Skip to content

Commit 7b650e0

Browse files
SarahFrenchSarahFrench
committed
Rename argument to backend and state store init methods to help distinguish between state managers
1 parent bce0926 commit 7b650e0

File tree

1 file changed

+31
-27
lines changed

1 file changed

+31
-27
lines changed

‎internal/command/meta_backend.go‎

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1100,7 +1100,7 @@ func (m *Meta) backendFromState(_ context.Context) (backend.Backend, tfdiags.Dia
11001100

11011101
// Unconfiguring a backend (moving from backend => local).
11021102
func (m *Meta) backend_c_r_S(
1103-
c *configs.Backend, cHash int, sMgr *clistate.LocalState, output bool, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
1103+
c *configs.Backend, cHash int, backendSMgr *clistate.LocalState, output bool, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
11041104

11051105
var diags tfdiags.Diagnostics
11061106

@@ -1111,7 +1111,8 @@ func (m *Meta) backend_c_r_S(
11111111
vt = arguments.ViewHuman
11121112
}
11131113

1114-
s := sMgr.State()
1114+
// Get backend state file data
1115+
s := backendSMgr.State()
11151116

11161117
cloudMode := cloud.DetectConfigChangeType(s.Backend, c, false)
11171118
diags = diags.Append(m.assertSupportedCloudInitOptions(cloudMode))
@@ -1136,7 +1137,7 @@ func (m *Meta) backend_c_r_S(
11361137
}
11371138

11381139
// Initialize the configured backend
1139-
b, moreDiags := m.savedBackend(sMgr)
1140+
b, moreDiags := m.savedBackend(backendSMgr)
11401141
diags = diags.Append(moreDiags)
11411142
if moreDiags.HasErrors() {
11421143
return nil, diags
@@ -1157,11 +1158,11 @@ func (m *Meta) backend_c_r_S(
11571158

11581159
// Remove the stored metadata
11591160
s.Backend = nil
1160-
if err := sMgr.WriteState(s); err != nil {
1161+
if err := backendSMgr.WriteState(s); err != nil {
11611162
diags = diags.Append(fmt.Errorf(strings.TrimSpace(errBackendClearSaved), err))
11621163
return nil, diags
11631164
}
1164-
if err := sMgr.PersistState(); err != nil {
1165+
if err := backendSMgr.PersistState(); err != nil {
11651166
diags = diags.Append(fmt.Errorf(strings.TrimSpace(errBackendClearSaved), err))
11661167
return nil, diags
11671168
}
@@ -1177,7 +1178,7 @@ func (m *Meta) backend_c_r_S(
11771178
}
11781179

11791180
// Configuring a backend for the first time.
1180-
func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.LocalState, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
1181+
func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, backendSMgr *clistate.LocalState, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
11811182
var diags tfdiags.Diagnostics
11821183

11831184
vt := arguments.ViewJSON
@@ -1282,15 +1283,15 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local
12821283
if m.stateLock {
12831284
view := views.NewStateLocker(vt, m.View)
12841285
stateLocker := clistate.NewLocker(m.stateLockTimeout, view)
1285-
if err := stateLocker.Lock(sMgr, "backend from plan"); err != nil {
1286+
if err := stateLocker.Lock(backendSMgr, "backend from plan"); err != nil {
12861287
diags = diags.Append(fmt.Errorf("Error locking state: %s", err))
12871288
return nil, diags
12881289
}
12891290
defer stateLocker.Unlock()
12901291
}
12911292

1292-
// Store the metadata in our saved state location
1293-
s := sMgr.State()
1293+
// Store the backend's metadata in our the backend state file location
1294+
s := backendSMgr.State()
12941295
if s == nil {
12951296
s = workdir.NewBackendStateFile()
12961297
}
@@ -1325,11 +1326,12 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local
13251326
}
13261327
}
13271328

1328-
if err := sMgr.WriteState(s); err != nil {
1329+
// Update backend state file
1330+
if err := backendSMgr.WriteState(s); err != nil {
13291331
diags = diags.Append(fmt.Errorf(errBackendWriteSaved, err))
13301332
return nil, diags
13311333
}
1332-
if err := sMgr.PersistState(); err != nil {
1334+
if err := backendSMgr.PersistState(); err != nil {
13331335
diags = diags.Append(fmt.Errorf(errBackendWriteSaved, err))
13341336
return nil, diags
13351337
}
@@ -1345,7 +1347,7 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local
13451347
}
13461348

13471349
// Changing a previously saved backend.
1348-
func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clistate.LocalState, output bool, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
1350+
func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, backendSMgr *clistate.LocalState, output bool, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
13491351
var diags tfdiags.Diagnostics
13501352

13511353
vt := arguments.ViewJSON
@@ -1355,8 +1357,8 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista
13551357
vt = arguments.ViewHuman
13561358
}
13571359

1358-
// Get the old state
1359-
s := sMgr.State()
1360+
// Get the old backend state file data
1361+
s := backendSMgr.State()
13601362

13611363
cloudMode := cloud.DetectConfigChangeType(s.Backend, c, false)
13621364
diags = diags.Append(m.assertSupportedCloudInitOptions(cloudMode))
@@ -1402,7 +1404,7 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista
14021404
// state lives.
14031405
if cloudMode != cloud.ConfigChangeInPlace {
14041406
// Grab the existing backend
1405-
oldB, oldBDiags := m.savedBackend(sMgr)
1407+
oldB, oldBDiags := m.savedBackend(backendSMgr)
14061408
diags = diags.Append(oldBDiags)
14071409
if oldBDiags.HasErrors() {
14081410
return nil, diags
@@ -1424,7 +1426,7 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista
14241426
if m.stateLock {
14251427
view := views.NewStateLocker(vt, m.View)
14261428
stateLocker := clistate.NewLocker(m.stateLockTimeout, view)
1427-
if err := stateLocker.Lock(sMgr, "backend from plan"); err != nil {
1429+
if err := stateLocker.Lock(backendSMgr, "backend from plan"); err != nil {
14281430
diags = diags.Append(fmt.Errorf("Error locking state: %s", err))
14291431
return nil, diags
14301432
}
@@ -1433,7 +1435,7 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista
14331435
}
14341436

14351437
// Update the backend state
1436-
s = sMgr.State()
1438+
s = backendSMgr.State()
14371439
if s == nil {
14381440
s = workdir.NewBackendStateFile()
14391441
}
@@ -1455,11 +1457,12 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista
14551457
}
14561458
}
14571459

1458-
if err := sMgr.WriteState(s); err != nil {
1460+
// Save data to backend state file
1461+
if err := backendSMgr.WriteState(s); err != nil {
14591462
diags = diags.Append(fmt.Errorf(errBackendWriteSaved, err))
14601463
return nil, diags
14611464
}
1462-
if err := sMgr.PersistState(); err != nil {
1465+
if err := backendSMgr.PersistState(); err != nil {
14631466
diags = diags.Append(fmt.Errorf(errBackendWriteSaved, err))
14641467
return nil, diags
14651468
}
@@ -1491,7 +1494,7 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista
14911494
//-------------------------------------------------------------------
14921495

14931496
// Configuring a state_store for the first time.
1494-
func (m *Meta) stateStore_C_s(c *configs.StateStore, cHash int, sMgr *clistate.LocalState, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
1497+
func (m *Meta) stateStore_C_s(c *configs.StateStore, cHash int, backendSMgr *clistate.LocalState, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) {
14951498
var diags tfdiags.Diagnostics
14961499

14971500
vt := arguments.ViewJSON
@@ -1577,15 +1580,15 @@ func (m *Meta) stateStore_C_s(c *configs.StateStore, cHash int, sMgr *clistate.L
15771580
if m.stateLock {
15781581
view := views.NewStateLocker(vt, m.View)
15791582
stateLocker := clistate.NewLocker(m.stateLockTimeout, view)
1580-
if err := stateLocker.Lock(sMgr, "state_store from plan"); err != nil {
1583+
if err := stateLocker.Lock(backendSMgr, "state_store from plan"); err != nil {
15811584
diags = diags.Append(fmt.Errorf("Error locking state: %s", err))
15821585
return nil, diags
15831586
}
15841587
defer stateLocker.Unlock()
15851588
}
15861589

15871590
// Store the state_store metadata in our saved state location
1588-
s := sMgr.State()
1591+
s := backendSMgr.State()
15891592
if s == nil {
15901593
s = workdir.NewBackendStateFile()
15911594
}
@@ -1684,7 +1687,7 @@ func (m *Meta) stateStore_C_s(c *configs.StateStore, cHash int, sMgr *clistate.L
16841687
diags = diags.Append(fmt.Errorf(errStateStoreWorkspaceCreate, c.Type, err))
16851688
return nil, diags
16861689
}
1687-
if err := sMgr.PersistState(); err != nil {
1690+
if err := backendSMgr.PersistState(); err != nil {
16881691
diags = diags.Append(fmt.Errorf(errStateStoreWorkspaceCreate, c.Type, err))
16891692
return nil, diags
16901693
}
@@ -1696,11 +1699,12 @@ func (m *Meta) stateStore_C_s(c *configs.StateStore, cHash int, sMgr *clistate.L
16961699
}
16971700
}
16981701

1699-
if err := sMgr.WriteState(s); err != nil {
1702+
// Update backend state file
1703+
if err := backendSMgr.WriteState(s); err != nil {
17001704
diags = diags.Append(fmt.Errorf(errBackendWriteSaved, err))
17011705
return nil, diags
17021706
}
1703-
if err := sMgr.PersistState(); err != nil {
1707+
if err := backendSMgr.PersistState(); err != nil {
17041708
diags = diags.Append(fmt.Errorf(errBackendWriteSaved, err))
17051709
return nil, diags
17061710
}
@@ -1713,10 +1717,10 @@ func (m *Meta) stateStore_C_s(c *configs.StateStore, cHash int, sMgr *clistate.L
17131717
// TODO: This is extremely similar to Meta.backendFromState() but for legacy reasons this is the
17141718
// function used by the migration APIs within this file. The other handles 'init -backend=false',
17151719
// specifically.
1716-
func (m *Meta) savedBackend(sMgr *clistate.LocalState) (backend.Backend, tfdiags.Diagnostics) {
1720+
func (m *Meta) savedBackend(backendSMgr *clistate.LocalState) (backend.Backend, tfdiags.Diagnostics) {
17171721
var diags tfdiags.Diagnostics
17181722

1719-
s := sMgr.State()
1723+
s := backendSMgr.State()
17201724

17211725
// Get the backend
17221726
f := backendInit.Backend(s.Backend.Type)

0 commit comments

Comments
 (0)