forked from nyaruka/courier
-
Notifications
You must be signed in to change notification settings - Fork 2
/
test.go
351 lines (289 loc) · 9.36 KB
/
test.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
package handlers
import (
"bytes"
"io/ioutil"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
"fmt"
_ "github.com/lib/pq" // postgres driver
"github.com/nyaruka/courier"
"github.com/nyaruka/courier/config"
"github.com/nyaruka/gocommon/urns"
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/require"
)
// RequestPrepFunc is our type for a hook for tests to use before a request is fired in a test
type RequestPrepFunc func(*http.Request)
// ChannelHandleTestCase defines the test values for a particular test case
type ChannelHandleTestCase struct {
Label string
URL string
Data string
Status int
Response string
Name *string
Text *string
URN *string
Attachment *string
Attachments []string
Date *time.Time
ChannelEvent *string
ExternalID *string
ID int64
PrepRequest RequestPrepFunc
}
// SendPrepFunc allows test cases to modify the channel, msg or server before a message is sent
type SendPrepFunc func(*httptest.Server, courier.Channel, courier.Msg)
// ChannelSendTestCase defines the test values for a particular test case
type ChannelSendTestCase struct {
Label string
Text string
URN string
Attachments []string
HighPriority bool
ResponseStatus int
ResponseBody string
Path string
URLParams map[string]string
PostParams map[string]string
RequestBody string
Headers map[string]string
Error string
Status string
ExternalID string
Stopped bool
SendPrep SendPrepFunc
}
// Sp is a utility method to get the pointer to the passed in string
func Sp(str string) *string { return &str }
// Tp is utility method to get the pointer to the passed in time
func Tp(tm time.Time) *time.Time { return &tm }
// utility method to make sure the passed in host is up, prevents races with our test server
func ensureTestServerUp(host string) {
for i := 0; i < 20; i++ {
_, err := http.Get(host)
if err == nil {
break
}
time.Sleep(time.Microsecond * 100)
}
}
// utility method to make a request to a handler URL
func testHandlerRequest(tb testing.TB, s courier.Server, path string, data string, expectedStatus int, expectedBody *string, requestPrepFunc RequestPrepFunc) string {
var req *http.Request
var err error
url := fmt.Sprintf("https://%s%s", s.Config().Domain, path)
if data != "" {
req, err = http.NewRequest("POST", url, strings.NewReader(data))
// guess our content type
contentType := "application/x-www-form-urlencoded"
if strings.Contains(data, "{") && strings.Contains(data, "}") {
contentType = "application/json"
} else if strings.Contains(data, "<") && strings.Contains(data, ">") {
contentType = "application/xml"
}
req.Header.Set("Content-Type", contentType)
} else {
req, err = http.NewRequest("GET", url, nil)
}
require.Nil(tb, err)
if requestPrepFunc != nil {
requestPrepFunc(req)
}
rr := httptest.NewRecorder()
s.Router().ServeHTTP(rr, req)
body := rr.Body.String()
require.Equal(tb, expectedStatus, rr.Code, fmt.Sprintf("incorrect status code with response: %s", body))
if expectedBody != nil {
require.Contains(tb, body, *expectedBody)
}
return body
}
func newServer(backend courier.Backend) courier.Server {
// for benchmarks, log to null
logger := logrus.New()
logger.Out = ioutil.Discard
logrus.SetOutput(ioutil.Discard)
return courier.NewServerWithLogger(config.NewTest(), backend, logger)
}
// RunChannelSendTestCases runs all the passed in test cases against the channel
func RunChannelSendTestCases(t *testing.T, channel courier.Channel, handler courier.ChannelHandler, testCases []ChannelSendTestCase) {
mb := courier.NewMockBackend()
s := newServer(mb)
mb.AddChannel(channel)
handler.Initialize(s)
for _, testCase := range testCases {
t.Run(testCase.Label, func(t *testing.T) {
require := require.New(t)
msg := mb.NewOutgoingMsg(channel, courier.NewMsgID(10), urns.URN(testCase.URN), testCase.Text, testCase.HighPriority)
for _, a := range testCase.Attachments {
msg.WithAttachment(a)
}
var testRequest *http.Request
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
body, _ := ioutil.ReadAll(r.Body)
testRequest = httptest.NewRequest(r.Method, r.URL.String(), bytes.NewBuffer(body))
testRequest.Header = r.Header
w.WriteHeader(testCase.ResponseStatus)
w.Write([]byte(testCase.ResponseBody))
}))
defer server.Close()
// call our prep function if we have one
if testCase.SendPrep != nil {
testCase.SendPrep(server, channel, msg)
}
status, err := handler.SendMsg(msg)
if testCase.Error != "" {
if err == nil {
t.Errorf("expected error: %s", testCase.Error)
} else {
require.Equal(testCase.Error, err.Error())
}
} else if err != nil {
t.Errorf("unexpected error: %s", err.Error())
}
if testCase.Path != "" {
require.NotNil(testRequest)
require.Equal(testCase.Path, testRequest.URL.Path)
}
if testCase.URLParams != nil {
require.NotNil(testRequest)
for k, v := range testCase.URLParams {
value := testRequest.URL.Query().Get(k)
require.Equal(v, value, fmt.Sprintf("%s not equal", k))
}
}
if testCase.PostParams != nil {
require.NotNil(testRequest)
for k, v := range testCase.PostParams {
value := testRequest.PostFormValue(k)
require.Equal(v, value)
}
}
if testCase.RequestBody != "" {
require.NotNil(testRequest)
value, _ := ioutil.ReadAll(testRequest.Body)
require.Equal(testCase.RequestBody, string(value))
}
if testCase.Headers != nil {
require.NotNil(testRequest)
for k, v := range testCase.Headers {
value := testRequest.Header.Get(k)
require.Equal(v, value)
}
}
if testCase.ExternalID != "" {
require.Equal(testCase.ExternalID, status.ExternalID())
}
if testCase.Status != "" {
require.Equal(testCase.Status, string(status.Status()))
}
if testCase.Stopped {
require.Equal(msg, mb.GetLastStoppedMsgContact())
}
})
}
}
// RunChannelTestCases runs all the passed in tests cases for the passed in channel configurations
func RunChannelTestCases(t *testing.T, channels []courier.Channel, handler courier.ChannelHandler, testCases []ChannelHandleTestCase) {
mb := courier.NewMockBackend()
s := newServer(mb)
for _, ch := range channels {
mb.AddChannel(ch)
}
handler.Initialize(s)
for _, testCase := range testCases {
t.Run(testCase.Label, func(t *testing.T) {
require := require.New(t)
mb.ClearQueueMsgs()
testHandlerRequest(t, s, testCase.URL, testCase.Data, testCase.Status, &testCase.Response, testCase.PrepRequest)
// pop our message off and test against it
contactName := mb.GetLastContactName()
msg, _ := mb.GetLastQueueMsg()
event, _ := mb.GetLastChannelEvent()
status, _ := mb.GetLastMsgStatus()
if testCase.Status == 200 {
if testCase.Name != nil {
require.Equal(*testCase.Name, contactName)
}
if testCase.Text != nil {
require.Equal(*testCase.Text, msg.Text())
}
if testCase.ChannelEvent != nil {
require.Equal(*testCase.ChannelEvent, string(event.EventType()))
}
if testCase.URN != nil {
if msg != nil {
require.Equal(*testCase.URN, string(msg.URN()))
} else if event != nil {
require.Equal(*testCase.URN, string(event.URN()))
} else {
require.Equal(*testCase.URN, "")
}
}
if testCase.ExternalID != nil {
if msg != nil {
require.Equal(*testCase.ExternalID, msg.ExternalID())
} else if status != nil {
require.Equal(*testCase.ExternalID, status.ExternalID())
} else {
require.Equal(*testCase.ExternalID, "")
}
}
if testCase.ID != 0 {
if status != nil {
require.Equal(testCase.ID, status.ID().Int64)
} else {
require.Equal(testCase.ID, -1)
}
}
if testCase.Attachment != nil {
require.Equal([]string{*testCase.Attachment}, msg.Attachments())
}
if len(testCase.Attachments) > 0 {
require.Equal(testCase.Attachments, msg.Attachments())
}
if testCase.Date != nil {
if msg != nil {
require.Equal((*testCase.Date).Local(), (*msg.ReceivedOn()).Local())
} else if event != nil {
require.Equal(*testCase.Date, event.OccurredOn())
} else {
require.Equal(*testCase.Date, nil)
}
}
}
})
}
// check non-channel specific error conditions against first test case
validCase := testCases[0]
t.Run("Queue Error", func(t *testing.T) {
mb.SetErrorOnQueue(true)
defer mb.SetErrorOnQueue(false)
testHandlerRequest(t, s, validCase.URL, validCase.Data, 400, Sp("unable to queue message"), validCase.PrepRequest)
})
t.Run("Receive With Invalid Channel", func(t *testing.T) {
mb.ClearChannels()
testHandlerRequest(t, s, validCase.URL, validCase.Data, 400, Sp("channel not found"), validCase.PrepRequest)
})
}
// RunChannelBenchmarks runs all the passed in test cases for the passed in channels
func RunChannelBenchmarks(b *testing.B, channels []courier.Channel, handler courier.ChannelHandler, testCases []ChannelHandleTestCase) {
mb := courier.NewMockBackend()
s := newServer(mb)
for _, ch := range channels {
mb.AddChannel(ch)
}
handler.Initialize(s)
for _, testCase := range testCases {
mb.ClearQueueMsgs()
b.Run(testCase.Label, func(b *testing.B) {
for i := 0; i < b.N; i++ {
testHandlerRequest(b, s, testCase.URL, testCase.Data, testCase.Status, nil, testCase.PrepRequest)
}
})
}
}