pulumi/pkg/resource/stack/checkpoint.go
Ian Wahbe 272c4643b2
Update error handling (#8406)
This is the result of a change applied via `go-rewrap-errors`.
2021-11-12 18:37:17 -08:00

128 lines
4.4 KiB
Go

// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package stack
import (
"encoding/json"
"fmt"
"github.com/pulumi/pulumi/pkg/v3/resource/deploy"
"github.com/pulumi/pulumi/pkg/v3/secrets"
"github.com/pulumi/pulumi/sdk/v3/go/common/apitype"
"github.com/pulumi/pulumi/sdk/v3/go/common/apitype/migrate"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
"github.com/pulumi/pulumi/sdk/v3/go/common/tokens"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
)
func UnmarshalVersionedCheckpointToLatestCheckpoint(bytes []byte) (*apitype.CheckpointV3, error) {
var versionedCheckpoint apitype.VersionedCheckpoint
if err := json.Unmarshal(bytes, &versionedCheckpoint); err != nil {
return nil, err
}
switch versionedCheckpoint.Version {
case 0:
// The happens when we are loading a checkpoint file from before we started to version things. Go's
// json package did not support strict marshalling before 1.10, and we use 1.9 in our toolchain today.
// After we upgrade, we could consider rewriting this code to use DisallowUnknownFields() on the decoder
// to have the old checkpoint not even deserialize as an apitype.VersionedCheckpoint.
var v1checkpoint apitype.CheckpointV1
if err := json.Unmarshal(bytes, &v1checkpoint); err != nil {
return nil, err
}
v2checkpoint := migrate.UpToCheckpointV2(v1checkpoint)
v3checkpoint := migrate.UpToCheckpointV3(v2checkpoint)
return &v3checkpoint, nil
case 1:
var v1checkpoint apitype.CheckpointV1
if err := json.Unmarshal(versionedCheckpoint.Checkpoint, &v1checkpoint); err != nil {
return nil, err
}
v2checkpoint := migrate.UpToCheckpointV2(v1checkpoint)
v3checkpoint := migrate.UpToCheckpointV3(v2checkpoint)
return &v3checkpoint, nil
case 2:
var v2checkpoint apitype.CheckpointV2
if err := json.Unmarshal(versionedCheckpoint.Checkpoint, &v2checkpoint); err != nil {
return nil, err
}
v3checkpoint := migrate.UpToCheckpointV3(v2checkpoint)
return &v3checkpoint, nil
case 3:
var v3checkpoint apitype.CheckpointV3
if err := json.Unmarshal(versionedCheckpoint.Checkpoint, &v3checkpoint); err != nil {
return nil, err
}
return &v3checkpoint, nil
default:
return nil, fmt.Errorf("unsupported checkpoint version %d", versionedCheckpoint.Version)
}
}
// SerializeCheckpoint turns a snapshot into a data structure suitable for serialization.
func SerializeCheckpoint(stack tokens.QName, snap *deploy.Snapshot,
sm secrets.Manager, showSecrets bool) (*apitype.VersionedCheckpoint, error) {
// If snap is nil, that's okay, we will just create an empty deployment; otherwise, serialize the whole snapshot.
var latest *apitype.DeploymentV3
if snap != nil {
dep, err := SerializeDeployment(snap, sm, showSecrets)
if err != nil {
return nil, fmt.Errorf("serializing deployment: %w", err)
}
latest = dep
}
b, err := json.Marshal(apitype.CheckpointV3{
Stack: stack,
Latest: latest,
})
if err != nil {
return nil, fmt.Errorf("marshalling checkpoint: %w", err)
}
return &apitype.VersionedCheckpoint{
Version: apitype.DeploymentSchemaVersionCurrent,
Checkpoint: json.RawMessage(b),
}, nil
}
// DeserializeCheckpoint takes a serialized deployment record and returns its associated snapshot. Returns nil
// if there have been no deployments performed on this checkpoint.
func DeserializeCheckpoint(chkpoint *apitype.CheckpointV3) (*deploy.Snapshot, error) {
contract.Require(chkpoint != nil, "chkpoint")
if chkpoint.Latest != nil {
return DeserializeDeploymentV3(*chkpoint.Latest, DefaultSecretsProvider)
}
return nil, nil
}
// GetRootStackResource returns the root stack resource from a given snapshot, or nil if not found.
func GetRootStackResource(snap *deploy.Snapshot) (*resource.State, error) {
if snap != nil {
for _, res := range snap.Resources {
if res.Type == resource.RootStackType {
return res, nil
}
}
}
return nil, nil
}