fix: Include provider config when writing a plan file using pluggable…

… state storage

internal/backend/local/backend_plan_test.go

@@ -940,20 +940,25 @@ func TestLocal_plan_withStateStore(t *testing.T) {
 	op.PlanMode = plans.NormalMode
 	op.PlanRefresh = true
 	op.PlanOutPath = planPath
-	cfg := cty.ObjectVal(map[string]cty.Value{
+	storeCfg := cty.ObjectVal(map[string]cty.Value{
 		"path": cty.StringVal(b.StatePath),
 	})
-	cfgRaw, err := plans.NewDynamicValue(cfg, cfg.Type())
+	storeCfgRaw, err := plans.NewDynamicValue(storeCfg, storeCfg.Type())
+	if err != nil {
+		t.Fatal(err)
+	}
+	providerCfg := cty.ObjectVal(map[string]cty.Value{}) // Empty as the mock provider has no schema for the provider
+	providerCfgRaw, err := plans.NewDynamicValue(providerCfg, providerCfg.Type())
 	if err != nil {
 		t.Fatal(err)
 	}
 	op.PlanOutStateStore = &plans.StateStore{
 		Type:   storeType,
-		Config: cfgRaw,
+		Config: storeCfgRaw,
 		Provider: &plans.Provider{
 			Source:  &mockAddr,
 			Version: providerVersion,
-			// No config as the mock provider has no schema for the provider
+			Config:  providerCfgRaw,
 		},
 		Workspace: defaultWorkspace,
 	}

internal/plans/planfile/tfplan.go

@@ -229,10 +229,7 @@ func readTfplan(r io.Reader) (*plans.Plan, error) {
 		}
 	case rawPlan.StateStore != nil:
 		rawStateStore := rawPlan.StateStore
-		config, err := valueFromTfplan(rawStateStore.Config)
-		if err != nil {
-			return nil, fmt.Errorf("plan file has invalid state_store configuration: %s", err)
-		}
+
 		provider := &plans.Provider{}
 		err = provider.SetSource(rawStateStore.Provider.Source)
 		if err != nil {
@@ -242,11 +239,21 @@ func readTfplan(r io.Reader) (*plans.Plan, error) {
 		if err != nil {
 			return nil, fmt.Errorf("plan file has invalid state_store provider version: %s", err)
 		}
+		providerConfig, err := valueFromTfplan(rawStateStore.Provider.Config)
+		if err != nil {
+			return nil, fmt.Errorf("plan file has invalid state_store configuration: %s", err)
+		}
+		provider.Config = providerConfig
+
+		storeConfig, err := valueFromTfplan(rawStateStore.Config)
+		if err != nil {
+			return nil, fmt.Errorf("plan file has invalid state_store configuration: %s", err)
+		}
 
 		plan.StateStore = &plans.StateStore{
 			Type:      rawStateStore.Type,
 			Provider:  provider,
-			Config:    config,
+			Config:    storeConfig,
 			Workspace: rawStateStore.Workspace,
 		}
 	}
@@ -759,6 +766,7 @@ func writeTfplan(plan *plans.Plan, w io.Writer) error {
 			Provider: &planproto.Provider{
 				Version: plan.StateStore.Provider.Version.String(),
 				Source:  plan.StateStore.Provider.Source.String(),
+				Config:  valueToTfplan(plan.StateStore.Provider.Config),
 			},
 			Config:    valueToTfplan(plan.StateStore.Config),
 			Workspace: plan.StateStore.Workspace,

internal/plans/planfile/tfplan_test.go

@@ -57,7 +57,13 @@ func TestTFPlanRoundTrip(t *testing.T) {
 							Namespace: "foobar",
 							Type:      "foo",
 						},
+						// Imagining a provider that has nothing in its schema
+						Config: mustNewDynamicValue(
+							cty.EmptyObjectVal,
+							cty.Object(nil),
+						),
 					},
+					// Imagining a state store with a field called `foo` in its schema
 					Config: mustNewDynamicValue(
 						cty.ObjectVal(map[string]cty.Value{
 							"foo": cty.StringVal("bar"),
@@ -136,6 +142,14 @@ func Test_writeTfplan_validation(t *testing.T) {
 							Namespace: "foobar",
 							Type:      "foo",
 						},
+						Config: mustNewDynamicValue(
+							cty.ObjectVal(map[string]cty.Value{
+								"foo": cty.StringVal("bar"),
+							}),
+							cty.Object(map[string]cty.Type{
+								"foo": cty.String,
+							}),
+						),
 					},
 					Config: mustNewDynamicValue(
 						cty.ObjectVal(map[string]cty.Value{

internal/plans/planproto/planfile.proto

@@ -169,6 +169,7 @@ message StateStore {
 message Provider {
     string source = 1;
     string version = 2;
+    DynamicValue config = 3;
 }
 
 // Action describes the type of action planned for an object.