Skip to content

Commit

Permalink
Merge #11803
Browse files Browse the repository at this point in the history 
11803: Display text-based diff if yaml/json diff is semantically equal r=aq17 a=aq17

Fixes #11799 

#9380 and #9484 introduced changes that render JSON/YAML parsable strings as objects in diffs – therefore, examples such as`"foo:\n  bar: {}\n  baz: {}\n"` and `"#foo\nfoo:\n  bar: {}\n  baz: {}\n"` are recognized as equal.

This change causes the display to fall back to showing the text-based diff if the JSON/YAML rendering does not indicate any diff.
It also prints all object keys even if the value is empty, i.e. `bar: {}` or `bar: ""` will be printed instead of `bar` being omitted.

Co-authored-by: aq17 <aqiu@pulumi.com>
  • Loading branch information
@bors @aq17
bors[bot] and aq17 committed Jan 19, 2023
2 parents d109730 + cdd95f8 commit 8d25616
Show file tree
Hide file tree
Showing 17 changed files with 653 additions and 72 deletions.
4 changes: 4 additions & 0 deletions ...230106--cli-display--display-text-based-diff-if-yaml-json-diff-is-semantically-equal.yaml
View file
@@ -0,0 +1,4 @@
changes:
- type: fix
scope: cli/display
description: Display text-based diff if yaml/json diff is semantically equal
14 changes: 7 additions & 7 deletions pkg/backend/display/object_diff.go
View file
Expand Up @@ -233,7 +233,7 @@ func (p *propertyPrinter) printObject(props resource.PropertyMap) {

// Now print out the values intelligently based on the type.
for _, k := range keys {
if v := props[k]; !resource.IsInternalPropertyKey(k) && shouldPrintPropertyValue(v, p.planning) {
if v := props[k]; !resource.IsInternalPropertyKey(k) {
p.printObjectProperty(k, v, maxkey)
}
}
Expand Down Expand Up @@ -477,9 +477,6 @@ func shouldPrintPropertyValue(v resource.PropertyValue, outs bool) bool {
if v.IsObject() && len(v.ObjectValue()) == 0 {
return false // skip objects with no properties, since they are also uninteresting.
}
if v.IsObject() && len(v.ObjectValue()) == 0 {
return false // skip objects with no properties, since they are also uninteresting.
}
if v.IsOutput() && !outs {
// also don't show output properties until the outs parameter tells us to.
return false
Expand Down Expand Up @@ -1180,10 +1177,13 @@ func (p *propertyPrinter) printEncodedValueDiff(old, new string) bool {
return false
}

if oldKind == newKind {
p.write("(%s) ", oldKind)
} else {
if oldKind != newKind {
p.write("(%s => %s) ", oldKind, newKind)
} else if old != new {
p.printTextDiff(strconv.Quote(old), strconv.Quote(new))
return true
} else {
p.write("(%s) ", oldKind)
}

diff := oldValue.Diff(newValue, resource.IsInternalPropertyKey)
Expand Down
2 changes: 2 additions & 0 deletions pkg/backend/display/testdata/not-truncated/template-body.json
View file

Large diffs are not rendered by default.

116 changes: 116 additions & 0 deletions ...nd/display/testdata/not-truncated/template-body.json.interactive-100x80-cooked.stdout.txt
View file

Large diffs are not rendered by default.

116 changes: 116 additions & 0 deletions pkg/backend/display/testdata/not-truncated/template-body.json.interactive-100x80.stdout.txt
View file

Large diffs are not rendered by default.

116 changes: 116 additions & 0 deletions ...nd/display/testdata/not-truncated/template-body.json.interactive-200x80-cooked.stdout.txt
View file

Large diffs are not rendered by default.

116 changes: 116 additions & 0 deletions pkg/backend/display/testdata/not-truncated/template-body.json.interactive-200x80.stdout.txt
View file

Large diffs are not rendered by default.

46 changes: 46 additions & 0 deletions ...end/display/testdata/not-truncated/template-body.json.interactive-80x24-cooked.stdout.txt
View file
Expand Up @@ -2435,6 +2435,52 @@
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-1 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-1-nat-1 
more⬇  <{%underline%}><{%fg 12%}>Type<{%reset%}> <{%underline%}><{%fg 12%}>Name<{%reset%}> 
<{%bold%}><{%reset%}> <{%reset%}> pulumi:pulumi:Stack aws-ts-eks-dev 
<{%reset%}> <{%reset%}> ├─ awsx:x:ec2:Vpc vpc 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:NatGateway vpc-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Eip vpc-0 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:NatGateway vpc-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Route vpc-public-0-ig 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:RouteTableAssociation vpc-public-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-0 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-0-nat-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:InternetGateway vpc 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:InternetGateway vpc 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-1 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-1-nat-1 
more⬇  <{%underline%}><{%fg 12%}>Type<{%reset%}> <{%underline%}><{%fg 12%}>Name<{%reset%}> 
<{%bold%}><{%reset%}> <{%reset%}> pulumi:pulumi:Stack aws-ts-eks-dev 
<{%reset%}> <{%reset%}> ├─ awsx:x:ec2:Vpc vpc 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:NatGateway vpc-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Eip vpc-0 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:NatGateway vpc-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Route vpc-public-0-ig 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:RouteTableAssociation vpc-public-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-0 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-0-nat-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:InternetGateway vpc 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:InternetGateway vpc 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-1 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-1-nat-1 
more⬇  <{%underline%}><{%fg 12%}>Type<{%reset%}> <{%underline%}><{%fg 12%}>Name<{%reset%}> 
<{%reset%}> <{%reset%}> pulumi:pulumi:Stack aws-ts-eks-dev 
Expand Down
46 changes: 46 additions & 0 deletions pkg/backend/display/testdata/not-truncated/template-body.json.interactive-80x24.stdout.txt
View file
Expand Up @@ -2435,6 +2435,52 @@
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-1 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-1-nat-1 
more⬇  <{%underline%}><{%fg 12%}>Type<{%reset%}> <{%underline%}><{%fg 12%}>Name<{%reset%}> 
<{%bold%}><{%reset%}> <{%reset%}> pulumi:pulumi:Stack aws-ts-eks-dev 
<{%reset%}> <{%reset%}> ├─ awsx:x:ec2:Vpc vpc 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:NatGateway vpc-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Eip vpc-0 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:NatGateway vpc-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Route vpc-public-0-ig 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:RouteTableAssociation vpc-public-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-0 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-0-nat-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:InternetGateway vpc 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:InternetGateway vpc 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-1 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-1-nat-1 
more⬇  <{%underline%}><{%fg 12%}>Type<{%reset%}> <{%underline%}><{%fg 12%}>Name<{%reset%}> 
<{%bold%}><{%reset%}> <{%reset%}> pulumi:pulumi:Stack aws-ts-eks-dev 
<{%reset%}> <{%reset%}> ├─ awsx:x:ec2:Vpc vpc 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:NatGateway vpc-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Eip vpc-0 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:NatGateway vpc-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-public-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Route vpc-public-0-ig 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:RouteTableAssociation vpc-public-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-0 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-0 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-0-nat-0 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:InternetGateway vpc 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:InternetGateway vpc 
<{%reset%}> <{%reset%}> │ ├─ awsx:x:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTable vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:Subnet vpc-private-1 
<{%reset%}> <{%reset%}> │ │ ├─ aws:ec2:RouteTableAssociation vpc-private-1 
<{%reset%}> <{%reset%}> │ │ └─ aws:ec2:Route vpc-private-1-nat-1 
more⬇  <{%underline%}><{%fg 12%}>Type<{%reset%}> <{%underline%}><{%fg 12%}>Name<{%reset%}> 
<{%reset%}> <{%reset%}> pulumi:pulumi:Stack aws-ts-eks-dev 
Expand Down
2 changes: 2 additions & 0 deletions pkg/backend/display/testdata/not-truncated/template-body.json.non-interactive.stdout.txt
View file
Expand Up @@ -59,6 +59,8 @@
<{%bold%}><{%reset%}> <{%reset%}> aws:ec2:LaunchConfiguration cluster-nodeLaunchConfiguration <{%bold%}><{%reset%}><{%reset%}>
<{%bold%}><{%fg 3%}>~ <{%reset%}> aws:cloudformation:Stack cluster-nodes <{%bold%}><{%fg 3%}>updating<{%reset%}> [diff: <{%fg 3%}>~templateBody<{%reset%}><{%reset%}>]
<{%fg 3%}>~ <{%reset%}> aws:cloudformation:Stack cluster-nodes <{%fg 3%}>updated<{%reset%}> [diff: <{%fg 3%}>~templateBody<{%reset%}><{%reset%}>]
<{%fg 3%}>~ <{%reset%}> aws:cloudformation:Stack cluster-nodes <{%fg 3%}>updated<{%reset%}> [diff: <{%fg 3%}>~templateBody<{%reset%}><{%reset%}>]
<{%fg 3%}>~ <{%reset%}> aws:cloudformation:Stack cluster-nodes <{%fg 3%}>updated<{%reset%}> [diff: <{%fg 3%}>~templateBody<{%reset%}><{%reset%}>]
<{%bold%}><{%reset%}> <{%reset%}> pulumi:providers:kubernetes cluster-provider <{%bold%}><{%reset%}><{%reset%}>
<{%reset%}> <{%reset%}> pulumi:pulumi:Stack aws-ts-eks-dev <{%reset%}><{%reset%}>

Expand Down

0 comments on commit 8d25616

Please sign in to comment.