refactor: move env vars from tests into one place (#4103)

fmenezes · web-flow · commit 5e9efb07297d · 2025-08-07T15:39:54.000Z
diff --git a/.github/workflows/update-e2e-tests.yml b/.github/workflows/update-e2e-tests.yml
@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        packages:
+        package:
           - atlas/autogeneration
           - atlas/backup/compliancepolicy
           - atlas/backup/flex
@@ -78,16 +78,15 @@ jobs:
       - run: make e2e-test
         env:
           TEST_CMD: gotestsum --junitfile e2e-tests.xml --format standard-verbose --
-          E2E_TEST_PACKAGES: ./test/e2e/{{ matrix.packages }}/...
+          E2E_TEST_PACKAGES: ./test/e2e/${{ matrix.package }}/...
           MONGODB_ATLAS_ORG_ID: ${{ secrets.MONGODB_ATLAS_ORG_ID }}
           MONGODB_ATLAS_PROJECT_ID: ${{ secrets.MONGODB_ATLAS_PROJECT_ID }}
           MONGODB_ATLAS_PUBLIC_API_KEY: ${{ secrets.MONGODB_ATLAS_PUBLIC_API_KEY }}
           MONGODB_ATLAS_PRIVATE_API_KEY: ${{ secrets.MONGODB_ATLAS_PRIVATE_API_KEY }}
           MONGODB_ATLAS_OPS_MANAGER_URL: ${{ secrets.MONGODB_ATLAS_OPS_MANAGER_URL }}
           MONGODB_ATLAS_SERVICE: cloud
           DO_NOT_TRACK: 1
-          UPDATE_SNAPSHOTS: true
-          E2E_SKIP_CLEANUP: true
+          TEST_MODE: record
           E2E_CLOUD_ROLE_ID: ${{ secrets.E2E_CLOUD_ROLE_ID }}
           E2E_TEST_BUCKET: ${{ secrets.E2E_TEST_BUCKET }}
           E2E_FLEX_INSTANCE_NAME: ${{ secrets.E2E_FLEX_INSTANCE_NAME }}
@@ -103,7 +102,7 @@ jobs:
         if: always()
         id: set-artifact-name
         run: |
-          echo "NAME=snapshots_${{ matrix.packages }}" | sed "s|/|_|g" >> "$GITHUB_OUTPUT"
+          echo "NAME=snapshots_${{ matrix.package }}" | sed "s|/|_|g" >> "$GITHUB_OUTPUT"
       - name: upload artifact
         if: always()
         uses: actions/upload-artifact@v4.6.2
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -126,11 +126,11 @@ Review and replace the atlas settings.
 {
   "go.testEnvVars": {
     "ATLAS_E2E_BINARY": "${workspaceFolder}/bin/atlas",
-    "UPDATE_SNAPSHOTS": "skip",
+    "TEST_MODE": "live",
     "SNAPSHOTS_DIR": "${workspaceFolder}/test/e2e/testdata/.snapshots",
     "GOCOVERDIR": "${workspaceFolder}/cov",
     "DO_NOT_TRACK": "1",
-    "E2E_SKIP_CLEANUP": "false",
+    "MONGODB_ATLAS_SKIP_UPDATE_CHECK": "yes",
     "MONGODB_ATLAS_ORG_ID": "<default org id>",
     "MONGODB_ATLAS_PROJECT_ID": "<default project id>",
     "MONGODB_ATLAS_PRIVATE_API_KEY": "<private key>",
@@ -274,7 +274,7 @@ To update simply rename all instances of major version across the repository imp
 
 e.g `v20230201001` => `v20230201002` 
 
-### Update Automation
+### Update SDK Automation
 
 To update Atlas SDK run:
 
diff --git a/Makefile b/Makefile
@@ -29,8 +29,7 @@ E2E_TEST_PACKAGES?=./test/e2e/...
 E2E_TIMEOUT?=60m
 E2E_PARALLEL?=1
 E2E_EXTRA_ARGS?=
-export UPDATE_SNAPSHOTS?=skip
-export E2E_SKIP_CLEANUP?=false 
+export TEST_MODE?=live
 export MONGODB_ATLAS_ORG_ID?=a0123456789abcdef012345a
 export MONGODB_ATLAS_PROJECT_ID?=b0123456789abcdef012345b
 export MONGODB_ATLAS_PUBLIC_API_KEY?=ABCDEF01
@@ -174,7 +173,7 @@ e2e-test: build-debug ## Run E2E tests
 
 .PHONY: e2e-test-snapshots
 e2e-test-snapshots: build-debug ## Run E2E tests
-	UPDATE_SNAPSHOTS=false E2E_SKIP_CLEANUP=true DO_NOT_TRACK=1 $(TEST_CMD) -v -timeout $(E2E_TIMEOUT) ${E2E_TEST_PACKAGES} $(E2E_EXTRA_ARGS)
+	TEST_MODE=replay DO_NOT_TRACK=1 $(TEST_CMD) -v -timeout $(E2E_TIMEOUT) ${E2E_TEST_PACKAGES} $(E2E_EXTRA_ARGS)
 	go tool covdata textfmt -i $(GOCOVERDIR) -o $(COVERAGE)
 
 .PHONY: unit-test
diff --git a/build/ci/evergreen.yml b/build/ci/evergreen.yml
@@ -136,7 +136,6 @@ functions:
           - AZURE_CLIENT_ID
           - AZURE_CLIENT_SECRET
           - E2E_TIMEOUT
-          - E2E_SERVERLESS_INSTANCE_NAME
           - E2E_FLEX_INSTANCE_NAME
           - E2E_PARALLEL
           - IDENTITY_PROVIDER_ID
@@ -146,6 +145,7 @@ functions:
           <<: *go_env
           MONGODB_ATLAS_SKIP_UPDATE_CHECK: "yes"
           DO_NOT_TRACK: "1"
+          TEST_MODE: live
           TEST_CMD: gotestsum --junitfile e2e-tests.xml --format standard-verbose --
         command: make e2e-test
   "install gotestsum":
diff --git a/test/e2e/atlas/backup/exports/buckets/backupexportbuckets/backup_export_buckets_test.go b/test/e2e/atlas/backup/exports/buckets/backupexportbuckets/backup_export_buckets_test.go
@@ -43,10 +43,10 @@ func TestExportBuckets(t *testing.T) {
 	r.NoError(err)
 
 	const cloudProvider = "AWS"
-	iamRoleID := os.Getenv("E2E_CLOUD_ROLE_ID")
-	bucketName := os.Getenv("E2E_TEST_BUCKET")
-	r.NotEmpty(iamRoleID)
-	r.NotEmpty(bucketName)
+	iamRoleID, err := internal.CloudRoleID()
+	r.NoError(err)
+	bucketName, err := internal.TestBucketName()
+	r.NoError(err)
 	var bucketID string
 
 	g.Run("Create", func(t *testing.T) { //nolint:thelper // g.Run replaces t.Run
diff --git a/test/e2e/atlas/backup/exports/jobs/backupexportjobs/backup_export_jobs_test.go b/test/e2e/atlas/backup/exports/jobs/backupexportjobs/backup_export_jobs_test.go
@@ -58,10 +58,10 @@ func TestExportJobs(t *testing.T) {
 	r.NoError(err)
 
 	const cloudProvider = "AWS"
-	iamRoleID := os.Getenv("E2E_CLOUD_ROLE_ID")
-	bucketName := os.Getenv("E2E_TEST_BUCKET")
-	r.NotEmpty(iamRoleID)
-	r.NotEmpty(bucketName)
+	iamRoleID, err := internal.CloudRoleID()
+	r.NoError(err)
+	bucketName, err := internal.TestBucketName()
+	r.NoError(err)
 	var bucketID string
 	var exportJobID string
 	var snapshotID string
diff --git a/test/e2e/atlas/backup/flex/backupflex/backup_flex_test.go b/test/e2e/atlas/backup/flex/backupflex/backup_flex_test.go
@@ -49,8 +49,8 @@ func TestFlexBackup(t *testing.T) {
 	g.ProjectID = os.Getenv("MONGODB_ATLAS_PROJECT_ID")
 	generateFlexCluster(t, g)
 
-	clusterName := os.Getenv("E2E_FLEX_INSTANCE_NAME")
-	require.NotEmpty(t, clusterName)
+	clusterName, err := internal.FlexInstanceName()
+	require.NoError(t, err)
 
 	var snapshotID string
 	g.Run("Snapshot List", func(t *testing.T) { //nolint:thelper // g.Run replaces t.Run
diff --git a/test/e2e/atlas/datafederation/db/datafederationdb/data_federation_db_test.go b/test/e2e/atlas/datafederation/db/datafederationdb/data_federation_db_test.go
@@ -46,10 +46,10 @@ func TestDataFederation(t *testing.T) {
 	n := g.MemoryRand("rand", 1000)
 
 	dataFederationName := fmt.Sprintf("e2e-data-federation-%v", n)
-	testBucket := os.Getenv("E2E_TEST_BUCKET")
-	r.NotEmpty(testBucket)
-	roleID := os.Getenv("E2E_CLOUD_ROLE_ID")
-	r.NotEmpty(roleID)
+	testBucket, err := internal.TestBucketName()
+	r.NoError(err)
+	roleID, err := internal.CloudRoleID()
+	r.NoError(err)
 
 	g.Run("Create", func(t *testing.T) { //nolint:thelper // g.Run replaces t.Run
 		cmd := exec.Command(cliPath,
diff --git a/test/e2e/atlas/datafederation/querylimits/datafederationquerylimit/data_federation_query_limit_test.go b/test/e2e/atlas/datafederation/querylimits/datafederationquerylimit/data_federation_query_limit_test.go
@@ -44,10 +44,10 @@ func TestDataFederationQueryLimit(t *testing.T) {
 
 	n := g.MemoryRand("rand", 1000)
 	dataFederationName := fmt.Sprintf("e2e-data-federation-%v", n)
-	testBucket := os.Getenv("E2E_TEST_BUCKET")
-	r.NotEmpty(testBucket)
-	roleID := os.Getenv("E2E_CLOUD_ROLE_ID")
-	r.NotEmpty(roleID)
+	testBucket, err := internal.TestBucketName()
+	r.NoError(err)
+	roleID, err := internal.CloudRoleID()
+	r.NoError(err)
 
 	limitName := "bytesProcessed.query"
 
diff --git a/test/e2e/atlas/decrypt/decryptionaws/decryption_aws_test.go b/test/e2e/atlas/decrypt/decryptionaws/decryption_aws_test.go
@@ -35,12 +35,16 @@ func TestDecryptWithAWS(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
 	_ = internal.NewAtlasE2ETestGenerator(t, internal.WithSnapshot())
-	req := require.New(t)
 
 	cliPath, err := internal.AtlasCLIBin()
 	req.NoError(err)
diff --git a/test/e2e/atlas/decrypt/decryptionazure/decryption_azure_test.go b/test/e2e/atlas/decrypt/decryptionazure/decryption_azure_test.go
@@ -35,12 +35,15 @@ func TestDecryptWithAzure(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
 	_ = internal.NewAtlasE2ETestGenerator(t, internal.WithSnapshot())
-	req := require.New(t)
 
 	cliPath, err := internal.AtlasCLIBin()
 	req.NoError(err)
diff --git a/test/e2e/atlas/decrypt/decryptiongcp/decryption_gcp_test.go b/test/e2e/atlas/decrypt/decryptiongcp/decryption_gcp_test.go
@@ -37,7 +37,12 @@ func TestDecryptWithGCP(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	mode, err := internal.TestRunMode()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
@@ -49,8 +54,8 @@ func TestDecryptWithGCP(t *testing.T) {
 
 	tmpDir := t.TempDir()
 
-	GCPCredentialsContent, ok := os.LookupEnv("GCP_CREDENTIALS")
-	req.True(ok, "GCP Credentials not found")
+	GCPCredentialsContent, err := internal.GCPCredentials()
+	req.NoError(err)
 	GCPCredentialsFile := path.Join(tmpDir, "gcp_credentials.json")
 	err = os.WriteFile(GCPCredentialsFile, []byte(GCPCredentialsContent), fs.ModePerm)
 	req.NoError(err)
diff --git a/test/e2e/atlas/decrypt/decryptionlocalkey/decryption_localkey_test.go b/test/e2e/atlas/decrypt/decryptionlocalkey/decryption_localkey_test.go
@@ -35,12 +35,15 @@ func TestDecryptWithLocalKey(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
 	_ = internal.NewAtlasE2ETestGenerator(t, internal.WithSnapshot())
-	req := require.New(t)
 
 	cliPath, err := internal.AtlasCLIBin()
 	req.NoError(err)
diff --git a/test/e2e/atlas/deployments/atlasclusters/deploymentsatlas/deployments_atlas_test.go b/test/e2e/atlas/deployments/atlasclusters/deploymentsatlas/deployments_atlas_test.go
@@ -45,14 +45,17 @@ func TestDeploymentsAtlas(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
 	g := internal.NewAtlasE2ETestGenerator(t, internal.WithSnapshot())
 	g.GenerateProject("setup")
 	cliPath, err := internal.AtlasCLIBin()
-	req := require.New(t)
 	req.NoError(err)
 
 	clusterName := g.Memory("clusterName", internal.Must(internal.RandClusterName())).(string)
diff --git a/test/e2e/atlas/deployments/atlasclusters/deploymentsatlas/deployments_atlas_test_iss.go b/test/e2e/atlas/deployments/atlasclusters/deploymentsatlas/deployments_atlas_test_iss.go
@@ -34,14 +34,17 @@ func TestDeploymentsAtlasISS(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
 	g := internal.NewAtlasE2ETestGenerator(t, internal.WithSnapshot())
 	g.GenerateProject("setup")
 	cliPath, err := internal.AtlasCLIBin()
-	req := require.New(t)
 	req.NoError(err)
 
 	clusterName := g.Memory("clusterName", internal.Must(internal.RandClusterName())).(string)
diff --git a/test/e2e/atlas/deployments/local/auth/deprecated/deploymentslocalauthindexdeprecated/deployments_local_auth_index_deprecated_test.go b/test/e2e/atlas/deployments/local/auth/deprecated/deploymentslocalauthindexdeprecated/deployments_local_auth_index_deprecated_test.go
@@ -51,7 +51,11 @@ func TestDeploymentsLocalWithAuthIndexDeprecated(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
@@ -62,7 +66,6 @@ func TestDeploymentsLocalWithAuthIndexDeprecated(t *testing.T) {
 	)
 
 	cliPath, err := internal.AtlasCLIBin()
-	req := require.New(t)
 	req.NoError(err)
 
 	t.Run("Setup", func(t *testing.T) {
diff --git a/test/e2e/atlas/deployments/local/auth/new/deploymentslocalauth/deployments_local_auth_test.go b/test/e2e/atlas/deployments/local/auth/new/deploymentslocalauth/deployments_local_auth_test.go
@@ -51,7 +51,11 @@ func TestDeploymentsLocalWithAuth(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
@@ -62,7 +66,6 @@ func TestDeploymentsLocalWithAuth(t *testing.T) {
 	)
 
 	cliPath, err := internal.AtlasCLIBin()
-	req := require.New(t)
 	req.NoError(err)
 
 	t.Run("Setup", func(t *testing.T) {
diff --git a/test/e2e/atlas/deployments/local/noauth/deploymentslocalnoauth/deployments_local_noauth_test.go b/test/e2e/atlas/deployments/local/noauth/deploymentslocalnoauth/deployments_local_noauth_test.go
@@ -51,14 +51,17 @@ func TestDeploymentsLocal(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
 	const deploymentName = "test"
 
 	cliPath, err := internal.AtlasCLIBin()
-	req := require.New(t)
 	req.NoError(err)
 
 	t.Run("Setup", func(t *testing.T) {
diff --git a/test/e2e/atlas/deployments/local/nocli/deploymentslocalnocli/deployments_local_nocli_test.go b/test/e2e/atlas/deployments/local/nocli/deploymentslocalnocli/deployments_local_nocli_test.go
@@ -53,7 +53,11 @@ func TestDeploymentsLocalWithNoCLI(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
@@ -64,7 +68,6 @@ func TestDeploymentsLocalWithNoCLI(t *testing.T) {
 	)
 
 	cliPath, err := internal.AtlasCLIBin()
-	req := require.New(t)
 	req.NoError(err)
 
 	bin := "docker"
diff --git a/test/e2e/atlas/deployments/local/seed/deploymentslocalseedfail/deployments_local_seed_fail_test.go b/test/e2e/atlas/deployments/local/seed/deploymentslocalseedfail/deployments_local_seed_fail_test.go
@@ -32,7 +32,11 @@ func TestDeploymentsLocalSeedFail(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	if internal.TestRunMode() != internal.TestModeLive {
+	req := require.New(t)
+	mode, err := internal.TestRunMode()
+	req.NoError(err)
+
+	if mode != internal.TestModeLive {
 		t.Skip("skipping test in snapshot mode")
 	}
 
@@ -43,7 +47,6 @@ func TestDeploymentsLocalSeedFail(t *testing.T) {
 	)
 
 	cliPath, err := internal.AtlasCLIBin()
-	req := require.New(t)
 	req.NoError(err)
 
 	t.Run("Test failed seed setup", func(t *testing.T) {
diff --git a/test/e2e/atlas/generic/dbusers/dbusers_test.go b/test/e2e/atlas/generic/dbusers/dbusers_test.go
diff --git a/test/internal/atlas_e2e_test_generator.go b/test/internal/atlas_e2e_test_generator.go
diff --git a/test/internal/cleanup_test.go b/test/internal/cleanup_test.go
diff --git a/test/internal/env.go b/test/internal/env.go
