Add tests on cmd package

Author: antham

cmd/edit_test.go

@@ -0,0 +1,77 @@
+package cmd
+
+import (
+	"bytes"
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNewEditCmd(t *testing.T) {
+	type scenario struct {
+		name  string
+		setup func(*testing.T) (workspaceManager, []string)
+		test  func(*testing.T, error)
+	}
+	scenarios := []scenario{
+		{
+			"An error occurred when editing a workspace",
+			func(t *testing.T) (workspaceManager, []string) {
+				w := newMockWorkspaceManager(t)
+				args := []string{"api"}
+				w.Mock.On("Edit", args[0]).Return(errors.New("an error occurred"))
+				return w, args
+			},
+			func(t *testing.T, err error) {
+				assert.Error(t, err)
+			},
+		},
+		{
+			"An error occurred when editing a workspace env",
+			func(t *testing.T) (workspaceManager, []string) {
+				w := newMockWorkspaceManager(t)
+				args := []string{"api", "prod"}
+				w.Mock.On("EditEnv", args[0], args[1]).Return(errors.New("an error occurred"))
+				return w, args
+			},
+			func(t *testing.T, err error) {
+				assert.Error(t, err)
+			},
+		},
+		{
+			"Editing a workspace successfully",
+			func(t *testing.T) (workspaceManager, []string) {
+				w := newMockWorkspaceManager(t)
+				args := []string{"api"}
+				w.Mock.On("Edit", args[0]).Return(nil)
+				return w, args
+			},
+			func(t *testing.T, err error) {
+				assert.NoError(t, err)
+			},
+		},
+		{
+			"Editing a workspace env successfully",
+			func(t *testing.T) (workspaceManager, []string) {
+				w := newMockWorkspaceManager(t)
+				args := []string{"api", "prod"}
+				w.Mock.On("EditEnv", args[0], args[1]).Return(nil)
+				return w, args
+			},
+			func(t *testing.T, err error) {
+				assert.NoError(t, err)
+			},
+		},
+	}
+	for _, s := range scenarios {
+		t.Run(s.name, func(t *testing.T) {
+			w, args := s.setup(t)
+			cmd := newEditCmd(w)
+			cmd.SetArgs(args)
+			cmd.SetErr(&bytes.Buffer{})
+			cmd.SetOut(&bytes.Buffer{})
+			s.test(t, cmd.Execute())
+		})
+	}
+}

cmd/mock_workspaceManager.go

@@ -22,6 +22,7 @@ require (
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/stretchr/objx v0.5.2 // indirect
 	golang.org/x/sys v0.12.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

go.mod

@@ -44,6 +44,8 @@ github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyh
 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/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
+github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=