File: foldertreewidgettest.cpp

package info (click to toggle)
mailcommon 4%3A25.08.3-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,816 kB
  • sloc: cpp: 30,838; xml: 340; makefile: 17; ansic: 12; sh: 3
file content (346 lines) | stat: -rw-r--r-- 15,289 bytes parent folder | download | duplicates (2)
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
/*
  SPDX-FileCopyrightText: 2016 David Faure <faure@kde.org>

  SPDX-License-Identifier: GPL-2.0-or-later
*/

#undef QT_NO_CAST_FROM_ASCII

#include <akonadi/qtest_akonadi.h>

#include <Akonadi/Collection>
#include <Akonadi/Item>
#include <Akonadi/ItemFetchScope>

#include <Akonadi/AgentInstanceCreateJob>
#include <Akonadi/AgentManager>
#include <Akonadi/AgentType>
#include <Akonadi/CollectionCreateJob>
#include <Akonadi/CollectionDeleteJob>
#include <Akonadi/CollectionFetchJob>
#include <Akonadi/CollectionMoveJob>
#include <Akonadi/EntityOrderProxyModel>
#include <Akonadi/SearchCreateJob>
#include <Akonadi/SearchQuery>

#include <KMime/Message>

#include "folder/entitycollectionorderproxymodel.h"
#include <MailCommon/FolderTreeView>
#include <MailCommon/FolderTreeWidget>
#include <MailCommon/MailKernel>

#include <QDebug>
#include <QStandardPaths>
#include <QTest>
#include <QTreeView>

#include "dummykernel.cpp"

// #define SHOW_WIDGET

using namespace Akonadi;

class FolderTreeWidgetTest : public QObject
{
    Q_OBJECT
private Q_SLOTS:
    void initTestCase()
    {
        AkonadiTest::checkTestIsIsolated();

        auto kernel = new DummyKernel(nullptr);
        CommonKernel->registerKernelIf(kernel);
        CommonKernel->registerSettingsIf(kernel);

        mFolderTreeWidget = new MailCommon::FolderTreeWidget(nullptr);
        const QStringList resourceOrder{"akonadi_knut_resource_2", "akonadi_knut_resource_0"}; // _1 isn't specified so it goes at the end
        mFolderTreeWidget->entityOrderProxy()->setTopLevelOrder(resourceOrder);

        mCollectionModel = KernelIf->collectionModel();
        mTopModel = mFolderTreeWidget->folderTreeView()->model();

        // One knut resource is already defined in the unittestenv, so that it's below "Search" in the ETM.
        QTRY_COMPARE(mCollectionModel->rowCount(), 4);
        QCOMPARE(mTopModel->rowCount(), 3); // Search doesn't appear yet
        mFolderNames = QStringList{QStringLiteral("res3"), QStringLiteral("res1"), QStringLiteral("res2")};
        QCOMPARE(collectNames(mTopModel), mFolderNames);
    }

