interface TestCase
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CloudAssembly.Schema.TestCase |
 Java | software.amazon.awscdk.cloudassembly.schema.TestCase |
 Python | aws_cdk.cloud_assembly_schema.TestCase |
 TypeScript (source) | @aws-cdk/cloud-assembly-schema » TestCase |
Represents an integration test case.
Properties
| Name | Type | Description |
|---|---|---|
| stacks | string[] | Stacks that should be tested as part of this test case The stackNames will be passed as args to the cdk commands so dependent stacks will be automatically deployed unless exclusively is passed. |
| allow | string[] | List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test. |
| assertion | string | The node id of the stack that contains assertions. |
| assertion | string | The name of the stack that contains assertions. |
| cdk | Cdk | Additional options to use for each CDK command. |
| diff | boolean | Whether or not to include asset hashes in the diff Asset hashes can introduces a lot of unneccessary noise into tests, but there are some cases where asset hashes should be included. |
| hooks? | Hooks | Additional commands to run at predefined points in the test workflow. |
| regions? | string[] | Limit deployment to these regions. |
| stack | boolean | Run update workflow on this test case This should only be set to false to test scenarios that are not possible to test as part of the update workflow. |
stacks
Type:
string[]
Stacks that should be tested as part of this test case The stackNames will be passed as args to the cdk commands so dependent stacks will be automatically deployed unless exclusively is passed.
allowDestroy?
Type:
string[]
(optional, default: do not allow destruction of any resources on update)
List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test.
This list should only include resources that for this specific integration test we are sure will not cause errors or an outage if destroyed. For example, maybe we know that a new resource will be created first before the old resource is destroyed which prevents any outage.
e.g. ['AWS::IAM::Role']
assertionStack?
Type:
string
(optional, default: no assertion stack)
The node id of the stack that contains assertions.
This is the value that can be used to deploy the stack with the CDK CLI
assertionStackName?
Type:
string
(optional, default: no assertion stack)
The name of the stack that contains assertions.
cdkCommandOptions?
Type:
Cdk
(optional, default: runner default options)
Additional options to use for each CDK command.
diffAssets?
Type:
boolean
(optional, default: false)
Whether or not to include asset hashes in the diff Asset hashes can introduces a lot of unneccessary noise into tests, but there are some cases where asset hashes should be included.
For example any tests involving custom resources or bundling
hooks?
Type:
Hooks
(optional, default: no hooks)
Additional commands to run at predefined points in the test workflow.
e.g. { postDeploy: ['yarn', 'test'] }
regions?
Type:
string[]
(optional, default: can run in any region)
Limit deployment to these regions.
stackUpdateWorkflow?
Type:
boolean
(optional, default: true)
Run update workflow on this test case This should only be set to false to test scenarios that are not possible to test as part of the update workflow.