forked from NdoleStudio/httpsms
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhelpers_test.go
More file actions
414 lines (337 loc) · 12.1 KB
/
Copy pathhelpers_test.go
File metadata and controls
414 lines (337 loc) · 12.1 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
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
package tests
import (
"bytes"
"context"
"crypto/rand"
"encoding/json"
"fmt"
"io"
"math/big"
"mime/multipart"
"net/http"
"strings"
"testing"
"time"
httpsms "github.com/NdoleStudio/httpsms-go"
"github.com/golang-jwt/jwt/v5"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"github.com/wiremock/go-wiremock"
wmJournal "github.com/wiremock/go-wiremock/journal"
)
const (
apiBaseURL = "http://localhost:8000"
wiremockURL = "http://localhost:8080"
wiremockWebhookURL = "http://wiremock.local:8080" // reachable from API container, passes URL validation (needs a dot)
userAPIKey = "test-user-api-key"
)
type testPhone struct {
PhoneNumber string
PhoneAPIKey string
FcmToken string
}
func newAPIClient() *httpsms.Client {
return httpsms.New(
httpsms.WithBaseURL(apiBaseURL),
httpsms.WithAPIKey(userAPIKey),
)
}
func newPhoneClient(phoneAPIKey string) *httpsms.Client {
return httpsms.New(
httpsms.WithBaseURL(apiBaseURL),
httpsms.WithAPIKey(phoneAPIKey),
)
}
func newWireMockClient() *wiremock.Client {
return wiremock.NewClient(wiremockURL)
}
func randomPhoneNumber() string {
n, err := rand.Int(rand.Reader, big.NewInt(10000))
if err != nil {
return "+18005550000"
}
return fmt.Sprintf("+1800555%04d", n.Int64())
}
func randomEncryptionKey() string {
b := make([]byte, 16)
_, err := rand.Read(b)
if err != nil {
return uuid.New().String()
}
return fmt.Sprintf("%x", b)
}
func setupPhone(ctx context.Context, t *testing.T, messagesPerMinute uint) testPhone {
t.Helper()
phoneNumber := randomPhoneNumber()
fcmToken := "fcm-" + uuid.New().String()
client := newAPIClient()
// Create the phone API key first so that a few seconds pass (during phone upsert)
// before we use it, giving the cache time to clear.
apiKeyResp, resp, err := client.PhoneAPIKeys.Store(ctx, &httpsms.PhoneAPIKeyStoreParams{
Name: "test-key-" + uuid.New().String(),
})
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.HTTPResponse.StatusCode, "phone api key store failed")
phoneAPIKeyValue := apiKeyResp.Data.APIKey
require.NotEmpty(t, phoneAPIKeyValue)
_, resp, err = client.Phones.Upsert(ctx, &httpsms.PhoneUpsertParams{
PhoneNumber: phoneNumber,
FcmToken: fcmToken,
MessagesPerMinute: messagesPerMinute,
MaxSendAttempts: 2,
MessageExpirationSeconds: 600,
SIM: "SIM1",
})
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.HTTPResponse.StatusCode, "phone upsert failed")
phoneClient := newPhoneClient(phoneAPIKeyValue)
_, resp, err = phoneClient.Phones.UpsertFCMToken(ctx, &httpsms.PhoneFCMTokenParams{
PhoneNumber: phoneNumber,
FcmToken: fcmToken,
SIM: "SIM1",
})
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.HTTPResponse.StatusCode, "fcm token bind failed")
return testPhone{
PhoneNumber: phoneNumber,
PhoneAPIKey: phoneAPIKeyValue,
FcmToken: fcmToken,
}
}
func setupWebhook(ctx context.Context, t *testing.T, phoneNumber string, events []string) (signingKey string, webhookPath string) {
t.Helper()
signingKey = randomEncryptionKey()
webhookPath = "/webhooks/" + uuid.New().String()
webhookURL := wiremockWebhookURL + webhookPath
client := newAPIClient()
_, resp, err := client.Webhooks.Store(ctx, &httpsms.WebhookStoreParams{
SigningKey: signingKey,
URL: webhookURL,
PhoneNumbers: []string{phoneNumber},
Events: events,
})
require.NoError(t, err)
require.Equal(t, http.StatusCreated, resp.HTTPResponse.StatusCode, "webhook store failed")
return signingKey, webhookPath
}
func fireEvent(ctx context.Context, t *testing.T, phoneAPIKey string, messageID string, eventName string) {
t.Helper()
url := fmt.Sprintf("%s/v1/messages/%s/events", apiBaseURL, messageID)
payload := map[string]interface{}{
"event_name": eventName,
"timestamp": time.Now().UTC().Format(time.RFC3339),
}
body, err := json.Marshal(payload)
require.NoError(t, err)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(body))
require.NoError(t, err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", phoneAPIKey)
resp, err := http.DefaultClient.Do(req)
require.NoError(t, err)
defer resp.Body.Close()
respBody, err := io.ReadAll(resp.Body)
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.StatusCode, "fire event %s failed: %s", eventName, string(respBody))
}
func pollMessageStatus(ctx context.Context, t *testing.T, messageID string, targetStatus string, timeout time.Duration) httpsms.Message {
t.Helper()
deadline := time.Now().Add(timeout)
for time.Now().Before(deadline) {
url := fmt.Sprintf("%s/v1/messages/%s", apiBaseURL, messageID)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
if err == nil {
req.Header.Set("x-api-key", userAPIKey)
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err == nil {
body, readErr := io.ReadAll(resp.Body)
resp.Body.Close()
if readErr == nil && resp.StatusCode == http.StatusOK {
var result httpsms.MessageResponse
if json.Unmarshal(body, &result) == nil && result.Data.Status == targetStatus {
return result.Data
}
}
}
}
time.Sleep(500 * time.Millisecond)
}
t.Fatalf("message %s did not reach status %q within %v", messageID, targetStatus, timeout)
return httpsms.Message{}
}
func fetchOutstandingMessage(ctx context.Context, t *testing.T, phoneAPIKey string, messageID string) map[string]interface{} {
t.Helper()
url := fmt.Sprintf("%s/v1/messages/outstanding?message_id=%s", apiBaseURL, messageID)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
require.NoError(t, err)
req.Header.Set("x-api-key", phoneAPIKey)
resp, err := http.DefaultClient.Do(req)
require.NoError(t, err)
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.StatusCode, "outstanding: %s", string(body))
var result map[string]interface{}
require.NoError(t, json.Unmarshal(body, &result))
data, ok := result["data"].(map[string]interface{})
require.True(t, ok, "no data in outstanding response")
return data
}
func findFCMRequests(t *testing.T, messageID string) []wmJournal.GetRequestResponse {
t.Helper()
wm := newWireMockClient()
allReqs, err := wm.GetAllRequests()
require.NoError(t, err)
var matched []wmJournal.GetRequestResponse
for _, req := range allReqs.Requests {
if strings.Contains(req.Request.URL, "/messages:send") || strings.Contains(req.Request.AbsoluteURL, "/messages:send") {
if strings.Contains(req.Request.Body, messageID) {
matched = append(matched, req)
}
}
}
return matched
}
func findWebhookRequests(t *testing.T, webhookPath string) []wmJournal.GetRequestResponse {
t.Helper()
wm := newWireMockClient()
allReqs, err := wm.GetAllRequests()
require.NoError(t, err)
var matched []wmJournal.GetRequestResponse
for _, req := range allReqs.Requests {
if strings.Contains(req.Request.URL, webhookPath) || strings.Contains(req.Request.AbsoluteURL, webhookPath) {
matched = append(matched, req)
}
}
return matched
}
func assertWebhookJWT(t *testing.T, request wmJournal.Request, signingKey string) {
t.Helper()
authHeader := request.Headers["Authorization"]
if authHeader == "" {
authHeader = request.Headers["authorization"]
}
require.NotEmpty(t, authHeader, "webhook request missing Authorization header")
require.True(t, strings.HasPrefix(authHeader, "Bearer "), "Authorization header must start with Bearer")
tokenString := strings.TrimPrefix(authHeader, "Bearer ")
token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
require.Equal(t, jwt.SigningMethodHS256, token.Method, "unexpected signing method")
return []byte(signingKey), nil
})
require.NoError(t, err, "JWT validation failed")
require.True(t, token.Valid, "JWT token is not valid")
claims, ok := token.Claims.(jwt.MapClaims)
require.True(t, ok, "cannot parse claims")
require.Equal(t, "api.httpsms.com", claims["iss"], "issuer mismatch")
require.NotEmpty(t, claims["sub"], "subject mismatch")
exp, err := claims.GetExpirationTime()
require.NoError(t, err)
require.True(t, exp.After(time.Now()), "token is expired")
nbf, err := claims.GetNotBefore()
require.NoError(t, err)
require.True(t, nbf.Before(time.Now()), "token not yet valid")
}
func waitForWebhookEvents(t *testing.T, webhookPath string, expectedCount int, timeout time.Duration) []wmJournal.GetRequestResponse {
t.Helper()
deadline := time.Now().Add(timeout)
for time.Now().Before(deadline) {
requests := findWebhookRequests(t, webhookPath)
if len(requests) >= expectedCount {
return requests
}
time.Sleep(500 * time.Millisecond)
}
requests := findWebhookRequests(t, webhookPath)
require.GreaterOrEqual(t, len(requests), expectedCount, "expected at least %d webhook events on %s, got %d", expectedCount, webhookPath, len(requests))
return requests
}
func waitForFCMPush(t *testing.T, messageID string, timeout time.Duration) []wmJournal.GetRequestResponse {
t.Helper()
deadline := time.Now().Add(timeout)
for time.Now().Before(deadline) {
requests := findFCMRequests(t, messageID)
if len(requests) >= 1 {
return requests
}
time.Sleep(500 * time.Millisecond)
}
t.Fatalf("FCM push for message %s not found within %v", messageID, timeout)
return nil
}
type BulkMessageEntry struct {
RequestID string `json:"request_id"`
Total int `json:"total"`
ScheduledCount int `json:"scheduled_count"`
PendingCount int `json:"pending_count"`
FailedCount int `json:"failed_count"`
ExpiredCount int `json:"expired_count"`
SentCount int `json:"sent_count"`
DeliveredCount int `json:"delivered_count"`
CreatedAt string `json:"created_at"`
}
func uploadBulkFile(ctx context.Context, t *testing.T, filename string, fileBytes []byte) (int, []byte) {
t.Helper()
var buf bytes.Buffer
writer := multipart.NewWriter(&buf)
part, err := writer.CreateFormFile("document", filename)
require.NoError(t, err)
_, err = part.Write(fileBytes)
require.NoError(t, err)
require.NoError(t, writer.Close())
url := apiBaseURL + "/v1/bulk-messages"
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, &buf)
require.NoError(t, err)
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Set("x-api-key", userAPIKey)
resp, err := http.DefaultClient.Do(req)
require.NoError(t, err)
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
return resp.StatusCode, body
}
func fetchBulkMessages(ctx context.Context, t *testing.T) []BulkMessageEntry {
t.Helper()
url := apiBaseURL + "/v1/bulk-messages"
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
require.NoError(t, err)
req.Header.Set("x-api-key", userAPIKey)
resp, err := http.DefaultClient.Do(req)
require.NoError(t, err)
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.StatusCode, "fetch bulk messages failed: %s", string(body))
var result struct {
Data []BulkMessageEntry `json:"data"`
}
require.NoError(t, json.Unmarshal(body, &result))
return result.Data
}
func searchMessages(ctx context.Context, t *testing.T, contact string, owner string) []httpsms.Message {
t.Helper()
url := fmt.Sprintf("%s/v1/messages?contact=%s&owner=%s&limit=20&skip=0", apiBaseURL, contact, owner)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
require.NoError(t, err)
req.Header.Set("x-api-key", userAPIKey)
resp, err := http.DefaultClient.Do(req)
require.NoError(t, err)
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.StatusCode, "search messages failed: %s", string(body))
var result struct {
Data []httpsms.Message `json:"data"`
}
require.NoError(t, json.Unmarshal(body, &result))
return result.Data
}
func findBulkEntry(entries []BulkMessageEntry, requestID string) *BulkMessageEntry {
for i := range entries {
if entries[i].RequestID == requestID {
return &entries[i]
}
}
return nil
}