Java: Testing - CDK Terrain (CDKTN)

Testing utilities for cdktf applications.

Initializers

import io.cdktn.cdktn.Testing;

new Testing();

Name	Type	Description

Static Functions

Name	Description
`app`	Returns an app for testing with the following properties: - Output directory is a temp dir.
`enableFutureFlags`	No description.
`fakeCdktfJsonPath`	No description.
`fullSynth`	No description.
`renderConstructTree`	No description.
`setupJest`	No description.
`stubVersion`	No description.
`synth`	Returns the Terraform synthesized JSON.
`synthHcl`	Returns the Terraform synthesized JSON.
`synthScope`	No description.
`toBeValidTerraform`	No description.
`toHaveDataSource`	No description.
`toHaveDataSourceWithProperties`	No description.
`toHaveProvider`	No description.
`toHaveProviderWithProperties`	No description.
`toHaveResource`	No description.
`toHaveResourceWithProperties`	No description.

`app`

import io.cdktn.cdktn.Testing;

Testing.app(),Testing.app(TestingAppConfig options)

Returns an app for testing with the following properties: - Output directory is a temp dir.

`options`^Optional

Type: TestingAppConfig

`enableFutureFlags`

import io.cdktn.cdktn.Testing;

Testing.enableFutureFlags(App app)

`app`^Required

Type: App

`fakeCdktfJsonPath`

import io.cdktn.cdktn.Testing;

Testing.fakeCdktfJsonPath(App app)

`app`^Required

Type: App

`fullSynth`

import io.cdktn.cdktn.Testing;

Testing.fullSynth(TerraformStack stack)

`stack`^Required

Type: TerraformStack

`renderConstructTree`

import io.cdktn.cdktn.Testing;

Testing.renderConstructTree(IConstruct construct)

`construct`^Required

Type: software.constructs.IConstruct

`setupJest`

import io.cdktn.cdktn.Testing;

Testing.setupJest()

`stubVersion`

import io.cdktn.cdktn.Testing;

Testing.stubVersion(App app)

`app`^Required

Type: App

`synth`

import io.cdktn.cdktn.Testing;

Testing.synth(TerraformStack stack),Testing.synth(TerraformStack stack, java.lang.Boolean runValidations)

Returns the Terraform synthesized JSON.

`stack`^Required

Type: TerraformStack

`runValidations`^Optional

Type: java.lang.Boolean

`synthHcl`

import io.cdktn.cdktn.Testing;

Testing.synthHcl(TerraformStack stack),Testing.synthHcl(TerraformStack stack, java.lang.Boolean runValidations),Testing.synthHcl(TerraformStack stack, java.lang.Boolean runValidations, java.lang.Boolean returnMetadata)

Returns the Terraform synthesized JSON.

`stack`^Required

Type: TerraformStack

`runValidations`^Optional

Type: java.lang.Boolean

`returnMetadata`^Optional

Type: java.lang.Boolean

`synthScope`

import io.cdktn.cdktn.Testing;

Testing.synthScope(IScopeCallback fn)

`fn`^Required

Type: IScopeCallback

`toBeValidTerraform`

import io.cdktn.cdktn.Testing;

Testing.toBeValidTerraform(java.lang.String received)

`received`^Required

Type: java.lang.String

`toHaveDataSource`

import io.cdktn.cdktn.Testing;

Testing.toHaveDataSource(java.lang.String received, java.lang.String resourceType)

`received`^Required

Type: java.lang.String

`resourceType`^Required

Type: java.lang.String

`toHaveDataSourceWithProperties`

import io.cdktn.cdktn.Testing;

Testing.toHaveDataSourceWithProperties(java.lang.String received, java.lang.String resourceType),Testing.toHaveDataSourceWithProperties(java.lang.String received, java.lang.String resourceType, java.util.Map<java.lang.String, java.lang.Object> properties)

`received`^Required

Type: java.lang.String

`resourceType`^Required

Type: java.lang.String

`properties`^Optional

Type: java.util.Map< java.lang.String, java.lang.Object >

`toHaveProvider`

import io.cdktn.cdktn.Testing;

Testing.toHaveProvider(java.lang.String received, java.lang.String resourceType)

`received`^Required

Type: java.lang.String

`resourceType`^Required

Type: java.lang.String

`toHaveProviderWithProperties`

import io.cdktn.cdktn.Testing;

Testing.toHaveProviderWithProperties(java.lang.String received, java.lang.String resourceType),Testing.toHaveProviderWithProperties(java.lang.String received, java.lang.String resourceType, java.util.Map<java.lang.String, java.lang.Object> properties)

`received`^Required

Type: java.lang.String

`resourceType`^Required

Type: java.lang.String

`properties`^Optional

Type: java.util.Map< java.lang.String, java.lang.Object >

`toHaveResource`

import io.cdktn.cdktn.Testing;

Testing.toHaveResource(java.lang.String received, java.lang.String resourceType)

`received`^Required

Type: java.lang.String

`resourceType`^Required

Type: java.lang.String

`toHaveResourceWithProperties`

import io.cdktn.cdktn.Testing;

Testing.toHaveResourceWithProperties(java.lang.String received, java.lang.String resourceType),Testing.toHaveResourceWithProperties(java.lang.String received, java.lang.String resourceType, java.util.Map<java.lang.String, java.lang.Object> properties)

`received`^Required

Type: java.lang.String

`resourceType`^Required

Type: java.lang.String

`properties`^Optional

Type: java.util.Map< java.lang.String, java.lang.Object >

​Initializers

​Static Functions

​app

​optionsOptional

​enableFutureFlags

​appRequired

​fakeCdktfJsonPath

​appRequired

​fullSynth

​stackRequired

​renderConstructTree

​constructRequired

​setupJest

​stubVersion

​appRequired

​synth

​stackRequired

​runValidationsOptional

​synthHcl

​stackRequired

​runValidationsOptional

​returnMetadataOptional

​synthScope

​fnRequired

​toBeValidTerraform

​receivedRequired

​toHaveDataSource

​receivedRequired

​resourceTypeRequired

​toHaveDataSourceWithProperties

​receivedRequired

​resourceTypeRequired

​propertiesOptional

​toHaveProvider

​receivedRequired

​resourceTypeRequired

​toHaveProviderWithProperties

​receivedRequired

​resourceTypeRequired

​propertiesOptional

​toHaveResource

​receivedRequired

​resourceTypeRequired

​toHaveResourceWithProperties

​receivedRequired

​resourceTypeRequired

​propertiesOptional

Initializers

Static Functions

`app`

`options`^Optional

`enableFutureFlags`

`app`^Required

`fakeCdktfJsonPath`

`app`^Required

`fullSynth`

`stack`^Required

`renderConstructTree`

`construct`^Required

`setupJest`

`stubVersion`

`app`^Required

`synth`

`stack`^Required

`runValidations`^Optional

`synthHcl`

`stack`^Required

`runValidations`^Optional

`returnMetadata`^Optional

`synthScope`

`fn`^Required

`toBeValidTerraform`

`received`^Required

`toHaveDataSource`

`received`^Required

`resourceType`^Required

`toHaveDataSourceWithProperties`

`received`^Required

`resourceType`^Required

`properties`^Optional

`toHaveProvider`

`received`^Required

`resourceType`^Required

`toHaveProviderWithProperties`

`received`^Required

`resourceType`^Required

`properties`^Optional

`toHaveResource`

`received`^Required

`resourceType`^Required

`toHaveResourceWithProperties`

`received`^Required

`resourceType`^Required

`properties`^Optional