-
Notifications
You must be signed in to change notification settings - Fork 0
/
response.go
417 lines (321 loc) · 12.4 KB
/
response.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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
package gointegration
import (
"fmt"
"net/http"
"regexp"
"strings"
"testing"
"github.com/btm6084/gojson"
"github.com/stretchr/testify/assert"
)
// ClientResponse holds the pertinent information returned from a third party request.
type ClientResponse struct {
Body string `json:"body"`
Cookies []*http.Cookie `json:"cookies"`
Error error `json:"error"`
Headers map[string]string `json:"headers"`
RequestTime string `json:"request_time"`
RequestURL string `json:"request_url"`
Status string `json:"status"`
StatusCode int `json:"status_code"`
}
// ExpectError is used to assert that a certain error condition has occured.
func (c ClientResponse) ExpectError(t *testing.T, err error) ClientResponse {
// To avoid a panic inside assert, we will handle nil values explicitly
if err == nil {
if c.Error == nil {
return c
}
assert.True(t, false, fmt.Sprintf("expected no error, got error `%v` instead", c.Error))
return c
}
if c.Error == nil {
assert.True(t, false, fmt.Sprintf("expected error `%v`, had nil instead", err))
return c
}
assert.Equal(t, err, c.Error, fmt.Sprintf("expected error with message `%v`, got error with message `%v`", err, c.Error))
return c
}
// Expect allows custom assertions to be run.
// A error returned from the eval function will cause the test to be failed.
func (c ClientResponse) Expect(t *testing.T, eval func(c ClientResponse) error) ClientResponse {
if c.Error != nil {
return c
}
err := eval(c)
msg := ""
if err != nil {
msg = err.Error()
}
assert.Nil(t, err, msg)
return c
}
// ExpectStatus asserts that a specific status code was received.
func (c ClientResponse) ExpectStatus(t *testing.T, status int) ClientResponse {
if c.Error != nil {
return c
}
assert.Equal(t, status, c.StatusCode, fmt.Sprintf("expected statuscode '%d', got '%d' instead", status, c.StatusCode))
return c
}
// ExpectHeaderEmpty asserts that there was no header value set at a given key.
func (c ClientResponse) ExpectHeaderEmpty(t *testing.T, key string) ClientResponse {
if c.Error != nil {
return c
}
if _, isset := c.Headers[key]; !isset {
return c
}
assert.Fail(t, fmt.Sprintf("expected no header with key '%s' set", key))
return c
}
// ExpectHeaderValue asserts that the header value at the given key will match the given value.
func (c ClientResponse) ExpectHeaderValue(t *testing.T, key string, value string) ClientResponse {
if c.Error != nil {
return c
}
if _, isset := c.Headers[key]; !isset {
assert.True(t, isset, fmt.Sprintf("no header with key '%s' set", key))
return c
}
assert.Equal(t, value, c.Headers[key], fmt.Sprintf("expected header '%s' to have value '%s', got '%s' instead", key, value, c.Headers[key]))
return c
}
// OptionalHeaderValue differs from ExpectHeaderValue in that it can only fail if the given key exists. If the key is missing entirely, the test will pass.
func (c ClientResponse) OptionalHeaderValue(t *testing.T, key string, value string) ClientResponse {
if _, isset := c.Headers[key]; !isset {
return c
}
return c.ExpectHeaderValue(t, key, value)
}
// ExpectHeaderMatch asserts that the header value at the given key will match the given regular expression.
func (c ClientResponse) ExpectHeaderMatch(t *testing.T, key string, re *regexp.Regexp) ClientResponse {
if c.Error != nil {
return c
}
if _, isset := c.Headers[key]; !isset {
assert.True(t, isset, fmt.Sprintf("no header with key '%s' set", key))
return c
}
val := c.Headers[key]
assert.True(t, re.Match([]byte(val)), fmt.Sprintf("expect header match error: '%s' did not pass the regex test `%s`", val, re.String()))
return c
}
// OptionalHeaderMatch differs from ExpectHeaderMatch in that it can only fail if the given key exists. If the key is missing entirely, the test will pass.
func (c ClientResponse) OptionalHeaderMatch(t *testing.T, key string, re *regexp.Regexp) ClientResponse {
if _, isset := c.Headers[key]; !isset {
return c
}
return c.ExpectHeaderMatch(t, key, re)
}
// JSONResponse is a ClientResponse with added functionality specifically for dealing with json API responses.
type JSONResponse struct {
ClientResponse
Reader *gojson.JSONReader `json:"-"`
}
// ExpectError is used to assert that a certain error condition has occured.
func (c JSONResponse) ExpectError(t *testing.T, err error) JSONResponse {
// To avoid a panic inside assert, we will handle nil values explicitly
if err == nil {
if c.Error == nil {
return c
}
assert.True(t, false, fmt.Sprintf("expected no error, got error `%v` instead", c.Error))
return c
}
if c.Error == nil {
assert.True(t, false, fmt.Sprintf("expected error `%v`, had nil instead", err))
return c
}
assert.Equal(t, err, c.Error, fmt.Sprintf("expected error with message `%v`, got error with message `%v`", err, c.Error))
return c
}
// Expect allows custom assertions to be run.
// A error returned from the eval function will cause the test to be failed.
func (c JSONResponse) Expect(t *testing.T, eval func(c JSONResponse) error) JSONResponse {
if c.Error != nil {
return c
}
err := eval(c)
msg := ""
if err != nil {
msg = err.Error()
}
assert.Nil(t, err, msg)
return c
}
// ExpectStatus asserts that a specific status code was received.
func (c JSONResponse) ExpectStatus(t *testing.T, status int) JSONResponse {
if c.Error != nil {
return c
}
assert.Equal(t, status, c.StatusCode, fmt.Sprintf("expected statuscode '%d', got '%d' instead", status, c.StatusCode))
return c
}
// ExpectType asserts the data type at the given key will match the given JSON data type.
func (c JSONResponse) ExpectType(t *testing.T, key, typ string) JSONResponse {
if c.Error != nil {
return c
}
r := c.Reader.Get(key)
// Allow for int or float when it's not important.
if typ == "number" && (r.Type == gojson.JSONInt || r.Type == gojson.JSONFloat) {
return c
}
assert.Equal(t, typ, r.Type, fmt.Sprintf("expected value at key `%s` to be `%s`, got `%s` instead", key, typ, r.Type))
return c
}
// ExpectTypes asserts the data type at the given key will match the given JSON data types.
func (c JSONResponse) ExpectTypes(t *testing.T, key string, typ ...string) JSONResponse {
if c.Error != nil {
return c
}
r := c.Reader.Get(key)
for _, check := range typ {
if check == r.Type {
return c
}
// Allow for int or float when it's not important.
if check == "number" && (r.Type == gojson.JSONInt || r.Type == gojson.JSONFloat) {
return c
}
}
assert.Equal(t, typ, r.Type, fmt.Sprintf("expected value at key `%s` to be `%s`, got `%s` instead", key, strings.Join(typ, `, `), r.Type))
return c
}
// OptionalType differs from ExpectType in that it can only fail if the given key exists. If the key is missing entirely, the test will pass.
func (c JSONResponse) OptionalType(t *testing.T, key, typ string) JSONResponse {
if !c.Reader.KeyExists(key) {
return c
}
return c.ExpectType(t, key, typ)
}
// OptionalTypes differs from ExpectTypes in that it can only fail if the given key exists. If the key is missing entirely, the test will pass.
func (c JSONResponse) OptionalTypes(t *testing.T, key string, typ ...string) JSONResponse {
if !c.Reader.KeyExists(key) {
return c
}
return c.ExpectTypes(t, key, typ...)
}
// ExpectValue asserts the value at the given key will match the given value.
func (c JSONResponse) ExpectValue(t *testing.T, key string, b interface{}) JSONResponse {
if c.Error != nil {
return c
}
a := c.Reader.GetInterface(key)
assert.Equal(t, b, a, fmt.Sprintf("expected '%s' to equal '%s'", b, a))
return c
}
// ExpectValueString asserts the value at the given key will match the given value. All comparisons are done as string comparisons.
func (c JSONResponse) ExpectValueString(t *testing.T, key, b string) JSONResponse {
if c.Error != nil {
return c
}
a := c.Reader.GetString(key)
assert.Equal(t, b, a, fmt.Sprintf("expected '%s' to equal '%s'", b, a))
return c
}
// OptionalValue differs from ExpectValue in that it can only fail if the given key exists. If the key is missing entirely, the test will pass.
func (c JSONResponse) OptionalValue(t *testing.T, key string, b interface{}) JSONResponse {
if !c.Reader.KeyExists(key) {
return c
}
return c.ExpectValue(t, key, b)
}
// ExpectValueMatch asserts that the value at the given key will match the given regular expression.
func (c JSONResponse) ExpectValueMatch(t *testing.T, key string, re *regexp.Regexp) JSONResponse {
if c.Error != nil {
return c
}
val := c.Reader.GetString(key)
assert.True(t, re.Match([]byte(val)), fmt.Sprintf("expect value match error: '%s' did not pass the regex test `%s`", val, re.String()))
return c
}
// OptionalValueMatch differs from ExpectValueMatch in that it can only fail if the given key exists. If the key is missing entirely, the test will pass.
func (c JSONResponse) OptionalValueMatch(t *testing.T, key string, re *regexp.Regexp) JSONResponse {
if !c.Reader.KeyExists(key) {
return c
}
return c.ExpectValueMatch(t, key, re)
}
// ExpectValueCountCompare asserts the aggregate data type at the given key will have the given number of child nodes.
func (c JSONResponse) ExpectValueCountCompare(t *testing.T, key string, comp string, count int) JSONResponse {
if c.Error != nil {
return c
}
r := c.Reader.Get(key)
switch comp {
case "=":
assert.Equal(t, count, len(r.Keys), fmt.Sprintf("expected count to not be %d items, found %d", count, len(r.Keys)))
case "!=":
assert.NotEqual(t, count, len(r.Keys), fmt.Sprintf("expected exactly %d items, found %d", count, len(r.Keys)))
case ">":
assert.True(t, len(r.Keys) > count, fmt.Sprintf("expected more than %d items, found %d", count, len(r.Keys)))
case ">=":
assert.True(t, len(r.Keys) >= count, fmt.Sprintf("expected at least %d items, found %d", count, len(r.Keys)))
case "<":
assert.True(t, len(r.Keys) < count, fmt.Sprintf("expected less than %d items, found %d", count, len(r.Keys)))
case "<=":
assert.True(t, len(r.Keys) <= count, fmt.Sprintf("expected a minimum of %d items, found %d", count, len(r.Keys)))
}
return c
}
// ExpectValueCount asserts the aggregate data type at the given key will have the given number of child nodes.
func (c JSONResponse) ExpectValueCount(t *testing.T, key string, count int) JSONResponse {
if c.Error != nil {
return c
}
r := c.Reader.Get(key)
assert.Equal(t, count, len(r.Keys), fmt.Sprintf("expected exactly %d items, found %d", count, len(r.Keys)))
return c
}
// ExpectHeaderEmpty asserts that there was no header value set at a given key.
func (c JSONResponse) ExpectHeaderEmpty(t *testing.T, key string) JSONResponse {
if c.Error != nil {
return c
}
if _, isset := c.Headers[key]; !isset {
return c
}
assert.Fail(t, fmt.Sprintf("expected no header with key '%s' set", key))
return c
}
// ExpectHeaderValue asserts that the header value at the given key will match the given value.
func (c JSONResponse) ExpectHeaderValue(t *testing.T, key string, value string) JSONResponse {
if c.Error != nil {
return c
}
if _, isset := c.Headers[key]; !isset {
assert.True(t, isset, fmt.Sprintf("no header with key '%s' set", key))
return c
}
assert.Equal(t, value, c.Headers[key], fmt.Sprintf("expected header '%s' to have value '%s', got '%s' instead", key, value, c.Headers[key]))
return c
}
// OptionalHeaderValue differs from ExpectHeaderValue in that it can only fail if the given key exists. If the key is missing entirely, the test will pass.
func (c JSONResponse) OptionalHeaderValue(t *testing.T, key string, value string) JSONResponse {
if _, isset := c.Headers[key]; !isset {
return c
}
return c.ExpectHeaderValue(t, key, value)
}
// ExpectHeaderMatch asserts that the header value at the given key will match the given regular expression.
func (c JSONResponse) ExpectHeaderMatch(t *testing.T, key string, re *regexp.Regexp) JSONResponse {
if c.Error != nil {
return c
}
if _, isset := c.Headers[key]; !isset {
assert.True(t, isset, fmt.Sprintf("no header with key '%s' set", key))
return c
}
val := c.Headers[key]
assert.True(t, re.Match([]byte(val)), fmt.Sprintf("expect header match error: '%s' did not pass the regex test `%s`", val, re.String()))
return c
}
// OptionalHeaderMatch differs from ExpectHeaderMatch in that it can only fail if the given key exists. If the key is missing entirely, the test will pass.
func (c JSONResponse) OptionalHeaderMatch(t *testing.T, key string, re *regexp.Regexp) JSONResponse {
if _, isset := c.Headers[key]; !isset {
return c
}
return c.ExpectHeaderMatch(t, key, re)
}