The --expect-no-changes flag checks for output diffs

changelog/pending/20240410--cli-engine--fixes-15564-expect-no-changes-now-causes-pulumi-cli-to-fail-if-the-only-changes-are-output-changes.yaml

@@ -0,0 +1,4 @@
+changes:
+- type: fix
+ scope: cli/engine
+ description: "Make --expect-no-changes fail even if the only changes are output changes"

pkg/backend/display/progress.go

@@ -1137,6 +1137,8 @@ func (display *ProgressDisplay) getStepDoneDescription(step engine.StepEventMeta
  opText = "discarding failed"
  case deploy.OpImport, deploy.OpImportReplacement:
  opText = "importing failed"
+ case deploy.OpOutputChange:
+ opText = "changing output failed"
  default:
  contract.Failf("Unrecognized resource step op: %v", op)
  return ""
@@ -1171,6 +1173,8 @@ func (display *ProgressDisplay) getStepDoneDescription(step engine.StepEventMeta
  opText = "imported"
  case deploy.OpImportReplacement:
  opText = "imported replacement"
+ case deploy.OpOutputChange:
+ opText = "output changed"
  default:
  contract.Failf("Unrecognized resource step op: %v", op)
  return ""

pkg/backend/httpstate/snapshot_test.go

@@ -37,6 +37,7 @@ import (
  "github.com/stretchr/testify/require"
 
  "github.com/pulumi/pulumi/pkg/v3/backend/httpstate/client"
+ "github.com/pulumi/pulumi/pkg/v3/display"
  "github.com/pulumi/pulumi/pkg/v3/engine"
  "github.com/pulumi/pulumi/pkg/v3/engine/lifecycletest"
  "github.com/pulumi/pulumi/pkg/v3/resource/deploy"
@@ -316,6 +317,7 @@ func generateSnapshots(t testing.TB, r *rand.Rand, resourceCount, resourcePayloa
  _ deploy.Target,
  entries engine.JournalEntries,
  _ []engine.Event,
+ _ display.ResourceChanges,
  _ error,
  ) error {
  journalEntries = entries

pkg/cmd/pulumi/stack_history.go

@@ -13,6 +13,7 @@ import (
 
  "github.com/pulumi/pulumi/pkg/v3/backend"
  "github.com/pulumi/pulumi/pkg/v3/backend/display"
+ "github.com/pulumi/pulumi/pkg/v3/resource/deploy"
  "github.com/pulumi/pulumi/sdk/v3/go/common/diag/colors"
  "github.com/pulumi/pulumi/sdk/v3/go/common/resource/config"
  "github.com/pulumi/pulumi/sdk/v3/go/common/util/cmdutil"
@@ -162,7 +163,11 @@ func displayUpdatesJSON(updates []backend.UpdateInfo, decrypter config.Decrypter
  info.EndTime = makeStringRef(time.Unix(update.EndTime, 0).UTC().Format(timeFormat))
  resourceChanges := make(map[string]int)
  for k, v := range update.ResourceChanges {
- resourceChanges[string(k)] = v
+ // Filter out the the OpOutputChange events because they are pseudo
+ // events that shouldn't be included in the stack history
+ if k != deploy.OpOutputChange {
+ resourceChanges[string(k)] = v
+ }
  }
  info.ResourceChanges = &resourceChanges
  }

pkg/engine/lifecycletest/alias_test.go

@@ -189,7 +189,7 @@ func createUpdateProgramWithResourceFuncForAliasTests(
  Op: Update,
  ExpectFailure: expectFailure,
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- events []Event, err error,
+ events []Event, changes display.ResourceChanges, err error,
  ) error {
  for _, event := range events {
  if event.Type == ResourcePreEvent {
@@ -1595,7 +1595,7 @@ func TestParentAlias(t *testing.T) {
  firstRun = false
  snap, err = TestOp(Update).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
  func(project workspace.Project, target deploy.Target,
- entries JournalEntries, events []Event, err error,
+ entries JournalEntries, events []Event, changes display.ResourceChanges, err error,
  ) error {
  for _, entry := range entries {
  assert.Equal(t, deploy.OpSame, entry.Step.Op())
@@ -1669,7 +1669,7 @@ func TestEmptyParentAlias(t *testing.T) {
  firstRun = false
  snap, err = TestOp(Update).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
  func(project workspace.Project, target deploy.Target,
- entries JournalEntries, events []Event, err error,
+ entries JournalEntries, events []Event, changes display.ResourceChanges, err error,
  ) error {
  for _, entry := range entries {
  assert.Equal(t, deploy.OpSame, entry.Step.Op())

pkg/engine/lifecycletest/analyzer_test.go

@@ -7,6 +7,7 @@ import (
  "testing"
 
  "github.com/blang/semver"
+ "github.com/pulumi/pulumi/pkg/v3/display"
  . "github.com/pulumi/pulumi/pkg/v3/engine" //nolint:revive
  "github.com/pulumi/pulumi/pkg/v3/resource/deploy"
  "github.com/pulumi/pulumi/pkg/v3/resource/deploy/deploytest"
@@ -375,7 +376,7 @@ func TestSimpleAnalyzeResourceFailureRemediateDowngradedToMandatory(t *testing.T
  SkipPreview: true,
  ExpectFailure: true,
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- events []Event, err error,
+ events []Event, changes display.ResourceChanges, err error,
  ) error {
  violationEvents := []Event{}
  for _, e := range events {
@@ -439,7 +440,7 @@ func TestSimpleAnalyzeStackFailureRemediateDowngradedToMandatory(t *testing.T) {
  SkipPreview: true,
  ExpectFailure: true,
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- events []Event, err error,
+ events []Event, changes display.ResourceChanges, err error,
  ) error {
  violationEvents := []Event{}
  for _, e := range events {

pkg/engine/lifecycletest/delete_before_replace_test.go

@@ -8,6 +8,7 @@ import (
  "github.com/stretchr/testify/require"
  "golang.org/x/exp/maps"
 
+ "github.com/pulumi/pulumi/pkg/v3/display"
  . "github.com/pulumi/pulumi/pkg/v3/engine" //nolint:revive
  "github.com/pulumi/pulumi/pkg/v3/resource/deploy"
  "github.com/pulumi/pulumi/pkg/v3/resource/deploy/deploytest"
@@ -176,7 +177,7 @@ func TestDeleteBeforeReplace(t *testing.T) {
  ExpectFailure: false,
  SkipPreview: true,
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -350,7 +351,7 @@ func TestExplicitDeleteBeforeReplace(t *testing.T) {
  Op: Update,
 
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -374,7 +375,7 @@ func TestExplicitDeleteBeforeReplace(t *testing.T) {
  Op: Update,
 
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -399,7 +400,7 @@ func TestExplicitDeleteBeforeReplace(t *testing.T) {
  Op: Update,
 
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -423,7 +424,7 @@ func TestExplicitDeleteBeforeReplace(t *testing.T) {
  Op: Update,
 
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -447,7 +448,7 @@ func TestExplicitDeleteBeforeReplace(t *testing.T) {
  Op: Update,
 
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -473,7 +474,7 @@ func TestExplicitDeleteBeforeReplace(t *testing.T) {
  Op: Update,
 
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -575,7 +576,7 @@ func TestDependencyChangeDBR(t *testing.T) {
  {
  Op: Update,
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
  assert.True(t, len(entries) > 0)

pkg/engine/lifecycletest/golang_sdk_test.go

@@ -160,7 +160,7 @@ func TestIgnoreChangesGolangLifecycle(t *testing.T) {
  {
  Op: Update,
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- events []Event, err error,
+ events []Event, changes display.ResourceChanges, err error,
  ) error {
  for _, event := range events {
  if event.Type == ResourcePreEvent {
@@ -262,7 +262,7 @@ func TestExplicitDeleteBeforeReplaceGoSDK(t *testing.T) {
  Op: Update,
 
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -286,7 +286,7 @@ func TestExplicitDeleteBeforeReplaceGoSDK(t *testing.T) {
  Op: Update,
 
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
  AssertSameSteps(t, []StepSummary{
@@ -349,7 +349,7 @@ func TestReadResourceGolangLifecycle(t *testing.T) {
  {
  Op: Update,
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- evts []Event, err error,
+ evts []Event, changes display.ResourceChanges, err error,
  ) error {
  assert.NoError(t, err)
 
@@ -598,7 +598,7 @@ func TestReplaceOnChangesGolangLifecycle(t *testing.T) {
  {
  Op: Update,
  Validate: func(project workspace.Project, target deploy.Target, entries JournalEntries,
- events []Event, err error,
+ events []Event, changes display.ResourceChanges, err error,
  ) error {
  collectedOps := make([]display.StepOp, 0)
  for _, event := range events {

pkg/engine/lifecycletest/import_test.go

@@ -8,6 +8,7 @@ import (
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
 
+ "github.com/pulumi/pulumi/pkg/v3/display"
  . "github.com/pulumi/pulumi/pkg/v3/engine" //nolint:revive
  "github.com/pulumi/pulumi/pkg/v3/resource/deploy"
  "github.com/pulumi/pulumi/pkg/v3/resource/deploy/deploytest"
@@ -103,7 +104,9 @@ func TestImportOption(t *testing.T) {
  // Run a second update after fixing the inputs. The import should succeed.
  inputs["foo"] = resource.NewStringProperty("bar")
  snap, err := TestOp(Update).Run(project, p.GetTarget(t, nil), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN:
@@ -123,7 +126,9 @@ func TestImportOption(t *testing.T) {
 
  // Now, run another update. The update should succeed and there should be no diffs.
  snap, err = TestOp(Update).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN, resURN:
@@ -141,7 +146,9 @@ func TestImportOption(t *testing.T) {
  // Change a property value and run a third update. The update should succeed.
  inputs["foo"] = resource.NewStringProperty("rab")
  snap, err = TestOp(Update).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN:
@@ -166,7 +173,9 @@ func TestImportOption(t *testing.T) {
 
  // Finally, destroy the stack. The `Delete` function should be called.
  _, err = TestOp(Destroy).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN, resURN:
@@ -182,7 +191,9 @@ func TestImportOption(t *testing.T) {
  // Now clear the ID to import and run an initial update to create a resource that we will import-replace.
  importID, inputs["foo"] = "", resource.NewStringProperty("bar")
  snap, err = TestOp(Update).Run(project, p.GetTarget(t, nil), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN, resURN:
@@ -206,7 +217,9 @@ func TestImportOption(t *testing.T) {
  }
  }
  snap, err = TestOp(Update).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN, resURN:
@@ -226,7 +239,9 @@ func TestImportOption(t *testing.T) {
  // a delete-replaced.
  importID = "id"
  snap, err = TestOp(Update).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN:
@@ -252,7 +267,9 @@ func TestImportOption(t *testing.T) {
  readID = "id"
  expectedInputs, expectedState = inputs, inputs
  snap, err = TestOp(Update).Run(project, p.GetTarget(t, nil), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN:
@@ -274,7 +291,9 @@ func TestImportOption(t *testing.T) {
  readID, importID = "", readID
  expectedInputs, expectedState = nil, nil
  _, err = TestOp(Update).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN:
@@ -364,7 +383,9 @@ func TestImportWithDifferingImportIdentifierFormat(t *testing.T) {
  // Run the initial update. The import should succeed.
  project := p.GetProject()
  snap, err := TestOp(Update).Run(project, p.GetTarget(t, nil), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN:
@@ -382,7 +403,9 @@ func TestImportWithDifferingImportIdentifierFormat(t *testing.T) {
 
  // Now, run another update. The update should succeed and there should be no diffs.
  _, err = TestOp(Update).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, err error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, err error,
+ ) error {
  for _, entry := range entries {
  switch urn := entry.Step.URN(); urn {
  case provURN, resURN:
@@ -717,7 +740,9 @@ func TestImportPlanExistingImport(t *testing.T) {
  Name: "resA",
  ID: "imported-id",
  }}).Run(project, p.GetTarget(t, snap), p.Options, false, p.BackendClient,
- func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event, _ error) error {
+ func(_ workspace.Project, _ deploy.Target, entries JournalEntries, _ []Event,
+ _ display.ResourceChanges, _ error,
+ ) error {
  for _, e := range entries {
  assert.Equal(t, deploy.OpSame, e.Step.Op())
  }