chore: Email attachment testcase (Fixes #812) (#814)

dagu-org · Feb 10, 2025 · c831612 · c831612
1 parent eb7944f
commit c831612
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 12 deletions.
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -230,6 +230,30 @@ Sending Email
           message: |
             Hello world
 
+Sending Email with Attachments
+------------------------------
+
+.. code-block:: yaml
+
+  smtp:
+    host: "smtp.foo.bar"
+    port: "587"
+    username: "<username>"
+    password: "<password>"
+
+  steps:
+    - name: step1
+      executor:
+        type: mail
+        config:
+          to: <to address>
+          from: <from address>
+          subject: "Sample Email"
+          message: |
+            Hello world
+          attachments:
+            - /tmp/email-attachment.txt
+
 
 Customizing Signal Handling on Stop
 -----------------------------------

diff --git a/internal/digraph/executor/mail.go b/internal/digraph/executor/mail.go
@@ -21,10 +21,11 @@ type mail struct {
 }
 
 type mailConfig struct {
-	From    string `mapstructure:"from"`
-	To      string `mapstructure:"to"`
-	Subject string `mapstructure:"subject"`
-	Message string `mapstructure:"message"`
+	From        string   `mapstructure:"from"`
+	To          string   `mapstructure:"to"`
+	Subject     string   `mapstructure:"subject"`
+	Message     string   `mapstructure:"message"`
+	Attachments []string `json:"attachments,omitempty"`
 }
 
 func newMail(ctx context.Context, step digraph.Step) (Executor, error) {

diff --git a/internal/digraph/executor/mail_test.go b/internal/digraph/executor/mail_test.go
@@ -3,6 +3,7 @@ package executor
 import (
 	"context"
 	"os"
+	"path/filepath"
 	"testing"
 
 	"github.com/dagu-org/dagu/internal/digraph"
@@ -12,9 +13,26 @@ import (
 func TestMail(t *testing.T) {
 	t.Parallel()
 
+	// Create temporary directory for test files
+	tmpDir, err := os.MkdirTemp("", "email-test")
+	if err != nil {
+		t.Fatalf("failed to create temp dir: %v", err)
+	}
+	defer os.RemoveAll(tmpDir)
+
+	// Create a test email attachment
+	attachFile := filepath.Join(tmpDir, "email.txt")
+	content := []byte("Test email")
+
 	os.Setenv("MAIL_SUBJECT", "Test Subject")
+	err = os.WriteFile(attachFile, content, 0644)
+	if err != nil {
+		t.Fatalf("failed to create temp file: %v", err)
+	}
+
 	t.Cleanup(func() {
 		os.Unsetenv("MAIL_SUBJECT")
+		os.Remove(attachFile)
 	})
 
 	t.Run("NewMail", func(t *testing.T) {
@@ -27,10 +45,11 @@ func TestMail(t *testing.T) {
 				step: digraph.Step{
 					ExecutorConfig: digraph.ExecutorConfig{
 						Config: map[string]any{
-							"from":    "[email protected]",
-							"to":      "[email protected]",
-							"subject": "Test Subject",
-							"message": "Test Message",
+							"from":        "[email protected]",
+							"to":          "[email protected]",
+							"subject":     "Test Subject",
+							"message":     "Test Message",
+							"attachments": attachFile,
 						},
 					},
 				},
@@ -40,10 +59,11 @@ func TestMail(t *testing.T) {
 				step: digraph.Step{
 					ExecutorConfig: digraph.ExecutorConfig{
 						Config: map[string]any{
-							"from":    "[email protected]",
-							"to":      "[email protected]",
-							"subject": "${MAIL_SUBJECT}",
-							"message": "Test Message",
+							"from":        "[email protected]",
+							"to":          "[email protected]",
+							"subject":     "${MAIL_SUBJECT}",
+							"message":     "Test Message",
+							"attachments": attachFile,
 						},
 					},
 				},
@@ -68,6 +88,7 @@ func TestMail(t *testing.T) {
 				assert.Equal(t, "[email protected]", mailExec.cfg.To)
 				assert.Equal(t, "Test Subject", mailExec.cfg.Subject)
 				assert.Equal(t, "Test Message", mailExec.cfg.Message)
+				assert.Equal(t, attachFile, mailExec.cfg.Attachments[0])
 			})
 		}
 	})