package postcard import ( "bytes" "context" "errors" "io/fs" "log/slog" "regexp" "strconv" "strings" "testing" "testing/fstest" "time" "git.golem15.com/golem15/summercms/modules/backpack" "git.golem15.com/golem15/summercms/modules/pact" ) // partialsPlugin is a fixture plugin that ships only mail partials. type partialsPlugin struct { id string fsys fs.FS partials []string } func (p partialsPlugin) ID() string { return p.id } func (p partialsPlugin) MailPartialsFS() fs.FS { return p.fsys } func (p partialsPlugin) MailPartials() []string { return p.partials } // mailPlugin is a fixture plugin that ships templates and, optionally, // partials. type mailPlugin struct { partialsPlugin templates []string layouts map[string]string } func (p mailPlugin) MailTemplatesFS() fs.FS { return p.fsys } func (p mailPlugin) MailTemplates() []string { return p.templates } func (p mailPlugin) MailLayouts() map[string]string { return p.layouts } // templatesOnly hides the partial capability of a mailPlugin. type templatesOnly struct{ p mailPlugin } func (t templatesOnly) ID() string { return t.p.id } func (t templatesOnly) MailTemplatesFS() fs.FS { return t.p.fsys } func (t templatesOnly) MailTemplates() []string { return t.p.templates } func (t templatesOnly) MailLayouts() map[string]string { return t.p.layouts } var ( _ pact.HasMailPartials = partialsPlugin{} _ pact.HasMailPartials = mailPlugin{} _ pact.HasMailTemplates = mailPlugin{} _ pact.HasMailTemplates = templatesOnly{} ) // buttonTag finds the opening tag of the button partial's link. var buttonTag = regexp.MustCompile(`]*button-primary[^>]*>`) // buttonStyle returns the style attribute of the button partial's link, or // empty when it has none. func buttonStyle(t *testing.T, html string) string { t.Helper() tag := buttonTag.FindString(html) if tag == "" { t.Fatalf("no button in %s", html) } _, style, ok := strings.Cut(tag, ` style="`) if !ok { return "" } style, _, _ = strings.Cut(style, `"`) return style } // copyright is the footer line of the built-in layouts without a site name. func copyright() string { return "© " + strconv.Itoa(time.Now().Year()) } // fakeOverrides is an OverrideSource with a fixed answer. type fakeOverrides struct{ ov Overrides } func (f fakeOverrides) MailOverrides(context.Context, string) (Overrides, error) { return f.ov, nil } const noteHTM = `name = "Note" == NOTE: {{ .text }} ==
{{ .text }}
` func partialsFS() fstest.MapFS { return fstest.MapFS{ "views/mail/welcome.htm": {Data: []byte("subject = \"Welcome\"\n==\nHi {{ .Name }}\n\n{{ partial \"button\" \"url\" .Link \"body\" \"Go\" }}\n\nBye\n")}, "views/mail/note.htm": {Data: []byte("subject = \"Note\"\nlayout = \"blog\"\n==\n{{ partial \"acme.blog::mail.partials.note\" \"text\" .Text }}\n")}, "views/mail/auto.htm": {Data: []byte("subject = \"Auto\"\nlayout = \"system\"\n==\nDone.\n")}, "views/mail/bare.htm": {Data: []byte("subject = \"Bare\"\nlayout = \"minimal\"\n==\nDone.\n")}, "views/mail/layouts/blog.htm": {Data: []byte(`name = "Blog" == {{ .Content }} {{ partial "acme.blog::mail.partials.note" "text" "footer" }} ==
{{ .Content }}{{ partial "acme.blog::mail.partials.note" "text" "footer" }}
`)}, "views/mail/partials/note.htm": {Data: []byte(noteHTM)}, } } func blogPlugin() mailPlugin { return mailPlugin{ partialsPlugin: partialsPlugin{id: "acme.blog", fsys: partialsFS(), partials: []string{"acme.blog::mail.partials.note"}}, templates: []string{"acme.blog::mail.welcome", "acme.blog::mail.note", "acme.blog::mail.auto", "acme.blog::mail.bare"}, layouts: map[string]string{"blog": "acme.blog::mail.layouts.blog"}, } } // partialsMailer registers the blog fixture in a fresh catalog and returns a // mailer over it with the given overrides. func partialsMailer(t *testing.T, opts Options, ov *Overrides) (Mailer, *MemoryDriver) { t.Helper() p := blogPlugin() cat := NewCatalog() if err := cat.RegisterPartials(p.id, p.fsys, p.partials); err != nil { t.Fatalf("RegisterPartials: %v", err) } if err := cat.Register(p.id, p.fsys, p.templates, p.layouts); err != nil { t.Fatalf("Register: %v", err) } if ov != nil { opts.Overrides = fakeOverrides{ov: *ov} } drv := NewMemoryDriver() return NewMailer(cat, drv, opts), drv } func sendTemplate(t *testing.T, m Mailer, drv *MemoryDriver, name string, vars map[string]any) RenderedMessage { t.Helper() if err := m.Send(context.Background(), Message{Template: name, To: []string{"ada@example.com"}, Vars: vars}); err != nil { t.Fatalf("Send %s: %v", name, err) } return lastMessage(t, drv) } func bootPartials[P interface{ ID() string }](t *testing.T, plugins ...P) (*backpack.App, error) { t.Helper() app := backpack.New(nil) if err := Activate(app, plugins); err != nil { t.Fatalf("Activate: %v", err) } for _, p := range plugins { if err := BootPlugin(app, p); err != nil { return app, err } } return app, nil } // TestMailPartialsSmoke covers mail partials end to end without a database: // the pact capability and its boot errors, partial calls in Markdown bodies // and in layouts, the built-in layouts, and layout and partial overrides // from an OverrideSource. func TestMailPartialsSmoke(t *testing.T) { t.Parallel() t.Run("capability", func(t *testing.T) { if _, err := bootPartials(t, blogPlugin()); err != nil { t.Fatalf("a plugin with templates and a partial does not boot: %v", err) } fsys := partialsFS() cases := []struct { name string partials []string want []string }{ {"foreign namespace", []string{"acme.other::mail.partials.note"}, []string{"not owned", "acme.other::mail.partials.note"}}, {"outside mail.partials", []string{"acme.blog::mail.note"}, []string{"acme.blog::mail.note", "mail.partials."}}, {"missing file", []string{"acme.blog::mail.partials.gone"}, []string{"missing partial acme.blog::mail.partials.gone"}}, {"duplicate", []string{"acme.blog::mail.partials.note", "acme.blog::mail.partials.note"}, []string{"duplicate partial acme.blog::mail.partials.note"}}, {"path escape", []string{"acme.blog::mail.partials.a/../b"}, []string{"invalid mail name"}}, } for _, tc := range cases { _, err := bootPartials(t, partialsPlugin{id: "acme.blog", fsys: fsys, partials: tc.partials}) if err == nil { t.Errorf("%s: BootPlugin succeeded", tc.name) continue } for _, want := range tc.want { if !strings.Contains(err.Error(), want) { t.Errorf("%s: error %q lacks %q", tc.name, err, want) } } } // The built-in names cannot be taken by a plugin. if err := NewCatalog().RegisterPartials("postcard", fsys, []string{"postcard::mail.partials.button"}); err == nil || !strings.Contains(err.Error(), "duplicate partial") { t.Errorf("re-registering a built-in partial = %v", err) } }) t.Run("partials_only_plugin", func(t *testing.T) { // acme.kit ships only a partial; acme.blog's template calls it. kit := partialsPlugin{id: "acme.kit", partials: []string{"acme.kit::mail.partials.badge"}, fsys: fstest.MapFS{ "views/mail/partials/badge.htm": {Data: []byte("name = \"Badge\"\n==\n[{{ .label }}]\n==\n{{ .label }}\n")}, }} blog := mailPlugin{ partialsPlugin: partialsPlugin{id: "acme.blog", fsys: fstest.MapFS{ "views/mail/hello.htm": {Data: []byte("subject = \"Hello\"\n==\nNew: {{ partial \"acme.kit::mail.partials.badge\" \"label\" \"beta\" }}\n")}, }}, templates: []string{"acme.blog::mail.hello"}, } app := backpack.New(nil) if err := Activate(app, []partialsPlugin{kit}); err != nil { t.Fatal(err) } if err := BootPlugin(app, kit); err != nil { t.Fatalf("a plugin with only partials does not boot: %v", err) } // blog implements both capabilities but declares no partial. if err := BootPlugin(app, blog); err != nil { t.Fatalf("BootPlugin blog: %v", err) } // A plugin with only templates still boots. if _, err := bootPartials(t, templatesOnly{p: blog}); err != nil { t.Fatalf("a plugin with only templates does not boot: %v", err) } got, _ := app.Lookup[Mailer]() m := got.(*mailer) msg := sendTemplate(t, m, m.driver.(*MemoryDriver), "acme.blog::mail.hello", nil) if !strings.Contains(msg.HTML, `

