-
Notifications
You must be signed in to change notification settings - Fork 0
/
mailslurper.go
358 lines (316 loc) · 12.7 KB
/
mailslurper.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
352
353
354
355
356
357
358
package mailslurper
import (
"context"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"os"
"regexp"
"strings"
"testing"
"time"
"github.com/ory/dockertest"
dc "github.com/ory/dockertest/docker"
"github.com/radekg/app-kit-orytest/common"
)
const (
// DefaultMailslurperImageName specifies the Mailslurper docker image name to use in tests.
DefaultMailslurperImageName = "oryd/mailslurper"
// DefaultMailslurperEnvVarImageName is the environment variable name for default Mailslurper docker image name.
DefaultMailslurperEnvVarImageName = "TEST_ORY_MAILSLURPER_IMAGE_NAME"
// DefaultMailslurperImageVersion specifies the Mailslurper docker image version to use in tests.
DefaultMailslurperImageVersion = "smtps-latest"
// DefaultMailslurperEnvVarImageVersion is the environment variable name for default Mailslurper docker image version.
DefaultMailslurperEnvVarImageVersion = "TEST_ORY_MAILSLURPER_IMAGE_VERSION"
// DefaultSubjectRecoverAccount is used when retrieving account recovery email
DefaultSubjectRecoverAccount = "Recover access to your account"
// DefaultSubjectVerifyAccount is used when retrieving account verification email
DefaultSubjectVerifyAccount = "Please verify your email address"
)
// TestEnvContext represents a test Mailslurper environment context.
type TestEnvContext interface {
Cleanup()
ContainerIP() string
ContainerWWWPort() string
ContainerServicePort() string
ContainerSMTPPort() string
ExtractRecoveryLink(*MailItem) (string, error)
ExtractVerificationLink(*MailItem) (string, error)
ListEmail() (*Mail, error)
WaitForRecoveryEmail(context.Context, *testing.T, string) <-chan interface{}
WaitForVerificationEmail(context.Context, *testing.T, string) <-chan interface{}
WaitForEmailWithSubject(context.Context, *testing.T, string, string) <-chan interface{}
}
// SetupTestMailslurper sets up Mailslurper environment for tests.
// This environment can be passed to other Ory components in tests.
func SetupTestMailslurper(t *testing.T) TestEnvContext {
cleanupContainers := true
// after every successful step, store a cleanup function here:
closables := []func(){}
// close all reasources in reverse order:
prependClosable := func(closable func(), closables []func()) []func() {
return append([]func(){closable}, closables...)
}
// used in case of a failure during setup:
closeClosables := func(closables []func()) {
for _, closable := range closables {
defer closable()
}
}
// mailslurper ports:
mailslurperWWWListener, err := common.NewRandomPortSupplier()
if err != nil {
closeClosables(closables)
t.Fatalf("failed creating mailslurper WWW random port listener: '%v'", err)
}
closables = prependClosable(func() {
t.Log("cleanup: closing mailslurper WWW random port listener, if not closed yet")
mailslurperWWWListener.Cleanup()
}, closables)
mailslurperServiceListener, err := common.NewRandomPortSupplier()
if err != nil {
closeClosables(closables)
t.Fatalf("failed creating mailslurper service random port listener: '%v'", err)
}
closables = prependClosable(func() {
t.Log("cleanup: closing mailslurper service random port listener, if not closed yet")
mailslurperServiceListener.Cleanup()
}, closables)
mailslurperSMTPListener, err := common.NewRandomPortSupplier()
if err != nil {
closeClosables(closables)
t.Fatalf("failed creating mailslurper SMTP random port listener: '%v'", err)
}
closables = prependClosable(func() {
t.Log("cleanup: closing mailslurper SMTP random port listener, if not closed yet")
mailslurperSMTPListener.Cleanup()
}, closables)
if err := mailslurperWWWListener.Discover(); err != nil {
closeClosables(closables)
t.Fatalf("failed extracting host and port from mailslurper WWW random port listener: '%v'", err)
}
if err := mailslurperServiceListener.Discover(); err != nil {
closeClosables(closables)
t.Fatalf("failed extracting host and port from mailslurper service random port listener: '%v'", err)
}
if err := mailslurperSMTPListener.Discover(); err != nil {
closeClosables(closables)
t.Fatalf("failed extracting host and port from mailslurper SMTP random port listener: '%v'", err)
}
fetchedMailslurperWWWRandomPort, _ := mailslurperWWWListener.DiscoveredPort()
fetchedMailslurperServiceRandomPort, _ := mailslurperServiceListener.DiscoveredPort()
fetchedMailslurperSMTPRandomPort, _ := mailslurperSMTPListener.DiscoveredPort()
// create new pool using the default Docker endpoint:
pool, poolErr := dockertest.NewPool("")
if poolErr != nil {
closeClosables(closables)
t.Fatalf("expected docker pool to come up but received: '%v'", poolErr)
}
// create mailslurper config:
mailslurperConfig, tempFileErr := ioutil.TempFile("", "mailslurper-config")
if tempFileErr != nil {
closeClosables(closables)
t.Fatalf("expected temp mailslurper config file to be created but received an error: '%v'", tempFileErr)
}
mailslurperJSONConfig := mailslurperConfigFunc(fetchedMailslurperWWWRandomPort, fetchedMailslurperServiceRandomPort, fetchedMailslurperSMTPRandomPort)
if writeErr := ioutil.WriteFile(mailslurperConfig.Name(), []byte(mailslurperJSONConfig), 0777); writeErr != nil {
closeClosables(closables)
t.Fatalf("expected temp mailslurper configuration file to be written but received an error: '%v'", writeErr)
}
closables = prependClosable(func() {
t.Log("cleanup: removing mailslurper configuration")
os.Remove(mailslurperConfig.Name())
}, closables)
t.Log("Mailslurper configuration written...", mailslurperConfig.Name())
// start mailslurper:
mailslurperOptions := &dockertest.RunOptions{
Repository: common.GetEnvOrDefault(DefaultMailslurperEnvVarImageName, DefaultMailslurperImageName),
Tag: common.GetEnvOrDefault(DefaultMailslurperEnvVarImageVersion, DefaultMailslurperImageVersion),
ExposedPorts: []string{
fmt.Sprintf("%s/tcp", fetchedMailslurperWWWRandomPort),
fmt.Sprintf("%s/tcp", fetchedMailslurperServiceRandomPort),
fmt.Sprintf("%s/tcp", fetchedMailslurperSMTPRandomPort)},
PortBindings: map[dc.Port][]dc.PortBinding{
dc.Port(fmt.Sprintf("%s/tcp", fetchedMailslurperWWWRandomPort)): {{HostIP: "0.0.0.0", HostPort: fetchedMailslurperWWWRandomPort}},
dc.Port(fmt.Sprintf("%s/tcp", fetchedMailslurperServiceRandomPort)): {{HostIP: "0.0.0.0", HostPort: fetchedMailslurperServiceRandomPort}},
dc.Port(fmt.Sprintf("%s/tcp", fetchedMailslurperSMTPRandomPort)): {{HostIP: "0.0.0.0", HostPort: fetchedMailslurperSMTPRandomPort}},
},
Mounts: []string{
fmt.Sprintf("%s:/go/src/github.com/mailslurper/mailslurper/cmd/mailslurper/config.json", mailslurperConfig.Name()),
},
}
// make sure the random mailslurper ports are free before we request the container to start:
mailslurperWWWListener.Cleanup()
mailslurperServiceListener.Cleanup()
mailslurperSMTPListener.Cleanup()
mailslurper, kratosErr := pool.RunWithOptions(mailslurperOptions, func(config *dc.HostConfig) {})
if kratosErr != nil {
closeClosables(closables)
t.Fatalf("expected mailslurper to start but received: '%v'", kratosErr)
}
closables = prependClosable(func() {
t.Log("cleanup: closing mailslurper")
if cleanupContainers {
mailslurper.Close()
pool.Purge(mailslurper)
}
}, closables)
mailslurperIPAddress := ""
containers, _ := pool.Client.ListContainers(dc.ListContainersOptions{All: true})
for _, container := range containers {
if container.ID == mailslurper.Container.ID {
for _, network := range container.Networks.Networks {
mailslurperIPAddress = network.IPAddress
}
}
}
return &testMailslurperContext{
CleanupValue: func() {
for _, closable := range closables {
closable()
}
},
ContainerIPValue: mailslurperIPAddress,
ContainerWWWPortValue: fetchedMailslurperWWWRandomPort,
ContainerServicePortValue: fetchedMailslurperServiceRandomPort,
ContainerSMTPPortValue: fetchedMailslurperSMTPRandomPort,
}
}
type testMailslurperContext struct {
CleanupValue func()
ContainerIPValue string
ContainerWWWPortValue string
ContainerServicePortValue string
ContainerSMTPPortValue string
}
func (ctx *testMailslurperContext) Cleanup() {
ctx.CleanupValue()
}
func (ctx *testMailslurperContext) ContainerIP() string {
return ctx.ContainerIPValue
}
func (ctx *testMailslurperContext) ContainerWWWPort() string {
return ctx.ContainerWWWPortValue
}
func (ctx *testMailslurperContext) ContainerServicePort() string {
return ctx.ContainerServicePortValue
}
func (ctx *testMailslurperContext) ContainerSMTPPort() string {
return ctx.ContainerSMTPPortValue
}
func (ctx *testMailslurperContext) ExtractRecoveryLink(mailItem *MailItem) (string, error) {
// this is the email message we've been waiting for:
re := regexp.MustCompile("\\<a.*\\>(.*)\\<\\/a\\>")
match := re.FindStringSubmatch(mailItem.Body)
if len(match) == 0 {
return "", fmt.Errorf("recovery email received but recovery link could not be extracted, body: '%s'", mailItem.Body)
}
return match[1], nil
}
func (ctx *testMailslurperContext) ExtractVerificationLink(mailItem *MailItem) (string, error) {
// this is the email message we've been waiting for:
re := regexp.MustCompile("\\<a.*\\>(.*)\\<\\/a\\>")
match := re.FindStringSubmatch(mailItem.Body)
if len(match) == 0 {
return "", fmt.Errorf("verification email received but verification link could not be extracted, body: '%s'", mailItem.Body)
}
return match[1], nil
}
func (ctx *testMailslurperContext) ListEmail() (*Mail, error) {
httpClient := &http.Client{}
response, err := httpClient.Get(fmt.Sprintf("http://localhost:%s/mail?pageNumber=1", ctx.ContainerServicePortValue))
if err != nil {
return nil, err
}
defer response.Body.Close()
mail := &Mail{}
return mail, json.NewDecoder(response.Body).Decode(mail)
}
func (ctx *testMailslurperContext) WaitForRecoveryEmail(c context.Context, t *testing.T, recipient string) <-chan interface{} {
return ctx.WaitForEmailWithSubject(c, t, recipient, DefaultSubjectRecoverAccount)
}
func (ctx *testMailslurperContext) WaitForVerificationEmail(c context.Context, t *testing.T, recipient string) <-chan interface{} {
return ctx.WaitForEmailWithSubject(c, t, recipient, DefaultSubjectVerifyAccount)
}
func (ctx *testMailslurperContext) WaitForEmailWithSubject(c context.Context, t *testing.T, recipient, subject string) <-chan interface{} {
callCtx, cancelFunc := context.WithDeadline(c, time.Now().Add(time.Second*10))
respChan := make(chan interface{}, 1)
go func() {
defer close(respChan)
for {
if err := callCtx.Err(); err != nil {
if err.Error() == context.Canceled.Error() {
return // message has been delivered
}
respChan <- err
return
}
mail, err := ctx.ListEmail()
if err != nil {
cancelFunc()
respChan <- fmt.Errorf("expected mail but received an error: '%v'", err)
return
}
if mail.TotalRecords == 0 {
time.Sleep(time.Second)
} else {
for _, mailItem := range mail.MailItems {
if strings.TrimSpace(mailItem.Subject) == strings.TrimSpace(subject) && common.StringSlicesEqual(t, mailItem.ToAddresses, []string{recipient}) {
cancelFunc()
respChan <- mailItem
return
}
}
}
}
}()
return respChan
}
func mailslurperConfigFunc(wwwPort, servicePort, smtpPort string) string {
return fmt.Sprintf(`{
"wwwAddress": "0.0.0.0",
"wwwPort": %s,
"serviceAddress": "0.0.0.0",
"servicePort": %s,
"smtpAddress": "0.0.0.0",
"smtpPort": %s,
"dbEngine": "SQLite",
"dbHost": "",
"dbPort": 0,
"dbDatabase": "mailslurper.db",
"dbUserName": "",
"dbPassword": "",
"maxWorkers": 1000,
"autoStartBrowser": false,
"keyFile": "mailslurper-key.pem",
"certFile": "mailslurper-cert.pem",
"adminKeyFile": "",
"adminCertFile": ""
}`, wwwPort, servicePort, smtpPort)
}
// Mail represents mailslurper messages.
type Mail struct {
MailItems []*MailItem `json:"mailItems"`
TotalPages int `json:"totalPages"`
TotalRecords int `json:"totalRecords"`
}
// MailItem represents a single mailslurper message.
type MailItem struct {
ID string `json:"id"`
DateSent string `json:"dateSent"`
FromAddress string `json:"fromAddress"`
ToAddresses []string `json:"toAddresses"`
Subject string `json:"subject"`
XMailer string `json:"xmailer"`
MIMEVersion string `json:"mimeVersion"`
Body string `json:"body"`
ContentType string `json:"contentType"`
Boundary string `json:"boundary"`
Attachments []interface{} `json:"attachments"`
TransferEncoding string `json:"transferEncoding"`
Message interface{} `json:"Message,omitempty"`
InlineAttachments interface{} `json:"InlineAttachments,omitempty"`
TextBody string `json:"TextBody"`
HTMLBody string `json:"HTMLBody"`
}