Plan Assertions

Plan assertions will be run after running terraform plan.

PlanSucceeds

Asserts that terraform plan succeeds.

SchemaExample

- name: <name>
  type: PlanSucceeds

- name: PlanShouldSucceed
  type: PlanSucceeds

Inputs	Description	Type	Required
name	Name for the assertion	String	No

PlanFails

Asserts that terraform plan fails.

SchemaExample

- name: <name>
  type: PlanFails

- name: PlanMustFail
  type: PlanFails

Inputs	Description	Type	Required
name	Name for the assertion	String	No

PlanFailsWithError

Asserts that terraform plan with an error containing a certain substring.

SchemaExample

- name: <name>
  type: PlanFailsWithError
  error_message_contains: <error_message_contains>

- name: MustFailWithSampleError
  type: PlanFailsWithError
  error_message_contains: Failed with sample error

Inputs	Description	Type	Required
name	Name for the assertion	String	No
error_message_contains	String that should be present in the error message	String	Yes