New: beta

`) { t.Errorf("HTML = %q, want the other plugin's partial inline", msg.HTML) } if !strings.Contains(msg.Text, "New: [beta]") { t.Errorf("text = %q", msg.Text) } }) t.Run("body", func(t *testing.T) { m, drv := partialsMailer(t, Options{}, nil) msg := sendTemplate(t, m, drv, "acme.blog::mail.welcome", map[string]any{"Name": "Ada", "Link": "https://example.com/go?a=1&b=2"}) if strings.Contains(msg.HTML, "raw HTML omitted") { t.Errorf("the partial was dropped by Markdown:\n%s", msg.HTML) } for _, want := range []string{ "

Hi Ada

\nGo`, "
\n

Bye

", } { if !strings.Contains(msg.HTML, want) { t.Errorf("HTML lacks %q:\n%s", want, msg.HTML) } } if strings.Contains(msg.HTML, "MAILPARTIAL") || strings.Contains(msg.Text, "MAILPARTIAL") { t.Errorf("a token was left in the message:\n%s\n%s", msg.HTML, msg.Text) } if msg.Text != "Hi Ada\n\nGo \n\nBye\n\n-------------------\n"+copyright() { t.Errorf("text = %q", msg.Text) } // The type argument picks the button class. cat := NewCatalog() fsys := fstest.MapFS{"views/mail/b.htm": {Data: []byte("subject = \"B\"\n==\n{{ partial \"button\" \"url\" \"https://example.com\" \"body\" \"Pay\" \"type\" \"positive\" }}\n\n{{ partial \"panel\" \"body\" \"Keep **this**.\" }}\n\n{{ partial \"table\" \"body\" .Table }}\n\n{{ partial \"subcopy\" \"body\" \"Small print.\" }}\n")}} if err := cat.Register("acme.blog", fsys, []string{"acme.blog::mail.b"}, nil); err != nil { t.Fatal(err) } drv2 := NewMemoryDriver() msg = sendTemplate(t, NewMailer(cat, drv2, Options{}), drv2, "acme.blog::mail.b", map[string]any{"Table": "| Item | Qty |\n|---|---|\n| Pen | 2 |"}) for _, want := range []string{ `class="button button-positive"`, `Keep this.

", `
`, "
", "", `
ItemPen
Small print.

", } { if !strings.Contains(msg.HTML, want) { t.Errorf("built-in partials: HTML lacks %q:\n%s", want, msg.HTML) } } for _, want := range []string{"Pay ", "Keep **this**.", "| Pen | 2 |", "-----\nSmall print."} { if !strings.Contains(msg.Text, want) { t.Errorf("built-in partials: text lacks %q:\n%s", want, msg.Text) } } }) t.Run("forged_token", func(t *testing.T) { m, drv := partialsMailer(t, Options{}, nil) forged := "MAILPARTIAL1 MAILPARTIAL" + strings.Repeat("0", 32) + "X1X" msg := sendTemplate(t, m, drv, "acme.blog::mail.welcome", map[string]any{"Name": forged, "Link": "https://example.com"}) if !strings.Contains(msg.HTML, "

Hi "+forged+"

") { t.Errorf("a forged token in a variable was not left as text:\n%s", msg.HTML) } if n := strings.Count(msg.HTML, `class="button`); n != 1 { t.Errorf("%d buttons rendered, want 1:\n%s", n, msg.HTML) } if !strings.Contains(msg.Text, "Hi "+forged) { t.Errorf("text = %q", msg.Text) } // Tokens carry a fresh random nonce per render. a, b := newPartialRun(NewCatalog(), nil), newPartialRun(NewCatalog(), nil) ta, err := a.bodyCall("button", "url", "https://example.com", "body", "Go") if err != nil { t.Fatal(err) } tb, err := b.bodyCall("button", "url", "https://example.com", "body", "Go") if err != nil { t.Fatal(err) } if ta == tb { t.Errorf("two renders produced the same token %q", ta) } for _, tok := range []string{ta, tb} { if !strings.HasPrefix(tok, "MAILPARTIAL") || len(tok) < len("MAILPARTIAL")+32 || strings.Trim(tok, "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789") != "" { t.Errorf("token %q is not MAILPARTIAL plus an alphanumeric nonce", tok) } } }) t.Run("errors", func(t *testing.T) { cases := map[string]struct { body string want []string }{ "unknown": {`{{ partial "nope" "a" "b" }}`, []string{"unknown partial", "postcard::mail.partials.nope"}}, "unknown_ns": {`{{ partial "acme.blog::mail.partials.nope" }}`, []string{"unknown partial", "acme.blog::mail.partials.nope"}}, "odd": {`{{ partial "button" "url" }}`, []string{"postcard::mail.partials.button", "key and a value"}}, "key_type": {`{{ partial "button" 1 "x" }}`, []string{"postcard::mail.partials.button", "not a string"}}, // The partial's own markup carries an entity-encoded javascript: // link; prose in a body is not a URL and passes. "unsafe_html": {`{{ partial "acme.blog::mail.partials.link" "text" "Go" }}`, []string{"dangerous"}}, } for name, tc := range cases { cat := NewCatalog() fsys := fstest.MapFS{ "views/mail/x.htm": {Data: []byte("subject = \"X\"\n==\n" + tc.body + "\n")}, "views/mail/partials/link.htm": {Data: []byte("name = \"Link\"\n==\n{{ .text }}\n==\n{{ .text }}\n")}, } if err := cat.RegisterPartials("acme.blog", fsys, []string{"acme.blog::mail.partials.link"}); err != nil { t.Fatalf("%s: RegisterPartials: %v", name, err) } if err := cat.Register("acme.blog", fsys, []string{"acme.blog::mail.x"}, nil); err != nil { t.Fatalf("%s: Register: %v", name, err) } drv := NewMemoryDriver() err := NewMailer(cat, drv, Options{}).Send(context.Background(), Message{Template: "acme.blog::mail.x", To: []string{"ada@example.com"}}) if err == nil { t.Errorf("%s: Send succeeded", name) continue } for _, want := range tc.want { if !strings.Contains(err.Error(), want) { t.Errorf("%s: error %q lacks %q", name, err, want) } } if len(drv.Messages()) != 0 { t.Errorf("%s: a message was sent", name) } } // partial is not available inside a partial. nested := fstest.MapFS{"views/mail/partials/outer.htm": {Data: []byte("name = \"Outer\"\n==\nx\n==\n{{ partial \"button\" }}\n")}} cat := NewCatalog() if err := cat.RegisterPartials("acme.blog", nested, []string{"acme.blog::mail.partials.outer"}); err != nil { t.Fatal(err) } if _, err := newPartialRun(cat, nil).htmlCall("acme.blog::mail.partials.outer"); err == nil || !strings.Contains(err.Error(), `function "partial" not defined`) { t.Errorf("a partial calling partial = %v", err) } }) t.Run("built_in_layouts", func(t *testing.T) { const logo = "https://cdn.example.com/u/logo.png" header := "
\n\"Acme" // The system layout with a logo: the header above the card, the // card with the subcopy, the footer below, and the content cell's // side padding. m, drv := partialsMailer(t, Options{CSS: "p{color:red}"}, &Overrides{Brand: &Brand{LogoURL: logo, SiteName: "Acme Mail"}}) msg := sendTemplate(t, m, drv, "acme.blog::mail.auto", nil) html := unstyled(msg.HTML) for _, want := range []string{ `class="wrapper layout-system"`, header, "

Done.

", `This is an automatic message. Please do not reply to it.", `
" + copyright() + " Acme Mail

", } { if !strings.Contains(html, want) { t.Errorf("system layout: HTML lacks %q:\n%s", want, html) } } if h, card, foot := strings.Index(html, `class="header"`), strings.Index(html, `class="inner-body"`), strings.Index(html, `class="footer"`); h > card || card > foot { t.Errorf("system layout: header %d, card %d, footer %d are out of order", h, card, foot) } // mail.css is inlined onto the paragraph, after the brand CSS. if !regexp.MustCompile(`

]*>Done\.

`).MatchString(msg.HTML) { t.Errorf("system layout: mail.css is not inlined:\n%s", msg.HTML) } if !strings.Contains(msg.HTML, `