Checks · Provider Test Patterns · hashicorp/agent-skills · Skills Docs

Checks · Provider Test Patterns · hashicorp/agent-skills · Skills Docs

TerraformVersionChecks: []tfversion.TerraformVersionCheck{
    tfversion.SkipBelow(tfversion.Version1_4_6),
},
// ...
statecheck.ExpectSensitiveValue("example_widget.test",
    tfjsonpath.New("api_key"))

compareValuesSame := statecheck.CompareValue(compare.ValuesSame())

Steps: []resource.TestStep{
    {
        Config: testAccConfig_v1(rName),
        ConfigStateChecks: []statecheck.StateCheck{
            compareValuesSame.AddStateValue("example_widget.test",
                tfjsonpath.New("id")),
        },
    },
    {
        Config: testAccConfig_v2(rName),
        ConfigStateChecks: []statecheck.StateCheck{
            compareValuesSame.AddStateValue("example_widget.test",
                tfjsonpath.New("id")),
        },
    },
},

Type	Example
`knownvalue.StringExact("value")`	Exact string match
`knownvalue.StringRegexp(regexp.MustCompile(`^arn:`))`	Regex match
`knownvalue.Bool(true)`	Boolean value
`knownvalue.Int64Exact(42)`	Exact int64
`knownvalue.Float64Exact(3.14)`	Exact float64
`knownvalue.NotNull()`	Value is set (not null)
`knownvalue.Null()`	Value is null
`knownvalue.ListExact([]knownvalue.Check{...})`	Exact list match
`knownvalue.ListPartial(map[int]knownvalue.Check{0: ...})`	Partial list match
`knownvalue.ListSizeExact(3)`	List has N elements
`knownvalue.SetExact([]knownvalue.Check{...})`	Exact set match
`knownvalue.SetPartial([]knownvalue.Check{...})`	Set contains items
`knownvalue.SetSizeExact(2)`	Set has N elements
`knownvalue.MapExact(map[string]knownvalue.Check{...})`	Exact map match
`knownvalue.MapPartial(map[string]knownvalue.Check{...})`	Map contains keys
`knownvalue.MapSizeExact(1)`	Map has N keys
`knownvalue.ObjectExact(map[string]knownvalue.Check{...})`	Exact object match
`knownvalue.ObjectPartial(map[string]knownvalue.Check{...})`	Object has attributes
`knownvalue.Float32Exact(1.5)`	Exact float32
`knownvalue.Int32Exact(42)`	Exact int32
`knownvalue.NumberExact(big.NewFloat(42))`	Exact number (`*big.Float`)
`knownvalue.TupleExact([]knownvalue.Check{...})`	Exact tuple match
`knownvalue.TuplePartial(map[int]knownvalue.Check{0: ...})`	Partial tuple match
`knownvalue.TupleSizeExact(3)`	Tuple has N elements

statecheck.ExpectKnownValue("example_widget.test",
    tfjsonpath.New("settings"),
    knownvalue.ObjectExact(map[string]knownvalue.Check{
        "mode":    knownvalue.StringExact("production"),
        "enabled": knownvalue.Bool(true),
    }))

tfjsonpath.New("attribute")                   // top-level attribute
tfjsonpath.New("block").AtMapKey("key")       // nested map/object key
tfjsonpath.New("list_attr").AtSliceIndex(0)   // list element by index
tfjsonpath.New("block").AtMapKey("nested").AtMapKey("deep") // deep nesting

ConfigPlanChecks: resource.ConfigPlanChecks{
    PreApply:  []plancheck.PlanCheck{...}, // after plan, before apply
    PostApplyPreRefresh: []plancheck.PlanCheck{...}, // after apply, before refresh
    PostApplyPostRefresh: []plancheck.PlanCheck{...}, // after refresh
},

// Expect no changes in plan
plancheck.ExpectEmptyPlan()

// Expect changes in plan
plancheck.ExpectNonEmptyPlan()

// Expect specific resource action
plancheck.ExpectResourceAction("example_widget.test", plancheck.ResourceActionCreate)
plancheck.ExpectResourceAction("example_widget.test", plancheck.ResourceActionUpdate)
plancheck.ExpectResourceAction("example_widget.test", plancheck.ResourceActionDestroy)
plancheck.ExpectResourceAction("example_widget.test", plancheck.ResourceActionNoop)

// Expect known plan value
plancheck.ExpectKnownValue("example_widget.test",
    tfjsonpath.New("name"),
    knownvalue.StringExact("my-widget"))

// Expect unknown (computed) value in plan
plancheck.ExpectUnknownValue("example_widget.test",
    tfjsonpath.New("computed_field"))

// Expect sensitive value in plan
plancheck.ExpectSensitiveValue("example_widget.test",
    tfjsonpath.New("api_key"))

Steps: []resource.TestStep{
    {
        Config: testAccConfig_basic(rName),
    },
    {
        Config: testAccConfig_updated(rName),
    },
    {
        Config: testAccConfig_basic(rName),
        ConfigPlanChecks: resource.ConfigPlanChecks{
            PreApply: []plancheck.PlanCheck{
                plancheck.ExpectEmptyPlan(),
            },
        },
    },
},