    void createAndDeleteSearchCollection()
    {
#ifdef SHOW_WIDGET
        mFolderTreeWidget->resize(1000, 1000);
        mFolderTreeWidget->show();
#endif

        // Create search folder
        Akonadi::SearchQuery query;
        query.addTerm(Akonadi::SearchTerm(QStringLiteral("plugin"), 1));
        auto create = new SearchCreateJob(QStringLiteral("search123456"), query, this);
        create->setSearchMimeTypes({KMime::Message::mimeType()});
        create->setRemoteSearchEnabled(false);
        AKVERIFYEXEC(create);
        const Collection searchCol = create->createdCollection();
        QVERIFY(searchCol.isValid());

        // Check it appeared in the tree, under a Search toplevel item
        QTRY_COMPARE(mCollectionModel->rowCount(), 4);
        QTRY_COMPARE(mTopModel->rowCount(), 4);
        const QStringList names = collectNames(mTopModel);
        const QStringList expectedNames{"res3", "res1", "res2", "Search"};
        QCOMPARE(names, expectedNames);
        const int rowOfSearch = names.indexOf("Search");
        const QModelIndex searchParent = mTopModel->index(rowOfSearch, 0);
        QCOMPARE(mTopModel->rowCount(searchParent), 1); // the actual child search folder

#ifdef SHOW_WIDGET
        QTest::qWait(500);
#endif

        QSignalSpy rATBRSpy_CollectionModel(mCollectionModel, &QAbstractItemModel::rowsAboutToBeRemoved);
        QSignalSpy rATBRSpy_FolderTreeProxyModel(mFolderTreeWidget->folderTreeWidgetProxyModel(), &QAbstractItemModel::rowsAboutToBeRemoved);
        QSignalSpy rATBRSpy_TopModel(mTopModel, &QAbstractItemModel::rowsAboutToBeRemoved);

        // Now delete it
        auto delJob = new Akonadi::CollectionDeleteJob(searchCol);
        AKVERIFYEXEC(delJob);

        // Check it disappeared from the tree, as well as the toplevel item
        QTRY_COMPARE(mTopModel->rowCount(), 3);
        QCOMPARE(collectNames(mTopModel), mFolderNames);
        QCOMPARE(collectNames(mFolderTreeWidget->entityOrderProxy()), mFolderNames);

        QCOMPARE(rATBRSpy_CollectionModel.count(), 2); // one for the child, one for the parent
        QCOMPARE(rATBRSpy_FolderTreeProxyModel.count(), 2); // one for the child, one for the parent
        QCOMPARE(rATBRSpy_TopModel.count(), 2); // one for the child, one for the parent

        checkMailFolders(mTopModel->index(0, 0));

#ifdef SHOW_WIDGET
        QTest::qWait(1000);
#endif
    }

    void testCreateResources()
    {
        // Test creating more knut resources.
        // This tests that ETM and proxies on top update correctly, and it tests toplevel collection order.
        const QList<int> numFolders{1, 5, 2};
        QList<Collection> topLevelCollections;
        const AgentType agentType = AgentManager::self()->type(QStringLiteral("akonadi_knut_resource"));
        QVERIFY(agentType.isValid());
        mFolderNames = QStringList{"res3", "res1", "res2"}; // according to resourceOrder above (the folder names are defined in testdata-res*.xml)

        // Create resources
        const int numResources = numFolders.count();
        for (int i = 3 /*first three already created*/; i < numResources; ++i) {
            auto agentCreateJob = new AgentInstanceCreateJob(agentType);
            AKVERIFYEXEC(agentCreateJob);
            const QString identifier = agentCreateJob->instance().identifier();

            QTRY_COMPARE(mCollectionModel->rowCount(), i + 1);
            QTRY_COMPARE(mTopModel->rowCount(), i + 1);

            Collection topLevelCollection;
            QTRY_VERIFY((topLevelCollection = topLevelCollectionForResource(identifier)).isValid());
            topLevelCollections.append(topLevelCollection);

            // Now create some folders
            for (int number = 0; number < numFolders[i]; ++number) {
                Collection mailCollection;
                mailCollection.setParentCollection(topLevelCollection);
                mailCollection.setName(QStringLiteral("mailCollection_%1_%2").arg(i).arg(number));
                auto collCreateJob = new CollectionCreateJob(mailCollection);
                AKVERIFYEXEC(collCreateJob);
            }
            const int resourceRow = collectNames(mTopModel).indexOf("res" + QString::number(i + 1));
            QModelIndex parent = mTopModel->index(resourceRow, 0);
            QTRY_COMPARE(mTopModel->rowCount(parent), numFolders[i]);

            checkMailFolders(parent);
        }
        QCOMPARE(collectNames(mTopModel), mFolderNames);
    }

