pulumi/pkg/cmd/pulumi/pulumi.go

802 lines
23 KiB
Go

// Copyright 2016-2023, 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 (
"bufio"
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"log"
"net/http"
"net/url"
"os"
"os/exec"
"path/filepath"
"regexp"
"runtime"
"strconv"
"strings"
"time"
"github.com/opentracing/opentracing-go"
user "github.com/tweekmonster/luser"
"github.com/blang/semver"
"github.com/djherbis/times"
"github.com/moby/term"
"github.com/spf13/cobra"
"github.com/pulumi/pulumi/pkg/v3/backend"
"github.com/pulumi/pulumi/pkg/v3/backend/display"
"github.com/pulumi/pulumi/pkg/v3/backend/httpstate"
"github.com/pulumi/pulumi/pkg/v3/backend/httpstate/client"
"github.com/pulumi/pulumi/pkg/v3/util/tracing"
"github.com/pulumi/pulumi/pkg/v3/version"
"github.com/pulumi/pulumi/sdk/v3/go/common/diag"
"github.com/pulumi/pulumi/sdk/v3/go/common/diag/colors"
"github.com/pulumi/pulumi/sdk/v3/go/common/env"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/cmdutil"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/httputil"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/logging"
"github.com/pulumi/pulumi/sdk/v3/go/common/workspace"
)
type commandGroup struct {
Name string
Commands []*cobra.Command
}
func (c *commandGroup) commandWidth() int {
width := 0
for _, com := range c.Commands {
if com.Hidden {
continue
}
newWidth := len(com.Name())
if newWidth > width {
width = newWidth
}
}
return width
}
func displayCommands(cgs []commandGroup) {
width := 0
for _, cg := range cgs {
newWidth := cg.commandWidth()
if newWidth > width {
width = newWidth
}
}
for _, cg := range cgs {
if cg.commandWidth() == 0 {
continue
}
fmt.Printf("%s:\n", cg.Name)
for _, com := range cg.Commands {
if com.Hidden {
continue
}
spacing := strings.Repeat(" ", width-len(com.Name()))
fmt.Println(" " + com.Name() + spacing + strings.Repeat(" ", 8) + com.Short)
}
fmt.Println()
}
}
func setCommandGroups(cmd *cobra.Command, rootCgs []commandGroup) {
for _, cg := range rootCgs {
for _, com := range cg.Commands {
cmd.AddCommand(com)
}
}
cmd.SetHelpFunc(func(c *cobra.Command, args []string) {
header := c.Long
if header == "" {
header = c.Short
}
if header != "" {
fmt.Println(strings.TrimSpace(header))
fmt.Println()
}
if c != cmd.Root() {
fmt.Print(c.UsageString())
return
}
fmt.Println("Usage:")
fmt.Println(" pulumi [command]")
fmt.Println()
displayCommands(rootCgs)
fmt.Println("Flags:")
fmt.Println(cmd.Flags().FlagUsages())
fmt.Println("Use `pulumi [command] --help` for more information about a command.")
})
}
type loggingWriter struct{}
func (loggingWriter) Write(bytes []byte) (int, error) {
logging.Infof(string(bytes))
return len(bytes), nil
}
// NewPulumiCmd creates a new Pulumi Cmd instance.
func NewPulumiCmd() *cobra.Command {
var cwd string
var logFlow bool
var logToStderr bool
var tracingFlag string
var tracingHeaderFlag string
var profiling string
var verbose int
var color string
var memProfileRate int
updateCheckResult := make(chan *diag.Diag)
cmd := &cobra.Command{
Use: "pulumi",
Short: "Pulumi command line",
Long: "Pulumi - Modern Infrastructure as Code\n" +
"\n" +
"To begin working with Pulumi, run the `pulumi new` command:\n" +
"\n" +
" $ pulumi new\n" +
"\n" +
"This will prompt you to create a new project for your cloud and language of choice.\n" +
"\n" +
"The most common commands from there are:\n" +
"\n" +
" - pulumi up : Deploy code and/or resource changes\n" +
" - pulumi stack : Manage instances of your project\n" +
" - pulumi config : Alter your stack's configuration or secrets\n" +
" - pulumi destroy : Tear down your stack's resources entirely\n" +
"\n" +
"For more information, please visit the project page: https://www.pulumi.com/docs/",
PersistentPreRun: cmdutil.RunFunc(func(cmd *cobra.Command, args []string) error {
// We run this method for its side-effects. On windows, this will enable the windows terminal
// to understand ANSI escape codes.
_, _, _ = term.StdStreams()
// If we fail before we start the async update check, go ahead and close the
// channel since we know it will never receive a value.
var waitForUpdateCheck bool
defer func() {
if !waitForUpdateCheck {
close(updateCheckResult)
}
}()
// For all commands, attempt to grab out the --color value provided so we
// can set the GlobalColorization value to be used by any code that doesn't
// get DisplayOptions passed in.
cmdFlag := cmd.Flag("color")
if cmdFlag != nil {
err := cmdutil.SetGlobalColorization(cmdFlag.Value.String())
if err != nil {
return err
}
}
if cwd != "" {
if err := os.Chdir(cwd); err != nil {
return err
}
}
logging.InitLogging(logToStderr, verbose, logFlow)
cmdutil.InitTracing("pulumi-cli", "pulumi", tracingFlag)
ctx := cmd.Context()
if cmdutil.IsTracingEnabled() {
if cmdutil.TracingRootSpan != nil {
ctx = opentracing.ContextWithSpan(ctx, cmdutil.TracingRootSpan)
}
// This is used to control the contents of the tracing header.
tracingHeader := os.Getenv("PULUMI_TRACING_HEADER")
if tracingHeaderFlag != "" {
tracingHeader = tracingHeaderFlag
}
tracingOptions := tracing.Options{
PropagateSpans: true,
TracingHeader: tracingHeader,
}
ctx = tracing.ContextWithOptions(ctx, tracingOptions)
}
cmd.SetContext(ctx)
if logging.Verbose >= 11 {
logging.Warningf("log level 11 will print sensitive information such as api tokens and request headers")
}
// The gocloud drivers use the log package to write logs, which by default just writes to stdout. This overrides
// that so that log messages go to the logging package that we use everywhere else instead.
loggingWriter := &loggingWriter{}
log.SetOutput(loggingWriter)
if profiling != "" {
if err := cmdutil.InitProfiling(profiling, memProfileRate); err != nil {
logging.Warningf("could not initialize profiling: %v", err)
}
}
if env.SkipUpdateCheck.Value() {
logging.V(5).Infof("skipping update check")
} else {
// Run the version check in parallel so that it doesn't block executing the command.
// If there is a new version to report, we will do so after the command has finished.
waitForUpdateCheck = true
go func() {
updateCheckResult <- checkForUpdate(ctx)
close(updateCheckResult)
}()
}
return nil
}),
PersistentPostRun: func(cmd *cobra.Command, args []string) {
// Before exiting, if there is a new version of the CLI available, print it out.
jsonFlag := cmd.Flag("json")
isJSON := jsonFlag != nil && jsonFlag.Value.String() == "true"
checkVersionMsg, ok := <-updateCheckResult
if ok && checkVersionMsg != nil && !isJSON {
cmdutil.Diag().Warningf(checkVersionMsg)
}
logging.Flush()
cmdutil.CloseTracing()
if profiling != "" {
if err := cmdutil.CloseProfiling(profiling); err != nil {
logging.Warningf("could not close profiling: %v", err)
}
}
},
}
cmd.PersistentFlags().StringVarP(&cwd, "cwd", "C", "",
"Run pulumi as if it had been started in another directory")
cmd.PersistentFlags().BoolVarP(&cmdutil.Emoji, "emoji", "e", runtime.GOOS == "darwin",
"Enable emojis in the output")
cmd.PersistentFlags().BoolVarP(&cmdutil.FullyQualifyStackNames, "fully-qualify-stack-names", "Q", false,
"Show fully-qualified stack names")
cmd.PersistentFlags().BoolVar(&backend.DisableIntegrityChecking, "disable-integrity-checking", false,
"Disable integrity checking of checkpoint files")
cmd.PersistentFlags().BoolVar(&logFlow, "logflow", false,
"Flow log settings to child processes (like plugins)")
cmd.PersistentFlags().BoolVar(&logToStderr, "logtostderr", false,
"Log to stderr instead of to files")
cmd.PersistentFlags().BoolVar(&cmdutil.DisableInteractive, "non-interactive", false,
"Disable interactive mode for all commands")
cmd.PersistentFlags().StringVar(&tracingFlag, "tracing", "",
"Emit tracing to the specified endpoint. Use the `file:` scheme to write tracing data to a local file")
cmd.PersistentFlags().StringVar(&profiling, "profiling", "",
"Emit CPU and memory profiles and an execution trace to '[filename].[pid].{cpu,mem,trace}', respectively")
cmd.PersistentFlags().IntVar(&memProfileRate, "memprofilerate", 0,
"Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate")
cmd.PersistentFlags().IntVarP(&verbose, "verbose", "v", 0,
"Enable verbose logging (e.g., v=3); anything >3 is very verbose")
cmd.PersistentFlags().StringVar(
&color, "color", "auto", "Colorize output. Choices are: always, never, raw, auto")
setCommandGroups(cmd, []commandGroup{
// Common commands:
{
Name: "Stack Management Commands",
Commands: []*cobra.Command{
newNewCmd(),
newConfigCmd(),
newStackCmd(),
newConsoleCmd(),
newImportCmd(),
newRefreshCmd(),
newStateCmd(),
newInstallCmd(),
},
},
{
Name: "Deployment Commands",
Commands: []*cobra.Command{
newUpCmd(),
newDestroyCmd(),
newPreviewCmd(),
newCancelCmd(),
},
},
{
Name: "Environment Commands",
Commands: []*cobra.Command{
newEnvCmd(),
},
},
{
Name: "Pulumi Cloud Commands",
Commands: []*cobra.Command{
newLoginCmd(),
newLogoutCmd(),
newWhoAmICmd(),
newOrgCmd(),
},
},
{
Name: "Policy Management Commands",
Commands: []*cobra.Command{
newPolicyCmd(),
},
},
{
Name: "Plugin Commands",
Commands: []*cobra.Command{
newPluginCmd(),
newSchemaCmd(),
newPackageCmd(),
},
},
{
Name: "Other Commands",
Commands: []*cobra.Command{
newVersionCmd(),
newAboutCmd(),
newGenCompletionCmd(cmd),
},
},
// Less common, and thus hidden, commands:
{
Name: "Hidden Commands",
Commands: []*cobra.Command{
newGenMarkdownCmd(cmd),
},
},
// We have a set of commands that are still experimental
// hidden unless PULUMI_EXPERIMENTAL is set to true.
{
Name: "Experimental Commands",
Commands: []*cobra.Command{
newQueryCmd(),
newConvertCmd(),
newWatchCmd(),
newLogsCmd(),
},
},
// We have a set of options that are useful for developers of pulumi
// hidden unless PULUMI_DEBUG_COMMANDS is set to true.
{
Name: "Developer Commands",
Commands: []*cobra.Command{
newViewTraceCmd(),
newConvertTraceCmd(),
newReplayEventsCmd(),
},
},
// AI Commands relating to specifically the Pulumi AI service
// and its related features
{
Name: "AI Commands",
Commands: []*cobra.Command{
newAICommand(),
},
},
})
cmd.PersistentFlags().StringVar(&tracingHeaderFlag, "tracing-header", "",
"Include the tracing header with the given contents.")
if !hasDebugCommands() {
err := cmd.PersistentFlags().MarkHidden("tracing-header")
contract.IgnoreError(err)
}
return cmd
}
// haveNewerDevVersion checks whethere we have a newer dev version available.
func haveNewerDevVersion(devVersion semver.Version, curVersion semver.Version) bool {
if devVersion.Major != curVersion.Major {
return devVersion.Major > curVersion.Major
}
if devVersion.Minor != curVersion.Minor {
return devVersion.Minor > curVersion.Minor
}
if devVersion.Patch != curVersion.Patch {
return devVersion.Patch > curVersion.Patch
}
// The dev version string looks like: v1.0.0-11-g4ff08363. We
// can determine whether we have a newer dev version by
// comparing the second part of the version string, which is
// the number of commits since the last tag.
devVersionParts := strings.Split(devVersion.String(), "-")
curVersionParts := strings.Split(curVersion.String(), "-")
// We're being leninent with parsing here. If we can't parse
// a version number correctly for any reason, we default to
// pretending there is no newer version, and not warning the
// user. As this is only a warning this is better than
// asserting or crashing in the error case.
if len(devVersionParts) != 3 || len(curVersionParts) != 3 {
return false
}
devCommits, err := strconv.Atoi(devVersionParts[1])
if err != nil {
return false
}
curCommits, err := strconv.Atoi(curVersionParts[1])
if err != nil {
return false
}
return devCommits > curCommits
}
// checkForUpdate checks to see if the CLI needs to be updated, and if so emits a warning, as well as information
// as to how it can be upgraded.
func checkForUpdate(ctx context.Context) *diag.Diag {
curVer, err := semver.ParseTolerant(version.Version)
if err != nil {
logging.V(3).Infof("error parsing current version: %s", err)
}
// We don't care about warning for you to update if you have installed a locally complied version
if isLocalVersion(curVer) {
return nil
}
isDevVersion := isDevVersion(curVer)
var skipUpdateCheck bool
latestVer, oldestAllowedVer, devVer, err := getCachedVersionInfo(isDevVersion)
if err == nil {
// If we have a cached version, we already warned the user once
// in the last 24 hours--the cache is considered stale after that.
// So we don't need to warn again.
skipUpdateCheck = true
} else {
latestVer, oldestAllowedVer, devVer, err = getCLIVersionInfo(ctx)
if err != nil {
logging.V(3).Infof("error fetching latest version information "+
"(set `%s=true` to skip update checks): %s", env.SkipUpdateCheck.Var().Name(), err)
}
}
if (isDevVersion && haveNewerDevVersion(devVer, curVer)) || (!isDevVersion && oldestAllowedVer.GT(curVer)) {
if isDevVersion {
latestVer = devVer
}
msg := getUpgradeMessage(latestVer, curVer, isDevVersion)
if skipUpdateCheck {
// If we're skipping the check,
// still log this to the internal logging system
// that users don't see by default.
logging.Warningf(msg)
return nil
}
return diag.RawMessage("", msg)
}
return nil
}
// getCLIVersionInfo returns information about the latest version of the CLI and the oldest version that should be
// allowed without warning. It caches data from the server for a day.
func getCLIVersionInfo(ctx context.Context) (semver.Version, semver.Version, semver.Version, error) {
client := client.NewClient(httpstate.DefaultURL(), "", false, cmdutil.Diag())
latest, oldest, dev, err := client.GetCLIVersionInfo(ctx)
if err != nil {
return semver.Version{}, semver.Version{}, semver.Version{}, err
}
brewLatest, isBrew, err := getLatestBrewFormulaVersion()
if err != nil {
logging.V(3).Infof("error determining if the running executable was installed with brew: %s", err)
}
if isBrew {
// When consulting Homebrew for version info, we just use the latest version as the oldest allowed.
latest, oldest, dev = brewLatest, brewLatest, brewLatest
}
err = cacheVersionInfo(latest, oldest, dev)
if err != nil {
logging.V(3).Infof("failed to cache version info: %s", err)
}
return latest, oldest, dev, err
}
// cacheVersionInfo saves version information in a cache file to be looked up later.
func cacheVersionInfo(latest semver.Version, oldest semver.Version, dev semver.Version) error {
updateCheckFile, err := workspace.GetCachedVersionFilePath()
if err != nil {
return err
}
file, err := os.OpenFile(updateCheckFile, os.O_CREATE|os.O_TRUNC|os.O_RDWR, 0o600)
if err != nil {
return err
}
defer contract.IgnoreClose(file)
return json.NewEncoder(file).Encode(cachedVersionInfo{
LatestVersion: latest.String(),
OldestWithoutWarning: oldest.String(),
LatestDevVersion: dev.String(),
})
}
// getCachedVersionInfo reads cached information about the newest CLI version, returning the newest version available,
// the oldest version that should be allowed without warning the user they should upgrade, as well as the
// latest dev version.
func getCachedVersionInfo(devVersion bool) (semver.Version, semver.Version, semver.Version, error) {
updateCheckFile, err := workspace.GetCachedVersionFilePath()
if err != nil {
return semver.Version{}, semver.Version{}, semver.Version{}, err
}
ts, err := times.Stat(updateCheckFile)
if err != nil {
return semver.Version{}, semver.Version{}, semver.Version{}, err
}
cacheTime := 24 * time.Hour
if devVersion {
cacheTime = 1 * time.Hour
}
if time.Now().After(ts.ModTime().Add(cacheTime)) {
return semver.Version{}, semver.Version{}, semver.Version{}, errors.New("cached expired")
}
file, err := os.OpenFile(updateCheckFile, os.O_RDONLY, 0o600)
if err != nil {
return semver.Version{}, semver.Version{}, semver.Version{}, err
}
defer contract.IgnoreClose(file)
var cached cachedVersionInfo
if err = json.NewDecoder(file).Decode(&cached); err != nil {
return semver.Version{}, semver.Version{}, semver.Version{}, err
}
latest, err := semver.ParseTolerant(cached.LatestVersion)
if err != nil {
return semver.Version{}, semver.Version{}, semver.Version{}, err
}
oldest, err := semver.ParseTolerant(cached.OldestWithoutWarning)
if err != nil {
return semver.Version{}, semver.Version{}, semver.Version{}, err
}
dev, err := semver.ParseTolerant(cached.LatestDevVersion)
if err != nil {
return semver.Version{}, semver.Version{}, semver.Version{}, err
}
return latest, oldest, dev, err
}
// cachedVersionInfo is the on disk format of the version information the CLI caches between runs.
type cachedVersionInfo struct {
LatestVersion string `json:"latestVersion"`
OldestWithoutWarning string `json:"oldestWithoutWarning"`
LatestDevVersion string `json:"latestDevVersion"`
}
// getUpgradeMessage gets a message to display to a user instructing them they are out of date and how to move from
// current to latest.
func getUpgradeMessage(latest semver.Version, current semver.Version, isDevVersion bool) string {
cmd := getUpgradeCommand(isDevVersion)
msg := fmt.Sprintf("A new version of Pulumi is available. To upgrade from version '%s' to '%s', ", current, latest)
if cmd != "" {
msg += "run \n " + cmd + "\nor "
}
msg += "visit https://pulumi.com/docs/install/ for manual instructions and release notes."
return msg
}
// getUpgradeCommand returns a command that will upgrade the CLI to the newest version. If we can not determine how
// the CLI was installed, the empty string is returned.
func getUpgradeCommand(isDevVersion bool) string {
curUser, err := user.Current()
if err != nil {
return ""
}
exe, err := os.Executable()
if err != nil {
return ""
}
isBrew, err := isBrewInstall(exe)
if err != nil {
logging.V(3).Infof("error determining if the running executable was installed with brew: %s", err)
}
if isBrew {
return "$ brew update && brew upgrade pulumi"
}
if filepath.Dir(exe) != filepath.Join(curUser.HomeDir, workspace.BookkeepingDir, "bin") {
return ""
}
if runtime.GOOS != "windows" {
command := "$ curl -sSL https://get.pulumi.com | sh"
if isDevVersion {
command = command + " -s -- --version dev"
}
return command
}
powershellCmd := `"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe"`
if _, err := exec.LookPath("powershell"); err == nil {
powershellCmd = "powershell"
}
powershellCmd = "> " + powershellCmd + ` -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "iex ` +
`((New-Object System.Net.WebClient).DownloadString('https://get.pulumi.com/install.ps1'))"`
if isDevVersion {
powershellCmd = powershellCmd + " -version dev"
}
return powershellCmd
}
// isBrewInstall returns true if the current running executable is running on macOS and was installed with brew.
func isBrewInstall(exe string) (bool, error) {
if runtime.GOOS != "darwin" {
return false, nil
}
exePath, err := filepath.EvalSymlinks(exe)
if err != nil {
return false, err
}
brewBin, err := exec.LookPath("brew")
if err != nil {
return false, err
}
brewPrefixCmd := exec.Command(brewBin, "--prefix", "pulumi")
var stdout bytes.Buffer
var stderr bytes.Buffer
brewPrefixCmd.Stdout = &stdout
brewPrefixCmd.Stderr = &stderr
if err = brewPrefixCmd.Run(); err != nil {
if ee, ok := err.(*exec.ExitError); ok {
ee.Stderr = stderr.Bytes()
}
return false, fmt.Errorf("'brew --prefix pulumi' failed: %w", err)
}
brewPrefixCmdOutput := strings.TrimSpace(stdout.String())
if brewPrefixCmdOutput == "" {
return false, errors.New("trimmed output from 'brew --prefix pulumi' is empty")
}
brewPrefixPath, err := filepath.EvalSymlinks(brewPrefixCmdOutput)
if err != nil {
return false, err
}
brewPrefixExePath := filepath.Join(brewPrefixPath, "bin", "pulumi")
return exePath == brewPrefixExePath, nil
}
func getLatestBrewFormulaVersion() (semver.Version, bool, error) {
exe, err := os.Executable()
if err != nil {
return semver.Version{}, false, err
}
isBrew, err := isBrewInstall(exe)
if err != nil {
return semver.Version{}, false, err
}
if !isBrew {
return semver.Version{}, false, nil
}
const formulaJSON = "https://formulae.brew.sh/api/formula/pulumi.json"
url, err := url.Parse(formulaJSON)
contract.AssertNoErrorf(err, "Could not parse URL %q", formulaJSON)
resp, err := httputil.DoWithRetry(&http.Request{
Method: http.MethodGet,
URL: url,
}, http.DefaultClient)
if err != nil {
return semver.Version{}, false, err
}
defer contract.IgnoreClose(resp.Body)
type versions struct {
Stable string `json:"stable"`
}
var formula struct {
Versions versions `json:"versions"`
}
if err := json.NewDecoder(resp.Body).Decode(&formula); err != nil {
return semver.Version{}, false, err
}
stable, err := semver.ParseTolerant(formula.Versions.Stable)
if err != nil {
return semver.Version{}, false, err
}
return stable, true, nil
}
func isLocalVersion(s semver.Version) bool {
if len(s.Pre) == 0 {
return false
}
devStrings := regexp.MustCompile(`alpha|beta|dev|rc`)
return !s.Pre[0].IsNum && devStrings.MatchString(s.Pre[0].VersionStr)
}
func isDevVersion(s semver.Version) bool {
if len(s.Pre) == 0 {
return false
}
devRegex := regexp.MustCompile(`\d*-g[0-9a-f]*$`)
return !s.Pre[0].IsNum && devRegex.MatchString(s.Pre[0].VersionStr)
}
func confirmPrompt(prompt string, name string, opts display.Options) bool {
out := opts.Stdout
if out == nil {
out = os.Stdout
}
in := opts.Stdin
if in == nil {
in = os.Stdin
}
if prompt != "" {
fmt.Fprint(out,
opts.Color.Colorize(
fmt.Sprintf("%s%s%s\n", colors.SpecAttention, prompt, colors.Reset)))
}
fmt.Fprint(out,
opts.Color.Colorize(
fmt.Sprintf("%sPlease confirm that this is what you'd like to do by typing `%s%s%s`:%s ",
colors.SpecAttention, colors.SpecPrompt, name, colors.SpecAttention, colors.Reset)))
reader := bufio.NewReader(in)
line, _ := reader.ReadString('\n')
return strings.TrimSpace(line) == name
}