Add Option to use Terraform Configuration in TestStep

.changes/unreleased/FEATURES-20230728-143814.yaml

@@ -0,0 +1,6 @@
+kind: FEATURES
+body: 'config: Introduced new `config` package which contains interfaces and helper
+  functions for working with native Terraform configuration and variables'
+time: 2023-07-28T14:38:14.006499+01:00
+custom:
+  Issue: "153"

.changes/unreleased/FEATURES-20230728-152737.yaml

@@ -0,0 +1,6 @@
+kind: FEATURES
+body: 'helper/resource: Added `TestStep.ConfigDirectory` to allow specifying a directory
+  containing Terraform configuration for use during acceptance tests'
+time: 2023-07-28T15:27:37.944964+01:00
+custom:
+  Issue: "153"

.changes/unreleased/FEATURES-20230728-152822.yaml

@@ -0,0 +1,6 @@
+kind: FEATURES
+body: 'helper/resource: Added `TestStep.ConfigFile` to allow specifying a file containing
+  Terraform configuration for use during acceptance tests'
+time: 2023-07-28T15:28:22.204411+01:00
+custom:
+  Issue: "153"

.changes/unreleased/FEATURES-20230728-152917.yaml

@@ -0,0 +1,6 @@
+kind: FEATURES
+body: 'helper/resource: Added `TestStep.ConfigVariables` to allow specifying Terraform variables
+  for use with Terraform configuration during acceptance tests'
+time: 2023-07-28T15:29:17.02183+01:00
+custom:
+  Issue: "153"

config/config.go

@@ -0,0 +1,38 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package config
+
+// TestStepConfigFunc is the callback type used with acceptance tests to
+// specify a string which either identifies a directory containing
+// Terraform configuration files, or a file that contains Terraform
+// configuration.
+type TestStepConfigFunc func(TestStepConfigRequest) string
+
+// TestStepConfigRequest defines the request supplied to types
+// implementing TestStepConfigFunc. StepNumber is one-based
+// and is used in the predefined helper functions:
+//
+//   - [config.TestStepDirectory]
+//   - [config.TestStepFile].
+//
+// TestName is used in the predefined helper functions:
+//
+//   - [config.TestNameDirectory]
+//   - [config.TestStepDirectory]
+//   - [config.TestNameFile]
+//   - [config.TestStepFile]
+type TestStepConfigRequest struct {
+	StepNumber int
+	TestName   string
+}
+
+// Exec executes TestStepConfigFunc if it is not nil, otherwise an
+// empty string is returned.
+func (f TestStepConfigFunc) Exec(req TestStepConfigRequest) string {
+	if f != nil {
+		return f(req)
+	}
+
+	return ""
+}

config/directory.go

@@ -0,0 +1,63 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package config
+
+import (
+	"path/filepath"
+	"strconv"
+)
+
+// StaticDirectory returns the supplied directory.
+func StaticDirectory(directory string) func(TestStepConfigRequest) string {
+	return func(_ TestStepConfigRequest) string {
+		return directory
+	}
+}
+
+// TestNameDirectory returns the name of the test prefixed with
+// "testdata".
+//
+// For example, given test code:
+//
+//	func TestExampleCloudThing_basic(t *testing.T) {
+//	    resource.Test(t, resource.TestCase{
+//	        Steps: []resource.TestStep{
+//	            {
+//	                ConfigDirectory: config.TestNameDirectory(),
+//	            },
+//	        },
+//	    })
+//	}
+//
+// The testing configurations will be expected in the
+// testdata/TestExampleCloudThing_basic/ directory.
+func TestNameDirectory() func(TestStepConfigRequest) string {
+	return func(req TestStepConfigRequest) string {
+		return filepath.Join("testdata", req.TestName)
+	}
+}
+
+// TestStepDirectory returns the name of the test suffixed with the
+// test step number and prefixed with "testdata".
+//
+// For example, given test code:
+//
+//	func TestExampleCloudThing_basic(t *testing.T) {
+//	    resource.Test(t, resource.TestCase{
+//	        Steps: []resource.TestStep{
+//	            {
+//	                ConfigDirectory: config.TestStepDirectory(),
+//	            },
+//	        },
+//	    })
+//	}
+//
+// The testing configurations will be expected in the
+// testdata/TestExampleCloudThing_basic/1 directory as
+// TestStepConfigRequest.StepNumber is one-based.
+func TestStepDirectory() func(TestStepConfigRequest) string {
+	return func(req TestStepConfigRequest) string {
+		return filepath.Join("testdata", req.TestName, strconv.Itoa(req.StepNumber))
+	}
+}

config/directory_test.go

