Error on use of ImportStateVerify with plannable import

Author: bbasata

helper/resource/importstate/import_block_in_config_directory_test.go

@@ -35,11 +35,10 @@ func Test_ImportBlock_InConfigDirectory(t *testing.T) {
 				ConfigDirectory: config.StaticDirectory(`testdata/1`),
 			},
 			{
-				ResourceName:      "examplecloud_container.test",
-				ImportState:       true,
-				ImportStateKind:   r.ImportBlockWithID,
-				ImportStateVerify: true,
-				ConfigDirectory:   config.StaticDirectory(`testdata/2`),
+				ResourceName:    "examplecloud_container.test",
+				ImportState:     true,
+				ImportStateKind: r.ImportBlockWithID,
+				ConfigDirectory: config.StaticDirectory(`testdata/2`),
 			},
 		},
 	})

helper/resource/importstate/import_block_in_config_file_test.go

@@ -35,11 +35,10 @@ func Test_ImportBlock_InConfigFile(t *testing.T) {
 				ConfigFile: config.StaticFile(`testdata/1/examplecloud_container.tf`),
 			},
 			{
-				ResourceName:      "examplecloud_container.test",
-				ImportState:       true,
-				ImportStateKind:   r.ImportBlockWithID,
-				ImportStateVerify: true,
-				ConfigFile:        config.StaticFile(`testdata/2/examplecloud_container_import.tf`),
+				ResourceName:    "examplecloud_container.test",
+				ImportState:     true,
+				ImportStateKind: r.ImportBlockWithID,
+				ConfigFile:      config.StaticFile(`testdata/2/examplecloud_container_import.tf`),
 			},
 		},
 	})

helper/resource/importstate/import_block_with_id_test.go

@@ -44,10 +44,9 @@ func Test_TestStep_ImportBlockId(t *testing.T) {
 				}`,
 			},
 			{
-				ResourceName:      "examplecloud_container.test",
-				ImportState:       true,
-				ImportStateKind:   r.ImportBlockWithID,
-				ImportStateVerify: true,
+				ResourceName:    "examplecloud_container.test",
+				ImportState:     true,
+				ImportStateKind: r.ImportBlockWithID,
 			},
 		},
 	})
@@ -81,11 +80,10 @@ func TestTest_TestStep_ImportBlockId_ExpectError(t *testing.T) {
 					location = "eastus"
 					name     = "somevalue"
 				}`,
-				ResourceName:      "examplecloud_container.test",
-				ImportState:       true,
-				ImportStateKind:   r.ImportBlockWithID,
-				ImportStateVerify: true,
-				ExpectError:       regexp.MustCompile(`importing resource examplecloud_container.test: expected a no-op resource action, got "update" action with plan(.?)`),
+				ResourceName:    "examplecloud_container.test",
+				ImportState:     true,
+				ImportStateKind: r.ImportBlockWithID,
+				ExpectError:     regexp.MustCompile(`importing resource examplecloud_container.test: expected a no-op resource action, got "update" action with plan(.?)`),
 			},
 		},
 	})
@@ -290,11 +288,9 @@ func TestTest_TestStep_ImportBlockId_ImportStateVerifyIgnore_Real_Example(t *tes
 				resource "examplecloud_container" "test" {
 					name = "somename"
 				}`,
-				ResourceName:            "examplecloud_container.test",
-				ImportState:             true,
-				ImportStateKind:         r.ImportBlockWithID,
-				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"password"},
+				ResourceName:    "examplecloud_container.test",
+				ImportState:     true,
+				ImportStateKind: r.ImportBlockWithID,
 			},
 		},
 	})
@@ -375,11 +371,9 @@ func TestTest_TestStep_ImportBlockId_ImportStateVerifyIgnore(t *testing.T) {
 				Config: `resource "examplecloud_container" "test" {}`,
 			},
 			{
-				ResourceName:            "examplecloud_container.test",
-				ImportState:             true,
-				ImportStateKind:         r.ImportBlockWithID,
-				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"password"},
+				ResourceName:    "examplecloud_container.test",
+				ImportState:     true,
+				ImportStateKind: r.ImportBlockWithID,
 			},
 		},
 	})

helper/resource/testing_new_import_state.go

@@ -9,8 +9,6 @@ import (
 	"reflect"
 	"strings"
 
-	"github.com/hashicorp/go-version"
-
 	tfjson "github.com/hashicorp/terraform-json"
 
 	"github.com/google/go-cmp/cmp"
@@ -32,17 +30,8 @@ func testStepNewImportState(ctx context.Context, t testing.T, helper *plugintest
 	kind := step.ImportStateKind
 	importStatePersist := step.ImportStatePersist
 
-	if kind.plannable() {
-		// Instead of calling [t.Fatal], return an error. This package's unit tests can use [TestStep.ExpectError] to match on the error message.
-		// An alternative, [plugintest.TestExpectTFatal], does not have access to logged error messages, so it is open to false positives on this
-		// complex code path.
-		if err := requirePlannableImport(t, *helper.TerraformVersion()); err != nil {
-			return err
-		}
-
-		if importStatePersist {
-			return fmt.Errorf("ImportStatePersist is not supported with plannable import blocks")
-		}
+	if err := importStatePreconditions(ctx, t, helper, step, cfgRaw); err != nil {
+		return err
 	}
 
 	configRequest := teststep.PrepareConfigurationRequest{
@@ -408,15 +397,28 @@ func appendImportBlock(config string, resourceName string, importID string) stri
 		resourceName, importID)
 }
 
-func requirePlannableImport(t testing.T, versionUnderTest version.Version) error {
+func importStatePreconditions(ctx context.Context, t testing.T, helper *plugintest.Helper, step TestStep, cfgRaw string) error {
 	t.Helper()
 
-	if versionUnderTest.LessThan(tfversion.Version1_5_0) {
+	kind := step.ImportStateKind
+	versionUnderTest := *helper.TerraformVersion()
+
+	// Instead of calling [t.Fatal], we return an error. This package's unit tests can use [TestStep.ExpectError] to match
+	// on the error message. An alternative, [plugintest.TestExpectTFatal], does not have access to logged error messages,
+	// so it is open to false positives on this complex code path.
+	switch {
+	case kind.plannable() && versionUnderTest.LessThan(tfversion.Version1_5_0):
 		return fmt.Errorf(
 			`ImportState steps using plannable import blocks require Terraform 1.5.0 or later. Either ` +
 				`upgrade the Terraform version running the test or add a ` + "`TerraformVersionChecks`" + ` to ` +
 				`the test case to skip this test.` + "\n\n" +
 				`https://developer.hashicorp.com/terraform/plugin/testing/acceptance-tests/tfversion-checks#skip-version-checks`)
+
+	case kind.plannable() && step.ImportStatePersist:
+		return fmt.Errorf(`ImportStatePersist is not supported with plannable import blocks`)
+
+	case kind.plannable() && step.ImportStateVerify:
+		return fmt.Errorf(`ImportStateVerify is not supported with plannable import blocks`)
 	}
 
 	return nil