Skip to content

Commit 2ac7b44

Browse files
author
Alexander Garagatyi
authored
CHE-4097: Refactor go agents package structure (eclipse-che#4344)
Also add comments and cleanup code. Signed-off-by: Alexander Garagatyi <agaragatyi@codenvy.com>
1 parent 73c14ec commit 2ac7b44

95 files changed

Lines changed: 814 additions & 618 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

agents/exec/.gitignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

agents/exec/README.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

agents/exec/src/auth/auth.go

Lines changed: 0 additions & 128 deletions
This file was deleted.

agents/exec/src/term/activity.go

Lines changed: 0 additions & 65 deletions
This file was deleted.

agents/go-agents/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
src/main/go/exec-agent/exec-agent
2+
src/main/go/exec-agent/logs

agents/go-agents/README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
Summary
2+
---
3+
Golang based server for executing commands and streaming process output logs,
4+
also websocket-terminal.
5+
6+
7+
Requirements
8+
--
9+
- golang 1.6+
10+
11+
12+
Docs
13+
---
14+
- jsonrpc2.0 based [Webscoket API](docs/ws_api.md)
15+
- jsonrpc2.0 based [Events](docs/events.md)
16+
- [REST API](docs/rest_api.md)
17+
18+
Development
19+
---
20+
21+
##### Link the sources to standard go workspace
22+
23+
```bash
24+
export CHE_PATH=~/code/che
25+
mkdir $GOPATH/src/github.com/eclipse/che/agents/go-agents/src/main -p
26+
ln -s $CHE_PATH/agents/go-agents/src/main/go $GOPATH/src/github.com/eclipse/che/agents/go-agents/src/main/go
27+
```
28+
29+
That's it, `$GOPATH/src/github.com/eclipse/che/agents/go-agents` project is ready.
30+
31+
##### Building linked project
32+
33+
```bash
34+
cd $GOPATH/src/github.com/eclipse/che/agents/go-agents/src/main/go && go build ./...
35+
```
36+
37+
#### Building exec agent executable
38+
39+
```bash
40+
cd $GOPATH/src/github.com/eclipse/che/agents/go-agents/src/main/go/exec-agent && go build
41+
```
42+
43+
##### Running linked project tests
44+
45+
```bash
46+
cd $GOPATH/src/github.com/eclipse/che/agents/go-agents/src/main/go && go test ./...
47+
```
48+
49+
##### Formatting linked project sources
50+
51+
```bash
52+
cd $GOPATH/src/github.com/eclipse/che/agents/go-agents/src/main/go && go fmt ./...
53+
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)