test: make shared secret names unique (#910)

* test: make shared secret names unique

* try this

* try this

* try that

* poke ci

* test

* test

* test

* test

* test

* test

* poke ci

* Revert "test"

This reverts commit 1b8b847.

* test

* test

* this should work

* fix lint

* fix e2e hotswap test with shared secrets

* uncomment project tear down in e2e test

* add amplifySharedSecretNameKey

* Revert "add amplifySharedSecretNameKey"

This reverts commit b5f9050.

* add amplifySharedSecretNameKey

* fix lint

* remove createSharedSecretEnvObject

* try this

Author: rtpascual

.changeset/mean-starfishes-travel.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/integration-tests': patch
+---
+
+Make shared secret names unique for e2e tests

packages/integration-tests/src/shared_secret.ts

@@ -0,0 +1,10 @@
+import { shortUuid } from './short_uuid.js';
+
+/**
+ * Create a unique shared secret name
+ */
+export const createAmplifySharedSecretName = (): string => {
+  return 'amplifySharedSecret' + shortUuid();
+};
+
+export const amplifySharedSecretNameKey = 'AMPLIFY_SHARED_SECRET_NAME';

packages/integration-tests/src/test-e2e/deployment.test.ts

@@ -25,6 +25,10 @@ import { ClientConfigFormat } from '@aws-amplify/client-config';
 import { testConcurrencyLevel } from './test_concurrency.js';
 import { TestCdkProjectBase } from '../test-project-setup/cdk/test_cdk_project_base.js';
 import { getTestCdkProjectCreators } from '../test-project-setup/cdk/test_cdk_project_creator.js';
+import {
+  amplifySharedSecretNameKey,
+  createAmplifySharedSecretName,
+} from '../shared_secret.js';
 
 const testProjectCreators = getTestProjectCreators();
 const testCdkProjectCreators = getTestCdkProjectCreators();
@@ -122,15 +126,24 @@ void describe('deployment tests', { concurrency: testConcurrencyLevel }, () => {
         });
 
         void describe('in sequence', { concurrency: false }, () => {
+          const sharedSecretsEnv = {
+            [amplifySharedSecretNameKey]: createAmplifySharedSecretName(),
+          };
           void it(`[${testProjectCreator.name}] deploys fully`, async () => {
-            await testProject.deploy(sandboxBackendIdentifier);
+            await testProject.deploy(
+              sandboxBackendIdentifier,
+              sharedSecretsEnv
+            );
             await testProject.assertPostDeployment(sandboxBackendIdentifier);
           });
 
           void it(`[${testProjectCreator.name}] hot-swaps a change`, async () => {
             const processController = amplifyCli(
               ['sandbox', '--dirToWatch', 'amplify'],
-              testProject.projectDirPath
+              testProject.projectDirPath,
+              {
+                env: sharedSecretsEnv,
+              }
             );
 
             const updates = await testProject.getUpdates();

packages/integration-tests/src/test-project-setup/data_storage_auth_with_triggers.ts

@@ -10,6 +10,10 @@ import { TestProjectCreator } from './test_project_creator.js';
 import { DeployedResourcesFinder } from '../find_deployed_resource.js';
 import assert from 'node:assert';
 import { InvokeCommand, LambdaClient } from '@aws-sdk/client-lambda';
+import {
+  amplifySharedSecretNameKey,
+  createAmplifySharedSecretName,
+} from '../shared_secret.js';
 
 /**
  * Creates test projects with data, storage, and auth categories.
@@ -85,7 +89,7 @@ class DataStorageAuthWithTriggerTestProject extends TestProjectBase {
     'amazonSecret',
   ];
 
-  private readonly testSharedSecretNames = ['amplifySharedSecret'];
+  private amplifySharedSecret: string;
 
   /**
    * Create a test project instance.
@@ -105,9 +109,19 @@ class DataStorageAuthWithTriggerTestProject extends TestProjectBase {
   /**
    * @inheritdoc
    */
-  override async deploy(backendIdentifier: BackendIdentifier) {
+  override async deploy(
+    backendIdentifier: BackendIdentifier,
+    environment: Record<string, string> = {}
+  ) {
+    this.amplifySharedSecret =
+      amplifySharedSecretNameKey in environment
+        ? environment[amplifySharedSecretNameKey]
+        : createAmplifySharedSecretName();
+    const sharedSecretEnvObject = {
+      [amplifySharedSecretNameKey]: this.amplifySharedSecret,
+    };
     await this.setUpDeployEnvironment(backendIdentifier);
-    await super.deploy(backendIdentifier);
+    await super.deploy(backendIdentifier, sharedSecretEnvObject);
   }
 
   /**
@@ -147,7 +161,6 @@ class DataStorageAuthWithTriggerTestProject extends TestProjectBase {
     backendId: BackendIdentifier
   ): Promise<void> {
     await super.assertPostDeployment(backendId);
-
     // Check that deployed lambda is working correctly
 
     // find lambda function
@@ -171,7 +184,7 @@ class DataStorageAuthWithTriggerTestProject extends TestProjectBase {
     assert.equal(
       responsePayload,
       // eslint-disable-next-line spellcheck/spell-checker
-      'Your uuid is 6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b. TEST_SECRET env var value is amazonSecret-e2eTestValue. TEST_SHARED_SECRET env var value is amplifySharedSecret-e2eTestSharedValue.'
+      `Your uuid is 6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b. TEST_SECRET env var value is amazonSecret-e2eTestValue. TEST_SHARED_SECRET env var value is ${this.amplifySharedSecret}-e2eTestSharedValue.`
     );
   }
 
@@ -182,14 +195,12 @@ class DataStorageAuthWithTriggerTestProject extends TestProjectBase {
       const secretValue = `${secretName}-e2eTestValue`;
       await this.secretClient.setSecret(backendId, secretName, secretValue);
     }
-    for (const sharedSecretName of this.testSharedSecretNames) {
-      const secretValue = `${sharedSecretName}-e2eTestSharedValue`;
-      await this.secretClient.setSecret(
-        backendId.namespace,
-        sharedSecretName,
-        secretValue
-      );
-    }
+    const secretValue = `${this.amplifySharedSecret}-e2eTestSharedValue`;
+    await this.secretClient.setSecret(
+      backendId.namespace,
+      this.amplifySharedSecret,
+      secretValue
+    );
   };
 
   private clearDeployEnvironment = async (
@@ -199,11 +210,9 @@ class DataStorageAuthWithTriggerTestProject extends TestProjectBase {
     for (const secretName of this.testSecretNames) {
       await this.secretClient.removeSecret(backendId, secretName);
     }
-    for (const sharedSecretName of this.testSharedSecretNames) {
-      await this.secretClient.removeSecret(
-        backendId.namespace,
-        sharedSecretName
-      );
-    }
+    await this.secretClient.removeSecret(
+      backendId.namespace,
+      this.amplifySharedSecret
+    );
   };
 }

packages/integration-tests/src/test-project-setup/test_project_base.ts

@@ -57,9 +57,14 @@ export abstract class TestProjectBase {
   /**
    * Deploy the project.
    */
-  async deploy(backendIdentifier: BackendIdentifier) {
+  async deploy(
+    backendIdentifier: BackendIdentifier,
+    environment?: Record<string, string>
+  ) {
     if (backendIdentifier.type === 'sandbox') {
-      await amplifyCli(['sandbox'], this.projectDirPath)
+      await amplifyCli(['sandbox'], this.projectDirPath, {
+        env: environment,
+      })
         .do(waitForSandboxDeploymentToPrintTotalTime())
         .do(interruptSandbox())
         .do(rejectCleanupSandbox())
@@ -75,7 +80,10 @@ export abstract class TestProjectBase {
         ],
         this.projectDirPath,
         {
-          env: { CI: 'true' },
+          env: {
+            CI: 'true',
+            ...environment,
+          },
         }
       ).run();
     }

packages/integration-tests/src/test-projects/data-storage-auth-with-triggers-ts/amplify/function.ts

@@ -1,10 +1,11 @@
 import { defineFunction, secret } from '@aws-amplify/backend';
+import { amplifySharedSecretNameKey } from '../../../shared_secret.js';
 
 export const myFunc = defineFunction({
   name: 'specialTestFunction',
   entry: './func-src/handler.ts',
   environment: {
     TEST_SECRET: secret('amazonSecret'),
-    TEST_SHARED_SECRET: secret('amplifySharedSecret'),
+    TEST_SHARED_SECRET: secret(process.env[amplifySharedSecretNameKey] as string),
   },
 });