mirror of
https://github.com/opentofu/opentofu.git
synced 2025-01-02 12:17:39 -06:00
f40800b3a4
This is part of a general effort to move all of Terraform's non-library package surface under internal in order to reinforce that these are for internal use within Terraform only. If you were previously importing packages under this prefix into an external codebase, you could pin to an earlier release tag as an interim solution until you've make a plan to achieve the same functionality some other way.
54 lines
1.7 KiB
Go
54 lines
1.7 KiB
Go
package statemgr
|
|
|
|
// The functions in this file are helper wrappers for common sequences of
|
|
// operations done against full state managers.
|
|
|
|
import (
|
|
"github.com/hashicorp/terraform/internal/states"
|
|
"github.com/hashicorp/terraform/internal/states/statefile"
|
|
"github.com/hashicorp/terraform/version"
|
|
)
|
|
|
|
// NewStateFile creates a new statefile.File object, with a newly-minted
|
|
// lineage identifier and serial 0, and returns a pointer to it.
|
|
func NewStateFile() *statefile.File {
|
|
return &statefile.File{
|
|
Lineage: NewLineage(),
|
|
TerraformVersion: version.SemVer,
|
|
State: states.NewState(),
|
|
}
|
|
}
|
|
|
|
// RefreshAndRead refreshes the persistent snapshot in the given state manager
|
|
// and then returns it.
|
|
//
|
|
// This is a wrapper around calling RefreshState and then State on the given
|
|
// manager.
|
|
func RefreshAndRead(mgr Storage) (*states.State, error) {
|
|
err := mgr.RefreshState()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return mgr.State(), nil
|
|
}
|
|
|
|
// WriteAndPersist writes a snapshot of the given state to the given state
|
|
// manager's transient store and then immediately persists it.
|
|
//
|
|
// The caller must ensure that the given state is not concurrently modified
|
|
// while this function is running, but it is safe to modify it after this
|
|
// function has returned.
|
|
//
|
|
// If an error is returned, it is undefined whether the state has been saved
|
|
// to the transient store or not, and so the only safe response is to bail
|
|
// out quickly with a user-facing error. In situations where more control
|
|
// is required, call WriteState and PersistState on the state manager directly
|
|
// and handle their errors.
|
|
func WriteAndPersist(mgr Storage, state *states.State) error {
|
|
err := mgr.WriteState(state)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return mgr.PersistState()
|
|
}
|