Python: Testing

CDKTN Core API Reference for Testing in Python.

Testing utilities for cdktf applications.

Initializers

import cdktn

cdktn.Testing()

Name	Type	Description

---

Static Functions

Name	Description
app	Returns an app for testing with the following properties: - Output directory is a temp dir.
enable_future_flags	No description.
fake_cdktf_json_path	No description.
full_synth	No description.
render_construct_tree	No description.
setup_jest	No description.
stub_version	No description.
synth	Returns the Terraform synthesized JSON.
synth_hcl	Returns the Terraform synthesized JSON.
synth_scope	No description.
to_be_valid_terraform	No description.
to_have_data_source	No description.
to_have_data_source_with_properties	No description.
to_have_provider	No description.
to_have_provider_with_properties	No description.
to_have_resource	No description.
to_have_resource_with_properties	No description.

---

app

import cdktn

cdktn.Testing.app(
  context: typing.Mapping[typing.Any] = None,
  enable_future_flags: bool = None,
  fake_cdktf_json_path: bool = None,
  outdir: str = None,
  stack_traces: bool = None,
  stub_version: bool = None
)

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

context^Optional

• Type: typing.Mapping[typing.Any]

---

enable_future_flags^Optional

• Type: bool

---

fake_cdktf_json_path^Optional

• Type: bool

---

outdir^Optional

• Type: str

---

stack_traces^Optional

• Type: bool

---

stub_version^Optional

• Type: bool

---

enable_future_flags

import cdktn

cdktn.Testing.enable_future_flags(
  app: App
)

app^Required

• Type: App

---

fake_cdktf_json_path

import cdktn

cdktn.Testing.fake_cdktf_json_path(
  app: App
)

app^Required

• Type: App

---

full_synth

import cdktn

cdktn.Testing.full_synth(
  stack: TerraformStack
)

stack^Required

• Type: TerraformStack

---

render_construct_tree

import cdktn

cdktn.Testing.render_construct_tree(
  construct: IConstruct
)

construct^Required

• Type: constructs.IConstruct

---

setup_jest

import cdktn

cdktn.Testing.setup_jest()

stub_version

import cdktn

cdktn.Testing.stub_version(
  app: App
)

app^Required

• Type: App

---

synth

import cdktn

cdktn.Testing.synth(
  stack: TerraformStack,
  run_validations: bool = None
)

Returns the Terraform synthesized JSON.

stack^Required

• Type: TerraformStack

---

run_validations^Optional

• Type: bool

---

synth_hcl

import cdktn

cdktn.Testing.synth_hcl(
  stack: TerraformStack,
  run_validations: bool = None,
  return_metadata: bool = None
)

Returns the Terraform synthesized JSON.

stack^Required

• Type: TerraformStack

---

run_validations^Optional

• Type: bool

---

return_metadata^Optional

• Type: bool

---

synth_scope

import cdktn

cdktn.Testing.synth_scope(
  fn: IScopeCallback
)

fn^Required

• Type: IScopeCallback

---

to_be_valid_terraform

import cdktn

cdktn.Testing.to_be_valid_terraform(
  received: str
)

received^Required

• Type: str

---

to_have_data_source

import cdktn

cdktn.Testing.to_have_data_source(
  received: str,
  resource_type: str
)

received^Required

• Type: str

---

resource_type^Required

• Type: str

---

to_have_data_source_with_properties

import cdktn

cdktn.Testing.to_have_data_source_with_properties(
  received: str,
  resource_type: str,
  properties: typing.Mapping[typing.Any] = None
)

received^Required

• Type: str

---

resource_type^Required

• Type: str

---

properties^Optional

• Type: typing.Mapping[typing.Any]

---

to_have_provider

import cdktn

cdktn.Testing.to_have_provider(
  received: str,
  resource_type: str
)

received^Required

• Type: str

---

resource_type^Required

• Type: str

---

to_have_provider_with_properties

import cdktn

cdktn.Testing.to_have_provider_with_properties(
  received: str,
  resource_type: str,
  properties: typing.Mapping[typing.Any] = None
)

received^Required

• Type: str

---

resource_type^Required

• Type: str

---

properties^Optional

• Type: typing.Mapping[typing.Any]

---

to_have_resource

import cdktn

cdktn.Testing.to_have_resource(
  received: str,
  resource_type: str
)

received^Required

• Type: str

---

resource_type^Required

• Type: str

---

to_have_resource_with_properties

import cdktn

cdktn.Testing.to_have_resource_with_properties(
  received: str,
  resource_type: str,
  properties: typing.Mapping[typing.Any] = None
)

received^Required

• Type: str

---

resource_type^Required

• Type: str

---

properties^Optional

• Type: typing.Mapping[typing.Any]

---