Fix snapshot tests by normalizing asset hashes

Author: Michael Kaiser

typescript/api-gateway-lambda-token-authorizer/test/stack/gateway-lambda-auth-stack.test.ts

@@ -1,44 +1,19 @@
 import { App } from "aws-cdk-lib";
 import { GatewayLambdaAuth } from "../../lib/stack/gateway-lambda-auth-stack";
 import { Template } from "aws-cdk-lib/assertions";
-
-/**
- * Normalizes asset hashes in CloudFormation templates to ensure consistent snapshots
- * across different environments (local vs CI/CD).
- */
-function normalizeAssetHashes(template: any): any {
-  // Create a deep copy of the template to avoid modifying the original
-  const templateCopy = JSON.parse(JSON.stringify(template));
-  
-  // Function to recursively traverse the template and replace asset hashes
-  function replaceAssetHashes(obj: any) {
-    if (!obj || typeof obj !== 'object') return;
-    
-    // Process object properties
-    for (const key in obj) {
-      if (key === 'S3Key' && typeof obj[key] === 'string' && /^[a-f0-9]{64}\.zip$/.test(obj[key])) {
-        // Replace asset hash with a constant placeholder
-        obj[key] = 'NORMALIZED_ASSET_HASH.zip';
-      } else if (typeof obj[key] === 'object') {
-        // Recursively process nested objects and arrays
-        replaceAssetHashes(obj[key]);
-      }
-    }
-  }
-  
-  replaceAssetHashes(templateCopy);
-  return templateCopy;
-}
+import { normalizeTemplate } from "../../../test-utils/normalize-template";
 
 describe('Snapshot', () => {
+
     it('Stack', () => {
         const app = new App();
         const stack = new GatewayLambdaAuth(app, 'test-api-gateway-lambda-auth');
         const template = Template.fromStack(stack);
 
-        // Normalize asset hashes before snapshot comparison
-        const normalizedTemplate = normalizeAssetHashes(template.toJSON());
+        // Normalize the template before snapshot comparison
+        const normalizedTemplate = normalizeTemplate(template.toJSON());
         expect(normalizedTemplate).toMatchSnapshot();
     });
+
 })
 

typescript/aws-transfer-sftp-server/jest.config.js

@@ -4,6 +4,7 @@ import {
 } from 'aws-cdk-lib';
 import { Template } from 'aws-cdk-lib/assertions';
 import { SftpServerStack } from '../aws-transfer-sftp-server';
+import { normalizeTemplate } from '../../test-utils/normalize-template';
 
 test('SftpServerStack has required resources', () => {
   const app = new cdk.App();
@@ -23,5 +24,8 @@ test('SftpServerStack has required resources', () => {
     dataBucket: bucket,
   });
 
-  expect(Template.fromStack(stack)).toMatchSnapshot();
+  // Normalize the template before snapshot comparison
+  const template = Template.fromStack(stack);
+  const normalizedTemplate = normalizeTemplate(template.toJSON());
+  expect(normalizedTemplate).toMatchSnapshot();
 });

typescript/aws-transfer-sftp-server/test/aws-transfer-sftp-server.test.ts

@@ -0,0 +1,8 @@
+module.exports = {
+  testEnvironment: 'node',
+  roots: ['<rootDir>/test'],
+  testMatch: ['**/*.test.ts'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest'
+  }
+};

typescript/ec2-instance-connect-endpoint/jest.config.js

@@ -1,11 +1,14 @@
 import { Template } from 'aws-cdk-lib/assertions';
 import { IntegTesting } from '../src/integ.default';
+import { normalizeTemplate } from '../../test-utils/normalize-template';
 
 test('default validation', () => {
   const integ = new IntegTesting();
   integ.stack.forEach(stack => {
     const t = Template.fromStack(stack);
+    // Normalize the template before snapshot comparison
+    const normalizedTemplate = normalizeTemplate(t.toJSON());
     // should match snapshot
-    expect(t).toMatchSnapshot();
+    expect(normalizedTemplate).toMatchSnapshot();
   });
 });

typescript/ec2-instance-connect-endpoint/test/integ.default.test.ts

@@ -1,39 +1,24 @@
 {
   "compilerOptions": {
-    "outDir": "lib",
-    "rootDir": "src",
-    "declarationMap": false,
-    "inlineSourceMap": true,
-    "inlineSources": true,
-    "alwaysStrict": true,
+    "target": "ES2018",
+    "module": "commonjs",
+    "lib": ["es2018"],
     "declaration": true,
-    "experimentalDecorators": true,
-    "incremental": true,
-    "lib": [
-      "es2020"
-    ],
-    "module": "CommonJS",
-    "noEmitOnError": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitAny": true,
-    "noImplicitReturns": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
     "strict": true,
+    "noImplicitAny": true,
     "strictNullChecks": true,
-    "strictPropertyInitialization": true,
-    "stripInternal": false,
-    "target": "ES2020",
-    "composite": false,
-    "tsBuildInfoFile": "lib/tsconfig.tsbuildinfo"
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": false,
+    "inlineSourceMap": true,
+    "inlineSources": true,
+    "experimentalDecorators": true,
+    "strictPropertyInitialization": false,
+    "typeRoots": ["./node_modules/@types"],
+    "outDir": "dist"
   },
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
+  "exclude": ["node_modules", "cdk.out"]
 }

typescript/ec2-instance-connect-endpoint/tsconfig.json

@@ -0,0 +1,8 @@
+module.exports = {
+  testEnvironment: 'node',
+  roots: ['<rootDir>/test'],
+  testMatch: ['**/*.test.ts'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest'
+  }
+};

typescript/ec2-instance/jest.config.js

@@ -2,6 +2,7 @@ import { App, Stack } from 'aws-cdk-lib';
 import { Template } from 'aws-cdk-lib/assertions';
 import { EC2Example } from '../src/ec2-instance';
 import { InstanceSize, CPUTypes } from '../src/envValidator';
+import { normalizeTemplate } from '../../test-utils/normalize-template';
 
 const devEnv = {
   account: process.env.CDK_DEFAULT_ACCOUNT,
@@ -28,7 +29,8 @@ test('Snapshot', () => {
   });
 
   const template = Template.fromStack(stack);
-  expect(template.toJSON()).toMatchSnapshot();
+  const normalizedTemplate = normalizeTemplate(template.toJSON());
+  expect(normalizedTemplate).toMatchSnapshot();
 });
 
 test('LARGE', () => {

typescript/ec2-instance/test/main.test.ts

@@ -1,11 +1,14 @@
 import * as cdk from 'aws-cdk-lib';
 import { Template } from 'aws-cdk-lib/assertions';
 import { ExampleLocalZoneStack } from '../example-localzone-stack';
+import { normalizeTemplate } from '../../test-utils/normalize-template';
 
 test('ExampleLocalZoneStack has required resources', () => {
   const app = new cdk.App();
   // WHEN
   const stack = new ExampleLocalZoneStack(app, 'ExampleLocalZoneStack', { });
 
-  expect(Template.fromStack(stack)).toMatchSnapshot();
+  const template = Template.fromStack(stack);
+  const normalizedTemplate = normalizeTemplate(template.toJSON());
+  expect(normalizedTemplate).toMatchSnapshot();
 });