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

55 lines
1.5 KiB
Go

// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
package cmd
import (
"fmt"
"github.com/pkg/errors"
"github.com/pulumi/pulumi/pkg/tokens"
"github.com/spf13/cobra"
"github.com/pulumi/pulumi/pkg/util/cmdutil"
)
// newStackSelectCmd handles both the "local" and "cloud" scenarios in its implementation.
func newStackSelectCmd() *cobra.Command {
return &cobra.Command{
Use: "select [<stack>]",
Short: "Switch the current workspace to the given stack",
Long: "Switch the current workspace to the given stack. This allows you to use\n" +
"other commands like `config`, `preview`, and `push` without needing to specify the\n" +
"stack name each and every time.\n" +
"\n" +
"If no <stack> argument is supplied, the current stack is printed.",
Args: cmdutil.MaximumNArgs(1),
Run: cmdutil.RunFunc(func(cmd *cobra.Command, args []string) error {
// Display the name of the current stack if a new one isn't specified.
if len(args) == 0 {
name, err := getCurrentStack()
if err != nil {
return err
}
fmt.Printf("%v\n", name)
return nil
}
selectedStack := tokens.QName(args[0])
// Confirm the stack name is valid.
summeries, err := backend.GetStacks()
if err != nil {
return err
}
for _, stack := range summeries {
if stack.Name == selectedStack {
return setCurrentStack(selectedStack)
}
}
return errors.Errorf("no stack with name '%v' found", selectedStack)
}),
}
}