aboutsummaryrefslogtreecommitdiffstats
path: root/tests/test_mailsync.cpp
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-08-29 11:25:02 +0200
committerDanilo M. <danix@danix.xyz>2026-08-29 11:25:02 +0200
commit3fd999907ae8344f76ee4e5be1ac278a26f452ca (patch)
tree17c01d44daee0147ecaca6cccd393471e6379cf1 /tests/test_mailsync.cpp
parent8c78dd139a77e896c72b7fc8b799af3c0df34344 (diff)
downloadqtmaildir-3fd999907ae8344f76ee4e5be1ac278a26f452ca.tar.gz
qtmaildir-3fd999907ae8344f76ee4e5be1ac278a26f452ca.zip
feat: have the sync script report what it did
Item 174, and half of item 125. The premise was corrected before any code. The note asks for an external `notmuch new` to clear the pending count; it must not. That count means tag mutations not yet known to have reached the MAIL STORE, which is the server: an edit is in notmuch the moment it is made, and what is outstanding is mbsync pushing the renamed Maildir files. `notmuch new` re-indexes local files and pushes nothing, so clearing on it would tell the user their work was safe to quit on while it was still local. The entry's own proposal to watch notmuch_database_get_revision() was rejected for the same reason: a revision moves when mail ARRIVES too, and in neither case does it say anything about the server. What was actually wrong was the reporting channel. The application inferred a finished run from an inode in /proc/locks and from grepping the log for its RUN END banner, which made a human-readable line into wire format and could not say WHICH channels a run carried. The local sync path has always narrowed its clear to the accounts it carried; the external path could not, and cleared everything, so an edit to an account a run never touched was reported as delivered. So the script reports instead of leaving evidence to be inferred. It writes ~/.local/state/qtmaildir/syncstatus.json atomically at the end of every run, including a skip, naming the channels, both exit statuses and a state of ok, failed or skipped. MailSync::readStatus() reads it, MainWindow prefers it over the log banner and narrows the clear through Account::syncChannel(). A skipped run clears nothing, which is item 125's first half: the application can now see that a run happened and carried nothing. The log banner and lastRunOutcome() stay as the fallback for a missing file, which is what a first run after upgrading looks like. This is the user's own framing of the scope: the script was written for another system and adapted, and is now qtmaildir's only consumer, so it serves the application rather than the reverse. Two facts made it safe to act on: their crontab runs mailsync.sh and nothing else touches mail, and ~/bin/mailsync.sh is a symlink into this repo, so an edit is live on the next tick. Two bugs found while wiring it in, both recorded in the closed item. A test read the developer's real sync state, twice: a [sync] section naming only `log` leaves syncStatus() defaulting to the real file, so two tests asserting that a FAILED run leaves the count alone read the last real cron run, found ok, and cleared. Pinning only `status` has the mirror problem. noSyncTestReadsTheRealSyncState() is the guard, modelled on noTestCanSeeTheRealLockTable(). And Qt::ISODate carries no milliseconds. The status file is preferred only when it describes THIS run, compared against when the lock appeared, so a stale success cannot outrank a fresh failure; but the script writes date -Iseconds, and a round trip of "now" comes back 329 ms behind, measured. A fast sync's own file therefore parsed as stale and fell back to the log, with nothing failing to say so. One second of slack matches the precision the format carries. Design: docs/superpowers/specs/2026-08-29-sync-status-file-design.md Suite: 43 of 44, with undoMovesTheMessageBack failing as it does on master (item 136).
Diffstat (limited to 'tests/test_mailsync.cpp')
-rw-r--r--tests/test_mailsync.cpp190
1 files changed, 190 insertions, 0 deletions
diff --git a/tests/test_mailsync.cpp b/tests/test_mailsync.cpp
index 45c7767..eb4990e 100644
--- a/tests/test_mailsync.cpp
+++ b/tests/test_mailsync.cpp
@@ -65,6 +65,16 @@ private slots:
void lastRunOutcomeReadsATailOfAHugeLog();
void lastRunOutcomeReadsABannerTheScriptActuallyWrote();
+ void readStatusReadsAnOkRun();
+ void readStatusReadsTheChannelsARunCarried();
+ void readStatusReadsAFullRunAsEveryAccount();
+ void readStatusReadsASkippedRun();
+ void readStatusOnAMissingFileIsUnknown();
+ void readStatusOnRubbishIsUnknown();
+ void readStatusOnATruncatedFileIsUnknown();
+ void readStatusOnAnUnknownVersionIsUnknown();
+ void readStatusReadsAFileTheScriptActuallyWrote();
+
private:
/// Writes an executable shell script into the temp dir, returns its path.
QString makeScript(const QString &name, const QString &body);
@@ -466,6 +476,186 @@ void TestMailSync::aChannelNameIsNotLetInVerbatim()
// script writes into its log. These tests pin the parser against the exact
// shape assets/mailsync.sh emits.
+// Item 174. The status file is what the application READS, as against the log,
+// which is for a human. These pin the reader against the exact shape
+// assets/mailsync.sh writes; assets/test_mailsync.py pins the writer against
+// the same shape from the other side, and the two agree by test rather than by
+// shared code, exactly as the two rules.json readers do.
+
+static QString writeStatus(const QDir &dir, const QString &name,
+ const QByteArray &contents)
+{
+ const QString path = dir.filePath(name);
+ QFile file(path);
+ if (!file.open(QIODevice::WriteOnly))
+ return QString();
+ file.write(contents);
+ file.close();
+ return path;
+}
+
+void TestMailSync::readStatusReadsAnOkRun()
+{
+ const QString path = writeStatus(
+ QDir(m_dir.path()), QStringLiteral("ok.json"),
+ R"({"version": 1, "run_id": "2026-08-29T10:00:00+02:00",
+ "started": "2026-08-29T10:00:00+02:00",
+ "ended": "2026-08-29T10:00:12+02:00",
+ "state": "ok", "channels": ["-a"],
+ "mbsync_status": 0, "notmuch_status": 0})");
+ QVERIFY(!path.isEmpty());
+
+ const SyncStatus status = MailSync::readStatus(path);
+ QCOMPARE(status.state, SyncState::Ok);
+ QVERIFY(status.ended.isValid());
+}
+
+void TestMailSync::readStatusReadsTheChannelsARunCarried()
+{
+ // The whole reason this file exists rather than the log's banner: the
+ // application clears its pending count for the accounts a run carried, and
+ // the log could never say which those were.
+ const QString path = writeStatus(
+ QDir(m_dir.path()), QStringLiteral("channels.json"),
+ R"({"version": 1, "run_id": "r", "started": "2026-08-29T10:00:00+02:00",
+ "ended": "2026-08-29T10:00:12+02:00", "state": "ok",
+ "channels": ["work", "personal"],
+ "mbsync_status": 0, "notmuch_status": 0})");
+ QVERIFY(!path.isEmpty());
+
+ const SyncStatus status = MailSync::readStatus(path);
+ QCOMPARE(status.state, SyncState::Ok);
+ QCOMPARE(status.channels,
+ (QStringList{ QStringLiteral("work"), QStringLiteral("personal") }));
+ QVERIFY(!status.everyChannel);
+}
+
+void TestMailSync::readStatusReadsAFullRunAsEveryAccount()
+{
+ // "-a" is not a channel name and must not be matched against one: a full
+ // run carries every account, so a reader treating it as an unknown channel
+ // would clear nothing on exactly the run that carried everything.
+ const QString path = writeStatus(
+ QDir(m_dir.path()), QStringLiteral("full.json"),
+ R"({"version": 1, "run_id": "r", "started": "2026-08-29T10:00:00+02:00",
+ "ended": "2026-08-29T10:00:12+02:00", "state": "ok",
+ "channels": ["-a"], "mbsync_status": 0, "notmuch_status": 0})");
+ QVERIFY(!path.isEmpty());
+
+ const SyncStatus status = MailSync::readStatus(path);
+ QVERIFY2(status.everyChannel, "a -a run was not read as every account");
+}
+
+void TestMailSync::readStatusReadsASkippedRun()
+{
+ // Item 125. A skipped run releases a lock it never took, so the spinner had
+ // nothing to clear on. It is a terminal state, and distinct from a failure:
+ // the other run is doing the work.
+ const QString path = writeStatus(
+ QDir(m_dir.path()), QStringLiteral("skip.json"),
+ R"({"version": 1, "run_id": "r", "started": "2026-08-29T10:00:00+02:00",
+ "ended": "2026-08-29T10:00:00+02:00", "state": "skipped",
+ "channels": ["-a"], "mbsync_status": -1, "notmuch_status": -1})");
+ QVERIFY(!path.isEmpty());
+
+ const SyncStatus status = MailSync::readStatus(path);
+ QCOMPARE(status.state, SyncState::Skipped);
+}
+
+void TestMailSync::readStatusOnAMissingFileIsUnknown()
+{
+ QCOMPARE(MailSync::readStatus(m_dir.filePath(QStringLiteral("nope.json"))).state,
+ SyncState::Unknown);
+ QCOMPARE(MailSync::readStatus(QString()).state, SyncState::Unknown);
+}
+
+void TestMailSync::readStatusOnRubbishIsUnknown()
+{
+ const QString path = writeStatus(QDir(m_dir.path()),
+ QStringLiteral("rubbish.json"),
+ "this is not json at all\n");
+ QVERIFY(!path.isEmpty());
+ QCOMPARE(MailSync::readStatus(path).state, SyncState::Unknown);
+}
+
+void TestMailSync::readStatusOnATruncatedFileIsUnknown()
+{
+ // The script writes atomically through a temp file and mv precisely so this
+ // cannot happen, but a reader that trusts that is one filesystem away from
+ // being wrong. Unknown changes no state, so a torn read is harmless.
+ const QString path = writeStatus(QDir(m_dir.path()),
+ QStringLiteral("torn.json"),
+ R"({"version": 1, "state": "o)");
+ QVERIFY(!path.isEmpty());
+ QCOMPARE(MailSync::readStatus(path).state, SyncState::Unknown);
+}
+
+void TestMailSync::readStatusOnAnUnknownVersionIsUnknown()
+{
+ // Refused rather than guessed at, the rule the rules file already follows:
+ // a future version may mean something different by the same field names,
+ // and acting on it would be worse than observing nothing.
+ const QString path = writeStatus(
+ QDir(m_dir.path()), QStringLiteral("future.json"),
+ R"({"version": 99, "run_id": "r", "started": "2026-08-29T10:00:00+02:00",
+ "ended": "2026-08-29T10:00:12+02:00", "state": "ok",
+ "channels": ["-a"], "mbsync_status": 0, "notmuch_status": 0})");
+ QVERIFY(!path.isEmpty());
+ QCOMPARE(MailSync::readStatus(path).state, SyncState::Unknown);
+}
+
+void TestMailSync::readStatusReadsAFileTheScriptActuallyWrote()
+{
+ // The guard against the two sides drifting apart. Every test above writes
+ // what this file BELIEVES the script emits; this one runs the real script
+ // with stubbed binaries and reads what it actually wrote.
+ //
+ // Skipped rather than failed where bash or the script is unavailable: a
+ // packaging build has no reason to carry either, and a test that cannot run
+ // has observed nothing.
+ const QString script = QStringLiteral(SOURCE_DIR "/assets/mailsync.sh");
+ if (!QFile::exists(script))
+ QSKIP("assets/mailsync.sh not found");
+
+ QTemporaryDir home;
+ QVERIFY(home.isValid());
+
+ // Stubs, so nothing reaches the network and the real lock is never taken.
+ const QString bin = home.filePath(QStringLiteral("bin"));
+ QVERIFY(QDir().mkpath(bin));
+ for (const QString &name : { QStringLiteral("mbsync"),
+ QStringLiteral("notmuch") }) {
+ QFile stub(bin + QLatin1Char('/') + name);
+ QVERIFY(stub.open(QIODevice::WriteOnly | QIODevice::Text));
+ stub.write("#!/bin/bash\nexit 0\n");
+ stub.close();
+ QVERIFY(stub.setPermissions(QFile::ReadOwner | QFile::WriteOwner
+ | QFile::ExeOwner));
+ }
+
+ QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
+ env.insert(QStringLiteral("HOME"), home.path());
+ env.insert(QStringLiteral("PATH"),
+ bin + QLatin1Char(':') + env.value(QStringLiteral("PATH")));
+ // Never /tmp/mbsync.lock: that is the mutex the user's cron sync uses, and
+ // a test that took it would block their mail.
+ env.insert(QStringLiteral("MAILSYNC_LOCKFILE"),
+ home.filePath(QStringLiteral("lock")));
+
+ QProcess proc;
+ proc.setProcessEnvironment(env);
+ proc.start(QStringLiteral("bash"), { script, QStringLiteral("work") });
+ if (!proc.waitForStarted(5000))
+ QSKIP("bash not available");
+ QVERIFY(proc.waitForFinished(30000));
+
+ const SyncStatus status = MailSync::readStatus(
+ home.filePath(QStringLiteral(".local/state/qtmaildir/syncstatus.json")));
+ QCOMPARE(status.state, SyncState::Ok);
+ QCOMPARE(status.channels, QStringList{ QStringLiteral("work") });
+ QVERIFY(!status.everyChannel);
+}
+
void TestMailSync::lastRunOutcomeReadsAnOkRun()
{
const QString path = m_dir.filePath(QStringLiteral("ok.log"));