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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
/*
SPDX-FileCopyrightText: 2013 Christian Mollekopf <mollekopf@kolabsys.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include <QTest>
#include "kimap/getmetadatajob.h"
#include "kimap/session.h"
#include "kimaptest/fakeserver.h"
#include <QDebug>
#include <QTest>
using MAP = QMap<QByteArray, QByteArray>;
Q_DECLARE_METATYPE(MAP)
class GetMetadataJobTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void metadata_data()
{
QTest::addColumn<QList<QByteArray>>("scenario");
QTest::addColumn<QString>("mailbox");
QTest::addColumn<QMap<QByteArray, QByteArray>>("expectedAnnotations");
{
// FIXME requesting /shared and getting /private back doesn't make sense => fix scenario
QList<QByteArray> scenario;
scenario << FakeServer::preauth() << "C: A000001 GETMETADATA (DEPTH infinity) \"Folder1\" (/shared)"
<< R"(S: * METADATA "Folder1" (/shared/comment "Shared comment"))"
<< R"(S: * METADATA "Folder1" (/private/comment "My own comment"))"
<< "S: A000001 OK GETMETADATA complete";
QMap<QByteArray, QByteArray> expected;
expected.insert("/shared/comment", "Shared comment");
expected.insert("/private/comment", "My own comment");
QTest::newRow("normal") << scenario << "Folder1" << expected;
}
{
QList<QByteArray> scenario;
scenario << FakeServer::preauth() << "C: A000001 GETMETADATA (DEPTH infinity) \"Folder1\" (/shared)"
<< R"(S: * METADATA "Folder1" (/shared/comment "Shared comment" /private/comment "My own comment"))"
<< "S: A000001 OK GETMETADATA complete";
QMap<QByteArray, QByteArray> expected;
expected.insert("/shared/comment", "Shared comment");
expected.insert("/private/comment", "My own comment");
QTest::newRow("combined response") << scenario << "Folder1" << expected;
}
{
QList<QByteArray> scenario;
scenario << FakeServer::preauth() << "C: A000001 GETMETADATA (DEPTH infinity) \"Folder1\" (/shared)"
<< R"(S: * METADATA "Folder1" (/shared/comment "NIL" /private/comment "NIL"))"
<< "S: A000001 OK GETMETADATA complete";
QMap<QByteArray, QByteArray> expected;
expected.insert("/shared/comment", "");
expected.insert("/private/comment", "");
QTest::newRow("NIL response") << scenario << "Folder1" << expected;
}
}
void metadata()
{
QFETCH(QList<QByteArray>, scenario);
QFETCH(QString, mailbox);
QFETCH(MAP, expectedAnnotations);
FakeServer fakeServer;
fakeServer.setScenario(scenario);
fakeServer.startAndWait();
KIMAP::Session session(QLatin1StringView("127.0.0.1"), 5989);
auto getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(mailbox);
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::AllLevels);
getMetadataJob->addRequestedEntry("/shared");
QVERIFY(getMetadataJob->exec());
QCOMPARE(getMetadataJob->allMetaData(mailbox).size(), expectedAnnotations.size());
const QMap<QByteArray, QByteArray> &allMetaData = getMetadataJob->allMetaData();
QCOMPARE(allMetaData.size(), expectedAnnotations.size());
const auto keys = expectedAnnotations.keys();
for (const QByteArray &entry : keys) {
QCOMPARE(getMetadataJob->metaData(mailbox, entry), expectedAnnotations.value(entry));
QCOMPARE(getMetadataJob->metaData(entry), expectedAnnotations.value(entry));
QCOMPARE(allMetaData.value(entry), expectedAnnotations.value(entry));
}
fakeServer.quit();
}
void testMetadataParameter()
{
FakeServer fakeServer;
QList<QByteArray> scenario;
scenario << FakeServer::preauth() << "C: A000001 GETMETADATA \"Folder1\" (/shared)"
<< "S: A000001 OK GETMETADATA complete"
<< "C: A000002 GETMETADATA (DEPTH 1) \"Folder1\" (/shared)"
<< "S: A000002 OK GETMETADATA complete"
<< "C: A000003 GETMETADATA (MAXSIZE 1234) \"Folder1\" (/shared)"
<< "S: A000003 OK GETMETADATA complete"
<< "C: A000004 GETMETADATA (DEPTH 1 MAXSIZE 1234) \"Folder1\" (/shared)"
<< "S: A000004 OK GETMETADATA complete"
<< "C: A000005 GETMETADATA (DEPTH 1 MAXSIZE 1234) \"Folder1\" (/shared /shared2)"
<< "S: A000005 OK GETMETADATA complete"
<< "C: A000006 GETMETADATA (DEPTH 1 MAXSIZE 1234) \"Folder1\""
<< "S: A000006 OK GETMETADATA complete"
<< "C: A000007 GETMETADATA (DEPTH 1) \"Folder1\""
<< "S: A000007 OK GETMETADATA complete"
<< "C: A000008 GETMETADATA (MAXSIZE 1234) \"Folder1\""
<< "S: A000008 OK GETMETADATA complete"
<< "C: A000009 GETMETADATA \"Folder1\""
<< "S: A000009 OK GETMETADATA complete"
<< "C: A000010 GETMETADATA \"\""
<< "S: A000010 OK GETMETADATA complete";
fakeServer.setScenario(scenario);
fakeServer.startAndWait();
KIMAP::Session session(QStringLiteral("127.0.0.1"), 5989);
// C: A000001 GETMETADATA "Folder1" (/shared)
auto getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->addRequestedEntry("/shared");
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::NoDepth);
QVERIFY(getMetadataJob->exec());
QCOMPARE(getMetadataJob->allMetaData(QLatin1StringView("Folder1")).size(), 0);
// C: A000002 GETMETADATA "Folder1" (DEPTH 1) (/shared)
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->addRequestedEntry("/shared");
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::OneLevel);
QVERIFY(getMetadataJob->exec());
// C: A000003 GETMETADATA "Folder1" (MAXSIZE 1234) (/shared)
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->addRequestedEntry("/shared");
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::NoDepth);
getMetadataJob->setMaximumSize(1234);
QVERIFY(getMetadataJob->exec());
// C: A000004 GETMETADATA "Folder1" (DEPTH 1) (MAXSIZE 1234) (/shared)
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->addRequestedEntry("/shared");
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::OneLevel);
getMetadataJob->setMaximumSize(1234);
QVERIFY(getMetadataJob->exec());
// C: A000005 GETMETADATA "Folder1" (DEPTH 1) (MAXSIZE 1234) (/shared /shared2)
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->addRequestedEntry("/shared");
getMetadataJob->addRequestedEntry("/shared2");
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::OneLevel);
getMetadataJob->setMaximumSize(1234);
QVERIFY(getMetadataJob->exec());
// C: A000006 GETMETADATA "Folder1" (DEPTH 1) (MAXSIZE 1234)
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::OneLevel);
getMetadataJob->setMaximumSize(1234);
QVERIFY(getMetadataJob->exec());
// C: A000007 GETMETADATA "Folder1" (DEPTH 1)
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::OneLevel);
QVERIFY(getMetadataJob->exec());
// C: A000008 GETMETADATA "Folder1" (MAXSIZE 1234)
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::NoDepth);
getMetadataJob->setMaximumSize(1234);
QVERIFY(getMetadataJob->exec());
// C: A000009 GETMETADATA "Folder1"
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::NoDepth);
QVERIFY(getMetadataJob->exec());
// C: A000010 GETMETADATA ""
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Metadata);
getMetadataJob->setMailBox(QLatin1StringView(""));
getMetadataJob->setDepth(KIMAP::GetMetaDataJob::NoDepth);
QVERIFY(getMetadataJob->exec());
QVERIFY(fakeServer.isAllScenarioDone());
fakeServer.quit();
}
void annotatemore_data()
{
QTest::addColumn<QList<QByteArray>>("scenario");
QTest::addColumn<QString>("mailbox");
QTest::addColumn<QMap<QByteArray, QByteArray>>("expectedAnnotations");
QTest::addColumn<QByteArray>("entry");
{
QList<QByteArray> scenario;
scenario << FakeServer::preauth() << R"(C: A000001 GETANNOTATION "Folder1" "*" "value.shared")"
<< "S: * ANNOTATION Folder1 /comment (value.shared \"Shared comment\")"
<< "S: * ANNOTATION Folder1 /comment (value.priv \"My own comment\")"
<< "S: A000001 OK annotations retrieved";
QMap<QByteArray, QByteArray> expected;
expected.insert("/shared/comment", "Shared comment");
expected.insert("/private/comment", "My own comment");
QTest::newRow("get all") << scenario << "Folder1" << expected << QByteArray("/shared*");
}
{
QList<QByteArray> scenario;
scenario << FakeServer::preauth() << R"(C: A000001 GETANNOTATION "Folder1" "/comment" "value.shared")"
<< "S: * ANNOTATION Folder1 /comment (value.shared \"Shared comment\")"
<< "S: * ANNOTATION Folder1 /comment (value.priv \"My own comment\")"
<< "S: A000001 OK annotations retrieved";
QMap<QByteArray, QByteArray> expected;
expected.insert("/shared/comment", "Shared comment");
expected.insert("/private/comment", "My own comment");
QTest::newRow("get single") << scenario << "Folder1" << expected << QByteArray("/shared/comment");
}
}
void annotatemore()
{
QFETCH(QList<QByteArray>, scenario);
QFETCH(QString, mailbox);
QFETCH(MAP, expectedAnnotations);
QFETCH(QByteArray, entry);
FakeServer fakeServer;
fakeServer.setScenario(scenario);
fakeServer.startAndWait();
KIMAP::Session session(QStringLiteral("127.0.0.1"), 5989);
auto getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Annotatemore);
getMetadataJob->setMailBox(mailbox);
getMetadataJob->addRequestedEntry(entry);
QVERIFY(getMetadataJob->exec());
// qDebug() << getMetadataJob->allMetaData(mailbox);
qDebug() << getMetadataJob->allMetaData();
const QMap<QByteArray, QByteArray> &allMetaData = getMetadataJob->allMetaData();
QCOMPARE(allMetaData.size(), expectedAnnotations.size());
const auto keys = expectedAnnotations.keys();
for (const QByteArray &e : keys) {
QCOMPARE(getMetadataJob->metaData(e), expectedAnnotations.value(e));
QCOMPARE(allMetaData.value(e), expectedAnnotations.value(e));
}
fakeServer.quit();
}
void testAnnotateEntires()
{
FakeServer fakeServer;
QList<QByteArray> scenario;
scenario << FakeServer::preauth() << "C: A000001 GETANNOTATION \"Folder1\""
<< "S: A000001 OK annotations retrieved"
<< R"(C: A000002 GETANNOTATION "Folder1" ("/comment" "/motd") ("value.priv" "value.shared"))"
<< "S: A000002 OK annotations retrieved";
fakeServer.setScenario(scenario);
fakeServer.startAndWait();
KIMAP::Session session(QStringLiteral("127.0.0.1"), 5989);
// C: A000001 GETANNOTATION "Folder1"
auto getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Annotatemore);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
QVERIFY(getMetadataJob->exec());
QCOMPARE(getMetadataJob->allMetaData(QLatin1StringView("Folder1")).size(), 0);
// C: A000002 GETANNOTATION "Folder1" ("/comment" "/motd") ("value.shared" "value.priv")
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Annotatemore);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->addRequestedEntry("/shared/comment");
getMetadataJob->addRequestedEntry("/private/motd");
QVERIFY(getMetadataJob->exec());
QVERIFY(fakeServer.isAllScenarioDone());
fakeServer.quit();
}
void testAnnotateMutiple()
{
// Do not double same parts of the request
FakeServer fakeServer;
QList<QByteArray> scenario;
scenario << FakeServer::preauth() << R"(C: A000001 GETANNOTATION "Folder1" ("/comment" "/motd") "value.shared")"
<< "S: A000001 OK annotations retrieved"
<< R"(C: A000002 GETANNOTATION "Folder1" "/comment" ("value.priv" "value.shared"))"
<< "S: A000002 OK annotations retrieved";
fakeServer.setScenario(scenario);
fakeServer.startAndWait();
KIMAP::Session session(QStringLiteral("127.0.0.1"), 5989);
// C: A000001 GETANNOTATION "Folder1" ("/comment" "/motd") "value.shared"
auto getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Annotatemore);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->addRequestedEntry("/shared/comment");
getMetadataJob->addRequestedEntry("/shared/motd");
QVERIFY(getMetadataJob->exec());
// C: A000002 GETANNOTATION "Folder1" ("/comment") ("value.shared" "value.priv")
getMetadataJob = new KIMAP::GetMetaDataJob(&session);
getMetadataJob->setServerCapability(KIMAP::MetaDataJobBase::Annotatemore);
getMetadataJob->setMailBox(QStringLiteral("Folder1"));
getMetadataJob->addRequestedEntry("/shared/comment");
getMetadataJob->addRequestedEntry("/private/comment");
QVERIFY(getMetadataJob->exec());
QVERIFY(fakeServer.isAllScenarioDone());
fakeServer.quit();
}
};
QTEST_GUILESS_MAIN(GetMetadataJobTest)
#include "getmetadatajobtest.moc"
|
