feat(awscdk): allow users to integration test multi-stack stages (pro…

…jen#1496) Allows users to add AWS CDK integration tests consisting of stages with multiple stacks. ```ts new awscdk.IntegrationTest(project, { name: "my-stage", entrypoint: "test/my-stage.myinteg.ts", stacks: ["my-stage/*"], tsconfigPath: project.tsconfigDev.fileName, cdkDeps: project.cdkDeps, }); ``` Fixes projen#1495 --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
FitX · Jan 12, 2022 · f6529dc · f6529dc
1 parent 43ee650
commit f6529dc
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 9 deletions.
diff --git a/API.md b/API.md
@@ -3916,6 +3916,8 @@ new awscdk.IntegrationTest(project: Project, options: IntegrationTestOptions)
   * **cdkDeps** (<code>[awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)</code>)  AWS CDK dependency manager. 
   * **entrypoint** (<code>string</code>)  A path from the project root directory to a TypeScript file which contains the integration test app. 
   * **tsconfigPath** (<code>string</code>)  The path of the tsconfig.json file to use when running integration test cdk apps. 
+  * **name** (<code>string</code>)  Name of the integration test. __*Default*__: Derived from the entrypoint filename.
+  * **stacks** (<code>Array<string></code>)  A list of stacks within the integration test to deploy/destroy. __*Default*__: ["*"]
 
 
 
@@ -11703,6 +11705,8 @@ Name | Type | Description
 **entrypoint**🔹 | <code>string</code> | A path from the project root directory to a TypeScript file which contains the integration test app.
 **tsconfigPath**🔹 | <code>string</code> | The path of the tsconfig.json file to use when running integration test cdk apps.
 **destroyAfterDeploy**?🔹 | <code>boolean</code> | Destroy the test app after a successful deployment.<br/>__*Default*__: true
+**name**?🔹 | <code>string</code> | Name of the integration test.<br/>__*Default*__: Derived from the entrypoint filename.
+**stacks**?🔹 | <code>Array<string></code> | A list of stacks within the integration test to deploy/destroy.<br/>__*Default*__: ["*"]
 
 
 

diff --git a/src/awscdk/integration-test.ts b/src/awscdk/integration-test.ts
@@ -19,6 +19,18 @@ export interface IntegrationTestCommonOptions {
  * Options for `IntegrationTest`.
  */
 export interface IntegrationTestOptions extends IntegrationTestCommonOptions {
+  /**
+   * Name of the integration test
+   * @default - Derived from the entrypoint filename.
+   */
+  readonly name?: string;
+
+  /**
+   * A list of stacks within the integration test to deploy/destroy.
+   * @default ["*"]
+   */
+  readonly stacks?: string[];
+
   /**
    * A path from the project root directory to a TypeScript file which contains
    * the integration test app.
@@ -72,7 +84,7 @@ export class IntegrationTest extends Component {
   constructor(project: Project, options: IntegrationTestOptions) {
     super(project);
     const entry = options.entrypoint;
-    const name = basename(entry, TYPESCRIPT_INTEG_EXT);
+    const name = options.name ?? basename(entry, TYPESCRIPT_INTEG_EXT);
     const dir = dirname(entry);
 
     const deploydir = join(dir, ".tmp", `${name}.integ`, "deploy.cdk.out");
@@ -107,13 +119,17 @@ export class IntegrationTest extends Component {
 
     const cdkopts = opts.join(" ");
 
+    // Determine which stacks to deploy
+    const stacks = options.stacks ?? ["*"];
+    const stackOpts = stacks.map((stack) => `'${stack}'`).join(" ");
+
     const deployTask = project.addTask(`integ:${name}:deploy`, {
       description: `deploy integration test '${name}' and capture snapshot`,
     });
 
     deployTask.exec(`rm -fr ${deploydir}`);
     deployTask.exec(
-      `cdk deploy ${cdkopts} --require-approval=never -o ${deploydir}`
+      `cdk deploy ${cdkopts} ${stackOpts} --require-approval=never -o ${deploydir}`
     );
 
     // if deployment was successful, copy the deploy dir to the expected dir
@@ -122,12 +138,12 @@ export class IntegrationTest extends Component {
 
     const watchTask = project.addTask(`integ:${name}:watch`, {
       description: `watch integration test '${name}' (without updating snapshots)`,
-      exec: `cdk watch ${cdkopts} -o ${deploydir}`,
+      exec: `cdk watch ${cdkopts} ${stackOpts} -o ${deploydir}`,
     });
 
     const destroyTask = project.addTask(`integ:${name}:destroy`, {
       description: `destroy integration test '${name}'`,
-      exec: `cdk destroy --app ${snapshotdir} --no-version-reporting`,
+      exec: `cdk destroy --app ${snapshotdir} ${stackOpts} --no-version-reporting`,
     });
 
     const destroyAfterDeploy = options.destroyAfterDeploy ?? true;

diff --git a/test/awscdk/__snapshots__/integration-test.test.ts.snap b/test/awscdk/__snapshots__/integration-test.test.ts.snap
diff --git a/test/awscdk/integration-test.test.ts b/test/awscdk/integration-test.test.ts
@@ -118,3 +118,34 @@ test("synthesizing cdk v2 integration tests", () => {
     output[".projen/tasks.json"].tasks["integ:foo:watch"]
   ).toMatchSnapshot();
 });
+
+test("synthesizing an integration test containing a multi-stack stage", () => {
+  // GIVEN
+  const project = new awscdk.AwsCdkTypeScriptApp({
+    name: "test",
+    defaultReleaseBranch: "main",
+    cdkVersion: "2.3.1",
+  });
+
+  // WHEN
+  new awscdk.IntegrationTest(project, {
+    name: "my-stage",
+    entrypoint: "test/my-stage.myinteg.ts",
+    stacks: ["my-stage/*"],
+    tsconfigPath: project.tsconfigDev.fileName,
+    cdkDeps: project.cdkDeps,
+  });
+
+  // THEN
+  const output = Testing.synth(project);
+
+  expect(
+    output[".projen/tasks.json"].tasks["integ:my-stage:deploy"]
+  ).toMatchSnapshot();
+  expect(
+    output[".projen/tasks.json"].tasks["integ:my-stage:snapshot"]
+  ).toMatchSnapshot();
+  expect(
+    output[".projen/tasks.json"].tasks["integ:my-stage:watch"]
+  ).toMatchSnapshot();
+});