Adding CLI tests

Author: cardil

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2019 WaveSoftware
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,16 +1,73 @@
 Installer for Openshift Serverless
 ==================================
 
+[![Build Status](https://travis-ci.com/wavesoftware/serverless-installer.svg?branch=master)](https://travis-ci.com/wavesoftware/serverless-installer)
+
 Installer will create a usable installation of Openshift's Serverless Platform.
 
 ## Usage
 
+### Interactive
+
+This command invoked without any parameters will enter TUI. 
+User is asked couple questions and then his answers are save on disk to
+be later used by deploy command.
+
+```bash
+serverless-installer
+```
+
+### Deploy
+
+This command will deploy a serverless platform on currently configured Openshift cluster.
+
 ```bash
-serverless-installer deploy
+serverless-installer deploy --answers serverless-installer-answers.yaml
 ```
 
-This command will deploy a serverless platform on currently configured cluster.
+Answers are expected to be produced by interactive mode.
+
+## Installation
+
+### Go
+
+if you have usable Go `>= 1.13` installation simply invoke:
 
 ```bash
-serverless-installer script
-```
+go get -u github.com/wavesoftware/serverless-installer
+```
+
+This will produce a binary that you can use.
+
+### Precompiled binaries
+
+**To be determined!**
+
+Procompiled binaries can be found in GitHub's releases page:
+
+ * [Linux amd64](https://github.com/wavesoftware/serverless-installer/releases/latest)
+ * [MacOSX amd64](https://github.com/wavesoftware/serverless-installer/releases/latest)
+ * [Windows amd64](https://github.com/wavesoftware/serverless-installer/releases/latest)
+
+## Development
+
+To build simply invoke (it will check & test the code as well):
+
+```bash
+make
+```
+
+Go `>= 1.13` is required to build.
+
+Contributions are welcome!
+
+To contribute, follow the standard [git flow](http://danielkummer.github.io/git-flow-cheatsheet/) of:
+
+1. Fork it
+1. Create your feature branch (`git checkout -b feature/my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin feature/my-new-feature`)
+1. Create new Pull Request
+
+Even if you can't contribute code, if you have an idea for an improvement 
+please open an [issue](https://github.com/wavesoftware/serverless-installer/issues).

cmd/installer/main_test.go

@@ -26,3 +26,7 @@ func TestMain(t *testing.T) {
 
 	assert.Equal(t, 0, exitcode)
 }
+
+func TestExit(t *testing.T) {
+	exit(0)
+}

internal/cli/deploy.go

@@ -12,19 +12,20 @@ type deployT struct {
 	Logging
 }
 
-var deploy = &cli.Command{
-	Name: "deploy",
-	Desc: "Deploys a Serverless onto Openshift cluster using ansers file",
-	Argv: func() interface{} { return new(deployT) },
-	Fn: func(ctx *cli.Context) error {
-		argv := ctx.Argv().(*deployT)
-		log.SetOutput(ctx.Writer())
-		log.SetLevel(argv.Logging.Level.value)
+func deploy() *cli.Command {
+	return &cli.Command{
+		Name: "deploy",
+		Desc: "Deploys a Serverless onto Openshift cluster using ansers file",
+		Argv: func() interface{} { return new(deployT) },
+		Fn: func(ctx *cli.Context) error {
+			argv := ctx.Argv().(*deployT)
+			log.SetOutput(ctx.Writer())
+			log.SetLevel(argv.Logging.Level.value)
 
-		ctx.String("Hello, from deploy command. Answers file is %s\n", argv.Answers)
-		log.
-			WithField("answers-file", argv.Answers).
-			Info("Hello, from deploy command.")
-		return nil
-	},
+			log.
+				WithField("answers-file", argv.Answers).
+				Info("Hello, from deploy command.")
+			return nil
+		},
+	}
 }

internal/cli/interactive.go

@@ -16,15 +16,17 @@ type interactiveT struct {
 	Logging
 }
 
-var interactive = &cli.Command{
-	Desc: `Installer for Openshift Serverless
-	
+func interactive() *cli.Command {
+	return &cli.Command{
+		Desc: `Installer for Openshift Serverless
+		
 Run without any options to enter interactive shell that will guide you
 through installation process and produce an answers file. That answers
 file can by applied on current Openshift cluster with deploy command.`,
 
-	Argv: func() interface{} { return new(interactiveT) },
-	Fn:   operate,
+		Argv: func() interface{} { return new(interactiveT) },
+		Fn:   operate,
+	}
 }
 
 func operate(ctx *cli.Context) error {
@@ -56,7 +58,7 @@ func save(answers contract.LocationAwareAnswers) error {
 	err := saver.Save(*answers.Answers, answers.Path)
 	if err == nil {
 		log.
-			WithField("Answers file", answers.Path).
+			WithField("Location", answers.Path).
 			Info("Answers file has been saved.")
 	}
 	return err

internal/cli/interactive/factory_test.go

@@ -0,0 +1,19 @@
+package interactive
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/wavesoftware/serverless-installer/internal/domain/contract"
+)
+
+func TestCreate(t *testing.T) {
+	// given
+	answers := contract.LocationAwareAnswers{}
+
+	// when
+	screen := Create(&answers)
+
+	// then
+	assert.NotNil(t, screen)
+}

internal/cli/runner.go

@@ -1,14 +1,15 @@
 package cli
 
 import (
-	"fmt"
 	"os"
 
 	"github.com/mkideal/cli"
 	"github.com/sirupsen/logrus"
 )
 
-var help = cli.HelpCommand("display help information")
+func help() *cli.Command {
+	return cli.HelpCommand("display help information")
+}
 
 type runner struct {
 	args []string
@@ -37,11 +38,11 @@ func (r runner) Run() int {
 		TimestampFormat: "15:04:05.000",
 	})
 	if err := cli.Root(
-		interactive,
-		cli.Tree(help),
-		cli.Tree(deploy),
+		interactive(),
+		cli.Tree(help()),
+		cli.Tree(deploy()),
 	).Run(r.args[1:]); err != nil {
-		fmt.Fprintln(os.Stderr, err)
+		logrus.Error(err)
 		return 1
 	}
 	return 0

internal/cli/runner_test.go

@@ -0,0 +1,39 @@
+package cli
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestBasicRunnerFactory(t *testing.T) {
+	// when
+	runner := NewRunner()
+
+	// then
+	assert.NotNil(t, runner)
+}
+
+func TestHelpRun(t *testing.T) {
+	// given
+	args := []string{"cmd", "--help"}
+	runner := NewRunnerWithArgs(args)
+
+	// when
+	retcode := runner.Run()
+
+	// then
+	assert.Equal(t, 0, retcode)
+}
+
+func TestInvalidRun(t *testing.T) {
+	// given
+	args := []string{"cmd", "invalid_command"}
+	runner := NewRunnerWithArgs(args)
+
+	// when
+	retcode := runner.Run()
+
+	// then
+	assert.Equal(t, 1, retcode)
+}

internal/domain/contract/answers_test.go

@@ -13,3 +13,8 @@ func TestStruct(t *testing.T) {
 	// then
 	assert.NotNil(t, answers)
 }
+
+func TestFilename(t *testing.T) {
+	// then
+	assert.NotEmpty(t, AnswersFilename)
+}