Package software.amazon.awscdk.cloud_assembly_schema

Interface TestCase

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TestOptions

All Known Implementing Classes:

TestCase.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.024Z")
@Stability(Stable)
public interface TestCase
extends software.amazon.jsii.JsiiSerializable, TestOptions

Represents an integration test case.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 TestCase testCase = TestCase.builder()
         .stacks(List.of("stacks"))
         // the properties below are optional
         .allowDestroy(List.of("allowDestroy"))
         .assertionStack("assertionStack")
         .assertionStackName("assertionStackName")
         .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	Interface	Description
static final class	TestCase.Builder	A builder for TestCase
static final class	TestCase.Jsii$Proxy	An implementation for TestCase

Method Summary

Modifier and Type	Method	Description
static TestCase.Builder	builder()
default String	getAssertionStack()	The node id of the stack that contains assertions.
default String	getAssertionStackName()	The name of the stack that contains assertions.
List<String>	getStacks()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.cloud_assembly_schema.TestOptions

getAllowDestroy, getCdkCommandOptions, getDiffAssets, getHooks, getRegions, getStackUpdateWorkflow

Method Details

getStacks

@Stability(Stable)
@NotNull
List<String> getStacks()

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.

getAssertionStack

@Stability(Stable)
@Nullable
default String getAssertionStack()

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

Default: - no assertion stack

getAssertionStackName

@Stability(Stable)
@Nullable
default String getAssertionStackName()

The name of the stack that contains assertions.

Default: - no assertion stack

builder

@Stability(Stable)
static TestCase.Builder builder()

Returns:

a TestCase.Builder of TestCase