Skip to content

feature disable the comparation of unexported fields of a struct #56

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
u5surf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feature disable the comparation of unexported fields of a struct #56

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
27 changes: 24 additions & 3 deletions diff.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"fmt"
"io"
"reflect"
"unicode"
)

type sbuf []string
Expand All @@ -20,6 +21,11 @@ func Diff(a, b interface{}) (desc []string) {
return desc
}

func UnexpDiff(a, b interface{}) (desc []string) {
UnexpPdiff((*sbuf)(&desc), a, b)
return desc
}

// wprintfer calls Fprintf on w for each Printf call
// with a trailing newline.
type wprintfer struct{ w io.Writer }
Expand All @@ -33,6 +39,10 @@ func Fdiff(w io.Writer, a, b interface{}) {
Pdiff(&wprintfer{w}, a, b)
}

func UnexpFdiff(w io.Writer, a, b interface{}) {
UnexpPdiff(&wprintfer{w}, a, b)
}

type Printfer interface {
Printf(format string, a ...interface{})
}
Expand All @@ -44,6 +54,10 @@ func Pdiff(p Printfer, a, b interface{}) {
diffPrinter{w: p}.diff(reflect.ValueOf(a), reflect.ValueOf(b))
}

func UnexpPdiff(p Printfer, a, b interface{}) {
diffPrinter{w: p, unexp: true}.diff(reflect.ValueOf(a), reflect.ValueOf(b))
}

type Logfer interface {
Logf(format string, a ...interface{})
}
Expand All @@ -63,9 +77,14 @@ func Ldiff(l Logfer, a, b interface{}) {
Pdiff(&logprintfer{l}, a, b)
}

func UnexpLdiff(l Logfer, a, b interface{}) {
UnexpPdiff(&logprintfer{l}, a, b)
}

type diffPrinter struct {
w Printfer
l string // label
w Printfer
l string // label
unexp bool
}