    void testMoveFolder()
    {
        // Given a source folder with 2 levels of parents (res1/sub1/sub2)
        const QStringList folderNames = collectNames(mCollectionModel);
        const QModelIndex res1Index = mCollectionModel->index(folderNames.indexOf("res1"), 0, QModelIndex());
        const auto topLevelCollection = res1Index.data(EntityTreeModel::CollectionRole).value<Collection>();
        QCOMPARE(topLevelCollection.name(), QStringLiteral("res1"));
        const int parentCount = 2;
        Collection currentColl = topLevelCollection;
        for (int number = 0; number < parentCount; ++number) {
            Collection mailCollection;
            mailCollection.setParentCollection(currentColl);
            mailCollection.setName(QStringLiteral("sub%1").arg(number + 1));
            auto collCreateJob = new CollectionCreateJob(mailCollection);
            AKVERIFYEXEC(collCreateJob);
            currentColl = collCreateJob->collection();
        }
        QTRY_COMPARE(mCollectionModel->rowCount(res1Index), 1);

        // ... and a dest folder in another resource
        const QPersistentModelIndex res2Index = mCollectionModel->index(folderNames.indexOf("res2"), 0, QModelIndex());
        const int origRowCount = mCollectionModel->rowCount(res2Index);
        const auto newParentCollection = res2Index.data(EntityTreeModel::CollectionRole).value<Collection>();
        QCOMPARE(newParentCollection.name(), QStringLiteral("res2"));

        QTest::qWait(100); // #### akonadi bug? Without this, a warning "Only resources can modify remote identifiers" appears

        // When moving the source folder (sub2) to the dest folder
        auto collMoveJob = new CollectionMoveJob(currentColl, newParentCollection);
        AKVERIFYEXEC(collMoveJob);

        // wait for Akonadi::Monitor::collectionMoved
        QTRY_COMPARE(mCollectionModel->rowCount(res2Index), origRowCount + 1);

#ifdef SHOW_WIDGET
        QTest::qWait(1000);
#endif
    }

    void testFiltering()
    {
        const auto model = mFolderTreeWidget->entityOrderProxy();
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res3", "res1", "sub1", "res2", "sub2"}));

        mFolderTreeWidget->applyFilter(QStringLiteral("sub"));
        // matches all folders matching "sub"
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res1", "sub1", "res2", "sub2"}));
        QCOMPARE(mFolderTreeWidget->currentIndex().data().toString(), "sub1");

        mFolderTreeWidget->applyFilter(QStringLiteral("res"));
        // matches all folders matching "res"
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res3", "res1", "res2"}));
        // "res1" is current because it became current when previous current "sub1" was filtered out
        QCOMPARE(mFolderTreeWidget->currentIndex().data().toString(), "res1");

        mFolderTreeWidget->applyFilter(QStringLiteral("foo"));
        // matches nothing
        QCOMPARE(collectNamesRecursive(model), (QStringList{}));
        QVERIFY(!mFolderTreeWidget->currentIndex().isValid());

        mFolderTreeWidget->applyFilter(QStringLiteral("res/sub"));
        // matches folders matching "sub" with parents matching "res"
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res1", "sub1", "res2", "sub2"}));
        QCOMPARE(mFolderTreeWidget->currentIndex().data().toString(), "sub1");

        mFolderTreeWidget->applyFilter(QStringLiteral("res/1"));
        // matches folders matching "1" with parents matching "res"
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res1", "sub1"}));
        QCOMPARE(mFolderTreeWidget->currentIndex().data().toString(), "sub1");

        mFolderTreeWidget->applyFilter(QStringLiteral("res/"));
        // matches folders matching anything ("" always matches) with parents matching "res"
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res1", "sub1", "res2", "sub2"}));
        QCOMPARE(mFolderTreeWidget->currentIndex().data().toString(), "sub1");

        mFolderTreeWidget->applyFilter(QStringLiteral("sub/"));
        // matches nothing (there are no folders matching "sub" that have subfolders)
        QCOMPARE(collectNamesRecursive(model), (QStringList{}));
        QVERIFY(!mFolderTreeWidget->currentIndex().isValid());

        mFolderTreeWidget->applyFilter(QStringLiteral("/sub"));
        // matches folders matching "sub" with parents matching anything
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res1", "sub1", "res2", "sub2"}));
        QCOMPARE(mFolderTreeWidget->currentIndex().data().toString(), "sub1");

        mFolderTreeWidget->applyFilter(QStringLiteral("/res"));
        // matches nothing (there are no subfolders matching "res")
        QCOMPARE(collectNamesRecursive(model), (QStringList{}));
        QVERIFY(!mFolderTreeWidget->currentIndex().isValid());

        mFolderTreeWidget->applyFilter(QStringLiteral("//sub"));
        // matches nothing (there are no subsubfolders matching "sub")
        QCOMPARE(collectNamesRecursive(model), (QStringList{}));
        QVERIFY(!mFolderTreeWidget->currentIndex().isValid());

        mFolderTreeWidget->applyFilter(QStringLiteral("res//"));
        // matches nothing (there are no folders matching "res" that have subsubfolders)
        QCOMPARE(collectNamesRecursive(model), (QStringList{}));
        QVERIFY(!mFolderTreeWidget->currentIndex().isValid());

        mFolderTreeWidget->applyFilter(QStringLiteral("1/1"));
        // matches folders matching "1" with parents matching "1"
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res1", "sub1"}));
        QCOMPARE(mFolderTreeWidget->currentIndex().data().toString(), "sub1");

        mFolderTreeWidget->applyFilter(QStringLiteral("2/"));
        // matches folders matching anything with parents matching "2"
        QCOMPARE(collectNamesRecursive(model), (QStringList{"res2", "sub2"}));
        QCOMPARE(mFolderTreeWidget->currentIndex().data().toString(), "sub2");

        mFolderTreeWidget->applyFilter(QStringLiteral("1/2"));
        // matches nothing (there are no folders matching "2" with parents matching "1")
        QCOMPARE(collectNamesRecursive(model), (QStringList{}));
        QVERIFY(!mFolderTreeWidget->currentIndex().isValid());
    }

private:
    static Collection topLevelCollectionForResource(const QString &identifier)
    {
        // Find out the collection for the resource (as defined in unittestenv/xdglocal/testdata-res*.xml)
        auto job = new CollectionFetchJob(Collection::root(), CollectionFetchJob::FirstLevel);
        if (job->exec()) {
            const Collection::List collections = job->collections();
            for (const Collection &col : collections) {
                // qDebug() << col.resource() << col.mimeType();
                if (col.resource() == identifier) {
                    return col;
                }
            }
        } else {
            qWarning() << job->errorString();
        }
        return {};
    }

