Add terraform block to config when not already present (#216)

* Prefix configuration with empty terraform block if block is missing from config (#215) * Adding unit tests for AddTerraformBlock() (#215) * Revert "Adding unit tests for AddTerraformBlock() (#215)" This reverts commit bd351c0. * Revert "Prefix configuration with empty terraform block if block is missing from config (#215)" This reverts commit d417058. * Broken implementation (#215) * Removing unneeded addition of provider blocks (#215) * Modifying TestStep.mergedConfig() to add terraform blocks (#215) * Linting (#215) * Only add terraform required provider blocks for TF >= 1.6.* (#215) * Adding change log entry (#215) * Fixing nil pointers (#215) * Remove Terraform version check when adding required providers (#215) * Remove Terraform version check when adding required providers (#215) * Revert "Remove Terraform version check when adding required providers (#215)" This reverts commit b530b61. * Revert "Remove Terraform version check when adding required providers (#215)" This reverts commit 711d592. * Remove addition of required providers that do not specify a source (#215) * Set minimum Terraform version to v1.0.0 for adding required providers to terraform block (#215) * Update changelog (#215)
hashicorp · Nov 30, 2023 · 222d08e · 222d08e
1 parent 880e76a
commit 222d08e
Show file tree

Hide file tree

Showing 17 changed files with 1,460 additions and 62 deletions.
diff --git a/.changes/unreleased/ENHANCEMENTS-20231130-092645.yaml b/.changes/unreleased/ENHANCEMENTS-20231130-092645.yaml
@@ -0,0 +1,6 @@
+kind: ENHANCEMENTS
+body: 'helper/resource: Automatically add `required_providers` configuration to `TestStep.Config`
+  Terraform language configuration when using Terraform >= 1.0.*'
+time: 2023-11-30T09:26:45.606859Z
+custom:
+  Issue: "216"
diff --git a/helper/resource/testcase_providers_test.go b/helper/resource/testcase_providers_test.go
@@ -16,6 +16,8 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 
 	"github.com/hashicorp/terraform-plugin-testing/internal/plugintest"
+	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testprovider"
+	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testsdk/providerserver"
 	"github.com/hashicorp/terraform-plugin-testing/tfversion"
 )
 
@@ -223,7 +225,8 @@ provider "test" {}
 					"test": {},
 				},
 			},
-			expected: `provider "test" {}`,
+			expected: `
+provider "test" {}`,
 		},
 	}
 
