Add flag to retain test project deployment. (#2151)

Author: Kamil Sobol

.changeset/chilled-clouds-judge.md

@@ -0,0 +1,2 @@
+---
+---

packages/integration-tests/README.md

@@ -17,14 +17,25 @@ or `npm run test:dir packages/integration-tests/lib/test-in-memory` (to run them
 The create-amplify e2e suite tests the first-time installation and setup of a new amplify backend project. To run this suite, run
 `npm run test:dir packages/integration-tests/lib/test-e2e/create_amplify.test.js`
 
-## deployment tests
+## deployment and sandbox tests
 
-To run end-to-end deployment tests, credentials to an AWS account must be available on the machine. Any credentials that will be picked up by the
+To run end-to-end deployment or sandbox tests, credentials to an AWS account must be available on the machine. Any credentials that will be picked up by the
 [default node credential provider](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html) should work.
-This include setting environment variables for a default profile.
+This includes setting environment variables for a default profile.
 
-To run this suite, run
-`npm run test:dir packages/integration-tests/lib/test-e2e/deployment.test.js`
+To run deployment suite, run
+`npm run test:dir packages/integration-tests/lib/test-e2e/deployment/*.deployment.test.js`
+
+To run sandbox suite, run
+`npm run test:dir packages/integration-tests/lib/test-e2e/sandbox/*.sandbox.test.js`
+
+To run deployment or sandbox test for specific project, specify exact test file, for example
+`npm run test:dir packages/integration-tests/lib/test-e2e/sandbox/data_storage_auth_with_triggers.sandbox.test.js`
+
+When working locally with sandbox tests, it is sometimes useful to retain deployment of test project to avoid full re-deployments while working
+on single test project incrementally. To retain deployment set `AMPLIFY_BACKEND_TESTS_RETAIN_TEST_PROJECT_DEPLOYMENT` environment
+variable to `true`. This flag disables project name randomization and deployment cleanup, so that subsequent runs of same test
+target the same CFN stacks. This option is not available for deployment tests (hotswap is not going to work there anyway).
 
 ## backend-output tests
 

packages/integration-tests/src/test-e2e/sandbox/sandbox.test.template.ts

@@ -48,7 +48,12 @@ export const defineSandboxTest = (testProjectCreator: TestProjectCreator) => {
       });
 
       after(async () => {
-        await testProject.tearDown(sandboxBackendIdentifier);
+        if (
+          process.env.AMPLIFY_BACKEND_TESTS_RETAIN_TEST_PROJECT_DEPLOYMENT !==
+          'true'
+        ) {
+          await testProject.tearDown(sandboxBackendIdentifier);
+        }
       });
 
       void describe('in sequence', { concurrency: false }, () => {

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

@@ -19,7 +19,12 @@ export const createEmptyAmplifyProject = async (
   projectDotAmplifyDir: string;
 }> => {
   const projectRoot = await fs.mkdtemp(path.join(parentDir, projectDirName));
-  const projectName = `${TEST_PROJECT_PREFIX}-${projectDirName}-${shortUuid()}`;
+  let projectName = `${TEST_PROJECT_PREFIX}-${projectDirName}`;
+  if (
+    process.env.AMPLIFY_BACKEND_TESTS_RETAIN_TEST_PROJECT_DEPLOYMENT !== 'true'
+  ) {
+    projectName += `-${shortUuid()}`;
+  }
   await fs.writeFile(
     path.join(projectRoot, 'package.json'),
     JSON.stringify({ name: projectName, type: 'module' }, null, 2)