pulumi/cmd/stack_select.go
Joe Duffy 776a76dffd
Make some stack-related CLI improvements (#947)
This change includes a handful of stack-related CLI formatting
improvements that I've been noodling on in the background for a while,
based on things that tend to trip up demos and the inner loop workflow.

This includes:

* If `pulumi stack select` is run by itself, use an interactive
  CLI menu to let the user select an existing stack, or choose to
  create a new one.  This looks as follows

      $ pulumi stack select
      Please choose a stack, or choose to create a new one:
        abcdef
        babblabblabble
      > currentlyselected
        defcon
        <create a new stack>

  and is navigated in the usual way (key up, down, enter).

* If a stack name is passed that does not exist, prompt the user
  to ask whether s/he wants to create one on-demand.  This hooks
  interesting moments in time, like `pulumi stack select foo`,
  and cuts down on the need to run additional commands.

* If a current stack is required, but none is currently selected,
  then pop the same interactive menu shown above to select one.
  Depending on the command being run, we may or may not show the
  option to create a new stack (e.g., that doesn't make much sense
  when you're running `pulumi destroy`, but might when you're
  running `pulumi stack`).  This again lets you do with a single
  command what would have otherwise entailed an error with multiple
  commands to recover from it.

* If you run `pulumi stack init` without any additional arguments,
  we interactively prompt for the stack name.  Before, we would
  error and you'd then need to run `pulumi stack init <name>`.

* Colorize some things nicely; for example, now all prompts will
  by default become bright white.
2018-02-16 15:03:54 -08:00

71 lines
2.3 KiB
Go

// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
package cmd
import (
"fmt"
"github.com/hashicorp/go-multierror"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"github.com/pulumi/pulumi/pkg/backend/state"
"github.com/pulumi/pulumi/pkg/tokens"
"github.com/pulumi/pulumi/pkg/util/cmdutil"
)
// newStackSelectCmd handles both the "local" and "cloud" scenarios in its implementation.
func newStackSelectCmd() *cobra.Command {
var cloud string
cmd := &cobra.Command{
Use: "select [<stack>]",
Short: "Switch the current workspace to the given stack",
Long: "Switch the current workspace to the given stack.\n" +
"\n" +
"Selecting a stack allows you to use commands like `config`, `preview`, and `update`\n" +
"without needing to type the stack name each time.\n" +
"\n" +
"If no <stack> argument is supplied, you will be prompted to select one interactively.",
Args: cmdutil.MaximumNArgs(1),
Run: cmdutil.RunFunc(func(cmd *cobra.Command, args []string) error {
bes, hasClouds := allBackends()
if len(args) > 0 {
// A stack was given, ask all known backends about it
stackName := tokens.QName(args[0])
var result error
for _, b := range bes {
stack, err := b.GetStack(stackName)
if err != nil {
// If there is an error, file it away, but keep going in case it's a transient cloud error.
result = multierror.Append(result, errors.Wrapf(err,
"could not query '%s' backend for stack selection", b.Name()))
continue
} else if stack != nil {
return state.SetCurrentStack(stackName)
}
}
// If we fell through, the stack was not found. Issue an error. Also customize the error
// message if no clouds are logged into, since that is presumably a common mistake.
msg := fmt.Sprintf("no stack named '%s' found", stackName)
if !hasClouds {
msg += "; you aren't logged into the Pulumi Cloud -- did you forget to 'pulumi login'?"
}
return multierror.Append(result, errors.New(msg))
}
// If no stack was given, prompt the user to select a name from the available ones.
stack, err := chooseStack(bes, true)
if err != nil {
return err
}
return state.SetCurrentStack(stack.Name())
}),
}
cmd.PersistentFlags().StringVarP(
&cloud, "cloud", "c", "", "A URL for the Pulumi Cloud containing the stack to be selected")
return cmd
}