fix(assertions): hasResourceProperties is incompatible with Match.not and Match.absent

packages/@aws-cdk/assertions/lib/private/resources.ts

@@ -4,6 +4,7 @@ import { formatFailure, matchSection } from './section';
 // Partial type for CloudFormation Resource
 type Resource = {
   Type: string;
+  Properties?: {};
 }
 
 export function findResources(inspector: StackInspector, type: string, props: any = {}): { [key: string]: { [key: string]: any } } {
@@ -17,9 +18,9 @@ export function findResources(inspector: StackInspector, type: string, props: an
   return result.matches;
 }
 
-export function hasResource(inspector: StackInspector, type: string, props: any): string | void {
+export function hasResource(inspector: StackInspector, type: string, props: any, addProperties?: boolean): string | void {
   const section: { [key: string]: Resource } = inspector.value.Resources;
-  const result = matchSection(filterType(section, type), props);
+  const result = matchSection(addProperties ? addEmptyProperties(filterType(section, type)) : filterType(section, type), props);
 
   if (result.match) {
     return;
@@ -35,6 +36,15 @@ export function hasResource(inspector: StackInspector, type: string, props: any)
   ].join('\n');
 }
 
+function addEmptyProperties(sections: { [key: string]: Resource}): { [key: string]: Resource } {
+  Object.keys(sections).map((key) => {
+    if (!sections[key].Properties) {
+      sections[key].Properties = {};
+    }
+  });
+  return sections;
+}
+
 function filterType(section: { [key: string]: Resource }, type: string): { [key: string]: Resource } {
   return Object.entries(section ?? {})
     .filter(([_, v]) => v.Type === type)

packages/@aws-cdk/assertions/lib/template.ts

@@ -74,9 +74,16 @@ export class Template {
    * @param props the 'Properties' section of the resource as should be expected in the template.
    */
   public hasResourceProperties(type: string, props: any): void {
-    this.hasResource(type, Match.objectLike({
+    // const addProperties = !(props instanceof AbsentMatch);
+    // Add the above line in place of below when this is merged: https://github.com/aws/aws-cdk/pull/16653
+    const addProperties = true;
+
+    const matchError = hasResource(this.inspector, type, Match.objectLike({
       Properties: Matcher.isMatcher(props) ? props : Match.objectLike(props),
-    }));
+    }), addProperties);
+    if (matchError) {
+      throw new Error(matchError);
+    }
   }
 
   /**

packages/@aws-cdk/assertions/test/template.test.ts

@@ -269,6 +269,64 @@ describe('Template', () => {
     });
   });
 
+  describe('hasResourceProperties', () => {
+    test('exact match', () => {
+      const stack = new Stack();
+      new CfnResource(stack, 'Foo', {
+        type: 'Foo::Bar',
+        properties: { baz: 'qux' },
+      });
+
+      const inspect = Template.fromStack(stack);
+      inspect.hasResourceProperties('Foo::Bar', { baz: 'qux' });
+
+      expect(() => inspect.hasResourceProperties('Foo::Bar', { baz: 'waldo' }))
+        .toThrow(/Expected waldo but received qux at \/Properties\/baz/);
+
+      expect(() => inspect.hasResourceProperties('Foo::Bar', { baz: 'qux', fred: 'waldo' }))
+        .toThrow(/Missing key at \/Properties\/fred/);
+    });
+
+    test('absent with properties', () => {
+      const stack = new Stack();
+      new CfnResource(stack, 'Foo', {
+        type: 'Foo::Bar',
+        properties: { baz: 'qux' },
+      });
+
+      const inspect = Template.fromStack(stack);
+      inspect.hasResourceProperties('Foo::Bar', { bar: Match.absentProperty() });
+
+      expect(() => inspect.hasResourceProperties('Foo::Bar', { baz: Match.absentProperty() }))
+        .toThrow(/Key should be absent at \/Properties\/baz/);
+    });
+
+    test('absent with no properties', () => {
+      const stack = new Stack();
+      new CfnResource(stack, 'Foo', {
+        type: 'Foo::Bar',
+      });
+
+      const inspect = Template.fromStack(stack);
+      inspect.hasResourceProperties('Foo::Bar', { bar: Match.absentProperty() });
+
+      expect(() => inspect.hasResourceProperties('Foo::Bar', { bar: Match.absentProperty(), baz: 'qux' }))
+        .toThrow(/Missing key at \/Properties\/baz/);
+      // Add the below line when this is merged: https://github.com/aws/aws-cdk/pull/16653
+      // expect(inspect.hasResourceProperties('Foo::Bar', Match.absent()));
+    });
+
+    test('match with not', () => {
+      const stack = new Stack();
+      new CfnResource(stack, 'Foo', {
+        type: 'Foo::Bar',
+      });
+
+      const inspect = Template.fromStack(stack);
+      expect(inspect.hasResourceProperties('Foo::Bar', Match.not({ baz: 'qux' })));
+    });
+  });
+
   describe('getResources', () => {
     test('matching resource type', () => {
       const stack = new Stack();