add basic tests for the ctl subcommands, and fix two small bugs

this doesn't really test the output of the ctl commands, just that they succeed without error. better than nothing... testing found two small bugs, that are not an issue in practice: 1. we were ack'ing streamed data from the other side of the ctl connection before having read it. when there is no buffer space on the connection (always the case for net.Pipe) that would cause a deadlock. only actually happened during the new tests. 2. the generated dkim keys are relatively to the directory of the dynamic config file. mox looked it up relative to the directory of the _static_ config file at startup. this directory is typicaly the same. users would have noticed if they had triggered this.
2025-07-10 07:14:40 +03:00 · 2023-07-02 13:53:34 +02:00
parent 1469b7293e
commit 03c3f56a59
11 changed files with 321 additions and 107 deletions
--- a/ctl_test.go
+++ b/ctl_test.go
@ -0,0 +1,180 @@
+//go:build !quickstart && !integration
+
+package main
+
+import (
+	"context"
+	"flag"
+	"net"
+	"os"
+	"testing"
+
+	"github.com/mjl-/mox/dmarcdb"
+	"github.com/mjl-/mox/dns"
+	"github.com/mjl-/mox/mlog"
+	"github.com/mjl-/mox/mox-"
+	"github.com/mjl-/mox/mtastsdb"
+	"github.com/mjl-/mox/queue"
+	"github.com/mjl-/mox/store"
+	"github.com/mjl-/mox/tlsrptdb"
+)
+
+var ctxbg = context.Background()
+
+func tcheck(t *testing.T, err error, errmsg string) {
+	if err != nil {
+		t.Helper()
+		t.Fatalf("%s: %v", errmsg, err)
+	}
+}
+
+// TestCtl executes commands through ctl. This tests at least the protocols (who
+// sends when/what) is tested. We often don't check the actual results, but
+// unhandled errors would cause a panic.
+func TestCtl(t *testing.T) {
+	os.RemoveAll("testdata/ctl/data")
+	mox.ConfigStaticPath = "testdata/ctl/mox.conf"
+	mox.ConfigDynamicPath = "testdata/ctl/domains.conf"
+	if errs := mox.LoadConfig(ctxbg, true, false); len(errs) > 0 {
+		t.Fatalf("loading mox config: %v", errs)
+	}
+	switchDone := store.Switchboard()
+	defer close(switchDone)
+
+	xlog := mlog.New("ctl")
+
+	testctl := func(fn func(clientctl *ctl)) {
+		t.Helper()
+
+		cconn, sconn := net.Pipe()
+		clientctl := ctl{conn: cconn, log: xlog}
+		serverctl := ctl{conn: sconn, log: xlog}
+		go servectlcmd(ctxbg, &serverctl, func() {})
+		fn(&clientctl)
+		cconn.Close()
+		sconn.Close()
+	}
+
+	// "deliver"
+	testctl(func(ctl *ctl) {
+		ctlcmdDeliver(ctl, "mjl@mox.example")
+	})
+
+	// "setaccountpassword"
+	testctl(func(ctl *ctl) {
+		ctlcmdSetaccountpassword(ctl, "mjl@mox.example", "test4321")
+	})
+
+	err := queue.Init()
+	tcheck(t, err, "queue init")
+
+	// "queue"
+	testctl(func(ctl *ctl) {
+		ctlcmdQueueList(ctl)
+	})
+
+	// "queuekick"
+	testctl(func(ctl *ctl) {
+		ctlcmdQueueKick(ctl, 0, "", "", "")
+	})
+
+	// "queuedrop"
+	testctl(func(ctl *ctl) {
+		ctlcmdQueueDrop(ctl, 0, "", "")
+	})
+
+	// no "queuedump", we don't have a message to dump, and the commands exits without a message.
+
+	// "importmbox"
+	testctl(func(ctl *ctl) {
+		ctlcmdImport(ctl, true, "mjl", "inbox", "testdata/importtest.mbox")
+	})
+
+	// "importmaildir"
+	testctl(func(ctl *ctl) {
+		ctlcmdImport(ctl, false, "mjl", "inbox", "testdata/importtest.maildir")
+	})
+
+	// "domainadd"
+	testctl(func(ctl *ctl) {
+		ctlcmdConfigDomainAdd(ctl, dns.Domain{ASCII: "mox2.example"}, "mjl", "")
+	})
+
+	// "accountadd"
+	testctl(func(ctl *ctl) {
+		ctlcmdConfigAccountAdd(ctl, "mjl2", "mjl2@mox2.example")
+	})
+
+	// "addressadd"
+	testctl(func(ctl *ctl) {
+		ctlcmdConfigAddressAdd(ctl, "mjl3@mox2.example", "mjl2")
+	})
+
+	// Add a message.
+	testctl(func(ctl *ctl) {
+		ctlcmdDeliver(ctl, "mjl3@mox2.example")
+	})
+	// "retrain", retrain junk filter.
+	testctl(func(ctl *ctl) {
+		ctlcmdRetrain(ctl, "mjl2")
+	})
+
+	// "addressrm"
+	testctl(func(ctl *ctl) {
+		ctlcmdConfigAddressRemove(ctl, "mjl3@mox2.example")
+	})
+
+	// "accountrm"
+	testctl(func(ctl *ctl) {
+		ctlcmdConfigAccountRemove(ctl, "mjl2")
+	})
+
+	// "domainrm"
+	testctl(func(ctl *ctl) {
+		ctlcmdConfigDomainRemove(ctl, dns.Domain{ASCII: "mox2.example"})
+	})
+
+	// "loglevels"
+	testctl(func(ctl *ctl) {
+		ctlcmdLoglevels(ctl)
+	})
+
+	// "setloglevels"
+	testctl(func(ctl *ctl) {
+		ctlcmdSetLoglevels(ctl, "", "debug")
+	})
+	testctl(func(ctl *ctl) {
+		ctlcmdSetLoglevels(ctl, "smtpserver", "debug")
+	})
+
+	// Export data, import it again
+	xcmdExport(true, []string{"testdata/ctl/data/tmp/export/mbox/", "testdata/ctl/data/accounts/mjl"}, nil)
+	xcmdExport(false, []string{"testdata/ctl/data/tmp/export/maildir/", "testdata/ctl/data/accounts/mjl"}, nil)
+	testctl(func(ctl *ctl) {
+		ctlcmdImport(ctl, true, "mjl", "inbox", "testdata/ctl/data/tmp/export/mbox/Inbox.mbox")
+	})
+	testctl(func(ctl *ctl) {
+		ctlcmdImport(ctl, false, "mjl", "inbox", "testdata/ctl/data/tmp/export/maildir/Inbox")
+	})
+
+	// "backup", backup account.
+	err = dmarcdb.Init()
+	tcheck(t, err, "dmarcdb init")
+	err = mtastsdb.Init(false)
+	tcheck(t, err, "mtastsdb init")
+	err = tlsrptdb.Init()
+	tcheck(t, err, "tlsrptdb init")
+	testctl(func(ctl *ctl) {
+		os.RemoveAll("testdata/ctl/data/tmp/backup-data")
+		err := os.WriteFile("testdata/ctl/data/receivedid.key", make([]byte, 16), 0600)
+		tcheck(t, err, "writing receivedid.key")
+		ctlcmdBackup(ctl, "testdata/ctl/data/tmp/backup-data", false)
+	})
+
+	// Verify the backup.
+	xcmd := cmd{
+		flag:     flag.NewFlagSet("", flag.ExitOnError),
+		flagArgs: []string{"testdata/ctl/data/tmp/backup-data"},
+	}
+	cmdVerifydata(&xcmd)
+}