refactor: update .Context() references for consistency (#33)

* refactor: Add slackcontext package to DRY context management

* refactor: Revert changes to unrelated error codes

* test: mock context in TableTestCommand

* test: mock context in TableTestCommand ExpectedAsserts

* test: use ctx in mocked ExpectedAsserts

* test: use ctx in mocked ExpectedAsserts to link_test.go

* test: use ctx in mocked ExpectedAsserts to update_test.go

* test: use .MockContext(...) instead of context.Background()

* test: update context references for .Setup

* refactor: update .Context() references for consistency

* refactor: update span to not return a ctx since it's locally scoped

* refactor: update root.go use to ctx for OnInitialize and OnFinalize

* refactor: pass ctx into Init

Author: mwbrooks

cmd/app/app.go

@@ -46,8 +46,9 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
 			return runListCommand(cmd, clients)
 		},
 		PostRunE: func(cmd *cobra.Command, args []string) error {
+			ctx := cmd.Context()
 			if cmd.CalledAs() == "workspace" {
-				clients.IO.PrintInfo(cmd.Context(), false, fmt.Sprintf(
+				clients.IO.PrintInfo(ctx, false, fmt.Sprintf(
 					"\n%s It looks like you used %s. This command will be deprecated in an upcoming release.\n    You can now use %s instead of %s.\n ",
 					style.Emoji("bulb"),
 					style.Commandf("workspace", true),

cmd/app/link_test.go

@@ -61,7 +61,7 @@ func Test_Apps_Link(t *testing.T) {
 					mockLinkSlackAuth1,
 				}, nil)
 				cm.AddDefaultMocks()
-				setupAppLinkCommandMocks(t, cm, cf)
+				setupAppLinkCommandMocks(t, ctx, cm, cf)
 				cm.IO.On("SelectPrompt",
 					mock.Anything,
 					"Select the existing app team",
@@ -118,7 +118,7 @@ func Test_Apps_Link(t *testing.T) {
 					mockLinkSlackAuth1,
 				}, nil)
 				cm.AddDefaultMocks()
-				setupAppLinkCommandMocks(t, cm, cf)
+				setupAppLinkCommandMocks(t, ctx, cm, cf)
 				cm.IO.On("SelectPrompt",
 					mock.Anything,
 					"Select the existing app team",
@@ -177,7 +177,7 @@ func Test_Apps_Link(t *testing.T) {
 					mockLinkSlackAuth2,
 				}, nil)
 				cm.AddDefaultMocks()
-				setupAppLinkCommandMocks(t, cm, cf)
+				setupAppLinkCommandMocks(t, ctx, cm, cf)
 				existingApp := types.App{
 					AppID:        mockLinkAppID1,
 					TeamDomain:   mockLinkSlackAuth1.TeamDomain,
@@ -246,7 +246,7 @@ func Test_Apps_Link(t *testing.T) {
 					mockLinkSlackAuth2,
 				}, nil)
 				cm.AddDefaultMocks()
-				setupAppLinkCommandMocks(t, cm, cf)
+				setupAppLinkCommandMocks(t, ctx, cm, cf)
 				existingApp := types.App{
 					AppID:        mockLinkAppID1,
 					TeamDomain:   mockLinkSlackAuth1.TeamDomain,
@@ -321,7 +321,7 @@ func Test_Apps_Link(t *testing.T) {
 					mockLinkSlackAuth2,
 				}, nil)
 				cm.AddDefaultMocks()
-				setupAppLinkCommandMocks(t, cm, cf)
+				setupAppLinkCommandMocks(t, ctx, cm, cf)
 				existingApp := types.App{
 					AppID:      mockLinkAppID2,
 					TeamDomain: mockLinkSlackAuth2.TeamDomain,
@@ -389,7 +389,7 @@ func Test_Apps_Link(t *testing.T) {
 					mockLinkSlackAuth2,
 				}, nil)
 				cm.AddDefaultMocks()
-				setupAppLinkCommandMocks(t, cm, cf)
+				setupAppLinkCommandMocks(t, ctx, cm, cf)
 				cm.IO.On("SelectPrompt",
 					mock.Anything,
 					"Select the existing app team",
@@ -437,9 +437,9 @@ func Test_Apps_Link(t *testing.T) {
 					mockLinkSlackAuth1,
 				}, nil)
 				cm.AddDefaultMocks()
-				setupAppLinkCommandMocks(t, cm, cf)
+				setupAppLinkCommandMocks(t, ctx, cm, cf)
 				// Set manifest source to project to trigger confirmation prompt
-				if err := cm.Config.ProjectConfig.SetManifestSource(t.Context(), config.MANIFEST_SOURCE_LOCAL); err != nil {
+				if err := cm.Config.ProjectConfig.SetManifestSource(ctx, config.MANIFEST_SOURCE_LOCAL); err != nil {
 					require.FailNow(t, fmt.Sprintf("Failed to set the manifest source in the memory-based file system: %s", err))
 				}
 				// Accept manifest source confirmation prompt
@@ -506,9 +506,9 @@ func Test_Apps_Link(t *testing.T) {
 		"decline manifest source prompt should not link app": {
 			Setup: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock, cf *shared.ClientFactory) {
 				cm.AddDefaultMocks()
-				setupAppLinkCommandMocks(t, cm, cf)
+				setupAppLinkCommandMocks(t, ctx, cm, cf)
 				// Set manifest source to project to trigger confirmation prompt
-				if err := cm.Config.ProjectConfig.SetManifestSource(t.Context(), config.MANIFEST_SOURCE_LOCAL); err != nil {
+				if err := cm.Config.ProjectConfig.SetManifestSource(ctx, config.MANIFEST_SOURCE_LOCAL); err != nil {
 					require.FailNow(t, fmt.Sprintf("Failed to set the manifest source in the memory-based file system: %s", err))
 				}
 				// Decline manifest source confirmation prompt
@@ -593,8 +593,7 @@ func Test_Apps_LinkAppHeaderSection(t *testing.T) {
 	}
 }
 
-func setupAppLinkCommandMocks(t *testing.T, cm *shared.ClientsMock, cf *shared.ClientFactory) {
-	ctx := t.Context()
+func setupAppLinkCommandMocks(t *testing.T, ctx context.Context, cm *shared.ClientsMock, cf *shared.ClientFactory) {
 	projectDirPath := slackdeps.MockWorkingDirectory
 	cm.Os.On("Getwd").Return(projectDirPath, nil)
 

cmd/auth/list.go

@@ -51,8 +51,9 @@ func NewListCommand(clients *shared.ClientFactory) *cobra.Command {
 
 // runListCommand will execute the list command
 func runListCommand(cmd *cobra.Command, clients *shared.ClientFactory) error {
+	ctx := cmd.Context()
 	log := newListLogger(cmd, clients.IO)
-	userAuthList, err := listFunc(cmd.Context(), clients, log)
+	userAuthList, err := listFunc(ctx, clients, log)
 	if err != nil {
 		return err
 	}
@@ -87,6 +88,8 @@ func newListLogger(cmd *cobra.Command, IO iostreams.IOStreamer) *logger.Logger {
 // API Host: https://dev.slack.com (optional, only shown for custom API Hosts)
 // Last Updated: 2021-03-12 11:18:00 -0700
 func printAuthList(cmd *cobra.Command, IO iostreams.IOStreamer, userAuthList []types.SlackAuth) {
+	ctx := cmd.Context()
+
 	// Based on loosely on time.RFC3339
 	timeFormat := "2006-01-02 15:04:05 Z07:00"
 
@@ -121,7 +124,7 @@ func printAuthList(cmd *cobra.Command, IO iostreams.IOStreamer, userAuthList []t
 		cmd.Println()
 
 		// Print a trace with info about the authorization
-		IO.PrintTrace(cmd.Context(), slacktrace.AuthListInfo, authInfo.UserID, authInfo.TeamID)
+		IO.PrintTrace(ctx, slacktrace.AuthListInfo, authInfo.UserID, authInfo.TeamID)
 	}
 
 	// When there are no authorizations
@@ -130,11 +133,12 @@ func printAuthList(cmd *cobra.Command, IO iostreams.IOStreamer, userAuthList []t
 	}
 
 	// Print a trace with the total number of authorized workspaces
-	IO.PrintTrace(cmd.Context(), slacktrace.AuthListCount, fmt.Sprint(len(userAuthList)))
+	IO.PrintTrace(ctx, slacktrace.AuthListCount, fmt.Sprint(len(userAuthList)))
 }
 
 // printAuthListSuccess is displayed at the very end and helps guide the developer toward next steps.
 func printAuthListSuccess(cmd *cobra.Command, IO iostreams.IOStreamer, userAuthList []types.SlackAuth) {
+	ctx := cmd.Context()
 	commandText := style.Commandf("login", true)
 
 	// When there are no authorizations, guide the user to creating an authorization.
@@ -145,5 +149,5 @@ func printAuthListSuccess(cmd *cobra.Command, IO iostreams.IOStreamer, userAuthL
 		)
 	}
 
-	IO.PrintTrace(cmd.Context(), slacktrace.AuthListSuccess)
+	IO.PrintTrace(ctx, slacktrace.AuthListSuccess)
 }

cmd/auth/login.go

@@ -127,14 +127,15 @@ func RunLoginCommand(clients *shared.ClientFactory, cmd *cobra.Command) (types.S
 }
 
 func printAuthSuccess(cmd *cobra.Command, IO iostreams.IOStreamer, credentialsPath string, token string) {
+	ctx := cmd.Context()
+
 	var secondaryLog string
 	if credentialsPath != "" {
 		secondaryLog = fmt.Sprintf("Authorization data was saved to %s", style.HomePath(credentialsPath))
 	} else if serviceTokenFlag && tokenFlag == "" {
 		secondaryLog = fmt.Sprintf("Service token:\n\n  %s\n\nMake sure to copy the token now and save it safely.", token)
 	}
 
-	ctx := cmd.Context()
 	IO.PrintInfo(ctx, false, "\n%s", style.Sectionf(style.TextSection{
 		Emoji:     "key",
 		Text:      "You've successfully authenticated!",

cmd/collaborators/add.go

@@ -58,7 +58,8 @@ func NewAddCommand(clients *shared.ClientFactory) *cobra.Command {
 			return cmdutil.IsValidProjectDirectory(clients)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return runAddCommandFunc(cmd.Context(), clients, cmd, args)
+			ctx := cmd.Context()
+			return runAddCommandFunc(ctx, clients, cmd, args)
 		},
 	}
 	cmd.Flags().StringVarP(&addFlags.permissionType, "permission-type", "P", "", "collaborator permission type: reader, owner")

cmd/collaborators/list.go

@@ -53,9 +53,8 @@ func NewListCommand(clients *shared.ClientFactory) *cobra.Command {
 
 // runListCommand will execute the list command
 func runListCommand(cmd *cobra.Command, clients *shared.ClientFactory) error {
-	var span opentracing.Span
 	ctx := cmd.Context()
-	span, ctx = opentracing.StartSpanFromContext(ctx, "cmd.Collaborators.List")
+	span, _ := opentracing.StartSpanFromContext(ctx, "cmd.Collaborators.List")
 	defer span.Finish()
 
 	// Get the app auth selection from the flag or prompt

cmd/collaborators/remove.go

@@ -48,7 +48,8 @@ func NewRemoveCommand(clients *shared.ClientFactory) *cobra.Command {
 			return cmdutil.IsValidProjectDirectory(clients)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return runRemoveCommandFunc(cmd.Context(), clients, cmd, args)
+			ctx := cmd.Context()
+			return runRemoveCommandFunc(ctx, clients, cmd, args)
 		},
 	}
 }

cmd/collaborators/update.go

@@ -74,9 +74,8 @@ func NewUpdateCommand(clients *shared.ClientFactory) *cobra.Command {
 
 // runUpdateCommand will execute the update command
 func runUpdateCommand(cmd *cobra.Command, clients *shared.ClientFactory, args []string) error {
-	var span opentracing.Span
 	ctx := cmd.Context()
-	span, ctx = opentracing.StartSpanFromContext(ctx, "cmd.Collaborators.Update")
+	span, _ := opentracing.StartSpanFromContext(ctx, "cmd.Collaborators.Update")
 	defer span.Finish()
 
 	var slackUser types.SlackUser

cmd/doctor/doctor_test.go

@@ -51,6 +51,7 @@ func TestDoctorCommand(t *testing.T) {
 	expectedUpdateTime := "0001-01-01 00:00:00 Z"
 
 	t.Run("creates a complete report", func(t *testing.T) {
+		ctx := slackcontext.MockContext(t.Context())
 		clientsMock := shared.NewClientsMock()
 		clientsMock.AuthInterface.On("Auths", mock.Anything).Return([]types.SlackAuth{expectedCredentials}, nil)
 		clientsMock.AuthInterface.On("ResolveApiHost", mock.Anything, mock.Anything, mock.Anything).Return("api.slack.com")
@@ -90,7 +91,7 @@ func TestDoctorCommand(t *testing.T) {
 		err := cmd.Execute()
 		require.NoError(t, err)
 
-		report, err := performChecks(cmd.Context(), clients)
+		report, err := performChecks(ctx, clients)
 		require.NoError(t, err)
 
 		expectedValues := DoctorReport{

cmd/fingerprint/fingerprint.go

@@ -43,10 +43,11 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
 			{Command: "_fingerprint", Meaning: "Print the unique value that identifies the Slack CLI binary"},
 		}),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			var span, _ = opentracing.StartSpanFromContext(cmd.Context(), "cmd._fingerprint")
+			ctx := cmd.Context()
+			var span, _ = opentracing.StartSpanFromContext(ctx, "cmd._fingerprint")
 			defer span.Finish()
 
-			clients.IO.PrintInfo(cmd.Context(), false, fingerprintHash)
+			clients.IO.PrintInfo(ctx, false, fingerprintHash)
 			return nil
 		},
 	}