Testing 'scw help'

Author: moul

.travis.yml

@@ -37,3 +37,4 @@ script:
   - make travis_run
   - make cover
   - goveralls -service=travis-ci -v -coverprofile=profile.out
+  - make integration-cli

Makefile

@@ -152,3 +152,14 @@ party:
 convey:
 	go get github.com/smartystreets/goconvey
 	goconvey -cover -port=9042 -workDir="$(realpath .)/pkg" -depth=-1
+
+
+.PHONY: integration-cli
+integration-cli:
+	go test -v ./integration-cli
+
+
+.PHONY: integration-cli
+convey-integration-cli:
+	go get github.com/smartystreets/goconvey
+	goconvey -cover -port=9043 -workDir="$(realpath .)/integration-cli" -depth=-1

integration-cli/custom_assert_test.go

@@ -0,0 +1,10 @@
+package integrationcli
+
+import "fmt"
+
+func shouldFitInTerminal(actual interface{}, expected ...interface{}) string {
+	if len(actual.(string)) < 80 {
+		return ""
+	}
+	return fmt.Sprintf("len(%q)\n -> %d chars (> 80 chars)", actual, len(actual.(string)))
+}

integration-cli/scw_cli_help_test.go

@@ -0,0 +1,98 @@
+package integrationcli
+
+import (
+	"fmt"
+	"os/exec"
+	"strings"
+	"testing"
+
+	. "github.com/scaleway/scaleway-cli/vendor/github.com/smartystreets/goconvey/convey"
+)
+
+func TestHelp(t *testing.T) {
+	Convey("Testing 'scw help'", t, func() {
+		Convey("scw help", func() {
+			cmd := exec.Command(scwcli, "help")
+			out, ec, err := runCommandWithOutput(cmd)
+			So(ec, ShouldEqual, 0)
+			So(err, ShouldBeNil)
+
+			// headers & footers
+			So(out, ShouldContainSubstring, "Usage: scw [OPTIONS] COMMAND [arg...]")
+			So(out, ShouldContainSubstring, "Interact with Scaleway from the command line.")
+			So(out, ShouldContainSubstring, "Run 'scw COMMAND --help' for more information on a command.")
+
+			// options
+			So(out, ShouldContainSubstring, "Options:")
+			for _, option := range publicOptions {
+				So(out, ShouldContainSubstring, " "+option)
+			}
+
+			// public commands
+			So(out, ShouldContainSubstring, "Commands:")
+			for _, command := range publicCommands {
+				So(out, ShouldContainSubstring, "    "+command)
+			}
+
+			// secret commands
+			for _, command := range secretCommands {
+				So(out, ShouldNotContainSubstring, "    "+command)
+			}
+
+			// :lipstick:
+			for _, line := range strings.Split(out, "\n") {
+				if false { // FIXME: disabled for now
+					So(line, shouldFitInTerminal)
+				}
+			}
+
+			// FIXME: count amount of options/commands, and panic if amount is different
+		})
+
+		commands := append(publicCommands, secretCommands...)
+		for _, command := range commands {
+			if command == "help" {
+				// FIXME: this should not be a special case
+				continue
+			}
+			Convey(fmt.Sprintf("scw --help %s", command), func() {
+				cmd := exec.Command(scwcli, command, "--help")
+				_, ec, err := runCommandWithOutput(cmd)
+
+				// exit code
+				So(ec, ShouldEqual, 1)
+				So(fmt.Sprintf("%s", err), ShouldEqual, "exit status 1")
+
+				// FIXME: disabled for now because it depends of 'scw login'
+				/*
+					// Header
+					So(out, ShouldContainSubstring, fmt.Sprintf("Usage: scw %s", command))
+					// FIXME: test description
+					// FIXME: test parameters
+
+					// Options
+					So(out, ShouldContainSubstring, "Options:")
+					So(out, ShouldContainSubstring, " -h, --help=false")
+					// FIXME: test other options
+
+					// Examples
+					// FIXME: todo
+					//So(out, ShouldContainSubstring, "Examples:")
+
+					secondCmd := exec.Command(scwcli, "help", command)
+					secondOut, secondEc, secondErr := runCommandWithOutput(secondCmd)
+					So(out, ShouldEqual, secondOut)
+					So(ec, ShouldEqual, secondEc)
+					So(fmt.Sprintf("%v", err), ShouldEqual, fmt.Sprintf("%v", secondErr))
+				*/
+			})
+		}
+		Convey("Unknown command", func() {
+			cmd := exec.Command(scwcli, "boogie")
+			out, ec, err := runCommandWithOutput(cmd)
+			So(out, ShouldContainSubstring, "scw: unknown subcommand boogie")
+			So(ec, ShouldEqual, 1)
+			So(fmt.Sprintf("%s", err), ShouldEqual, "exit status 1")
+		})
+	})
+}

integration-cli/utils_test.go

@@ -0,0 +1,37 @@
+package integrationcli
+
+import (
+	"fmt"
+	"os/exec"
+	"syscall"
+)
+
+func getExitCode(err error) (int, error) {
+	exitCode := 0
+	if exiterr, ok := err.(*exec.ExitError); ok {
+		if procExit, ok := exiterr.Sys().(syscall.WaitStatus); ok {
+			return procExit.ExitStatus(), nil
+		}
+	}
+	return exitCode, fmt.Errorf("failed to get exit code")
+}
+
+func processExitCode(err error) (exitCode int) {
+	if err != nil {
+		var exiterr error
+		if exitCode, exiterr = getExitCode(err); exiterr != nil {
+			// TODO: Fix this so we check the error's text.
+			// we've failed to retrieve exit code, so we set it to 127
+			exitCode = 127
+		}
+	}
+	return
+}
+
+func runCommandWithOutput(cmd *exec.Cmd) (output string, exitCode int, err error) {
+	exitCode = 0
+	out, err := cmd.CombinedOutput()
+	exitCode = processExitCode(err)
+	output = string(out)
+	return
+}

integration-cli/vars_test.go

@@ -0,0 +1,25 @@
+package integrationcli
+
+var (
+	scwcli         string   = "../scw"
+	publicCommands []string = []string{
+		"help", "attach", "commit", "cp", "create",
+		"events", "exec", "history", "images", "info",
+		"inspect", "kill", "login", "logout", "logs",
+		"port", "ps", "rename", "restart", "rm", "rmi",
+		"run", "search", "start", "stop", "tag", "top",
+		"version", "wait",
+	}
+	secretCommands []string = []string{
+		"_patch", "_completion", "_flush-cache",
+	}
+	publicOptions []string = []string{
+		"-h, --help=false",
+		"-D, --debug=false",
+		"-V, --verbose=false",
+		"-q, --quiet=false",
+		"--api-endpoint=APIEndPoint",
+		"--sensitive=false",
+		"-v, --version=false",
+	}
+)