aws-cdk-assert v1.1.0

IMPORTANT This tool is NOT an official tool made by AWS.

aws-cdk-assert

This tool gives handy utilities to test AWS CDK Stack, with predefined test constructs for certain CDK constructs.

The tool currently contains the following test constructs:

Need a new construct?

Suggest one in the issues, with an example CloudFormation template or contribute implementing it in this tool.

Usage

// stack.test.ts
import * as cdk from 'aws-cdk-lib';
import * as MyStack from '../lib/mystack.ts';
import { AdvancedTemplate } from 'aws-cdk-assert';

describe('MyStack', () => {
  let template: AdvancedTemplate;

  beforeAll(() => {
    const app = new cdk.App();
    const stack = new MyStack.MyStack(app, 'MyStack', {
      // props
    });
    template = AdvancedTemplate.fromStack(stack);
  });

  test('should have S3 Bucket', () => {
    template.s3Bucket().withBucketName('MyBucket').exists();
  });
});

API

The main components/API the tool relies on:

• AdvancedTemplate is a wrapper around Template, decorated with factory methods for the predefined constructs.
• AdvancedMatcher is similar to Match, but with additional functions.
• Resource (and RemovableResource) is the base construct to work with CloudFormation constructs. It allows to
  • construct the matcher properties, which will be used to find a construct in the template,
  • check if a construct exists or not,
  • check the count of a construct (not just based on type, but fully matching construct),
  • make assertions with extended information in case of failure,
  • etc.

For detailed documentation see the TypeDocs documentation.