Skip to content

fix: include resource identity in single-change dyff output #1089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sean0407 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: include resource identity in single-change dyff output #1089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions diff/report.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ func printDyffReport(r *Report, to io.Writer) {
OmitHeader: true,
MinorChangeThreshold: 0.1,
}
// dyff omits the root description for a single-document comparison.
if len(r.Entries) == 1 {
_, _ = fmt.Fprintln(to, r.Entries[0].Key)
}
_ = reportWriter.WriteReport(to)
}

Expand Down
27 changes: 27 additions & 0 deletions diff/report_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,33 @@ func TestPrintDyffReport(t *testing.T) {
require.Contains(t, output, "+ 3", "Expected dyff output to show updated replicas value")
}

func TestPrintDyffReportSingleChangeIncludesResourceIdentity(t *testing.T) {
report := &Report{
Entries: []ReportEntry{{
Key: "default, heat-trusts, Job (batch)",
Kind: "Job",
ChangeType: "MODIFY",
Diffs: []difflib.DiffRecord{
{Payload: "apiVersion: batch/v1", Delta: difflib.Common},
{Payload: "kind: Job", Delta: difflib.Common},
{Payload: "metadata:", Delta: difflib.Common},
{Payload: " name: heat-trusts", Delta: difflib.Common},
{Payload: "spec:", Delta: difflib.Common},
{Payload: " parallelism: 1", Delta: difflib.LeftOnly},
{Payload: " parallelism: 2", Delta: difflib.RightOnly},
},
}},
}

var buf bytes.Buffer
printDyffReport(report, &buf)
output := buf.String()
require.Contains(t, output, "default, heat-trusts, Job (batch)")
require.Contains(t, output, "spec.parallelism")
require.Contains(t, output, "- 1")
require.Contains(t, output, "+ 2")
}

func TestPrintDyffReportWithAddAndRemove(t *testing.T) {
report := &Report{
Entries: []ReportEntry{
Expand Down