@@ -365,9 +368,7 @@ func TestTest_TestCase_ProtoV5ProviderFactories(t *testing.T) {
 
 	Test(&mockT{}, TestCase{
 		ProtoV5ProviderFactories: map[string]func() (tfprotov5.ProviderServer, error){
-			"test": func() (tfprotov5.ProviderServer, error) { //nolint:unparam // required signature
-				return nil, nil
-			},
+			"test": providerserver.NewProtov5ProviderServer(testprovider.Protov5Provider{}),
 		},
 		Steps: []TestStep{
 			{
@@ -401,9 +402,7 @@ func TestTest_TestCase_ProtoV6ProviderFactories(t *testing.T) {
 
 	Test(&mockT{}, TestCase{
 		ProtoV6ProviderFactories: map[string]func() (tfprotov6.ProviderServer, error){
-			"test": func() (tfprotov6.ProviderServer, error) { //nolint:unparam // required signature
-				return nil, nil
-			},
+			"test": providerserver.NewProviderServer(testprovider.Provider{}),
 		},
 		Steps: []TestStep{
 			{
@@ -438,7 +437,7 @@ func TestTest_TestCase_ProviderFactories(t *testing.T) {
 	Test(&mockT{}, TestCase{
 		ProviderFactories: map[string]func() (*schema.Provider, error){
 			"test": func() (*schema.Provider, error) { //nolint:unparam // required signature
-				return nil, nil
+				return &schema.Provider{}, nil
 			},
 		},
 		Steps: []TestStep{

diff --git a/helper/resource/testing_new.go b/helper/resource/testing_new.go
@@ -228,13 +228,23 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 
 			var testStepConfig teststep.Config
 
+			rawCfg, err := step.providerConfig(ctx, hasProviderBlock, helper.TerraformVersion())
+
+			if err != nil {
+				logging.HelperResourceError(ctx,
+					"TestStep error generating provider configuration",
+					map[string]interface{}{logging.KeyError: err},
+				)
+				t.Fatalf("TestStep %d/%d error generating provider configuration: %s", stepNumber, len(c.Steps), err)
+			}
+
 			// Return value from step.providerConfig() is assigned to Raw as this was previously being
 			// passed to wd.SetConfig() directly when the second argument to wd.SetConfig() accepted a
 			// configuration string.
 			confRequest := teststep.PrepareConfigurationRequest{
 				Directory: step.ConfigDirectory,
 				File:      step.ConfigFile,
-				Raw:       step.providerConfig(ctx, hasProviderBlock),
+				Raw:       rawCfg,
 				TestStepConfigRequest: config.TestStepConfigRequest{
 					StepNumber: stepIndex + 1,
 					TestName:   t.Name(),
@@ -354,7 +364,7 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 		if cfg != nil {
 			logging.HelperResourceTrace(ctx, "TestStep is Config mode")
 
-			err := testStepNewConfig(ctx, t, c, wd, step, providers, stepIndex)
+			err := testStepNewConfig(ctx, t, c, wd, step, providers, stepIndex, helper)
 			if step.ExpectError != nil {
 				logging.HelperResourceDebug(ctx, "Checking TestStep ExpectError")
 
@@ -413,7 +423,15 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 				}
 			}
 
-			mergedConfig := step.mergedConfig(ctx, c, hasTerraformBlock, hasProviderBlock)
+			mergedConfig, err := step.mergedConfig(ctx, c, hasTerraformBlock, hasProviderBlock, helper.TerraformVersion())
+
+			if err != nil {
+				logging.HelperResourceError(ctx,
+					"Error generating merged configuration",
+					map[string]interface{}{logging.KeyError: err},
+				)
+				t.Fatalf("Error generating merged configuration: %s", err)
+			}
 
 			confRequest := teststep.PrepareConfigurationRequest{
 				Directory: step.ConfigDirectory,
@@ -469,7 +487,7 @@ func planIsEmpty(plan *tfjson.Plan) bool {
 	return true
 }
 
-func testIDRefresh(ctx context.Context, t testing.T, c TestCase, wd *plugintest.WorkingDir, step TestStep, r *terraform.ResourceState, providers *providerFactories, stepIndex int) error {
+func testIDRefresh(ctx context.Context, t testing.T, c TestCase, wd *plugintest.WorkingDir, step TestStep, r *terraform.ResourceState, providers *providerFactories, stepIndex int, helper *plugintest.Helper) error {
 	t.Helper()
 
 	// Build the state. The state is just the resource with an ID. There
@@ -521,11 +539,17 @@ func testIDRefresh(ctx context.Context, t testing.T, c TestCase, wd *plugintest.
 		t.Fatalf("Error setting import test config: %s", err)
 	}
 
+	rawCfg, err := step.providerConfig(ctx, hasProviderBlock, helper.TerraformVersion())
+
+	if err != nil {
+		t.Fatalf("Error generating import provider config: %s", err)
+	}
+
 	defer func() {
 		confRequest := teststep.PrepareConfigurationRequest{
 			Directory: step.ConfigDirectory,
 			File:      step.ConfigFile,
-			Raw:       step.providerConfig(ctx, hasProviderBlock),
+			Raw:       rawCfg,
 			TestStepConfigRequest: config.TestStepConfigRequest{
 				StepNumber: stepIndex + 1,
 				TestName:   t.Name(),

diff --git a/helper/resource/testing_new_config.go b/helper/resource/testing_new_config.go
@@ -20,7 +20,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/internal/plugintest"
 )
 
-func testStepNewConfig(ctx context.Context, t testing.T, c TestCase, wd *plugintest.WorkingDir, step TestStep, providers *providerFactories, stepIndex int) error {
+func testStepNewConfig(ctx context.Context, t testing.T, c TestCase, wd *plugintest.WorkingDir, step TestStep, providers *providerFactories, stepIndex int, helper *plugintest.Helper) error {
 	t.Helper()
 
 	configRequest := teststep.PrepareConfigurationRequest{
@@ -62,7 +62,15 @@ func testStepNewConfig(ctx context.Context, t testing.T, c TestCase, wd *plugint
 		}
 	}
 
-	mergedConfig := step.mergedConfig(ctx, c, hasTerraformBlock, hasProviderBlock)
+	mergedConfig, err := step.mergedConfig(ctx, c, hasTerraformBlock, hasProviderBlock, helper.TerraformVersion())
+
+	if err != nil {
+		logging.HelperResourceError(ctx,
+			"Error generating merged configuration",
+			map[string]interface{}{logging.KeyError: err},
+		)
+		t.Fatalf("Error generating merged configuration: %s", err)
+	}
 
 	confRequest := teststep.PrepareConfigurationRequest{
 		Directory: step.ConfigDirectory,
@@ -76,7 +84,7 @@ func testStepNewConfig(ctx context.Context, t testing.T, c TestCase, wd *plugint
 
 	testStepConfig := teststep.Configuration(confRequest)
 
-	err := wd.SetConfig(ctx, testStepConfig, step.ConfigVariables)
+	err = wd.SetConfig(ctx, testStepConfig, step.ConfigVariables)
 	if err != nil {
 		return fmt.Errorf("Error setting config: %w", err)
 	}
@@ -335,7 +343,7 @@ func testStepNewConfig(ctx context.Context, t testing.T, c TestCase, wd *plugint
 		// this fails. If refresh isn't read-only, then this will have
 		// caught a different bug.
 		if idRefreshCheck != nil {
-			if err := testIDRefresh(ctx, t, c, wd, step, idRefreshCheck, providers, stepIndex); err != nil {
+			if err := testIDRefresh(ctx, t, c, wd, step, idRefreshCheck, providers, stepIndex, helper); err != nil {
 				return fmt.Errorf(
 					"[ERROR] Test: ID-only test failed: %s", err)
 			}

diff --git a/helper/resource/testing_test.go b/helper/resource/testing_test.go
@@ -13,9 +13,8 @@ import (
 	"strings"
 	"testing"
 
-	testinginterface "github.com/mitchellh/go-testing-interface"
-
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	testinginterface "github.com/mitchellh/go-testing-interface"
 
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
 )
@@ -35,7 +34,7 @@ func TestParallelTest(t *testing.T) {
 		IsUnitTest: true,
 		ProviderFactories: map[string]func() (*schema.Provider, error){
 			"test": func() (*schema.Provider, error) { //nolint:unparam // required signature
-				return nil, nil
+				return &schema.Provider{}, nil
 			},
 		},
 		Steps: []TestStep{