1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
|
package messagediff
import (
"fmt"
"reflect"
"sort"
"strings"
"time"
"unsafe"
)
type Different struct {
From, To interface{}
}
type BytesDifferent struct {
From, To interface{}
}
// PrettyDiff does a deep comparison and returns the nicely formated results.
// See DeepDiff for more details.
func PrettyDiff(a, b interface{}, options ...Option) (string, bool) {
d, equal := DeepDiff(a, b, options...)
var dstr []string
for path, added := range d.Added {
dstr = append(dstr, fmt.Sprintf("added: %s = %#v\n", path.String(), added))
}
for path, removed := range d.Removed {
dstr = append(dstr, fmt.Sprintf("removed: %s = %#v\n", path.String(), removed))
}
for path, modified := range d.Modified {
if d, ok := modified.(*Different); ok {
dstr = append(dstr, fmt.Sprintf("modified: %s, from = %#v; to = %#v\n", path.String(), d.From, d.To))
} else if d, ok := modified.(*BytesDifferent); ok {
var fromV string
if v, ok := d.From.(fmt.Stringer); ok {
fromV = v.String()
} else {
fromV = fmt.Sprintf("%x", d.From)
}
var toV string
if v, ok := d.To.(fmt.Stringer); ok {
toV = v.String()
} else {
toV = fmt.Sprintf("%x", d.To)
}
dstr = append(dstr, fmt.Sprintf("modified bytes: %s\nfrom = %s\n to = %s\n", path.String(), fromV, toV))
}
}
sort.Strings(dstr)
return strings.Join(dstr, ""), equal
}
// DeepDiff does a deep comparison and returns the results.
// If the field is time.Time, use Equal to compare
func DeepDiff(a, b interface{}, options ...Option) (*Diff, bool) {
d := newDiff()
opts := &opts{}
for _, o := range options {
o.apply(opts)
}
return d, d.diff(reflect.ValueOf(a), reflect.ValueOf(b), nil, opts)
}
func newDiff() *Diff {
return &Diff{
Added: make(map[*Path]interface{}),
Removed: make(map[*Path]interface{}),
Modified: make(map[*Path]interface{}),
visited: make(map[visit]bool),
}
}
func (d *Diff) diff(aVal, bVal reflect.Value, path Path, opts *opts) bool {
// The array underlying `path` could be modified in subsequent
// calls. Make sure we have a local copy.
localPath := make(Path, len(path))
copy(localPath, path)
// Validity checks. Should only trigger if nil is one of the original arguments.
if !aVal.IsValid() && !bVal.IsValid() {
return true
}
if !bVal.IsValid() {
d.Modified[&localPath] = &Different{aVal.Interface(), nil}
return false
} else if !aVal.IsValid() {
d.Modified[&localPath] = &Different{nil, bVal.Interface()}
return false
}
if aVal.Type() != bVal.Type() {
d.Modified[&localPath] = &Different{aVal.Interface(), bVal.Interface()}
return false
}
kind := aVal.Kind()
// Borrowed from the reflect package to handle recursive data structures.
hard := func(k reflect.Kind) bool {
switch k {
case reflect.Array, reflect.Map, reflect.Slice, reflect.Struct:
return true
}
return false
}
if aVal.CanAddr() && bVal.CanAddr() && hard(kind) {
addr1 := unsafe.Pointer(aVal.UnsafeAddr())
addr2 := unsafe.Pointer(bVal.UnsafeAddr())
if uintptr(addr1) > uintptr(addr2) {
// Canonicalize order to reduce number of entries in visited.
// Assumes non-moving garbage collector.
addr1, addr2 = addr2, addr1
}
// Short circuit if references are already seen.
typ := aVal.Type()
v := visit{addr1, addr2, typ}
if d.visited[v] {
return true
}
// Remember for later.
d.visited[v] = true
}
// End of borrowed code.
equal := true
switch kind {
case reflect.Map, reflect.Ptr, reflect.Func, reflect.Chan, reflect.Slice:
if aVal.IsNil() && bVal.IsNil() {
return true
}
if (aVal.IsNil() || bVal.IsNil()) && (kind != reflect.Slice || !opts.sliceWeakEmpty) {
d.Modified[&localPath] = &Different{aVal.Interface(), bVal.Interface()}
return false
}
}
switch kind {
case reflect.Array, reflect.Slice:
aLen := aVal.Len()
bLen := bVal.Len()
if aVal.Type().Elem().Kind() == reflect.Uint8 {
a := aVal.Interface()
b := bVal.Interface()
if kind == reflect.Array {
if a != b {
d.Modified[&localPath] = &BytesDifferent{From: a, To: b}
return false
}
return true
}
if aLen != bLen {
d.Modified[&localPath] = &BytesDifferent{From: a, To: b}
return false
} else {
for i := 0; i < aLen; i++ {
if aVal.Index(i).Interface() != bVal.Index(i).Interface() {
d.Modified[&localPath] = &BytesDifferent{From: a, To: b}
return false
}
}
return true
}
} else {
for i := 0; i < min(aLen, bLen); i++ {
localPath := append(localPath, SliceIndex(i))
if eq := d.diff(aVal.Index(i), bVal.Index(i), localPath, opts); !eq {
equal = false
}
}
if aLen > bLen {
for i := bLen; i < aLen; i++ {
localPath := append(localPath, SliceIndex(i))
d.Removed[&localPath] = aVal.Index(i).Interface()
equal = false
}
} else if aLen < bLen {
for i := aLen; i < bLen; i++ {
localPath := append(localPath, SliceIndex(i))
d.Added[&localPath] = bVal.Index(i).Interface()
equal = false
}
}
}
case reflect.Map:
for _, key := range aVal.MapKeys() {
aI := aVal.MapIndex(key)
bI := bVal.MapIndex(key)
localPath := append(localPath, MapKey{key.Interface()})
if !bI.IsValid() {
d.Removed[&localPath] = aI.Interface()
equal = false
} else if eq := d.diff(aI, bI, localPath, opts); !eq {
equal = false
}
}
for _, key := range bVal.MapKeys() {
aI := aVal.MapIndex(key)
if !aI.IsValid() {
bI := bVal.MapIndex(key)
localPath := append(localPath, MapKey{key.Interface()})
d.Added[&localPath] = bI.Interface()
equal = false
}
}
case reflect.Struct:
typ := aVal.Type()
// If the field is time.Time, use Equal to compare
if typ.String() == "time.Time" {
aTime := aVal.Interface().(time.Time)
bTime := bVal.Interface().(time.Time)
if !aTime.Equal(bTime) {
d.Modified[&localPath] = &Different{aVal.Interface().(time.Time).String(), bVal.Interface().(time.Time).String()}
equal = false
}
} else {
for i := 0; i < typ.NumField(); i++ {
index := []int{i}
field := typ.FieldByIndex(index)
if field.Tag.Get("testdiff") == "ignore" { // skip fields marked to be ignored
continue
}
if _, skip := opts.ignoreField[field.Name]; skip {
continue
}
localPath := append(localPath, StructField(field.Name))
aI := unsafeReflectValue(aVal.FieldByIndex(index))
bI := unsafeReflectValue(bVal.FieldByIndex(index))
if eq := d.diff(aI, bI, localPath, opts); !eq {
equal = false
}
}
}
case reflect.Ptr:
equal = d.diff(aVal.Elem(), bVal.Elem(), localPath, opts)
default:
if reflect.DeepEqual(aVal.Interface(), bVal.Interface()) {
equal = true
} else {
d.Modified[&localPath] = &Different{aVal.Interface(), bVal.Interface()}
equal = false
}
}
return equal
}
func min(a, b int) int {
if a < b {
return a
}
return b
}
// During deepValueEqual, must keep track of checks that are
// in progress. The comparison algorithm assumes that all
// checks in progress are true when it reencounters them.
// Visited comparisons are stored in a map indexed by visit.
// This is borrowed from the reflect package.
type visit struct {
a1 unsafe.Pointer
a2 unsafe.Pointer
typ reflect.Type
}
// Diff represents a change in a struct.
type Diff struct {
Added, Removed, Modified map[*Path]interface{}
visited map[visit]bool
}
// Path represents a path to a changed datum.
type Path []PathNode
func (p Path) String() string {
var out string
for _, n := range p {
out += n.String()
}
return out
}
// PathNode represents one step in the path.
type PathNode interface {
String() string
}
// StructField is a path element representing a field of a struct.
type StructField string
func (n StructField) String() string {
return fmt.Sprintf(".%s", string(n))
}
// MapKey is a path element representing a key of a map.
type MapKey struct {
Key interface{}
}
func (n MapKey) String() string {
return fmt.Sprintf("[%#v]", n.Key)
}
// SliceIndex is a path element representing a index of a slice.
type SliceIndex int
func (n SliceIndex) String() string {
return fmt.Sprintf("[%d]", n)
}
type opts struct {
ignoreField map[string]struct{}
// if true, nil slices are deemed equal to zero-length slices.
sliceWeakEmpty bool
}
// Option is an option to specify in diff
type Option interface {
apply(*opts)
}
// IgnoreStructField return an option of IgnoreFieldOption
func IgnoreStructField(field string) Option {
return IgnoreFieldOption{
Field: field,
}
}
// IgnoreFieldOption is an option for specifying a field that does not diff
type IgnoreFieldOption struct {
Field string
}
func (i IgnoreFieldOption) apply(opts *opts) {
if opts.ignoreField == nil {
opts.ignoreField = map[string]struct{}{}
}
opts.ignoreField[i.Field] = struct{}{}
}
type SliceWeakEmptyOption struct{}
func (v SliceWeakEmptyOption) apply(opts *opts) {
opts.sliceWeakEmpty = true
}
|