-
Notifications
You must be signed in to change notification settings - Fork 7
/
gen_bool_compare.go
208 lines (185 loc) · 9.47 KB
/
gen_bool_compare.go
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
package main
import (
"strings"
"text/template"
"github.com/Antonboom/testifylint/internal/checkers"
)
type BoolCompareTestsGenerator struct{}
func (BoolCompareTestsGenerator) Checker() checkers.Checker {
return checkers.NewBoolCompare()
}
func (g BoolCompareTestsGenerator) TemplateData() any {
var (
checker = g.Checker().Name()
reportUse = checker + ": use %s.%s"
reportSimplify = checker + ": need to simplify the assertion"
)
type test struct {
Name string
InvalidAssertions []Assertion
ValidAssertions []Assertion
}
return struct {
CheckerName CheckerName
Tests []test
IgnoredAssertions []Assertion
}{
CheckerName: CheckerName(checker),
Tests: []test{
{
Name: "assert.True cases",
InvalidAssertions: []Assertion{
{Fn: "Equal", Argsf: "predicate, true", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "Equal", Argsf: "true, predicate", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "EqualValues", Argsf: "predicate, true", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "EqualValues", Argsf: "true, predicate", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "Exactly", Argsf: "predicate, true", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "Exactly", Argsf: "true, predicate", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "NotEqual", Argsf: "predicate, false", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "NotEqual", Argsf: "false, predicate", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "NotEqualValues", Argsf: "predicate, false", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "NotEqualValues", Argsf: "false, predicate", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "predicate == true", ReportMsgf: reportSimplify, ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "true == predicate", ReportMsgf: reportSimplify, ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "predicate == false", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "false == predicate", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "predicate != true", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "true != predicate", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "predicate != false", ReportMsgf: reportSimplify, ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "false != predicate", ReportMsgf: reportSimplify, ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "!predicate", ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: "predicate"},
{Fn: "False", Argsf: `!result["flag"].(bool)`, ReportMsgf: reportUse, ProposedFn: "True", ProposedArgsf: `result["flag"].(bool)`}, //nolint:lll
},
ValidAssertions: []Assertion{
{Fn: "True", Argsf: "predicate"},
},
},
{
Name: "assert.False cases",
InvalidAssertions: []Assertion{
{Fn: "Equal", Argsf: "predicate, false", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "Equal", Argsf: "false, predicate", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "EqualValues", Argsf: "predicate, false", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "EqualValues", Argsf: "false, predicate", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "Exactly", Argsf: "predicate, false", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "Exactly", Argsf: "false, predicate", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "NotEqual", Argsf: "predicate, true", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "NotEqual", Argsf: "true, predicate", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "NotEqualValues", Argsf: "predicate, true", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "NotEqualValues", Argsf: "true, predicate", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "predicate == true", ReportMsgf: reportSimplify, ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "true == predicate", ReportMsgf: reportSimplify, ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "predicate == false", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "false == predicate", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "predicate != true", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "true != predicate", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "predicate != false", ReportMsgf: reportSimplify, ProposedArgsf: "predicate"},
{Fn: "False", Argsf: "false != predicate", ReportMsgf: reportSimplify, ProposedArgsf: "predicate"},
{Fn: "True", Argsf: "!predicate", ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: "predicate"},
{Fn: "True", Argsf: `!result["flag"].(bool)`, ReportMsgf: reportUse, ProposedFn: "False", ProposedArgsf: `result["flag"].(bool)`}, //nolint:lll
},
ValidAssertions: []Assertion{
{Fn: "False", Argsf: "predicate"},
},
},
},
IgnoredAssertions: []Assertion{
{Fn: "Equal", Argsf: "true, true"},
{Fn: "Equal", Argsf: "false, false"},
{Fn: "NotEqual", Argsf: "true, true"},
{Fn: "NotEqual", Argsf: "false, false"},
{Fn: "True", Argsf: "true == true"},
{Fn: "True", Argsf: "false == false"},
{Fn: "False", Argsf: "true == true"},
{Fn: "False", Argsf: "false == false"},
{Fn: "True", Argsf: "true != true"},
{Fn: "True", Argsf: "false != false"},
{Fn: "False", Argsf: "true != true"},
{Fn: "False", Argsf: "false != false"},
{Fn: "Equal", Argsf: "predicate, predicate"},
{Fn: "NotEqual", Argsf: "predicate, predicate"},
{Fn: "True", Argsf: "predicate == predicate"},
{Fn: "False", Argsf: "predicate == predicate"},
{Fn: "True", Argsf: "predicate != predicate"},
{Fn: "False", Argsf: "predicate != predicate"},
// `any` cases.
{Fn: "Equal", Argsf: `true, result["flag"]`},
{Fn: "Equal", Argsf: `result["flag"], true`},
{Fn: "Equal", Argsf: `false, result["flag"]`},
{Fn: "Equal", Argsf: `result["flag"], false`},
{Fn: "NotEqual", Argsf: `true, result["flag"]`},
{Fn: "NotEqual", Argsf: `result["flag"], true`},
{Fn: "NotEqual", Argsf: `false, result["flag"]`},
{Fn: "NotEqual", Argsf: `result["flag"], false`},
// https://go.dev/ref/spec#Comparison_operators
// A value x of non-interface type X and a value t of interface type T can be compared
// if type X is comparable and X implements T.
{Fn: "True", Argsf: `true == result["flag"]`},
{Fn: "True", Argsf: `result["flag"] == true`},
{Fn: "True", Argsf: `false == result["flag"]`},
{Fn: "True", Argsf: `result["flag"] == false`},
{Fn: "False", Argsf: `true == result["flag"]`},
{Fn: "False", Argsf: `result["flag"] == true`},
{Fn: "False", Argsf: `false == result["flag"]`},
{Fn: "False", Argsf: `result["flag"] == false`},
{Fn: "True", Argsf: `true != result["flag"]`},
{Fn: "True", Argsf: `result["flag"] != true`},
{Fn: "True", Argsf: `false != result["flag"]`},
{Fn: "True", Argsf: `result["flag"] != false`},
{Fn: "False", Argsf: `true != result["flag"]`},
{Fn: "False", Argsf: `result["flag"] != true`},
{Fn: "False", Argsf: `false != result["flag"]`},
{Fn: "False", Argsf: `result["flag"] != false`},
{Fn: "Equal", Argsf: "foo, foo"},
{Fn: "NotEqual", Argsf: "foo, foo"},
{Fn: "True", Argsf: "foo == foo"},
{Fn: "False", Argsf: "foo == foo"},
{Fn: "True", Argsf: "foo != foo"},
{Fn: "False", Argsf: "foo != foo"},
},
}
}
func (BoolCompareTestsGenerator) ErroredTemplate() Executor {
return template.Must(template.New("BoolCompareTestsGenerator.ErroredTemplate").
Funcs(fm).
Parse(boolCompareTestTmpl))
}
func (BoolCompareTestsGenerator) GoldenTemplate() Executor {
return template.Must(template.New("BoolCompareTestsGenerator.GoldenTemplate").
Funcs(fm).
Parse(strings.ReplaceAll(boolCompareTestTmpl, "NewAssertionExpander", "NewAssertionExpander.AsGolden")))
}
const boolCompareTestTmpl = header + `
package {{ .CheckerName.AsPkgName }}
import (
"testing"
"github.com/stretchr/testify/assert"
)
func {{ .CheckerName.AsTestName }}(t *testing.T) {
var predicate bool
result := map[string]any{}
{{ range $ti, $test := $.Tests }}
// {{ $test.Name }}.
{
// Invalid.
{{- range $ai, $assrn := $test.InvalidAssertions }}
{{ NewAssertionExpander.Expand $assrn "assert" "t" nil }}
{{- end }}
// Valid.
{{- range $ai, $assrn := $test.ValidAssertions }}
{{ NewAssertionExpander.Expand $assrn "assert" "t" nil }}
{{- end }}
}
{{ end -}}
}
func {{ .CheckerName.AsTestName }}_Ignored(t *testing.T) {
var predicate bool
var foo any
result := map[string]any{}
foo = true
assert.Equal(t, true, foo)
{{ range $ai, $assrn := $.IgnoredAssertions }}
{{ NewAssertionExpander.Expand $assrn "assert" "t" nil }}
{{- end }}
}
`