update testing of new import states to support generating import blocks with an id string and calling apply

Author: stephybun

helper/resource/testing.go

@@ -454,6 +454,14 @@ type ExternalProvider struct {
 	Source            string // the provider source
 }
 
+type ImportStateKind byte
+
+const (
+	ImportCommandWithId ImportStateKind = iota
+	ImportBlockWithId
+	ImportBlockWithResourceIdentity
+)
+
 // TestStep is a single apply sequence of a test, done within the
 // context of a state.
 //
@@ -633,6 +641,8 @@ type TestStep struct {
 	// ID of that resource.
 	ImportState bool
 
+	ImportStateKind ImportStateKind
+
 	// ImportStateId is the ID to perform an ImportState operation with.
 	// This is optional. If it isn't set, then the resource ID is automatically
 	// determined by inspecting the state for ResourceName's ID.

helper/resource/testing_new.go

@@ -133,7 +133,7 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 
 	// use this to track last step successfully applied
 	// acts as default for import tests
-	var appliedCfg teststep.Config
+	var appliedCfg string
 	var stepNumber int
 
 	for stepIndex, step := range c.Steps {
@@ -426,7 +426,7 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 				}
 			}
 
-			mergedConfig, err := step.mergedConfig(ctx, c, hasTerraformBlock, hasProviderBlock, helper.TerraformVersion())
+			appliedCfg, err = step.mergedConfig(ctx, c, hasTerraformBlock, hasProviderBlock, helper.TerraformVersion())
 
 			if err != nil {
 				logging.HelperResourceError(ctx,
@@ -436,18 +436,6 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 				t.Fatalf("Error generating merged configuration: %s", err)
 			}
 
-			confRequest := teststep.PrepareConfigurationRequest{
-				Directory: step.ConfigDirectory,
-				File:      step.ConfigFile,
-				Raw:       mergedConfig,
-				TestStepConfigRequest: config.TestStepConfigRequest{
-					StepNumber: stepIndex + 1,
-					TestName:   t.Name(),
-				},
-			}.Exec()
-
-			appliedCfg = teststep.Configuration(confRequest)
-
 			logging.HelperResourceDebug(ctx, "Finished TestStep")
 
 			continue

helper/resource/testing_new_import_state.go

@@ -6,6 +6,7 @@ package resource
 import (
 	"context"
 	"fmt"
+	"github.com/hashicorp/terraform-exec/tfexec"
 	"reflect"
 	"strings"
 
@@ -20,7 +21,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/internal/plugintest"
 )
 
-func testStepNewImportState(ctx context.Context, t testing.T, helper *plugintest.Helper, wd *plugintest.WorkingDir, step TestStep, cfg teststep.Config, providers *providerFactories, stepIndex int) error {
+func testStepNewImportState(ctx context.Context, t testing.T, helper *plugintest.Helper, wd *plugintest.WorkingDir, step TestStep, cfgRaw string, providers *providerFactories, stepIndex int) error {
 	t.Helper()
 
 	configRequest := teststep.PrepareConfigurationRequest{
@@ -93,11 +94,40 @@ func testStepNewImportState(ctx context.Context, t testing.T, helper *plugintest
 
 	logging.HelperResourceTrace(ctx, fmt.Sprintf("Using import identifier: %s", importId))
 
+	if testStepConfig == nil {
+		logging.HelperResourceTrace(ctx, "Using prior TestStep Config for import")
+	}
+
 	// Create working directory for import tests
 	if testStepConfig == nil {
 		logging.HelperResourceTrace(ctx, "Using prior TestStep Config for import")
 
-		testStepConfig = cfg
+		switch step.ImportStateKind {
+		case ImportBlockWithResourceIdentity:
+			t.Fatalf("TODO implement me")
+		case ImportBlockWithId:
+			cfgRaw += fmt.Sprintf(`
+			import {
+				to = %s
+				id = %q
+			}
+		`, step.ResourceName, importId)
+		default:
+			// Not an import block test so nothing to do here
+		}
+
+		confRequest := teststep.PrepareConfigurationRequest{
+			Directory: step.ConfigDirectory,
+			File:      step.ConfigFile,
+			Raw:       cfgRaw,
+			TestStepConfigRequest: config.TestStepConfigRequest{
+				StepNumber: stepIndex + 1,
+				TestName:   t.Name(),
+			},
+		}.Exec()
+
+		testStepConfig = teststep.Configuration(confRequest)
+		//testStepConfig = cfg
 		if testStepConfig == nil {
 			t.Fatal("Cannot import state with no specified config")
 		}
@@ -129,11 +159,22 @@ func testStepNewImportState(ctx context.Context, t testing.T, helper *plugintest
 		}
 	}
 
-	err = runProviderCommand(ctx, t, func() error {
-		return importWd.Import(ctx, step.ResourceName, importId)
-	}, importWd, providers)
-	if err != nil {
-		return err
+	if step.ImportStateKind == ImportBlockWithResourceIdentity || step.ImportStateKind == ImportBlockWithId {
+		var opts []tfexec.ApplyOption
+
+		err = runProviderCommand(ctx, t, func() error {
+			return importWd.Apply(ctx, opts...)
+		}, importWd, providers)
+		if err != nil {
+			return err
+		}
+	} else {
+		err = runProviderCommand(ctx, t, func() error {
+			return importWd.Import(ctx, step.ResourceName, importId)
+		}, importWd, providers)
+		if err != nil {
+			return err
+		}
 	}
 
 	var importState *terraform.State