srcclr-cli

SourceClear CLI

Development

1. Install go-swagger

   $ sudo curl -L -o /usr/local/bin/swagger https://github.com/go-swagger/go-swagger/releases/download/v0.19.0/swagger_linux_amd64
   $ chmod 755 /usr/local/bin/swagger
   $ swagger version
   version: v0.19.0
   commit: 312366608bbf17dd219190b66ab63bdc8b4d0db0

2. Download SourceClear API Swagger specification file (sca_v1_spec_sca.json).
3. Generate an API client by go-swagger.

   # NOTE: go-swagger does not support Go module yet.
   # Your source tree must be in GOPATH.
   # You must hit `direnv deny` and deactivate Go module if you use direnv. 
   $ swagger generate client -f ./swagger/sca_v1_spec_with_sec_oas2.json --default-scheme=https
   ...
   2019/01/01 12:00:00 Generation completed!
   
   For this generation to compile you need to have some packages in your GOPATH:
   
           * github.com/go-openapi/errors
           * github.com/go-openapi/runtime
           * github.com/go-openapi/runtime/client
           * github.com/go-openapi/strfmt
   
   You can get these now with: go get -u -f ./...
   
   # activate Go module
   $ direnv allow
   $ go get -u -f ./...
   $ go mod tidy

4. Generate a CLI template by cobra.

   $ go get -u github.com/spf13/cobra/cobra
   $ cobra init --pkg-name github.com/wdstar/srcclr-cli
   $ go mod tidy
   $ go build
   $ ./srcclr-cli

5. Add sub commands.

   $ cobra add version -p "rootCmd"
   $ cobra add get     -p "rootCmd"

6. Add goreleaser configurations.

   $ curl -sL -o /usr/local/bin/goreleaser https://git.io/goreleaser
   $ chmod 755 /usr/local/bin/goreleaser
   $ goreleaser init
   # Snapshot build
   $ goreleaser --snapshot --skip-publish --rm-dist
   $ ./dist/go-cmd-example_linux_amd64/go-cmd-example version
   # Production release
   $ export GITHUB_TOKEN=**********************************
   $ git tag -a vX.X.X -m 'initial release.'
   $ git push --tags
   $ goreleaser --rm-dist

Known Issues

Invalid swagger specs

$ swagger validate swagger/sca_v1_spec_oas2.json 
...
The swagger spec at "swagger/sca_v1_spec_oas2.json" is invalid against swagger specification 2.0.
See errors below:
- default value for status in query does not validate its schema
- status in query must be of type array: "string"