pulumi/cmd/stack.go
Matt Ellis 8f076b7cb3 Argument validation for CLI commands
Previously, we were inconsistent on how we handled argument validation
in the CLI. Many commands used cobra.Command's Args property to
provide a validator if they took arguments, but commands which did not
rarely used cobra.NoArgs to indicate this.

This change does two things:

1. Introduce `cmdutil.ArgsFunc` which works like `cmdutil.RunFunc`, it
wraps an existing cobra type and lets us control the behavior when an
arguments validator fails.

2. Ensure every command sets the Args property with an instance of
cmdutil.ArgsFunc. The cmdutil package defines wrapers for all the
cobra validators we are using, to prevent us from having to spell out
`cmduitl.ArgsFunc(...)` everywhere.

Fixes #588
2017-11-29 16:10:53 -08:00

108 lines
3.3 KiB
Go

// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
package cmd
import (
"fmt"
"github.com/spf13/cobra"
"github.com/pulumi/pulumi/pkg/resource"
"github.com/pulumi/pulumi/pkg/resource/stack"
"github.com/pulumi/pulumi/pkg/util/cmdutil"
)
func newStackCmd() *cobra.Command {
var showIDs bool
var showURNs bool
cmd := &cobra.Command{
Use: "stack",
Short: "Manage stacks",
Long: "Manage stacks\n" +
"\n" +
"An stack is a named update target, and a single project may have many of them.\n" +
"Each stack has a configuration and update history associated with it, stored in\n" +
"the workspace, in addition to a full checkpoint of the last known good update.\n",
Args: cmdutil.NoArgs,
Run: cmdutil.RunFunc(func(cmd *cobra.Command, args []string) error {
stackName, err := getCurrentStack()
if err != nil {
return err
}
_, config, snapshot, stackFile, err := getStack(stackName)
if err != nil {
return err
}
// First print general info about the current stack.
fmt.Printf("Current stack is %v:\n", stackName)
if snapshot != nil {
fmt.Printf(" Last updated at %v\n", snapshot.Time)
}
if len(config) > 0 {
fmt.Printf(" %v configuration variables set (see `pulumi config` for details)\n", len(config))
}
fmt.Printf(" Checkpoint file is %s\n", stackFile)
fmt.Printf(" (Use `pulumi stack select` to change stack; `pulumi stack ls` lists known ones)\n")
fmt.Printf("\n")
// Now show the resources.
var rescnt int
if snapshot != nil {
rescnt = len(snapshot.Resources)
}
fmt.Printf("Current stack resources (%d):\n", rescnt)
if rescnt == 0 {
fmt.Printf(" No resources currently in this stack\n")
} else {
fmt.Printf(" %-48s %s\n", "TYPE", "NAME")
var stackResource *resource.State
for _, res := range snapshot.Resources {
if res.Type == stack.RootPulumiStackTypeName {
stackResource = res
} else {
fmt.Printf(" %-48s %s\n", res.Type, res.URN.Name())
// If the ID and/or URN is requested, show it on the following line. It would be nice to do
// this on a single line, but this can get quite lengthy and so this formatting is better.
if showURNs {
fmt.Printf(" URN: %s\n", res.URN)
}
if showIDs && res.ID != "" {
fmt.Printf(" ID: %s\n", res.ID)
}
}
}
// Print out the output properties for the stack, if present.
if stackResource != nil {
fmt.Printf("\n")
outputs := stack.SerializeResource(stackResource).Outputs
fmt.Printf("Current stack outputs (%d):\n", len(outputs))
if len(outputs) == 0 {
fmt.Printf(" No output values currently in this stack\n")
} else {
fmt.Printf(" %-48s %s\n", "OUTPUT", "VALUE")
for key, val := range outputs {
fmt.Printf(" %-48s %s\n", key, val)
}
}
}
}
return nil
}),
}
cmd.PersistentFlags().BoolVarP(
&showIDs, "show-ids", "i", false, "Display each resource's provider-assigned unique ID")
cmd.PersistentFlags().BoolVarP(
&showURNs, "show-urns", "u", false, "Display each resource's Pulumi-assigned globally unique URN")
cmd.AddCommand(newStackInitCmd())
cmd.AddCommand(newStackLsCmd())
cmd.AddCommand(newStackRmCmd())
cmd.AddCommand(newStackSelectCmd())
return cmd
}