test: Add a new test that shows PSS cannot be used if the pluggable_state_stores experiment isn't declared in the config.

Author: SarahFrench

internal/command/experimental_test.go

@@ -12,8 +12,43 @@ import (
 
 func TestInit_stateStoreBlockIsExperimental(t *testing.T) {
 
-	t.Run("init command", func(t *testing.T) {
-		// Create a temporary working directory with state_store in use
+	// When experiments are enabled, users are prompted to add experiments = [pluggable_state_stores] to their config.
+	t.Run("init command without `pluggable_state_stores` experiment in config", func(t *testing.T) {
+		// Create a temporary working directory with state_store in use but experiment not declared
+		td := t.TempDir()
+		testCopyDir(t, testFixturePath("init-with-state-store-no-experiment"), td)
+		t.Chdir(td)
+
+		ui := new(cli.MockUi)
+		view, done := testView(t)
+		c := &InitCommand{
+			Meta: Meta{
+				Ui:                        ui,
+				View:                      view,
+				AllowExperimentalFeatures: true,
+			},
+		}
+
+		args := []string{}
+		code := c.Run(args)
+		testOutput := done(t)
+		if code != 1 {
+			t.Fatalf("unexpected output: \n%s", testOutput.All())
+		}
+
+		// Check output
+		output := cleanString(testOutput.Stderr())
+		if !strings.Contains(output, `Error: Pluggable state store experiment not supported`) {
+			t.Fatalf("doesn't look like experiment is blocking access': %s", output)
+		}
+		if !strings.Contains(output, "opt into the \"pluggable_state_stores\" experiment using the `terraform` block's `experiments` attribute") {
+			t.Fatalf("expected the error to explain the need for a config change': %s", output)
+		}
+	})
+
+	// When experiments aren't enabled, the state_store block is reported as being unexpected
+	t.Run("init command without experiments enabled", func(t *testing.T) {
+		// Create a temporary working directory with state_store in use but experiment not declared
 		td := t.TempDir()
 		testCopyDir(t, testFixturePath("init-with-state-store"), td)
 		t.Chdir(td)
@@ -42,7 +77,7 @@ func TestInit_stateStoreBlockIsExperimental(t *testing.T) {
 		}
 	})
 
-	t.Run("non-init command: plan", func(t *testing.T) {
+	t.Run("non-init command: `plan` without experiments enabled", func(t *testing.T) {
 		// Create a temporary working directory with state_store in use
 		td := t.TempDir()
 		testCopyDir(t, testFixturePath("init-with-state-store"), td)
@@ -72,7 +107,7 @@ func TestInit_stateStoreBlockIsExperimental(t *testing.T) {
 		}
 	})
 
-	t.Run("non-init command: state list", func(t *testing.T) {
+	t.Run("non-init command: `state list` without experiments enabled", func(t *testing.T) {
 		// Create a temporary working directory with state_store in use
 		td := t.TempDir()
 		testCopyDir(t, testFixturePath("init-with-state-store"), td)

internal/command/testdata/init-with-state-store-no-experiment/main.tf

@@ -0,0 +1,14 @@
+terraform {
+  # There should be `experiments = [pluggable_state_stores]` present here, but it is intentionally missing.
+  required_providers {
+    test = {
+      source = "hashicorp/test"
+    }
+  }
+  state_store "test_store" {
+    provider "test" {
+    }
+
+    value = "foobar"
+  }
+}