    // Check that every child of @p parent has a valid CollectionRole.
    static void checkMailFolders(const QModelIndex &parent)
    {
        const QAbstractItemModel *model = parent.model();
        QVERIFY(model);
        for (int row = 0; row < model->rowCount(parent); ++row) {
            QModelIndex idx = model->index(row, 0, parent);
            QModelIndex col1idx = model->index(row, 1, parent);
            QCOMPARE(col1idx.sibling(col1idx.row(), 0), idx);
            auto collection = idx.data(EntityTreeModel::CollectionRole).value<Collection>();
            QVERIFY2(collection.isValid(), qPrintable(idx.data().toString()));
        }
    }

    static QStringList collectNamesRecursive(const QAbstractItemModel *model, const QModelIndex &parent = QModelIndex{})
    {
        QStringList ret;
        ret.reserve(model->rowCount(parent));
        for (int row = 0; row < model->rowCount(parent); ++row) {
            QModelIndex idx = model->index(row, 0, parent);
            ret.append(idx.data().toString());
            ret.append(collectNamesRecursive(model, idx));
        }
        return ret;
    }

    static QStringList collectNames(QAbstractItemModel *model);
    EntityMimeTypeFilterModel *mCollectionModel = nullptr;
    QAbstractItemModel *mTopModel = nullptr;
    MailCommon::FolderTreeWidget *mFolderTreeWidget = nullptr;
    QStringList mFolderNames;
};

QStringList FolderTreeWidgetTest::collectNames(QAbstractItemModel *model)
{
    QStringList ret;
    ret.reserve(model->rowCount());
    for (int row = 0; row < model->rowCount(); ++row) {
        ret.append(model->index(row, 0).data().toString());
    }
    return ret;
}

QTEST_AKONADIMAIN(FolderTreeWidgetTest)

#include "foldertreewidgettest.moc"