-
Notifications
You must be signed in to change notification settings - Fork 27
/
expect.go
277 lines (244 loc) · 6.85 KB
/
expect.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
package frisby
import (
"fmt"
"reflect"
"strconv"
"strings"
"github.com/bitly/go-simplejson"
)
// ExpectFunc function type used as argument to Expect()
type ExpectFunc func(F *Frisby) (bool, string)
// Expect Checks according to the given function, which allows you to describe any kind of assertion.
func (F *Frisby) Expect(foo ExpectFunc) *Frisby {
Global.NumAsserts++
if ok, err_str := foo(F); !ok {
F.AddError(err_str)
}
return F
}
// Checks the response status code
func (F *Frisby) ExpectStatus(code int) *Frisby {
Global.NumAsserts++
status := F.Resp.StatusCode
if status != code {
err_str := fmt.Sprintf("Expected Status %d, but got %d: %q", code, status, F.Resp.Status)
F.AddError(err_str)
}
return F
}
// Checks for header and if values match
func (F *Frisby) ExpectHeader(key, value string) *Frisby {
Global.NumAsserts++
chk_val := F.Resp.Header.Get(key)
if chk_val == "" {
err_str := fmt.Sprintf("Expected Header %q, but it was missing", key)
F.AddError(err_str)
} else if chk_val != value {
err_str := fmt.Sprintf("Expected Header %q to be %q, but got %q", key, value, chk_val)
F.AddError(err_str)
}
return F
}
// Checks the response body for the given string
func (F *Frisby) ExpectContent(content string) *Frisby {
Global.NumAsserts++
text, err := F.Resp.Text()
if err != nil {
F.AddError(err.Error())
return F
}
contains := strings.Contains(text, content)
if !contains {
err_str := fmt.Sprintf("Expected Body to contain %q, but it was missing", content)
F.AddError(err_str)
}
return F
}
// ExpectJson uses the reflect.DeepEqual to compare the response
// JSON and the supplied JSON for structural and value equality
//
// path can be a dot joined field names.
// ex: 'path.to.subobject.field'
func (F *Frisby) ExpectJson(path string, value interface{}) *Frisby {
Global.NumAsserts++
simp_json, err := F.Resp.Json()
if err != nil {
F.AddError(err.Error())
return F
}
if path != "" {
// Loop over each path item and progress down the json path.
path_items := strings.Split(path, Global.PathSeparator)
for _, segment := range path_items {
processed := false
// If the path segment is an integer, and we're at an array, access the index.
index, err := strconv.Atoi(segment)
if err == nil {
if _, err := simp_json.Array(); err == nil {
simp_json = simp_json.GetIndex(index)
processed = true
}
}
if !processed {
simp_json = simp_json.Get(segment)
}
}
}
json := simp_json.Interface()
equal := false
switch reflect.ValueOf(value).Kind() {
case reflect.Int:
val, err := simp_json.Int()
if err != nil {
F.AddError(err.Error())
return F
} else {
equal = (val == value.(int))
}
case reflect.Float64:
val, err := simp_json.Float64()
if err != nil {
F.AddError(err.Error())
return F
} else {
equal = (val == value.(float64))
}
default:
equal = reflect.DeepEqual(value, json)
}
if !equal {
err_str := fmt.Sprintf("ExpectJson equality test failed for %q, got value: %v", path, json)
F.AddError(err_str)
}
return F
}
// ExpectJsonType checks if the types of the response
// JSON and the supplied JSON match
//
// path can be a dot joined field names.
// ex: 'path.to.subobject.field'
func (F *Frisby) ExpectJsonType(path string, val_type reflect.Kind) *Frisby {
Global.NumAsserts++
json, err := F.Resp.Json()
if err != nil {
F.AddError(err.Error())
return F
}
if path != "" {
path_items := strings.Split(path, Global.PathSeparator)
json = json.GetPath(path_items...)
}
json_json := json.Interface()
json_val := reflect.ValueOf(json_json)
if val_type != json_val.Kind() {
err_str := fmt.Sprintf("Expect Json %q type to be %q, but got %T", path, val_type, json_json)
F.AddError(err_str)
}
return F
}
// ExpectJsonLength checks if the JSON at path
// is an array and has the correct length
//
// path can be a dot joined field names.
// ex: 'path.to.subobject.field'
func (F *Frisby) ExpectJsonLength(path string, length int) *Frisby {
Global.NumAsserts++
json, err := F.Resp.Json()
if err != nil {
F.AddError(err.Error())
return F
}
if path != "" {
path_items := strings.Split(path, Global.PathSeparator)
json = json.GetPath(path_items...)
}
ary, err := json.Array()
if err != nil {
F.AddError(err.Error())
return F
}
L := len(ary)
if L != length {
err_str := fmt.Sprintf("Expect length to be %d, but got %d", length, L)
F.AddError(err_str)
}
return F
}
// function type used as argument to AfterContent()
type AfterContentFunc func(F *Frisby, content []byte, err error)
// AfterContent allows you to write your own functions for inspecting the body of the response.
// You are also provided with the Frisby object.
//
// The function signiture is AfterContentFunc
// type AfterContentFunc func(F *Frisby, content []byte, err error)
//
func (F *Frisby) AfterContent(foo AfterContentFunc) *Frisby {
content, err := F.Resp.Content()
foo(F, content, err)
return F
}
// function type used as argument to AfterText()
type AfterTextFunc func(F *Frisby, text string, err error)
// AfterText allows you to write your own functions for inspecting the body of the response.
// You are also provided with the Frisby object.
//
// The function signiture is AfterTextFunc
// type AfterTextFunc func(F *Frisby, text string, err error)
//
func (F *Frisby) AfterText(foo AfterTextFunc) *Frisby {
text, err := F.Resp.Text()
foo(F, text, err)
return F
}
// function type used as argument to AfterJson()
type AfterJsonFunc func(F *Frisby, json *simplejson.Json, err error)
// AfterJson allows you to write your own functions for inspecting the body of the response.
// You are also provided with the Frisby object.
//
// The function signiture is AfterJsonFunc
// type AfterJsonFunc func(F *Frisby, json *simplejson.Json, err error)
//
// simplejson docs: https://github.com/bitly/go-simplejson
func (F *Frisby) AfterJson(foo AfterJsonFunc) *Frisby {
json, err := F.Resp.Json()
foo(F, json, err)
return F
}
// Prints the body of the response
func (F *Frisby) PrintBody() *Frisby {
str, err := F.Resp.Text()
if err != nil {
F.AddError(err.Error())
return F
}
fmt.Println(str)
return F
}
// Prints a report for the Frisby Object
//
// If there are any errors, they will all be printed as well
func (F *Frisby) PrintReport() *Frisby {
if len(F.Errs) == 0 {
fmt.Printf("Pass [%s]\n", F.Name)
} else {
fmt.Printf("FAIL [%s]\n", F.Name)
for _, e := range F.Errs {
fmt.Println(" - ", e)
}
}
return F
}
// Prints a report for the Frisby Object in go_test format
//
// If there are any errors, they will all be printed as well
func (F *Frisby) PrintGoTestReport() *Frisby {
if len(F.Errs) == 0 {
fmt.Printf("=== RUN %s\n--- PASS: %s (%.2fs)\n", F.Name, F.Name, F.ExecutionTime)
} else {
fmt.Printf("=== RUN %s\n--- FAIL: %s (%.2fs)\n", F.Name, F.Name, F.ExecutionTime)
for _, e := range F.Errs {
fmt.Println(" ", e)
}
}
return F
}