Commandline package initial code (#1)

Signed-off-by: Krzysztof Suszyński <[email protected]>

Author: cardil

.github/workflows/go.yml

@@ -0,0 +1,33 @@
+name: Go
+
+on:
+  push:
+    branches: [ 'main', 'release-*' ]
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+
+  build:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version:
+          - '1.18'
+    steps:
+
+      - name: Set up Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Test
+        run: go run gotest.tools/[email protected] --format testname --
+          -race -count=1 -short ./...
+        env:
+          FORCE_COLOR: true

.github/workflows/knative-style.yaml

@@ -0,0 +1,10 @@
+name: Code Style
+
+on:
+  pull_request:
+    branches: [ 'main', 'release-*' ]
+
+jobs:
+
+  style:
+    uses: knative/actions/.github/workflows/style.yaml@main

go.mod

@@ -0,0 +1,15 @@
+module github.com/wavesoftware/go-commandline
+
+go 1.18
+
+require (
+	github.com/spf13/cobra v1.5.0
+	github.com/wavesoftware/go-retcode v1.0.0
+	gotest.tools/v3 v3.3.0
+)
+
+require (
+	github.com/google/go-cmp v0.5.5 // indirect
+	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+)

go.sum

@@ -0,0 +1,41 @@
+github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
+github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.5.0 h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=
+github.com/spf13/cobra v1.5.0/go.mod h1:dWXEIy2H428czQCjInthrTRUg7yKbok+2Qi/yBIJoUM=
+github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/wavesoftware/go-retcode v1.0.0 h1:Z53+VpIHMvRMtjS6jPScdihbAN1ks3lIJ5Mj32gCpno=
+github.com/wavesoftware/go-retcode v1.0.0/go.mod h1:BLqIIXhB/PQ+izkkRGfSQgu95BDtMmUBuvTJ/gkSWVM=
+github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gotest.tools/v3 v3.3.0 h1:MfDY1b1/0xN1CyMlQDac0ziEy9zJQd9CXBRRDHw2jJo=
+gotest.tools/v3 v3.3.0/go.mod h1:Mcr9QNxkg0uMvy/YElmo4SpXgJKWgQvYrT7Kw5RzJ1A=

test/cmd/main.go

@@ -0,0 +1,10 @@
+package main
+
+import (
+	"github.com/wavesoftware/go-commandline"
+	"github.com/wavesoftware/go-commandline/test/internal/cli"
+)
+
+func main() {
+	commandline.New(new(cli.App)).ExecuteOrDie(cli.Opts...)
+}

test/cmd/main_test.go

@@ -0,0 +1,49 @@
+package main_test
+
+import (
+	"bytes"
+	"testing"
+
+	main "github.com/wavesoftware/go-commandline/test/cmd"
+	"github.com/wavesoftware/go-commandline/test/internal/cli"
+	"gotest.tools/v3/assert"
+
+	"github.com/wavesoftware/go-commandline"
+)
+
+func TestTheMain(t *testing.T) {
+	s := capture(func() {
+		main.Main()
+	})
+	assert.Equal(t, 0, s.exitCode)
+	assert.Equal(t, "Hello, world!\n", s.out.String())
+}
+
+type state struct {
+	exitCode int
+	out      bytes.Buffer
+}
+
+func (s *state) opts() []commandline.Option {
+	return []commandline.Option{
+		commandline.WithOutput(&s.out),
+		commandline.WithExit(func(code int) {
+			s.exitCode = code
+		}),
+	}
+}
+
+func capture(fn func()) state {
+	var s state
+	withOpts(fn, s.opts())
+	return s
+}
+
+func withOpts(fn func(), opts []commandline.Option) {
+	keep := cli.Opts
+	defer func() {
+		cli.Opts = keep
+	}()
+	cli.Opts = opts
+	fn()
+}

test/cmd/themain_test.go

@@ -0,0 +1,6 @@
+package main
+
+// Main is the entrypoint for the main package.
+func Main() {
+	main()
+}

test/internal/cli/app.go

@@ -0,0 +1,20 @@
+package cli
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/wavesoftware/go-commandline"
+)
+
+// Opts is the list of commandline options to pass to the main function.
+var Opts []commandline.Option
+
+type App struct{}
+
+func (a App) Command() *cobra.Command {
+	return &cobra.Command{
+		Use: "example",
+		Run: func(cmd *cobra.Command, args []string) {
+			cmd.Println("Hello, world!")
+		},
+	}
+}

test/internal/cli/app_test.go

