Known Value Checks

Known Value Checks are for use in conjunction with Plan Checks, and State Checks which leverage the terraform-json representation of a Terraform plan.

Usage

Example uses in the testing module include:

• Plan Checks: The ExpectKnownValue(), ExpectKnownOutputValue() and ExpectKnownOutputValueAtPath() built-in plan checks use known value checks for asserting whether a specific resource attribute, or output value has a particular type, and value.
• State Checks: The ExpectKnownValue(), ExpectKnownOutputValue() and ExpectKnownOutputValueAtPath() built-in state checks use known value checks for asserting whether a specific resource attribute, or output value has a particular type, and value.

Using a Known Value Check

The known value check types are implemented within the terraform-plugin-testing module in the knownvalue package. Known value checks are instantiated by calling the relevant constructor function.

knownvalue.Bool(true)

For known value checks that represent collections, or objects, nesting of known value checks can be used to define a "composite" known value check for use in asserting against a resource attribute, or output value that contains other values.

knownvalue.ListExact([]knownvalue.Check{
    knownvalue.StringExact("value1"),
    knownvalue.StringExact("value2"),
})

Known Value Check Types

The following table shows the correspondence between knownvalue.Check types, and attributes.