2018-05-22 19:43:36 +00:00
|
|
|
// Copyright 2016-2018, 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.
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2018-09-04 22:40:15 +00:00
|
|
|
package display
|
2018-04-15 19:47:53 +00:00
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"fmt"
|
2019-04-01 14:27:21 +00:00
|
|
|
"io"
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
"sort"
|
2018-04-17 06:41:00 +00:00
|
|
|
"strings"
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2018-09-24 20:49:14 +00:00
|
|
|
"github.com/dustin/go-humanize/english"
|
2023-09-18 11:01:28 +00:00
|
|
|
"github.com/pulumi/pulumi/pkg/v3/display"
|
2021-03-17 13:20:05 +00:00
|
|
|
"github.com/pulumi/pulumi/pkg/v3/engine"
|
|
|
|
"github.com/pulumi/pulumi/pkg/v3/resource/deploy"
|
|
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/apitype"
|
|
|
|
"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/resource"
|
2023-06-28 16:02:04 +00:00
|
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/slice"
|
2018-04-15 19:47:53 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
type Row interface {
|
2018-04-24 18:13:22 +00:00
|
|
|
DisplayOrderIndex() int
|
|
|
|
SetDisplayOrderIndex(index int)
|
|
|
|
|
2018-04-15 19:47:53 +00:00
|
|
|
ColorizedColumns() []string
|
|
|
|
ColorizedSuffix() string
|
2018-05-11 23:48:05 +00:00
|
|
|
|
2018-04-24 18:13:22 +00:00
|
|
|
HideRowIfUnnecessary() bool
|
2018-05-11 23:48:05 +00:00
|
|
|
SetHideRowIfUnnecessary(value bool)
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
type ResourceRow interface {
|
|
|
|
Row
|
|
|
|
|
2018-04-24 18:13:22 +00:00
|
|
|
Step() engine.StepEventMetadata
|
2018-04-15 19:47:53 +00:00
|
|
|
SetStep(step engine.StepEventMetadata)
|
2018-08-02 04:48:14 +00:00
|
|
|
AddOutputStep(step engine.StepEventMetadata)
|
2018-04-15 19:47:53 +00:00
|
|
|
|
|
|
|
// The tick we were on when we created this row. Purely used for generating an
|
|
|
|
// ellipses to show progress for in-flight resources.
|
|
|
|
Tick() int
|
|
|
|
|
2018-08-02 04:48:14 +00:00
|
|
|
IsDone() bool
|
2018-04-15 19:47:53 +00:00
|
|
|
|
|
|
|
SetFailed()
|
|
|
|
|
|
|
|
DiagInfo() *DiagInfo
|
2020-02-13 23:16:46 +00:00
|
|
|
PolicyPayloads() []engine.PolicyViolationEventPayload
|
2023-10-09 18:31:17 +00:00
|
|
|
PolicyRemediationPayloads() []engine.PolicyRemediationEventPayload
|
2020-02-13 23:16:46 +00:00
|
|
|
|
2018-04-15 19:47:53 +00:00
|
|
|
RecordDiagEvent(diagEvent engine.Event)
|
2019-06-10 22:20:44 +00:00
|
|
|
RecordPolicyViolationEvent(diagEvent engine.Event)
|
2023-10-09 18:31:17 +00:00
|
|
|
RecordPolicyRemediationEvent(diagEvent engine.Event)
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Implementation of a Row, used for the header of the grid.
|
|
|
|
type headerRowData struct {
|
2018-04-17 06:41:00 +00:00
|
|
|
display *ProgressDisplay
|
|
|
|
columns []string
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
2018-04-24 18:13:22 +00:00
|
|
|
func (data *headerRowData) HideRowIfUnnecessary() bool {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2018-05-11 23:48:05 +00:00
|
|
|
func (data *headerRowData) SetHideRowIfUnnecessary(value bool) {
|
|
|
|
}
|
|
|
|
|
2018-04-24 18:13:22 +00:00
|
|
|
func (data *headerRowData) DisplayOrderIndex() int {
|
|
|
|
// sort the header before all other rows
|
|
|
|
return -1
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *headerRowData) SetDisplayOrderIndex(time int) {
|
|
|
|
// Nothing to do here. Header is always at the same index.
|
|
|
|
}
|
|
|
|
|
2018-04-15 19:47:53 +00:00
|
|
|
func (data *headerRowData) ColorizedColumns() []string {
|
|
|
|
if len(data.columns) == 0 {
|
|
|
|
header := func(msg string) string {
|
2019-09-26 01:42:30 +00:00
|
|
|
return columnHeader(msg)
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
2018-04-17 02:46:57 +00:00
|
|
|
var statusColumn string
|
|
|
|
if data.display.isPreview {
|
|
|
|
statusColumn = header("Plan")
|
|
|
|
} else {
|
|
|
|
statusColumn = header("Status")
|
|
|
|
}
|
2018-04-30 19:31:57 +00:00
|
|
|
data.columns = []string{"", header("Type"), header("Name"), statusColumn, header("Info")}
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return data.columns
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *headerRowData) ColorizedSuffix() string {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
2020-02-13 23:16:46 +00:00
|
|
|
// resourceRowData is the implementation of a row used for all the resource rows in the grid.
|
2018-04-15 19:47:53 +00:00
|
|
|
type resourceRowData struct {
|
2018-04-24 18:13:22 +00:00
|
|
|
displayOrderIndex int
|
|
|
|
|
2018-04-15 19:47:53 +00:00
|
|
|
display *ProgressDisplay
|
|
|
|
|
|
|
|
// The change that the engine wants apply to that resource.
|
2018-08-02 04:48:14 +00:00
|
|
|
step engine.StepEventMetadata
|
|
|
|
outputSteps []engine.StepEventMetadata
|
2018-04-15 19:47:53 +00:00
|
|
|
|
|
|
|
// The tick we were on when we created this row. Purely used for generating an
|
|
|
|
// ellipses to show progress for in-flight resources.
|
|
|
|
tick int
|
|
|
|
|
|
|
|
// If we failed this operation for any reason.
|
|
|
|
failed bool
|
|
|
|
|
2023-10-09 18:31:17 +00:00
|
|
|
diagInfo *DiagInfo
|
|
|
|
policyPayloads []engine.PolicyViolationEventPayload
|
|
|
|
policyRemediationPayloads []engine.PolicyRemediationEventPayload
|
2018-04-24 18:13:22 +00:00
|
|
|
|
|
|
|
// If this row should be hidden by default. We will hide unless we have any child nodes
|
|
|
|
// we need to show.
|
|
|
|
hideRowIfUnnecessary bool
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) DisplayOrderIndex() int {
|
|
|
|
// sort the header before all other rows
|
|
|
|
return data.displayOrderIndex
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) SetDisplayOrderIndex(index int) {
|
|
|
|
// only set this if it's the first time.
|
|
|
|
if data.displayOrderIndex == 0 {
|
|
|
|
data.displayOrderIndex = index
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) HideRowIfUnnecessary() bool {
|
|
|
|
return data.hideRowIfUnnecessary
|
|
|
|
}
|
|
|
|
|
2018-05-11 23:48:05 +00:00
|
|
|
func (data *resourceRowData) SetHideRowIfUnnecessary(value bool) {
|
|
|
|
data.hideRowIfUnnecessary = value
|
|
|
|
}
|
|
|
|
|
2018-04-24 18:13:22 +00:00
|
|
|
func (data *resourceRowData) Step() engine.StepEventMetadata {
|
|
|
|
return data.step
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) SetStep(step engine.StepEventMetadata) {
|
|
|
|
data.step = step
|
|
|
|
}
|
|
|
|
|
2018-08-02 04:48:14 +00:00
|
|
|
func (data *resourceRowData) AddOutputStep(step engine.StepEventMetadata) {
|
|
|
|
data.outputSteps = append(data.outputSteps, step)
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
2018-08-02 04:48:14 +00:00
|
|
|
func (data *resourceRowData) Tick() int {
|
|
|
|
return data.tick
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) Failed() bool {
|
|
|
|
return data.failed
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) SetFailed() {
|
|
|
|
data.failed = true
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) DiagInfo() *DiagInfo {
|
|
|
|
return data.diagInfo
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) RecordDiagEvent(event engine.Event) {
|
2020-07-17 06:52:31 +00:00
|
|
|
payload := event.Payload().(engine.DiagEventPayload)
|
2019-06-10 22:20:44 +00:00
|
|
|
data.recordDiagEventPayload(payload)
|
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2019-06-10 22:20:44 +00:00
|
|
|
func (data *resourceRowData) recordDiagEventPayload(payload engine.DiagEventPayload) {
|
|
|
|
diagInfo := data.diagInfo
|
2018-07-17 20:00:10 +00:00
|
|
|
diagInfo.LastDiag = &payload
|
|
|
|
|
2019-08-01 17:21:47 +00:00
|
|
|
if payload.Severity == diag.Error {
|
2018-05-07 22:11:52 +00:00
|
|
|
diagInfo.LastError = &payload
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
2018-05-07 22:11:52 +00:00
|
|
|
if diagInfo.StreamIDToDiagPayloads == nil {
|
|
|
|
diagInfo.StreamIDToDiagPayloads = make(map[int32][]engine.DiagEventPayload)
|
|
|
|
}
|
|
|
|
|
|
|
|
payloads := diagInfo.StreamIDToDiagPayloads[payload.StreamID]
|
|
|
|
payloads = append(payloads, payload)
|
|
|
|
diagInfo.StreamIDToDiagPayloads[payload.StreamID] = payloads
|
|
|
|
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
if !payload.Ephemeral {
|
2018-05-07 22:11:52 +00:00
|
|
|
switch payload.Severity {
|
|
|
|
case diag.Error:
|
|
|
|
diagInfo.ErrorCount++
|
|
|
|
case diag.Warning:
|
|
|
|
diagInfo.WarningCount++
|
|
|
|
case diag.Infoerr:
|
|
|
|
diagInfo.InfoCount++
|
|
|
|
case diag.Info:
|
|
|
|
diagInfo.InfoCount++
|
|
|
|
case diag.Debug:
|
|
|
|
diagInfo.DebugCount++
|
|
|
|
}
|
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
2024-04-07 12:19:17 +00:00
|
|
|
// PolicyPayloads returns the PolicyViolationEventPayload object associated with the resourceRowData.
|
2020-02-13 23:16:46 +00:00
|
|
|
func (data *resourceRowData) PolicyPayloads() []engine.PolicyViolationEventPayload {
|
|
|
|
return data.policyPayloads
|
|
|
|
}
|
2019-06-10 22:20:44 +00:00
|
|
|
|
2020-02-13 23:16:46 +00:00
|
|
|
// RecordPolicyViolationEvent records a policy event with the resourceRowData.
|
|
|
|
func (data *resourceRowData) RecordPolicyViolationEvent(event engine.Event) {
|
2020-07-17 06:52:31 +00:00
|
|
|
pePayload := event.Payload().(engine.PolicyViolationEventPayload)
|
2020-02-13 23:16:46 +00:00
|
|
|
data.policyPayloads = append(data.policyPayloads, pePayload)
|
2019-06-10 22:20:44 +00:00
|
|
|
}
|
|
|
|
|
2023-10-09 18:31:17 +00:00
|
|
|
// PolicyRemediationPayloads returns all policy remediation event payloads that have been registered.
|
|
|
|
func (data *resourceRowData) PolicyRemediationPayloads() []engine.PolicyRemediationEventPayload {
|
|
|
|
return data.policyRemediationPayloads
|
|
|
|
}
|
|
|
|
|
|
|
|
// RecordPolicyRemediationEvent records a policy remediation with the resourceRowData.
|
|
|
|
func (data *resourceRowData) RecordPolicyRemediationEvent(event engine.Event) {
|
|
|
|
tPayload := event.Payload().(engine.PolicyRemediationEventPayload)
|
|
|
|
data.policyRemediationPayloads = append(data.policyRemediationPayloads, tPayload)
|
|
|
|
}
|
|
|
|
|
2018-04-15 19:47:53 +00:00
|
|
|
type column int
|
|
|
|
|
|
|
|
const (
|
2018-04-30 19:31:57 +00:00
|
|
|
opColumn column = 0
|
|
|
|
typeColumn column = 1
|
|
|
|
nameColumn column = 2
|
|
|
|
statusColumn column = 3
|
|
|
|
infoColumn column = 4
|
2018-04-15 19:47:53 +00:00
|
|
|
)
|
|
|
|
|
2018-08-02 04:48:14 +00:00
|
|
|
func (data *resourceRowData) IsDone() bool {
|
|
|
|
if data.failed {
|
|
|
|
// consider a failed resource 'done'.
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
if data.display.done {
|
|
|
|
// if the display is done, then we're definitely done.
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
2019-06-18 22:38:32 +00:00
|
|
|
if isRootStack(data.step) {
|
|
|
|
// the root stack only becomes 'done' once the program has completed (i.e. the condition
|
|
|
|
// checked just above this). If the program is not finished, then always show the root
|
|
|
|
// stack as not done so the user sees "running..." presented for it.
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2018-08-02 04:48:14 +00:00
|
|
|
// We're done if we have the output-step for whatever step operation we're performing
|
|
|
|
return data.ContainsOutputsStep(data.step.Op)
|
|
|
|
}
|
|
|
|
|
2022-06-27 14:08:06 +00:00
|
|
|
func (data *resourceRowData) ContainsOutputsStep(op display.StepOp) bool {
|
2018-08-02 04:48:14 +00:00
|
|
|
for _, s := range data.outputSteps {
|
|
|
|
if s.Op == op {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2018-04-15 19:47:53 +00:00
|
|
|
func (data *resourceRowData) ColorizedSuffix() string {
|
2018-08-02 04:48:14 +00:00
|
|
|
if !data.IsDone() && data.display.isTerminal {
|
|
|
|
op := data.display.getStepOp(data.step)
|
2020-07-09 14:19:12 +00:00
|
|
|
if op != deploy.OpSame || isRootURN(data.step.URN) {
|
2018-04-24 18:13:22 +00:00
|
|
|
suffixes := data.display.suffixesArray
|
|
|
|
ellipses := suffixes[(data.tick+data.display.currentTick)%len(suffixes)]
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2022-06-27 14:08:06 +00:00
|
|
|
return deploy.ColorProgress(op) + ellipses + colors.Reset
|
2018-04-24 18:13:22 +00:00
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
func (data *resourceRowData) ColorizedColumns() []string {
|
|
|
|
step := data.step
|
|
|
|
|
2020-07-09 14:19:12 +00:00
|
|
|
urn := data.step.URN
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
if urn == "" {
|
|
|
|
// If we don't have a URN yet, mock parent it to the global stack.
|
2022-03-17 21:37:11 +00:00
|
|
|
urn = resource.DefaultRootStackURN(data.display.stack.Q(), data.display.proj)
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
2023-11-20 08:59:00 +00:00
|
|
|
name := urn.Name()
|
2023-04-13 21:33:18 +00:00
|
|
|
typ := urn.Type().DisplayName()
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2021-09-28 22:16:09 +00:00
|
|
|
done := data.IsDone()
|
|
|
|
|
2018-04-30 19:31:57 +00:00
|
|
|
columns := make([]string, 5)
|
2021-09-28 22:16:09 +00:00
|
|
|
columns[opColumn] = data.display.getStepOpLabel(step, done)
|
2018-04-15 19:47:53 +00:00
|
|
|
columns[typeColumn] = typ
|
|
|
|
columns[nameColumn] = name
|
|
|
|
|
|
|
|
diagInfo := data.diagInfo
|
|
|
|
|
2023-02-13 22:15:13 +00:00
|
|
|
failed := data.failed || diagInfo.ErrorCount > 0
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2023-02-13 22:15:13 +00:00
|
|
|
columns[statusColumn] = data.display.getStepStatus(step, done, failed)
|
2018-07-17 20:00:10 +00:00
|
|
|
columns[infoColumn] = data.getInfoColumn()
|
2018-04-15 19:47:53 +00:00
|
|
|
return columns
|
|
|
|
}
|
|
|
|
|
2023-02-13 22:15:13 +00:00
|
|
|
// addRetainStatusFlag adds a "[retain]" suffix to the input string if the resource is marked as
|
|
|
|
// RetainOnDelete and the step will discard the resource.
|
|
|
|
func addRetainStatusFlag(status string, step engine.StepEventMetadata) string {
|
2024-06-28 23:19:26 +00:00
|
|
|
if step.Old == nil || !step.Old.RetainOnDelete {
|
2023-02-13 22:15:13 +00:00
|
|
|
return status
|
|
|
|
}
|
|
|
|
|
|
|
|
switch step.Op {
|
|
|
|
// Deletes and Replacements should indicate retain on delete behavior as they can leave
|
|
|
|
// untracked resources in the environment.
|
|
|
|
case deploy.OpDelete, deploy.OpReplace, deploy.OpCreateReplacement, deploy.OpDeleteReplaced:
|
2023-04-13 22:04:53 +00:00
|
|
|
status += "[retain]"
|
2023-02-13 22:15:13 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return status
|
|
|
|
}
|
|
|
|
|
2018-07-17 20:00:10 +00:00
|
|
|
func (data *resourceRowData) getInfoColumn() string {
|
2018-04-15 19:47:53 +00:00
|
|
|
step := data.step
|
2019-07-12 18:12:01 +00:00
|
|
|
switch step.Op {
|
|
|
|
case deploy.OpCreateReplacement, deploy.OpDeleteReplaced:
|
2018-08-02 04:48:14 +00:00
|
|
|
// if we're doing a replacement, see if we can find a replace step that contains useful
|
|
|
|
// information to display.
|
|
|
|
for _, outputStep := range data.outputSteps {
|
|
|
|
if outputStep.Op == deploy.OpReplace {
|
|
|
|
step = outputStep
|
|
|
|
}
|
|
|
|
}
|
2019-07-12 18:12:01 +00:00
|
|
|
|
|
|
|
case deploy.OpImport, deploy.OpImportReplacement:
|
|
|
|
// If we're doing an import, see if we have the imported state to diff.
|
|
|
|
for _, outputStep := range data.outputSteps {
|
|
|
|
if outputStep.Op == step.Op {
|
|
|
|
step = outputStep
|
|
|
|
}
|
|
|
|
}
|
2018-08-02 04:48:14 +00:00
|
|
|
}
|
|
|
|
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
var diagMsg string
|
|
|
|
appendDiagMessage := func(msg string) {
|
|
|
|
if diagMsg != "" {
|
|
|
|
diagMsg += "; "
|
|
|
|
}
|
|
|
|
|
|
|
|
diagMsg += msg
|
|
|
|
}
|
|
|
|
|
2021-03-19 02:11:59 +00:00
|
|
|
changes := getDiffInfo(step, data.display.action)
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
if colors.Never.Colorize(changes) != "" {
|
|
|
|
appendDiagMessage("[" + changes + "]")
|
|
|
|
}
|
|
|
|
|
|
|
|
diagInfo := data.diagInfo
|
|
|
|
if data.display.done {
|
|
|
|
// If we are done, show a summary of how many messages were printed.
|
|
|
|
if c := diagInfo.ErrorCount; c > 0 {
|
|
|
|
appendDiagMessage(fmt.Sprintf("%d %s%s%s",
|
2018-09-24 20:49:14 +00:00
|
|
|
c, colors.SpecError, english.PluralWord(c, "error", ""), colors.Reset))
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
}
|
|
|
|
if c := diagInfo.WarningCount; c > 0 {
|
|
|
|
appendDiagMessage(fmt.Sprintf("%d %s%s%s",
|
2018-09-24 20:49:14 +00:00
|
|
|
c, colors.SpecWarning, english.PluralWord(c, "warning", ""), colors.Reset))
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
}
|
|
|
|
if c := diagInfo.InfoCount; c > 0 {
|
|
|
|
appendDiagMessage(fmt.Sprintf("%d %s%s%s",
|
2018-09-24 20:49:14 +00:00
|
|
|
c, colors.SpecInfo, english.PluralWord(c, "message", ""), colors.Reset))
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
}
|
|
|
|
if c := diagInfo.DebugCount; c > 0 {
|
|
|
|
appendDiagMessage(fmt.Sprintf("%d %s%s%s",
|
2018-09-24 20:49:14 +00:00
|
|
|
c, colors.SpecDebug, english.PluralWord(c, "debug", ""), colors.Reset))
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
}
|
|
|
|
} else {
|
2019-08-01 17:21:47 +00:00
|
|
|
// If we're not totally done, and we're in the tree-view, just print out the last error (if
|
|
|
|
// there is one) next to the status message. This is helpful for long running tasks to know
|
|
|
|
// something bad has happened. However, once done, we print the diagnostics at the bottom, so we don't
|
|
|
|
// need to show this.
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
//
|
2019-08-01 17:21:47 +00:00
|
|
|
// if we're not in the tree-view (i.e. non-interactive mode), then we want to print out
|
|
|
|
// whatever the last diagnostics was that we got. This way, as we're hearing about
|
|
|
|
// diagnostic events, we're always printing out the last one.
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2019-08-01 17:21:47 +00:00
|
|
|
diagnostic := data.diagInfo.LastDiag
|
|
|
|
if data.display.isTerminal && data.diagInfo.LastError != nil {
|
|
|
|
diagnostic = data.diagInfo.LastError
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if diagnostic != nil {
|
|
|
|
eventMsg := data.display.renderProgressDiagEvent(*diagnostic, true /*includePrefix:*/)
|
|
|
|
if eventMsg != "" {
|
|
|
|
appendDiagMessage(eventMsg)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
newLineIndex := strings.Index(diagMsg, "\n")
|
|
|
|
if newLineIndex >= 0 {
|
|
|
|
diagMsg = diagMsg[0:newLineIndex]
|
|
|
|
}
|
|
|
|
|
|
|
|
return diagMsg
|
|
|
|
}
|
|
|
|
|
2021-03-19 02:11:59 +00:00
|
|
|
func getDiffInfo(step engine.StepEventMetadata, action apitype.UpdateKind) string {
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
changesBuf := &bytes.Buffer{}
|
Implement first-class providers. (#1695)
### First-Class Providers
These changes implement support for first-class providers. First-class
providers are provider plugins that are exposed as resources via the
Pulumi programming model so that they may be explicitly and multiply
instantiated. Each instance of a provider resource may be configured
differently, and configuration parameters may be source from the
outputs of other resources.
### Provider Plugin Changes
In order to accommodate the need to verify and diff provider
configuration and configure providers without complete configuration
information, these changes adjust the high-level provider plugin
interface. Two new methods for validating a provider's configuration
and diffing changes to the same have been added (`CheckConfig` and
`DiffConfig`, respectively), and the type of the configuration bag
accepted by `Configure` has been changed to a `PropertyMap`.
These changes have not yet been reflected in the provider plugin gRPC
interface. We will do this in a set of follow-up changes. Until then,
these methods are implemented by adapters:
- `CheckConfig` validates that all configuration parameters are string
or unknown properties. This is necessary because existing plugins
only accept string-typed configuration values.
- `DiffConfig` either returns "never replace" if all configuration
values are known or "must replace" if any configuration value is
unknown. The justification for this behavior is given
[here](https://github.com/pulumi/pulumi/pull/1695/files#diff-a6cd5c7f337665f5bb22e92ca5f07537R106)
- `Configure` converts the config bag to a legacy config map and
configures the provider plugin if all config values are known. If any
config value is unknown, the underlying plugin is not configured and
the provider may only perform `Check`, `Read`, and `Invoke`, all of
which return empty results. We justify this behavior becuase it is
only possible during a preview and provides the best experience we
can manage with the existing gRPC interface.
### Resource Model Changes
Providers are now exposed as resources that participate in a stack's
dependency graph. Like other resources, they are explicitly created,
may have multiple instances, and may have dependencies on other
resources. Providers are referred to using provider references, which
are a combination of the provider's URN and its ID. This design
addresses the need during a preview to refer to providers that have not
yet been physically created and therefore have no ID.
All custom resources that are not themselves providers must specify a
single provider via a provider reference. The named provider will be
used to manage that resource's CRUD operations. If a resource's
provider reference changes, the resource must be replaced. Though its
URN is not present in the resource's dependency list, the provider
should be treated as a dependency of the resource when topologically
sorting the dependency graph.
Finally, `Invoke` operations must now specify a provider to use for the
invocation via a provider reference.
### Engine Changes
First-class providers support requires a few changes to the engine:
- The engine must have some way to map from provider references to
provider plugins. It must be possible to add providers from a stack's
checkpoint to this map and to register new/updated providers during
the execution of a plan in response to CRUD operations on provider
resources.
- In order to support updating existing stacks using existing Pulumi
programs that may not explicitly instantiate providers, the engine
must be able to manage the "default" providers for each package
referenced by a checkpoint or Pulumi program. The configuration for
a "default" provider is taken from the stack's configuration data.
The former need is addressed by adding a provider registry type that is
responsible for managing all of the plugins required by a plan. In
addition to loading plugins froma checkpoint and providing the ability
to map from a provider reference to a provider plugin, this type serves
as the provider plugin for providers themselves (i.e. it is the
"provider provider").
The latter need is solved via two relatively self-contained changes to
plan setup and the eval source.
During plan setup, the old checkpoint is scanned for custom resources
that do not have a provider reference in order to compute the set of
packages that require a default provider. Once this set has been
computed, the required default provider definitions are conjured and
prepended to the checkpoint's resource list. Each resource that
requires a default provider is then updated to refer to the default
provider for its package.
While an eval source is running, each custom resource registration,
resource read, and invoke that does not name a provider is trapped
before being returned by the source iterator. If no default provider
for the appropriate package has been registered, the eval source
synthesizes an appropriate registration, waits for it to complete, and
records the registered provider's reference. This reference is injected
into the original request, which is then processed as usual. If a
default provider was already registered, the recorded reference is
used and no new registration occurs.
### SDK Changes
These changes only expose first-class providers from the Node.JS SDK.
- A new abstract class, `ProviderResource`, can be subclassed and used
to instantiate first-class providers.
- A new field in `ResourceOptions`, `provider`, can be used to supply
a particular provider instance to manage a `CustomResource`'s CRUD
operations.
- A new type, `InvokeOptions`, can be used to specify options that
control the behavior of a call to `pulumi.runtime.invoke`. This type
includes a `provider` field that is analogous to
`ResourceOptions.provider`.
2018-08-07 00:50:29 +00:00
|
|
|
if step.Old != nil && step.New != nil {
|
|
|
|
var diff *resource.ObjectDiff
|
2024-05-02 12:28:43 +00:00
|
|
|
// An OpSame might have a diff due to metadata changes (e.g. protect) but we should never print a property diff,
|
|
|
|
// even if the properties appear to have changed. See https://github.com/pulumi/pulumi/issues/15944 for context.
|
|
|
|
if step.Op != deploy.OpSame {
|
|
|
|
if step.DetailedDiff != nil {
|
Change `pulumi refresh` to report diff relative to desired state instead of relative to only output changes (#16146)
Presently, the behaviour of diffing during refresh steps is incomplete,
returning only an "output diff" that presents the changes in outputs.
This commit changes refresh steps so that:
* they compute a diff similar to the one that would be computed if a
`preview` were run immediately after the refresh, which is more
typically what users expect and want; and
* `IgnoreChanges` resource options are respected when performing the new
desired-state diffs, so that property additions or changes reported by a
refresh can be ignored.
In particular, `IgnoreChanges` can now be used to acknowledge that part
or all of a resource may change in the provider, but the user is OK with
this and doesn't want to be notified about it during a refresh.
Importantly, this means that the diff won't be reported, but also that
the changes won't be applied to state.
The implementation covers the following:
* A diff is computed using the inputs from the program and then
inverting the result, since in the case of a refresh the diff is being
driven by the provider side and not the program. This doesn't change
what is stored back into the state, but it does produce a diff that is
more aligned with the "true changes to the desired state".
* `IgnoreChanges` resource options are now stored in state, so that this
information can be used in refresh operations that do not have access
to/run the program.
* In the context of a refresh operation, `IgnoreChanges` applies to
*both* input and output properties. This differs from the behaviour of a
normal update operation, where `IgnoreChanges` only considers input
properties.
* The special `"*"` value for `IgnoreChanges` can be used to ignore all
properties. It _also_ ignores the case where the resource cannot be
found in the provider, and instead keeps the resource intact in state
with its existing input and output properties.
Because the program is not run for refresh operations, `IgnoreChanges`
options must be applied separately before a refresh takes place. This
can be accomplished using e.g. a `pulumi up` that applies the options
prior to a refresh. We should investigate perhaps providing a `pulumi
state set ...`-like CLI to make these sorts of changes directly to a
state.
For use cases relying on the legacy refresh diff provider, the
`PULUMI_USE_LEGACY_REFRESH_DIFF` environment variable can be set, which
will disable desired-state diff computation. We only need to perform
checks in `RefreshStep.{ResultOp,Apply}`, since downstream code will
work correctly based on the presence or absence of a `DetailedDiff` in
the step.
### Notes
- https://github.com/pulumi/pulumi/issues/16144 affects some of these
cases - though its technically orthogonal
- https://github.com/pulumi/pulumi/issues/11279 is another technically
orthogonal issue that many providers (at least TFBridge ones) - do not
report back changes to input properties on Read when the input property
(or property path) was missing on the inputs. This is again technically
orthogonal - but leads to cases that appear "wrong" in terms of what is
stored back into the state still - though the same as before this
change.
- Azure Native doesn't seem to handle `ignoreChanges` passed to Diff, so
the ability to ignore changes on refresh doesn't currently work for
Azure Native.
### Fixes
* Fixes #16072
* Fixes #16278
* Fixes #16334
* Not quite #12346, but likely replaces the need for that
Co-authored-by: Will Jones <will@sacharissa.co.uk>
2024-06-12 16:17:05 +00:00
|
|
|
diff = engine.TranslateDetailedDiff(&step, false)
|
2024-05-02 12:28:43 +00:00
|
|
|
} else if step.Old.Inputs != nil && step.New.Inputs != nil {
|
|
|
|
diff = step.Old.Inputs.Diff(step.New.Inputs)
|
2018-08-23 00:52:46 +00:00
|
|
|
}
|
Implement first-class providers. (#1695)
### First-Class Providers
These changes implement support for first-class providers. First-class
providers are provider plugins that are exposed as resources via the
Pulumi programming model so that they may be explicitly and multiply
instantiated. Each instance of a provider resource may be configured
differently, and configuration parameters may be source from the
outputs of other resources.
### Provider Plugin Changes
In order to accommodate the need to verify and diff provider
configuration and configure providers without complete configuration
information, these changes adjust the high-level provider plugin
interface. Two new methods for validating a provider's configuration
and diffing changes to the same have been added (`CheckConfig` and
`DiffConfig`, respectively), and the type of the configuration bag
accepted by `Configure` has been changed to a `PropertyMap`.
These changes have not yet been reflected in the provider plugin gRPC
interface. We will do this in a set of follow-up changes. Until then,
these methods are implemented by adapters:
- `CheckConfig` validates that all configuration parameters are string
or unknown properties. This is necessary because existing plugins
only accept string-typed configuration values.
- `DiffConfig` either returns "never replace" if all configuration
values are known or "must replace" if any configuration value is
unknown. The justification for this behavior is given
[here](https://github.com/pulumi/pulumi/pull/1695/files#diff-a6cd5c7f337665f5bb22e92ca5f07537R106)
- `Configure` converts the config bag to a legacy config map and
configures the provider plugin if all config values are known. If any
config value is unknown, the underlying plugin is not configured and
the provider may only perform `Check`, `Read`, and `Invoke`, all of
which return empty results. We justify this behavior becuase it is
only possible during a preview and provides the best experience we
can manage with the existing gRPC interface.
### Resource Model Changes
Providers are now exposed as resources that participate in a stack's
dependency graph. Like other resources, they are explicitly created,
may have multiple instances, and may have dependencies on other
resources. Providers are referred to using provider references, which
are a combination of the provider's URN and its ID. This design
addresses the need during a preview to refer to providers that have not
yet been physically created and therefore have no ID.
All custom resources that are not themselves providers must specify a
single provider via a provider reference. The named provider will be
used to manage that resource's CRUD operations. If a resource's
provider reference changes, the resource must be replaced. Though its
URN is not present in the resource's dependency list, the provider
should be treated as a dependency of the resource when topologically
sorting the dependency graph.
Finally, `Invoke` operations must now specify a provider to use for the
invocation via a provider reference.
### Engine Changes
First-class providers support requires a few changes to the engine:
- The engine must have some way to map from provider references to
provider plugins. It must be possible to add providers from a stack's
checkpoint to this map and to register new/updated providers during
the execution of a plan in response to CRUD operations on provider
resources.
- In order to support updating existing stacks using existing Pulumi
programs that may not explicitly instantiate providers, the engine
must be able to manage the "default" providers for each package
referenced by a checkpoint or Pulumi program. The configuration for
a "default" provider is taken from the stack's configuration data.
The former need is addressed by adding a provider registry type that is
responsible for managing all of the plugins required by a plan. In
addition to loading plugins froma checkpoint and providing the ability
to map from a provider reference to a provider plugin, this type serves
as the provider plugin for providers themselves (i.e. it is the
"provider provider").
The latter need is solved via two relatively self-contained changes to
plan setup and the eval source.
During plan setup, the old checkpoint is scanned for custom resources
that do not have a provider reference in order to compute the set of
packages that require a default provider. Once this set has been
computed, the required default provider definitions are conjured and
prepended to the checkpoint's resource list. Each resource that
requires a default provider is then updated to refer to the default
provider for its package.
While an eval source is running, each custom resource registration,
resource read, and invoke that does not name a provider is trapped
before being returned by the source iterator. If no default provider
for the appropriate package has been registered, the eval source
synthesizes an appropriate registration, waits for it to complete, and
records the registered provider's reference. This reference is injected
into the original request, which is then processed as usual. If a
default provider was already registered, the recorded reference is
used and no new registration occurs.
### SDK Changes
These changes only expose first-class providers from the Node.JS SDK.
- A new abstract class, `ProviderResource`, can be subclassed and used
to instantiate first-class providers.
- A new field in `ResourceOptions`, `provider`, can be used to supply
a particular provider instance to manage a `CustomResource`'s CRUD
operations.
- A new type, `InvokeOptions`, can be used to specify options that
control the behavior of a call to `pulumi.runtime.invoke`. This type
includes a `provider` field that is analogous to
`ResourceOptions.provider`.
2018-08-07 00:50:29 +00:00
|
|
|
}
|
2018-09-17 22:03:06 +00:00
|
|
|
|
|
|
|
// Show a diff if either `provider` or `protect` changed; they might not show a diff via inputs or outputs, but
|
|
|
|
// it is still useful to show that these changed in output.
|
|
|
|
recordMetadataDiff := func(name string, old, new resource.PropertyValue) {
|
|
|
|
if old != new {
|
|
|
|
if diff == nil {
|
|
|
|
diff = &resource.ObjectDiff{
|
|
|
|
Adds: make(resource.PropertyMap),
|
|
|
|
Deletes: make(resource.PropertyMap),
|
|
|
|
Sames: make(resource.PropertyMap),
|
|
|
|
Updates: make(map[resource.PropertyKey]resource.ValueDiff),
|
|
|
|
}
|
Implement first-class providers. (#1695)
### First-Class Providers
These changes implement support for first-class providers. First-class
providers are provider plugins that are exposed as resources via the
Pulumi programming model so that they may be explicitly and multiply
instantiated. Each instance of a provider resource may be configured
differently, and configuration parameters may be source from the
outputs of other resources.
### Provider Plugin Changes
In order to accommodate the need to verify and diff provider
configuration and configure providers without complete configuration
information, these changes adjust the high-level provider plugin
interface. Two new methods for validating a provider's configuration
and diffing changes to the same have been added (`CheckConfig` and
`DiffConfig`, respectively), and the type of the configuration bag
accepted by `Configure` has been changed to a `PropertyMap`.
These changes have not yet been reflected in the provider plugin gRPC
interface. We will do this in a set of follow-up changes. Until then,
these methods are implemented by adapters:
- `CheckConfig` validates that all configuration parameters are string
or unknown properties. This is necessary because existing plugins
only accept string-typed configuration values.
- `DiffConfig` either returns "never replace" if all configuration
values are known or "must replace" if any configuration value is
unknown. The justification for this behavior is given
[here](https://github.com/pulumi/pulumi/pull/1695/files#diff-a6cd5c7f337665f5bb22e92ca5f07537R106)
- `Configure` converts the config bag to a legacy config map and
configures the provider plugin if all config values are known. If any
config value is unknown, the underlying plugin is not configured and
the provider may only perform `Check`, `Read`, and `Invoke`, all of
which return empty results. We justify this behavior becuase it is
only possible during a preview and provides the best experience we
can manage with the existing gRPC interface.
### Resource Model Changes
Providers are now exposed as resources that participate in a stack's
dependency graph. Like other resources, they are explicitly created,
may have multiple instances, and may have dependencies on other
resources. Providers are referred to using provider references, which
are a combination of the provider's URN and its ID. This design
addresses the need during a preview to refer to providers that have not
yet been physically created and therefore have no ID.
All custom resources that are not themselves providers must specify a
single provider via a provider reference. The named provider will be
used to manage that resource's CRUD operations. If a resource's
provider reference changes, the resource must be replaced. Though its
URN is not present in the resource's dependency list, the provider
should be treated as a dependency of the resource when topologically
sorting the dependency graph.
Finally, `Invoke` operations must now specify a provider to use for the
invocation via a provider reference.
### Engine Changes
First-class providers support requires a few changes to the engine:
- The engine must have some way to map from provider references to
provider plugins. It must be possible to add providers from a stack's
checkpoint to this map and to register new/updated providers during
the execution of a plan in response to CRUD operations on provider
resources.
- In order to support updating existing stacks using existing Pulumi
programs that may not explicitly instantiate providers, the engine
must be able to manage the "default" providers for each package
referenced by a checkpoint or Pulumi program. The configuration for
a "default" provider is taken from the stack's configuration data.
The former need is addressed by adding a provider registry type that is
responsible for managing all of the plugins required by a plan. In
addition to loading plugins froma checkpoint and providing the ability
to map from a provider reference to a provider plugin, this type serves
as the provider plugin for providers themselves (i.e. it is the
"provider provider").
The latter need is solved via two relatively self-contained changes to
plan setup and the eval source.
During plan setup, the old checkpoint is scanned for custom resources
that do not have a provider reference in order to compute the set of
packages that require a default provider. Once this set has been
computed, the required default provider definitions are conjured and
prepended to the checkpoint's resource list. Each resource that
requires a default provider is then updated to refer to the default
provider for its package.
While an eval source is running, each custom resource registration,
resource read, and invoke that does not name a provider is trapped
before being returned by the source iterator. If no default provider
for the appropriate package has been registered, the eval source
synthesizes an appropriate registration, waits for it to complete, and
records the registered provider's reference. This reference is injected
into the original request, which is then processed as usual. If a
default provider was already registered, the recorded reference is
used and no new registration occurs.
### SDK Changes
These changes only expose first-class providers from the Node.JS SDK.
- A new abstract class, `ProviderResource`, can be subclassed and used
to instantiate first-class providers.
- A new field in `ResourceOptions`, `provider`, can be used to supply
a particular provider instance to manage a `CustomResource`'s CRUD
operations.
- A new type, `InvokeOptions`, can be used to specify options that
control the behavior of a call to `pulumi.runtime.invoke`. This type
includes a `provider` field that is analogous to
`ResourceOptions.provider`.
2018-08-07 00:50:29 +00:00
|
|
|
}
|
2018-09-17 22:03:06 +00:00
|
|
|
|
|
|
|
diff.Updates[resource.PropertyKey(name)] = resource.ValueDiff{Old: old, New: new}
|
Implement first-class providers. (#1695)
### First-Class Providers
These changes implement support for first-class providers. First-class
providers are provider plugins that are exposed as resources via the
Pulumi programming model so that they may be explicitly and multiply
instantiated. Each instance of a provider resource may be configured
differently, and configuration parameters may be source from the
outputs of other resources.
### Provider Plugin Changes
In order to accommodate the need to verify and diff provider
configuration and configure providers without complete configuration
information, these changes adjust the high-level provider plugin
interface. Two new methods for validating a provider's configuration
and diffing changes to the same have been added (`CheckConfig` and
`DiffConfig`, respectively), and the type of the configuration bag
accepted by `Configure` has been changed to a `PropertyMap`.
These changes have not yet been reflected in the provider plugin gRPC
interface. We will do this in a set of follow-up changes. Until then,
these methods are implemented by adapters:
- `CheckConfig` validates that all configuration parameters are string
or unknown properties. This is necessary because existing plugins
only accept string-typed configuration values.
- `DiffConfig` either returns "never replace" if all configuration
values are known or "must replace" if any configuration value is
unknown. The justification for this behavior is given
[here](https://github.com/pulumi/pulumi/pull/1695/files#diff-a6cd5c7f337665f5bb22e92ca5f07537R106)
- `Configure` converts the config bag to a legacy config map and
configures the provider plugin if all config values are known. If any
config value is unknown, the underlying plugin is not configured and
the provider may only perform `Check`, `Read`, and `Invoke`, all of
which return empty results. We justify this behavior becuase it is
only possible during a preview and provides the best experience we
can manage with the existing gRPC interface.
### Resource Model Changes
Providers are now exposed as resources that participate in a stack's
dependency graph. Like other resources, they are explicitly created,
may have multiple instances, and may have dependencies on other
resources. Providers are referred to using provider references, which
are a combination of the provider's URN and its ID. This design
addresses the need during a preview to refer to providers that have not
yet been physically created and therefore have no ID.
All custom resources that are not themselves providers must specify a
single provider via a provider reference. The named provider will be
used to manage that resource's CRUD operations. If a resource's
provider reference changes, the resource must be replaced. Though its
URN is not present in the resource's dependency list, the provider
should be treated as a dependency of the resource when topologically
sorting the dependency graph.
Finally, `Invoke` operations must now specify a provider to use for the
invocation via a provider reference.
### Engine Changes
First-class providers support requires a few changes to the engine:
- The engine must have some way to map from provider references to
provider plugins. It must be possible to add providers from a stack's
checkpoint to this map and to register new/updated providers during
the execution of a plan in response to CRUD operations on provider
resources.
- In order to support updating existing stacks using existing Pulumi
programs that may not explicitly instantiate providers, the engine
must be able to manage the "default" providers for each package
referenced by a checkpoint or Pulumi program. The configuration for
a "default" provider is taken from the stack's configuration data.
The former need is addressed by adding a provider registry type that is
responsible for managing all of the plugins required by a plan. In
addition to loading plugins froma checkpoint and providing the ability
to map from a provider reference to a provider plugin, this type serves
as the provider plugin for providers themselves (i.e. it is the
"provider provider").
The latter need is solved via two relatively self-contained changes to
plan setup and the eval source.
During plan setup, the old checkpoint is scanned for custom resources
that do not have a provider reference in order to compute the set of
packages that require a default provider. Once this set has been
computed, the required default provider definitions are conjured and
prepended to the checkpoint's resource list. Each resource that
requires a default provider is then updated to refer to the default
provider for its package.
While an eval source is running, each custom resource registration,
resource read, and invoke that does not name a provider is trapped
before being returned by the source iterator. If no default provider
for the appropriate package has been registered, the eval source
synthesizes an appropriate registration, waits for it to complete, and
records the registered provider's reference. This reference is injected
into the original request, which is then processed as usual. If a
default provider was already registered, the recorded reference is
used and no new registration occurs.
### SDK Changes
These changes only expose first-class providers from the Node.JS SDK.
- A new abstract class, `ProviderResource`, can be subclassed and used
to instantiate first-class providers.
- A new field in `ResourceOptions`, `provider`, can be used to supply
a particular provider instance to manage a `CustomResource`'s CRUD
operations.
- A new type, `InvokeOptions`, can be used to specify options that
control the behavior of a call to `pulumi.runtime.invoke`. This type
includes a `provider` field that is analogous to
`ResourceOptions.provider`.
2018-08-07 00:50:29 +00:00
|
|
|
}
|
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2018-09-17 22:03:06 +00:00
|
|
|
recordMetadataDiff("provider",
|
|
|
|
resource.NewStringProperty(step.Old.Provider), resource.NewStringProperty(step.New.Provider))
|
|
|
|
recordMetadataDiff("protect",
|
|
|
|
resource.NewBoolProperty(step.Old.Protect), resource.NewBoolProperty(step.New.Protect))
|
|
|
|
|
2023-10-09 18:31:17 +00:00
|
|
|
writeShortDiff(changesBuf, diff, step.Diffs)
|
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2023-10-09 18:31:17 +00:00
|
|
|
fprintIgnoreError(changesBuf, colors.Reset)
|
|
|
|
return changesBuf.String()
|
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2023-10-09 18:31:17 +00:00
|
|
|
func writeShortDiff(changesBuf io.StringWriter, diff *resource.ObjectDiff, include []resource.PropertyKey) {
|
|
|
|
if diff != nil {
|
|
|
|
writeString(changesBuf, "diff: ")
|
|
|
|
|
|
|
|
updates := make(resource.PropertyMap)
|
|
|
|
for k := range diff.Updates {
|
|
|
|
updates[k] = resource.PropertyValue{}
|
|
|
|
}
|
|
|
|
|
|
|
|
filteredKeys := func(m resource.PropertyMap) []string {
|
|
|
|
keys := slice.Prealloc[string](len(m))
|
|
|
|
for k := range m {
|
|
|
|
keys = append(keys, string(k))
|
2019-03-07 00:41:19 +00:00
|
|
|
}
|
2023-10-09 18:31:17 +00:00
|
|
|
return keys
|
|
|
|
}
|
|
|
|
if len(include) > 0 {
|
|
|
|
includeSet := make(map[resource.PropertyKey]bool)
|
|
|
|
for _, k := range include {
|
|
|
|
includeSet[k] = true
|
|
|
|
}
|
|
|
|
filteredKeys = func(m resource.PropertyMap) []string {
|
|
|
|
var filteredKeys []string
|
|
|
|
for k := range m {
|
|
|
|
if includeSet[k] {
|
|
|
|
filteredKeys = append(filteredKeys, string(k))
|
2019-03-07 00:41:19 +00:00
|
|
|
}
|
|
|
|
}
|
2023-10-09 18:31:17 +00:00
|
|
|
return filteredKeys
|
2019-03-07 00:41:19 +00:00
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
2023-10-09 18:31:17 +00:00
|
|
|
writePropertyKeys(changesBuf, filteredKeys(diff.Adds), deploy.OpCreate)
|
|
|
|
writePropertyKeys(changesBuf, filteredKeys(diff.Deletes), deploy.OpDelete)
|
|
|
|
writePropertyKeys(changesBuf, filteredKeys(updates), deploy.OpUpdate)
|
|
|
|
}
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
|
2022-06-27 14:08:06 +00:00
|
|
|
func writePropertyKeys(b io.StringWriter, keys []string, op display.StepOp) {
|
2019-03-07 00:41:19 +00:00
|
|
|
if len(keys) > 0 {
|
2022-06-27 14:08:06 +00:00
|
|
|
writeString(b, strings.Trim(deploy.Prefix(op, true /*done*/), " "))
|
2018-07-17 20:00:10 +00:00
|
|
|
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
sort.Strings(keys)
|
2018-07-17 20:00:10 +00:00
|
|
|
|
2019-03-07 00:41:19 +00:00
|
|
|
for index, k := range keys {
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
if index != 0 {
|
|
|
|
writeString(b, ",")
|
2018-07-17 20:00:10 +00:00
|
|
|
}
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
writeString(b, k)
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|
|
|
|
|
Make a smattering of CLI UX improvements
Since I was digging around over the weekend after the change to move
away from light black, and the impact it had on less important
information showing more prominently than it used to, I took a step
back and did a deeper tidying up of things. Another side goal of this
exercise was to be a little more respectful of terminal width; when
we could say things with fewer words, I did so.
* Stylize the preview/update summary differently, so that it stands
out as a section. Also highlight the total changes with bold -- it
turns out this has a similar effect to the bright white colorization,
just without the negative effects on e.g. white terminals.
* Eliminate some verbosity in the phrasing of change summaries.
* Make all heading sections stylized consistently. This includes
the color (bright magenta) and the vertical spacing (always a newline
separating headings). We were previously inconsistent on this (e.g.,
outputs were under "---outputs---"). Now the headings are:
Previewing (etc), Diagnostics, Outputs, Resources, Duration, and Permalink.
* Fix an issue where we'd parent things to "global" until the stack
object later showed up. Now we'll simply mock up a stack resource.
* Don't show messages like "no change" or "unchanged". Prior to the
light black removal, these faded into the background of the terminal.
Now they just clutter up the display. Similar to the elision of "*"
for OpSames in a prior commit, just leave these out. Now anything
that's written is actually a meaningful status for the user to note.
* Don't show the "3 info messages," etc. summaries in the Info column
while an update is ongoing. Instead, just show the latest line. This
is more respectful of width -- I often find that the important
messages scroll off the right of my screen before this change.
For discussion:
- I actually wonder if we should eliminate the summary
altogether and always just show the latest line. Or even
blank it out. The summary feels better suited for the
Diagnostics section, and the Status concisely tells us
how a resource's update ended up (failed, succeeded, etc).
- Similarly, I question the idea of showing only the "worst"
message. I'd vote for always showing the latest, and again
leaving it to the Status column for concisely telling the
user about the final state a resource ended up in.
* Stop prepending "info: " to every stdout/stderr message. It adds
no value, clutters up the display, and worsens horizontal usage.
* Lessen the verbosity of update headline messages, so we now instead
of e.g. "Previewing update of stack 'x':", we just say
"Previewing update (x):".
* Eliminate vertical whitespace in the Diagnostics section. Every
independent console.out previously was separated by an entire newline,
which made the section look cluttered to my eyes. These are just
streams of logs, there's no reason for the extra newlines.
* Colorize the resource headers in the Diagnostic section light blue.
Note that this will change various test baselines, which I will
update next. I didn't want those in the same commit.
2018-09-24 15:31:19 +00:00
|
|
|
writeString(b, colors.Reset)
|
2018-04-17 06:41:00 +00:00
|
|
|
}
|
2018-04-15 19:47:53 +00:00
|
|
|
}
|