Skip to main content
Testing utilities for cdktf applications.

​
Initializers 

import io.cdktn.cdktn.Testing;

new Testing();
NameTypeDescription

​
Static Functions

NameDescription
appReturns an app for testing with the following properties: - Output directory is a temp dir.
enableFutureFlagsNo description.
fakeCdktfJsonPathNo description.
fullSynthNo description.
renderConstructTreeNo description.
setupJestNo description.
stubVersionNo description.
synthReturns the Terraform synthesized JSON.
synthHclReturns the Terraform synthesized JSON.
synthScopeNo description.
toBeValidTerraformNo description.
toHaveDataSourceNo description.
toHaveDataSourceWithPropertiesNo description.
toHaveProviderNo description.
toHaveProviderWithPropertiesNo description.
toHaveResourceNo description.
toHaveResourceWithPropertiesNo 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.

​
optionsOptional

​
enableFutureFlags 

import io.cdktn.cdktn.Testing;

Testing.enableFutureFlags(App app)

​
appRequired

​
fakeCdktfJsonPath 

import io.cdktn.cdktn.Testing;

Testing.fakeCdktfJsonPath(App app)

​
appRequired

​
fullSynth 

import io.cdktn.cdktn.Testing;

Testing.fullSynth(TerraformStack stack)

​
stackRequired

​
renderConstructTree 

import io.cdktn.cdktn.Testing;

Testing.renderConstructTree(IConstruct construct)

​
constructRequired

  • Type: software.constructs.IConstruct

​
setupJest 

import io.cdktn.cdktn.Testing;

Testing.setupJest()

​
stubVersion 

import io.cdktn.cdktn.Testing;

Testing.stubVersion(App app)

​
appRequired

​
synth 

import io.cdktn.cdktn.Testing;

Testing.synth(TerraformStack stack),Testing.synth(TerraformStack stack, java.lang.Boolean runValidations)
Returns the Terraform synthesized JSON.

​
stackRequired

​
runValidationsOptional

  • 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.

​
stackRequired

​
runValidationsOptional

  • Type: java.lang.Boolean

​
returnMetadataOptional

  • Type: java.lang.Boolean

​
synthScope 

import io.cdktn.cdktn.Testing;

Testing.synthScope(IScopeCallback fn)

​
fnRequired

​
toBeValidTerraform 

import io.cdktn.cdktn.Testing;

Testing.toBeValidTerraform(java.lang.String received)

​
receivedRequired

  • Type: java.lang.String

​
toHaveDataSource 

import io.cdktn.cdktn.Testing;

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

​
receivedRequired

  • Type: java.lang.String

​
resourceTypeRequired

  • 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)

​
receivedRequired

  • Type: java.lang.String

​
resourceTypeRequired

  • Type: java.lang.String

​
propertiesOptional

  • 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)

​
receivedRequired

  • Type: java.lang.String

​
resourceTypeRequired

  • 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)

​
receivedRequired

  • Type: java.lang.String

​
resourceTypeRequired

  • Type: java.lang.String

​
propertiesOptional

  • 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)

​
receivedRequired

  • Type: java.lang.String

​
resourceTypeRequired

  • 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)

​
receivedRequired

  • Type: java.lang.String

​
resourceTypeRequired

  • Type: java.lang.String

​
propertiesOptional

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