@@ -0,0 +1,54 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package config_test
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/config"
+)
+
+func TestTestStepConfigFunc_Exec_Directory(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		testStepConfigFunc    config.TestStepConfigFunc
+		testStepConfigRequest config.TestStepConfigRequest
+		expected              string
+	}{
+		"static_directory": {
+			testStepConfigFunc: config.StaticDirectory("name_of_directory"),
+			expected:           "name_of_directory",
+		},
+		"test_name_directory": {
+			testStepConfigFunc: config.TestNameDirectory(),
+			testStepConfigRequest: config.TestStepConfigRequest{
+				TestName: "TestTestStepConfigFunc_Exec",
+			},
+			expected: "testdata/TestTestStepConfigFunc_Exec",
+		},
+		"test_step_directory": {
+			testStepConfigFunc: config.TestStepDirectory(),
+			testStepConfigRequest: config.TestStepConfigRequest{
+				StepNumber: 1,
+				TestName:   "TestTestStepConfigFunc_Exec",
+			},
+			expected: "testdata/TestTestStepConfigFunc_Exec/1",
+		},
+	}
+
+	for name, testCase := range testCases {
+		name, testCase := name, testCase
+
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			got := testCase.testStepConfigFunc.Exec(testCase.testStepConfigRequest)
+
+			if testCase.expected != got {
+				t.Errorf("expected %s, got %s", testCase.expected, got)
+			}
+		})
+	}
+}

config/doc.go

@@ -0,0 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+// Package config implements functionality for supporting native
+// Terraform configuration and variables for testing purposes.
+package config

config/file.go

@@ -0,0 +1,63 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package config
+
+import (
+	"path/filepath"
+	"strconv"
+)
+
+// StaticFile returns the supplied file.
+func StaticFile(file string) func(TestStepConfigRequest) string {
+	return func(_ TestStepConfigRequest) string {
+		return file
+	}
+}
+
+// TestNameFile returns the name of the test suffixed with the supplied
+// file and prefixed with "testdata".
+//
+// For example, given test code:
+//
+//	func TestExampleCloudThing_basic(t *testing.T) {
+//	    resource.Test(t, resource.TestCase{
+//	        Steps: []resource.TestStep{
+//	            {
+//	                ConfigFile: config.TestNameFile("test.tf"),
+//	            },
+//	        },
+//	    })
+//	}
+//
+// The testing configuration will be expected in the
+// testdata/TestExampleCloudThing_basic/test.tf file.
+func TestNameFile(file string) func(TestStepConfigRequest) string {
+	return func(req TestStepConfigRequest) string {
+		return filepath.Join("testdata", req.TestName, file)
+	}
+}
+
+// TestStepFile returns the name of the test suffixed with the test
+// step number and the supplied file, and prefixed with "testdata".
+//
+// For example, given test code:
+//
+//	func TestExampleCloudThing_basic(t *testing.T) {
+//	    resource.Test(t, resource.TestCase{
+//	        Steps: []resource.TestStep{
+//	            {
+//	                ConfigFile: config.TestStepFile("test.tf"),
+//	            },
+//	        },
+//	    })
+//	}
+//
+// The testing configuration will be expected in the
+// testdata/TestExampleCloudThing_basic/1/test.tf file
+// as TestStepConfigRequest.StepNumber is one-based.
+func TestStepFile(file string) func(TestStepConfigRequest) string {
+	return func(req TestStepConfigRequest) string {
+		return filepath.Join("testdata", req.TestName, strconv.Itoa(req.StepNumber), file)
+	}
+}

config/file_test.go

@@ -0,0 +1,54 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package config_test
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/config"
+)
+
+func TestTestStepConfigFunc_Exec_File(t *testing.T) {
+	t.Parallel()
+
+	testCases := map[string]struct {
+		testStepConfigFunc    config.TestStepConfigFunc
+		testStepConfigRequest config.TestStepConfigRequest
+		expected              string
+	}{
+		"static_file": {
+			testStepConfigFunc: config.StaticFile("name_of_file"),
+			expected:           "name_of_file",
+		},
+		"test_name_file": {
+			testStepConfigFunc: config.TestNameFile("test.tf"),
+			testStepConfigRequest: config.TestStepConfigRequest{
+				TestName: "TestTestStepConfigFunc_Exec",
+			},
+			expected: "testdata/TestTestStepConfigFunc_Exec/test.tf",
+		},
+		"test_step_file": {
+			testStepConfigFunc: config.TestStepFile("test.tf"),
+			testStepConfigRequest: config.TestStepConfigRequest{
+				StepNumber: 1,
+				TestName:   "TestTestStepConfigFunc_Exec",
+			},
+			expected: "testdata/TestTestStepConfigFunc_Exec/1/test.tf",
+		},
+	}
+
+	for name, testCase := range testCases {
+		name, testCase := name, testCase
+
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			got := testCase.testStepConfigFunc.Exec(testCase.testStepConfigRequest)
+
+			if testCase.expected != got {
+				t.Errorf("expected %s, got %s", testCase.expected, got)
+			}
+		})
+	}
+}