@aws-cdk/assert
Advanced tools
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
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:
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' }
}]
}
}
}
}));
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
}));
Integration tests are modeled as CDK apps that are deployed by the developers. If deployment succeeds, the synthesized template is saved in a local file and "locked". During build, the test app is only synthesized and compared against the checked-in file to protect against regressions.
Create any number of files called integ.*.ts in your test directory. These
should be CDK apps containing a single stack.
Add the following to your package.json':
{
scripts: {
"test": ".... && cdk-integ-assert",
"integ": "cdk-integ"
},
...
devDependencies: {
"@aws-cdk/assert": "*",
"aws-cdk": "*"
}
}
This installs two tools into your scripts:
npm test is executed (during build), the cdk-integ-assert tool is
invoked. This tool will only synthesize the integration test stacks and
compare them to the .expected files. If the files differ (or do not exist),
the test will fail.npm run integ is executed (manually by the developer), the cdk-integ
tool is invoked. This tool will actually attempt to deploy the integration
test stacks into the default environment. If it succeeds, the .expected file
will be updated to include the latest synthesized stack.The usage of cdk-integ is:
cdk-integ [--no-clean] [filters...]
# or
npm run integ -- [--no-clean] [filters...]
--no-clean is specified, the integration test stacks will not be cleaned
up. This can be used to perform manual validation on the stacks.0.34.0 (2019-06-07)
aws-cloudwatch-actions (#2688) (e3df21a)recordValue: string prop in route53.TxtRecord changed to values: string[]recordValue prop in route53.CnameRecord renamed to domainNameroute53.AliasRecord has been removed, use route53.ARecord or route53.AaaaRecord with the target prop.EncryptionKeyAlias class was renamed to Alias.
Associated types (such as EncryptionKeyAliasProps) were renamed in the
same way.App.run() was renamed to App.synth() (soft deprecation, it will be removed in the next release).node.stack is now Stack.of(construct) (fixes #2766)node.resolve has been moved to stack.resolve.node.stringifyJson has been moved to stack.stringifyJson.node.validateTree is now ConstructNode.validate(node)node.prepareTree is now ConstructNode.prepare(node)node.getContext is now node.tryGetContextnode.recordReference is now node.addReferencenode.apply is now node.applyAspectnode.ancestors() is now node.scopesnode.required has been removed.node.typename has been removed.node.addChild is now privatenode.findReferences() is now node.referencesnode.findDependencies() is now node.dependenciesstack.dependencies() is now stack.dependenciesCfnElement.stackPath has been removed.CloudFormationLang is now internal (use stack.toJsonString())@aws-cdk/aws-cloudwatch-actions
package.targets.EcsEc2Task renamed to targets.EcsTaskendpoint is now type string (previously any)result in the Pass state is now type map (previously any)@aws-cdk/applet-js, @aws-cdk/aws-autoscaling-api, @aws-cdk/aws-codedeploy-apiaddPropertyOverride should match in capitalization to the CloudFormation schema (normally pascal case). For example, addPropertyOverride('accessControl', 'xxx') should now be addPropertyOverride('AccessControl', 'xxx').rds.RotationSingleUser renamed to rds.SecretRotationrds.ClusterParameterGroup no longer has setParameter() and removeParameter() methods, use the parameters prop directly in the constructor instead.FAQs
An assertion library for use with CDK Apps
The npm package @aws-cdk/assert receives a total of 91,758 weekly downloads. As such, @aws-cdk/assert popularity was classified as popular.
We found that @aws-cdk/assert demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.