diff options
| author | Damien Neil <neild@users.noreply.github.com> | 2021-07-19 10:12:14 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-19 10:12:14 -0700 |
| commit | 402949e8139bb890c71a707b6faf6dd05c92f4e5 (patch) | |
| tree | 1e5142823aaab3313e67cd9a47309a1a47cd438e | |
| parent | 290a6a23966f9edffe2a0a4a1d8dd065cc0753fd (diff) | |
| parent | d5fcb386864232c4b315ea7f9838e455a2ce3cda (diff) | |
| download | go-cmp-402949e8139bb890c71a707b6faf6dd05c92f4e5.tar.gz | |
Merge pull request #266 from dsnet/fix-format
Fix textual printing of byte slices
| -rw-r--r-- | cmp/compare_test.go | 20 | ||||
| -rw-r--r-- | cmp/report_reflect.go | 3 | ||||
| -rw-r--r-- | cmp/testdata/diffs | 24 |
3 files changed, 46 insertions, 1 deletions
diff --git a/cmp/compare_test.go b/cmp/compare_test.go index dc0bfe0..a435209 100644 --- a/cmp/compare_test.go +++ b/cmp/compare_test.go @@ -1317,6 +1317,26 @@ using the AllowUnexported option.`, "\n"), x: "d5c14bdf6bac81c27afc5429500ed750\n25483503b557c606dad4f144d27ae10b\n90bdbcdbb6ea7156068e3dcfb7459244\n978f480a6e3cced51e297fbff9a506b7\n", y: "Xd5c14bdf6bac81c27afc5429500ed750\nX25483503b557c606dad4f144d27ae10b\nX90bdbcdbb6ea7156068e3dcfb7459244\nX978f480a6e3cced51e297fbff9a506b7\n", reason: "all lines are different, so diffing based on lines is pointless", + }, { + label: label + "/StringifiedBytes", + x: struct{ X []byte }{[]byte("hello, world!")}, + y: struct{ X []byte }{}, + reason: "[]byte should be printed as text since it is printable text", + }, { + label: label + "/NonStringifiedBytes", + x: struct{ X []byte }{[]byte("\xde\xad\xbe\xef")}, + y: struct{ X []byte }{}, + reason: "[]byte should not be printed as text since it is binary data", + }, { + label: label + "/StringifiedNamedBytes", + x: struct{ X MyBytes }{MyBytes("hello, world!")}, + y: struct{ X MyBytes }{}, + reason: "MyBytes should be printed as text since it is printable text", + }, { + label: label + "/NonStringifiedNamedBytes", + x: struct{ X MyBytes }{MyBytes("\xde\xad\xbe\xef")}, + y: struct{ X MyBytes }{}, + reason: "MyBytes should not be printed as text since it is binary data", }} } diff --git a/cmp/report_reflect.go b/cmp/report_reflect.go index 33f0357..76c04fd 100644 --- a/cmp/report_reflect.go +++ b/cmp/report_reflect.go @@ -207,9 +207,10 @@ func (opts formatOptions) FormatValue(v reflect.Value, parentKind reflect.Kind, // Check whether this is a []byte of text data. if t.Elem() == reflect.TypeOf(byte(0)) { b := v.Bytes() - isPrintSpace := func(r rune) bool { return unicode.IsPrint(r) && unicode.IsSpace(r) } + isPrintSpace := func(r rune) bool { return unicode.IsPrint(r) || unicode.IsSpace(r) } if len(b) > 0 && utf8.Valid(b) && len(bytes.TrimFunc(b, isPrintSpace)) == 0 { out = opts.formatString("", string(b)) + skipType = true return opts.WithTypeMode(emitType).FormatType(t, out) } } diff --git a/cmp/testdata/diffs b/cmp/testdata/diffs index a3d5909..96ea191 100644 --- a/cmp/testdata/diffs +++ b/cmp/testdata/diffs @@ -1096,6 +1096,30 @@ "978f480a6e3cced51e297fbff9a506b7\n", }, "") >>> TestDiff/Reporter/AllLinesDiffer +<<< TestDiff/Reporter/StringifiedBytes + struct{ X []uint8 }{ +- X: []uint8("hello, world!"), ++ X: nil, + } +>>> TestDiff/Reporter/StringifiedBytes +<<< TestDiff/Reporter/NonStringifiedBytes + struct{ X []uint8 }{ +- X: []uint8{0xde, 0xad, 0xbe, 0xef}, ++ X: nil, + } +>>> TestDiff/Reporter/NonStringifiedBytes +<<< TestDiff/Reporter/StringifiedNamedBytes + struct{ X cmp_test.MyBytes }{ +- X: cmp_test.MyBytes("hello, world!"), ++ X: nil, + } +>>> TestDiff/Reporter/StringifiedNamedBytes +<<< TestDiff/Reporter/NonStringifiedNamedBytes + struct{ X cmp_test.MyBytes }{ +- X: cmp_test.MyBytes{0xde, 0xad, 0xbe, 0xef}, ++ X: nil, + } +>>> TestDiff/Reporter/NonStringifiedNamedBytes <<< TestDiff/EmbeddedStruct/ParentStructA/Inequal teststructs.ParentStructA{ privateStruct: teststructs.privateStruct{ |