cleanup snapshot-test-runner

aws · Nov 15, 2022 · bc8d82e · bc8d82e
1 parent 2507fe7
commit bc8d82e
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 30 deletions.
diff --git a/packages/@aws-cdk/integ-runner/lib/runner/snapshot-test-runner.ts b/packages/@aws-cdk/integ-runner/lib/runner/snapshot-test-runner.ts
@@ -43,19 +43,7 @@ export class IntegSnapshotRunner extends IntegRunner {
   public testSnapshot(options: SnapshotVerificationOptions = {}): { diagnostics: Diagnostic[], destructiveChanges: DestructiveChange[] } {
     let doClean = true;
     try {
-      // read the existing snapshot
-      const expectedAssembly = this.readAssembly(this.snapshotDir);
-      const expectedStacks = expectedAssembly.stacks;
-      // only diff stacks that are part of the test case
-      const expectedStacksToDiff: Record<string, any> = {};
-      for (const [stackName, template] of Object.entries(expectedStacks)) {
-        if (this.expectedTestSuite?.stacks.includes(stackName)) {
-          expectedStacksToDiff[stackName] = template;
-          Object.entries(expectedAssembly.getNestedStacksForStack(stackName)).forEach(([nestedStackName, nestedTemplate]) => {
-            expectedStacksToDiff[nestedStackName] = nestedTemplate;
-          });
-        }
-      }
+      const expectedSnapshotAssembly = this.getSnapshotAssembly(this.snapshotDir, this.expectedTestSuite?.stacks);
 
       // synth the integration test
       // FIXME: ideally we should not need to run this again if
@@ -75,24 +63,10 @@ export class IntegSnapshotRunner extends IntegRunner {
       });
 
       // read the "actual" snapshot
-      const actualDir = this.cdkOutDir;
-      const actualAssembly = this.readAssembly(actualDir);
-      const actualStacks = actualAssembly.stacks;
-      // only diff stacks that are part of the test case
-      const actualStacksToDiff: Record<string, any> = {};
-      for (const [stackName, template] of Object.entries(actualStacks)) {
-        if (this.actualTestSuite.stacks.includes(stackName)) {
-          actualStacksToDiff[stackName] = template;
-          Object.entries(actualAssembly.getNestedStacksForStack(stackName)).forEach(([nestedStackName, nestedTemplate]) => {
-            actualStacksToDiff[nestedStackName] = nestedTemplate;
-          });
-        }
-      }
+      const actualSnapshotAssembly = this.getSnapshotAssembly(this.cdkOutDir, this.actualTestSuite.stacks);
 
       // diff the existing snapshot (expected) with the integration test (actual)
-      const manifest = AssemblyManifestReader.fromPath(manifestDir);
-      const assets = manifest.getAssetIdsForStack(stackName);
-      const diagnostics = this.diffAssembly(expectedStacksToDiff, actualStacksToDiff);
+      const diagnostics = this.diffAssembly(expectedSnapshotAssembly, actualSnapshotAssembly);
 
       if (diagnostics.diagnostics.length) {
         // Attach additional messages to the first diagnostic
@@ -101,7 +75,7 @@ export class IntegSnapshotRunner extends IntegRunner {
         if (options.retain) {
           additionalMessages.push(
             `(Failure retained) Expected: ${path.relative(process.cwd(), this.snapshotDir)}`,
-            `                   Actual:   ${path.relative(process.cwd(), actualDir)}`,
+            `                   Actual:   ${path.relative(process.cwd(), this.cdkOutDir)}`,
           ),
           doClean = false;
         }
@@ -136,6 +110,36 @@ export class IntegSnapshotRunner extends IntegRunner {
     }
   }
 
+  /**
+   * For a given cloud assembly return a collection of all templates
+   * that should be part of the snapshot and any required meta data.
+   *
+   * @param cloudAssemblyDir The directory of the cloud assembly to look for snapshots
+   * @param pickStacks Pick only these stacks from the cloud assembly
+   * @returns A SnapshotAssembly, the collection of all templates in this snapshot and required meta data
+   */
+  private getSnapshotAssembly(cloudAssemblyDir: string, pickStacks: string[] = []): SnapshotAssembly {
+    const assembly = this.readAssembly(cloudAssemblyDir);
+    const stacks = assembly.stacks;
+    const snapshots: SnapshotAssembly = {};
+    for (const [stackName, stackTemplate] of Object.entries(stacks)) {
+      if (pickStacks.includes(stackName)) {
+        const manifest = AssemblyManifestReader.fromPath(cloudAssemblyDir);
+        const assets = manifest.getAssetIdsForStack(stackName);
+
+        snapshots[stackName] = {
+          templates: {
+            [stackName]: stackTemplate,
+            ...assembly.getNestedStacksForStack(stackName),
+          },
+          assets,
+        };
+      }
+    }
+
+    return snapshots;
+  }
+
   /**
    * For a given stack return all resource types that are allowed to be destroyed
    * as part of a stack update

diff --git a/packages/@aws-cdk/integ-runner/test/cli.test.ts b/packages/@aws-cdk/integ-runner/test/cli.test.ts
@@ -32,6 +32,7 @@ describe('CLI', () => {
       [
         'xxxxx.integ-test1.js',
         'xxxxx.integ-test2.js',
+        'xxxxx.test-with-nested-stack.js',
         'xxxxx.test-with-new-assets-diff.js',
         'xxxxx.test-with-new-assets.js',
         'xxxxx.test-with-snapshot-assets-diff.js',