refactor(server): use MockExecute helper to get command output

Author: kangasta

internal/commands/server/list_test.go

@@ -1,18 +1,16 @@
 package server
 
 import (
-	"bytes"
 	"testing"
 
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
 	"github.com/UpCloudLtd/upcloud-cli/internal/config"
 	smock "github.com/UpCloudLtd/upcloud-cli/internal/mock"
-	"github.com/UpCloudLtd/upcloud-cli/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/internal/mockexecute"
 	internal "github.com/UpCloudLtd/upcloud-cli/internal/service"
 
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud"
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud/request"
-	"github.com/gemalto/flume"
 	"github.com/jedib0t/go-pretty/v6/text"
 	"github.com/stretchr/testify/assert"
 )
@@ -128,7 +126,6 @@ func TestListServers(t *testing.T) {
 	} {
 		t.Run(test.name, func(t *testing.T) {
 			conf := config.New()
-			conf.Viper().Set(config.KeyOutput, config.ValueOutputHuman)
 
 			testCmd := ListCommand()
 			mService := new(smock.Service)
@@ -138,23 +135,17 @@ func TestListServers(t *testing.T) {
 			mService.On("GetServerNetworks", &request.GetServerNetworksRequest{ServerUUID: uuid}).Return(&serverNetworks, nil)
 
 			c := commands.BuildCommand(testCmd, nil, conf)
-			err := c.Cobra().Flags().Parse(test.args)
-			assert.NoError(t, err)
-
-			res, err := c.(commands.NoArgumentCommand).ExecuteWithoutArguments(commands.NewExecutor(conf, mService, flume.New("test")))
-			assert.NoError(t, err)
+			c.Cobra().SetArgs(test.args)
 
-			buf := bytes.NewBuffer(nil)
-			err = output.Render(buf, conf, res)
+			output, err := mockexecute.MockExecute(c, mService, conf)
 			assert.NoError(t, err)
-			str := buf.String()
 
 			for _, contains := range test.outputContains {
-				assert.Contains(t, str, contains)
+				assert.Contains(t, output, contains)
 			}
 
 			for _, notContains := range test.outputNotContains {
-				assert.NotContains(t, str, notContains)
+				assert.NotContains(t, output, notContains)
 			}
 		})
 	}

internal/commands/server/show_test.go

@@ -1,17 +1,15 @@
 package server
 
 import (
-	"bytes"
 	"testing"
 
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
 	"github.com/UpCloudLtd/upcloud-cli/internal/config"
 	smock "github.com/UpCloudLtd/upcloud-cli/internal/mock"
-	"github.com/UpCloudLtd/upcloud-cli/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/internal/mockexecute"
 
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud"
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud/request"
-	"github.com/gemalto/flume"
 	"github.com/jedib0t/go-pretty/v6/text"
 	"github.com/stretchr/testify/assert"
 )
@@ -202,8 +200,6 @@ func TestServerHumanOutput(t *testing.T) {
 	mService.On("GetFirewallRules", &request.GetFirewallRulesRequest{ServerUUID: uuid}).Return(firewallRules, nil)
 
 	conf := config.New()
-	// force human output
-	conf.Viper().Set(config.KeyOutput, config.ValueOutputHuman)
 
 	command := commands.BuildCommand(ShowCommand(), nil, conf)
 
@@ -212,12 +208,10 @@ func TestServerHumanOutput(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	res, err := command.(commands.MultipleArgumentCommand).Execute(commands.NewExecutor(conf, &mService, flume.New("test")), uuid)
 
-	assert.Nil(t, err)
+	command.Cobra().SetArgs([]string{uuid})
+	output, err := mockexecute.MockExecute(command, &mService, conf)
 
-	buf := bytes.NewBuffer(nil)
-	err = output.Render(buf, conf, res)
 	assert.NoError(t, err)
-	assert.Equal(t, expected, buf.String())
+	assert.Equal(t, expected, output)
 }

internal/commands/zone/list_test.go

@@ -1,16 +1,14 @@
 package zone
 
 import (
-	"bytes"
 	"testing"
 
 	"github.com/UpCloudLtd/upcloud-cli/internal/commands"
 	"github.com/UpCloudLtd/upcloud-cli/internal/config"
 	smock "github.com/UpCloudLtd/upcloud-cli/internal/mock"
-	"github.com/UpCloudLtd/upcloud-cli/internal/output"
+	"github.com/UpCloudLtd/upcloud-cli/internal/mockexecute"
 
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud"
-	"github.com/gemalto/flume"
 	"github.com/jedib0t/go-pretty/v6/text"
 	"github.com/stretchr/testify/assert"
 )
@@ -28,18 +26,11 @@ func TestZoneListHumanOutput(t *testing.T) {
 	mService.On("GetZones").Return(&zones, nil)
 
 	conf := config.New()
-	// force human output
-	conf.Viper().Set(config.KeyOutput, config.ValueOutputHuman)
-
 	command := commands.BuildCommand(ListCommand(), nil, conf)
 
-	res, err := command.(commands.NoArgumentCommand).ExecuteWithoutArguments(commands.NewExecutor(conf, &mService, flume.New("test")))
-
-	assert.Nil(t, err)
+	output, err := mockexecute.MockExecute(command, &mService, conf)
 
-	buf := bytes.NewBuffer(nil)
-	err = output.Render(buf, conf, res)
 	assert.NoError(t, err)
-	assert.Regexp(t, "ID\\s+Description\\s+Public", buf.String())
-	assert.Regexp(t, "fi-hel1\\s+Helsinki #1\\s+yes", buf.String())
+	assert.Regexp(t, "ID\\s+Description\\s+Public", output)
+	assert.Regexp(t, "fi-hel1\\s+Helsinki #1\\s+yes", output)
 }

internal/mockexecute/mockexecute.go

@@ -12,13 +12,18 @@ import (
 	"github.com/UpCloudLtd/upcloud-cli/internal/service"
 )
 
-func MockExecute(command commands.Command, service service.AllServices, config *config.Config) (string, error) {
+func MockExecute(command commands.Command, service service.AllServices, conf *config.Config) (string, error) {
 	buf := bytes.NewBuffer(nil)
 	command.Cobra().SetErr(buf)
 	command.Cobra().SetOut(buf)
 
+	// Use human output if nothing else is defined
+	if !conf.IsSet(config.KeyOutput) {
+		conf.Viper().Set(config.KeyOutput, config.ValueOutputHuman)
+	}
+
 	command.Cobra().RunE = func(_ *cobra.Command, args []string) error {
-		return mockRunE(command, service, config, args)
+		return mockRunE(command, service, conf, args)
 	}
 	err := command.Cobra().Execute()
 
@@ -38,8 +43,8 @@ func mockRunE(command commands.Command, service service.AllServices, config *con
 	case commands.MultipleArgumentCommand:
 		out, err = typedCommand.Execute(executor, args[0])
 	}
-
-	_ = output.Render(command.Cobra().OutOrStdout(), config, out)
-
-	return err
+	if err != nil {
+		return err
+	}
+	return output.Render(command.Cobra().OutOrStdout(), config, out)
 }