Skip to content

Commit 9612d6a

Browse files
rhysdrhysd
authored
Merge pull request #475 from alexandear/refactor-test-cmp-diff
simplify tests with cmp.Diff
2 parents 919b72a + 816ca54 commit 9612d6a

13 files changed

+56
-57
lines changed

‎config_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ func TestConfigParseSelfHostedRunnerOK(t *testing.T) {
4949
t.Fatal(err)
5050
}
5151

52-
if !cmp.Equal(c.SelfHostedRunner.Labels, tc.labels) {
53-
t.Fatal(cmp.Diff(c.SelfHostedRunner.Labels, tc.labels))
52+
if diff := cmp.Diff(c.SelfHostedRunner.Labels, tc.labels); diff != "" {
53+
t.Fatal(diff)
5454
}
5555
})
5656
}
@@ -224,8 +224,8 @@ func TestConfigReadFileOK(t *testing.T) {
224224
t.Fatal(err)
225225
}
226226
labels := []string{"foo", "bar"}
227-
if !cmp.Equal(c.SelfHostedRunner.Labels, labels) {
228-
t.Fatal(cmp.Diff(c.SelfHostedRunner.Labels, labels))
227+
if diff := cmp.Diff(c.SelfHostedRunner.Labels, labels); diff != "" {
228+
t.Fatal(diff)
229229
}
230230
}
231231

‎error_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -488,8 +488,8 @@ func TestErrorPrintSerializedIntoJSON(t *testing.T) {
488488
if err := json.Unmarshal(b.Bytes(), &decoded); err != nil {
489489
t.Fatal(err)
490490
}
491-
if !cmp.Equal(testErrorTemplateFields, decoded) {
492-
t.Fatal(cmp.Diff(testErrorTemplateFields, decoded))
491+
if diff := cmp.Diff(testErrorTemplateFields, decoded); diff != "" {
492+
t.Fatal(diff)
493493
}
494494
}
495495

‎expr_parser_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -596,8 +596,8 @@ func TestParseExpressionSyntaxOK(t *testing.T) {
596596
t.Fatal("Parse error:", err)
597597
}
598598

599-
if !cmp.Equal(tc.expected, n, opts...) {
600-
t.Fatalf("wanted:\n%#v\n\nbut got:\n%#v\n\ndiff:\n%s\n", tc.expected, n, cmp.Diff(tc.expected, n, opts...))
599+
if diff := cmp.Diff(tc.expected, n, opts...); diff != "" {
600+
t.Fatalf("wanted:\n%#v\n\nbut got:\n%#v\n\ndiff:\n%s\n", tc.expected, n, diff)
601601
}
602602
})
603603
}

‎expr_sema_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -788,8 +788,8 @@ func TestExprSemanticsCheckOK(t *testing.T) {
788788
t.Fatal("semantics check failed:", errs)
789789
}
790790

791-
if !cmp.Equal(tc.expected, ty) {
792-
t.Fatalf("wanted: %s\nbut got:%s\ndiff:\n%s", tc.expected.String(), ty.String(), cmp.Diff(tc.expected, ty))
791+
if diff := cmp.Diff(tc.expected, ty); diff != "" {
792+
t.Fatalf("wanted: %s\nbut got:%s\ndiff:\n%s", tc.expected.String(), ty.String(), diff)
793793
}
794794
})
795795
}

‎expr_type_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -812,14 +812,14 @@ func TestExprTypeMergeComplicated(t *testing.T) {
812812
t.Run(tc.what, func(t *testing.T) {
813813
opt := cmpopts.EquateEmpty()
814814
ty := tc.with.Merge(tc.ty)
815-
if !cmp.Equal(ty, tc.want, opt) {
815+
if diff := cmp.Diff(tc.want, ty, opt); diff != "" {
816816
t.Fatalf(
817817
"%s was merged with %s as %s while expecting %s\ndiff:\n%s",
818818
tc.ty.String(),
819819
tc.with.String(),
820820
ty.String(),
821821
tc.want.String(),
822-
cmp.Diff(tc.want, ty, opt),
822+
diff,
823823
)
824824
}
825825
})

‎linter_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,8 @@ func TestLinterFormatErrorMessageOK(t *testing.T) {
396396
have = strings.ReplaceAll(have, escaped, slash)
397397
}
398398

399-
if !cmp.Equal(want, have) {
400-
t.Fatal(cmp.Diff(want, have))
399+
if diff := cmp.Diff(want, have); diff != "" {
400+
t.Fatal(diff)
401401
}
402402
})
403403
}
@@ -452,8 +452,8 @@ func TestLinterFormatErrorMessageInSARIF(t *testing.T) {
452452
panic(err)
453453
}
454454

