diff --git a/.gitignore b/.gitignore index 78f71d30..009bf68b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.swp proctor +vendor diff --git a/README.md b/README.md index 56fb94d8..c8a45444 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ ## Proctor Proctor is an automation framework. It helps everyone contribute to automation, mange it and use it. + +### Introduction + +Proctor CLI is a command line tool to interact with proctor-engine. +It helps you execute various jobs available with proctor. + +### Dev environment setup + +* Install and setup golang +* Install glide +* Make a directory `src/github.com/gojekfarm` inside your GOPATH +* Clone this repo inside above directory +* Install dependencies using glide +* [Configure proctor CLI](#proctor-cli-configuration) +* Running `go install github.com/gojekfarm/proctor` will place the CLI binary in your `$GOPATH/bin` directory +* Run `proctor version` to check installation + +### Running tests instructions + +* [Setup dev environment](#dev-environment-setup) +* Run tests: `go test -race -cover $(glide novendor)` + +#### Proctor CLI configuration + +* Make a directory `.proctor` inside your home directory +* Create a file proctor.yaml inside above directory +* Put the following content in the above file + +``` +PROCTOR_URL: [URL to proctor Engine] +``` diff --git a/glide.lock b/glide.lock index ebc62e3b..1620d95e 100644 --- a/glide.lock +++ b/glide.lock @@ -1,8 +1,12 @@ -hash: 472b8f5a435fd3308215a66e7ab236e1cb5282b4a0b0b333d3081bfea42f0d50 -updated: 2018-03-06T02:38:33.170613+05:30 +hash: be788ce484a5eb18ef59b0a26d93cf3face969ae45c6e861bb78c0a646c179d3 +updated: 2018-03-13T14:57:37.432979+05:30 imports: - name: github.com/briandowns/spinner version: 48dbb65d7bd5c74ab50d53d04c949f20e3d14944 +- name: github.com/davecgh/go-spew + version: 5215b55f46b2b919f50a1df0eaa5886afe4e3b3d + subpackages: + - spew - name: github.com/fatih/color version: 507f6050b8568533fb3f5504de8e5205fa62a114 - name: github.com/fsnotify/fsnotify @@ -32,6 +36,10 @@ imports: version: 06020f85339e21b2478f756a78e295255ffa4d6a - name: github.com/pelletier/go-toml version: 4e9e0ee19b60b13eb79915933f44d8ed5f268bdd +- name: github.com/pmezard/go-difflib + version: d8ed2627bdf02c080bf22230dbb337003b7aba2d + subpackages: + - difflib - name: github.com/spf13/afero version: 8d919cbe7e2627e417f3e45c3c0e489a5b7e2536 subpackages: @@ -46,10 +54,15 @@ imports: version: e57e3eeb33f795204c1ca35f56c44f83227c6e66 - name: github.com/spf13/viper version: 25b30aa063fc18e48662b86996252eabdcf2f0c7 +- name: github.com/stretchr/objx + version: 8a3f7159479fbc75b30357fbc48f380b7320f08e - name: github.com/stretchr/testify version: 12b6f73e6084dad08a7c6e575284b177ecafbc71 subpackages: - assert + - mock + - require + - suite - name: golang.org/x/sys version: 8f0908ab3b2457e2e15403d3697c9ef5cb4b57a9 subpackages: @@ -61,12 +74,4 @@ imports: - unicode/norm - name: gopkg.in/yaml.v2 version: 287cf08546ab5e7e37d55a84f7ed3fd1db036de5 -testImports: -- name: github.com/davecgh/go-spew - version: 5215b55f46b2b919f50a1df0eaa5886afe4e3b3d - subpackages: - - spew -- name: github.com/pmezard/go-difflib - version: d8ed2627bdf02c080bf22230dbb337003b7aba2d - subpackages: - - difflib +testImports: [] diff --git a/glide.yaml b/glide.yaml index edeb746e..cc2c5ea1 100644 --- a/glide.yaml +++ b/glide.yaml @@ -1,4 +1,4 @@ -package: github.com/gojektech/proctor +package: github.com/gojekfarm/proctor import: - package: github.com/gorilla/websocket version: ~1.2.0