-
Notifications
You must be signed in to change notification settings - Fork 42
/
http_response.go
165 lines (147 loc) · 5.43 KB
/
http_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
package common
import (
"fmt"
"net/http"
"strings"
"time"
"github.com/maistra/maistra-test-tool/pkg/util"
"github.com/maistra/maistra-test-tool/pkg/util/test"
)
type FailureFunc func(t test.TestHelper, msg string, detailedMsg string)
func CheckResponseMatchesFile(t test.TestHelper, resp *http.Response, responseBody []byte, file, successMsg, failureMsg string, failure FailureFunc, otherFiles ...string) {
t.T().Helper()
requireNonNilResponse(t, resp)
err := util.CompareHTTPResponse(responseBody, file)
if err == nil {
if successMsg == "" {
successMsg = fmt.Sprintf("response matches file %s", file)
}
logSuccess(t, successMsg)
} else {
var detailMsg string
if len(otherFiles) > 0 {
matchedFile := findMatchingFile(responseBody, otherFiles)
if matchedFile == "" {
detailMsg = fmt.Sprintf("expected the response to match file %q, but it didn't match that or any other file", file)
if !t.WillRetry() {
detailMsg += "\ndiff between the expected (-) and actual response (+):\n" + err.Error()
}
} else {
detailMsg = fmt.Sprintf("expected the response to match file %q, but it matched %q", file, matchedFile)
}
} else {
detailMsg = fmt.Sprintf("expected the response to match file %q, but it didn't", file)
if !t.WillRetry() {
detailMsg += "\ndiff between the expected (-) and actual response (+):\n" + err.Error()
}
}
failure(t, failureMsg, detailMsg)
}
}
func findMatchingFile(body []byte, otherFiles []string) string {
for _, file := range otherFiles {
if matchesFile(body, file) {
return file
}
}
return ""
}
func matchesFile(body []byte, file string) bool {
err := util.CompareHTTPResponse(body, file)
return err == nil
}
func CheckResponseStatus(t test.TestHelper, resp *http.Response, responseBody []byte, expectedStatus int, failure FailureFunc) {
t.T().Helper()
requireNonNilResponse(t, resp)
if resp.StatusCode == expectedStatus {
logSuccess(t, fmt.Sprintf("received expected status code %d", expectedStatus))
} else {
if t.WillRetry() {
failure(t, fmt.Sprintf("expected status code %d but got %s", expectedStatus, resp.Status), "")
} else {
failure(t, fmt.Sprintf("expected status code %d but got %s and response: %s", expectedStatus, resp.Status, string(responseBody)), "")
}
}
}
func CheckResponseContains(t test.TestHelper, resp *http.Response, responseBody []byte, str string, failure FailureFunc) {
t.T().Helper()
requireNonNilResponse(t, resp)
body := string(responseBody)
if strings.Contains(body, str) {
logSuccess(t, fmt.Sprintf("string '%s' found in response", str))
} else {
detailMsg := fmt.Sprintf("expected to find the string '%s' in the response, but it wasn't found", str)
if !t.WillRetry() {
detailMsg += "\nfull response:\n" + body
}
failure(t, detailMsg, "")
}
}
func CheckResponseDoesNotContain(t test.TestHelper, resp *http.Response, responseBody []byte, str string, failure FailureFunc) {
t.T().Helper()
requireNonNilResponse(t, resp)
body := string(responseBody)
if strings.Contains(body, str) {
detailMsg := fmt.Sprintf("expected the string '%s' to be absent from the response, but it was present", str)
if !t.WillRetry() {
detailMsg += "\nfull response:\n" + body
}
failure(t, detailMsg, "")
} else {
logSuccess(t, fmt.Sprintf("string '%s' not found in response", str))
}
}
func CheckDurationInRange(t test.TestHelper, resp *http.Response, duration, minDuration, maxDuration time.Duration, failure FailureFunc) {
t.T().Helper()
requireNonNilResponse(t, resp)
if minDuration <= duration && duration <= maxDuration {
logSuccess(t, fmt.Sprintf("request completed in %v, which is within the expected range %v - %v", duration.Truncate(time.Millisecond), minDuration, maxDuration))
} else {
failure(t, fmt.Sprintf("expected request duration to be between %v and %v, but was %v", minDuration, maxDuration, duration.Truncate(time.Millisecond)), "")
}
}
func CheckRequestSucceeds(t test.TestHelper, resp *http.Response, responseBody []byte, successMsg, failureMsg string, failure FailureFunc) {
if resp == nil {
failure(t, failureMsg, "expected request to succeed, but it failed")
} else if successMsg != "" {
logSuccess(t, successMsg)
}
}
func CheckRequestFails(t test.TestHelper, resp *http.Response, responseBody []byte, successMsg, failureMsg string, failure FailureFunc) {
t.T().Helper()
if resp == nil {
if successMsg != "" {
logSuccess(t, successMsg)
}
} else {
detailMsg := fmt.Sprintf("expected request to fail, but it succeeded with the following status: %s", resp.Status)
if !t.WillRetry() {
detailMsg += "\nfull response:\n" + string(responseBody)
}
failure(t, failureMsg, detailMsg)
}
}
func CheckRequestFailureMessagesAny(t test.TestHelper, requestError error, expectedErrorMessages []string, successMsg, failureMsg string, failure FailureFunc) {
t.T().Helper()
if requestError == nil {
failure(t, "expected request error, but it is nil", "")
return
}
for _, str := range expectedErrorMessages {
if strings.Contains(requestError.Error(), str) {
if successMsg != "" {
logSuccess(t, successMsg)
}
return
}
}
// none of the expected strings were found
detailMsg := fmt.Sprintf("\nexpected any of error messages:'%s'\nactual error message:'%s'", expectedErrorMessages, requestError.Error())
failure(t, failureMsg, detailMsg)
}
func requireNonNilResponse(t test.TestHelper, resp *http.Response) {
t.T().Helper()
if resp == nil {
t.Fatal("response is nil; the HTTP request must have failed")
}
}