-
Notifications
You must be signed in to change notification settings - Fork 2
/
value.go
286 lines (271 loc) · 7.54 KB
/
value.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
package httpexpect
import (
"reflect"
)
// Value provides methods to inspect attached interface{} object
// (Go representation of arbitrary JSON value) and cast it to
// concrete type.
type Value struct {
chain chain
value interface{}
}
// NewValue returns a new Value given a reporter used to report failures
// and value to be inspected.
//
// reporter should not be nil, but value may be nil.
//
// Example:
// value := NewValue(t, map[string]interface{}{"foo": 123})
// value.Object()
//
// value := NewValue(t, []interface{}{"foo", 123})
// value.Array()
//
// value := NewValue(t, "foo")
// value.String()
//
// value := NewValue(t, 123)
// value.Number()
//
// value := NewValue(t, true)
// value.Boolean()
//
// value := NewValue(t, nil)
// value.Null()
func NewValue(reporter Reporter, value interface{}) *Value {
chain := makeChain(reporter)
if value != nil {
value, _ = canonValue(&chain, value)
}
return &Value{chain, value}
}
// Raw returns underlying value attached to Value.
// This is the value originally passed to NewValue, converted to canonical form.
//
// Example:
// value := NewValue(t, "foo")
// assert.Equal(t, "foo", number.Raw().(string))
func (v *Value) Raw() interface{} {
return v.value
}
// Path returns a new Value object for child object(s) matching given
// JSONPath expression.
//
// JSONPath is a simple XPath-like query language.
// See http://goessner.net/articles/JsonPath/.
//
// We currently use https://github.com/yalp/jsonpath, which implements
// only a subset of JSONPath, yet useful for simple queries. It doesn't
// support filters and requires double quotes for strings.
//
// Example 1:
// json := `{"users": [{"name": "john"}, {"name": "bob"}]}`
// value := NewValue(t, json)
//
// value.Path("$.users[0].name").String().Equal("john")
// value.Path("$.users[1].name").String().Equal("bob")
//
// Example 2:
// json := `{"yfGH2a": {"user": "john"}, "f7GsDd": {"user": "john"}}`
// value := NewValue(t, json)
//
// for _, user := range value.Path("$..user").Array().Iter() {
// user.String().Equal("john")
// }
func (v *Value) Path(path string) *Value {
return getPath(&v.chain, v.value, path)
}
// Schema succeeds if value matches given JSON Schema.
//
// JSON Schema specifies a JSON-based format to define the structure of
// JSON data. See http://json-schema.org/.
// We use https://github.com/xeipuuv/gojsonschema implementation.
//
// schema should be one of the following:
// - go value that can be json.Marshal-ed to a valid schema
// - type convertible to string containing valid schema
// - type convertible to string containing valid http:// or file:// URI,
// pointing to reachable and valid schema
//
// Example 1:
// schema := `{
// "type": "object",
// "properties": {
// "foo": {
// "type": "string"
// },
// "bar": {
// "type": "integer"
// }
// },
// "require": ["foo", "bar"]
// }`
//
// value := NewValue(t, map[string]interface{}{
// "foo": "a",
// "bar": 1,
// })
//
// value.Schema(schema)
//
// Example 2:
// value := NewValue(t, data)
// value.Schema("http://example.com/schema.json")
func (v *Value) Schema(schema interface{}) *Value {
checkSchema(&v.chain, v.value, schema)
return v
}
// Object returns a new Object attached to underlying value.
//
// If underlying value is not an object (map[string]interface{}), failure is reported
// and empty (but non-nil) value is returned.
//
// Example:
// value := NewValue(t, map[string]interface{}{"foo": 123})
// value.Object().ContainsKey("foo")
func (v *Value) Object() *Object {
data, ok := v.value.(map[string]interface{})
if !ok {
v.chain.fail("\nexpected object value (map or struct), but got:\n%s",
dumpValue(v.value))
}
return &Object{v.chain, data}
}
// Array returns a new Array attached to underlying value.
//
// If underlying value is not an array ([]interface{}), failure is reported and empty
// (but non-nil) value is returned.
//
// Example:
// value := NewValue(t, []interface{}{"foo", 123})
// value.Array().Elements("foo", 123)
func (v *Value) Array() *Array {
data, ok := v.value.([]interface{})
if !ok {
v.chain.fail("\nexpected array value, but got:\n%s",
dumpValue(v.value))
}
return &Array{v.chain, data}
}
// String returns a new String attached to underlying value.
//
// If underlying value is not string, failure is reported and empty (but non-nil)
// value is returned.
//
// Example:
// value := NewValue(t, "foo")
// value.String().EqualFold("FOO")
func (v *Value) String() *String {
data, ok := v.value.(string)
if !ok {
v.chain.fail("\nexpected string value, but got:\n%s",
dumpValue(v.value))
}
return &String{v.chain, data}
}
// Number returns a new Number attached to underlying value.
//
// If underlying value is not a number (numeric type convertible to float64), failure
// is reported and empty (but non-nil) value is returned.
//
// Example:
// value := NewValue(t, 123)
// value.Number().InRange(100, 200)
func (v *Value) Number() *Number {
data, ok := v.value.(float64)
if !ok {
v.chain.fail("\nexpected numeric value, but got:\n%s",
dumpValue(v.value))
}
return &Number{v.chain, data}
}
// Boolean returns a new Boolean attached to underlying value.
//
// If underlying value is not a bool, failure is reported and empty (but non-nil)
// value is returned.
//
// Example:
// value := NewValue(t, true)
// value.Boolean().True()
func (v *Value) Boolean() *Boolean {
data, ok := v.value.(bool)
if !ok {
v.chain.fail("\nexpected boolean value, but got:\n%s",
dumpValue(v.value))
}
return &Boolean{v.chain, data}
}
// Null succeeds if value is nil.
//
// Note that non-nil interface{} that points to nil value (e.g. nil slice or map)
// is also treated as null value. Empty (non-nil) slice or map, empty string, and
// zero number are not treated as null value.
//
// Example:
// value := NewValue(t, nil)
// value.Null()
//
// value := NewValue(t, []interface{}(nil))
// value.Null()
func (v *Value) Null() *Value {
if v.value != nil {
v.chain.fail("\nexpected nil value, but got:\n%s",
dumpValue(v.value))
}
return v
}
// NotNull succeeds if value is not nil.
//
// Note that non-nil interface{} that points to nil value (e.g. nil slice or map)
// is also treated as null value. Empty (non-nil) slice or map, empty string, and
// zero number are not treated as null value.
//
// Example:
// value := NewValue(t, "")
// value.NotNull()
//
// value := NewValue(t, make([]interface{}, 0)
// value.Null()
func (v *Value) NotNull() *Value {
if v.value == nil {
v.chain.fail("\nexpected non-nil value, but got:\n%s",
dumpValue(v.value))
}
return v
}
// Equal succeeds if value is equal to another value.
// Before comparison, both values are converted to canonical form.
//
// Example:
// value := NewValue(t, "foo")
// value.Equal("foo")
func (v *Value) Equal(value interface{}) *Value {
expected, ok := canonValue(&v.chain, value)
if !ok {
return v
}
if !reflect.DeepEqual(expected, v.value) {
v.chain.fail("\nexpected value equal to:\n%s\n\nbut got:\n%s\n\ndiff:\n%s",
dumpValue(expected),
dumpValue(v.value),
diffValues(expected, v.value))
}
return v
}
// NotEqual succeeds if value is not equal to another value.
// Before comparison, both values are converted to canonical form.
//
// Example:
// value := NewValue(t, "foo")
// value.NorEqual("bar")
func (v *Value) NotEqual(value interface{}) *Value {
expected, ok := canonValue(&v.chain, value)
if !ok {
return v
}
if reflect.DeepEqual(expected, v.value) {
v.chain.fail("\nexpected value not equal to:\n%s",
dumpValue(expected))
}
return v
}