Repository navigation
Expand file tree
/
Copy pathdiff_test.go
More file actions
1061 lines (975 loc) · 33.7 KB
/
Copy pathdiff_test.go
File metadata and controls
1061 lines (975 loc) · 33.7 KB
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package structdiff
import (
"encoding/json"
"reflect"
"testing"
"time"
"github.com/databricks/cli/libs/structs/structaccess"
"github.com/databricks/databricks-sdk-go/common/types/duration"
sdktime "github.com/databricks/databricks-sdk-go/common/types/time"
"github.com/databricks/databricks-sdk-go/service/jobs"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
type B struct{ S string }
type A struct {
XX int `json:"xx"`
X int `json:"x,omitempty"`
B B `json:"b,omitempty"`
P *B `json:"p,omitempty"`
M map[string]int `json:"m,omitempty"`
L []string `json:"l,omitempty"`
Ignored string `json:"-"`
}
type C struct {
Name string `json:"name,omitempty"`
Age int `json:"age,omitempty"`
IsEnabled bool `json:"is_enabled,omitempty"`
Title string `json:"title"` // no omitempty
ForceSendFields []string `json:"-"`
}
type Embedded struct {
EmbeddedString string `json:"embedded_field,omitempty"`
EmbeddedInt int `json:"embedded_int,omitempty"`
}
type D struct {
Embedded // Anonymous embedded struct
Name string `json:"name,omitempty"`
}
type E struct {
*Embedded // Pointer to anonymous embedded struct
Name string `json:"name,omitempty"`
}
// O holds opaque struct fields: Duration and Timestamp keep their payload in an
// unexported protobuf pointer, while Empty is a proto message that really is
// empty.
type O struct {
Duration *duration.Duration `json:"duration,omitempty"`
Timestamp *sdktime.Time `json:"timestamp,omitempty"`
Empty *jobs.ScheduleTriggerState `json:"empty,omitempty"`
}
// ResolvedChange represents a change with the field path as a string (like the old Change struct)
type ResolvedChange struct {
Field string
Old any
New any
}
// Helper function to convert []Change to []ResolvedChange for test comparison
func resolveChanges(changes []Change) []ResolvedChange {
if len(changes) == 0 {
return nil
}
resolved := make([]ResolvedChange, len(changes))
for i, ch := range changes {
resolved[i] = ResolvedChange{
Field: ch.Path.String(),
Old: ch.Old,
New: ch.New,
}
}
return resolved
}
func TestGetStructDiff(t *testing.T) {
b1 := &B{S: "one"}
b2 := &B{S: "two"}
dur300 := duration.New(300 * time.Second)
dur600 := duration.New(600 * time.Second)
ts1 := sdktime.New(time.Unix(1000, 0))
ts2 := sdktime.New(time.Unix(2000, 0))
// An *invalid* reflect.Value (IsValid() == false)
var invalidRV reflect.Value
tests := []struct {
name string
a, b any
want []ResolvedChange
wantErr bool
}{
{
name: "pointer vs non-pointer",
a: &A{},
b: A{},
wantErr: true,
},
{
name: "both typed nil pointers",
a: (*A)(nil),
b: (*A)(nil),
want: nil,
},
{
name: "both untyped nil pointers",
a: nil,
b: nil,
want: nil,
},
{
name: "typed nil vs non-nil pointer",
a: (*A)(nil),
b: &A{X: 1},
want: []ResolvedChange{{Field: "", Old: (*A)(nil), New: &A{X: 1}}},
},
{
name: "different top-level types",
a: A{},
b: B{},
wantErr: true,
},
{
name: "invalid reflect value input",
a: invalidRV,
b: A{},
wantErr: true,
},
{
name: "simple field change - omitempty",
a: A{X: 5},
b: A{},
want: []ResolvedChange{{Field: "x", Old: 5, New: nil}},
},
{
name: "simple field change - required",
a: A{XX: 5},
b: A{},
want: []ResolvedChange{{Field: "xx", Old: 5, New: 0}},
},
{
name: "nested struct field",
a: A{B: B{S: "one"}},
b: A{B: B{S: "two"}},
want: []ResolvedChange{{Field: "b.S", Old: "one", New: "two"}},
},
{
name: "pointer nil vs value",
a: A{P: b1},
b: A{},
want: []ResolvedChange{{Field: "p", Old: B{S: "one"}, New: nil}},
},
{
name: "pointer nested value diff",
a: A{P: b1},
b: A{P: b2},
want: []ResolvedChange{{Field: "p.S", Old: "one", New: "two"}},
},
{
name: "map diff",
a: A{M: map[string]int{"a": 1}},
b: A{M: map[string]int{"a": 2}},
want: []ResolvedChange{{Field: "m['a']", Old: 1, New: 2}},
},
{
name: "slice diff",
a: A{L: []string{"a"}},
b: A{L: []string{"a", "b"}},
want: []ResolvedChange{{Field: "l", Old: []string{"a"}, New: []string{"a", "b"}}},
},
{
name: "ignored field change",
a: A{X: 5, Ignored: "old"},
b: A{X: 5, Ignored: "new"},
want: nil,
},
// ForceSendFields with non-empty fields (omitempty)
{
name: "forcesend nonempty 1",
a: C{Name: "Hello", ForceSendFields: []string{"Name"}},
b: C{Name: "World"},
want: []ResolvedChange{{Field: "name", Old: "Hello", New: "World"}},
},
{
name: "forcesend noneempty 2",
a: C{Name: "Hello", ForceSendFields: []string{"Name"}},
b: C{Name: "World", ForceSendFields: []string{"Name"}},
want: []ResolvedChange{{Field: "name", Old: "Hello", New: "World"}},
},
{
name: "forcesend noneempty 3",
a: C{Name: "Hello"},
b: C{Name: "World", ForceSendFields: []string{"Name"}},
want: []ResolvedChange{{Field: "name", Old: "Hello", New: "World"}},
},
// ForceSendFields with non-empty fields (required)
{
name: "forcesend nonempty required 1",
a: C{Title: "Hello", ForceSendFields: []string{"Title"}},
b: C{Title: "World"},
want: []ResolvedChange{{Field: "title", Old: "Hello", New: "World"}},
},
{
name: "forcesend noneempty required 2",
a: C{Title: "Hello", ForceSendFields: []string{"Title"}},
b: C{Title: "World", ForceSendFields: []string{"Title"}},
want: []ResolvedChange{{Field: "title", Old: "Hello", New: "World"}},
},
{
name: "forcesend noneempty required 3",
a: C{Title: "Hello"},
b: C{Title: "World", ForceSendFields: []string{"Title"}},
want: []ResolvedChange{{Field: "title", Old: "Hello", New: "World"}},
},
// ForceSendFields with empty fields
{
name: "forcesend empty string diff",
a: C{ForceSendFields: []string{"Name"}}, // Name == "" zero, but forced
b: C{},
want: []ResolvedChange{{Field: "name", Old: "", New: nil}},
},
{
name: "forcesend empty int diff",
a: C{ForceSendFields: []string{"Age"}},
b: C{},
want: []ResolvedChange{{Field: "age", Old: 0, New: nil}},
},
{
name: "forcesend empty bool diff",
a: C{ForceSendFields: []string{"IsEnabled"}},
b: C{},
want: []ResolvedChange{{Field: "is_enabled", Old: false, New: nil}},
},
{
name: "forcesend empty all",
a: C{ForceSendFields: []string{"Name", "IsEnabled"}},
b: C{ForceSendFields: []string{"Age"}},
want: []ResolvedChange{
{Field: "name", Old: "", New: nil},
{Field: "age", Old: nil, New: 0},
{Field: "is_enabled", Old: false, New: nil},
},
},
{
name: "forcesend is different but field is non empty – no diff",
a: C{Name: "name", ForceSendFields: []string{"Name"}},
b: C{Name: "name"},
want: nil,
},
{
name: "forcesend on non-omitempty field – no diff",
a: C{Title: "", ForceSendFields: []string{"Title"}},
b: C{},
want: nil,
},
// ForceSendFields inside slice
{
name: "slice of struct with only ForceSendFields diff",
a: []C{{Name: "hello", ForceSendFields: []string{"Name"}}},
b: []C{{Name: "hello"}},
want: nil,
},
{
name: "slice of struct with empty string and ForceSendFields diff",
a: []C{{Name: "", ForceSendFields: []string{"Name"}}},
b: []C{{Name: ""}},
want: []ResolvedChange{{Field: "[0].name", Old: "", New: nil}},
},
// ForceSendFields inside map value
{
name: "forcesend inside map",
a: map[string]C{"key1": {Title: "title", ForceSendFields: []string{"Name", "IsEnabled", "Title"}}},
b: map[string]C{"key1": {Title: "title", ForceSendFields: []string{"Age"}}},
want: []ResolvedChange{
{Field: "['key1'].name", Old: "", New: nil},
{Field: "['key1'].age", Old: nil, New: 0},
{Field: "['key1'].is_enabled", Old: false, New: nil},
},
},
// ForceSendFields inside map value pointer
{
name: "forcesend inside map",
a: map[string]*C{"key1": {Title: "title", ForceSendFields: []string{"Name", "IsEnabled", "Title"}}},
b: map[string]*C{"key1": {Title: "title", ForceSendFields: []string{"Age"}}},
want: []ResolvedChange{
{Field: "['key1'].name", Old: "", New: nil},
{Field: "['key1'].age", Old: nil, New: 0},
{Field: "['key1'].is_enabled", Old: false, New: nil},
},
},
// Embedded struct tests
{
name: "embedded struct field change",
a: D{Embedded: Embedded{EmbeddedString: "old"}, Name: "test"},
b: D{Embedded: Embedded{EmbeddedString: "new"}, Name: "test"},
want: []ResolvedChange{{Field: "embedded_field", Old: "old", New: "new"}},
},
{
name: "embedded struct multiple field changes",
a: D{Embedded: Embedded{EmbeddedString: "old", EmbeddedInt: 5}, Name: "test"},
b: D{Embedded: Embedded{EmbeddedString: "new", EmbeddedInt: 10}, Name: "test"},
want: []ResolvedChange{
{Field: "embedded_field", Old: "old", New: "new"},
{Field: "embedded_int", Old: 5, New: 10},
},
},
{
name: "embedded and non-embedded field changes",
a: D{Embedded: Embedded{EmbeddedString: "old"}, Name: "alice"},
b: D{Embedded: Embedded{EmbeddedString: "new"}, Name: "bob"},
want: []ResolvedChange{
{Field: "embedded_field", Old: "old", New: "new"},
{Field: "name", Old: "alice", New: "bob"},
},
},
{
name: "embedded struct zero to non-zero",
a: D{Name: "test"},
b: D{Embedded: Embedded{EmbeddedString: "value"}, Name: "test"},
want: []ResolvedChange{{Field: "embedded_field", Old: nil, New: "value"}},
},
{
name: "embedded struct non-zero to zero",
a: D{Embedded: Embedded{EmbeddedString: "value"}, Name: "test"},
b: D{Name: "test"},
want: []ResolvedChange{{Field: "embedded_field", Old: "value", New: nil}},
},
{
name: "embedded struct both zero",
a: D{Name: "test"},
b: D{Name: "test"},
want: nil,
},
{
name: "embedded struct only non-embedded field changes",
a: D{Embedded: Embedded{EmbeddedString: "same"}, Name: "alice"},
b: D{Embedded: Embedded{EmbeddedString: "same"}, Name: "bob"},
want: []ResolvedChange{{Field: "name", Old: "alice", New: "bob"}},
},
// Pointer embedded struct tests
{
name: "pointer embedded struct field change",
a: E{Embedded: &Embedded{EmbeddedString: "old"}, Name: "test"},
b: E{Embedded: &Embedded{EmbeddedString: "new"}, Name: "test"},
want: []ResolvedChange{{Field: "embedded_field", Old: "old", New: "new"}},
},
{
name: "pointer embedded struct multiple field changes",
a: E{Embedded: &Embedded{EmbeddedString: "old", EmbeddedInt: 5}, Name: "test"},
b: E{Embedded: &Embedded{EmbeddedString: "new", EmbeddedInt: 10}, Name: "test"},
want: []ResolvedChange{
{Field: "embedded_field", Old: "old", New: "new"},
{Field: "embedded_int", Old: 5, New: 10},
},
},
{
name: "pointer embedded and non-embedded field changes",
a: E{Embedded: &Embedded{EmbeddedString: "old"}, Name: "alice"},
b: E{Embedded: &Embedded{EmbeddedString: "new"}, Name: "bob"},
want: []ResolvedChange{
{Field: "embedded_field", Old: "old", New: "new"},
{Field: "name", Old: "alice", New: "bob"},
},
},
{
name: "pointer embedded struct nil to non-nil",
a: E{Name: "test"},
b: E{Embedded: &Embedded{EmbeddedString: "value"}, Name: "test"},
want: []ResolvedChange{{Field: "", Old: (*Embedded)(nil), New: &Embedded{EmbeddedString: "value"}}},
},
{
name: "pointer embedded struct non-nil to nil",
a: E{Embedded: &Embedded{EmbeddedString: "value"}, Name: "test"},
b: E{Name: "test"},
want: []ResolvedChange{{Field: "", Old: &Embedded{EmbeddedString: "value"}, New: (*Embedded)(nil)}},
},
{
name: "pointer embedded struct both nil",
a: E{Name: "test"},
b: E{Name: "test"},
want: nil,
},
{
name: "pointer embedded struct only non-embedded field changes",
a: E{Embedded: &Embedded{EmbeddedString: "same"}, Name: "alice"},
b: E{Embedded: &Embedded{EmbeddedString: "same"}, Name: "bob"},
want: []ResolvedChange{{Field: "name", Old: "alice", New: "bob"}},
},
{
name: "pointer embedded struct zero to non-zero int",
a: E{Name: "test"},
b: E{Embedded: &Embedded{EmbeddedInt: 42}, Name: "test"},
want: []ResolvedChange{{Field: "", Old: (*Embedded)(nil), New: &Embedded{EmbeddedInt: 42}}},
},
{
name: "pointer embedded struct non-zero to zero int",
a: E{Embedded: &Embedded{EmbeddedInt: 42}, Name: "test"},
b: E{Name: "test"},
want: []ResolvedChange{{Field: "", Old: &Embedded{EmbeddedInt: 42}, New: (*Embedded)(nil)}},
},
{
name: "opaque duration changed",
a: O{Duration: dur300},
b: O{Duration: dur600},
want: []ResolvedChange{{Field: "duration", Old: *dur300, New: *dur600}},
},
{
name: "opaque duration unset to set",
a: O{},
b: O{Duration: dur600},
want: []ResolvedChange{{Field: "duration", Old: nil, New: *dur600}},
},
{
name: "opaque timestamp changed",
a: O{Timestamp: ts1},
b: O{Timestamp: ts2},
want: []ResolvedChange{{Field: "timestamp", Old: *ts1, New: *ts2}},
},
{
name: "empty proto message is not opaque",
a: O{Empty: &jobs.ScheduleTriggerState{}},
b: O{Empty: &jobs.ScheduleTriggerState{}},
want: nil,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := GetStructDiff(tt.a, tt.b, nil)
assert.Equal(t, tt.want, resolveChanges(got))
if tt.wantErr {
assert.Error(t, err)
} else {
assert.NoError(t, err)
}
})
t.Run(tt.name+" mirror", func(t *testing.T) {
got, err := GetStructDiff(tt.b, tt.a, nil)
var mirrorWant []ResolvedChange
for _, ch := range tt.want {
mirrorWant = append(mirrorWant, ResolvedChange{
Field: ch.Field,
Old: ch.New,
New: ch.Old,
})
}
assert.Equal(t, mirrorWant, resolveChanges(got))
if tt.wantErr {
assert.Error(t, err)
} else {
assert.NoError(t, err)
}
})
t.Run(tt.name+" equal A", func(t *testing.T) {
got, err := GetStructDiff(tt.a, tt.a, nil)
assert.NoError(t, err)
assert.Nil(t, got)
})
t.Run(tt.name+" equal B", func(t *testing.T) {
got, err := GetStructDiff(tt.b, tt.b, nil)
assert.NoError(t, err)
assert.Nil(t, got)
})
t.Run(tt.name+" IsEqual", func(t *testing.T) {
equal := IsEqual(tt.a, tt.b)
expected := len(tt.want) == 0 && !tt.wantErr
assert.Equal(t, expected, equal)
})
}
}
type EmbedItem struct {
Name string `json:"name,omitempty"`
Level string `json:"level,omitempty"`
}
type EmbedContainer struct {
ObjectID string `json:"object_id"`
EmbeddedSlice []EmbedItem `json:"items,omitempty"`
}
func embedItemKey(item EmbedItem) (string, string) {
return "name", item.Name
}
func TestGetStructDiffEmbedTag(t *testing.T) {
tests := []struct {
name string
a, b EmbedContainer
want []ResolvedChange
}{
{
name: "no changes",
a: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "admin"}}},
b: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "admin"}}},
want: nil,
},
{
name: "embed field change without keys",
a: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "admin"}}},
b: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "reader"}}},
want: []ResolvedChange{{Field: "[0].level", Old: "admin", New: "reader"}},
},
{
name: "embed element added",
a: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice"}}},
b: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice"}, {Name: "bob"}}},
// Different lengths without key func → whole-slice change
want: []ResolvedChange{{Field: "", Old: []EmbedItem{{Name: "alice"}}, New: []EmbedItem{{Name: "alice"}, {Name: "bob"}}}},
},
{
name: "non-embed field change",
a: EmbedContainer{ObjectID: "abc"},
b: EmbedContainer{ObjectID: "def"},
want: []ResolvedChange{{Field: "object_id", Old: "abc", New: "def"}},
},
{
name: "embed slice empty vs non-empty",
a: EmbedContainer{ObjectID: "abc"},
b: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice"}}},
want: []ResolvedChange{{Field: "", Old: nil, New: []EmbedItem{{Name: "alice"}}}},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := GetStructDiff(tt.a, tt.b, nil)
assert.NoError(t, err)
assert.Equal(t, tt.want, resolveChanges(got))
})
}
}
func TestGetStructDiffEmbedTagWithKeyFunc(t *testing.T) {
// The EmbeddedSlice field appears at root path, so key pattern is "".
sliceKeys := map[string]KeyFunc{
"": embedItemKey,
}
tests := []struct {
name string
a, b EmbedContainer
want []ResolvedChange
}{
{
name: "reorder with key func",
a: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "admin"}, {Name: "bob", Level: "reader"}}},
b: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "bob", Level: "reader"}, {Name: "alice", Level: "admin"}}},
want: nil,
},
{
name: "field change with key func",
a: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "admin"}}},
b: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "reader"}}},
want: []ResolvedChange{{Field: "[name='alice'].level", Old: "admin", New: "reader"}},
},
{
name: "element added with key func",
a: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice"}}},
b: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice"}, {Name: "bob", Level: "reader"}}},
want: []ResolvedChange{{Field: "[name='bob']", Old: nil, New: EmbedItem{Name: "bob", Level: "reader"}}},
},
{
name: "element removed with key func",
a: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "admin"}, {Name: "bob"}}},
b: EmbedContainer{ObjectID: "abc", EmbeddedSlice: []EmbedItem{{Name: "alice", Level: "admin"}}},
want: []ResolvedChange{{Field: "[name='bob']", Old: EmbedItem{Name: "bob"}, New: nil}},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := GetStructDiff(tt.a, tt.b, sliceKeys)
assert.NoError(t, err)
assert.Equal(t, tt.want, resolveChanges(got))
})
}
}
type Dep struct {
TaskKey string `json:"task_key,omitempty"`
Outcome string `json:"outcome,omitempty"`
}
type Task struct {
TaskKey string `json:"task_key,omitempty"`
Description string `json:"description,omitempty"`
Timeout int `json:"timeout,omitempty"`
DependsOn []Dep `json:"depends_on,omitempty"`
}
type Job struct {
Name string `json:"name,omitempty"`
Tasks []Task `json:"tasks,omitempty"`
}
func taskKeyFunc(task Task) (string, string) {
return "task_key", task.TaskKey
}
func depKeyFunc(dep Dep) (string, string) {
return "task_key", dep.TaskKey
}
func TestGetStructDiffSliceKeys(t *testing.T) {
sliceKeys := map[string]KeyFunc{
"tasks": taskKeyFunc,
}
tests := []struct {
name string
a, b any
want []ResolvedChange
}{
{
name: "slice with same keys same order",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}, {TaskKey: "b", Description: "two"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}, {TaskKey: "b", Description: "two"}}},
want: nil,
},
{
name: "slice with same keys different order",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}, {TaskKey: "b", Description: "two"}}},
b: Job{Tasks: []Task{{TaskKey: "b", Description: "two"}, {TaskKey: "a", Description: "one"}}},
want: nil,
},
{
name: "slice with same keys field change",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "changed"}}},
want: []ResolvedChange{{Field: "tasks[task_key='a'].description", Old: "one", New: "changed"}},
},
{
name: "slice element added",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}, {TaskKey: "b", Description: "two"}}},
want: []ResolvedChange{{Field: "tasks[task_key='b']", Old: nil, New: Task{TaskKey: "b", Description: "two"}}},
},
{
name: "slice element removed",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}, {TaskKey: "b", Description: "two"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}}},
want: []ResolvedChange{{Field: "tasks[task_key='b']", Old: Task{TaskKey: "b", Description: "two"}, New: nil}},
},
{
name: "slice element replaced",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}}},
b: Job{Tasks: []Task{{TaskKey: "b", Description: "two"}}},
want: []ResolvedChange{
{Field: "tasks[task_key='a']", Old: Task{TaskKey: "a", Description: "one"}, New: nil},
{Field: "tasks[task_key='b']", Old: nil, New: Task{TaskKey: "b", Description: "two"}},
},
},
{
name: "multiple changes with reorder",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "one"}, {TaskKey: "b", Description: "two"}, {TaskKey: "c", Description: "three"}}},
b: Job{Tasks: []Task{{TaskKey: "c", Description: "changed"}, {TaskKey: "a", Description: "one"}}},
want: []ResolvedChange{
{Field: "tasks[task_key='b']", Old: Task{TaskKey: "b", Description: "two"}, New: nil},
{Field: "tasks[task_key='c'].description", Old: "three", New: "changed"},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := GetStructDiff(tt.a, tt.b, sliceKeys)
assert.NoError(t, err)
assert.Equal(t, tt.want, resolveChanges(got))
})
}
}
func TestGetStructDiffNestedDependsOn(t *testing.T) {
sliceKeys := map[string]KeyFunc{
"tasks": taskKeyFunc,
"tasks[*].depends_on": depKeyFunc,
}
tests := []struct {
name string
a, b Job
want []ResolvedChange
}{
{
name: "depends_on reordered no diff",
a: Job{Tasks: []Task{{TaskKey: "c", DependsOn: []Dep{{TaskKey: "a"}, {TaskKey: "b"}}}}},
b: Job{Tasks: []Task{{TaskKey: "c", DependsOn: []Dep{{TaskKey: "b"}, {TaskKey: "a"}}}}},
want: nil,
},
{
name: "depends_on field change",
a: Job{Tasks: []Task{{TaskKey: "c", DependsOn: []Dep{{TaskKey: "a", Outcome: "success"}}}}},
b: Job{Tasks: []Task{{TaskKey: "c", DependsOn: []Dep{{TaskKey: "a", Outcome: "failed"}}}}},
want: []ResolvedChange{{Field: "tasks[task_key='c'].depends_on[task_key='a'].outcome", Old: "success", New: "failed"}},
},
{
name: "depends_on element added",
a: Job{Tasks: []Task{{TaskKey: "c", DependsOn: []Dep{{TaskKey: "a"}}}}},
b: Job{Tasks: []Task{{TaskKey: "c", DependsOn: []Dep{{TaskKey: "a"}, {TaskKey: "b"}}}}},
want: []ResolvedChange{{Field: "tasks[task_key='c'].depends_on[task_key='b']", Old: nil, New: Dep{TaskKey: "b"}}},
},
{
name: "depends_on element removed",
a: Job{Tasks: []Task{{TaskKey: "c", DependsOn: []Dep{{TaskKey: "a"}, {TaskKey: "b"}}}}},
b: Job{Tasks: []Task{{TaskKey: "c", DependsOn: []Dep{{TaskKey: "a"}}}}},
want: []ResolvedChange{{Field: "tasks[task_key='c'].depends_on[task_key='b']", Old: Dep{TaskKey: "b"}, New: nil}},
},
{
name: "tasks and depends_on both reordered no diff",
a: Job{Tasks: []Task{
{TaskKey: "x", DependsOn: []Dep{{TaskKey: "a"}, {TaskKey: "b"}}},
{TaskKey: "y", DependsOn: []Dep{{TaskKey: "c"}}},
}},
b: Job{Tasks: []Task{
{TaskKey: "y", DependsOn: []Dep{{TaskKey: "c"}}},
{TaskKey: "x", DependsOn: []Dep{{TaskKey: "b"}, {TaskKey: "a"}}},
}},
want: nil,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := GetStructDiff(tt.a, tt.b, sliceKeys)
assert.NoError(t, err)
assert.Equal(t, tt.want, resolveChanges(got))
})
}
}
type Nested struct {
Items []Item `json:"items,omitempty"`
}
type Item struct {
ID string `json:"id,omitempty"`
Value int `json:"value,omitempty"`
}
type Root struct {
Nested []Nested `json:"nested,omitempty"`
}
func itemKeyFunc(item Item) (string, string) {
return "id", item.ID
}
func TestGetStructDiffNestedSliceKeys(t *testing.T) {
sliceKeys := map[string]KeyFunc{
"nested[*].items": itemKeyFunc,
}
tests := []struct {
name string
a, b any
want []ResolvedChange
}{
{
name: "nested slice with same keys different order",
a: Root{Nested: []Nested{{Items: []Item{{ID: "x", Value: 1}, {ID: "y", Value: 2}}}}},
b: Root{Nested: []Nested{{Items: []Item{{ID: "y", Value: 2}, {ID: "x", Value: 1}}}}},
want: nil,
},
{
name: "nested slice field change",
a: Root{Nested: []Nested{{Items: []Item{{ID: "x", Value: 1}}}}},
b: Root{Nested: []Nested{{Items: []Item{{ID: "x", Value: 99}}}}},
want: []ResolvedChange{{Field: "nested[0].items[id='x'].value", Old: 1, New: 99}},
},
{
name: "nested slice element added",
a: Root{Nested: []Nested{{Items: []Item{{ID: "x", Value: 1}}}}},
b: Root{Nested: []Nested{{Items: []Item{{ID: "x", Value: 1}, {ID: "y", Value: 2}}}}},
want: []ResolvedChange{{Field: "nested[0].items[id='y']", Old: nil, New: Item{ID: "y", Value: 2}}},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := GetStructDiff(tt.a, tt.b, sliceKeys)
assert.NoError(t, err)
assert.Equal(t, tt.want, resolveChanges(got))
})
}
}
func TestGetStructDiffSliceKeysInvalidFunc(t *testing.T) {
tests := []struct {
name string
keyFunc any
errMsg string
}{
{
name: "not a function",
keyFunc: "not a function",
errMsg: "KeyFunc must be a function, got string",
},
{
name: "wrong number of parameters",
keyFunc: func() (string, string) { return "", "" },
errMsg: "KeyFunc must have exactly 1 parameter, got 0",
},
{
name: "too many parameters",
keyFunc: func(a, b Task) (string, string) { return "", "" },
errMsg: "KeyFunc must have exactly 1 parameter, got 2",
},
{
name: "wrong number of returns",
keyFunc: func(t Task) string { return "" },
errMsg: "KeyFunc must return exactly 2 values, got 1",
},
{
name: "wrong first return type",
keyFunc: func(t Task) (int, string) { return 0, "" },
errMsg: "KeyFunc must return (string, string), got (int, string)",
},
{
name: "wrong second return type",
keyFunc: func(t Task) (string, int) { return "", 0 },
errMsg: "KeyFunc must return (string, string), got (string, int)",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
sliceKeys := map[string]KeyFunc{"tasks": tt.keyFunc}
a := Job{Tasks: []Task{{TaskKey: "a"}}}
b := Job{Tasks: []Task{{TaskKey: "a"}}}
_, err := GetStructDiff(a, b, sliceKeys)
assert.EqualError(t, err, tt.errMsg)
})
}
}
func TestGetStructDiffSliceKeysWrongArgType(t *testing.T) {
// Function expects Item but slice contains Task
sliceKeys := map[string]KeyFunc{
"tasks": func(item Item) (string, string) {
return "id", item.ID
},
}
a := Job{Tasks: []Task{{TaskKey: "a"}}}
b := Job{Tasks: []Task{{TaskKey: "b"}}}
_, err := GetStructDiff(a, b, sliceKeys)
assert.EqualError(t, err, "KeyFunc expects structdiff.Item, got structdiff.Task")
}
func TestGetStructDiffSliceKeysDuplicates(t *testing.T) {
sliceKeys := map[string]KeyFunc{
"tasks": taskKeyFunc,
}
tests := []struct {
name string
a, b Job
want []ResolvedChange
}{
{
name: "same duplicates no change",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}, {TaskKey: "a", Description: "2"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}, {TaskKey: "a", Description: "2"}}},
want: nil,
},
{
name: "duplicates with field change",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}, {TaskKey: "a", Description: "2"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}, {TaskKey: "a", Description: "changed"}}},
want: []ResolvedChange{{Field: "tasks[task_key='a'].description", Old: "2", New: "changed"}},
},
{
name: "extra in old is deleted",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}, {TaskKey: "a", Description: "2"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}}},
want: []ResolvedChange{{Field: "tasks[task_key='a']", Old: Task{TaskKey: "a", Description: "2"}, New: nil}},
},
{
name: "extra in new is added",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}, {TaskKey: "a", Description: "2"}}},
want: []ResolvedChange{{Field: "tasks[task_key='a']", Old: nil, New: Task{TaskKey: "a", Description: "2"}}},
},
{
name: "two in old one in new with change",
a: Job{Tasks: []Task{{TaskKey: "a", Description: "1"}, {TaskKey: "a", Description: "2"}}},
b: Job{Tasks: []Task{{TaskKey: "a", Description: "changed"}}},
want: []ResolvedChange{
{Field: "tasks[task_key='a'].description", Old: "1", New: "changed"},
{Field: "tasks[task_key='a']", Old: Task{TaskKey: "a", Description: "2"}, New: nil},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := GetStructDiff(tt.a, tt.b, sliceKeys)
assert.NoError(t, err)
assert.Equal(t, tt.want, resolveChanges(got))
})
}
}
// An anonymous field carrying a json name is a named field to encoding/json: it serializes as
// a nested object, so a change inside it belongs at that nested path.
type DiffEmbedLeaf struct {
Value string `json:"value,omitempty"`
}
type diffTaggedEmbed struct {
DiffEmbedLeaf `json:"leaf"`
Own string `json:"own,omitempty"`
}
func TestDiffTaggedEmbedIsReportedUnderItsName(t *testing.T) {
before := &diffTaggedEmbed{Value: "before", Own: "o"}
after := &diffTaggedEmbed{Value: "after", Own: "o"}
blob, err := json.Marshal(after)
require.NoError(t, err)
assert.JSONEq(t, `{"leaf":{"value":"after"},"own":"o"}`, string(blob))
changes, err := GetStructDiff(before, after, nil)
require.NoError(t, err)
require.Len(t, changes, 1)
assert.Equal(t, "leaf.value", changes[0].Path.String())
}
// namedMapKey is a defined string type used as a map key, like config's
// ScriptHook (`type ScriptHook string`). Its kind is String but its dynamic
// type is not string.
type namedMapKey string
type namedKeyMapHolder struct {
M map[namedMapKey]string `json:"m"`
}
// TestGetStructDiffNamedStringMapKey guards against a regression where
// diffMapStringKey extracted keys with a `k.Interface().(string)` assertion,
// which panics for a defined string key type (routing only checks the key's
// Kind is String). Value.String() handles both string and named-string keys.
func TestGetStructDiffNamedStringMapKey(t *testing.T) {
a := namedKeyMapHolder{M: map[namedMapKey]string{"pre": "a", "post": "x"}}
b := namedKeyMapHolder{M: map[namedMapKey]string{"pre": "b", "post": "x"}}
got, err := GetStructDiff(&a, &b, nil)
assert.NoError(t, err)
assert.Equal(t, []ResolvedChange{{Field: "m['pre']", Old: "a", New: "b"}}, resolveChanges(got))
}
// Types for the "whole block" tests below: two levels of nesting under an
// optional pointer, mirroring a schema like Outer{Field *Mid{A *Inner{b,c}}}.
type wbInner struct {
B string `json:"b,omitempty"`
C string `json:"c,omitempty"`
}
type wbMid struct {
A *wbInner `json:"a,omitempty"`
}
type wbOuter struct {
Field *wbMid `json:"field,omitempty"`
}
// TestGetStructDiffWholeBlock documents the "whole block" bug: when a nested
// struct is nil on one side, the diff records a single change at the level where
// the nil appears instead of descending to the differing leaves. The want values
// below are the CURRENT (buggy) output; the commented "should be" lines are what
// leaf-level decomposition must produce, and this test is expected to change when
// the bug is fixed.
func TestGetStructDiffWholeBlock(t *testing.T) {