pulumi/pkg/cmd/pulumi/stack_export.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

134 lines
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 main
import (
"encoding/json"
"fmt"
"os"
"github.com/pulumi/pulumi/pkg/v3/resource/stack"
"github.com/spf13/cobra"
"github.com/pulumi/pulumi/pkg/v3/backend"
"github.com/pulumi/pulumi/pkg/v3/backend/display"
"github.com/pulumi/pulumi/sdk/v3/go/common/apitype"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/cmdutil"
)
func newStackExportCmd() *cobra.Command {
var file string
var stackName string
var version string
var showSecrets bool
cmd := &cobra.Command{
Use: "export",
Args: cmdutil.MaximumNArgs(0),
Short: "Export a stack's deployment to standard out",
Long: "Export a stack's deployment to standard out.\n" +
"\n" +
"The deployment can then be hand-edited and used to update the stack via\n" +
"`pulumi stack import`. This process may be used to correct inconsistencies\n" +
"in a stack's state due to failed deployments, manual changes to cloud\n" +
"resources, etc.",
Run: cmdutil.RunFunc(func(cmd *cobra.Command, args []string) error {
ctx := commandContext()
opts := display.Options{
Color: cmdutil.GetGlobalColorization(),
}
// Fetch the current stack and export its deployment
s, err := requireStack(stackName, false, opts, false /*setCurrent*/)
if err != nil {
return err
}
var deployment *apitype.UntypedDeployment
// Export the latest version of the checkpoint by default. Otherwise, we require that
// the backend/stack implements the ability the export previous checkpoints.
if version == "" {
deployment, err = s.ExportDeployment(ctx)
if err != nil {
return err
}
} else {
// Check that the stack and its backend supports the ability to do this.
be := s.Backend()
specificExpBE, ok := be.(backend.SpecificDeploymentExporter)
if !ok {
return fmt.Errorf("the current backend (%s) does not provide the ability to export previous deployments",
be.Name())
}
deployment, err = specificExpBE.ExportDeploymentForVersion(ctx, s, version)
if err != nil {
return err
}
}
// Read from stdin or a specified file.
writer := os.Stdout
if file != "" {
writer, err = os.Create(file)
if err != nil {
return fmt.Errorf("could not open file: %w", err)
}
}
if showSecrets {
snap, err := stack.DeserializeUntypedDeployment(deployment, stack.DefaultSecretsProvider)
if err != nil {
return checkDeploymentVersionError(err, stackName)
}
serializedDeployment, err := stack.SerializeDeployment(snap, snap.SecretsManager, true)
if err != nil {
return err
}
data, err := json.Marshal(serializedDeployment)
if err != nil {
return err
}
deployment = &apitype.UntypedDeployment{
Version: 3,
Deployment: data,
}
}
// Write the deployment.
enc := json.NewEncoder(writer)
enc.SetIndent("", " ")
if err = enc.Encode(deployment); err != nil {
return fmt.Errorf("could not export deployment: %w", err)
}
return nil
}),
}
cmd.PersistentFlags().StringVarP(
&stackName, "stack", "s", "", "The name of the stack to operate on. Defaults to the current stack")
cmd.PersistentFlags().StringVarP(
&file, "file", "", "", "A filename to write stack output to")
cmd.PersistentFlags().StringVarP(
&version, "version", "", "", "Previous stack version to export. (If unset, will export the latest.)")
cmd.Flags().BoolVarP(
&showSecrets, "show-secrets", "", false, "Emit secrets in plaintext in exported stack. Defaults to `false`")
return cmd
}