package cli import ( "bytes" "context" "crypto/ed25519" "crypto/rand" "crypto/x509" "encoding/json" "encoding/pem" "errors" "fmt" "io" "net/http" "net/http/httptest" "os" "path/filepath" "regexp" "strings" "testing" "time" "codeberg.org/squidd/parsimony/internal/api" "codeberg.org/squidd/parsimony/internal/dkimsign" "codeberg.org/squidd/parsimony/internal/store" ) const token = "cli-token" type fakeReleaser struct{ released []int64 } func (f *fakeReleaser) Release(_ context.Context, id int64) error { f.released = append(f.released, id) return nil } type env struct { s *store.Store srv *httptest.Server rel *fakeReleaser } // newEnv serves the real API handler over HTTP: the CLI talks to the real thing. func newEnv(t *testing.T) *env { t.Helper() s, err := store.Open(":memory:") if err != nil { t.Fatal(err) } rel := &fakeReleaser{} srv := httptest.NewServer(api.New(s, token, rel)) t.Cleanup(func() { srv.Close(); s.Close() }) return &env{s: s, srv: srv, rel: rel} } // run executes the CLI like a shell would and returns exit code, stdout and stderr. func (e *env) run(t *testing.T, args ...string) (int, string, string) { t.Helper() return e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}, "", args...) } func (e *env) runEnv(t *testing.T, vars map[string]string, stdin string, args ...string) (int, string, string) { t.Helper() var out, errb bytes.Buffer code := Run(args, IO{In: strings.NewReader(stdin), Out: &out, Err: &errb}, func(k string) string { return vars[k] }) return code, out.String(), errb.String() } func (e *env) ok(t *testing.T, args ...string) string { t.Helper() code, out, errs := e.run(t, args...) if code != 0 { t.Fatalf("%v: exit %d\nstdout: %s\nstderr: %s", args, code, out, errs) } return out } func (e *env) fails(t *testing.T, wantCode int, wantErr string, args ...string) { t.Helper() code, out, errs := e.run(t, args...) if code != wantCode { t.Fatalf("%v: exit %d, want %d\nstdout: %s\nstderr: %s", args, code, wantCode, out, errs) } if !strings.Contains(errs, wantErr) { t.Fatalf("%v: stderr %q lacks %q", args, errs, wantErr) } if out != "" { t.Fatalf("%v: errors must not print to stdout: %q", args, out) } } func TestHelpAndUsageErrors(t *testing.T) { e := newEnv(t) for _, args := range [][]string{{"help"}, {"-h"}, {"--help"}} { code, out, _ := e.run(t, args...) if code != 0 || !strings.Contains(out, "list") || !strings.Contains(out, "PARSIMONY_API_TOKEN") { t.Fatalf("%v: %d %q", args, code, out) } } e.fails(t, 2, "usage") e.fails(t, 2, "unknown command", "frobnicate") e.fails(t, 2, "unknown command", "list", "frobnicate") e.fails(t, 2, "usage: parsimony list add", "list", "add") e.fails(t, 2, "usage: parsimony member add", "member", "add", "dev@example.org") e.fails(t, 2, "flag provided but not defined", "list", "ls", "--nope") } func TestAuthAndConnectionProblems(t *testing.T) { e := newEnv(t) code, _, errs := e.runEnv(t, map[string]string{"PARSIMONY_URL": e.srv.URL}, "", "list", "ls") if code != 1 || !strings.Contains(errs, "PARSIMONY_API_TOKEN is not set") { t.Fatalf("no token: %d %q", code, errs) } code, _, errs = e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": "wrong", "PARSIMONY_URL": e.srv.URL}, "", "list", "ls") if code != 1 || !strings.Contains(errs, "invalid or missing token") { t.Fatalf("wrong token: %d %q", code, errs) } code, _, errs = e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": "http://127.0.0.1:1"}, "", "list", "ls") if code != 1 || !strings.Contains(errs, "cannot reach") { t.Fatalf("unreachable: %d %q", code, errs) } } func TestURLFlagBeatsEnvironmentAndTrailingSlashIsFine(t *testing.T) { e := newEnv(t) vars := map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": "http://127.0.0.1:1"} code, _, errs := e.runEnv(t, vars, "", "--url", e.srv.URL+"/", "list", "ls") if code != 0 { t.Fatalf("--url must win over PARSIMONY_URL: %d %q", code, errs) } code, _, errs = e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token}, "", "list", "ls") if code != 1 || !strings.Contains(errs, "cannot reach") { t.Fatalf("default URL is the local daemon: %d %q", code, errs) } } func TestListLifecycle(t *testing.T) { e := newEnv(t) if out := e.ok(t, "list", "ls"); !strings.Contains(out, "No lists") { t.Fatalf("empty: %q", out) } out := e.ok(t, "list", "add", "dev@example.org", "--title", "Developers") if !strings.Contains(out, "Created dev@example.org") { t.Fatalf("add: %q", out) } e.ok(t, "list", "add", "news@example.org") out = e.ok(t, "list", "ls") for _, want := range []string{"ID", "ADDRESS", "TITLE", "POST", "JOIN", "ARCHIVE", "dev@example.org", "Developers", "members", "open", "private", "news@example.org"} { if !strings.Contains(out, want) { t.Fatalf("ls lacks %q:\n%s", want, out) } } e.fails(t, 1, "already exists", "list", "add", "dev@example.org") e.fails(t, 2, "name@domain", "list", "add", "nodomain") e.fails(t, 2, "name@domain", "list", "add", "@example.org") e.fails(t, 1, "name must be", "list", "add", "a+b@example.org") for _, ref := range []string{"dev@example.org", "DEV@Example.org", "1"} { out = e.ok(t, "list", "show", ref) if !strings.Contains(out, "dev@example.org") || !strings.Contains(out, "Developers") || !strings.Contains(out, "archive") { t.Fatalf("show %s: %q", ref, out) } } e.fails(t, 1, "no such list", "list", "show", "ghost@example.org") e.fails(t, 1, "no such list", "list", "show", "99") e.fails(t, 1, "no such list", "list", "show", "notanumber") out = e.ok(t, "list", "set", "dev@example.org", "--post", "moderated", "--archive", "public") if !strings.Contains(out, "Updated dev@example.org") { t.Fatalf("set: %q", out) } l, _ := e.s.FindList("dev@example.org") if l.PostPolicy != "moderated" || l.ArchivePolicy != "public" || l.JoinPolicy != "open" || l.Title != "Developers" { t.Fatalf("only the given fields change: %+v", l) } e.ok(t, "list", "set", "1", "--title", "Core devs", "--join", "closed") l, _ = e.s.FindList("dev@example.org") if l.Title != "Core devs" || l.JoinPolicy != "closed" || l.PostPolicy != "moderated" { t.Fatalf("%+v", l) } e.fails(t, 2, "nothing to change", "list", "set", "dev@example.org") e.fails(t, 1, "post_policy", "list", "set", "dev@example.org", "--post", "bogus") e.fails(t, 1, "no such list", "list", "set", "ghost@example.org", "--title", "x") } func TestListRemoveNeedsYes(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") e.fails(t, 2, "--yes", "list", "rm", "dev@example.org") if _, err := e.s.FindList("dev@example.org"); err != nil { t.Fatal("without --yes nothing is deleted") } out := e.ok(t, "list", "rm", "dev@example.org", "--yes") if !strings.Contains(out, "Deleted dev@example.org") { t.Fatalf("rm: %q", out) } if _, err := e.s.FindList("dev@example.org"); err == nil { t.Fatal("list must be gone") } e.fails(t, 1, "no such list", "list", "rm", "dev@example.org", "--yes") } func TestJSONOutputIsValidAndStable(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org", "--title", "Dev") var lists []map[string]any if err := json.Unmarshal([]byte(e.ok(t, "--json", "list", "ls")), &lists); err != nil || len(lists) != 1 || lists[0]["address"] != "dev@example.org" { t.Fatalf("json ls: %v %v", err, lists) } var one map[string]any if err := json.Unmarshal([]byte(e.ok(t, "--json", "list", "show", "dev@example.org")), &one); err != nil || one["title"] != "Dev" { t.Fatalf("json show: %v %v", err, one) } e.s.CreateList("empty", "example.org", "E") var ms []any if err := json.Unmarshal([]byte(e.ok(t, "--json", "member", "ls", "empty@example.org")), &ms); err != nil || ms == nil || len(ms) != 0 { t.Fatalf("an empty result is [] in JSON: %v %v", err, ms) } } func TestMembers(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") if out := e.ok(t, "member", "ls", "dev@example.org"); !strings.Contains(out, "No members") { t.Fatalf("empty: %q", out) } out := e.ok(t, "member", "add", "dev@example.org", "Alice@Example.com", "--name", "Alice") if !strings.Contains(out, "Added alice@example.com") { t.Fatalf("add: %q", out) } e.ok(t, "member", "add", "1", "bob@example.com") out = e.ok(t, "member", "ls", "dev@example.org") for _, want := range []string{"ADDRESS", "NAME", "STATUS", "alice@example.com", "Alice", "bob@example.com", "active"} { if !strings.Contains(out, want) { t.Fatalf("ls lacks %q:\n%s", want, out) } } if out := e.ok(t, "member", "ls", "dev@example.org", "--emails"); out != "alice@example.com\nbob@example.com\n" { t.Fatalf("--emails: %q", out) } e.fails(t, 1, "valid email", "member", "add", "dev@example.org", "not-an-address") e.fails(t, 1, "no such list", "member", "add", "ghost@example.org", "a@b.com") // Bounce state is visible, and adding again re-enables. l, _ := e.s.FindList("dev@example.org") ms, _ := e.s.Members(l.ID) e.s.RecordHardBounce(ms[1].ID, 3) out = e.ok(t, "member", "ls", "dev@example.org") if !strings.Contains(out, "active (1 bounce)") { t.Fatalf("a member with a few bounces is still active: %s", out) } for i := 0; i < 3; i++ { e.s.RecordHardBounce(ms[0].ID, 3) } out = e.ok(t, "member", "ls", "dev@example.org") if !strings.Contains(out, "disabled (3 bounces)") { t.Fatalf("bounce state: %s", out) } e.ok(t, "member", "add", "dev@example.org", "alice@example.com") if out = e.ok(t, "member", "ls", "dev@example.org"); strings.Contains(out, "disabled") { t.Fatalf("re-adding re-enables: %s", out) } out = e.ok(t, "member", "rm", "dev@example.org", "bob@example.com") if !strings.Contains(out, "Removed bob@example.com") { t.Fatalf("rm: %q", out) } e.fails(t, 1, "not found", "member", "rm", "dev@example.org", "bob@example.com") if ok, _ := e.s.IsMember(l.ID, "alice@example.com"); !ok { t.Fatal("alice must stay") } } func TestMemberImport(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") input := "# subscribers exported from Mailman\n\nalice@example.com, Alice Smith\nbob@example.com\n carol@example.com ,Carol \nnot-an-address\ndave@example.com,Dave,Publisher\n" code, out, errs := e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}, input, "member", "import", "dev@example.org", "-") if code != 1 { t.Fatalf("a failed line must make the exit code non-zero, got %d", code) } if !strings.Contains(out, "Imported 4") || !strings.Contains(out, "1 failed") { t.Fatalf("summary: %q", out) } if !strings.Contains(errs, "line 6") || !strings.Contains(errs, "not-an-address") || !strings.Contains(errs, "valid email") { t.Fatalf("the failing line is reported with its number: %q", errs) } l, _ := e.s.FindList("dev@example.org") ms, _ := e.s.Members(l.ID) names := map[string]string{} for _, m := range ms { names[m.Address] = m.DisplayName } if len(ms) != 4 || names["alice@example.com"] != "Alice Smith" || names["carol@example.com"] != "Carol" || names["dave@example.com"] != "Dave" { t.Fatalf("members: %v", names) } // Importing again is idempotent; a file works as well as stdin. path := t.TempDir() + "/subs.txt" if err := os.WriteFile(path, []byte("alice@example.com\nerin@example.com\n"), 0o600); err != nil { t.Fatal(err) } out = e.ok(t, "member", "import", "dev@example.org", path) if !strings.Contains(out, "Imported 2") || strings.Contains(out, "failed") { t.Fatalf("file import: %q", out) } e.fails(t, 1, "no such file", "member", "import", "dev@example.org", "/nonexistent/file.txt") e.fails(t, 1, "no such list", "member", "import", "ghost@example.org", path) } func TestHeldQueue(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") l, _ := e.s.FindList("dev@example.org") if out := e.ok(t, "held", "ls", "dev@example.org"); !strings.Contains(out, "Nothing is held") { t.Fatalf("empty: %q", out) } id1, _ := e.s.HoldMessage(l.ID, "bob@x.com", []byte("From: Bob \r\nSubject: First held\r\n\r\nbody"), "the list is moderated") id2, _ := e.s.HoldMessage(l.ID, "eve@x.com", []byte("Subject: Second held\r\n\r\nbody"), "") id3, _ := e.s.HoldMessage(l.ID, "anon@x.com", []byte("From: anon@x.com\r\n\r\nno subject here"), "") out := e.ok(t, "held", "ls", "dev@example.org") for _, want := range []string{"ID", "SENDER", "FROM", "SUBJECT", "SIZE", "REASON", "bob@x.com", "First held", "eve@x.com", "Second held", "(no subject)", "the list is moderated"} { if !strings.Contains(out, want) { t.Fatalf("held ls lacks %q:\n%s", want, out) } } out = e.ok(t, "held", "approve", fmt.Sprint(id1)) if !strings.Contains(out, "Approved") || len(e.rel.released) != 1 || e.rel.released[0] != id1 { t.Fatalf("approve: %q %v", out, e.rel.released) } out = e.ok(t, "held", "discard", fmt.Sprint(id2)) if !strings.Contains(out, "Discarded") { t.Fatalf("discard: %q", out) } e.ok(t, "held", "discard", fmt.Sprint(id3)) if h, _ := e.s.ListHeld(l.ID); len(h) != 1 { // the approved one stays: the fake releaser only records it t.Fatalf("held left: %d", len(h)) } e.fails(t, 1, "not found", "held", "discard", fmt.Sprint(id2)) e.fails(t, 2, "usage: parsimony held approve", "held", "approve") e.fails(t, 2, "not a valid id", "held", "approve", "abc") } func TestArchive(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") l, _ := e.s.FindList("dev@example.org") if out := e.ok(t, "archive", "ls", "dev@example.org"); !strings.Contains(out, "archive is empty") { t.Fatalf("empty: %q", out) } for i, subj := range []string{"Deploy failed", "Lunch plans", "Deploy fixed"} { e.s.ArchiveMessage(l.ID, store.Message{MessageID: fmt.Sprintf("<%d@x>", i), Subject: subj, Sender: "Alice", Date: time.Unix(1_700_000_000+int64(i), 0), Body: "body of " + subj}) } out := e.ok(t, "archive", "ls", "dev@example.org") for _, want := range []string{"ID", "DATE", "FROM", "SUBJECT", "Deploy fixed", "Lunch plans", "Deploy failed", "3 messages"} { if !strings.Contains(out, want) { t.Fatalf("archive ls lacks %q:\n%s", want, out) } } if strings.Index(out, "Deploy fixed") > strings.Index(out, "Deploy failed") { t.Fatal("newest first") } out = e.ok(t, "archive", "ls", "dev@example.org", "--q", "deploy") if strings.Contains(out, "Lunch") || !strings.Contains(out, "2 messages") { t.Fatalf("search: %q", out) } out = e.ok(t, "archive", "ls", "dev@example.org", "--limit", "1", "--offset", "1") if !strings.Contains(out, "Lunch plans") || strings.Contains(out, "Deploy fixed") || !strings.Contains(out, "Showing 1 of 3 messages") { t.Fatalf("paging: %q", out) } if out = e.ok(t, "archive", "ls", "dev@example.org", "--q", "zzz"); !strings.Contains(out, "No messages found") { t.Fatalf("no match: %q", out) } out = e.ok(t, "archive", "show", "1") if !strings.Contains(out, "Subject: Deploy failed") || !strings.Contains(out, "body of Deploy failed") { t.Fatalf("show: %q", out) } if exact := e.ok(t, "archive", "show", "1"); exact != "Subject: Deploy failed\nFrom: Alice\nDate: 2023-11-14 22:13\n\nbody of Deploy failed\n" { t.Fatalf("show must print exactly the message, got %q", exact) } var shown map[string]any if err := json.Unmarshal([]byte(e.ok(t, "--json", "archive", "show", "1")), &shown); err != nil || shown["subject"] != "Deploy failed" { t.Fatalf("--json show must be a single JSON document: %v %v", err, shown) } e.fails(t, 1, "not found", "archive", "show", "99") out = e.ok(t, "archive", "rm", "1", "--yes") if !strings.Contains(out, "Deleted") { t.Fatalf("rm: %q", out) } e.fails(t, 2, "--yes", "archive", "rm", "2") if _, total, _ := e.s.ListMessages(l.ID, 10, 0); total != 2 { t.Fatalf("total = %d", total) } } func TestQueueListIsCapped(t *testing.T) { e := newEnv(t) var items []store.NewOutbound for i := 0; i < 105; i++ { items = append(items, store.NewOutbound{From: "b@x.org", Rcpt: fmt.Sprintf("u%d@x.com", i)}) } e.s.Enqueue([]byte("x"), items) out := e.ok(t, "queue", "ls") if !strings.Contains(out, "Pending: 105") || !strings.Contains(out, "Showing 100 of 105 deliveries") { t.Fatalf("queue ls:\n%.300s ... %s", out, out[max(0, len(out)-80):]) } } func TestURLWithTrailingSlashDoesNotProduceDoubleSlashes(t *testing.T) { e := newEnv(t) var paths []string spy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { paths = append(paths, r.URL.Path) e.srv.Config.Handler.ServeHTTP(w, r) })) defer spy.Close() vars := map[string]string{"PARSIMONY_API_TOKEN": token} if code, _, errs := e.runEnv(t, vars, "", "--url", spy.URL+"//", "list", "ls"); code != 0 { t.Fatalf("%d %s", code, errs) } if len(paths) != 1 || paths[0] != "/api/v1/lists" { t.Fatalf("request paths: %v", paths) } } func TestQueue(t *testing.T) { e := newEnv(t) if out := e.ok(t, "queue", "ls"); !strings.Contains(out, "Pending: 0") || !strings.Contains(out, "queue is empty") { t.Fatalf("empty: %q", out) } e.s.Enqueue([]byte("x"), []store.NewOutbound{{From: "b@x.org", Rcpt: "a@x.com"}, {From: "b@x.org", Rcpt: "b@x.com"}}) due, _ := e.s.DueOutbox(10) e.s.RetryOutbox(due[1].ID, time.Now().Add(time.Hour), "connection refused") out := e.ok(t, "queue", "ls") for _, want := range []string{"Pending: 2", "Retrying: 1", "ID", "RECIPIENT", "ATTEMPTS", "LAST ERROR", "a@x.com", "b@x.com", "connection refused"} { if !strings.Contains(out, want) { t.Fatalf("queue ls lacks %q:\n%s", want, out) } } if strings.Index(out, "b@x.com") > strings.Index(out, "a@x.com") { t.Fatal("failing deliveries first") } e.ok(t, "queue", "rm", fmt.Sprint(due[1].ID)) e.fails(t, 1, "not found", "queue", "rm", fmt.Sprint(due[1].ID)) if st, _ := e.s.OutboxStats(); st.Pending != 1 { t.Fatalf("pending = %d", st.Pending) } } const cliMbox = "From alice@example.com Tue Jan 2 15:04:05 2024\nFrom: Alice \nSubject: Kickoff\nMessage-ID: <1@x>\nDate: Mon, 01 Jan 2024 10:00:00 +0000\n\nlet's start\n\n" + "From bob@example.com Tue Jan 2 15:04:05 2024\nFrom: Bob \nSubject: Re: Kickoff\nMessage-ID: <2@x>\nIn-Reply-To: <1@x>\nDate: Mon, 01 Jan 2024 11:00:00 +0000\n\nagreed\n" func TestArchiveImportFromFileAndStdin(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") path := t.TempDir() + "/dev.mbox" if err := os.WriteFile(path, []byte(cliMbox), 0o600); err != nil { t.Fatal(err) } out := e.ok(t, "archive", "import", "dev@example.org", path) if !strings.Contains(out, "Imported 2 messages into dev@example.org") || strings.Contains(out, "failed") || strings.Contains(out, "already") { t.Fatalf("import: %q", out) } l, _ := e.s.FindList("dev@example.org") if _, total, _ := e.s.ListMessages(l.ID, 10, 0); total != 2 { t.Fatalf("stored %d", total) } // Again, through stdin: nothing new, and it says so. code, out, errs := e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}, cliMbox, "archive", "import", "1", "-") if code != 0 || !strings.Contains(out, "Imported 0 messages") || !strings.Contains(out, "2 already present") { t.Fatalf("second import: %d %q %q", code, out, errs) } } func TestArchiveImportReportsFailures(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") bad := cliMbox + "\nFrom x@y.z Tue Jan 2 15:04:05 2024\n\nno headers\n" code, out, errs := e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}, bad, "archive", "import", "dev@example.org", "-") if code != 1 { t.Fatalf("a failed message must give a non-zero exit status, got %d", code) } if !strings.Contains(out, "Imported 2 messages") || !strings.Contains(out, "1 failed") { t.Fatalf("summary: %q", out) } if !strings.Contains(errs, "message 3") || !strings.Contains(errs, "no headers") { t.Fatalf("the failure is reported: %q", errs) } } func TestArchiveImportErrorsAndJSON(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") e.fails(t, 1, "no such file", "archive", "import", "dev@example.org", "/nonexistent/x.mbox") e.fails(t, 1, "no such list", "archive", "import", "ghost@example.org", "/dev/null") e.fails(t, 2, "usage: parsimony archive import", "archive", "import", "dev@example.org") _, out, _ := e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}, cliMbox, "--json", "archive", "import", "dev@example.org", "-") var sum map[string]any if err := json.Unmarshal([]byte(out), &sum); err != nil || sum["imported"].(float64) != 2 { t.Fatalf("json: %v %q", err, out) } } func TestLongRunningUploadsAreNotCutByTheShortRequestTimeout(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") var cl *client c := &cmd{getenv: func(k string) string { return map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}[k] }} cl, err := c.client() if err != nil { t.Fatal(err) } if cl.http.Timeout == 0 { t.Fatal("ordinary requests need a timeout") } if cl.upload == nil || cl.upload.Timeout != 0 { t.Fatal("uploads of big archives must not have an overall timeout") } } func TestArchiveImportSaysHowManyMoreFailuresThereAre(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") var b strings.Builder for i := 0; i < 25; i++ { b.WriteString("From x@y.z Tue Jan 2 15:04:05 2024\n\nno headers\n\n") } code, out, errs := e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}, b.String(), "archive", "import", "dev@example.org", "-") if code != 1 || !strings.Contains(out, "25 failed") { t.Fatalf("%d %q", code, out) } if !strings.Contains(errs, "... and 5 more") { t.Fatalf("only 20 are listed, the rest is counted: %q", errs) } } func TestArchiveImportSendsTheFileAsAnMbox(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") var contentType, body string spy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if strings.HasSuffix(r.URL.Path, "/archive/import") { contentType = r.Header.Get("Content-Type") b, _ := io.ReadAll(r.Body) body = string(b) r.Body = io.NopCloser(strings.NewReader(body)) } e.srv.Config.Handler.ServeHTTP(w, r) })) defer spy.Close() vars := map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": spy.URL} if code, _, errs := e.runEnv(t, vars, cliMbox, "archive", "import", "dev@example.org", "-"); code != 0 { t.Fatalf("%d %s", code, errs) } if contentType != "application/mbox" || body != cliMbox { t.Fatalf("content type %q, body unchanged: %v", contentType, body == cliMbox) } } // --- dkim ---------------------------------------------------------------------- // noAuth runs a command that must not need the API token or URL. func noAuth(t *testing.T, args ...string) (int, string, string) { t.Helper() var out, errb bytes.Buffer code := Run(args, IO{In: strings.NewReader(""), Out: &out, Err: &errb}, func(string) string { return "" }) return code, out.String(), errb.String() } func TestDKIMKeygen(t *testing.T) { dir := t.TempDir() keyFile := filepath.Join(dir, "dkim.pem") code, out, errs := noAuth(t, "dkim", "keygen", "example.org", "--out", keyFile) if code != 0 { t.Fatalf("exit %d: %s", code, errs) } info, err := os.Stat(keyFile) if err != nil || info.Mode().Perm() != 0o600 { t.Fatalf("the private key must be created with mode 0600: %v %v", err, info) } key, err := dkimsign.LoadKey("example.org", "mail", keyFile) if err != nil { t.Fatal(err) } want, _ := dkimsign.Record(key.Signer.Public()) for _, s := range []string{ "mail._domainkey.example.org.", "IN TXT", "Wrote private key to " + keyFile, "dkim:", "domain: example.org", "selector: mail", "key_file: " + keyFile, want, "parsimony dkim check example.org", } { if !strings.Contains(out, s) { t.Errorf("output lacks %q:\n%s", s, out) } } // The zone-file form is split in strings of at most 255 bytes. for _, line := range strings.Split(out, "\n") { if strings.Contains(line, "IN TXT") { for _, q := range regexp.MustCompile(`"([^"]*)"`).FindAllStringSubmatch(line, -1) { if len(q[1]) > 255 { t.Fatalf("a TXT string of %d bytes exceeds the DNS limit", len(q[1])) } } } } if strings.Contains(out, "PRIVATE KEY") { t.Fatal("never print the private key") } } func TestDKIMKeygenOptions(t *testing.T) { dir := t.TempDir() keyFile := filepath.Join(dir, "k.pem") code, out, _ := noAuth(t, "dkim", "keygen", "lists.example.org", "--selector", "s2024", "--out", keyFile) if code != 0 || !strings.Contains(out, "s2024._domainkey.lists.example.org.") || !strings.Contains(out, "selector: s2024") { t.Fatalf("selector: %d %s", code, out) } first, _ := os.ReadFile(keyFile) code, _, errs := noAuth(t, "dkim", "keygen", "lists.example.org", "--out", keyFile) if code != 1 || !strings.Contains(errs, "already exists") { t.Fatalf("an existing key must not be overwritten: %d %q", code, errs) } if again, _ := os.ReadFile(keyFile); !bytes.Equal(first, again) { t.Fatal("the existing key was modified") } if code, _, errs := noAuth(t, "dkim", "keygen", "lists.example.org", "--out", keyFile, "--force"); code != 0 { t.Fatalf("--force: %d %s", code, errs) } if replaced, _ := os.ReadFile(keyFile); bytes.Equal(first, replaced) { t.Fatal("--force must replace the key") } if info, _ := os.Stat(keyFile); info.Mode().Perm() != 0o600 { t.Fatalf("mode after --force: %v", info.Mode().Perm()) } } func TestDKIMKeygenDefaultFileName(t *testing.T) { dir := t.TempDir() old, _ := os.Getwd() os.Chdir(dir) defer os.Chdir(old) if code, _, errs := noAuth(t, "dkim", "keygen", "example.org"); code != 0 { t.Fatalf("%d %s", code, errs) } if _, err := os.Stat(filepath.Join(dir, "dkim-example.org.pem")); err != nil { t.Fatalf("default file name: %v", err) } } func TestDKIMUsageErrors(t *testing.T) { for name, args := range map[string][]string{ "no domain": {"dkim", "keygen"}, "domain with @": {"dkim", "keygen", "a@example.org"}, "domain with space": {"dkim", "keygen", "my domain.org"}, "no dot": {"dkim", "keygen", "localhost"}, "bad selector": {"dkim", "keygen", "example.org", "--selector", "my sel"}, "bits not a number": {"dkim", "keygen", "example.org", "--bits", "abc"}, "record no key": {"dkim", "record", "example.org"}, "check no key": {"dkim", "check", "example.org"}, "unknown": {"dkim", "frobnicate"}, } { if code, _, errs := noAuth(t, args...); code != 2 { t.Errorf("%s: exit %d, want 2 (%q)", name, code, errs) } } if code, _, errs := noAuth(t, "dkim", "keygen", "example.org", "--bits", "512", "--out", filepath.Join(t.TempDir(), "k")); code != 1 || !strings.Contains(errs, "1024") { t.Fatalf("a tiny key is refused: %d %q", code, errs) } } func writeKey(t *testing.T) (string, string) { t.Helper() dir := t.TempDir() keyFile := filepath.Join(dir, "k.pem") if code, _, errs := noAuth(t, "dkim", "keygen", "example.org", "--out", keyFile); code != 0 { t.Fatalf("%d %s", code, errs) } key, _ := dkimsign.LoadKey("example.org", "mail", keyFile) rec, _ := dkimsign.Record(key.Signer.Public()) return keyFile, rec } func TestDKIMRecord(t *testing.T) { keyFile, rec := writeKey(t) code, out, errs := noAuth(t, "dkim", "record", "example.org", "--key", keyFile) if code != 0 || !strings.Contains(out, "mail._domainkey.example.org.") || !strings.Contains(out, rec) { t.Fatalf("record: %d %q %q", code, out, errs) } _, out, _ = noAuth(t, "dkim", "record", "example.org", "--key", keyFile, "--selector", "x1") if !strings.Contains(out, "x1._domainkey.example.org.") { t.Fatalf("selector: %q", out) } if code, _, errs := noAuth(t, "dkim", "record", "example.org", "--key", "/nonexistent.pem"); code != 1 || errs == "" { t.Fatalf("missing key: %d %q", code, errs) } } func withDNS(t *testing.T, records map[string][]string) *[]string { t.Helper() var asked []string old := lookupTXT lookupTXT = func(name string) ([]string, error) { asked = append(asked, name) if r, ok := records[name]; ok { return r, nil } return nil, errors.New("no such host") } t.Cleanup(func() { lookupTXT = old }) return &asked } func TestDKIMCheck(t *testing.T) { keyFile, rec := writeKey(t) asked := withDNS(t, map[string][]string{"mail._domainkey.example.org": {"v=spf1 -all", rec}}) code, out, errs := noAuth(t, "dkim", "check", "example.org", "--key", keyFile) if code != 0 || !strings.Contains(out, "OK") || len(*asked) != 1 || (*asked)[0] != "mail._domainkey.example.org" { t.Fatalf("matching record: %d %q %q asked=%v", code, out, errs, *asked) } withDNS(t, map[string][]string{"mail._domainkey.example.org": {"v=DKIM1; k=rsa; p=AAAAAAAA"}}) code, _, errs = noAuth(t, "dkim", "check", "example.org", "--key", keyFile) if code != 1 || !strings.Contains(errs, "different key") { t.Fatalf("mismatch: %d %q", code, errs) } withDNS(t, map[string][]string{}) code, _, errs = noAuth(t, "dkim", "check", "example.org", "--key", keyFile) if code != 1 || !strings.Contains(errs, "no DKIM record") || !strings.Contains(errs, "mail._domainkey.example.org") { t.Fatalf("missing: %d %q", code, errs) } withDNS(t, map[string][]string{"mail._domainkey.example.org": {"v=spf1 -all"}}) if code, _, errs = noAuth(t, "dkim", "check", "example.org", "--key", keyFile); code != 1 || !strings.Contains(errs, "no DKIM record") { t.Fatalf("only unrelated TXT records: %d %q", code, errs) } asked = withDNS(t, map[string][]string{"s9._domainkey.example.org": {rec}}) if code, _, errs = noAuth(t, "dkim", "check", "example.org", "--key", keyFile, "--selector", "s9"); code != 0 { t.Fatalf("selector: %d %q asked=%v", code, errs, *asked) } if code, _, errs = noAuth(t, "dkim", "check", "example.org", "--key", "/nonexistent.pem"); code != 1 { t.Fatalf("missing key file: %d %q", code, errs) } } func TestDKIMCheckEd25519Key(t *testing.T) { pub, priv, _ := ed25519.GenerateKey(rand.Reader) der, _ := x509.MarshalPKCS8PrivateKey(priv) keyFile := filepath.Join(t.TempDir(), "ed.pem") os.WriteFile(keyFile, pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: der}), 0o600) rec, _ := dkimsign.Record(pub) withDNS(t, map[string][]string{"mail._domainkey.example.org": {rec}}) if code, out, errs := noAuth(t, "dkim", "check", "example.org", "--key", keyFile); code != 0 || !strings.Contains(out, "OK") { t.Fatalf("%d %q %q", code, out, errs) } } func TestDKIMDomainIsLowercased(t *testing.T) { keyFile := filepath.Join(t.TempDir(), "k.pem") code, out, errs := noAuth(t, "dkim", "keygen", "Lists.Example.ORG", "--out", keyFile) if code != 0 { t.Fatalf("%d %s", code, errs) } if !strings.Contains(out, "mail._domainkey.lists.example.org.") || !strings.Contains(out, "domain: lists.example.org") { t.Fatalf("DNS names and the config use lowercase:\n%s", out) } asked := withDNS(t, map[string][]string{}) noAuth(t, "dkim", "check", "Lists.Example.ORG", "--key", keyFile) if len(*asked) != 1 || (*asked)[0] != "mail._domainkey.lists.example.org" { t.Fatalf("lookup name: %v", *asked) } } func TestQueueShowsFailedDeliveries(t *testing.T) { e := newEnv(t) e.s.Enqueue([]byte("x"), []store.NewOutbound{{From: "b@x.org", Rcpt: "waits@x.com"}, {From: "b@x.org", Rcpt: "retries@x.com"}, {From: "b@x.org", Rcpt: "lost@x.com"}}) due, _ := e.s.DueOutbox(10) e.s.RetryOutbox(due[1].ID, time.Now().Add(time.Hour), "connection refused") e.s.FailOutbox(due[2].ID, "refused by the relay: 554 policy rejection") out := e.ok(t, "queue", "ls") for _, want := range []string{"Pending: 2", "Retrying: 1", "Failed: 1", "STATE", "failed", "retrying", "waiting", "refused by the relay: 554 policy rejection"} { if !strings.Contains(out, want) { t.Fatalf("queue ls lacks %q:\n%s", want, out) } } if strings.Index(out, "lost@x.com") > strings.Index(out, "retries@x.com") || strings.Index(out, "retries@x.com") > strings.Index(out, "waits@x.com") { t.Fatalf("failed first, then retrying, then waiting:\n%s", out) } e.ok(t, "queue", "rm", fmt.Sprint(due[2].ID)) if out := e.ok(t, "queue", "ls"); strings.Contains(out, "lost@x.com") || !strings.Contains(out, "Failed: 0") { t.Fatalf("a failed delivery can be cleared:\n%s", out) } } func TestHeldListingWarnsWhenTheHeaderDiffersFromTheSender(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") l, _ := e.s.FindList("dev@example.org") e.s.HoldMessage(l.ID, "bob@x.com", []byte("From: Bob \r\nSubject: honest\r\n\r\nb"), "r") e.s.HoldMessage(l.ID, "bob@x.com", []byte("From: Eve \r\nSubject: passing as eve\r\n\r\nb"), "r") e.s.HoldMessage(l.ID, "bob@x.com", []byte("Subject: no from\r\n\r\nb"), "r") out := e.ok(t, "held", "ls", "dev@example.org") lines := map[string]string{} for _, l := range strings.Split(out, "\n") { for _, key := range []string{"honest", "passing as eve", "no from"} { if strings.Contains(l, key) { lines[key] = l } } } if strings.Contains(lines["honest"], "differs") { t.Fatalf("a matching header is not flagged: %q", lines["honest"]) } if !strings.Contains(lines["passing as eve"], "Eve ") || !strings.Contains(lines["passing as eve"], "differs") { t.Fatalf("the author readers will see is shown and flagged: %q", lines["passing as eve"]) } if !strings.Contains(lines["no from"], "differs") { t.Fatalf("no usable From is flagged too: %q", lines["no from"]) } } const esc = "\x1b[31mRED\x1b]0;pwned\x07" // noControl fails when s still holds a control character other than tab and newline. func noControl(t *testing.T, what, s string) { t.Helper() for _, r := range s { if (r < 0x20 && r != '\t' && r != '\n') || (r >= 0x7f && r <= 0x9f) { t.Fatalf("%s prints control character %U:\n%q", what, r, s) } } } func TestPrintableStripsControlCharactersButKeepsTabAndNewline(t *testing.T) { for in, want := range map[string]string{ "plain text, accents: àèì 日本": "plain text, accents: àèì 日本", "a\tb\nc": "a\tb\nc", "a\r\nb": "a\nb", "\x1b[31mred\x1b[0m": `\x1b[31mred\x1b[0m`, "us\x1f": `us\x1f`, "bell\x07 nul\x00 del\x7f": `bell\x07 nul\x00 del\x7f`, "c1 \u009b31m and \u0085": `c1 \u009b31m and \u0085`, "c1 edges \u0080 \u009f, kept: ~ \u00a0 \u00a1": `c1 edges \u0080 \u009f, kept: ~ ` + "\u00a0 \u00a1", "lone\rcarriage": `lone\x0dcarriage`, "": "", } { if got := printable(in); got != want { t.Errorf("printable(%q) = %q, want %q", in, got, want) } } } func TestControlCharactersFromMailNeverReachTheTerminal(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") l, _ := e.s.FindList("dev@example.org") e.s.ArchiveMessage(l.ID, store.Message{MessageID: "", Subject: "subj " + esc, Sender: "from " + esc, Date: time.Unix(1_700_000_000, 0), Body: "line one\r\nbody " + esc + "\r\nlast"}) e.s.HoldMessage(l.ID, "bob@x.com", []byte("From: Bob "+esc+" \r\nSubject: held "+esc+"\r\n\r\nb"), "reason "+esc) e.s.Enqueue([]byte("x"), []store.NewOutbound{{From: "b@x.org", Rcpt: "lost@x.com"}}) due, _ := e.s.DueOutbox(10) e.s.FailOutbox(due[0].ID, "refused: 554 "+esc) for _, args := range [][]string{ {"archive", "ls", "dev@example.org"}, {"archive", "ls", "dev@example.org", "--q", "subj"}, {"archive", "show", "1"}, {"held", "ls", "dev@example.org"}, {"queue", "ls"}, } { out := e.ok(t, args...) noControl(t, strings.Join(args, " "), out) if !strings.Contains(out, `\x1b[31mRED`) { t.Errorf("%v: the escape sequence should stay visible as text:\n%s", args, out) } } if out := e.ok(t, "archive", "show", "1"); !strings.Contains(out, "\nbody ") || strings.Contains(out, `\x0d`) { t.Errorf("CRLF line ends are not control noise: %q", out) } } func TestControlCharactersInListAndMemberNamesAreEscaped(t *testing.T) { e := newEnv(t) addr := "a\x1b[31mb\x07@x.org" l, err := e.s.CreateList("a\x1b[31mb\x07", "x.org", "title "+esc) if err != nil { t.Fatal(err) } e.s.AddMember(l.ID, "m\x1b[2Jm@x.org", "name "+esc) mbox := "From a@x.com Tue Jan 2 15:04:05 2024\nSubject: s\n\nbody\n" for _, c := range []struct { stdin string args []string }{ {"", []string{"list", "ls"}}, {"", []string{"list", "show", addr}}, {"", []string{"list", "set", addr, "--title", "t"}}, {"", []string{"member", "ls", addr}}, {"", []string{"member", "ls", addr, "--emails"}}, {"", []string{"member", "add", addr, "new@x.com"}}, {"new2@x.com\n", []string{"member", "import", addr, "-"}}, {mbox, []string{"archive", "import", addr, "-"}}, {"", []string{"member", "rm", addr, "new@x.com"}}, {"", []string{"list", "rm", addr, "--yes"}}, } { code, out, errs := e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}, c.stdin, c.args...) if code != 0 { t.Fatalf("%v: exit %d %s", c.args, code, errs) } noControl(t, strings.Join(c.args, " "), out+errs) } } func TestControlCharactersInImportReportsAreEscaped(t *testing.T) { e := newEnv(t) e.ok(t, "list", "add", "dev@example.org") code, out, errs := e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": e.srv.URL}, "bad"+esc+"@x\n", "member", "import", "dev@example.org", "-") if code != 1 || !strings.Contains(errs, `line 1: bad\x1b[31mRED`) { t.Fatalf("member import: %d %q", code, errs) } noControl(t, "member import", out+errs) fake := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if r.Method == "POST" { b, _ := json.Marshal(map[string]any{"imported": 0, "failed": 1, "errors": []string{"message 1: " + esc}}) w.Write(b) return } w.Write([]byte(`[{"id":1,"address":"dev@example.org"}]`)) })) defer fake.Close() var o, eb bytes.Buffer vars := map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": fake.URL} Run([]string{"archive", "import", "dev@example.org", "-"}, IO{In: strings.NewReader("x"), Out: &o, Err: &eb}, func(k string) string { return vars[k] }) if !strings.Contains(eb.String(), `message 1: \x1b[31mRED`) { t.Fatalf("archive import errors: %q", eb.String()) } noControl(t, "archive import", o.String()+eb.String()) } func TestControlCharactersInAPIErrorsAndImportReportsAreEscaped(t *testing.T) { api := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusBadGateway) msg, _ := json.Marshal(map[string]string{"error": "relay said " + esc}) w.Write(msg) })) defer api.Close() var out, errb bytes.Buffer vars := map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": api.URL} code := Run([]string{"list", "ls"}, IO{In: strings.NewReader(""), Out: &out, Err: &errb}, func(k string) string { return vars[k] }) if code != 1 || !strings.Contains(errb.String(), `relay said \x1b[31mRED`) { t.Fatalf("exit %d: %q", code, errb.String()) } noControl(t, "error text", errb.String()) } func TestTokenIsNotSentOverPlainHTTPToARemoteHost(t *testing.T) { e := newEnv(t) run := func(url string, extra ...string) (int, string) { args := append(append([]string{"--url", url}, extra...), "list", "ls") code, out, errs := e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token}, "", args...) if out != "" { t.Fatalf("stdout %q", out) } return code, errs } code, errs := run("http://lists.example.org:8080") if code != 2 || !strings.Contains(errs, "--insecure") || !strings.Contains(errs, "http") { t.Fatalf("remote http must be refused with a usage error: %d %q", code, errs) } if code, errs = run("HTTP://10.1.2.3"); code != 2 { t.Fatalf("scheme case must not matter: %d %q", code, errs) } // Past the check the only thing left to fail is the connection (port 1 is closed, .invalid never resolves). for _, u := range []string{"http://localhost:1", "http://LocalHost.:1", "http://127.0.0.1:1", "http://[::1]:1", "https://nowhere.invalid"} { if code, errs = run(u); code != 1 || !strings.Contains(errs, "cannot reach") { t.Errorf("%s must be allowed: %d %q", u, code, errs) } } if code, errs = run("http://nowhere.invalid", "--insecure"); code != 1 || !strings.Contains(errs, "cannot reach") { t.Fatalf("--insecure allows plain http: %d %q", code, errs) } // The environment variable is checked like the flag. code, _, errs = e.runEnv(t, map[string]string{"PARSIMONY_API_TOKEN": token, "PARSIMONY_URL": "http://lists.example.org"}, "", "list", "ls") if code != 2 { t.Fatalf("PARSIMONY_URL: %d %q", code, errs) } // No token to protect, no URL check: offline commands never build the client. _, _, errs = e.runEnv(t, nil, "", "--url", "http://lists.example.org", "dkim", "record", "example.org", "--key", filepath.Join(t.TempDir(), "none")) if strings.Contains(errs, "--insecure") { t.Fatalf("offline commands must not care about the URL") } }