class IntegTest (construct) 🔹

Language	Type name
.NET	Amazon.CDK.IntegTests.IntegTest
Java	software.amazon.awscdk.integtests.IntegTest
Python	aws_cdk.integ_tests.IntegTest
TypeScript (source)	@aws-cdk/integ-tests » IntegTest

Implements IConstruct, IConstruct, IDependable

A collection of test cases.

Each test case file should contain exactly one instance of this class.

Example

declare const lambdaFunction: lambda.IFunction;
declare const app: App;

const stack = new Stack(app, 'cdk-integ-lambda-bundling');

const integ = new IntegTest(app, 'IntegTest', {
  testCases: [stack],
});

const invoke = integ.assertions.invokeFunction({
  functionName: lambdaFunction.functionName,
});
invoke.expect(ExpectedResult.objectLike({
  Payload: '200',
}));

Initializer

new IntegTest(scope: Construct, id: string, props: IntegTestProps)

Parameters

• scope Construct
• id string
• props IntegTestProps

Construct Props

Name	Type	Description
testCases🔹	Stack[]	List of test cases that make up this test.
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.

---

testCases🔹

Type: Stack[]

List of test cases that make up this 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']

---

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.
node🔹	ConstructNode	The construct tree node associated with this construct.

---

assertions🔹

Type: IDeployAssert

Make assertions on resources in this test case.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

Methods

Name	Description
toString()🔹	Returns a string representation of this construct.
protected onPrepare()🔹	Perform final modifications before synthesis.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected onPrepare()🔹

protected onPrepare(): void

Perform final modifications before synthesis.

This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.

This is an advanced framework feature. Only use this if you understand the implications.