src/tests/kfileitemmodelbenchmark.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   3  *   Copyright (C) 2013 by Frank Reininghaus <frank78ac@googlemail.com>    *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  19  ***************************************************************************/
  20
  21 #include <QTest>
  22 #include <QSignalSpy>
  23
  24 #include <algorithm>
  25 #include <random>
  26
  27 #include "kitemviews/kfileitemmodel.h"
  28 #include "kitemviews/private/kfileitemmodelsortalgorithm.h"
  29
  30 #include "testdir.h"
  31
  32 void myMessageOutput(QtMsgType type, const QMessageLogContext& context, const QString& msg)
  33 {
  34     Q_UNUSED(context);
  35
  36     switch (type) {
  37     case QtDebugMsg:
  38         break;
  39     case QtWarningMsg:
  40         break;
  41     case QtCriticalMsg:
  42         fprintf(stderr, "Critical: %s\n", msg.toLocal8Bit().data());
  43         break;
  44     case QtFatalMsg:
  45         fprintf(stderr, "Fatal: %s\n", msg.toLocal8Bit().data());
  46         abort();
  47     default:
  48        break;
  49     }
  50 }
  51
  52 Q_DECLARE_METATYPE(KFileItemList)
  53 Q_DECLARE_METATYPE(KItemRangeList)
  54
  55 class KFileItemModelBenchmark : public QObject
  56 {
  57     Q_OBJECT
  58
  59 public:
  60     KFileItemModelBenchmark();
  61
  62 private slots:
  63     void insertAndRemoveManyItems_data();
  64     void insertAndRemoveManyItems();
  65     void insertManyChildItems();
  66
  67 private:
  68     static KFileItemList createFileItemList(const QStringList& fileNames, const QString& urlPrefix = QLatin1String("file:///"));
  69 };
  70
  71 KFileItemModelBenchmark::KFileItemModelBenchmark()
  72 {
  73 }
  74
  75 void KFileItemModelBenchmark::insertAndRemoveManyItems_data()
  76 {
  77     QTest::addColumn<KFileItemList>("initialItems");
  78     QTest::addColumn<KFileItemList>("newItems");
  79     QTest::addColumn<KFileItemList>("removedItems");
  80     QTest::addColumn<KFileItemList>("expectedFinalItems");
  81     QTest::addColumn<KItemRangeList>("expectedItemsInserted");
  82     QTest::addColumn<KItemRangeList>("expectedItemsRemoved");
  83
  84     QList<int> sizes;
  85     sizes << 1000 << 4000 << 16000 << 64000 << 256000;
  86     //sizes << 50000 << 100000 << 150000 << 200000 << 250000;
  87
  88     foreach (int n, sizes) {
  89         QStringList allStrings;
  90         for (int i = 0; i < n; ++i) {
  91             allStrings << QString::number(i);
  92         }
  93
  94         // We want to keep the sorting overhead in the benchmark low.
  95         // Therefore, we do not use natural sorting. However, this
  96         // means that our list is currently not sorted.
  97         allStrings.sort();
  98
  99         KFileItemList all = createFileItemList(allStrings);
 100
 101         KFileItemList firstHalf, secondHalf, even, odd;
 102         for (int i = 0; i < n; ++i) {
 103             if (i < n / 2) {
 104                 firstHalf << all.at(i);
 105             } else {
 106                 secondHalf << all.at(i);
 107             }
 108
 109             if (i % 2 == 0) {
 110                 even << all.at(i);
 111             } else {
 112                 odd << all.at(i);
 113             }
 114         }
 115
 116         KItemRangeList itemRangeListFirstHalf;
 117         itemRangeListFirstHalf << KItemRange(0, firstHalf.count());
 118
 119         KItemRangeList itemRangeListSecondHalf;
 120         itemRangeListSecondHalf << KItemRange(firstHalf.count(), secondHalf.count());
 121
 122         KItemRangeList itemRangeListOddInserted, itemRangeListOddRemoved;
 123         for (int i = 0; i < odd.count(); ++i) {
 124             // Note that the index in the KItemRange is the index of
 125             // the model *before* the items have been inserted.
 126             itemRangeListOddInserted << KItemRange(i + 1, 1);
 127             itemRangeListOddRemoved << KItemRange(2 * i + 1, 1);
 128         }
 129
 130         const int bufferSize = 128;
 131         char buffer[bufferSize];
 132
 133         snprintf(buffer, bufferSize, "all--n=%i", n);
 134         QTest::newRow(buffer) << all << KFileItemList() << KFileItemList() << all << KItemRangeList() << KItemRangeList();
 135
 136         snprintf(buffer, bufferSize, "1st half + 2nd half--n=%i", n);
 137         QTest::newRow(buffer) << firstHalf << secondHalf << KFileItemList() << all << itemRangeListSecondHalf << KItemRangeList();
 138
 139         snprintf(buffer, bufferSize, "2nd half + 1st half--n=%i", n);
 140         QTest::newRow(buffer) << secondHalf << firstHalf << KFileItemList() << all << itemRangeListFirstHalf << KItemRangeList();
 141
 142         snprintf(buffer, bufferSize, "even + odd--n=%i", n);
 143         QTest::newRow(buffer) << even << odd << KFileItemList() << all << itemRangeListOddInserted << KItemRangeList();
 144
 145         snprintf(buffer, bufferSize, "all - 2nd half--n=%i", n);
 146         QTest::newRow(buffer) << all << KFileItemList() << secondHalf << firstHalf << KItemRangeList() << itemRangeListSecondHalf;
 147
 148         snprintf(buffer, bufferSize, "all - 1st half--n=%i", n);
 149         QTest::newRow(buffer) << all << KFileItemList() << firstHalf << secondHalf << KItemRangeList() << itemRangeListFirstHalf;
 150
 151         snprintf(buffer, bufferSize, "all - odd--n=%i", n);
 152         QTest::newRow(buffer) << all << KFileItemList() << odd << even << KItemRangeList() << itemRangeListOddRemoved;
 153     }
 154 }
 155
 156 void KFileItemModelBenchmark::insertAndRemoveManyItems()
 157 {
 158     QFETCH(KFileItemList, initialItems);
 159     QFETCH(KFileItemList, newItems);
 160     QFETCH(KFileItemList, removedItems);
 161     QFETCH(KFileItemList, expectedFinalItems);
 162     QFETCH(KItemRangeList, expectedItemsInserted);
 163     QFETCH(KItemRangeList, expectedItemsRemoved);
 164
 165     KFileItemModel model;
 166
 167     // Avoid overhead caused by natural sorting
 168     // and determining the isDir/isLink roles.
 169     model.m_naturalSorting = false;
 170     model.setRoles({"text"});
 171
 172     QSignalSpy spyItemsInserted(&model, SIGNAL(itemsInserted(KItemRangeList)));
 173     QSignalSpy spyItemsRemoved(&model, SIGNAL(itemsRemoved(KItemRangeList)));
 174
 175     QBENCHMARK {
 176         model.slotClear();
 177         model.slotItemsAdded(model.directory(), initialItems);
 178         model.slotCompleted();
 179         QCOMPARE(model.count(), initialItems.count());
 180
 181         if (!newItems.isEmpty()) {
 182             model.slotItemsAdded(model.directory(), newItems);
 183             model.slotCompleted();
 184         }
 185         QCOMPARE(model.count(), initialItems.count() + newItems.count());
 186
 187         if (!removedItems.isEmpty()) {
 188             model.slotItemsDeleted(removedItems);
 189         }
 190         QCOMPARE(model.count(), initialItems.count() + newItems.count() - removedItems.count());
 191     }
 192
 193     QVERIFY(model.isConsistent());
 194
 195     for (int i = 0; i < model.count(); ++i) {
 196         QCOMPARE(model.fileItem(i), expectedFinalItems.at(i));
 197     }
 198
 199     if (!expectedItemsInserted.empty()) {
 200         QVERIFY(!spyItemsInserted.empty());
 201         const KItemRangeList actualItemsInserted = spyItemsInserted.last().first().value<KItemRangeList>();
 202         QCOMPARE(actualItemsInserted, expectedItemsInserted);
 203     }
 204
 205     if (!expectedItemsRemoved.empty()) {
 206         QVERIFY(!spyItemsRemoved.empty());
 207         const KItemRangeList actualItemsRemoved = spyItemsRemoved.last().first().value<KItemRangeList>();
 208         QCOMPARE(actualItemsRemoved, expectedItemsRemoved);
 209     }
 210 }
 211
 212 void KFileItemModelBenchmark::insertManyChildItems()
 213 {
 214     // TODO: this function needs to be adjusted to the changes in KFileItemModel
 215     // (replacement of slotNewItems(KFileItemList) by slotItemsAdded(KUrl,KFileItemList))
 216     // Currently, this function tries to insert child items of multiple
 217     // directories by invoking the slot only once.
 218 #if 0
 219     qInstallMsgHandler(myMessageOutput);
 220
 221     KFileItemModel model;
 222
 223     // Avoid overhead caused by natural sorting.
 224     model.m_naturalSorting = false;
 225
 226     QSet<QByteArray> modelRoles = model.roles();
 227     modelRoles << "isExpanded" << "isExpandable" << "expandedParentsCount";
 228     model.setRoles(modelRoles);
 229     model.setSortDirectoriesFirst(false);
 230
 231     // Create a test folder with a 3-level tree structure of folders.
 232     TestDir testFolder;
 233     int numberOfFolders = 0;
 234
 235     QStringList subFolderNames;
 236     subFolderNames << "a/" << "b/" << "c/" << "d/";
 237
 238     foreach (const QString& s1, subFolderNames) {
 239         ++numberOfFolders;
 240         foreach (const QString& s2, subFolderNames) {
 241             ++numberOfFolders;
 242             foreach (const QString& s3, subFolderNames) {
 243                 testFolder.createDir("level-1-" + s1 + "level-2-" + s2 + "level-3-" + s3);
 244                 ++numberOfFolders;
 245             }
 246         }
 247     }
 248
 249     // Open the folder in the model and expand all subfolders.
 250     model.loadDirectory(testFolder.url());
 251     QVERIFY(QTest::kWaitForSignal(&model, SIGNAL(itemsInserted(KItemRangeList)), DefaultTimeout));
 252
 253     int index = 0;
 254     while (index < model.count()) {
 255         if (model.isExpandable(index)) {
 256             model.setExpanded(index, true);
 257
 258             if (!model.data(index).value("text").toString().startsWith("level-3")) {
 259                 // New subfolders will appear unless we are on the final level already.
 260                 QVERIFY(QTest::kWaitForSignal(&model, SIGNAL(itemsInserted(KItemRangeList)), DefaultTimeout));
 261             }
 262
 263             QVERIFY(model.isExpanded(index));
 264         }
 265         ++index;
 266     }
 267
 268     QCOMPARE(model.count(), numberOfFolders);
 269
 270     // Create a list of many file items, which will be added to each of the
 271     // "level 1", "level 2", and "level 3" folders.
 272     const int filesPerDirectory = 500;
 273     QStringList allStrings;
 274     for (int i = 0; i < filesPerDirectory; ++i) {
 275         allStrings << QString::number(i);
 276     }
 277     allStrings.sort();
 278
 279     KFileItemList newItems;
 280
 281     // Also keep track of all expected items, including the existing
 282     // folders, to verify the final state of the model.
 283     KFileItemList allExpectedItems;
 284
 285     for (int i = 0; i < model.count(); ++i) {
 286         const KFileItem folderItem = model.fileItem(i);
 287         allExpectedItems << folderItem;
 288
 289         const KUrl folderUrl = folderItem.url();
 290         KFileItemList itemsInFolder = createFileItemList(allStrings, folderUrl.url(KUrl::AddTrailingSlash));
 291
 292         newItems.append(itemsInFolder);
 293         allExpectedItems.append(itemsInFolder);
 294     }
 295
 296     // Bring the items into random order.
 297     std::random_device rd;
 298     std::mt19937 g(rd());
 299     std::shuffle(newItems.begin(), newItems.end(), g);
 300
 301     // Measure how long it takes to insert and then remove all files.
 302     QBENCHMARK {
 303         model.slotNewItems(newItems);
 304         model.slotCompleted();
 305
 306         QCOMPARE(model.count(), allExpectedItems.count());
 307         QVERIFY(model.isConsistent());
 308         for (int i = 0; i < model.count(); ++i) {
 309             QCOMPARE(model.fileItem(i), allExpectedItems.at(i));
 310         }
 311
 312         model.slotItemsDeleted(newItems);
 313         QCOMPARE(model.count(), numberOfFolders);
 314         QVERIFY(model.isConsistent());
 315     }
 316 #endif
 317 }
 318
 319 KFileItemList KFileItemModelBenchmark::createFileItemList(const QStringList& fileNames, const QString& prefix)
 320 {
 321     // Suppress 'file does not exist anymore' messages from KFileItemPrivate::init().
 322     qInstallMessageHandler(myMessageOutput);
 323
 324     KFileItemList result;
 325     foreach (const QString& name, fileNames) {
 326         const KFileItem item(QUrl::fromLocalFile(prefix + name), QString(), KFileItem::Unknown);
 327         result << item;
 328     }
 329     return result;
 330 }
 331
 332 QTEST_MAIN(KFileItemModelBenchmark)
 333
 334 #include "kfileitemmodelbenchmark.moc"