-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathstep_request_response.go
More file actions
274 lines (245 loc) · 7.72 KB
/
Copy pathstep_request_response.go
File metadata and controls
274 lines (245 loc) · 7.72 KB
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
package hrp
import (
"bytes"
builtinJSON "encoding/json"
"fmt"
"io"
"net/http"
"regexp"
"strings"
"testing"
"github.com/jmespath/go-jmespath"
"github.com/pkg/errors"
"github.com/rs/zerolog/log"
"github.com/httprunner/httprunner/v5/internal/builtin"
"github.com/httprunner/httprunner/v5/internal/json"
)
var fieldTags = []string{"proto", "status_code", "headers", "cookies", "body", textExtractorSubRegexp}
type httpRespObjMeta struct {
Proto string `json:"proto"`
StatusCode int `json:"status_code"`
Headers map[string]string `json:"headers"`
Cookies map[string]string `json:"cookies"`
Body interface{} `json:"body"`
}
func newHttpResponseObject(t *testing.T, parser *Parser, resp *http.Response) (*responseObject, error) {
// prepare response headers
headers := make(map[string]string)
for k, v := range resp.Header {
if len(v) > 0 {
headers[k] = v[0]
}
}
// prepare response cookies
cookies := make(map[string]string)
for _, cookie := range resp.Cookies() {
cookies[cookie.Name] = cookie.Value
}
// read response body
respBodyBytes, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
// parse response body
var body interface{}
if err := json.Unmarshal(respBodyBytes, &body); err != nil {
// response body is not json, use raw body
body = string(respBodyBytes)
}
respObjMeta := httpRespObjMeta{
Proto: resp.Proto,
StatusCode: resp.StatusCode,
Headers: headers,
Cookies: cookies,
Body: body,
}
return convertToResponseObject(t, parser, respObjMeta)
}
type wsCloseRespObject struct {
StatusCode int `json:"status_code"`
Text string `json:"body"`
}
func newWsCloseResponseObject(t *testing.T, parser *Parser, resp *wsCloseRespObject) (*responseObject, error) {
return convertToResponseObject(t, parser, resp)
}
type wsReadRespObject struct {
Message interface{} `json:"body"`
messageType int
}
func newWsReadResponseObject(t *testing.T, parser *Parser, resp *wsReadRespObject) (*responseObject, error) {
byteMessage, ok := resp.Message.([]byte)
if !ok {
return nil, errors.New("websocket message type should be []byte")
}
var msg interface{}
if err := json.Unmarshal(byteMessage, &msg); err != nil {
// response body is not json, use raw body
msg = string(byteMessage)
}
resp.Message = msg
return convertToResponseObject(t, parser, resp)
}
func convertToResponseObject(t *testing.T, parser *Parser, respObjMeta interface{}) (*responseObject, error) {
respObjMetaBytes, _ := json.Marshal(respObjMeta)
var data interface{}
decoder := json.NewDecoder(bytes.NewReader(respObjMetaBytes))
decoder.UseNumber()
if err := decoder.Decode(&data); err != nil {
log.Error().
Str("respObjectMeta", string(respObjMetaBytes)).
Err(err).
Msg("[convertToResponseObject] convert respObjectMeta to interface{} failed")
return nil, err
}
return &responseObject{
t: t,
parser: parser,
respObjMeta: data,
}, nil
}
type responseObject struct {
t *testing.T
parser *Parser
respObjMeta interface{}
validationResults []*ValidationResult
}
const textExtractorSubRegexp string = `(.*)`
func (v *responseObject) searchField(field string, variablesMapping map[string]interface{}) interface{} {
var result interface{} = field
if strings.Contains(field, "$") {
// parse reference variables in field before search
var err error
result, err = v.parser.Parse(field, variablesMapping)
if err != nil {
log.Error().Str("field name", field).Err(err).Msg("fail to parse field before search")
}
}
// search field using jmespath or regex if parsed field is still string and contains specified fieldTags
if parsedField, ok := result.(string); ok && checkSearchField(parsedField) {
if strings.Contains(field, textExtractorSubRegexp) {
result = v.searchRegexp(parsedField)
} else {
result = v.searchJmespath(parsedField)
}
}
return result
}
func (v *responseObject) Extract(extractors map[string]string, variablesMapping map[string]interface{}) map[string]interface{} {
if extractors == nil {
return nil
}
extractMapping := make(map[string]interface{})
for key, value := range extractors {
extractedValue := v.searchField(value, variablesMapping)
log.Info().Str("from", value).Interface("value", extractedValue).Msg("extract value")
log.Info().Str("variable", key).Interface("value", extractedValue).Msg("set variable")
extractMapping[key] = extractedValue
}
return extractMapping
}
func (v *responseObject) Validate(iValidators []interface{}, variablesMapping map[string]interface{}) (err error) {
for _, iValidator := range iValidators {
validator, ok := iValidator.(Validator)
if !ok {
return errors.New("validator type error")
}
// parse check value
checkItem := validator.Check
checkValue := v.searchField(checkItem, variablesMapping)
// get assert method
assertMethod := validator.Assert
assertFunc, ok := builtin.Assertions[assertMethod]
if !ok {
return errors.New(fmt.Sprintf("unexpected assertMethod: %v", assertMethod))
}
// parse expected value
expectValue, err := v.parser.Parse(validator.Expect, variablesMapping)
if err != nil {
return err
}
validResult := &ValidationResult{
Validator: Validator{
Check: validator.Check,
Expect: expectValue,
Assert: assertMethod,
Message: validator.Message,
},
CheckValue: checkValue,
CheckResult: "fail",
}
// do assertion
result := assertFunc(v.t, checkValue, expectValue)
if result {
validResult.CheckResult = "pass"
}
v.validationResults = append(v.validationResults, validResult)
log.Info().
Str("checkExpr", validator.Check).
Str("assertMethod", assertMethod).
Interface("expectValue", expectValue).
Str("expectValueType", builtin.InterfaceType(expectValue)).
Interface("checkValue", checkValue).
Str("checkValueType", builtin.InterfaceType(checkValue)).
Bool("result", result).
Msgf("validate %s", checkItem)
if !result {
v.t.Fail()
log.Error().
Str("checkExpr", validator.Check).
Str("assertMethod", assertMethod).
Interface("checkValue", checkValue).
Str("checkValueType", builtin.InterfaceType(checkValue)).
Interface("expectValue", expectValue).
Str("expectValueType", builtin.InterfaceType(expectValue)).
Msg("assert failed")
return errors.New("step validation failed")
}
}
return nil
}
func checkSearchField(expr string) bool {
for _, t := range fieldTags {
if strings.Contains(expr, t) {
return true
}
}
return false
}
func (v *responseObject) searchJmespath(expr string) interface{} {
checkValue, err := jmespath.Search(expr, v.respObjMeta)
if err != nil {
log.Error().Str("expr", expr).Err(err).Msg("search jmespath failed")
return expr // jmespath not found, return the expression
}
if number, ok := checkValue.(builtinJSON.Number); ok {
checkNumber, err := parseJSONNumber(number)
if err != nil {
log.Error().Interface("json number", number).Err(err).Msg("convert json number failed")
}
return checkNumber
}
return checkValue
}
func (v *responseObject) searchRegexp(expr string) interface{} {
respMap, ok := v.respObjMeta.(map[string]interface{})
if !ok {
log.Error().Interface("resp", v.respObjMeta).Msg("convert respObjMeta to map failed")
return expr
}
bodyStr, ok := respMap["body"].(string)
if !ok {
log.Error().Interface("resp", respMap).Msg("convert body to string failed")
return expr
}
regexpCompile, err := regexp.Compile(expr)
if err != nil {
log.Error().Str("expr", expr).Err(err).Msg("compile expr failed")
return expr
}
match := regexpCompile.FindStringSubmatch(bodyStr)
if len(match) > 1 {
return match[1] // return first matched result in parentheses
}
log.Error().Str("expr", expr).Msg("search regexp failed")
return expr
}