455-
if !cmp.Equal(want, have) {
456-
t.Fatal(cmp.Diff(want, have))
455+
if diff := cmp.Diff(want, have); diff != "" {
456+
t.Fatal(diff)
457457
}
458458
}
459459

‎reusable_workflow_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,8 @@ func TestReusableWorkflowUnmarshalOK(t *testing.T) {
242242
t.Fatal(err)
243243
}
244244

245-
if !cmp.Equal(m, tc.want) {
246-
t.Fatal("Parse result is unexpected. diff:\n" + cmp.Diff(m, tc.want))
245+
if diff := cmp.Diff(m, tc.want); diff != "" {
246+
t.Fatal("Parse result is unexpected. diff:\n" + diff)
247247
}
248248
})
249249
}
@@ -363,8 +363,8 @@ func TestReusableWorkflowCacheFindMetadataOK(t *testing.T) {
363363
if err != nil {
364364
t.Fatal(err)
365365
}
366-
if !cmp.Equal(m, testReusableWorkflowWantedMetadata) {
367-
t.Fatal(cmp.Diff(m, testReusableWorkflowWantedMetadata))
366+
if diff := cmp.Diff(m, testReusableWorkflowWantedMetadata); diff != "" {
367+
t.Fatal(diff)
368368
}
369369

370370
m2, err := c.FindMetadata("./ok.yaml")
@@ -630,8 +630,8 @@ func TestReusableWorkflowMetadataFromASTNodeInputs(t *testing.T) {
630630
t.Fatal("Event was not converted to event")
631631
}
632632

633-
if !cmp.Equal(m.Inputs, tc.want) {
634-
t.Error(cmp.Diff(m.Inputs, tc.want))
633+
if diff := cmp.Diff(m.Inputs, tc.want); diff != "" {
634+
t.Fatal(diff)
635635
}
636636
if len(m.Outputs) != 0 {
637637
t.Error("Outputs are not empty", m.Outputs)
@@ -674,8 +674,8 @@ func TestReusableWorkflowMetadataFromASTNodeOutputs(t *testing.T) {
674674
want[strings.ToLower(o)] = &ReusableWorkflowMetadataOutput{o}
675675
}
676676

677-
if !cmp.Equal(m.Outputs, want) {
678-
t.Error(cmp.Diff(m.Outputs, want))
677+
if diff := cmp.Diff(m.Outputs, want); diff != "" {
678+
t.Fatal(diff)
679679
}
680680
if len(m.Inputs) != 0 {
681681
t.Error("Inputs are not empty", m.Inputs)
@@ -733,8 +733,8 @@ func TestReusableWorkflowMetadataFromASTNodeSecrets(t *testing.T) {
733733
}
734734
}
735735

736-
if !cmp.Equal(m.Secrets, want) {
737-
t.Error(cmp.Diff(m.Secrets, want))
736+
if diff := cmp.Diff(m.Secrets, want); diff != "" {
737+
t.Fatal(diff)
738738
}
739739
if len(m.Inputs) != 0 {
740740
t.Error("Inputs are not empty", m.Inputs)
@@ -811,8 +811,8 @@ func TestReusableWorkflowMetadataCacheFindOneMetadataConcurrently(t *testing.T)
811811
}
812812

813813
for _, m := range ms {
814-
if !cmp.Equal(testReusableWorkflowWantedMetadata, m) {
815-
t.Fatal(cmp.Diff(testReusableWorkflowWantedMetadata, m))
814+
if diff := cmp.Diff(testReusableWorkflowWantedMetadata, m); diff != "" {
815+
t.Fatal(diff)
816816
}
817817
}
818818

‎rule_deprecated_commands_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ func TestRuleDeprecatedCommandsDetectTargetCommands(t *testing.T) {
117117
have = append(have, ss[1])
118118
}
119119

120-
if !cmp.Equal(have, tc.want) {
121-
t.Fatal(cmp.Diff(have, tc.want))
120+
if diff := cmp.Diff(have, tc.want); diff != "" {
121+
t.Fatal(diff)
122122
}
123123
})
124124
}

‎rule_workflow_call_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ func TestRuleWorkflowCallWriteEventNodeToMetadataCache(t *testing.T) {
152152
},
153153
}
154154

155-
if !cmp.Equal(want, m) {
156-
t.Fatal(cmp.Diff(want, m))
155+
if diff := cmp.Diff(want, m); diff != "" {
156+
t.Fatal(diff)
157157
}
158158
}
159159

‎scripts/check-checks/main_test.go

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package main
22

33
import (
4-
"bytes"
54
"io"
65
"log"
76
"os"
@@ -58,8 +57,8 @@ func TestMainGenerateOK(t *testing.T) {
5857

5958
want := must(os.ReadFile(filepath.FromSlash("testdata/ok/minimal.out")))
6059
have := must(os.ReadFile(path))
61-
if !bytes.Equal(want, have) {
62-
t.Fatal(cmp.Diff(want, have))
60+
if diff := cmp.Diff(want, have); diff != "" {
61+
t.Fatal(diff)
6362
}
6463
}
6564

@@ -141,8 +140,8 @@ func TestUpdateOK(t *testing.T) {
141140
t.Fatal(err)
142141
}
143142
want := must(os.ReadFile(out))
144-
if !bytes.Equal(want, have) {
145-
t.Fatal(cmp.Diff(want, have))
143+
if diff := cmp.Diff(want, have); diff != "" {
144+
t.Fatal(diff)
146145
}
147146
})
148147
}

‎scripts/generate-availability/main_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ func TestOKWriteStdout(t *testing.T) {
3232
}
3333
want := string(b)
3434

35-
if stdout != want {
36-
t.Fatal(cmp.Diff(want, stdout))
35+
if diff := cmp.Diff(stdout, want); diff != "" {
36+
t.Fatal(diff)
3737
}
3838
}
3939

@@ -63,8 +63,8 @@ func TestOKWriteFile(t *testing.T) {
6363
}
6464
have := string(b)
6565

66-
if want != have {
67-
t.Fatal(cmp.Diff(want, have))
66+
if diff := cmp.Diff(want, have); diff != "" {
67+
t.Fatal(diff)
6868
}
6969
}
7070

‎scripts/generate-popular-actions/main_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ func TestReadWriteJSONL(t *testing.T) {
8989
want := string(b)
9090
have := stdout.String()
9191

92-
if want != have {
93-
t.Fatalf("read content and output content differ\n%s", cmp.Diff(want, have))
92+
if diff := cmp.Diff(want, have); diff != "" {
93+
t.Fatalf("read content and output content differ\n%s", diff)
9494
}
9595
})
9696
}
@@ -139,8 +139,8 @@ func TestWriteGoToStdout(t *testing.T) {
139139
want := string(b)
140140
have := stdout.String()
141141

142-
if want != have {
143-
t.Fatalf("read content and output content differ\n%s", cmp.Diff(want, have))
142+
if diff := cmp.Diff(want, have); diff != "" {
143+
t.Fatalf("read content and output content differ\n%s", diff)
144144
}
145145
})
146146
}
@@ -170,8 +170,8 @@ func TestWriteJSONLFile(t *testing.T) {
170170
}
171171
have := string(b)
172172

173-
if want != have {
174-
t.Fatalf("read content and output content differ\n%s", cmp.Diff(want, have))
173+
if diff := cmp.Diff(want, have); diff != "" {
174+
t.Fatalf("read content and output content differ\n%s", diff)
175175
}
176176
}
177177

@@ -199,8 +199,8 @@ func TestWriteGoFile(t *testing.T) {
199199
}
200200
have := string(b)
201201

202-
if want != have {
203-
t.Fatalf("read content and output content differ\n%s", cmp.Diff(want, have))
202+
if diff := cmp.Diff(want, have); diff != "" {
203+
t.Fatalf("read content and output content differ\n%s", diff)
204204
}
205205
}
206206

@@ -231,8 +231,8 @@ func TestFetchRemoteYAML(t *testing.T) {
231231
want := string(b)
232232
have := stdout.String()
233233

234-
if !cmp.Equal(want, have) {
235-
t.Fatalf("fetched JSONL data does not match: %s", cmp.Diff(want, have))
234+
if diff := cmp.Diff(want, have); diff != "" {
235+
t.Fatalf("fetched JSONL data does not match: %s", diff)
236236
}
237237
})
238238
}
@@ -252,8 +252,8 @@ func TestWriteOutdatedActionAsJSONL(t *testing.T) {
252252
panic(err)
253253
}
254254
want, have := string(b), stdout.String()
255-
if want != have {
256-
t.Fatal(cmp.Diff(want, have))
255+
if diff := cmp.Diff(want, have); diff != "" {
256+
t.Fatal(diff)
257257
}
258258
}
259259

‎scripts/generate-webhook-events/main_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ func TestOKWriteStdout(t *testing.T) {
3232
}
3333
want := string(b)
3434

35-
if stdout != want {
36-
t.Fatal(cmp.Diff(want, stdout))
35+
if diff := cmp.Diff(want, stdout); diff != "" {
36+
t.Fatal(diff)
3737
}
3838
}
3939

@@ -63,8 +63,8 @@ func TestOKWriteFile(t *testing.T) {
6363
}
6464
have := string(b)
6565

66-
if want != have {
67-
t.Fatal(cmp.Diff(want, have))
66+
if diff := cmp.Diff(want, have); diff != "" {
67+
t.Fatal(diff)
6868
}
6969
}
7070

0 commit comments

Comments
 (0)