fix: move state_alias to run block + rename to state_key

hashicorp · Dec 11, 2024 · fd155ad · fd155ad
1 parent 3a17ab1
commit fd155ad
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 23 deletions.
diff --git a/internal/backend/local/test.go b/internal/backend/local/test.go
@@ -348,8 +348,8 @@ func (runner *TestFileRunner) Test(file *moduletest.File) {
 			}
 		}
 
-		if run.Config.Options.StateAlias != "" {
-			key = run.Config.Options.StateAlias
+		if run.Config.StateKey != "" {
+			key = run.Config.StateKey
 		}
 
 		if _, exists := runner.RelevantStates[key]; !exists {

diff --git a/internal/command/test_test.go b/internal/command/test_test.go
@@ -275,7 +275,7 @@ func TestTest_Runs(t *testing.T) {
 			expectedErr: []string{"Ephemeral resource instance has expired", "Ephemeral resources cannot be asserted"},
 			code:        1,
 		},
-		"with_state_alias": {
+		"with_state_key": {
 			expectedOut: []string{"3 passed, 1 failed."},
 			expectedErr: []string{"Test assertion failed", "resource renamed without moved block"},
 			code:        1,

diff --git a/...th_state_alias/breaking_change.tftest.hcl → ...with_state_key/breaking_change.tftest.hcl b/...th_state_alias/breaking_change.tftest.hcl → ...with_state_key/breaking_change.tftest.hcl
@@ -1,16 +1,12 @@
 run "old_version" {
-  plan_options {
-    state_alias = "test1"
-  }
+  state_key = "test1"
 }
 
 run "new_code" {
+  state_key = "test1"
   module {
     source = "./breaking_change"
   }
-  plan_options {
-    state_alias = "test1"
-  }
   assert {
     condition = test_resource.renamed_without_move.id == run.old_version.test_id
     error_message = "resource renamed without moved block"

diff --git a/.../with_state_alias/breaking_change/main.tf → ...st/with_state_key/breaking_change/main.tf b/.../with_state_alias/breaking_change/main.tf → ...st/with_state_key/breaking_change/main.tf
diff --git a/...nd/testdata/test/with_state_alias/main.tf → ...mand/testdata/test/with_state_key/main.tf b/...nd/testdata/test/with_state_alias/main.tf → ...mand/testdata/test/with_state_key/main.tf
diff --git a/...ta/test/with_state_alias/moved.tftest.hcl → ...data/test/with_state_key/moved.tftest.hcl b/...ta/test/with_state_alias/moved.tftest.hcl → ...data/test/with_state_key/moved.tftest.hcl
@@ -1,16 +1,12 @@
 run "old_version" {
+  state_key = "test1"
   module {
     source = "./old_version"
   }
-  plan_options {
-    state_alias = "test1"
-  }
 }
 
 run "new_code" {
-  plan_options {
-    state_alias = "test1"
-  }
+  state_key = "test1"
   assert {
     condition = test_resource.test_id_moved.id == run.old_version.test_id
     error_message = "ressource_id differed"

diff --git a/...test/with_state_alias/old_version/main.tf → ...a/test/with_state_key/old_version/main.tf b/...test/with_state_alias/old_version/main.tf → ...a/test/with_state_key/old_version/main.tf
diff --git a/internal/configs/test_file.go b/internal/configs/test_file.go
@@ -133,6 +133,8 @@ type TestRun struct {
 	// run.
 	ExpectFailures []hcl.Traversal
 
+	StateKey string
+
 	NameDeclRange      hcl.Range
 	VariablesDeclRange hcl.Range
 	DeclRange          hcl.Range
@@ -275,8 +277,6 @@ type TestRunOptions struct {
 	// Refresh is analogous to the -refresh=false Terraform plan option.
 	Refresh bool
 
-	StateAlias string
-
 	// Replace is analogous to the -replace=ADDRESS Terraform plan option.
 	Replace []hcl.Traversal
 
@@ -608,6 +608,11 @@ func decodeTestRunBlock(block *hcl.Block) (*TestRun, hcl.Diagnostics) {
 		r.ExpectFailures = failures
 	}
 
+	if attr, exists := content.Attributes["state_key"]; exists {
+		rawDiags := gohcl.DecodeExpression(attr.Expr, nil, &r.StateKey)
+		diags = append(diags, rawDiags...)
+	}
+
 	return &r, diags
 }
 
@@ -762,11 +767,6 @@ func decodeTestRunOptionsBlock(block *hcl.Block) (*TestRunOptions, hcl.Diagnosti
 		opts.Target = tars
 	}
 
-	if attr, exists := content.Attributes["state_alias"]; exists {
-		rawDiags := gohcl.DecodeExpression(attr.Expr, nil, &opts.StateAlias)
-		diags = append(diags, rawDiags...)
-	}
-
 	if !opts.Refresh && opts.Mode == RefreshOnlyTestMode {
 		// These options are incompatible.
 		diags = append(diags, &hcl.Diagnostic{
@@ -814,6 +814,7 @@ var testRunBlockSchema = &hcl.BodySchema{
 		{Name: "command"},
 		{Name: "providers"},
 		{Name: "expect_failures"},
+		{Name: "state_key"},
 	},
 	Blocks: []hcl.BlockHeaderSchema{
 		{
@@ -846,7 +847,6 @@ var testRunOptionsBlockSchema = &hcl.BodySchema{
 		{Name: "refresh"},
 		{Name: "replace"},
 		{Name: "target"},
-		{Name: "state_alias"},
 	},
 }