class IntegTestCase (construct) 🔹

Language	Type name
.NET	Amazon.CDK.IntegTests.Alpha.IntegTestCase
Go	github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#IntegTestCase
Java	software.amazon.awscdk.integtests.alpha.IntegTestCase
Python	aws_cdk.integ_tests_alpha.IntegTestCase
TypeScript (source)	@aws-cdk/integ-tests-alpha » IntegTestCase

Implements IConstruct, IDependable

An integration test case. Allows the definition of test properties that apply to all stacks under this case.

It is recommended that you use the IntegTest construct since that will create a default IntegTestCase

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as integ_tests_alpha from '@aws-cdk/integ-tests-alpha';
import * as cdk from 'aws-cdk-lib';
import { cloud_assembly_schema } from 'aws-cdk-lib';

declare const stack: cdk.Stack;
const integTestCase = new integ_tests_alpha.IntegTestCase(this, 'MyIntegTestCase', {
  stacks: [stack],

  // the properties below are optional
  allowDestroy: ['allowDestroy'],
  assertionStack: stack,
  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,
});

Initializer

new IntegTestCase(scope: Construct, id: string, props: IntegTestCaseProps)

Parameters

• scope Construct
• id string
• props IntegTestCaseProps

Construct Props

Name	Type	Description
stacks🔹	Stack[]	Stacks to be deployed during the test.
allowDestroy?🔹	string[]	List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test.
assertionStack?🔹	Stack	Specify a stack to use for assertions.
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.

---

stacks🔹

Type: Stack[]

Stacks to be deployed during the test.

---

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: Stack (optional, default: a stack is created for you)

Specify a stack to use for assertions.

---

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.

Properties

Name	Type	Description
assertions🔹	IDeployAssert	Make assertions on resources in this test case.
manifest🔹	IntegManifest	The integration test manifest for this test case.
node🔹	Node	The tree node.

---

assertions🔹

Type: IDeployAssert

Make assertions on resources in this test case.

---

manifest🔹

Type: IntegManifest

The integration test manifest for this test case.

Manifests are used by the integration test runner.

---

node🔹

Type: Node

The tree node.

Methods

Name	Description
toString()🔹	Returns a string representation of this construct.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.