-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
checker.go
294 lines (258 loc) · 8.84 KB
/
checker.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
// SPDX-License-Identifier: Apache-2.0
// Copyright 2018-2019 Authors of Cilium
package checker
import (
"fmt"
"reflect"
"regexp"
"github.com/cilium/cilium/pkg/comparator"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"gopkg.in/check.v1"
)
type diffChecker struct {
*check.CheckerInfo
}
// DeepEquals is a GoCheck checker that does a diff between two objects and
// pretty-prints any difference between the two. It can act as a substitute
// for DeepEquals.
var (
defaultParams = []string{"obtained", "expected"}
DeepEquals check.Checker = &diffChecker{
&check.CheckerInfo{Name: "Diff", Params: defaultParams},
}
)
// Check performs a diff between two objects provided as parameters, and
// returns either true if the objects are identical, or false otherwise. If
// it returns false, it also returns the unified diff between the expected
// and obtained output.
func (checker *diffChecker) Check(params []interface{}, names []string) (result bool, error string) {
if len(params) != 2 || len(names) != 2 {
return false, "params and names must be of length 2"
}
if reflect.DeepEqual(params[0], params[1]) {
return true, ""
}
return false, comparator.CompareWithNames(params[0], params[1], names[0], names[1])
}
// DeepEqual tests whether two parameters are deeply equal, and returns true if
// they are. If the objects are not deeply equal, then the second return value
// includes a json representation of the difference between the parameters.
func DeepEqual(params ...interface{}) (bool, string) {
return DeepEquals.Check(params, defaultParams)
}
type cmpChecker struct {
*check.CheckerInfo
}
// Equals is a GoCheck checker that does a diff between two objects and
// pretty-prints any difference between the two. It can act as a substitute
// for DeepEquals.
var (
cmpParams = []string{"obtained", "expected"}
Equals check.Checker = &cmpChecker{
&check.CheckerInfo{Name: "Equals", Params: cmpParams},
}
)
// Check performs a diff between two objects provided as parameters, and
// returns either true if the objects are identical, or false otherwise. If
// it returns false, it also returns the unified diff between the expected
// and obtained output.
func (checker *cmpChecker) Check(params []interface{}, _ []string) (result bool, error string) {
if len(params) < 2 {
return false, "Parameter missing"
}
// Diff expects to receive parameters in order ("expected",
// "obtained"), but our convention is to pass them as
// ("obtained", "expected"), so reverse them here.
diff := cmp.Diff(params[1], params[0], DeepAllowUnexported(params[1], params[0]))
return diff == "", diff
}
// Equal tests whether two parameters are deeply equal, and returns true if
// they are. If the objects are not deeply equal, then the second return value
// includes a json representation of the difference between the parameters.
func Equal(params ...interface{}) (bool, string) {
return Equals.Check(params, cmpParams)
}
func DeepAllowUnexported(vs ...interface{}) cmp.Option {
m := make(map[reflect.Type]struct{})
for _, v := range vs {
structTypes(reflect.ValueOf(v), m)
}
typs := make([]interface{}, 0, len(m))
for t := range m {
typs = append(typs, reflect.New(t).Elem().Interface())
}
return cmp.AllowUnexported(typs...)
}
func structTypes(v reflect.Value, m map[reflect.Type]struct{}) {
if !v.IsValid() {
return
}
switch v.Kind() {
case reflect.Ptr:
if !v.IsNil() {
structTypes(v.Elem(), m)
}
case reflect.Interface:
if !v.IsNil() {
structTypes(v.Elem(), m)
}
case reflect.Slice, reflect.Array:
for i := 0; i < v.Len(); i++ {
structTypes(v.Index(i), m)
}
case reflect.Map:
for _, k := range v.MapKeys() {
structTypes(v.MapIndex(k), m)
}
case reflect.Struct:
m[v.Type()] = struct{}{}
for i := 0; i < v.NumField(); i++ {
structTypes(v.Field(i), m)
}
}
}
type cmpExportedChecker struct {
*check.CheckerInfo
}
// ExportedEquals is a GoCheck checker that does a diff between two objects and
// pretty-prints any difference between the two. Note that unexported struct
// fields are NOT included in the comparison! Equals can act as a substitute
// for DeepEquals with the exception that unexported struct fields are ignored.
var ExportedEquals check.Checker = &cmpExportedChecker{&check.CheckerInfo{Name: "ExportedEquals", Params: cmpParams}}
// Check performs a diff between two objects provided as parameters, and
// returns either true if the objects are identical, or false otherwise. If
// it returns false, it also returns the unified diff between the expected
// and obtained output.
func (checker *cmpExportedChecker) Check(params []interface{}, _ []string) (result bool, error string) {
if len(params) < 2 {
return false, "Parameter missing"
}
// Diff expects to receive parameters in order ("expected",
// "obtained"), but our convention is to pass them as
// ("obtained", "expected"), so reverse them here.
diff := cmp.Diff(params[1], params[0], DeepIgnoreUnexported(params[1], params[0]))
return diff == "", diff
}
// ExportedEqual tests whether two parameters are deeply equal, when considering
// only exported fields, and returns true if they are. If the objects are not
// deeply equal, then the second return value includes a json representation of
// the difference between the parameters.
func ExportedEqual(params ...interface{}) (bool, string) {
return Equals.Check(params, cmpParams)
}
func DeepIgnoreUnexported(vs ...interface{}) cmp.Option {
m := make(map[reflect.Type]struct{})
for _, v := range vs {
exportedStructTypes(reflect.ValueOf(v), m)
}
typs := make([]interface{}, 0, len(m))
for t := range m {
typs = append(typs, reflect.New(t).Elem().Interface())
}
return cmpopts.IgnoreUnexported(typs...)
}
func exportedStructTypes(v reflect.Value, m map[reflect.Type]struct{}) {
exportedUniqueStructTypes(v, m, make(map[uintptr]struct{}))
}
func exportedUniqueStructTypes(v reflect.Value, m map[reflect.Type]struct{}, s map[uintptr]struct{}) {
if !v.IsValid() {
return
}
switch v.Kind() {
case reflect.Ptr:
if !v.IsNil() {
addr := v.Pointer()
if _, found := s[addr]; found {
return // prevent infinite loops
}
// mark pointer as seen
s[addr] = struct{}{}
exportedUniqueStructTypes(v.Elem(), m, s)
}
case reflect.Interface:
if !v.IsNil() {
exportedUniqueStructTypes(v.Elem(), m, s)
}
case reflect.Slice, reflect.Array:
for i := 0; i < v.Len(); i++ {
exportedUniqueStructTypes(v.Index(i), m, s)
}
case reflect.Map:
for _, k := range v.MapKeys() {
exportedUniqueStructTypes(v.MapIndex(k), m, s)
}
case reflect.Struct:
// mark type's unexported fields to be ignored
m[v.Type()] = struct{}{}
for i := 0; i < v.NumField(); i++ {
// Only descend to exported fields
if v.Field(i).CanInterface() {
exportedUniqueStructTypes(v.Field(i), m, s)
}
}
}
}
type matchesChecker struct {
*check.CheckerInfo
}
// PartialMatches is a GoCheck checker that the provided regex matches at least
// part of the provided string. It can act as a substitute for Matches.
var (
matchesParams = []string{"value", "regex"}
PartialMatches check.Checker = &matchesChecker{
&check.CheckerInfo{Name: "PartialMatches", Params: matchesParams},
}
)
// Check performs a regular expression search on the expression provided as the
// second parameter and the value provided as the first parameter. It returns
// true if the value matches the expression, otherwise it returns false.
func (checker *matchesChecker) Check(params []interface{}, _ []string) (result bool, error string) {
valueStr, ok := params[0].(string)
if !ok {
return false, "Value must be a string"
}
regexStr, ok := params[1].(string)
if !ok {
return false, "Regex must be a string"
}
matches, err := regexp.MatchString(regexStr, valueStr)
if err != nil {
return false, "Failed to compile regex: " + err.Error()
}
return matches, ""
}
// -----------------------------------------------------------------------
// HasKey checker.
type hasKeyChecker struct {
*check.CheckerInfo
}
// The HasKey checker verifies that the obtained map contains the
// provided key.
//
// For example:
//
// c.Assert(myMap, HasKey, "five")
//
var HasKey check.Checker = &hasKeyChecker{
&check.CheckerInfo{Name: "HasKey", Params: []string{"map", "key"}},
}
func (checker *hasKeyChecker) Check(params []interface{}, names []string) (result bool, error string) {
m := reflect.ValueOf(params[0])
mType := m.Type()
key := reflect.ValueOf(params[1])
keyType := key.Type()
if mType.Kind() != reflect.Map {
return false, fmt.Sprintf("'%s' must be a map", names[0])
}
if mType.Key() != keyType {
return false, fmt.Sprintf("'%s' must be of '%s's key type (%s, not %s)",
names[1], names[0], mType.Key(), keyType)
}
for _, v := range m.MapKeys() {
if v.Interface() == key.Interface() {
return true, ""
}
}
return false, fmt.Sprintf("'%s' has no key %v", names[0], key.Interface())
}