go-tests

name

go-tests

description

Go test patterns for this Terraform provider using table-driven tests, the Expectation pattern, and cmp.Diff. MUST be consulted before writing Go test code, including tests added as part of a larger feature implementation. Use when writing, adding, or fixing Go tests; working with _test.go files; implementing Go behavior that needs test coverage; adding unit tests; testing Terraform provider mapping/model/diagnostic behavior; adding acceptance tests with Terraform Plugin Testing; or verifying Go code with tests. Triggers on "Go test", "write tests", "add tests", "test coverage", "unit test", "_test.go", "verify with tests", "test the implementation", "add test cases", "table-driven test", "cmp.Diff", or any Go implementation task that includes a testing step.

Go Tests

Table-driven tests using the Expectation pattern with cmp.Diff.

For Terraform provider lifecycle behavior, also use the terraform-provider-development skill. Provider tests must prove Terraform state, plan, import, diagnostics, and drift behavior, not only Go return values.

Required Pattern

func TestFunctionName(t *testing.T) {
	t.Parallel()

	type Expectation struct {
		Result ResultType
		Err    string
	}

	tests := []struct {
		Name     string
		Input    InputType
		Expected Expectation
	}{
		{
			Name:  "descriptive_snake_case_name",
			Input: inputValue,
			Expected: Expectation{
				Result: expectedValue,
			},
		},
	}

	for _, tc := range tests {
		t.Run(tc.Name, func(t *testing.T) {
			t.Parallel()

			 got Expectation
			result, err := FunctionUnderTest(tc.Input)
			 err !=  {
				got.Err = err.Error()
			}  {
				got.Result = result
			}

			 diff := cmp.Diff(tc.Expected, got); diff !=  {
				t.Errorf(, diff)
			}
		})
	}
}