1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/*
* qtmaildir - a Qt6 mail client for notmuch-indexed Maildirs
* Copyright (C) 2026 Danilo M. <danix@danix.xyz>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <QtTest>
#include "rulequery.h"
/// RuleQuery is a view over a string the notmuch post-new hook executes, so
/// the risk is a query that compiles to something subtly wider than the rows
/// say. These tests are about exact strings, not about whether notmuch would
/// accept the result: notmuch accepts almost anything, including `from:((((`.
class TestRuleQuery : public QObject
{
Q_OBJECT
private slots:
void aSingleContainsTermCompiles();
void everyFieldCompilesToItsPrefix();
void isQuotesAndContainsDoesNot();
void negationPrefixesNot();
void aValueWithASpaceIsAlwaysQuoted();
void folderAppendsTheRecursiveSuffix();
void dateCompilesToAOneSidedRange();
void allJoinsWithAnd();
void anyJoinsWithOr();
void exclusionsAppendAsAndNot();
void anyIsParenthesisedOnlyWhenExclusionsFollow();
void anEmptyQueryCompilesToAnEmptyString();
};
void TestRuleQuery::aSingleContainsTermCompiles()
{
RuleQuery q;
q.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("sender@example.org")});
QCOMPARE(q.compile(), QStringLiteral("from:sender@example.org"));
}
void TestRuleQuery::everyFieldCompilesToItsPrefix()
{
const QVector<QPair<RuleTerm::Field, QString>> cases = {
{RuleTerm::From, QStringLiteral("from:x")},
{RuleTerm::To, QStringLiteral("to:x")},
{RuleTerm::Cc, QStringLiteral("cc:x")},
{RuleTerm::Subject, QStringLiteral("subject:x")},
};
for (const auto &c : cases) {
RuleQuery q;
q.terms.append({c.first, RuleTerm::Contains, QStringLiteral("x")});
QCOMPARE(q.compile(), c.second);
}
}
void TestRuleQuery::isQuotesAndContainsDoesNot()
{
RuleQuery contains;
contains.terms.append({RuleTerm::Subject, RuleTerm::Contains,
QStringLiteral("receipt")});
QCOMPARE(contains.compile(), QStringLiteral("subject:receipt"));
RuleQuery is;
is.terms.append({RuleTerm::Subject, RuleTerm::Is,
QStringLiteral("receipt")});
QCOMPARE(is.compile(), QStringLiteral("subject:\"receipt\""));
}
void TestRuleQuery::negationPrefixesNot()
{
RuleQuery q;
q.terms.append({RuleTerm::Subject, RuleTerm::ContainsNot,
QStringLiteral("receipt")});
QCOMPARE(q.compile(), QStringLiteral("not subject:receipt"));
RuleQuery tag;
tag.terms.append({RuleTerm::Tag, RuleTerm::IsNot,
QStringLiteral("inbox")});
QCOMPARE(tag.compile(), QStringLiteral("not tag:inbox"));
RuleQuery att;
att.terms.append({RuleTerm::Attachment, RuleTerm::HasNot,
QStringLiteral("pdf")});
QCOMPARE(att.compile(), QStringLiteral("not attachment:pdf"));
}
void TestRuleQuery::aValueWithASpaceIsAlwaysQuoted()
{
// Unquoted, a space would end the term and the rest would become a
// separate bare word, silently widening the rule.
RuleQuery q;
q.terms.append({RuleTerm::Subject, RuleTerm::Contains,
QStringLiteral("your receipt")});
QCOMPARE(q.compile(), QStringLiteral("subject:\"your receipt\""));
}
void TestRuleQuery::folderAppendsTheRecursiveSuffix()
{
// A path: without the suffix matches nothing, and notmuch reports no
// error when it happens.
RuleQuery q;
q.terms.append({RuleTerm::Folder, RuleTerm::Is,
QStringLiteral("account-one")});
QCOMPARE(q.compile(), QStringLiteral("path:\"account-one/**\""));
}
void TestRuleQuery::dateCompilesToAOneSidedRange()
{
RuleQuery before;
before.terms.append({RuleTerm::Date, RuleTerm::Before,
QStringLiteral("2026-01-01")});
QCOMPARE(before.compile(), QStringLiteral("date:..2026-01-01"));
RuleQuery after;
after.terms.append({RuleTerm::Date, RuleTerm::After,
QStringLiteral("2026-01-01")});
QCOMPARE(after.compile(), QStringLiteral("date:2026-01-01.."));
}
void TestRuleQuery::allJoinsWithAnd()
{
RuleQuery q;
q.join = RuleQuery::All;
q.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("vendor.example.org")});
q.terms.append({RuleTerm::Subject, RuleTerm::Contains,
QStringLiteral("receipt")});
QCOMPARE(q.compile(),
QStringLiteral("from:vendor.example.org and subject:receipt"));
}
void TestRuleQuery::anyJoinsWithOr()
{
RuleQuery q;
q.join = RuleQuery::Any;
q.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("one.example.org")});
q.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("two.example.org")});
QCOMPARE(q.compile(),
QStringLiteral("from:one.example.org or from:two.example.org"));
}
void TestRuleQuery::exclusionsAppendAsAndNot()
{
RuleQuery q;
q.join = RuleQuery::All;
q.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("vendor.example.org")});
q.exclusions.append({RuleTerm::Subject, RuleTerm::Contains,
QStringLiteral("receipt")});
QCOMPARE(q.compile(),
QStringLiteral("from:vendor.example.org "
"and not subject:receipt"));
}
void TestRuleQuery::anyIsParenthesisedOnlyWhenExclusionsFollow()
{
// Without the parens this binds as (a or (b and not c)), which matches
// everything from the first sender regardless of the exclusion.
RuleQuery guarded;
guarded.join = RuleQuery::Any;
guarded.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("one.example.org")});
guarded.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("two.example.org")});
guarded.exclusions.append({RuleTerm::Subject, RuleTerm::Contains,
QStringLiteral("receipt")});
QCOMPARE(guarded.compile(),
QStringLiteral("(from:one.example.org or from:two.example.org) "
"and not subject:receipt"));
// No exclusion, no parens: they would be noise in the stored file.
RuleQuery bare;
bare.join = RuleQuery::Any;
bare.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("one.example.org")});
bare.terms.append({RuleTerm::From, RuleTerm::Contains,
QStringLiteral("two.example.org")});
QCOMPARE(bare.compile(),
QStringLiteral("from:one.example.org or from:two.example.org"));
}
void TestRuleQuery::anEmptyQueryCompilesToAnEmptyString()
{
RuleQuery q;
QCOMPARE(q.compile(), QString());
}
QTEST_MAIN(TestRuleQuery)
#include "test_rulequery.moc"
|
