command/meta: Ensure PreviousLocks are passed through

Author: radeksimko

internal/command/init.go

@@ -158,7 +158,7 @@ func (c *InitCommand) initCloud(ctx context.Context, root *configs.Module, extra
 	return back, true, diags
 }
 
-func (c *InitCommand) initBackend(ctx context.Context, root *configs.Module, initArgs *arguments.Init, configLocks *depsfile.Locks, view views.Init) (be backend.Backend, output bool, diags tfdiags.Diagnostics) {
+func (c *InitCommand) initBackend(ctx context.Context, root *configs.Module, initArgs *arguments.Init, previousLocks *depsfile.Locks, configLocks *depsfile.Locks, view views.Init) (be backend.Backend, output bool, diags tfdiags.Diagnostics) {
 	ctx, span := tracer.Start(ctx, "initialize backend")
 	_ = ctx // prevent staticcheck from complaining to avoid a maintenance hazard of having the wrong ctx in scope here
 	defer span.End()
@@ -234,6 +234,7 @@ func (c *InitCommand) initBackend(ctx context.Context, root *configs.Module, ini
 		opts = &BackendOpts{
 			StateStoreConfig: root.StateStore,
 			Locks:            configLocks,
+			PreviousLocks:    previousLocks,
 			ConfigOverride:   configOverride,
 			Init:             true,
 			ViewType:         initArgs.ViewType,

internal/command/init_run.go

@@ -234,10 +234,10 @@ func (c *InitCommand) run(initArgs *arguments.Init, view views.Init) int {
 	case initArgs.Cloud && rootModEarly.CloudConfig != nil:
 		back, backendOutput, backDiags = c.initCloud(ctx, rootModEarly, initArgs.BackendConfig, initArgs.ViewType, view)
 	case initArgs.Backend:
-		back, backendOutput, backDiags = c.initBackend(ctx, rootModEarly, initArgs, configLocks, view)
+		back, backendOutput, backDiags = c.initBackend(ctx, rootModEarly, initArgs, previousLocks, configLocks, view)
 	default:
 		// load the previously-stored backend config
-		back, backDiags = c.Meta.backendFromState(ctx)
+		back, backDiags = c.Meta.backendFromState(ctx, previousLocks)
 	}
 	if backendOutput {
 		header = true

internal/command/meta_backend.go

@@ -65,6 +65,10 @@ type BackendOpts struct {
 	// version in use currently.
 	Locks *depsfile.Locks
 
+	// PreviousLocks allows state-migration logic to use the older version of the provider
+	// during upgrade-triggered migrations.
+	PreviousLocks *depsfile.Locks
+
 	// ConfigOverride is an hcl.Body that, if non-nil, will be used with
 	// configs.MergeBodies to override the type-specific backend configuration
 	// arguments in Config.
@@ -1044,7 +1048,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di
 		v := views.NewInit(opts.ViewType, m.View)
 		v.Output(views.InitMessageCode("state_store_unset"), s.StateStore.Type)
 
-		return m.stateStore_to_backend(sMgr, "local", localB, nil, opts.ViewType)
+		return m.stateStore_to_backend(sMgr, "local", localB, nil, opts)
 
 	// Configuring a backend for the first time or -reconfigure flag was used
 	case backendConfig != nil && s.Backend.Empty() &&
@@ -1118,7 +1122,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di
 		newBackendCfgState.SetConfig(configVal, b.ConfigSchema())
 		newBackendCfgState.Hash = uint64(cHash)
 
-		return m.stateStore_to_backend(sMgr, backendConfig.Type, b, newBackendCfgState, opts.ViewType)
+		return m.stateStore_to_backend(sMgr, backendConfig.Type, b, newBackendCfgState, opts)
 
 	// Migration from backend to state store
 	case backendConfig == nil && !s.Backend.Empty() &&
@@ -1220,7 +1224,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di
 		// AND we're not providing any overrides. An override can mean a change overriding an unchanged backend block (indicated by the hash value).
 		if (uint64(cHash) == s.StateStore.Hash) && (!opts.Init || opts.ConfigOverride == nil) {
 			log.Printf("[TRACE] Meta.Backend: using already-initialized, unchanged %q state_store configuration", stateStoreConfig.Type)
-			savedStateStore, sssDiags := m.savedStateStore(sMgr)
+			savedStateStore, sssDiags := m.savedStateStore(sMgr, opts.Locks)
 			diags = diags.Append(sssDiags)
 			// Verify that selected workspace exist. Otherwise prompt user to create one
 			if opts.Init && savedStateStore != nil {
@@ -1238,7 +1242,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di
 		// don't need to migrate, we update the state store cache hash value.
 		if !m.stateStoreConfigNeedsMigration(stateStoreConfig, s.StateStore, opts) {
 			log.Printf("[TRACE] Meta.Backend: using already-initialized %q state store configuration", stateStoreConfig.Type)
-			savedStateStore, moreDiags := m.savedStateStore(sMgr)
+			savedStateStore, moreDiags := m.savedStateStore(sMgr, opts.Locks)
 			diags = diags.Append(moreDiags)
 			if moreDiags.HasErrors() {
 				return nil, diags
@@ -1467,7 +1471,7 @@ func (m *Meta) determineStateStoreInitReason(cfgState *workdir.StateStoreConfigS
 // from the backend state. This should be used only when a user runs
 // `terraform init -backend=false`. This function returns a local backend if
 // there is no backend state or no backend configured.
-func (m *Meta) backendFromState(_ context.Context) (backend.Backend, tfdiags.Diagnostics) {
+func (m *Meta) backendFromState(_ context.Context, locks *depsfile.Locks) (backend.Backend, tfdiags.Diagnostics) {
 	var diags tfdiags.Diagnostics
 	// Get the path to where we store a local cache of backend configuration
 	// if we're using a remote backend. This may not yet exist which means
@@ -1493,7 +1497,7 @@ func (m *Meta) backendFromState(_ context.Context) (backend.Backend, tfdiags.Dia
 		// state_store
 		log.Printf("[TRACE] Meta.Backend: working directory was previously initialized for %q state store", s.StateStore.Type)
 		var ssDiags tfdiags.Diagnostics
-		b, ssDiags = m.savedStateStore(sMgr) // Relies on the state manager's internal state being refreshed above.
+		b, ssDiags = m.savedStateStore(sMgr, locks) // Relies on the state manager's internal state being refreshed above.
 		diags = diags.Append(ssDiags)
 		if ssDiags.HasErrors() {
 			return nil, diags
@@ -2531,17 +2535,17 @@ func (m *Meta) stateStore_C_s(c *configs.StateStore, stateStoreHash int, backend
 }
 
 // Migrating a state store to backend (including local).
-func (m *Meta) stateStore_to_backend(ssSMgr *clistate.LocalState, dstBackendType string, dstBackend backend.Backend, newBackendState *workdir.BackendConfigState, viewType arguments.ViewType) (backend.Backend, tfdiags.Diagnostics) {
+func (m *Meta) stateStore_to_backend(ssSMgr *clistate.LocalState, dstBackendType string, dstBackend backend.Backend, newBackendState *workdir.BackendConfigState, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
 	var diags tfdiags.Diagnostics
 
 	s := ssSMgr.State()
 	stateStoreType := s.StateStore.Type
 
-	view := views.NewInit(viewType, m.View)
+	view := views.NewInit(opts.ViewType, m.View)
 	view.Output(views.StateMigrateLocalMessage, stateStoreType)
 
 	// Initialize the configured state store
-	ss, moreDiags := m.savedStateStore(ssSMgr)
+	ss, moreDiags := m.savedStateStore(ssSMgr, opts.Locks)
 	diags = diags.Append(moreDiags)
 	if moreDiags.HasErrors() {
 		return nil, diags
@@ -2553,7 +2557,7 @@ func (m *Meta) stateStore_to_backend(ssSMgr *clistate.LocalState, dstBackendType
 		DestinationType: dstBackendType,
 		Source:          ss,
 		Destination:     dstBackend,
-		ViewType:        viewType,
+		ViewType:        opts.ViewType,
 	})
 	if err != nil {
 		diags = diags.Append(err)
@@ -2668,7 +2672,7 @@ func (m *Meta) stateStore_changed(cfg *configs.StateStore, cfgHash int, sMgr *cl
 	}
 
 	// Grab the source state store
-	srcB, srcBDiags := m.savedStateStore(sMgr)
+	srcB, srcBDiags := m.savedStateStore(sMgr, opts.PreviousLocks)
 	diags = diags.Append(srcBDiags)
 	if srcBDiags.HasErrors() {
 		return nil, diags
@@ -2822,7 +2826,7 @@ To make the initial dependency selections that will initialize the dependency lo
 }
 
 // Initializing a saved state store from the backend state file (aka 'cache file', aka 'legacy state file')
-func (m *Meta) savedStateStore(sMgr *clistate.LocalState) (backend.Backend, tfdiags.Diagnostics) {
+func (m *Meta) savedStateStore(sMgr *clistate.LocalState, locks *depsfile.Locks) (backend.Backend, tfdiags.Diagnostics) {
 	// We're preparing a state_store version of backend.Backend.
 	//
 	// The provider and state store will be configured using the backend state file.
@@ -2831,7 +2835,7 @@ func (m *Meta) savedStateStore(sMgr *clistate.LocalState) (backend.Backend, tfdi
 
 	s := sMgr.State()
 
-	factory, pDiags := m.StateStoreProviderFactoryFromConfigState(s.StateStore)
+	factory, pDiags := m.StateStoreProviderFactoryFromConfigState(s.StateStore, locks)
 	diags = diags.Append(pDiags)
 	if pDiags.HasErrors() {
 		return nil, diags
@@ -3346,7 +3350,7 @@ func (m *Meta) StateStoreProviderFactoryFromConfig(config *configs.StateStore, l
 	return factory, diags
 }
 
-func (m *Meta) StateStoreProviderFactoryFromConfigState(cfgState *workdir.StateStoreConfigState) (providers.Factory, tfdiags.Diagnostics) {
+func (m *Meta) StateStoreProviderFactoryFromConfigState(cfgState *workdir.StateStoreConfigState, locks *depsfile.Locks) (providers.Factory, tfdiags.Diagnostics) {
 	var diags tfdiags.Diagnostics
 
 	if cfgState == nil {
@@ -3362,7 +3366,7 @@ func (m *Meta) StateStoreProviderFactoryFromConfigState(cfgState *workdir.StateS
 		})
 	}
 
-	factories, err := m.ProviderFactories()
+	factories, err := m.providerFactoriesFromLocks(locks)
 	if err != nil {
 		// This may happen if the provider isn't present in the provider cache.
 		// This should be caught earlier by logic that diffs the config against the backend state file.

internal/command/meta_backend_test.go

@@ -2159,7 +2159,12 @@ func TestBackendFromState(t *testing.T) {
 	// them to match just for this test.
 	wd.OverrideDataDir(".")
 
-	stateBackend, diags := m.backendFromState(context.Background())
+	locks, diags := m.lockedDependencies()
+	if diags.HasErrors() {
+		t.Fatal(diags.Err())
+	}
+
+	stateBackend, diags := m.backendFromState(context.Background(), locks)
 	if diags.HasErrors() {
 		t.Fatal(diags.Err())
 	}
@@ -2419,8 +2424,13 @@ func TestSavedStateStore(t *testing.T) {
 			t.Fatalf("unexpected error: %s", err)
 		}
 
+		locks, diags := m.lockedDependencies()
+		if diags.HasErrors() {
+			t.Fatal(diags.Err())
+		}
+
 		// Code under test
-		b, diags := m.savedStateStore(sMgr)
+		b, diags := m.savedStateStore(sMgr, locks)
 		if diags.HasErrors() {
 			t.Fatalf("unexpected errors: %s", diags.Err())
 		}
@@ -2459,7 +2469,12 @@ func TestSavedStateStore(t *testing.T) {
 			t.Fatalf("unexpected error: %s", err)
 		}
 
-		_, diags := m.savedStateStore(sMgr)
+		locks, dDiags := m.lockedDependencies()
+		if dDiags.HasErrors() {
+			t.Fatal(dDiags.Err())
+		}
+
+		_, diags := m.savedStateStore(sMgr, locks)
 		if !diags.HasErrors() {
 			t.Fatal("expected errors but got none")
 		}
@@ -2496,7 +2511,12 @@ func TestSavedStateStore(t *testing.T) {
 			t.Fatalf("unexpected error: %s", err)
 		}
 
-		_, diags := m.savedStateStore(sMgr)
+		locks, dDiags := m.lockedDependencies()
+		if dDiags.HasErrors() {
+			t.Fatal(dDiags.Err())
+		}
+
+		_, diags := m.savedStateStore(sMgr, locks)
 		if !diags.HasErrors() {
 			t.Fatal("expected errors but got none")
 		}

internal/provider-simple-v6/state_store_fs.go

@@ -178,6 +178,7 @@ func (f *FsStore) ReadStateBytes(req providers.ReadStateBytesRequest) providers.
 
 	// E.g. terraform.tfstate.d/foobar/terraform.tfstate
 	path := f.getStatePath(req.StateId)
+	log.Printf("[DEBUG] ReadStateBytes: reading data from path %q", path)
 	file, err := os.Open(path)
 
 	fileExists := true
@@ -231,6 +232,8 @@ func (f *FsStore) WriteStateBytes(req providers.WriteStateBytesRequest) provider
 	// E.g. terraform.tfstate.d/foobar/terraform.tfstate
 	path := f.getStatePath(req.StateId)
 
+	log.Printf("[DEBUG] WriteStateBytes: writing data to path %q", path)
+
 	// Create or open state file
 	dir := f.getStateDir(req.StateId)
 	err := os.MkdirAll(dir, 0755)