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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
/*
* 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 <QTemporaryDir>
#include <QtTest>
#include "tagrules.h"
/// The risk in TagRules is the format, not painting: a field silently dropped
/// on save mis-tags real mail on the next sync, and does it quietly. These
/// tests are therefore about round-trips and rejections, and the file they
/// read is byte-for-byte what mailctl writes.
class TestTagRules : public QObject
{
Q_OBJECT
private slots:
void aRuleLoadsWithEveryField();
void absentFieldsTakeTheirDefaults();
void aMalformedRuleIsDroppedWithAWarning();
void unknownFieldsSurviveASave();
void stageOrderPutsAccountsFirst();
void aQueryWithQuotesRoundTrips();
void aMissingFileIsEmptyNotAnError();
void aNewerVersionIsRefused();
private:
QString writeRules(const QString &json);
QTemporaryDir m_dir;
};
QString TestTagRules::writeRules(const QString &json)
{
const QString path = m_dir.filePath(QStringLiteral("rules.json"));
QFile file(path);
if (!file.open(QIODevice::WriteOnly | QIODevice::Truncate))
return QString();
file.write(json.toUtf8());
file.close();
return path;
}
void TestTagRules::aRuleLoadsWithEveryField()
{
const QString path = writeRules(R"({
"version": 1,
"rules": [{
"id": "notify-forge",
"stage": 50,
"enabled": true,
"add": ["notify/forge"],
"remove": [],
"query": "from:notifications@example.com",
"note": "All repositories, not one project."
}]
})");
TagRules rules;
rules.load(path);
QVERIFY2(rules.warnings().isEmpty(),
qPrintable(rules.warnings().join(QStringLiteral("; "))));
QCOMPARE(rules.rules().size(), 1);
const TagRule &rule = rules.rules().first();
QCOMPARE(rule.id, QStringLiteral("notify-forge"));
QCOMPARE(rule.stage, 50);
QVERIFY(rule.enabled);
QCOMPARE(rule.add, QStringList{ QStringLiteral("notify/forge") });
QVERIFY(rule.remove.isEmpty());
QCOMPARE(rule.query, QStringLiteral("from:notifications@example.com"));
QCOMPARE(rule.note, QStringLiteral("All repositories, not one project."));
}
void TestTagRules::absentFieldsTakeTheirDefaults()
{
const QString path = writeRules(R"({
"version": 1,
"rules": [{"id": "minimal", "add": ["x"],
"query": "from:a@example.com"}]
})");
TagRules rules;
rules.load(path);
QVERIFY(rules.warnings().isEmpty());
const TagRule &rule = rules.rules().first();
QCOMPARE(rule.stage, 50);
QVERIFY(rule.enabled);
QVERIFY(rule.remove.isEmpty());
QVERIFY(rule.note.isEmpty());
}
void TestTagRules::aMalformedRuleIsDroppedWithAWarning()
{
// One bad rule must not cost the others. Four separate defects, and the
// good rule sits first so a parser that stops at the first problem is
// caught by the count rather than by an empty list.
const QString path = writeRules(R"({
"version": 1,
"rules": [
{"id": "good", "add": ["x"], "query": "from:a@example.com"},
{"id": "no-query", "add": ["y"]},
{"id": "no-tags", "query": "from:b@example.com"},
{"id": "Bad Id", "add": ["z"], "query": "from:c@example.com"}
]
})");
TagRules rules;
rules.load(path);
QCOMPARE(rules.rules().size(), 1);
QCOMPARE(rules.rules().first().id, QStringLiteral("good"));
QCOMPARE(rules.warnings().size(), 3);
}
void TestTagRules::unknownFieldsSurviveASave()
{
// The neutrality guarantee. If qtmaildir strips a field mailctl wrote,
// the file is qtmaildir's file that mailctl may read.
const QString path = writeRules(R"({
"version": 1,
"future_top_level": {"set_by": "another tool"},
"rules": [{
"id": "keeper",
"add": ["x"],
"query": "from:a@example.com",
"future_field": [1, 2, 3]
}]
})");
TagRules rules;
rules.load(path);
QVERIFY(rules.save(path));
QFile file(path);
QVERIFY(file.open(QIODevice::ReadOnly));
const QJsonObject root =
QJsonDocument::fromJson(file.readAll()).object();
QCOMPARE(root.value(QStringLiteral("future_top_level"))
.toObject().value(QStringLiteral("set_by")).toString(),
QStringLiteral("another tool"));
const QJsonObject saved =
root.value(QStringLiteral("rules")).toArray().first().toObject();
QCOMPARE(saved.value(QStringLiteral("future_field")).toArray().size(), 3);
QCOMPARE(saved.value(QStringLiteral("id")).toString(),
QStringLiteral("keeper"));
}
void TestTagRules::stageOrderPutsAccountsFirst()
{
const QString path = writeRules(R"({
"version": 1,
"rules": [
{"id": "topic-b", "stage": 50, "add": ["b"],
"query": "from:b@example.com"},
{"id": "account", "stage": 10, "add": ["acct"],
"query": "path:\"work/**\""},
{"id": "topic-a", "stage": 50, "add": ["a"],
"query": "from:a@example.com"},
{"id": "off", "stage": 20, "add": ["c"],
"query": "from:c@example.com", "enabled": false}
]
})");
TagRules rules;
rules.load(path);
QStringList ids;
for (const TagRule &rule : rules.ordered())
ids.append(rule.id);
// Stage ascending, ties in file order, disabled excluded.
QCOMPARE(ids, (QStringList{ QStringLiteral("account"),
QStringLiteral("topic-b"),
QStringLiteral("topic-a") }));
// Still loaded, so the dialog can show and re-enable it.
QCOMPARE(rules.rules().size(), 4);
}
void TestTagRules::aQueryWithQuotesRoundTrips()
{
// Not hypothetical: every account rule is written path:"account/**".
const QString path = writeRules(R"({
"version": 1,
"rules": [{"id": "account", "add": ["acct"],
"query": "path:\"work-account/**\""}]
})");
TagRules rules;
rules.load(path);
QCOMPARE(rules.rules().first().query,
QStringLiteral("path:\"work-account/**\""));
QVERIFY(rules.save(path));
TagRules reloaded;
reloaded.load(path);
QVERIFY(reloaded.warnings().isEmpty());
QCOMPARE(reloaded.rules().first().query,
QStringLiteral("path:\"work-account/**\""));
}
void TestTagRules::aMissingFileIsEmptyNotAnError()
{
// qtmaildir must open on a machine that has never written this file.
TagRules rules;
rules.load(m_dir.filePath(QStringLiteral("absent.json")));
QVERIFY(rules.rules().isEmpty());
QVERIFY(rules.warnings().isEmpty());
QVERIFY(rules.missing());
}
void TestTagRules::aNewerVersionIsRefused()
{
const QString path = writeRules(R"({
"version": 2,
"rules": [{"id": "x", "add": ["a"], "query": "from:a@example.com"}]
})");
TagRules rules;
rules.load(path);
QVERIFY(rules.rules().isEmpty());
QCOMPARE(rules.warnings().size(), 1);
}
QTEST_MAIN(TestTagRules)
#include "test_tagrules.moc"
|
