@aws-cdk/assert

Testing utilities and assertions for CDK libraries

---

This is a developer preview (public beta) module. Releases might lack important features and might have future breaking changes.

This API is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the API is not recommended in production environments. Experimental APIs are not subject to the Semantic Versioning model.

---

This library contains helpers for writing unit tests and integration tests for CDK libraries

Unit tests

Write your unit tests like this:

const stack = new Stack();

new MyConstruct(stack, 'MyConstruct', {
    ...
});

expect(stack).to(someExpectation(...));

Here are the expectations you can use:

Verify (parts of) a template

Check that the synthesized stack template looks like the given template, or is a superset of it. These functions match logical IDs and all properties of a resource.

matchTemplate(template, matchStyle)
exactlyMatchTemplate(template)
beASupersetOfTemplate(template)

Example:

expect(stack).to(beASupersetOfTemplate({
    Resources: {
        HostedZone674DD2B7: {
            Type: "AWS::Route53::HostedZone",
            Properties: {
                Name: "test.private.",
                VPCs: [{
                    VPCId: { Ref: 'VPC06C5F037' },
                    VPCRegion: { Ref: 'AWS::Region' }
                }]
            }
        }
    }
}));

Check existence of a resource

If you only care that a resource of a particular type exists (regardless of its logical identifier), and that some of its properties are set to specific values:

haveResource(type, subsetOfProperties)

Example:

expect(stack).to(haveResource('AWS::CertificateManager::Certificate', {
    DomainName: 'test.example.com',
    // Note: some properties omitted here

    ShouldNotExist: ABSENT
}));

ABSENT is a magic value to assert that a particular key in an object is not set (or set to undefined).

Check number of resources

If you want to assert that n number of resources of a particular type exist, with or without specific properties:

countResources(type, count)
countResourcesLike(type, count, props)

Example:

expect(stack).to(countResources('AWS::ApiGateway::Method', 3));
expect(stack).to(countResourcesLike('AWS::ApiGateway::Method', 1, {
  HttpMethod: 'GET',
  ResourceId: {
    "Ref": "MyResource01234"
  }
}));

Check existence of an output

haveOutput assertion can be used to check that a stack contains specific output. Parameters to check against can be:

• outputName
• outputValue
• exportName

If outputValue is provided, at least one of outputName, exportName should be provided as well

Example

expect(synthStack).to(haveOutput({
  outputName: 'TestOutputName',
  exportName: 'TestOutputExportName',
  outputValue: {
    'Fn::GetAtt': [
      'TestResource',
      'Arn'
    ]
  }
}));

Changelog

1.26.0 (2020-02-25)

⚠ BREAKING CHANGES TO EXPERIMENTAL FEATURES

• apigateway: the interface now accepts endpointconfiguration property instead of endpoint type as defined by cfn
• lambda-nodejs: parcel-bundler v1.x is now a peer dependency of @aws-cdk/aws-lambda-nodejs. Please add it to your package.json.

Features

• apigateway: expose endpointconfiguration to include vpcEndpointIds (#6078) (99de6ca), closes #6038
• apigateway: lambda request authorizer (#5642) (031932d)
• appsync: mapping template for lambda proxy (#6288) (f865d5e)
• batch: add JobQueue, ComputeEnvironment and JobDefinition constructs (c8a22b1)
• cdk-assets: asset uploading tool (c505348)
• cli: faster "no-op" deployments (#6346) (d4a132b), closes #6046 #2553 #6216
• cfn: CloudFormation Resource Specification 11.1.0 (#6424) (ab9b77c)
• cognito: user pool verification and invitation messages (#6282) (faf6693)
• ecs-patterns: create dlq when queue is not provided for QueueProcessingService (#6356) (e307d7f)
• kms: trustAccountIdentities avoids cyclic stack dependencies (03f4ef2)
• rds: attach description to database secret (d5a4854)
• sns: support multiple tokens as url and email subscriptions (#6357) (e5493bd), closes #3996
• ssm: add ability to specify SSM Parameter tier (#6326) (9209ef6)

Bug Fixes

• aws-ecs: propagate dnsTtl property part of cloudMapOptions (#6370) (747bdb2), closes #6223
• cli: cdk deploy hangs when stack deployment fails (#6433) (4b11d99)
• cli: Python init templates are missing .gitignore file (#6350) (cd6cd42), closes #5566
• core: top-level resources cannot use long logical ids (#6419) (2a418b9), closes #6190 #6190
• ecs: support file as firelens config type (#6322) (f9996f3)
• lambda: erroneous inline code support for ruby (#6365) (8e21e78), closes #6302
• lambda-nodejs: parcel is too big to bundle (a93e4d5), closes #6340