chore: force stable keys for Lambda assets in unit tests [skip ci] (#98)

Addresses a workflow failure in #83.

---

_By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_

Author: Eugene Cheung

test/dashboard/widget/BitmapWidget.test.ts

@@ -3,12 +3,15 @@ import { Template } from "monocdk/assertions";
 import { GraphWidget } from "monocdk/aws-cloudwatch";
 
 import { BitmapWidgetRenderingSupport } from "../../../lib";
+import { forceStableAssetKeys } from "../../utils/StableTestKeys";
 
 test("support", () => {
   const stack = new Stack();
 
   new BitmapWidgetRenderingSupport(stack, "Support");
 
+  forceStableAssetKeys(stack);
+
   expect(Template.fromStack(stack)).toMatchSnapshot();
 });
 

test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap

@@ -34,6 +34,7 @@ import {
   MonitoringFacade,
   MonitoringAspectProps,
 } from "../../lib";
+import { forceStableAssetKeys } from "../utils/StableTestKeys";
 
 function createDummyMonitoringFacade(stack: Stack): MonitoringFacade {
   return new MonitoringFacade(stack, "MonitoringFacade", {
@@ -414,6 +415,8 @@ describe("MonitoringAspect", () => {
     // WHEN
     facade.monitorScope(stack, defaultAspectProps);
 
+    forceStableAssetKeys(stack);
+
     // THEN
     expect(Template.fromStack(stack)).toMatchSnapshot();
   });
@@ -468,6 +471,8 @@ describe("MonitoringAspect", () => {
     // WHEN
     facade.monitorScope(stack, defaultAspectProps);
 
+    forceStableAssetKeys(stack);
+
     // THEN
     expect(Template.fromStack(stack)).toMatchSnapshot();
   });

test/facade/MonitoringAspect.test.ts

@@ -7,8 +7,17 @@ import {
   SecretsManagerMetricsPublisher,
   SecretsManagerSecretMonitoring,
 } from "../../../lib";
+import { forceStableAssetKeys } from "../../utils/StableTestKeys";
 import { TestMonitoringScope } from "../TestMonitoringScope";
 
+beforeEach(() => {
+  // reset cached publisher instances before each test
+  // test stacks have duplicate uniqueIds since they don't belong to a single construct tree
+  (SecretsManagerMetricsPublisher as any).instances = {};
+});
+
+afterAll = beforeEach;
+
 test("snapshot test", () => {
   const stack = new Stack();
   stack.node.setContext(cx_api.SECRETS_MANAGER_PARSE_OWNED_SECRET_NAME, true);
@@ -72,6 +81,9 @@ test("snapshot test", () => {
   });
 
   expect(numAlarmsCreated).toStrictEqual(4);
+
+  forceStableAssetKeys(stack);
+
   expect(Template.fromStack(stack)).toMatchSnapshot();
 });
 
@@ -104,14 +116,8 @@ test("each stack in an app gets its own publisher instance", () => {
       });
     }
 
+    forceStableAssetKeys(stack);
+
     expect(Template.fromStack(stack)).toMatchSnapshot();
   }
 });
-
-beforeEach(() => {
-  // reset cached publisher instances before each test
-  // test stacks have duplicate uniqueIds since they don't belong to a single construct tree
-  (SecretsManagerMetricsPublisher as any).instances = {};
-});
-
-afterAll = beforeEach;

test/monitoring/aws-secretsmanager/SecretsManagerSecretMonitoring.test.ts

@@ -4,7 +4,7 @@ import { Canary, Code, Runtime, Schedule, Test } from "monocdk/aws-synthetics";
 
 import { AlarmWithAnnotation } from "../../../lib";
 import { SyntheticsCanaryMonitoring } from "../../../lib/monitoring/aws-synthetics";
-import { addMonitoringDashboardsToStack } from "../SnapshotUtil";
+import { addMonitoringDashboardsToStack } from "../../utils/SnapshotUtil";
 import { TestMonitoringScope } from "../TestMonitoringScope";
 
 test("snapshot test: no alarms", () => {

test/monitoring/aws-secretsmanager/__snapshots__/SecretsManagerSecretMonitoring.test.ts.snap

@@ -3,7 +3,7 @@ import { Template } from "monocdk/assertions";
 import { CfnWebACL } from "monocdk/aws-wafv2";
 
 import { WafV2Monitoring } from "../../../lib";
-import { addMonitoringDashboardsToStack } from "../SnapshotUtil";
+import { addMonitoringDashboardsToStack } from "../../utils/SnapshotUtil";
 import { TestMonitoringScope } from "../TestMonitoringScope";
 
 test("snapshot test: no alarms", () => {

test/monitoring/aws-synthetics/SyntheticsCanaryMonitoring.test.ts

@@ -1,11 +1,12 @@
-/**
- * Executes a snapshot test for widgets, summary widgets and alarm widgets.
- * @param monitoring monitoring to test
- */
 import { Stack } from "monocdk";
 import { Dashboard } from "monocdk/aws-cloudwatch";
 import { Monitoring } from "../../lib";
 
+/**
+ * Executes a snapshot test for widgets, summary widgets and alarm widgets.
+ *
+ * @param monitoring monitoring to test
+ */
 export function addMonitoringDashboardsToStack(
   stack: Stack,
   monitoring: Monitoring

test/monitoring/aws-wafv2/WafV2Monitoring.test.ts

@@ -0,0 +1,23 @@
+import { Aspects, CfnResource, IConstruct, Stack } from "monocdk";
+
+/**
+ * Overwrite potentially unstable properties for unit testing purposes.
+ *
+ * @param stack stack to replace properties
+ */
+export function forceStableAssetKeys(stack: Stack) {
+  Aspects.of(stack).add({
+    visit({ node }: IConstruct) {
+      if (node.defaultChild && CfnResource.isCfnResource(node.defaultChild)) {
+        switch (node.defaultChild.cfnResourceType) {
+          case "AWS::Lambda::Function":
+            node.defaultChild.addPropertyOverride(
+              "Code.S3Key",
+              "Fixed key that does not depend on asset changes"
+            );
+            break;
+        }
+      }
+    },
+  });
+}