opentofu/internal/states/statefile/marshal_equal.go
Christian Mesh 2f5dcd5c0a
Integrate Encryption into State Backends (#1288)
Signed-off-by: Christian Mesh <christianmesh1@gmail.com>
2024-03-04 09:25:14 -05:00

47 lines
1.4 KiB
Go

// Copyright (c) The OpenTofu Authors
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) 2023 HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package statefile
import (
"bytes"
"github.com/opentofu/opentofu/internal/encryption"
"github.com/opentofu/opentofu/internal/states"
)
// StatesMarshalEqual returns true if and only if the two given states have
// an identical (byte-for-byte) statefile representation.
//
// This function compares only the portions of the state that are persisted
// in state files, so for example it will not return false if the only
// differences between the two states are local values or descendent module
// outputs.
func StatesMarshalEqual(a, b *states.State) bool {
var aBuf bytes.Buffer
var bBuf bytes.Buffer
// nil states are not valid states, and so they can never martial equal.
if a == nil || b == nil {
return false
}
// We write here some temporary files that have no header information
// populated, thus ensuring that we're only comparing the state itself
// and not any metadata.
err := Write(&File{State: a}, &aBuf, encryption.StateEncryptionDisabled())
if err != nil {
// Should never happen, because we're writing to an in-memory buffer
panic(err)
}
err = Write(&File{State: b}, &bBuf, encryption.StateEncryptionDisabled())
if err != nil {
// Should never happen, because we're writing to an in-memory buffer
panic(err)
}
return bytes.Equal(aBuf.Bytes(), bBuf.Bytes())
}