From f8d27de2e0fc6517fd862a839c3fb99cb2c4b885 Mon Sep 17 00:00:00 2001
From: "Jeffrey C. Ollie" <jeff@ocjtech.us>
Date: Sat, 29 Aug 2026 22:43:07 -0500
Subject: [PATCH] add doctests for configGet and queryCreateWithSyntax

configGet shows a config-file value and a null read for an unset key;
queryCreateWithSyntax demonstrates s-expression queries (the
match-all () form and a field query) alongside the equivalent Xapian
syntax.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017i7R7ReKJAHGQpitxGXqrb
---
 src/Database.zig | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/src/Database.zig b/src/Database.zig
index 37a22ff..f5338a3 100644
--- a/src/Database.zig
+++ b/src/Database.zig
@@ -1156,6 +1156,29 @@ pub fn queryCreateWithSyntax(self: *const Database, query_string: [:0]const u8,
     return .init(query orelse return error.OutOfMemory);
 }
 
+test queryCreateWithSyntax {
+    const fixture = @import("testing.zig");
+
+    var test_db = try fixture.corpusDatabase();
+    defer test_db.deinit();
+    const db = test_db.database;
+
+    // The s-expression syntax: () matches all messages.
+    const all = try db.queryCreateWithSyntax("()", .sexp);
+    defer all.deinit();
+    try std.testing.expectEqual(@as(u32, fixture.corpus.len), try all.countMessages());
+
+    // A field query in s-expression form.
+    const lunch = try db.queryCreateWithSyntax("(subject lunch)", .sexp);
+    defer lunch.deinit();
+    try std.testing.expectEqual(@as(u32, 2), try lunch.countMessages());
+
+    // The default Xapian syntax is available by name as well.
+    const xapian = try db.queryCreateWithSyntax("subject:lunch", .xapian);
+    defer xapian.deinit();
+    try std.testing.expectEqual(@as(u32, 2), try xapian.countMessages());
+}
+
 /// Get a configuration value from an open database.
 ///
 /// This value reflects all configuration information given at the time
@@ -1168,6 +1191,23 @@ pub fn configGet(self: *const Database, key: Config) Error!?[:0]const u8 {
     return std.mem.span(c.notmuch_config_get(self.database, @intFromEnum(key)) orelse return null);
 }
 
+test configGet {
+    const fixture = @import("testing.zig");
+
+    var test_db = try fixture.corpusDatabase();
+    defer test_db.deinit();
+    const db = test_db.database;
+
+    // A value read from the configuration file the database was opened with.
+    try std.testing.expectEqualStrings(
+        "zig@example.org",
+        try db.configGet(.primary_email) orelse return error.TestUnexpectedResult,
+    );
+
+    // A key with neither a configured value nor a default reads as null.
+    try std.testing.expectEqual(@as(?[:0]const u8, null), try db.configGet(.other_email));
+}
+
 /// Set config `key` to `value`.
 ///
 /// The database must be open in read-write mode.
-- 
2.51.2