test: Add command-level test for state pull showing integration with pluggable state storage code.

Author: SarahFrench

internal/command/state_pull_test.go

@@ -10,6 +10,11 @@ import (
 	"testing"
 
 	"github.com/hashicorp/cli"
+	"github.com/hashicorp/terraform/internal/addrs"
+	"github.com/hashicorp/terraform/internal/providers"
+	"github.com/hashicorp/terraform/internal/states"
+	"github.com/hashicorp/terraform/internal/states/statefile"
+	"github.com/hashicorp/terraform/internal/terminal"
 )
 
 func TestStatePull(t *testing.T) {
@@ -43,6 +48,84 @@ func TestStatePull(t *testing.T) {
 	}
 }
 
+// Tests using `terraform state pull` subcommand in combination with pluggable state storage
+//
+// Note: Whereas other tests in this file use the local backend and require a state file in the test fixures,
+// with pluggable state storage we can define the state via the mocked provider.
+func TestStatePull_stateStore(t *testing.T) {
+	// Create a temporary working directory that is empty
+	td := t.TempDir()
+	testCopyDir(t, testFixturePath("state-list-state-store"), td)
+	t.Chdir(td)
+
+	// Get bytes describing a state containing a resource
+	state := states.NewState()
+	rootModule := state.RootModule()
+	rootModule.SetResourceInstanceCurrent(
+		addrs.Resource{
+			Mode: addrs.ManagedResourceMode,
+			Type: "test_instance",
+			Name: "foo",
+		}.Instance(addrs.NoKey),
+		&states.ResourceInstanceObjectSrc{
+			Status: states.ObjectReady,
+			AttrsJSON: []byte(`{
+				"input": "foobar"
+			}`),
+		},
+		addrs.AbsProviderConfig{
+			Provider: addrs.NewDefaultProvider("test"),
+			Module:   addrs.RootModule,
+		},
+	)
+	var stateBuf bytes.Buffer
+	if err := statefile.Write(statefile.New(state, "", 1), &stateBuf); err != nil {
+		t.Fatalf("error during test setup: %s", err)
+	}
+	stateBytes := stateBuf.Bytes()
+
+	// Create a mock that contains a persisted "default" state that uses the bytes from above.
+	mockProvider := mockPluggableStateStorageProvider(t)
+	mockProvider.MockStates = map[string]interface{}{
+		"default": stateBytes,
+	}
+	mockProviderAddress := addrs.NewDefaultProvider("test")
+	providerSource, close := newMockProviderSource(t, map[string][]string{
+		"hashicorp/test": {"1.0.0"},
+	})
+	defer close()
+
+	ui := cli.NewMockUi()
+	streams, _ := terminal.StreamsForTesting(t)
+	c := &StatePullCommand{
+		Meta: Meta{
+			AllowExperimentalFeatures: true,
+			testingOverrides: &testingOverrides{
+				Providers: map[addrs.Provider]providers.Factory{
+					mockProviderAddress: providers.FactoryFixed(mockProvider),
+				},
+			},
+			ProviderSource: providerSource,
+			Ui:             ui,
+			Streams:        streams,
+		},
+	}
+
+	// `terraform show` command specifying a given resource addr
+	expectedResourceAddr := "test_instance.foo"
+	args := []string{expectedResourceAddr}
+	code := c.Run(args)
+	if code != 0 {
+		t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String())
+	}
+
+	// Test that the state in the output matches the original state
+	actual := ui.OutputWriter.Bytes()
+	if bytes.Equal(actual, stateBytes) {
+		t.Fatalf("expected:\n%s\n\nto include: %q", actual, stateBytes)
+	}
+}
+
 func TestStatePull_noState(t *testing.T) {
 	tmp := t.TempDir()
 	t.Chdir(tmp)