Merge pull request #9 from areed/areed/ch568/vendor-cli-release

generate docs

Author: areed

.gitignore

@@ -1,2 +1,3 @@
 dist/
 .glide
+gen/docs

.travis.yml

@@ -1,6 +1,8 @@
 language: go
 go: 1.8.3
-install:
-  - make build
 script:
+  - make build
   - make test
+after_success:
+  - test -n "$TRAVIS_TAG" && make package_docker_docs
+  - test -n "$TRAVIS_TAG" && curl -sL https://git.io/goreleaser | bash

Makefile

@@ -1,3 +1,5 @@
+.PHONY: docs
+
 API_PKGS=apps channels releases
 
 docker:
@@ -58,3 +60,12 @@ release:
 		--volume `pwd`:/go/src/github.com/replicatedhq/replicated \
 		--env GITHUB_TOKEN=${GITHUB_TOKEN} \
 		replicatedhq.replicated goreleaser
+
+docs:
+	go run docs/generate.go --path ./gen/docs
+
+package_docker_docs: docs
+	docker login -p $(QUAY_PASS) -u $(QUAY_USER) quay.io
+	docker build -t quay.io/replicatedcom/vendor-cli-docs:release -f docs/Dockerfile .
+	docker push quay.io/replicatedcom/vendor-cli-docs:release
+	docker rmi -f quay.io/replicatedcom/vendor-cli-docs:release

README.md

@@ -3,6 +3,8 @@
 This repository provides a client and CLI for interacting with the Replicated Vendor API.
 The models are generated from the API's swagger spec.
 
+## CLI
+
 Grab the latest [release](https://github.com/replicatedhq/replicated/releases) and extract it to your path.
 
 ```
@@ -13,12 +15,52 @@ Set the following env vars to avoid passing them as arguments to each command.
 * REPLICATED_APP_SLUG
 * REPLICATED_API_TOKEN
 
+## Client
+
+(GoDoc)[https://godoc.org/github.com/replicatedhq/replicated/client]
+
+```golang
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/replicatedhq/replicated/client"
+)
+
+func main() {
+	token := os.Getenv("REPLICATED_API_TOKEN")
+	appSlug := os.Getenv("REPLICATED_APP_SLUG")
+
+	api := client.New(token)
+
+	app, err := api.GetAppBySlug(appSlug)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	channels, err := api.ListChannels(app.Id)
+	if err != nil {
+		log.Fatal(err)
+	}
+	for _, c := range channels {
+		fmt.Printf("channel %s is on release %d\n", c.Name, c.ReleaseSequence)
+	}
+}
+```
+
 ## Development
 ```make build``` installs the binary to ```$GOPATH/bin```
 
 ### Tests
 REPLICATED_API_ORIGIN may be set for testing an alternative environment.
 
+Since apps can only be deleted in a login session, set these to cleanup garbage from the tests.
+VENDOR_USER_EMAIL should be set to delete app
+VENDOR_USER_PASSWORD should be set to delete app
+
 ### Releases
 Releases are created locally with [goreleaser](https://github.com/goreleaser/goreleaser).
 Tag the commit to release then run goreleaser.

cli/cmd/root.go

@@ -62,7 +62,7 @@ func Execute(w io.Writer) error {
 				return errors.New("Please provide your API token")
 			}
 		}
-		api := client.New(apiOrigin, apiToken)
+		api := client.NewHTTPClient(apiOrigin, apiToken)
 		runCmds.api = api
 
 		if appSlug == "" {

cli/test/channel_create_test.go

@@ -12,6 +12,7 @@ import (
 )
 
 var _ = Describe("channel create", func() {
+	t := GinkgoT()
 	var app = &apps.App{Name: mustToken(8)}
 
 	BeforeEach(func() {
@@ -22,14 +23,13 @@ var _ = Describe("channel create", func() {
 
 	AfterEach(func() {
 		// ignore error, garbage collection
-		api.DeleteApp(app.Id)
+		deleteApp(t, app.Id)
 	})
 
 	name := mustToken(8)
 	desc := mustToken(16)
 	Describe(fmt.Sprintf("--name %s --description %s", name, desc), func() {
 		It("should print the created channel", func() {
-			t := GinkgoT()
 			var stdout bytes.Buffer
 			var stderr bytes.Buffer
 

cli/test/channel_inspect_test.go

@@ -12,11 +12,11 @@ import (
 )
 
 var _ = Describe("channel inspect", func() {
+	t := GinkgoT()
 	var app = &apps.App{Name: mustToken(8)}
 	var appChan = &channels.AppChannel{}
 
 	BeforeEach(func() {
-		t := GinkgoT()
 		var err error
 		app, err = api.CreateApp(app.Name)
 		assert.Nil(t, err)
@@ -28,13 +28,12 @@ var _ = Describe("channel inspect", func() {
 
 	AfterEach(func() {
 		// ignore error, garbage collection
-		api.DeleteApp(app.Id)
+		deleteApp(t, app.Id)
 	})
 
 	Context("with an existing channel ID", func() {
 		Context("with no licenses and no releases", func() {
 			It("should print the full channel details", func() {
-				t := GinkgoT()
 				var stdout bytes.Buffer
 				var stderr bytes.Buffer
 

cli/test/channel_list_test.go

@@ -27,8 +27,7 @@ var _ = Describe("channel ls", func() {
 	})
 
 	AfterEach(func() {
-		// ignore error, garbage collection
-		api.DeleteApp(app.Id)
+		deleteApp(t, app.Id)
 	})
 
 	Context("when an app has three channels without releases", func() {

cli/test/channel_rm_test.go

@@ -27,8 +27,7 @@ var _ = Describe("channel rm", func() {
 	})
 
 	AfterEach(func() {
-		// ignore error, garbage collection
-		api.DeleteApp(app.Id)
+		deleteApp(t, app.Id)
 	})
 
 	Context("when the channel ID exists", func() {

cli/test/release_create_test.go

@@ -10,47 +10,6 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-var yaml = `---
-replicated_api_version: 2.9.2
-name: "Test"
-
-#
-# https://www.replicated.com/docs/packaging-an-application/application-properties
-#
-properties:
-  app_url: http://{{repl ConfigOption "hostname" }}
-  console_title: "Test"
-
-#
-# https://www.replicated.com/docs/kb/supporting-your-customers/install-known-versions
-#
-host_requirements:
-  replicated_version: ">=2.9.2"
-
-#
-# Settings screen
-# https://www.replicated.com/docs/packaging-an-application/config-screen
-#
-config:
-- name: hostname
-  title: Hostname
-  description: Ensure this domain name is routable on your network.
-  items:
-  - name: hostname
-    title: Hostname
-    value: '{{repl ConsoleSetting "tls.hostname"}}'
-    type: text
-    test_proc:
-    display_name: Check DNS
-    command: resolve_host
-
-#
-# Define how the application containers will be created and started
-# https://www.replicated.com/docs/packaging-an-application/components-and-containers
-#
-components: []
-`
-
 var _ = Describe("release create", func() {
 	t := GinkgoT()
 	var app = &apps.App{Name: mustToken(8)}
@@ -62,8 +21,7 @@ var _ = Describe("release create", func() {
 	})
 
 	AfterEach(func() {
-		// ignore error, garbage collection
-		api.DeleteApp(app.Id)
+		deleteApp(t, app.Id)
 	})
 
 	Context("with valid --yaml in an app with no releases", func() {