interface TestOptions

Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.TestOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#TestOptions
Java	software.amazon.awscdk.cloud_assembly_schema.TestOptions
Python	aws_cdk.cloud_assembly_schema.TestOptions
TypeScript (source)	aws-cdk-lib » cloud_assembly_schema » TestOptions

The set of options to control the workflow of the test runner.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
const testOptions: cloud_assembly_schema.TestOptions = {
  allowDestroy: ['allowDestroy'],
  cdkCommandOptions: {
    deploy: {
      args: {
        all: false,
        app: 'app',
        assetMetadata: false,
        caBundlePath: 'caBundlePath',
        changeSetName: 'changeSetName',
        ci: false,
        color: false,
        concurrency: 123,
        context: {
          contextKey: 'context',
        },
        debug: false,
        ec2Creds: false,
        exclusively: false,
        execute: false,
        force: false,
        ignoreErrors: false,
        json: false,
        lookups: false,
        notices: false,
        notificationArns: ['notificationArns'],
        output: 'output',
        outputsFile: 'outputsFile',
        parameters: {
          parametersKey: 'parameters',
        },
        pathMetadata: false,
        profile: 'profile',
        proxy: 'proxy',
        requireApproval: cloud_assembly_schema.RequireApproval.NEVER,
        reuseAssets: ['reuseAssets'],
        roleArn: 'roleArn',
        rollback: false,
        stacks: ['stacks'],
        staging: false,
        strict: false,
        toolkitStackName: 'toolkitStackName',
        trace: false,
        usePreviousParameters: false,
        verbose: false,
        versionReporting: false,
      },
      enabled: false,
      expectedMessage: 'expectedMessage',
      expectError: false,
    },
    destroy: {
      args: {
        all: false,
        app: 'app',
        assetMetadata: false,
        caBundlePath: 'caBundlePath',
        color: false,
        context: {
          contextKey: 'context',
        },
        debug: false,
        ec2Creds: false,
        exclusively: false,
        force: false,
        ignoreErrors: false,
        json: false,
        lookups: false,
        notices: false,
        output: 'output',
        pathMetadata: false,
        profile: 'profile',
        proxy: 'proxy',
        roleArn: 'roleArn',
        stacks: ['stacks'],
        staging: false,
        strict: false,
        trace: false,
        verbose: false,
        versionReporting: false,
      },
      enabled: false,
      expectedMessage: 'expectedMessage',
      expectError: false,
    },
  },
  diffAssets: false,
  hooks: {
    postDeploy: ['postDeploy'],
    postDestroy: ['postDestroy'],
    preDeploy: ['preDeploy'],
    preDestroy: ['preDestroy'],
  },
  regions: ['regions'],
  stackUpdateWorkflow: false,
};

Properties

Name	Type	Description
allowDestroy?	string[]	List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test.
cdkCommandOptions?	CdkCommands	Additional options to use for each CDK command.
diffAssets?	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.
stackUpdateWorkflow?	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.

---

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']

---

cdkCommandOptions?

Type: CdkCommands (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.