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
  66 private:
  67     static KFileItemList createFileItemList(const QStringList& fileNames, const QString& urlPrefix = QLatin1String("file:///"));
  68 };
  69
  70 KFileItemModelBenchmark::KFileItemModelBenchmark()
  71 {
  72 }
  73
  74 void KFileItemModelBenchmark::insertAndRemoveManyItems_data()
  75 {
  76     QTest::addColumn<KFileItemList>("initialItems");
  77     QTest::addColumn<KFileItemList>("newItems");
  78     QTest::addColumn<KFileItemList>("removedItems");
  79     QTest::addColumn<KFileItemList>("expectedFinalItems");
  80     QTest::addColumn<KItemRangeList>("expectedItemsInserted");
  81     QTest::addColumn<KItemRangeList>("expectedItemsRemoved");
  82
  83     QList<int> sizes;
  84     sizes << 100000;
  85
  86     foreach (int n, sizes) {
  87         QStringList allStrings;
  88         for (int i = 0; i < n; ++i) {
  89             allStrings << QString::number(i);
  90         }
  91
  92         // We want to keep the sorting overhead in the benchmark low.
  93         // Therefore, we do not use natural sorting. However, this
  94         // means that our list is currently not sorted.
  95         allStrings.sort();
  96
  97         KFileItemList all = createFileItemList(allStrings);
  98
  99         KFileItemList firstHalf, secondHalf, even, odd;
 100         for (int i = 0; i < n; ++i) {
 101             if (i < n / 2) {
 102                 firstHalf << all.at(i);
 103             } else {
 104                 secondHalf << all.at(i);
 105             }
 106
 107             if (i % 2 == 0) {
 108                 even << all.at(i);
 109             } else {
 110                 odd << all.at(i);
 111             }
 112         }
 113
 114         KItemRangeList itemRangeListFirstHalf;
 115         itemRangeListFirstHalf << KItemRange(0, firstHalf.count());
 116
 117         KItemRangeList itemRangeListSecondHalf;
 118         itemRangeListSecondHalf << KItemRange(firstHalf.count(), secondHalf.count());
 119
 120         KItemRangeList itemRangeListOddInserted, itemRangeListOddRemoved;
 121         for (int i = 0; i < odd.count(); ++i) {
 122             // Note that the index in the KItemRange is the index of
 123             // the model *before* the items have been inserted.
 124             itemRangeListOddInserted << KItemRange(i + 1, 1);
 125             itemRangeListOddRemoved << KItemRange(2 * i + 1, 1);
 126         }
 127
 128         const int bufferSize = 128;
 129         char buffer[bufferSize];
 130
 131         snprintf(buffer, bufferSize, "all--n=%i", n);
 132         QTest::newRow(buffer) << all << KFileItemList() << KFileItemList() << all << KItemRangeList() << KItemRangeList();
 133
 134         snprintf(buffer, bufferSize, "1st half + 2nd half--n=%i", n);
 135         QTest::newRow(buffer) << firstHalf << secondHalf << KFileItemList() << all << itemRangeListSecondHalf << KItemRangeList();
 136
 137         snprintf(buffer, bufferSize, "2nd half + 1st half--n=%i", n);
 138         QTest::newRow(buffer) << secondHalf << firstHalf << KFileItemList() << all << itemRangeListFirstHalf << KItemRangeList();
 139
 140         snprintf(buffer, bufferSize, "even + odd--n=%i", n);
 141         QTest::newRow(buffer) << even << odd << KFileItemList() << all << itemRangeListOddInserted << KItemRangeList();
 142
 143         snprintf(buffer, bufferSize, "all - 2nd half--n=%i", n);
 144         QTest::newRow(buffer) << all << KFileItemList() << secondHalf << firstHalf << KItemRangeList() << itemRangeListSecondHalf;
 145
 146         snprintf(buffer, bufferSize, "all - 1st half--n=%i", n);
 147         QTest::newRow(buffer) << all << KFileItemList() << firstHalf << secondHalf << KItemRangeList() << itemRangeListFirstHalf;
 148
 149         snprintf(buffer, bufferSize, "all - odd--n=%i", n);
 150         QTest::newRow(buffer) << all << KFileItemList() << odd << even << KItemRangeList() << itemRangeListOddRemoved;
 151     }
 152 }
 153
 154 void KFileItemModelBenchmark::insertAndRemoveManyItems()
 155 {
 156     QFETCH(KFileItemList, initialItems);
 157     QFETCH(KFileItemList, newItems);
 158     QFETCH(KFileItemList, removedItems);
 159     QFETCH(KFileItemList, expectedFinalItems);
 160     QFETCH(KItemRangeList, expectedItemsInserted);
 161     QFETCH(KItemRangeList, expectedItemsRemoved);
 162
 163     KFileItemModel model;
 164
 165     // Avoid overhead caused by natural sorting
 166     // and determining the isDir/isLink roles.
 167     model.m_naturalSorting = false;
 168     model.setRoles({"text"});
 169
 170     QSignalSpy spyItemsInserted(&model, SIGNAL(itemsInserted(KItemRangeList)));
 171     QSignalSpy spyItemsRemoved(&model, SIGNAL(itemsRemoved(KItemRangeList)));
 172
 173     QBENCHMARK {
 174         model.slotClear();
 175         model.slotItemsAdded(model.directory(), initialItems);
 176         model.slotCompleted();
 177         QCOMPARE(model.count(), initialItems.count());
 178
 179         if (!newItems.isEmpty()) {
 180             model.slotItemsAdded(model.directory(), newItems);
 181             model.slotCompleted();
 182         }
 183         QCOMPARE(model.count(), initialItems.count() + newItems.count());
 184
 185         if (!removedItems.isEmpty()) {
 186             model.slotItemsDeleted(removedItems);
 187         }
 188         QCOMPARE(model.count(), initialItems.count() + newItems.count() - removedItems.count());
 189     }
 190
 191     QVERIFY(model.isConsistent());
 192
 193     for (int i = 0; i < model.count(); ++i) {
 194         QCOMPARE(model.fileItem(i), expectedFinalItems.at(i));
 195     }
 196
 197     if (!expectedItemsInserted.empty()) {
 198         QVERIFY(!spyItemsInserted.empty());
 199         const KItemRangeList actualItemsInserted = spyItemsInserted.last().first().value<KItemRangeList>();
 200         QCOMPARE(actualItemsInserted, expectedItemsInserted);
 201     }
 202
 203     if (!expectedItemsRemoved.empty()) {
 204         QVERIFY(!spyItemsRemoved.empty());
 205         const KItemRangeList actualItemsRemoved = spyItemsRemoved.last().first().value<KItemRangeList>();
 206         QCOMPARE(actualItemsRemoved, expectedItemsRemoved);
 207     }
 208 }
 209
 210 KFileItemList KFileItemModelBenchmark::createFileItemList(const QStringList& fileNames, const QString& prefix)
 211 {
 212     // Suppress 'file does not exist anymore' messages from KFileItemPrivate::init().
 213     qInstallMessageHandler(myMessageOutput);
 214
 215     KFileItemList result;
 216     foreach (const QString& name, fileNames) {
 217         const KFileItem item(QUrl::fromLocalFile(prefix + name), QString(), KFileItem::Unknown);
 218         result << item;
 219     }
 220     return result;
 221 }
 222
 223 QTEST_MAIN(KFileItemModelBenchmark)
 224
 225 #include "kfileitemmodelbenchmark.moc"