Open platform to collect and prioritize feedback
refactoring: unit tests for mailgun+smtp (#437)
Guilherme Oenningdbaef8956f19
diff --git a/app/middlewares/setup.go b/app/middlewares/setup.goindex 5836b6b92..b5cc7ff02 100644--- a/app/middlewares/setup.go+++ b/app/middlewares/setup.go@@ -4,6 +4,10 @@ import ("fmt""time"+ "github.com/getfider/fider/app/pkg/email"+ "github.com/getfider/fider/app/pkg/email/mailgun"+ "github.com/getfider/fider/app/pkg/email/smtp"+ "github.com/getfider/fider/app/pkg/env""github.com/getfider/fider/app/pkg/log""github.com/getfider/fider/app/pkg/worker"@@ -50,7 +54,7 @@ func WorkerSetup() worker.MiddlewareFunc {Ideas: postgres.NewIdeaStorage(trx),Tags: postgres.NewTagStorage(trx),Notifications: postgres.NewNotificationStorage(trx),- Emailer: app.NewEmailer(c.Logger()),+ Emailer: newEmailer(c.Logger()),})//In case it panics somewhere@@ -132,7 +136,7 @@ func WebSetup() web.MiddlewareFunc {Ideas: postgres.NewIdeaStorage(trx),Tags: postgres.NewTagStorage(trx),Notifications: postgres.NewNotificationStorage(trx),- Emailer: app.NewEmailer(c.Logger()),+ Emailer: newEmailer(c.Logger()),})//In case it panics somewhere@@ -186,3 +190,19 @@ func WebSetup() web.MiddlewareFunc {}}}++func newEmailer(logger log.Logger) email.Sender {+ if env.IsTest() {+ return email.NewNoopSender()+ }+ if env.IsDefined("EMAIL_MAILGUN_API") {+ return mailgun.NewSender(logger, web.NewHTTPClient(), env.MustGet("EMAIL_MAILGUN_DOMAIN"), env.MustGet("EMAIL_MAILGUN_API"))+ }+ return smtp.NewSender(+ logger,+ env.MustGet("EMAIL_SMTP_HOST"),+ env.MustGet("EMAIL_SMTP_PORT"),+ env.GetEnvOrDefault("EMAIL_SMTP_USERNAME", ""),+ env.GetEnvOrDefault("EMAIL_SMTP_PASSWORD", ""),+ )+}diff --git a/app/pkg/assert/assert.go b/app/pkg/assert/assert.goindex 10d1f1ab8..29cd03a30 100644--- a/app/pkg/assert/assert.go+++ b/app/pkg/assert/assert.go@@ -83,7 +83,7 @@ func (a *AnyAssertions) Equals(expected interface{}) bool {if reflect.DeepEqual(expected, a.actual) {return true}- err := fmt.Errorf("Equals assertion failed. \n Expected: \n\t\t %s \n Actual: \n\t\t %s", describe(expected), describe(a.actual))+ err := fmt.Errorf("Equals assertion failed. \n Expected: \n\t\t %s\n Actual: \n\t\t %s", describe(expected), describe(a.actual))currentT.Error(errors.StackN(err, 1))return false}@@ -93,7 +93,7 @@ func (a *AnyAssertions) ContainsSubstring(substr string) bool {if strings.Contains(a.actual.(string), substr) {return true}- err := fmt.Errorf("ContainsSubstring assertion failed. \n Substring: \n\t\t %s \n Actual: \n\t\t %s", substr, describe(a.actual))+ err := fmt.Errorf("ContainsSubstring assertion failed. \n Substring: \n\t\t %s\n Actual: \n\t\t %s", substr, describe(a.actual))currentT.Error(errors.StackN(err, 1))return false}@@ -103,7 +103,7 @@ func (a *AnyAssertions) NotEquals(other interface{}) bool {if !reflect.DeepEqual(other, a.actual) {return true}- err := fmt.Errorf("NotEquals assertion failed. \n Other: \n\t\t %s \n Actual: \n\t\t %s", describe(other), describe(a.actual))+ err := fmt.Errorf("NotEquals assertion failed. \n Other: \n\t\t %s\n Actual: \n\t\t %s", describe(other), describe(a.actual))currentT.Error(errors.StackN(err, 1))return false}diff --git a/app/pkg/email/mailgun/mailgun.go b/app/pkg/email/mailgun/mailgun.goindex 9b30fcde1..587cf2707 100644--- a/app/pkg/email/mailgun/mailgun.go+++ b/app/pkg/email/mailgun/mailgun.go@@ -12,6 +12,7 @@ import ("github.com/getfider/fider/app/pkg/env""github.com/getfider/fider/app/pkg/errors""github.com/getfider/fider/app/pkg/log"+ "github.com/getfider/fider/app/pkg/web")var baseURL = "https://api.mailgun.net/v3/%s/messages"@@ -19,13 +20,14 @@ var baseURL = "https://api.mailgun.net/v3/%s/messages"//Sender is used to send emailstype Sender struct {logger log.Logger+ client web.Clientdomain stringapiKey string}//NewSender creates a new mailgun email sender-func NewSender(logger log.Logger, domain, apiKey string) *Sender {- return &Sender{logger, domain, apiKey}+func NewSender(logger log.Logger, client web.Client, domain, apiKey string) *Sender {+ return &Sender{logger, client, domain, apiKey}}//Send an email@@ -53,6 +55,7 @@ func (s *Sender) BatchSend(tenant *models.Tenant, templateName string, params em}form := url.Values{}+form.Add("from", fmt.Sprintf("%s <%s>", from, email.NoReply))form.Add("subject", message.Subject)form.Add("html", message.Body)@@ -112,7 +115,7 @@ func (s *Sender) BatchSend(tenant *models.Tenant, templateName string, params emrequest.SetBasicAuth("api", s.apiKey)request.Header.Set("Content-Type", "application/x-www-form-urlencoded")- resp, err := http.DefaultClient.Do(request)+ resp, err := s.client.Do(request)if err != nil {return errors.Wrap(err, "failed to send email with template %s", templateName)}diff --git a/app/pkg/email/mailgun/mailgun_test.go b/app/pkg/email/mailgun/mailgun_test.gonew file mode 100644index 000000000..104cc9708--- /dev/null+++ b/app/pkg/email/mailgun/mailgun_test.go@@ -0,0 +1,130 @@+package mailgun_test++import (+ "io/ioutil"+ "net/url"+ "os"+ "testing"++ "github.com/getfider/fider/app/models"+ "github.com/getfider/fider/app/pkg/email"+ "github.com/getfider/fider/app/pkg/mock"++ "github.com/getfider/fider/app/pkg/email/mailgun"+ "github.com/getfider/fider/app/pkg/log/noop"++ . "github.com/getfider/fider/app/pkg/assert"+)++var client = mock.NewHTTPClient()+var sender = mailgun.NewSender(noop.NewLogger(), client, "mydomain.com", "mys3cr3tk3y")+var tenant = &models.Tenant{+ Subdomain: "got",+}++func TestSend_Success(t *testing.T) {+ RegisterT(t)+ os.Setenv("HOST_MODE", "MULTI")+ client.Reset()++ to := email.Recipient{+ Name: "Jon Sow",+ Address: "[email protected]",+ }+ sender.Send(tenant, "echo_test", email.Params{+ "name": "Hello",+ }, "Fider Test", to)++ Expect(client.Requests).HasLen(1)+ Expect(client.Requests[0].URL.String()).Equals("https://api.mailgun.net/v3/mydomain.com/messages")+ Expect(client.Requests[0].Header.Get("Authorization")).Equals("Basic YXBpOm15czNjcjN0azN5")+ Expect(client.Requests[0].Header.Get("Content-Type")).Equals("application/x-www-form-urlencoded")++ bytes, err := ioutil.ReadAll(client.Requests[0].Body)+ Expect(err).IsNil()+ values, err := url.ParseQuery(string(bytes))+ Expect(err).IsNil()+ Expect(values).HasLen(5)+ Expect(values.Get("to")).Equals("Jon Sow <[email protected]>")+ Expect(values.Get("from")).Equals("Fider Test <[email protected]>")+ Expect(values.Get("subject")).Equals("Message to: Hello")+ Expect(values.Get("html")).Equals("Hello World Hello!")+ Expect(values["o:tag"][0]).Equals("template:echo_test")+ Expect(values["o:tag"][1]).Equals("tenant:got")+}++func TestSend_SkipEmptyAddress(t *testing.T) {+ RegisterT(t)+ client.Reset()++ to := email.Recipient{+ Name: "Jon Sow",+ Address: "",+ }+ sender.Send(tenant, "echo_test", email.Params{+ "name": "Hello",+ }, "Fider Test", to)++ Expect(client.Requests).HasLen(0)+}++func TestSend_SkipUnlistedAddress(t *testing.T) {+ RegisterT(t)+ client.Reset()+ email.SetWhitelist("^.*@gmail.com$")++ to := email.Recipient{+ Name: "Jon Sow",+ Address: "[email protected]",+ }+ sender.Send(tenant, "echo_test", email.Params{+ "name": "Hello",+ }, "Fider Test", to)++ Expect(client.Requests).HasLen(0)+}++func TestBatch_Success(t *testing.T) {+ RegisterT(t)+ client.Reset()+ email.SetWhitelist("")++ to := []email.Recipient{+ email.Recipient{+ Name: "Jon Sow",+ Address: "[email protected]",+ Params: email.Params{+ "name": "Jon",+ },+ },+ email.Recipient{+ Name: "Arya Stark",+ Address: "[email protected]",+ Params: email.Params{+ "name": "Arya",+ },+ },+ }+ sender.BatchSend(tenant, "echo_test", email.Params{}, "Fider Test", to)++ Expect(client.Requests).HasLen(1)+ Expect(client.Requests[0].URL.String()).Equals("https://api.mailgun.net/v3/mydomain.com/messages")+ Expect(client.Requests[0].Header.Get("Authorization")).Equals("Basic YXBpOm15czNjcjN0azN5")+ Expect(client.Requests[0].Header.Get("Content-Type")).Equals("application/x-www-form-urlencoded")++ bytes, err := ioutil.ReadAll(client.Requests[0].Body)+ Expect(err).IsNil()+ values, err := url.ParseQuery(string(bytes))+ Expect(err).IsNil()+ Expect(values).HasLen(6)+ Expect(values["to"]).HasLen(2)+ Expect(values["to"][0]).Equals("Jon Sow <[email protected]>")+ Expect(values["to"][1]).Equals("Arya Stark <[email protected]>")+ Expect(values.Get("from")).Equals("Fider Test <[email protected]>")+ Expect(values.Get("subject")).Equals("Message to: %recipient.name%")+ Expect(values.Get("html")).Equals("Hello World %recipient.name%!")+ Expect(values["o:tag"]).HasLen(2)+ Expect(values["o:tag"][0]).Equals("template:echo_test")+ Expect(values["o:tag"][1]).Equals("tenant:got")+ Expect(values.Get("recipient-variables")).Equals("{\"[email protected]\":{\"name\":\"Arya\"},\"[email protected]\":{\"name\":\"Jon\"}}")+}diff --git a/app/pkg/email/smtp/smtp.go b/app/pkg/email/smtp/smtp.goindex 4f45626cf..9ec6bba54 100644--- a/app/pkg/email/smtp/smtp.go+++ b/app/pkg/email/smtp/smtp.go@@ -17,6 +17,22 @@ func authenticate(username string, password string, host string) gosmtp.Auth {return gosmtp.PlainAuth("", username, password, host)}+type builder struct {+ content string+}++func (b *builder) Set(key, value string) {+ b.content += fmt.Sprintf("%s: %s\r\n", key, value)+}++func (b *builder) Body(body string) {+ b.content += "\r\n" + body+}++func (b *builder) Bytes() []byte {+ return []byte(b.content)+}+//Sender is used to send emailstype Sender struct {logger log.Logger@@ -24,11 +40,17 @@ type Sender struct {port stringusername stringpassword string+ send func(string, gosmtp.Auth, string, []string, []byte) error}//NewSender creates a new mailgun email senderfunc NewSender(logger log.Logger, host, port, username, password string) *Sender {- return &Sender{logger, host, port, username, password}+ return &Sender{logger, host, port, username, password, gosmtp.SendMail}+}++//ReplaceSend can be used to mock internal send function+func (s *Sender) ReplaceSend(send func(string, gosmtp.Auth, string, []string, []byte) error) {+ s.send = send}//Send an email@@ -52,22 +74,17 @@ func (s *Sender) Send(tenant *models.Tenant, templateName string, params email.P})message := email.RenderMessage(templateName, params.Merge(to.Params))- headers := make(map[string]string)- headers["From"] = fmt.Sprintf("%s <%s>", from, email.NoReply)- headers["To"] = fmt.Sprintf("%s <%s>", to.Name, to.Address)- headers["Subject"] = message.Subject- headers["MIME-version"] = "1.0"- headers["Content-Type"] = "text/html; charset=\"UTF-8\""-- body := ""- for k, v := range headers {- body += fmt.Sprintf("%s: %s\r\n", k, v)- }- body += "\r\n" + message.Body+ b := builder{}+ b.Set("From", fmt.Sprintf("%s <%s>", from, email.NoReply))+ b.Set("To", fmt.Sprintf("%s <%s>", to.Name, to.Address))+ b.Set("Subject", message.Subject)+ b.Set("MIME-version", "1.0")+ b.Set("Content-Type", "text/html; charset=\"UTF-8\"")+ b.Body(message.Body)servername := fmt.Sprintf("%s:%s", s.host, s.port)auth := authenticate(s.username, s.password, s.host)- err := gosmtp.SendMail(servername, auth, email.NoReply, []string{to.Address}, []byte(body))+ err := s.send(servername, auth, email.NoReply, []string{to.Address}, b.Bytes())if err != nil {return errors.Wrap(err, "failed to send email with template %s", templateName)}diff --git a/app/pkg/email/smtp/smtp_test.go b/app/pkg/email/smtp/smtp_test.gonew file mode 100644index 000000000..85fc911f1--- /dev/null+++ b/app/pkg/email/smtp/smtp_test.go@@ -0,0 +1,129 @@+package smtp_test++import (+ gosmtp "net/smtp"+ "testing"++ "github.com/getfider/fider/app/models"+ . "github.com/getfider/fider/app/pkg/assert"+ "github.com/getfider/fider/app/pkg/email"+ "github.com/getfider/fider/app/pkg/email/smtp"+ "github.com/getfider/fider/app/pkg/log/noop"+)++type request struct {+ servername string+ auth gosmtp.Auth+ from string+ to []string+ body []byte+}++var sender = smtp.NewSender(noop.NewLogger(), "localhost", "1234", "us3r", "p4ss")+var tenant = &models.Tenant{+ Subdomain: "got",+}+var requests = make([]request, 0)++func mockSend(servername string, auth gosmtp.Auth, from string, to []string, body []byte) error {+ requests = append(requests, request{servername, auth, from, to, body})+ return nil+}++func reset() {+ sender.ReplaceSend(mockSend)+ requests = make([]request, 0)+}++func TestSend_Success(t *testing.T) {+ RegisterT(t)+ reset()++ to := email.Recipient{+ Name: "Jon Sow",+ Address: "[email protected]",+ }+ err := sender.Send(tenant, "echo_test", email.Params{+ "name": "Hello",+ }, "Fider Test", to)++ Expect(err).IsNil()+ Expect(requests).HasLen(1)+ Expect(requests[0].servername).Equals("localhost:1234")+ Expect(requests[0].auth).Equals(gosmtp.PlainAuth("", "us3r", "p4ss", "localhost"))+ Expect(requests[0].from).Equals("[email protected]")+ Expect(requests[0].to).Equals([]string{"[email protected]"})+ Expect(string(requests[0].body)).Equals("From: Fider Test <[email protected]>\r\nTo: Jon Sow <[email protected]>\r\nSubject: Message to: Hello\r\nMIME-version: 1.0\r\nContent-Type: text/html; charset=\"UTF-8\"\r\n\r\nHello World Hello!")+}+func TestSend_SkipEmptyAddress(t *testing.T) {+ RegisterT(t)+ reset()++ to := email.Recipient{+ Name: "Jon Sow",+ Address: "",+ }+ err := sender.Send(tenant, "echo_test", email.Params{+ "name": "Hello",+ }, "Fider Test", to)++ Expect(err).IsNil()+ Expect(requests).HasLen(0)+}++func TestSend_SkipUnlistedAddress(t *testing.T) {+ RegisterT(t)+ reset()+ email.SetWhitelist("^.*@gmail.com$")++ to := email.Recipient{+ Name: "Jon Sow",+ Address: "[email protected]",+ }+ err := sender.Send(tenant, "echo_test", email.Params{+ "name": "Hello",+ }, "Fider Test", to)++ Expect(err).IsNil()+ Expect(requests).HasLen(0)+}++func TestBatch_Success(t *testing.T) {+ RegisterT(t)+ reset()+ email.SetWhitelist("")++ to := []email.Recipient{+ email.Recipient{+ Name: "Jon Sow",+ Address: "[email protected]",+ Params: email.Params{+ "name": "Jon",+ },+ },+ email.Recipient{+ Name: "Arya Stark",+ Address: "[email protected]",+ Params: email.Params{+ "name": "Arya",+ },+ },+ }++ err := sender.BatchSend(tenant, "echo_test", email.Params{}, "Fider Test", to)+ Expect(err).IsNil()++ Expect(requests).HasLen(2)++ Expect(requests[0].servername).Equals("localhost:1234")+ Expect(requests[0].auth).Equals(gosmtp.PlainAuth("", "us3r", "p4ss", "localhost"))+ Expect(requests[0].from).Equals("[email protected]")+ Expect(requests[0].to).Equals([]string{"[email protected]"})+ Expect(string(requests[0].body)).Equals("From: Fider Test <[email protected]>\r\nTo: Jon Sow <[email protected]>\r\nSubject: Message to: Jon\r\nMIME-version: 1.0\r\nContent-Type: text/html; charset=\"UTF-8\"\r\n\r\nHello World Jon!")++ Expect(requests[1].servername).Equals("localhost:1234")+ Expect(requests[1].auth).Equals(gosmtp.PlainAuth("", "us3r", "p4ss", "localhost"))+ Expect(requests[1].from).Equals("[email protected]")+ Expect(requests[1].to).Equals([]string{"[email protected]"})+ Expect(string(requests[1].body)).Equals("From: Fider Test <[email protected]>\r\nTo: Arya Stark <[email protected]>\r\nSubject: Message to: Arya\r\nMIME-version: 1.0\r\nContent-Type: text/html; charset=\"UTF-8\"\r\n\r\nHello World Arya!")+}diff --git a/app/pkg/mock/client.go b/app/pkg/mock/client.gonew file mode 100644index 000000000..a6e81bf24--- /dev/null+++ b/app/pkg/mock/client.go@@ -0,0 +1,34 @@+package mock++import (+ "bytes"+ "io/ioutil"+ "net/http"+)++// HTTPClient is an mocked implementation of HTTP Client+type HTTPClient struct {+ Requests []*http.Request+}++// NewHTTPClient creates a new HTTPClient+func NewHTTPClient() *HTTPClient {+ return &HTTPClient{+ Requests: make([]*http.Request, 0),+ }+}++// Do saves the request internally for later inspection+func (client *HTTPClient) Do(req *http.Request) (*http.Response, error) {+ client.Requests = append(client.Requests, req)++ return &http.Response{+ StatusCode: http.StatusOK,+ Body: ioutil.NopCloser(bytes.NewReader([]byte(""))),+ }, nil+}++// Reset the internal request store+func (client *HTTPClient) Reset() {+ client.Requests = make([]*http.Request, 0)+}diff --git a/app/pkg/web/client.go b/app/pkg/web/client.gonew file mode 100644index 000000000..9ac9891e2--- /dev/null+++ b/app/pkg/web/client.go@@ -0,0 +1,24 @@+package web++import (+ "net/http"+)++// Client is an interface for HTTP Client+type Client interface {+ Do(req *http.Request) (*http.Response, error)+}++// HTTPClient is an implementation of HTTP Client+type HTTPClient struct {+}++// NewHTTPClient creates a new HTTPClient+func NewHTTPClient() *HTTPClient {+ return &HTTPClient{}+}++// Do sends the request using http.DefaultClient+func (client *HTTPClient) Do(req *http.Request) (*http.Response, error) {+ return http.DefaultClient.Do(req)+}diff --git a/app/services.go b/app/services.goindex 14a23fd23..9181ed4ad 100644--- a/app/services.go+++ b/app/services.go@@ -3,10 +3,6 @@ package appimport ("github.com/getfider/fider/app/models""github.com/getfider/fider/app/pkg/email"- "github.com/getfider/fider/app/pkg/email/mailgun"- "github.com/getfider/fider/app/pkg/email/smtp"- "github.com/getfider/fider/app/pkg/env"- "github.com/getfider/fider/app/pkg/log""github.com/getfider/fider/app/pkg/oauth""github.com/getfider/fider/app/storage")@@ -39,20 +35,3 @@ func (s *Services) SetCurrentUser(user *models.User) {s.Ideas.SetCurrentUser(user)s.Notifications.SetCurrentUser(user)}--//NewEmailer creates a new emailer based on system configuration-func NewEmailer(logger log.Logger) email.Sender {- if env.IsTest() {- return email.NewNoopSender()- }- if env.IsDefined("EMAIL_MAILGUN_API") {- return mailgun.NewSender(logger, env.MustGet("EMAIL_MAILGUN_DOMAIN"), env.MustGet("EMAIL_MAILGUN_API"))- }- return smtp.NewSender(- logger,- env.MustGet("EMAIL_SMTP_HOST"),- env.MustGet("EMAIL_SMTP_PORT"),- env.GetEnvOrDefault("EMAIL_SMTP_USERNAME", ""),- env.GetEnvOrDefault("EMAIL_SMTP_PASSWORD", ""),- )-}