Files
larksuite-cli/shortcuts/mail/mail_draft_create_test.go
bubbmon233 bbef3cbfb1 feat(mail): HTML lint library + Larksuite-native autofix + lark-mail … (#1019)
* feat(mail): HTML lint library + Larksuite-native autofix + lark-mail skill

为 lark-cli mail 域写信链路引入 HTML lint 能力,提升邮件 HTML 的兼容性、
安全性与 Larksuite-native 格式适配。

lint 库(shortcuts/mail/lint/):
- 四档分类:pass / native-autofix / warn-autofix / error-strip
- 安全规则覆盖 script / iframe / on* 事件处理器 / javascript: 及其它
  危险 URL scheme 等 XSS 向量,未知 scheme 一律删除并归 error
- Larksuite-native 格式自动修复:双层 div 段落、原生多级列表结构、
  灰边引用、Larksuite 蓝链接
- cleaned_html 输出确定性稳定(位置索引派生 data-ol-id),便于
  golden-file 测试与缓存

+lint-html 独立预检 shortcut:
- 只读、不调 API、不建草稿,供 AI / 用户 / CI 在写信前预览 lint 结果

写入路径内置 lint(6 个 compose shortcut):
- +send / +draft-create / +draft-edit / +reply / +reply-all / +forward
  在 emlbuilder 之前强制 lint 净化 HTML
- 默认 envelope 对 lint 改动透明(无 lint 字段),保持小巧供 AI 消费;
  --show-lint-details 显式取证返回 lint_applied[] / original_blocked[]
- --body-file 支持从文件读取 body(32MB 上限),与 --body 互斥

预制 HTML 邮件模板(skills/lark-mail/assets/templates/):
- 资讯周报 / 个人周报 / 团队周报 / 调研报告 / 求职简历 5 套
- 按 Larksuite mail-editor 原生格式编写,含正确的多级列表嵌套结构

lark-mail skill 文档:
- references/lark-mail-html.md:邮件 HTML 写法指南(24 个格式 section
  + 颜色调色盘 + URL scheme + 官方模板套用流程)
- references/lark-mail-lint-html.md:+lint-html 用法
- SKILL.md 顶部 CRITICAL 引导

* fix(mail): remove unused readAttr func and apply gofmt

Drop the unused `readAttr` helper in shortcuts/mail/lint/linter.go
that was flagged by golangci-lint (unused linter). Apply gofmt to
linter.go and rules.go which had minor formatting issues.

* fix(mail): address compose lint and guidance
2026-05-27 22:23:32 +08:00

423 lines
14 KiB
Go

// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package mail
import (
"context"
"encoding/base64"
"encoding/json"
"os"
"strings"
"testing"
"github.com/larksuite/cli/internal/httpmock"
"github.com/larksuite/cli/shortcuts/common"
"github.com/spf13/cobra"
)
// newRuntimeWithEventFlags creates a RuntimeContext with --from and calendar event flags.
func newRuntimeWithEventFlags(from, summary, start, end, location string) *common.RuntimeContext {
cmd := &cobra.Command{Use: "test"}
for _, name := range []string{"from", "mailbox", "event-summary", "event-start", "event-end", "event-location"} {
cmd.Flags().String(name, "", "")
}
if from != "" {
_ = cmd.Flags().Set("from", from)
}
if summary != "" {
_ = cmd.Flags().Set("event-summary", summary)
}
if start != "" {
_ = cmd.Flags().Set("event-start", start)
}
if end != "" {
_ = cmd.Flags().Set("event-end", end)
}
if location != "" {
_ = cmd.Flags().Set("event-location", location)
}
return &common.RuntimeContext{Cmd: cmd}
}
// newRuntimeWithFrom creates a minimal RuntimeContext with --from flag set.
func newRuntimeWithFrom(from string) *common.RuntimeContext {
cmd := &cobra.Command{Use: "test"}
cmd.Flags().String("from", "", "")
cmd.Flags().String("mailbox", "", "")
if from != "" {
_ = cmd.Flags().Set("from", from)
}
return &common.RuntimeContext{Cmd: cmd}
}
// TestBuildRawEMLForDraftCreate_ResolvesLocalImages verifies build raw EML for draft create resolves local images.
func TestBuildRawEMLForDraftCreate_ResolvesLocalImages(t *testing.T) {
chdirTemp(t)
os.WriteFile("test_image.png", []byte{0x89, 'P', 'N', 'G', 0x0D, 0x0A, 0x1A, 0x0A}, 0o644)
input := draftCreateInput{
From: "sender@example.com",
Subject: "local image test",
Body: `<p>Hello</p><p><img src="./test_image.png" /></p>`,
}
rawEML, _, _, err := buildRawEMLForDraftCreate(context.Background(), newRuntimeWithFrom("sender@example.com"), input, nil, "", nil, "", "", nil, nil)
if err != nil {
t.Fatalf("buildRawEMLForDraftCreate() error = %v", err)
}
eml := decodeBase64URL(rawEML)
if strings.Contains(eml, `src="./test_image.png"`) {
t.Fatal("local image path should have been replaced with cid: reference")
}
if !strings.Contains(eml, "cid:") {
t.Fatal("expected cid: reference in resolved HTML body")
}
if !strings.Contains(eml, "Content-Disposition: inline") {
t.Fatal("expected inline MIME part for the resolved image")
}
}
// TestBuildRawEMLForDraftCreate_NoLocalImages verifies build raw EML for draft create no local images.
func TestBuildRawEMLForDraftCreate_NoLocalImages(t *testing.T) {
input := draftCreateInput{
From: "sender@example.com",
Subject: "plain html",
Body: `<p>Hello <b>world</b></p>`,
}
rawEML, _, _, err := buildRawEMLForDraftCreate(context.Background(), newRuntimeWithFrom("sender@example.com"), input, nil, "", nil, "", "", nil, nil)
if err != nil {
t.Fatalf("buildRawEMLForDraftCreate() error = %v", err)
}
eml := decodeBase64URL(rawEML)
if !strings.Contains(eml, "Hello") {
t.Fatal("expected body content in EML")
}
if strings.Contains(eml, "Content-Disposition: inline") {
t.Fatal("no inline parts expected without local images")
}
}
// TestBuildRawEMLForDraftCreate_AutoResolveCountedInSizeLimit verifies build raw EML for draft create auto resolve counted in size limit.
func TestBuildRawEMLForDraftCreate_AutoResolveCountedInSizeLimit(t *testing.T) {
chdirTemp(t)
// Create a 1KB PNG file — small, but enough to push over the limit
// when combined with a near-limit --attach file.
pngHeader := []byte{0x89, 'P', 'N', 'G', 0x0D, 0x0A, 0x1A, 0x0A}
imgData := make([]byte, 1024)
copy(imgData, pngHeader)
os.WriteFile("photo.png", imgData, 0o644)
// Create an attach file that's just under the 25MB limit (use .txt — allowed extension).
bigFile := make([]byte, MaxAttachmentBytes-500)
os.WriteFile("big.txt", bigFile, 0o644)
input := draftCreateInput{
From: "sender@example.com",
Subject: "size limit test",
Body: `<p><img src="./photo.png" /></p>`,
Attach: "./big.txt",
}
_, _, _, err := buildRawEMLForDraftCreate(context.Background(), newRuntimeWithFrom("sender@example.com"), input, nil, "", nil, "", "", nil, nil)
if err == nil {
t.Fatal("expected size limit error when auto-resolved image + attachment exceed 25MB")
}
if !strings.Contains(err.Error(), "25 MB") && !strings.Contains(err.Error(), "large attachment") {
t.Fatalf("expected size limit or large attachment error, got: %v", err)
}
}
// TestBuildRawEMLForDraftCreate_OrphanedInlineSpecError verifies build raw EML for draft create orphaned inline spec error.
func TestBuildRawEMLForDraftCreate_OrphanedInlineSpecError(t *testing.T) {
chdirTemp(t)
os.WriteFile("unused.png", []byte{0x89, 'P', 'N', 'G', 0x0D, 0x0A, 0x1A, 0x0A}, 0o644)
input := draftCreateInput{
From: "sender@example.com",
Subject: "orphan test",
Body: `<p>No image reference here</p>`,
Inline: `[{"cid":"orphan","file_path":"./unused.png"}]`,
}
_, _, _, err := buildRawEMLForDraftCreate(context.Background(), newRuntimeWithFrom("sender@example.com"), input, nil, "", nil, "", "", nil, nil)
if err == nil {
t.Fatal("expected error for orphaned --inline CID not referenced in body")
}
if !strings.Contains(err.Error(), "orphan") {
t.Fatalf("expected error mentioning orphan, got: %v", err)
}
}
// TestBuildRawEMLForDraftCreate_MissingCIDRefError verifies build raw EML for draft create missing CID ref error.
func TestBuildRawEMLForDraftCreate_MissingCIDRefError(t *testing.T) {
chdirTemp(t)
os.WriteFile("present.png", []byte{0x89, 'P', 'N', 'G', 0x0D, 0x0A, 0x1A, 0x0A}, 0o644)
input := draftCreateInput{
From: "sender@example.com",
Subject: "missing cid test",
Body: `<p><img src="cid:present" /><img src="cid:missing" /></p>`,
Inline: `[{"cid":"present","file_path":"./present.png"}]`,
}
_, _, _, err := buildRawEMLForDraftCreate(context.Background(), newRuntimeWithFrom("sender@example.com"), input, nil, "", nil, "", "", nil, nil)
if err == nil {
t.Fatal("expected error for missing CID reference")
}
if !strings.Contains(err.Error(), "missing") {
t.Fatalf("expected error mentioning missing, got: %v", err)
}
}
// TestBuildRawEMLForDraftCreate_WithPriority verifies build raw EML for draft create with priority.
func TestBuildRawEMLForDraftCreate_WithPriority(t *testing.T) {
input := draftCreateInput{
From: "sender@example.com",
Subject: "priority test",
Body: `<p>Hello</p>`,
}
rawEML, _, _, err := buildRawEMLForDraftCreate(context.Background(), newRuntimeWithFrom("sender@example.com"), input, nil, "1", nil, "", "", nil, nil)
if err != nil {
t.Fatalf("buildRawEMLForDraftCreate() error = %v", err)
}
eml := decodeBase64URL(rawEML)
if !strings.Contains(eml, "X-Cli-Priority: 1") {
t.Errorf("expected X-Cli-Priority: 1 in EML, got:\n%s", eml)
}
}
// TestBuildRawEMLForDraftCreate_NoPriority verifies build raw EML for draft create no priority.
func TestBuildRawEMLForDraftCreate_NoPriority(t *testing.T) {
input := draftCreateInput{
From: "sender@example.com",
Subject: "no priority",
Body: `<p>Hello</p>`,
}
rawEML, _, _, err := buildRawEMLForDraftCreate(context.Background(), newRuntimeWithFrom("sender@example.com"), input, nil, "", nil, "", "", nil, nil)
if err != nil {
t.Fatalf("buildRawEMLForDraftCreate() error = %v", err)
}
eml := decodeBase64URL(rawEML)
if strings.Contains(eml, "X-Cli-Priority") {
t.Errorf("expected no X-Cli-Priority header when priority is empty, got:\n%s", eml)
}
}
// newRuntimeWithFromAndRequestReceipt mirrors newRuntimeWithFrom but also
// exposes the --request-receipt bool flag so tests can exercise the
// Disposition-Notification-To / validation-error paths gated by that flag.
func newRuntimeWithFromAndRequestReceipt(from string, requestReceipt bool) *common.RuntimeContext {
cmd := &cobra.Command{Use: "test"}
cmd.Flags().String("from", "", "")
cmd.Flags().String("mailbox", "", "")
cmd.Flags().Bool("request-receipt", false, "")
if from != "" {
_ = cmd.Flags().Set("from", from)
}
if requestReceipt {
_ = cmd.Flags().Set("request-receipt", "true")
}
return &common.RuntimeContext{Cmd: cmd}
}
// TestBuildRawEMLForDraftCreate_RequestReceiptAddsHeader verifies build raw EML for draft create request receipt adds header.
func TestBuildRawEMLForDraftCreate_RequestReceiptAddsHeader(t *testing.T) {
input := draftCreateInput{
From: "sender@example.com",
Subject: "needs receipt",
Body: "<p>hi</p>",
}
rawEML, _, _, err := buildRawEMLForDraftCreate(context.Background(),
newRuntimeWithFromAndRequestReceipt("sender@example.com", true), input, nil, "", nil, "", "", nil, nil)
if err != nil {
t.Fatalf("buildRawEMLForDraftCreate() error = %v", err)
}
eml := decodeBase64URL(rawEML)
// Pin the full header value, not just "sender@example.com" somewhere in the
// EML — the From: header already contains that address, so a substring
// check would pass even if the DNT wiring was completely broken.
if !strings.Contains(eml, "Disposition-Notification-To: <sender@example.com>") {
t.Errorf("expected DNT header addressed to sender; got EML:\n%s", eml)
}
}
// TestBuildRawEMLForDraftCreate_RequestReceiptOmittedByDefault verifies build raw EML for draft create request receipt omitted by default.
func TestBuildRawEMLForDraftCreate_RequestReceiptOmittedByDefault(t *testing.T) {
input := draftCreateInput{
From: "sender@example.com",
Subject: "no receipt",
Body: "<p>hi</p>",
}
rawEML, _, _, err := buildRawEMLForDraftCreate(context.Background(),
newRuntimeWithFromAndRequestReceipt("sender@example.com", false), input, nil, "", nil, "", "", nil, nil)
if err != nil {
t.Fatalf("buildRawEMLForDraftCreate() error = %v", err)
}
eml := decodeBase64URL(rawEML)
if strings.Contains(eml, "Disposition-Notification-To:") {
t.Errorf("expected no Disposition-Notification-To header when --request-receipt unset; got EML:\n%s", eml)
}
}
// TestBuildRawEMLForDraftCreate_PlainTextSkipsResolve verifies build raw EML for draft create plain text skips resolve.
func TestBuildRawEMLForDraftCreate_PlainTextSkipsResolve(t *testing.T) {
chdirTemp(t)
os.WriteFile("img.png", []byte{0x89, 'P', 'N', 'G', 0x0D, 0x0A, 0x1A, 0x0A}, 0o644)
input := draftCreateInput{
From: "sender@example.com",
Subject: "plain text",
Body: `check <img src="./img.png" /> text`,
PlainText: true,
}
rawEML, _, _, err := buildRawEMLForDraftCreate(context.Background(), newRuntimeWithFrom("sender@example.com"), input, nil, "", nil, "", "", nil, nil)
if err != nil {
t.Fatalf("buildRawEMLForDraftCreate() error = %v", err)
}
eml := decodeBase64URL(rawEML)
if strings.Contains(eml, "cid:") {
t.Fatal("plain-text mode should not resolve local images")
}
}
func TestBuildRawEMLForDraftCreate_WithCalendarEvent(t *testing.T) {
rt := newRuntimeWithEventFlags("sender@example.com", "Team Sync", "2026-05-10T10:00+08:00", "2026-05-10T11:00+08:00", "Room 301")
input := draftCreateInput{
From: "sender@example.com",
To: "alice@example.com",
Subject: "Team Sync",
Body: "<p>Please join us</p>",
}
rawEML, _, _, err := buildRawEMLForDraftCreate(context.Background(), rt, input, nil, "", nil, "", "", nil, nil)
if err != nil {
t.Fatalf("buildRawEMLForDraftCreate() error = %v", err)
}
eml := decodeBase64URL(rawEML)
if !strings.Contains(eml, "text/calendar") {
t.Errorf("expected text/calendar part in EML:\n%s", eml)
}
if !strings.Contains(eml, "method=REQUEST") {
t.Errorf("expected method=REQUEST in Content-Type:\n%s", eml)
}
if !strings.Contains(eml, "multipart/alternative") {
t.Errorf("expected calendar inside multipart/alternative:\n%s", eml)
}
}
// TestMailDraftCreatePrettyOutputsReference verifies mail draft create pretty outputs reference.
func TestMailDraftCreatePrettyOutputsReference(t *testing.T) {
f, stdout, _, reg := mailShortcutTestFactory(t)
reg.Register(&httpmock.Stub{
Method: "GET",
URL: "/user_mailboxes/me/profile",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{
"primary_email_address": "me@example.com",
},
},
})
reg.Register(&httpmock.Stub{
Method: "POST",
URL: "/user_mailboxes/me/drafts",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{
"draft_id": "draft_001",
"reference": "https://www.feishu.cn/mail?draftId=draft_001",
},
},
})
err := runMountedMailShortcut(t, MailDraftCreate, []string{
"+draft-create",
"--subject", "hello",
"--body", "world",
"--format", "pretty",
}, f, stdout)
if err != nil {
t.Fatalf("draft create failed: %v", err)
}
out := stdout.String()
if !strings.Contains(out, "Draft created.") {
t.Fatalf("expected pretty output header, got: %s", out)
}
if !strings.Contains(out, "draft_id: draft_001") {
t.Fatalf("expected draft_id in pretty output, got: %s", out)
}
if !strings.Contains(out, "reference: https://www.feishu.cn/mail?draftId=draft_001") {
t.Fatalf("expected reference in pretty output, got: %s", out)
}
}
func TestMailDraftCreate_WithCalendarEventFlags(t *testing.T) {
f, stdout, _, reg := mailShortcutTestFactory(t)
draftsStub := &httpmock.Stub{
Method: "POST",
URL: "/user_mailboxes/me/drafts",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{"draft_id": "draft_cal_001"},
},
}
reg.Register(&httpmock.Stub{
Method: "GET",
URL: "/user_mailboxes/me/profile",
Body: map[string]interface{}{
"code": 0,
"data": map[string]interface{}{"primary_email_address": "me@example.com"},
},
})
reg.Register(draftsStub)
err := runMountedMailShortcut(t, MailDraftCreate, []string{
"+draft-create",
"--to", "alice@example.com",
"--subject", "Team Sync",
"--body", "<p>Please join us</p>",
"--event-summary", "Team Sync",
"--event-start", "2026-05-10T10:00+08:00",
"--event-end", "2026-05-10T11:00+08:00",
"--event-location", "Room 301",
}, f, stdout)
if err != nil {
t.Fatalf("draft create with calendar failed: %v", err)
}
var reqBody map[string]interface{}
if err := json.Unmarshal(draftsStub.CapturedBody, &reqBody); err != nil {
t.Fatalf("unmarshal captured request body: %v", err)
}
raw, _ := reqBody["raw"].(string)
decoded, decErr := base64.URLEncoding.DecodeString(raw)
if decErr != nil {
t.Fatalf("base64url decode raw: %v", decErr)
}
eml := string(decoded)
if !strings.Contains(eml, "text/calendar") {
t.Errorf("expected text/calendar in EML:\n%s", eml)
}
if !strings.Contains(eml, "Team Sync") {
t.Errorf("expected event summary in ICS:\n%s", eml)
}
}