test: stub AreCredsFromEnvVars in app init to speed tests by 70s (aws#2465)

efekarakus · web-flow · commit a486bacac9a7 · 2021-06-15T22:44:05.000Z
🤦 Previously, we were calling sessions.AreCredsFromEnvVars in our tests which would timeout after 10s: https://github.com/aws/copilot-cli/blob/f2f0ee317e01b9da85ab72ecd64481c10658cd05/internal/pkg/aws/sessions/sessions.go#L28 Since the test TestInitAppOpts_Ask has 7 testcases it would take 70s to test the cli package. With this one weird trick™️ and replacing the functional call with a fake, we speed up our tests by 70s. By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
diff --git a/internal/pkg/cli/app_init.go b/internal/pkg/cli/app_init.go
@@ -41,13 +41,14 @@ type initAppVars struct {
 type initAppOpts struct {
 	initAppVars
 
-	identity identityService
-	store    applicationStore
-	route53  domainHostedZoneGetter
-	ws       wsAppManager
-	cfn      appDeployer
-	prompt   prompter
-	prog     progress
+	identity             identityService
+	store                applicationStore
+	route53              domainHostedZoneGetter
+	ws                   wsAppManager
+	cfn                  appDeployer
+	prompt               prompter
+	prog                 progress
+	isSessionFromEnvVars func() (bool, error)
 
 	cachedHostedZoneID string
 }
@@ -75,6 +76,9 @@ func newInitAppOpts(vars initAppVars) (*initAppOpts, error) {
 		cfn:         cloudformation.New(sess),
 		prompt:      prompt.New(),
 		prog:        termprogress.NewSpinner(log.DiagnosticWriter),
+		isSessionFromEnvVars: func() (bool, error) {
+			return sessions.AreCredsFromEnvVars(sess)
+		},
 	}, nil
 }
 
@@ -100,11 +104,7 @@ func (o *initAppOpts) Validate() error {
 
 // Ask prompts the user for any required arguments that they didn't provide.
 func (o *initAppOpts) Ask() error {
-	sess, err := sessions.NewProvider().Default()
-	if err != nil {
-		return fmt.Errorf("get default session: %w", err)
-	}
-	if ok, _ := sessions.AreCredsFromEnvVars(sess); ok { // Ignore the error, we do not want to crash for a warning.
+	if ok, _ := o.isSessionFromEnvVars(); ok { // Ignore the error, we do not want to crash for a warning.
 		log.Warningln(`Looks like you're creating an application using credentials set by environment variables.
 Copilot will store your application metadata in this account.
 We recommend using credentials from named profiles. To learn more:
diff --git a/internal/pkg/cli/app_init_test.go b/internal/pkg/cli/app_init_test.go
@@ -266,6 +266,9 @@ func TestInitAppOpts_Ask(t *testing.T) {
 				store:  mocks.NewMockstore(ctrl),
 				ws:     mocks.NewMockwsAppManager(ctrl),
 				prompt: mocks.NewMockprompter(ctrl),
+				isSessionFromEnvVars: func() (bool, error) {
+					return false, nil
+				},
 			}
 			tc.expect(opts)
 
diff --git a/internal/pkg/cli/init.go b/internal/pkg/cli/init.go
@@ -116,6 +116,9 @@ func newInitOpts(vars initVars) (*initOpts, error) {
 		identity: id,
 		cfn:      deployer,
 		prog:     spin,
+		isSessionFromEnvVars: func() (bool, error) {
+			return sessions.AreCredsFromEnvVars(defaultSess)
+		},
 	}
 	initEnvCmd := &initEnvOpts{
 		initEnvVars: initEnvVars{

Original file line number	Diff line number	Diff line change
`@@ -266,6 +266,9 @@ func TestInitAppOpts_Ask(t *testing.T) {`
`266`	`266`	`store: mocks.NewMockstore(ctrl),`
`267`	`267`	`ws: mocks.NewMockwsAppManager(ctrl),`
`268`	`268`	`prompt: mocks.NewMockprompter(ctrl),`
	`269`	`+ isSessionFromEnvVars: func() (bool, error) {`
	`270`	`+ return false, nil`
	`271`	`+ },`
`269`	`272`	`}`
`270`	`273`	`tc.expect(opts)`
`271`	`274`