mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-27 01:11:10 -06:00
5c1c6e9d9c
Whereas the parent directory "states" contains the models that represent state in memory, this package's responsibility is in serializing a subset of that data to a JSON-based file format and then reloading that data back into memory later. For reading, this package supports state file formats going back to version 1, using lightly-adapted versions of the migration code previously used in the "terraform" package. State data is upgraded to the latest version step by step and then transformed into the in-memory state representation, which is distinct from any of the file format structs in this package to enable these to evolve separately. For writing, only the latest version (4) is supported, which is a new format that is a slightly-flattened version of the new in-memory state models introduced in the prior commit. This format retains the outputs from only the root module and it flattens out the module and instance parts of the hierarchy by including the identifiers for these inside the child object. The loader then reconstructs the multi-layer structure we use for more convenient access in memory. For now, the only testing in this package is of round-tripping different versions of state through a read and a write, ensuring the output is as desired. This exercises all of the reading, upgrading, and writing functions but should be augmented in later commits to improve coverage and introduce more focused tests for specific parts of the functionality.
24 lines
697 B
Go
24 lines
697 B
Go
package statefile
|
|
|
|
// looksLikeVersion0 sniffs for the signature indicating a version 0 state
|
|
// file.
|
|
//
|
|
// Version 0 was the number retroactively assigned to Terraform's initial
|
|
// (unversioned) binary state file format, which was later superseded by the
|
|
// version 1 format in JSON.
|
|
//
|
|
// Version 0 is no longer supported, so this is used only to detect it and
|
|
// return a nice error to the user.
|
|
func looksLikeVersion0(src []byte) bool {
|
|
// Version 0 files begin with the magic prefix "tfstate".
|
|
const magic = "tfstate"
|
|
if len(src) < len(magic) {
|
|
// Not even long enough to have the magic prefix
|
|
return false
|
|
}
|
|
if string(src[0:len(magic)]) == magic {
|
|
return true
|
|
}
|
|
return false
|
|
}
|