mirror of https://github.com/pulumi/pulumi.git
254 lines
8.1 KiB
Go
254 lines
8.1 KiB
Go
// Copyright 2018-2024, 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"
|
|
"sort"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/dustin/go-humanize"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/pulumi/pulumi/pkg/v3/backend"
|
|
"github.com/pulumi/pulumi/pkg/v3/backend/display"
|
|
pkgWorkspace "github.com/pulumi/pulumi/pkg/v3/workspace"
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/diag/colors"
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/config"
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/util/cmdutil"
|
|
)
|
|
|
|
const errorDecryptingValue = "ERROR_UNABLE_TO_DECRYPT"
|
|
|
|
func newStackHistoryCmd() *cobra.Command {
|
|
var stack string
|
|
var jsonOut bool
|
|
var showSecrets bool
|
|
var pageSize int
|
|
var page int
|
|
var showFullDates bool
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "history",
|
|
Aliases: []string{"hist"},
|
|
SuggestFor: []string{"updates"},
|
|
Short: "Display history for a stack",
|
|
Long: `Display history for a stack
|
|
|
|
This command displays data about previous updates for a stack.`,
|
|
Run: runCmdFunc(func(cmd *cobra.Command, args []string) error {
|
|
ctx := cmd.Context()
|
|
ws := pkgWorkspace.Instance
|
|
opts := display.Options{
|
|
Color: cmdutil.GetGlobalColorization(),
|
|
}
|
|
s, err := requireStack(ctx, ws, stack, stackLoadOnly, opts)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
b := s.Backend()
|
|
updates, err := b.GetHistory(ctx, s.Ref(), pageSize, page)
|
|
if err != nil {
|
|
return fmt.Errorf("getting history: %w", err)
|
|
}
|
|
var decrypter config.Decrypter
|
|
if showSecrets {
|
|
project, _, err := ws.ReadProject()
|
|
if err != nil {
|
|
return fmt.Errorf("loading project: %w", err)
|
|
}
|
|
ps, err := loadProjectStack(project, s)
|
|
if err != nil {
|
|
return fmt.Errorf("getting stack config: %w", err)
|
|
}
|
|
crypter, needsSave, err := getStackDecrypter(s, ps)
|
|
if err != nil {
|
|
return fmt.Errorf("decrypting secrets: %w", err)
|
|
}
|
|
if needsSave {
|
|
if err = saveProjectStack(s, ps); err != nil {
|
|
return fmt.Errorf("saving stack config: %w", err)
|
|
}
|
|
}
|
|
decrypter = crypter
|
|
}
|
|
|
|
if showSecrets {
|
|
log3rdPartySecretsProviderDecryptionEvent(ctx, s, "", "pulumi stack history")
|
|
}
|
|
|
|
if jsonOut {
|
|
return displayUpdatesJSON(updates, decrypter)
|
|
}
|
|
|
|
return displayUpdatesConsole(updates, page, opts, showFullDates)
|
|
}),
|
|
}
|
|
|
|
cmd.PersistentFlags().StringVarP(
|
|
&stack, "stack", "s", "",
|
|
"Choose a stack other than the currently selected one")
|
|
cmd.Flags().BoolVar(
|
|
&showSecrets, "show-secrets", false,
|
|
"Show secret values when listing config instead of displaying blinded values")
|
|
cmd.PersistentFlags().BoolVarP(
|
|
&jsonOut, "json", "j", false, "Emit output as JSON")
|
|
cmd.PersistentFlags().BoolVar(
|
|
&showFullDates, "full-dates", false, "Show full dates, instead of relative dates")
|
|
cmd.PersistentFlags().IntVar(
|
|
&pageSize, "page-size", 10, "Used with 'page' to control number of results returned")
|
|
cmd.PersistentFlags().IntVar(
|
|
&page, "page", 1, "Used with 'page-size' to paginate results")
|
|
return cmd
|
|
}
|
|
|
|
// updateInfoJSON is the shape of the --json output for a configuration value. While we can add fields to this
|
|
// structure in the future, we should not change existing fields.
|
|
type updateInfoJSON struct {
|
|
Version int `json:"version"`
|
|
Kind string `json:"kind"`
|
|
StartTime string `json:"startTime"`
|
|
Message string `json:"message"`
|
|
Environment map[string]string `json:"environment"`
|
|
Config map[string]configValueJSON `json:"config"`
|
|
Result string `json:"result,omitempty"`
|
|
|
|
// These values are only present once the update finishes
|
|
EndTime *string `json:"endTime,omitempty"`
|
|
ResourceChanges *map[string]int `json:"resourceChanges,omitempty"`
|
|
}
|
|
|
|
func displayUpdatesJSON(updates []backend.UpdateInfo, decrypter config.Decrypter) error {
|
|
makeStringRef := func(s string) *string {
|
|
return &s
|
|
}
|
|
|
|
updatesJSON := make([]updateInfoJSON, len(updates))
|
|
for idx, update := range updates {
|
|
info := updateInfoJSON{
|
|
Version: update.Version,
|
|
Kind: string(update.Kind),
|
|
StartTime: time.Unix(update.StartTime, 0).UTC().Format(timeFormat),
|
|
Message: update.Message,
|
|
Environment: update.Environment,
|
|
}
|
|
|
|
info.Config = make(map[string]configValueJSON)
|
|
for k, v := range update.Config {
|
|
configValue := configValueJSON{
|
|
Secret: v.Secure(),
|
|
}
|
|
if !v.Secure() || (v.Secure() && decrypter != nil) {
|
|
value, err := v.Value(decrypter)
|
|
if err != nil {
|
|
// We don't actually want to error here
|
|
// we are just going to mark as "UNKNOWN" and then let the command continue
|
|
configValue.Value = makeStringRef(errorDecryptingValue)
|
|
} else {
|
|
configValue.Value = makeStringRef(value)
|
|
}
|
|
|
|
if v.Object() {
|
|
var obj interface{}
|
|
if err := json.Unmarshal([]byte(value), &obj); err != nil {
|
|
return err
|
|
}
|
|
configValue.ObjectValue = obj
|
|
}
|
|
}
|
|
info.Config[k.String()] = configValue
|
|
}
|
|
info.Result = string(update.Result)
|
|
if update.Result != backend.InProgressResult {
|
|
info.EndTime = makeStringRef(time.Unix(update.EndTime, 0).UTC().Format(timeFormat))
|
|
resourceChanges := make(map[string]int)
|
|
for k, v := range update.ResourceChanges {
|
|
resourceChanges[string(k)] = v
|
|
}
|
|
info.ResourceChanges = &resourceChanges
|
|
}
|
|
updatesJSON[idx] = info
|
|
}
|
|
|
|
return printJSON(updatesJSON)
|
|
}
|
|
|
|
func displayUpdatesConsole(updates []backend.UpdateInfo, page int, opts display.Options, noHumanize bool) error {
|
|
if len(updates) == 0 {
|
|
if page > 1 {
|
|
fmt.Printf("No stack updates found on page '%d'\n", page)
|
|
return nil
|
|
}
|
|
fmt.Println("Stack has never been updated")
|
|
return nil
|
|
}
|
|
|
|
printResourceChanges := func(background, text, sign, reset string, amount int) {
|
|
msg := opts.Color.Colorize(fmt.Sprintf("%s%s%s%v%s", background, text, sign, amount, reset))
|
|
fmt.Print(msg)
|
|
}
|
|
|
|
for _, update := range updates {
|
|
fmt.Printf("Version: %d\n", update.Version)
|
|
fmt.Printf("UpdateKind: %v\n", update.Kind)
|
|
if update.Result == "succeeded" {
|
|
fmt.Print(opts.Color.Colorize(fmt.Sprintf("%sStatus: %v%s\n", colors.Green, update.Result, colors.Reset)))
|
|
} else {
|
|
fmt.Print(opts.Color.Colorize(fmt.Sprintf("%sStatus: %v%s\n", colors.Red, update.Result, colors.Reset)))
|
|
}
|
|
fmt.Printf("Message: %v\n", update.Message)
|
|
|
|
printResourceChanges(colors.GreenBackground, colors.Black, "+", colors.Reset, update.ResourceChanges["create"])
|
|
printResourceChanges(colors.RedBackground, colors.Black, "-", colors.Reset, update.ResourceChanges["delete"])
|
|
printResourceChanges(colors.YellowBackground, colors.Black, "~", colors.Reset, update.ResourceChanges["update"])
|
|
printResourceChanges(colors.BlueBackground, colors.Black, " ", colors.Reset, update.ResourceChanges["same"])
|
|
|
|
timeStart := time.Unix(update.StartTime, 0)
|
|
var timeCreated string
|
|
if noHumanize {
|
|
timeCreated = timeStart.String()
|
|
} else {
|
|
timeCreated = humanize.Time(timeStart)
|
|
}
|
|
timeEnd := time.Unix(update.EndTime, 0)
|
|
duration := timeEnd.Sub(timeStart)
|
|
fmt.Printf("%sUpdated %s took %s\n", " ", timeCreated, duration)
|
|
|
|
isEmpty := func(s string) bool {
|
|
return len(strings.TrimSpace(s)) == 0
|
|
}
|
|
var keys []string
|
|
for k := range update.Environment {
|
|
keys = append(keys, k)
|
|
}
|
|
sort.Strings(keys)
|
|
indent := 4
|
|
for _, k := range keys {
|
|
if k == backend.GitHead && !isEmpty(update.Environment[k]) {
|
|
fmt.Print(opts.Color.Colorize(
|
|
fmt.Sprintf("%*s%s%s: %s%s\n", indent, "", colors.Yellow, k, update.Environment[k], colors.Reset)))
|
|
} else if !isEmpty(update.Environment[k]) {
|
|
fmt.Printf("%*s%s: %s\n", indent, "", k, update.Environment[k])
|
|
}
|
|
}
|
|
fmt.Println("")
|
|
}
|
|
|
|
return nil
|
|
}
|