func (w diffPrinter) printf(f string, a ...interface{}) {
Expand Down Expand Up @@ -167,7 +186,9 @@ func (w diffPrinter) diff(av, bv reflect.Value) {
}
case reflect.Struct:
for i := 0; i < av.NumField(); i++ {
w.relabel(at.Field(i).Name).diff(av.Field(i), bv.Field(i))
if (w.unexp && unicode.IsUpper(rune(at.Field(i).Name[0]))) || !w.unexp {
w.relabel(at.Field(i).Name).diff(av.Field(i), bv.Field(i))
}
}
default:
panic("unknown reflect Kind: " + kind.String())
Expand Down
130 changes: 130 additions & 0 deletions unexpdiff_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
package pretty

import (
"bytes"
"fmt"
"log"
"testing"
"unsafe"
)

var (
_ Logfer = (*testing.T)(nil)
_ Logfer = (*testing.B)(nil)
_ Printfer = (*log.Logger)(nil)
)


var unexpdiffs = []difftest{
{a: nil, b: nil},
{a: S{A: 1}, b: S{A: 1}},

{0, "", []string{`int != string`}},
{0, 1, []string{`0 != 1`}},
{S{}, new(S), []string{`pretty.S != *pretty.S`}},
{"a", "b", []string{`"a" != "b"`}},
{S{}, S{A: 1}, []string{`A: 0 != 1`}},
{new(S), &S{A: 1}, []string{`A: 0 != 1`}},
{S{S: new(S)}, S{S: &S{A: 1}}, []string{`S.A: 0 != 1`}},
{S{}, S{I: 0}, []string{`I: nil != int(0)`}},
{S{I: 1}, S{I: "X"}, []string{`I: int != string`}},
{S{}, S{C: []int{1}}, []string{`C: []int[0] != []int[1]`}},
{S{C: []int{}}, S{C: []int{1}}, []string{`C: []int[0] != []int[1]`}},
{S{C: []int{1, 2, 3}}, S{C: []int{1, 2, 4}}, []string{`C[2]: 3 != 4`}},
{S{}, S{A: 1, S: new(S)}, []string{`A: 0 != 1`, `S: nil != &pretty.S{}`}},

// unexported fields of every reflect.Kind (both equal and unequal)
{struct{ X bool }{false}, struct{ X bool }{false}, nil},
{struct{ X bool }{false}, struct{ X bool }{true}, []string{`X: false != true`}},
{struct{ X int }{0}, struct{ X int }{0}, nil},
{struct{ X int }{0}, struct{ X int }{1}, []string{`X: 0 != 1`}},
{struct{ X int8 }{0}, struct{ X int8 }{0}, nil},
{struct{ X int8 }{0}, struct{ X int8 }{1}, []string{`X: 0 != 1`}},
{struct{ X int16 }{0}, struct{ X int16 }{0}, nil},
{struct{ X int16 }{0}, struct{ X int16 }{1}, []string{`X: 0 != 1`}},
{struct{ X int32 }{0}, struct{ X int32 }{0}, nil},
{struct{ X int32 }{0}, struct{ X int32 }{1}, []string{`X: 0 != 1`}},
{struct{ X int64 }{0}, struct{ X int64 }{0}, nil},
{struct{ X int64 }{0}, struct{ X int64 }{1}, []string{`X: 0 != 1`}},
{struct{ X uint }{0}, struct{ X uint }{0}, nil},
{struct{ X uint }{0}, struct{ X uint }{1}, []string{`X: 0 != 1`}},
{struct{ X uint8 }{0}, struct{ X uint8 }{0}, nil},
{struct{ X uint8 }{0}, struct{ X uint8 }{1}, []string{`X: 0 != 1`}},
{struct{ X uint16 }{0}, struct{ X uint16 }{0}, nil},
{struct{ X uint16 }{0}, struct{ X uint16 }{1}, []string{`X: 0 != 1`}},
{struct{ X uint32 }{0}, struct{ X uint32 }{0}, nil},
{struct{ X uint32 }{0}, struct{ X uint32 }{1}, []string{`X: 0 != 1`}},
{struct{ X uint64 }{0}, struct{ X uint64 }{0}, nil},
{struct{ X uint64 }{0}, struct{ X uint64 }{1}, []string{`X: 0 != 1`}},
{struct{ X uintptr }{0}, struct{ X uintptr }{0}, nil},
{struct{ X uintptr }{0}, struct{ X uintptr }{1}, []string{`X: 0 != 1`}},
{struct{ X float32 }{0}, struct{ X float32 }{0}, nil},
{struct{ X float32 }{0}, struct{ X float32 }{1}, []string{`X: 0 != 1`}},
{struct{ X float64 }{0}, struct{ X float64 }{0}, nil},
{struct{ X float64 }{0}, struct{ X float64 }{1}, []string{`X: 0 != 1`}},
{struct{ X complex64 }{0}, struct{ X complex64 }{0}, nil},
{struct{ X complex64 }{0}, struct{ X complex64 }{1}, []string{`X: (0+0i) != (1+0i)`}},
{struct{ X complex128 }{0}, struct{ X complex128 }{0}, nil},
{struct{ X complex128 }{0}, struct{ X complex128 }{1}, []string{`X: (0+0i) != (1+0i)`}},
{struct{ X [1]int }{[1]int{0}}, struct{ X [1]int }{[1]int{0}}, nil},
{struct{ X [1]int }{[1]int{0}}, struct{ X [1]int }{[1]int{1}}, []string{`X[0]: 0 != 1`}},
{struct{ X chan int }{c0}, struct{ X chan int }{c0}, nil},
{struct{ X chan int }{c0}, struct{ X chan int }{c1}, []string{fmt.Sprintf("X: %p != %p", c0, c1)}},
{struct{ X func() }{f0}, struct{ X func() }{f0}, nil},
{struct{ X func() }{f0}, struct{ X func() }{f1}, []string{fmt.Sprintf("X: %p != %p", f0, f1)}},
{struct{ X interface{} }{0}, struct{ X interface{} }{0}, nil},
{struct{ X interface{} }{0}, struct{ X interface{} }{1}, []string{`X: 0 != 1`}},
{struct{ X interface{} }{0}, struct{ X interface{} }{""}, []string{`X: int != string`}},
{struct{ X interface{} }{0}, struct{ X interface{} }{nil}, []string{`X: int(0) != nil`}},
{struct{ X interface{} }{nil}, struct{ X interface{} }{0}, []string{`X: nil != int(0)`}},
{struct{ X map[int]int }{map[int]int{0: 0}}, struct{ X map[int]int }{map[int]int{0: 0}}, nil},
{struct{ X map[int]int }{map[int]int{0: 0}}, struct{ X map[int]int }{map[int]int{0: 1}}, []string{`X[0]: 0 != 1`}},
{struct{ X *int }{new(int)}, struct{ X *int }{new(int)}, nil},
{struct{ X *int }{&i0}, struct{ X *int }{&i1}, []string{`X: 0 != 1`}},
{struct{ X *int }{nil}, struct{ X *int }{&i0}, []string{`X: nil != &int(0)`}},
{struct{ X *int }{&i0}, struct{ X *int }{nil}, []string{`X: &int(0) != nil`}},
{struct{ X []int }{[]int{0}}, struct{ X []int }{[]int{0}}, nil},
{struct{ X []int }{[]int{0}}, struct{ X []int }{[]int{1}}, []string{`X[0]: 0 != 1`}},
{struct{ X string }{"a"}, struct{ X string }{"a"}, nil},
{struct{ X string }{"a"}, struct{ X string }{"b"}, []string{`X: "a" != "b"`}},
{struct{ X N }{N{0}}, struct{ X N }{N{0}}, nil},
{struct{ X N }{N{0}}, struct{ X N }{N{1}}, []string{`X.N: 0 != 1`}},
{
struct{ X unsafe.Pointer }{unsafe.Pointer(uintptr(0))},
struct{ X unsafe.Pointer }{unsafe.Pointer(uintptr(0))},
nil,
},
{
struct{ X unsafe.Pointer }{unsafe.Pointer(uintptr(0))},
struct{ X unsafe.Pointer }{unsafe.Pointer(uintptr(1))},
[]string{`X: 0x0 != 0x1`},
},
}

func TestUnexpDiff(t *testing.T) {
for _, tt := range unexpdiffs {
got := UnexpDiff(tt.a, tt.b)
eq := len(got) == len(tt.exp)
if eq {
for i := range got {
eq = eq && got[i] == tt.exp[i]
}
}
if !eq {
t.Errorf("unexported field diffing % #v", tt.a)
t.Errorf("with % #v", tt.b)
diffdiff(t, got, tt.exp)
continue
}
}
}

func TestUnexpFdiff(t *testing.T) {
var buf bytes.Buffer
UnexpFdiff(&buf, 0, 1)
want := "0 != 1\n"
if got := buf.String(); got != want {
t.Errorf("UnexpFdiff(0, 1) = %q want %q", got, want)
}
}