test: add success and error tests to cmd.ExecuteContext (#61)

* fix: cancelled context now exits the process with error code

* test: add success and error tests to root.ExecuteContext

* test: rewrite root.ExecuteContext tests as table tests

* test: add TODO to assert that the event tracker was called

Author: mwbrooks

cmd/root.go

@@ -361,7 +361,7 @@ func ExecuteContext(ctx context.Context, rootCmd *cobra.Command, clients *shared
 				clients.IO.PrintDebug(ctx, "... root cleanup waitgroup done.")
 				cleanup(ctx, clients)
 				clients.IO.PrintDebug(ctx, "Exiting with cancel exit code.")
-				os.Exit(int(iostreams.ExitCancel))
+				clients.Os.Exit(int(iostreams.ExitCancel))
 			}()
 		// Received completed execution, so exit the process successfully
 		case <-completedChan:
@@ -371,7 +371,7 @@ func ExecuteContext(ctx context.Context, rootCmd *cobra.Command, clients *shared
 		// If we get a second interrupt, no matter what exit the process
 		<-interruptChan
 		clients.IO.PrintDebug(ctx, "Got second process interrupt signal, exiting the process")
-		os.Exit(int(iostreams.ExitCancel))
+		clients.Os.Exit(int(iostreams.ExitCancel))
 	}()
 
 	// The cleanup() method in the root command will invoke via `defer` from within Execute.
@@ -391,7 +391,7 @@ func ExecuteContext(ctx context.Context, rootCmd *cobra.Command, clients *shared
 			}
 			clients.IO.PrintError(ctx, errMsg)
 		}
-		defer os.Exit(int(clients.IO.GetExitCode()))
+		defer clients.Os.Exit(int(clients.IO.GetExitCode()))
 		completedChan <- true
 	} else {
 		completedChan <- true

cmd/root_test.go

@@ -21,9 +21,11 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/slackapi/slack-cli/internal/iostreams"
 	"github.com/slackapi/slack-cli/internal/shared"
 	"github.com/slackapi/slack-cli/internal/slackcontext"
 	"github.com/slackapi/slack-cli/test/testutil"
+	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -76,6 +78,56 @@ func TestRootCommand(t *testing.T) {
 	}
 }
 
+func TestExecuteContext(t *testing.T) {
+	tests := map[string]struct {
+		expectedErr      error
+		expectedExitCode iostreams.ExitCode
+		expectedOutputs  []string
+	}{
+		"Command successfully executes": {
+			expectedErr:      nil,
+			expectedExitCode: iostreams.ExitOK,
+		},
+		"Command fails execution and returns an error": {
+			expectedErr:      fmt.Errorf("command failed"),
+			expectedExitCode: iostreams.ExitError,
+			expectedOutputs: []string{
+				"command failed",
+			},
+		},
+	}
+	for name, tt := range tests {
+		t.Run(name, func(t *testing.T) {
+			ctx := slackcontext.MockContext(t.Context())
+
+			// Mock clients
+			clientsMock := shared.NewClientsMock()
+			clientsMock.AddDefaultMocks()
+			clients := shared.NewClientFactory(clientsMock.MockClientFactory())
+
+			// Mock command
+			cmd := &cobra.Command{
+				Use: "mock [flags]",
+				RunE: func(cmd *cobra.Command, args []string) error {
+					return tt.expectedErr
+				},
+			}
+
+			// Execute the command
+			ExecuteContext(ctx, cmd, clients)
+			output := clientsMock.GetCombinedOutput()
+
+			// Assertions
+			// TODO: Assert that the event tracker was called with the correct exit code
+			require.Equal(t, tt.expectedExitCode, clients.IO.GetExitCode())
+
+			for _, expectedOutput := range tt.expectedOutputs {
+				require.Contains(t, output, expectedOutput)
+			}
+		})
+	}
+}
+
 // FYI: do not try to run this test in vscode using the run/debug test inline test helper; as the assertions in this test will fail in that context
 func TestVersionFlags(t *testing.T) {
 	ctx := slackcontext.MockContext(t.Context())