feat(mail): integration when running job

this change adresses #15, in order to run the mail notifications as a
job, the workload will need to have access to all attachements that are
expected in the mails. The idea with this change, is that theese
attachements will be available before dispatching a job (during the
validation phase) and can be added as kubernetes resources (configmaps
or secrets) from which the job can consume them.

This change includes:

  - Adding volumes and mounts for a secret (with the expected name
    xml-data-<dataset_folder>.xml)

  - Adding environment variables that allows the user to configure the
    secret name to consume from (should be xml-data-<dataset_folder>.xml)

  - Replacing gopkg.in/gomail.v2 with github.com/wnessen/go-mail since
    gomail.v2 have a single maintainer that is no longer maintaining the
    repositry

How to test:

```bash
./bpctl mail --dry-run
```

Author: zeidlitz

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/lib/pq v1.10.9
 	github.com/spf13/cobra v1.10.1
 	github.com/spf13/viper v1.21.0
-	gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df
+	github.com/wneessen/go-mail v0.7.2
 )
 
 require (
@@ -24,6 +24,5 @@ require (
 	github.com/subosito/gotenv v1.6.0 // indirect
 	go.yaml.in/yaml/v3 v3.0.4 // indirect
 	golang.org/x/sys v0.34.0 // indirect
-	golang.org/x/text v0.28.0 // indirect
-	gopkg.in/alexcesaro/quotedprintable.v3 v3.0.0-20150716171945-2caba252f4dc // indirect
+	golang.org/x/text v0.29.0 // indirect
 )

go.sum

@@ -45,18 +45,16 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
 github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
 github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
+github.com/wneessen/go-mail v0.7.2 h1:xxPnhZ6IZLSgxShebmZ6DPKh1b6OJcoHfzy7UjOkzS8=
+github.com/wneessen/go-mail v0.7.2/go.mod h1:+TkW6QP3EVkgTEqHtVmnAE/1MRhmzb8Y9/W3pweuS+k=
 go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc=
 go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
 golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA=
 golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
-golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
-golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
-gopkg.in/alexcesaro/quotedprintable.v3 v3.0.0-20150716171945-2caba252f4dc h1:2gGKlE2+asNV9m7xrywl36YYNnBG5ZQ0r/BOOxqPpmk=
-gopkg.in/alexcesaro/quotedprintable.v3 v3.0.0-20150716171945-2caba252f4dc/go.mod h1:m7x9LTH6d71AHyAX77c9yqWCCa3UKHcVEj9y7hAtKDk=
+golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk=
+golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df h1:n7WqCuqOuCbNr617RXOY0AWRXxgwEyPp2z+p0+hgMuE=
-gopkg.in/gomail.v2 v2.0.0-20160411212932-81ebce5c23df/go.mod h1:LRQQ+SO6ZHR7tOkpBDuZnXENFzX8qRjMDMyPD6BRkCw=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

helpers/helpers.go

@@ -30,6 +30,7 @@ type TemplateData struct {
 	SslCaCert                    string
 	ClientApiHost                string
 	ClientAccessToken            string
+	MailXmlSecretName            string
 	MailUploaderName             string
 	MailUploaderOrganizationName string
 	MailUploader                 string
@@ -93,6 +94,7 @@ func createTemplateData(cfg *config.Config) (TemplateData, error) {
 		SslCaCert:                    "/.secrets/tls/ca.crt",
 		ClientApiHost:                cfg.ClientApiHost,
 		ClientAccessToken:            cfg.ClientAccessToken,
+		MailXmlSecretName:            cfg.MailXmlSecretName,
 		MailUploaderName:             cfg.MailUploaderName,
 		MailUploaderOrganizationName: cfg.MailUploaderOrganizationName,
 		MailUploader:                 cfg.MailUploader,

helpers/templates/job.template.yaml

@@ -101,11 +101,17 @@ spec:
           volumeMounts:
             - name: data-volume
               mountPath: /data
-            - mountPath: /.secrets/tls/
-              name: tls
+            - name: xml-data
+              mountPath: /data/xml-data/
+            - name: tls
+              mountPath: /.secrets/tls/
       volumes:
         - name: data-volume
           emptyDir: {}
+        - name: xml-data
+          secret:
+            defaultMode: 288
+            secretName: {{ .MailXmlSecretName }}
         - name: tls
           secret:
             defaultMode: 288

internal/config/config.go

@@ -28,6 +28,7 @@ type Config struct {
 	DbSslMode                    string `mapstructure:"DB_SSL_MODE"`
 	DbClientCert                 string `mapstructure:"DB_CLIENT_CERT"`
 	DbClientKey                  string `mapstructure:"DB_CLIENT_KEY"`
+	MailXmlSecretName            string `mapstructure:"MAIL_XML_SECRET_NAME"`
 	MailAddress                  string `mapstructure:"MAIL_ADDRESS"`
 	MailPassword                 string `mapstructure:"MAIL_PASSWORD"`
 	MailSmtpHost                 string `mapstructure:"MAIL_SMTP_HOST"`
@@ -86,6 +87,7 @@ func bindKeys(v *viper.Viper) {
 	v.BindEnv("DB_SSL_MODE")
 	v.BindEnv("DB_CLIENT_CERT")
 	v.BindEnv("DB_CLIENT_KEY")
+	v.BindEnv("MAIL_XML_SECRET_NAME")
 	v.BindEnv("MAIL_ADDRESS")
 	v.BindEnv("MAIL_PASSWORD")
 	v.BindEnv("MAIL_SMTP_HOST")

internal/mail/mail.go

@@ -11,7 +11,7 @@ import (
 	"github.com/NBISweden/sda-bpctl/cmd"
 	"github.com/NBISweden/sda-bpctl/internal/config"
 	"github.com/spf13/cobra"
-	"gopkg.in/gomail.v2"
+	gomail "github.com/wneessen/go-mail"
 )
 
 //go:embed templates/*.html
@@ -110,35 +110,6 @@ func New(c *config.Config) *Mail {
 	return m
 }
 
-func (mail *Mail) send(subject string, message string, reciever string, attachements []string, ccs []string) error {
-	m := gomail.NewMessage()
-	m.SetHeader("From", mail.from)
-	m.SetHeader("To", reciever)
-	m.SetHeader("Subject", subject)
-
-	if len(ccs) > 0 {
-		addresses := make([]string, 0, len(ccs))
-		for _, email := range ccs {
-			addresses = append(addresses, m.FormatAddress(email, ""))
-		}
-		m.SetHeader("Cc", addresses...)
-	}
-
-	m.SetBody("text/html", message)
-
-	// Enforce that the wanted attachements are files that exists
-	if err := attachementsExists(attachements); err != nil {
-		return err
-	}
-	for _, file := range attachements {
-		m.Attach(file)
-	}
-
-	d := gomail.NewDialer(mail.smtpHost, mail.smtpPort, mail.email, mail.password)
-	slog.Info("[mail] notification sent about dataset completion", "reciever", reciever)
-	return d.DialAndSend(m)
-}
-
 func (mail *Mail) Notify(notifier string, dryRun bool) error {
 	htmlBody, err := renderTemplate(mail.lookup[notifier].template, mail.data)
 	if err != nil {
@@ -173,6 +144,44 @@ func renderTemplate(filename string, data TemplateData) (string, error) {
 	return buf.String(), nil
 }
 
+func (mail *Mail) send(subject string, message string, reciever string, attachements []string, ccs []string) error {
+	m := gomail.NewMsg()
+
+	if err := m.From(mail.from); err != nil {
+		return err
+	}
+
+	if err := m.To(reciever); err != nil {
+		return err
+	}
+
+	m.Subject(subject)
+
+	if len(ccs) > 0 {
+		if err := m.Cc(ccs...); err != nil {
+			return err
+		}
+	}
+
+	m.SetBodyString("text/html", message)
+
+	// Enforce that the wanted attachements are files that exists
+	if err := attachementsExists(attachements); err != nil {
+		return err
+	}
+
+	for _, file := range attachements {
+		m.AttachFile(file)
+	}
+
+	client, err := gomail.NewClient(mail.smtpHost, gomail.WithPort(mail.smtpPort), gomail.WithSMTPAuth(gomail.SMTPAuthPlain), gomail.WithUsername(mail.email), gomail.WithPassword(mail.password))
+	if err != nil {
+		return err
+	}
+	slog.Info("[mail] notification sent about dataset completion", "reciever", reciever)
+	return client.DialAndSend(m)
+}
+
 func attachementsExists(attachements []string) error {
 	for _, attachement := range attachements {
 		info, err := os.Stat(attachement)