-
Notifications
You must be signed in to change notification settings - Fork 14
/
check.go
378 lines (303 loc) · 6.52 KB
/
check.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
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
package check
import (
"bytes"
"encoding/json"
"fmt"
"reflect"
"regexp"
"strings"
"github.com/ipfs/gateway-conformance/tooling/tmpl"
)
// Base Structure
// ==============
type CheckOutput struct {
Success bool
Reason string
Err error
Hint string
}
type Check[T any] interface {
Check(T) CheckOutput
}
type CheckWithHint[T any] struct {
Check_ Check[T]
Hint string
}
func WithHint[T any](hint string, check Check[T]) CheckWithHint[T] {
return CheckWithHint[T]{
Hint: hint,
Check_: check,
}
}
func (c CheckWithHint[T]) Check(v T) CheckOutput {
output := c.Check_.Check(v)
if output.Hint == "" {
output.Hint = c.Hint
} else {
output.Hint = fmt.Sprintf("%s (%s)", c.Hint, output.Hint)
}
return output
}
var _ Check[string] = CheckWithHint[string]{}
// Base
// ====
type CheckIsEmpty struct {
}
func (c CheckIsEmpty) Check(v []string) CheckOutput {
if len(v) == 0 {
return CheckOutput{
Success: true,
}
}
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expected empty array, got '%s'", v),
}
}
var _ Check[[]string] = CheckIsEmpty{}
func IsEmpty(hint ...string) interface{} {
if len(hint) > 1 {
panic("hint can only be one string")
}
if len(hint) == 1 {
return WithHint[[]string](
hint[0],
CheckIsEmpty{},
)
}
return CheckIsEmpty{}
}
type CheckAnd[T any] struct {
Checks []Check[T]
}
func And[T any](checks ...Check[T]) Check[T] {
return &CheckAnd[T]{
Checks: checks,
}
}
func (c *CheckAnd[T]) Check(v T) CheckOutput {
for _, check := range c.Checks {
output := check.Check(v)
if !output.Success {
return output
}
}
return CheckOutput{
Success: true,
}
}
type CheckIsEqual[T comparable] struct {
Value T
}
func IsEqual(value string, rest ...any) CheckIsEqual[string] {
return CheckIsEqual[string]{
Value: tmpl.Fmt(value, rest...),
}
}
func IsEqualT[T comparable](value T) *CheckIsEqual[T] {
return &CheckIsEqual[T]{
Value: value,
}
}
func (c CheckIsEqual[T]) Check(v T) CheckOutput {
if v == c.Value {
return CheckOutput{
Success: true,
}
}
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expected '%v', got '%v'", c.Value, v),
}
}
var _ Check[string] = CheckIsEqual[string]{}
type CheckIsEqualBytes struct {
Value []byte
}
// golang doesn't support method overloading / generic specialization
func IsEqualBytes(value []byte) Check[[]byte] {
return CheckIsEqualBytes{
Value: value,
}
}
func (c CheckIsEqualBytes) Check(v []byte) CheckOutput {
if bytes.Equal(v, c.Value) {
return CheckOutput{
Success: true,
}
}
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expected '%v', got '%v'", c.Value, v),
}
}
var _ Check[[]byte] = CheckIsEqualBytes{}
func IsEqualWithHint(hint string, value string, rest ...any) CheckWithHint[string] {
return WithHint[string](hint, IsEqual(value, rest...))
}
type CheckUniqAnd struct {
check Check[string]
}
var _ Check[[]string] = &CheckUniqAnd{}
func IsUniqAnd(check Check[string]) Check[[]string] {
return &CheckUniqAnd{
check: check,
}
}
func (c *CheckUniqAnd) Check(v []string) CheckOutput {
if len(v) != 1 {
return CheckOutput{
Success: false,
Reason: "expected one element",
}
}
return c.check.Check(v[0])
}
type CheckHas struct {
values []string
}
var _ Check[[]string] = &CheckHas{}
func Has(values ...string) Check[[]string] {
return &CheckHas{
values: values,
}
}
func (c *CheckHas) Check(v []string) CheckOutput {
for _, value := range c.values {
found := false
for _, v := range v {
if v == value {
found = true
break
}
}
if !found {
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expected to find '%s' in '%s'", value, v),
}
}
}
return CheckOutput{
Success: true,
}
}
type CheckContains struct {
Value string
}
func Contains(value string, rest ...any) Check[string] {
return &CheckContains{
Value: tmpl.Fmt(value, rest...),
}
}
func (c *CheckContains) Check(v string) CheckOutput {
if strings.Contains(v, c.Value) {
return CheckOutput{
Success: true,
}
}
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expect to find substring '%s', got '%s'", c.Value, v),
}
}
func ContainsWithHint(hint string, value string, rest ...any) CheckWithHint[string] {
return WithHint(hint, Contains(value, rest...))
}
var _ Check[string] = &CheckContains{}
type CheckRegexpMatch struct {
Value *regexp.Regexp
}
func (c *CheckRegexpMatch) Check(v string) CheckOutput {
if c.Value.MatchString(v) {
return CheckOutput{
Success: true,
}
}
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expected to match '%s', got '%s'", c.Value.String(), v),
}
}
func Matches(value string, rest ...any) Check[string] {
str := tmpl.Fmt(value, rest...)
return &CheckRegexpMatch{
Value: regexp.MustCompile(str),
}
}
var _ Check[string] = &CheckRegexpMatch{}
type CheckFunc[T any] struct {
Fn func(T) bool
}
func Checks[T any](hint string, f func(T) bool) CheckWithHint[T] {
return WithHint[T](hint, &CheckFunc[T]{
Fn: f,
})
}
func (c CheckFunc[T]) Check(v T) CheckOutput {
if c.Fn(v) {
return CheckOutput{
Success: true,
}
}
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expected to 'f(%v) = true'", v),
}
}
var _ Check[string] = &CheckFunc[string]{}
type CheckNot[T any] struct {
check Check[T]
}
func Not[T any](check Check[T]) Check[T] {
return CheckNot[T]{
check: check,
}
}
func (c CheckNot[T]) Check(v T) CheckOutput {
result := c.check.Check(v)
if result.Success {
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expected %v to fail, but it succeeded", c.check),
}
}
return CheckOutput{
Success: true,
}
}
var _ Check[string] = CheckNot[string]{}
type CheckIsJSONEqual struct {
Value interface{}
}
func IsJSONEqual(value []byte) Check[[]byte] {
var result interface{}
err := json.Unmarshal(value, &result)
if err != nil {
panic(err) // TODO: move a t.Testing around to `t.Fatal` this case
}
return &CheckIsJSONEqual{
Value: result,
}
}
func (c *CheckIsJSONEqual) Check(v []byte) CheckOutput {
var o map[string]any
err := json.Unmarshal(v, &o)
if err != nil {
panic(err) // TODO: move a t.Testing around to call `t.Fatal` on this case
}
if reflect.DeepEqual(o, c.Value) {
return CheckOutput{
Success: true,
}
}
b, err := json.Marshal(c.Value)
if err != nil {
panic(err) // TODO: move a t.Testing around to call `t.Fatal` on this case
}
return CheckOutput{
Success: false,
Reason: fmt.Sprintf("expected '%s', got '%s'", string(b), string(v)),
}
}
var _ Check[[]byte] = &CheckIsJSONEqual{}