Make tests more stable

Author: mnapoli

package.json

@@ -13,9 +13,10 @@
     "constructs": "^10.0.0"
   },
   "dependencies": {
-    "@bref.sh/layers": "^2.0.3"
+    "@bref.sh/layers": "^2.0.21"
   },
   "devDependencies": {
+    "@types/lodash": "^4.14.191",
     "@types/node": "^18.11.3",
     "@typescript-eslint/eslint-plugin": "^5.40.1",
     "@typescript-eslint/parser": "^5.40.1",
@@ -25,6 +26,7 @@
     "eslint": "8.22.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
+    "lodash": "^4.17.21",
     "nodemon": "^2.0.20",
     "prettier": "^2.7.1",
     "typescript": "^4.8.4",

test/function/PhpFpmFunction.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
-import { PhpFpmFunction, PhpFunction } from '../../src';
-import { compileTestStack } from '../helper';
+import { PhpFpmFunction } from '../../src';
+import { cleanupTemplate, compileTestStack } from '../helper';
 
 describe('PhpFpmFunction', () => {
     it('builds', () => {
@@ -9,9 +9,7 @@ describe('PhpFpmFunction', () => {
                 handler: 'index.php',
             });
         }).toJSON();
-        // Remove random data that changes every time
-        delete template.Resources.Function76856677?.Properties?.Code?.S3Key;
 
-        expect(template.Resources).toMatchSnapshot();
+        expect(cleanupTemplate(template).Resources).toMatchSnapshot();
     });
 });

test/function/PhpFunction.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { PhpFunction } from '../../src';
-import { compileTestStack } from '../helper';
+import { cleanupTemplate, compileTestStack } from '../helper';
 
 describe('PhpFunction', () => {
     it('builds', () => {
@@ -9,9 +9,7 @@ describe('PhpFunction', () => {
                 handler: 'index.php',
             });
         }).toJSON();
-        // Remove random data that changes every time
-        delete template.Resources.Function76856677?.Properties?.Code?.S3Key;
 
-        expect(template.Resources).toMatchSnapshot();
+        expect(cleanupTemplate(template).Resources).toMatchSnapshot();
     });
 });

test/function/__snapshots__/PhpFpmFunction.test.ts.snap

@@ -11,11 +11,12 @@ exports[`PhpFpmFunction > builds 1`] = `
         "S3Bucket": {
           "Fn::Sub": "cdk-hnb659fds-assets-\${AWS::AccountId}-us-east-1",
         },
+        "S3Key": "<removed>",
       },
       "Description": "HTTP application",
       "Handler": "index.php",
       "Layers": [
-        "arn:aws:lambda:us-east-1:534081306603:layer:php-81-fpm:2",
+        "arn:aws:lambda:us-east-1:534081306603:layer:php-81-fpm:<removed>",
       ],
       "MemorySize": 1024,
       "Role": {

test/function/__snapshots__/PhpFunction.test.ts.snap

@@ -11,10 +11,11 @@ exports[`PhpFunction > builds 1`] = `
         "S3Bucket": {
           "Fn::Sub": "cdk-hnb659fds-assets-\${AWS::AccountId}-us-east-1",
         },
+        "S3Key": "<removed>",
       },
       "Handler": "index.php",
       "Layers": [
-        "arn:aws:lambda:us-east-1:534081306603:layer:php-81:2",
+        "arn:aws:lambda:us-east-1:534081306603:layer:php-81:<removed>",
       ],
       "MemorySize": 1024,
       "Role": {

test/helper.ts

@@ -1,5 +1,6 @@
 import { Stack } from 'aws-cdk-lib';
 import { Template } from 'aws-cdk-lib/assertions';
+import { mapValues } from 'lodash';
 
 export function compileTestStack(definition: (stack: Stack) => void): Template {
     const stack = new Stack(undefined, 'app', {
@@ -9,3 +10,27 @@ export function compileTestStack(definition: (stack: Stack) => void): Template {
 
     return Template.fromStack(stack);
 }
+
+type CompiledTemplate = { [key: string]: any };
+
+export function cleanupTemplate(template: CompiledTemplate): CompiledTemplate {
+    template.Resources = mapValues(template.Resources, (resource) => {
+        if (resource.Type === 'AWS::Lambda::Function') {
+            if (resource.Properties.Code.S3Key) {
+                resource.Properties.Code.S3Key = '<removed>';
+            }
+            if (Array.isArray(resource.Properties.Layers)) {
+                resource.Properties.Layers = resource.Properties.Layers.map((layer: string) =>
+                    layer.replace(
+                        /(arn:aws:lambda:[a-z0-9\-]+:534081306603:layer:[a-z0-9\-]+:)\d+/,
+                        '$1<removed>'
+                    )
+                );
+            }
+        }
+
+        return resource;
+    });
+
+    return template;
+}