Package software.amazon.awscdk.integtests.alpha

Class IntegTestCase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.integtests.alpha.IntegTestCase

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:17.843Z")
@Stability(Experimental)
public class IntegTestCase
extends software.constructs.Construct

(experimental) 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 software.amazon.awscdk.integtests.alpha.*;
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.cloud_assembly_schema.*;
 Stack stack;
 IntegTestCase integTestCase = IntegTestCase.Builder.create(this, "MyIntegTestCase")
         .stacks(List.of(stack))
         // the properties below are optional
         .allowDestroy(List.of("allowDestroy"))
         .assertionStack(stack)
         .cdkCommandOptions(CdkCommands.builder()
                 .deploy(DeployCommand.builder()
                         .args(DeployOptions.builder()
                                 .all(false)
                                 .app("app")
                                 .assetMetadata(false)
                                 .caBundlePath("caBundlePath")
                                 .changeSetName("changeSetName")
                                 .ci(false)
                                 .color(false)
                                 .concurrency(123)
                                 .context(Map.of(
                                         "contextKey", "context"))
                                 .debug(false)
                                 .ec2Creds(false)
                                 .exclusively(false)
                                 .execute(false)
                                 .force(false)
                                 .ignoreErrors(false)
                                 .json(false)
                                 .lookups(false)
                                 .notices(false)
                                 .notificationArns(List.of("notificationArns"))
                                 .output("output")
                                 .outputsFile("outputsFile")
                                 .parameters(Map.of(
                                         "parametersKey", "parameters"))
                                 .pathMetadata(false)
                                 .profile("profile")
                                 .proxy("proxy")
                                 .requireApproval(RequireApproval.NEVER)
                                 .reuseAssets(List.of("reuseAssets"))
                                 .roleArn("roleArn")
                                 .rollback(false)
                                 .stacks(List.of("stacks"))
                                 .staging(false)
                                 .strict(false)
                                 .toolkitStackName("toolkitStackName")
                                 .trace(false)
                                 .usePreviousParameters(false)
                                 .verbose(false)
                                 .versionReporting(false)
                                 .build())
                         .enabled(false)
                         .expectedMessage("expectedMessage")
                         .expectError(false)
                         .build())
                 .destroy(DestroyCommand.builder()
                         .args(DestroyOptions.builder()
                                 .all(false)
                                 .app("app")
                                 .assetMetadata(false)
                                 .caBundlePath("caBundlePath")
                                 .color(false)
                                 .context(Map.of(
                                         "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(List.of("stacks"))
                                 .staging(false)
                                 .strict(false)
                                 .trace(false)
                                 .verbose(false)
                                 .versionReporting(false)
                                 .build())
                         .enabled(false)
                         .expectedMessage("expectedMessage")
                         .expectError(false)
                         .build())
                 .build())
         .diffAssets(false)
         .hooks(Hooks.builder()
                 .postDeploy(List.of("postDeploy"))
                 .postDestroy(List.of("postDestroy"))
                 .preDeploy(List.of("preDeploy"))
                 .preDestroy(List.of("preDestroy"))
                 .build())
         .regions(List.of("regions"))
         .stackUpdateWorkflow(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IntegTestCase.Builder	(experimental) A fluent builder for IntegTestCase.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IntegTestCase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	IntegTestCase(software.amazon.jsii.JsiiObjectRef objRef)
	IntegTestCase(software.constructs.Construct scope, String id, IntegTestCaseProps props)

Method Summary

Modifier and Type	Method	Description
IDeployAssert	getAssertions()	(experimental) Make assertions on resources in this test case.
IntegManifest	getManifest()	(experimental) The integration test manifest for this test case.

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

IntegTestCase

protected IntegTestCase(software.amazon.jsii.JsiiObjectRef objRef)

IntegTestCase

protected IntegTestCase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

IntegTestCase

@Stability(Experimental)
public IntegTestCase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 IntegTestCaseProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getAssertions

@Stability(Experimental)
@NotNull
public IDeployAssert getAssertions()

(experimental) Make assertions on resources in this test case.

getManifest

@Stability(Experimental)
@NotNull
public IntegManifest getManifest()

(experimental) The integration test manifest for this test case.

Manifests are used by the integration test runner.