@@ -0,0 +1,19 @@
+package cli_test
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/wavesoftware/go-commandline/test/internal/cli"
+	"gotest.tools/v3/assert"
+)
+
+func TestAppCommand(t *testing.T) {
+	app := new(cli.App)
+	cmd := app.Command()
+	var buf bytes.Buffer
+	cmd.SetOut(&buf)
+	err := cmd.Execute()
+	assert.NilError(t, err)
+	assert.Equal(t, "Hello, world!\n", buf.String())
+}

types.go

@@ -0,0 +1,99 @@
+package commandline
+
+import (
+	"errors"
+	"io"
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/wavesoftware/go-retcode"
+)
+
+// ErrNoRootCommand is returned when no root command is provided.
+var ErrNoRootCommand = errors.New("no root command provided")
+
+// App represents a command line application.
+type App struct {
+	CobraProvider
+	Exit func(code int)
+	root *cobra.Command
+}
+
+// CobraProvider is used to provide a Cobra command.
+type CobraProvider interface {
+	Command() *cobra.Command
+}
+
+// Option is used to configure an App.
+type Option func(*App)
+
+// New creates a new App from CobraProvider.
+func New(cp CobraProvider) *App {
+	return &App{
+		CobraProvider: cp,
+		Exit:          os.Exit,
+	}
+}
+
+// ExecuteOrDie will execute the application or perform os.Exit in case of error.
+func (a *App) ExecuteOrDie(options ...Option) {
+	if err := a.Execute(options...); err != nil {
+		a.Exit(retcode.Calc(err))
+	}
+}
+
+// WithArgs creates an option which sets args.
+func WithArgs(args ...string) Option {
+	return func(app *App) {
+		app.root.SetArgs(args)
+	}
+}
+
+// WithInput creates an option witch sets os.Stdin.
+func WithInput(in io.Reader) Option {
+	return func(app *App) {
+		app.root.SetIn(in)
+	}
+}
+
+// WithOutput creates an option witch sets os.Stdout and os.Stderr.
+func WithOutput(out io.Writer) Option {
+	return func(app *App) {
+		app.root.SetOut(out)
+		app.root.SetErr(out)
+	}
+}
+
+// WithExit creates an option which sets the exit function.
+func WithExit(fn func(code int)) Option {
+	return func(app *App) {
+		app.Exit = fn
+	}
+}
+
+// Execute will execute the application with the provided options and return
+// error if any.
+func (a *App) Execute(options ...Option) error {
+	if err := a.init(); err != nil {
+		return err
+	}
+	for _, config := range options {
+		config(a)
+	}
+	// cobra.Command should pass our own errors, no need to wrap them.
+	return a.root.Execute() //nolint:wrapcheck
+}
+
+func (a *App) init() error {
+	if a.Exit == nil {
+		a.Exit = os.Exit
+	}
+	if a.CobraProvider == nil {
+		return ErrNoRootCommand
+	}
+	a.root = a.Command()
+	if a.root == nil {
+		return ErrNoRootCommand
+	}
+	return nil
+}

types_test.go

@@ -0,0 +1,63 @@
+package commandline_test
+
+import (
+	"bytes"
+	"errors"
+	"io/ioutil"
+	"testing"
+
+	"github.com/spf13/cobra"
+	"github.com/wavesoftware/go-commandline"
+	"gotest.tools/v3/assert"
+)
+
+func TestExecuteOrDie(t *testing.T) {
+	var buf bytes.Buffer
+	var retcode int
+	commandline.New(new(testApp)).ExecuteOrDie(
+		commandline.WithOutput(&buf),
+		commandline.WithInput(bytes.NewBufferString("Input")),
+		commandline.WithArgs("arg1", "arg2"),
+		commandline.WithExit(func(code int) {
+			retcode = code
+		}),
+	)
+	assert.Equal(t, `example Input: ["arg1" "arg2"]`, buf.String())
+	assert.Equal(t, 133, retcode)
+}
+
+func TestExit(t *testing.T) {
+	app := commandline.App{CobraProvider: nil}
+	err := app.Execute()
+	assert.ErrorIs(t, err, commandline.ErrNoRootCommand)
+
+	app = commandline.App{CobraProvider: nilApp{}}
+	err = app.Execute()
+	assert.ErrorIs(t, err, commandline.ErrNoRootCommand)
+}
+
+var errExample = errors.New("example error")
+
+type testApp struct{}
+
+func (t testApp) Command() *cobra.Command {
+	return &cobra.Command{
+		Use:           "example",
+		SilenceUsage:  true,
+		SilenceErrors: true,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			in, err := ioutil.ReadAll(cmd.InOrStdin())
+			if err != nil {
+				return err
+			}
+			cmd.Printf("%s %s: %q", cmd.Use, in, args)
+			return errExample
+		},
+	}
+}
+
+type nilApp struct{}
+
+func (n nilApp) Command() *cobra.Command {
+	return nil
+}