Add notifications package for easy sending of notifications (#779)

Co-authored-by: kolaente <k@knt.li>
Reviewed-on: https://kolaente.dev/vikunja/api/pulls/779
Co-authored-by: konrad <konrad@kola-entertainments.de>
Co-committed-by: konrad <konrad@kola-entertainments.de>

pkg/mail/send_mail.go

@@ -17,19 +17,14 @@
 package mail
 
 import (
-	"bytes"
-	"html/template"
-
 	"code.vikunja.io/api/pkg/config"
 	"code.vikunja.io/api/pkg/log"
-	"code.vikunja.io/api/pkg/static"
-	"code.vikunja.io/api/pkg/utils"
-	"github.com/shurcooL/httpfs/html/vfstemplate"
 	"gopkg.in/gomail.v2"
 )
 
 // Opts holds infos for a mail
 type Opts struct {
+	From        string
 	To          string
 	Subject     string
 	Message     string
@@ -56,7 +51,7 @@ type header struct {
 
 // SendTestMail sends a test mail to a receipient.
 // It works without a queue.
-func SendTestMail(to string) error {
+func SendTestMail(opts *Opts) error {
 	if config.MailerHost.GetString() == "" {
 		log.Warning("Mailer seems to be not configured! Please see the config docs for more details.")
 		return nil
@@ -69,19 +64,17 @@ func SendTestMail(to string) error {
 	}
 	defer s.Close()
 
-	m := gomail.NewMessage()
-	m.SetHeader("From", config.MailerFromEmail.GetString())
-	m.SetHeader("To", to)
-	m.SetHeader("Subject", "Test from Vikunja")
-	m.SetBody("text/plain", "This is a test mail! If you got this, Vikunja is correctly set up to send emails.")
+	m := sendMail(opts)
 
 	return gomail.Send(s, m)
 }
 
-// SendMail puts a mail in the queue
-func SendMail(opts *Opts) {
+func sendMail(opts *Opts) *gomail.Message {
 	m := gomail.NewMessage()
-	m.SetHeader("From", config.MailerFromEmail.GetString())
+	if opts.From == "" {
+		opts.From = config.MailerFromEmail.GetString()
+	}
+	m.SetHeader("From", opts.From)
 	m.SetHeader("To", opts.To)
 	m.SetHeader("Subject", opts.Subject)
 	for _, h := range opts.Headers {
@@ -97,49 +90,16 @@ func SendMail(opts *Opts) {
 		m.SetBody("text/plain", opts.Message)
 		m.AddAlternative("text/html", opts.HTMLMessage)
 	}
+	return m
+}
 
+// SendMail puts a mail in the queue
+func SendMail(opts *Opts) {
+	if isUnderTest {
+		sentMails = append(sentMails, opts)
+		return
+	}
+
+	m := sendMail(opts)
 	Queue <- m
 }
-
-// Template holds a pointer about a template
-type Template struct {
-	Templates *template.Template
-}
-
-// SendMailWithTemplate parses a template and sends it via mail
-func SendMailWithTemplate(to, subject, tpl string, data map[string]interface{}) {
-	var htmlContent bytes.Buffer
-	var plainContent bytes.Buffer
-
-	t, err := vfstemplate.ParseGlob(static.Templates, nil, "*.tmpl")
-	if err != nil {
-		log.Errorf("SendMailWithTemplate: ParseGlob: %v", err)
-		return
-	}
-
-	boundary := "np" + utils.MakeRandomString(13)
-
-	data["Boundary"] = boundary
-	data["FrontendURL"] = config.ServiceFrontendurl.GetString()
-
-	if err := t.ExecuteTemplate(&htmlContent, tpl+".html.tmpl", data); err != nil {
-		log.Errorf("ExecuteTemplate: %v", err)
-		return
-	}
-
-	if err := t.ExecuteTemplate(&plainContent, tpl+".plain.tmpl", data); err != nil {
-		log.Errorf("ExecuteTemplate: %v", err)
-		return
-	}
-
-	opts := &Opts{
-		To:          to,
-		Subject:     subject,
-		Message:     plainContent.String(),
-		HTMLMessage: htmlContent.String(),
-		ContentType: ContentTypeMultipart,
-		Boundary:    boundary,
-	}
-
-	SendMail(opts)
-}

pkg/mail/testing.go

@@ -0,0 +1,48 @@
+// Vikunja is a to-do list application to facilitate your life.
+// Copyright 2018-2021 Vikunja and contributors. All rights reserved.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public Licensee as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public Licensee for more details.
+//
+// You should have received a copy of the GNU Affero General Public Licensee
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package mail
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+var (
+	isUnderTest bool
+	sentMails   []*Opts
+)
+
+// Fake stops any mails from being sent and instead allows for recording and querying them.
+func Fake() {
+	isUnderTest = true
+	sentMails = nil
+}
+
+// AssertSent asserts if a mail has been sent
+func AssertSent(t *testing.T, opts *Opts) {
+	var found bool
+	for _, testMail := range sentMails {
+		if reflect.DeepEqual(testMail, opts) {
+			found = true
+			break
+		}
+	}
+
+	assert.True(t, found, "Failed to assert mail '%v' has been sent.", opts)
+}