src/tests/placesitemmodeltest.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2017 by Renato Araujo Oliveira <renato.araujo@kdab.com> *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #include <QTest>
  21 #include <QSignalSpy>
  22 #include <QStandardPaths>
  23 #include <QAction>
  24 #include <QDBusInterface>
  25
  26 #include <KBookmarkManager>
  27 #include <KConfig>
  28 #include <KConfigGroup>
  29 #include <KAboutData>
  30 #include <KFilePlacesModel>
  31
  32 #include "panels/places/placesitemmodel.h"
  33 #include "panels/places/placesitem.h"
  34 #include "views/viewproperties.h"
  35
  36 Q_DECLARE_METATYPE(KItemRangeList)
  37 Q_DECLARE_METATYPE(KItemRange)
  38
  39 #ifdef Q_OS_WIN
  40 //c:\ as root for windows
  41 #define KDE_ROOT_PATH "C:\\"
  42 #else
  43 #define KDE_ROOT_PATH "/"
  44 #endif
  45
  46 static QString bookmarksFile()
  47 {
  48     return QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + "/user-places.xbel";
  49 }
  50
  51 class PlacesItemModelTest : public QObject
  52 {
  53     Q_OBJECT
  54
  55 private slots:
  56     void init();
  57     void cleanup();
  58
  59     void initTestCase();
  60     void cleanupTestCase();
  61
  62     void testModelSort();
  63     void testGroups();
  64     void testDeletePlace();
  65     void testPlaceItem_data();
  66     void testPlaceItem();
  67     void testTearDownDevice();
  68     void testDefaultViewProperties_data();
  69     void testDefaultViewProperties();
  70     void testClear();
  71     void testHideItem();
  72     void testSystemItems();
  73     void testEditBookmark();
  74     void testEditAfterCreation();
  75     void testEditMetadata();
  76     void testRefresh();
  77     void testIcons_data();
  78     void testIcons();
  79     void testDragAndDrop();
  80     void testHideDevices();
  81     void testDuplicatedEntries();
  82     void renameAfterCreation();
  83
  84 private:
  85     PlacesItemModel* m_model;
  86     QSet<int> m_tobeRemoved;
  87     QMap<QString, QDBusInterface *> m_interfacesMap;
  88     int m_expectedModelCount = 15;
  89     bool m_hasDesktopFolder = false;
  90     bool m_hasDownloadsFolder = false;
  91
  92     void setBalooEnabled(bool enabled);
  93     int indexOf(const QUrl &url);
  94     QDBusInterface *fakeManager();
  95     QDBusInterface *fakeDevice(const QString &udi);
  96     QStringList placesUrls(PlacesItemModel *model = nullptr) const;
  97     QStringList initialUrls() const;
  98     void createPlaceItem(const QString &text, const QUrl &url, const QString &icon);
  99     void schedulePlaceRemoval(int index);
 100     void cancelPlaceRemoval(int index);
 101     void removeTestUserData();
 102     QMimeData *createMimeData(const QList<int> &indexes) const;
 103 };
 104
 105 #define CHECK_PLACES_URLS(urls)                                             \
 106     {                                                                       \
 107         QStringList places = placesUrls();                                  \
 108         if (places != urls) {                                               \
 109             qWarning() << "Expected:" << urls;                              \
 110             qWarning() << "Got:" << places;                                 \
 111             QCOMPARE(places, urls);                                         \
 112         }                                                                   \
 113     }
 114
 115 void PlacesItemModelTest::setBalooEnabled(bool enabled)
 116 {
 117     KConfig config(QStringLiteral("baloofilerc"));
 118     KConfigGroup basicSettings = config.group("Basic Settings");
 119     basicSettings.writeEntry("Indexing-Enabled", enabled);
 120     config.sync();
 121 }
 122
 123 int PlacesItemModelTest::indexOf(const QUrl &url)
 124 {
 125     for (int r = 0; r < m_model->count(); r++) {
 126         if (m_model->placesItem(r)->url() == url) {
 127             return r;
 128         }
 129     }
 130     return -1;
 131 }
 132
 133 QDBusInterface *PlacesItemModelTest::fakeManager()
 134 {
 135     return fakeDevice(QStringLiteral("/org/kde/solid/fakehw"));
 136 }
 137
 138 QDBusInterface *PlacesItemModelTest::fakeDevice(const QString &udi)
 139 {
 140     if (m_interfacesMap.contains(udi)) {
 141         return m_interfacesMap[udi];
 142     }
 143
 144     QDBusInterface *iface = new QDBusInterface(QDBusConnection::sessionBus().baseService(), udi);
 145     m_interfacesMap[udi] = iface;
 146
 147     return iface;
 148 }
 149
 150 QStringList PlacesItemModelTest::placesUrls(PlacesItemModel *model) const
 151 {
 152     QStringList urls;
 153     if (!model) {
 154         model = m_model;
 155     }
 156
 157     for (int row = 0; row < model->count(); ++row) {
 158         urls << model->placesItem(row)->url().toDisplayString(QUrl::PreferLocalFile);
 159     }
 160     return urls;
 161 }
 162
 163 QStringList PlacesItemModelTest::initialUrls() const
 164 {
 165     static QStringList urls;
 166     if (urls.isEmpty()) {
 167         urls << QDir::homePath();
 168
 169         if (m_hasDesktopFolder) {
 170             urls << QDir::homePath() + QStringLiteral("/Desktop");
 171         }
 172
 173         if (m_hasDownloadsFolder) {
 174             urls << QDir::homePath() + QStringLiteral("/Downloads");
 175         }
 176
 177         urls << QStringLiteral(KDE_ROOT_PATH) << QStringLiteral("trash:/")
 178              << QStringLiteral("remote:/")
 179              << QStringLiteral("/media/nfs")
 180              << QStringLiteral("timeline:/today") << QStringLiteral("timeline:/yesterday")
 181              << QStringLiteral("search:/documents") << QStringLiteral("search:/images") << QStringLiteral("search:/audio") << QStringLiteral("search:/videos")
 182              << QStringLiteral("/foreign")
 183              << QStringLiteral("/media/floppy0") << QStringLiteral("/media/XO-Y4") << QStringLiteral("/media/cdrom");
 184     }
 185     return urls;
 186 }
 187
 188 void PlacesItemModelTest::createPlaceItem(const QString &text, const QUrl &url, const QString &icon)
 189 {
 190     m_model->createPlacesItem(text, url, icon);
 191 }
 192
 193 void PlacesItemModelTest::schedulePlaceRemoval(int index)
 194 {
 195     m_tobeRemoved.insert(index);
 196 }
 197
 198 void PlacesItemModelTest::cancelPlaceRemoval(int index)
 199 {
 200     m_tobeRemoved.remove(index);
 201 }
 202
 203 void PlacesItemModelTest::removeTestUserData()
 204 {
 205     // user hardcoded path to avoid removal of any user personal data
 206     QDir dir(QStringLiteral("/home/renato/.qttest/share/placesitemmodeltest"));
 207     if (dir.exists()) {
 208         QVERIFY(dir.removeRecursively());
 209     }
 210 }
 211
 212 QMimeData *PlacesItemModelTest::createMimeData(const QList<int> &indexes) const
 213 {
 214     QByteArray itemData;
 215     QDataStream stream(&itemData, QIODevice::WriteOnly);
 216     QList<QUrl> urls;
 217
 218     for (int index : indexes) {
 219         const QUrl itemUrl = m_model->placesItem(index)->url();
 220         if (itemUrl.isValid()) {
 221             urls << itemUrl;
 222         }
 223         stream << index;
 224     }
 225
 226     QMimeData* mimeData = new QMimeData();
 227     mimeData->setUrls(urls);
 228     // copied from PlacesItemModel::internalMimeType()
 229     const QString internalMimeType = "application/x-dolphinplacesmodel-" +
 230             QString::number((qptrdiff)m_model);
 231     mimeData->setData(internalMimeType, itemData);
 232     return mimeData;
 233 }
 234
 235 void PlacesItemModelTest::init()
 236 {
 237     m_model = new PlacesItemModel();
 238     // WORKAROUND: need to wait for bookmark to load
 239     QTest::qWait(300);
 240     QCOMPARE(m_model->count(), m_expectedModelCount);
 241 }
 242
 243 void PlacesItemModelTest::cleanup()
 244 {
 245     const auto tobeRemoved = m_tobeRemoved;
 246     for (const int i : tobeRemoved) {
 247         int before = m_model->count();
 248         m_model->deleteItem(i);
 249         QTRY_COMPARE(m_model->count(), before - 1);
 250     }
 251     m_tobeRemoved.clear();
 252     delete m_model;
 253     m_model = nullptr;
 254     removeTestUserData();
 255 }
 256
 257 void PlacesItemModelTest::initTestCase()
 258 {
 259     QStandardPaths::setTestModeEnabled(true);
 260     // remove test user data
 261     removeTestUserData();
 262
 263     const QString fakeHw = QFINDTESTDATA("data/fakecomputer.xml");
 264     QVERIFY(!fakeHw.isEmpty());
 265     qputenv("SOLID_FAKEHW", QFile::encodeName(fakeHw));
 266
 267     setBalooEnabled(true);
 268     const QString bookmarsFileName = bookmarksFile();
 269     if (QFileInfo::exists(bookmarsFileName)) {
 270         // Ensure we'll have a clean bookmark file to start
 271         QVERIFY(QFile::remove(bookmarsFileName));
 272     }
 273
 274     if (QDir(QStandardPaths::writableLocation(QStandardPaths::DesktopLocation)).exists()) {
 275         m_hasDesktopFolder = true;
 276         m_expectedModelCount++;
 277     }
 278
 279     if (QDir(QStandardPaths::writableLocation(QStandardPaths::DownloadLocation)).exists()) {
 280         m_hasDownloadsFolder = true;
 281         m_expectedModelCount++;
 282     }
 283
 284     qRegisterMetaType<KItemRangeList>();
 285     qRegisterMetaType<KItemRange>();
 286 }
 287
 288 void PlacesItemModelTest::cleanupTestCase()
 289 {
 290     qDeleteAll(m_interfacesMap);
 291     QFile::remove(bookmarksFile());
 292
 293     // Remove any previous properties file
 294     removeTestUserData();
 295 }
 296
 297 void PlacesItemModelTest::testModelSort()
 298 {
 299     CHECK_PLACES_URLS(initialUrls());
 300 }
 301
 302 void PlacesItemModelTest::testGroups()
 303 {
 304     const auto groups = m_model->groups();
 305     int expectedGroupSize = 3;
 306     if (m_hasDesktopFolder) {
 307         expectedGroupSize++;
 308     }
 309     if (m_hasDownloadsFolder) {
 310         expectedGroupSize++;
 311     }
 312
 313     QCOMPARE(groups.size(), 6);
 314
 315     QCOMPARE(groups.at(0).first, 0);
 316     QCOMPARE(groups.at(0).second.toString(), QStringLiteral("Places"));
 317
 318     QCOMPARE(groups.at(1).first, expectedGroupSize);
 319     QCOMPARE(groups.at(1).second.toString(), QStringLiteral("Remote"));
 320
 321     QCOMPARE(groups.at(2).first, expectedGroupSize + 2);
 322     QCOMPARE(groups.at(2).second.toString(), QStringLiteral("Recently Saved"));
 323
 324     QCOMPARE(groups.at(3).first, expectedGroupSize + 4);
 325     QCOMPARE(groups.at(3).second.toString(), QStringLiteral("Search For"));
 326
 327     QCOMPARE(groups.at(4).first, expectedGroupSize + 8);
 328     QCOMPARE(groups.at(4).second.toString(), QStringLiteral("Devices"));
 329
 330     QCOMPARE(groups.at(5).first, expectedGroupSize + 9);
 331     QCOMPARE(groups.at(5).second.toString(), QStringLiteral("Removable Devices"));
 332 }
 333
 334 void PlacesItemModelTest::testPlaceItem_data()
 335 {
 336     QTest::addColumn<QUrl>("url");
 337     QTest::addColumn<bool>("expectedIsHidden");
 338     QTest::addColumn<bool>("expectedIsSystemItem");
 339     QTest::addColumn<QString>("expectedGroup");
 340     QTest::addColumn<bool>("expectedStorageSetupNeeded");
 341
 342     // places
 343     QTest::newRow("Places - Home") << QUrl::fromLocalFile(QDir::homePath()) << false << true << QStringLiteral("Places") << false;
 344
 345     // baloo -search
 346     QTest::newRow("Baloo - Documents") << QUrl("search:/documents") << false << true << QStringLiteral("Search For") << false;
 347
 348     // baloo - timeline
 349     QTest::newRow("Baloo - Today") << QUrl("timeline:/today") << false << true << QStringLiteral("Recently Saved") << false;
 350
 351     // devices
 352     QTest::newRow("Devices - Floppy") << QUrl("file:///media/floppy0") << false << false << QStringLiteral("Removable Devices") << false;
 353 }
 354
 355 void PlacesItemModelTest::testPlaceItem()
 356 {
 357     QFETCH(QUrl, url);
 358     QFETCH(bool, expectedIsHidden);
 359     QFETCH(bool, expectedIsSystemItem);
 360     QFETCH(QString, expectedGroup);
 361     QFETCH(bool, expectedStorageSetupNeeded);
 362
 363     const int index = indexOf(url);
 364     PlacesItem *item = m_model->placesItem(index);
 365     QCOMPARE(item->url(), url);
 366     QCOMPARE(item->isHidden(), expectedIsHidden);
 367     QCOMPARE(item->isSystemItem(), expectedIsSystemItem);
 368     QCOMPARE(item->group(), expectedGroup);
 369     QCOMPARE(item->storageSetupNeeded(), expectedStorageSetupNeeded);
 370 }
 371
 372 void PlacesItemModelTest::testDeletePlace()
 373 {
 374     const QUrl tempUrl = QUrl::fromLocalFile(QStandardPaths::writableLocation(QStandardPaths::TempLocation));
 375     QStringList urls = initialUrls();
 376     QSignalSpy itemsInsertedSpy(m_model, &PlacesItemModel::itemsInserted);
 377     QSignalSpy itemsRemovedSpy(m_model, &PlacesItemModel::itemsRemoved);
 378
 379     PlacesItemModel *model = new PlacesItemModel();
 380
 381     int tempDirIndex = 3;
 382     if (m_hasDesktopFolder) {
 383         tempDirIndex++;
 384     }
 385     if (m_hasDownloadsFolder) {
 386         tempDirIndex++;
 387     }
 388
 389     // create a new place
 390     createPlaceItem(QStringLiteral("Temporary Dir"), tempUrl, QString());
 391     urls.insert(tempDirIndex, tempUrl.toLocalFile());
 392
 393     // check if the new entry was created
 394     QTRY_COMPARE(itemsInsertedSpy.count(), 1);
 395     CHECK_PLACES_URLS(urls);
 396     QTRY_COMPARE(model->count(), m_model->count());
 397
 398     // delete item
 399     m_model->deleteItem(tempDirIndex);
 400
 401     // make sure that the new item is removed
 402     QTRY_COMPARE(itemsRemovedSpy.count(), 1);
 403     QTRY_COMPARE(m_model->count(), m_expectedModelCount);
 404     CHECK_PLACES_URLS(initialUrls());
 405     QTRY_COMPARE(model->count(), m_model->count());
 406 }
 407
 408 void PlacesItemModelTest::testTearDownDevice()
 409 {
 410     const QUrl mediaUrl = QUrl::fromLocalFile(QStringLiteral("/media/XO-Y4"));
 411     int index = indexOf(mediaUrl);
 412     QVERIFY(index != -1);
 413
 414     auto ejectAction = m_model->ejectAction(index);
 415     QVERIFY(!ejectAction);
 416
 417     auto teardownAction = m_model->teardownAction(index);
 418     QVERIFY(teardownAction);
 419
 420     QCOMPARE(m_model->count(), m_expectedModelCount);
 421
 422     QSignalSpy spyItemsRemoved(m_model, &PlacesItemModel::itemsRemoved);
 423     fakeManager()->call(QStringLiteral("unplug"), "/org/kde/solid/fakehw/volume_part1_size_993284096");
 424     QTRY_COMPARE(m_model->count(), m_expectedModelCount - 1);
 425     QCOMPARE(spyItemsRemoved.count(), 1);
 426     const QList<QVariant> spyItemsRemovedArgs = spyItemsRemoved.takeFirst();
 427     const KItemRangeList removedRange = spyItemsRemovedArgs.at(0).value<KItemRangeList>();
 428     QCOMPARE(removedRange.size(), 1);
 429     QCOMPARE(removedRange.first().index, index);
 430     QCOMPARE(removedRange.first().count, 1);
 431
 432     QCOMPARE(indexOf(mediaUrl), -1);
 433
 434     QSignalSpy spyItemsInserted(m_model, &PlacesItemModel::itemsInserted);
 435     fakeManager()->call(QStringLiteral("plug"), "/org/kde/solid/fakehw/volume_part1_size_993284096");
 436     QTRY_COMPARE(m_model->count(), m_expectedModelCount);
 437     QCOMPARE(spyItemsInserted.count(), 1);
 438     index = indexOf(mediaUrl);
 439
 440     const QList<QVariant> args = spyItemsInserted.takeFirst();
 441     const KItemRangeList insertedRange = args.at(0).value<KItemRangeList>();
 442     QCOMPARE(insertedRange.size(), 1);
 443     QCOMPARE(insertedRange.first().index, index);
 444     QCOMPARE(insertedRange.first().count, 1);
 445 }
 446
 447 void PlacesItemModelTest::testDefaultViewProperties_data()
 448 {
 449     QTest::addColumn<QUrl>("url");
 450     QTest::addColumn<DolphinView::Mode>("expectedViewMode");
 451     QTest::addColumn<bool>("expectedPreviewShow");
 452     QTest::addColumn<QList<QByteArray> >("expectedVisibleRole");
 453
 454     // places
 455     QTest::newRow("Places - Home") << QUrl::fromLocalFile(QDir::homePath()) << DolphinView::IconsView << true << QList<QByteArray>({"text"});
 456
 457     // baloo -search
 458     QTest::newRow("Baloo - Documents") << QUrl("search:/documents") << DolphinView::DetailsView << false << QList<QByteArray>({"text", "path"});
 459
 460     // audio files
 461     QTest::newRow("Places - Audio") << QUrl("search:/audio") << DolphinView::DetailsView << false << QList<QByteArray>({"text", "artist", "album"});
 462
 463     // baloo - timeline
 464     QTest::newRow("Baloo - Today") << QUrl("timeline:/today") << DolphinView::DetailsView << true << QList<QByteArray>({"text", "modificationtime"});
 465
 466     // devices
 467     QTest::newRow("Devices - Floppy") << QUrl("file:///media/floppy0") << DolphinView::IconsView << true << QList<QByteArray>({"text"});
 468
 469 }
 470
 471 void PlacesItemModelTest::testDefaultViewProperties()
 472 {
 473     QFETCH(QUrl, url);
 474     QFETCH(DolphinView::Mode, expectedViewMode);
 475     QFETCH(bool, expectedPreviewShow);
 476     QFETCH(QList<QByteArray>, expectedVisibleRole);
 477
 478     ViewProperties properties(KFilePlacesModel::convertedUrl(url));
 479     QCOMPARE(properties.viewMode(), expectedViewMode);
 480     QCOMPARE(properties.previewsShown(), expectedPreviewShow);
 481     QCOMPARE(properties.visibleRoles(), expectedVisibleRole);
 482 }
 483
 484 void PlacesItemModelTest::testClear()
 485 {
 486     QCOMPARE(m_model->count(), m_expectedModelCount);
 487     m_model->clear();
 488     QCOMPARE(m_model->count(), 0);
 489     QCOMPARE(m_model->hiddenCount(), 0);
 490     m_model->refresh();
 491     QTRY_COMPARE(m_model->count(), m_expectedModelCount);
 492 }
 493
 494 void PlacesItemModelTest::testHideItem()
 495 {
 496     const QUrl mediaUrl = QUrl::fromLocalFile(QStringLiteral("/media/XO-Y4"));
 497     const int index = indexOf(mediaUrl);
 498
 499     PlacesItem *item = m_model->placesItem(index);
 500
 501     QSignalSpy spyItemsRemoved(m_model, &PlacesItemModel::itemsRemoved);
 502     QList<QVariant> spyItemsRemovedArgs;
 503     KItemRangeList removedRange;
 504
 505     QSignalSpy spyItemsInserted(m_model, &PlacesItemModel::itemsInserted);
 506     QList<QVariant> spyItemsInsertedArgs;
 507     KItemRangeList insertedRange;
 508     QVERIFY(item);
 509
 510     // hide an item
 511     item->setHidden(true);
 512
 513     // check if items removed was fired
 514     QTRY_COMPARE(m_model->count(), m_expectedModelCount - 1);
 515     QCOMPARE(spyItemsRemoved.count(), 1);
 516     spyItemsRemovedArgs = spyItemsRemoved.takeFirst();
 517     removedRange = spyItemsRemovedArgs.at(0).value<KItemRangeList>();
 518     QCOMPARE(removedRange.size(), 1);
 519     QCOMPARE(removedRange.first().index, index);
 520     QCOMPARE(removedRange.first().count, 1);
 521
 522     // allow model to show hidden items
 523     m_model->setHiddenItemsShown(true);
 524
 525     // check if the items inserted was fired
 526     spyItemsInsertedArgs = spyItemsInserted.takeFirst();
 527     insertedRange = spyItemsInsertedArgs.at(0).value<KItemRangeList>();
 528     QCOMPARE(insertedRange.size(), 1);
 529     QCOMPARE(insertedRange.first().index, index);
 530     QCOMPARE(insertedRange.first().count, 1);
 531
 532     // mark item as visible
 533     item = m_model->placesItem(index);
 534     item->setHidden(false);
 535
 536      // mark model to hide invisible items
 537     m_model->setHiddenItemsShown(true);
 538
 539     QTRY_COMPARE(m_model->count(), m_expectedModelCount);
 540 }
 541
 542 void PlacesItemModelTest::testSystemItems()
 543 {
 544     int tempDirIndex = 3;
 545     if (m_hasDesktopFolder) {
 546         tempDirIndex++;
 547     }
 548     if (m_hasDownloadsFolder) {
 549         tempDirIndex++;
 550     }
 551
 552     QCOMPARE(m_model->count(), m_expectedModelCount);
 553     for (int r = 0; r < m_model->count(); r++) {
 554         QCOMPARE(m_model->placesItem(r)->isSystemItem(), !m_model->placesItem(r)->device().isValid());
 555     }
 556
 557     QSignalSpy itemsInsertedSpy(m_model, &PlacesItemModel::itemsInserted);
 558
 559     // create a new entry (non system item)
 560     createPlaceItem(QStringLiteral("Temporary Dir"),  QUrl::fromLocalFile(QStandardPaths::writableLocation(QStandardPaths::TempLocation)), QString());
 561
 562     // check if the new entry was created
 563     QTRY_COMPARE(itemsInsertedSpy.count(), 1);
 564
 565     // make sure the new place get removed
 566     schedulePlaceRemoval(tempDirIndex);
 567
 568     QList<QVariant> args = itemsInsertedSpy.takeFirst();
 569     KItemRangeList range = args.at(0).value<KItemRangeList>();
 570     QCOMPARE(range.first().index, tempDirIndex);
 571     QCOMPARE(range.first().count, 1);
 572     QVERIFY(!m_model->placesItem(tempDirIndex)->isSystemItem());
 573     QCOMPARE(m_model->count(), m_expectedModelCount + 1);
 574
 575     QTest::qWait(300);
 576     // check if the removal signal is correct
 577     QSignalSpy itemsRemovedSpy(m_model, &PlacesItemModel::itemsRemoved);
 578     m_model->deleteItem(tempDirIndex);
 579     QTRY_COMPARE(itemsRemovedSpy.count(), 1);
 580     args = itemsRemovedSpy.takeFirst();
 581     range = args.at(0).value<KItemRangeList>();
 582     QCOMPARE(range.first().index, tempDirIndex);
 583     QCOMPARE(range.first().count, 1);
 584     QTRY_COMPARE(m_model->count(), m_expectedModelCount);
 585
 586     //cancel removal (it was removed above)
 587     cancelPlaceRemoval(tempDirIndex);
 588 }
 589
 590 void PlacesItemModelTest::testEditBookmark()
 591 {
 592     int tempDirIndex = 1;
 593     if (m_hasDesktopFolder) {
 594         tempDirIndex++;
 595     }
 596     if (m_hasDownloadsFolder) {
 597         tempDirIndex++;
 598     }
 599
 600     QScopedPointer<PlacesItemModel> other(new PlacesItemModel());
 601
 602     createPlaceItem(QStringLiteral("Temporary Dir"), QUrl::fromLocalFile(QStandardPaths::writableLocation(QStandardPaths::TempLocation)), QString());
 603
 604     // make sure that the new item will be removed later
 605     schedulePlaceRemoval(tempDirIndex + 2);
 606
 607     QSignalSpy itemsChangedSply(m_model, &PlacesItemModel::itemsChanged);
 608
 609     // modify place text
 610     m_model->item(tempDirIndex)->setText(QStringLiteral("Renamed place"));
 611     m_model->refresh();
 612
 613     // check if the correct signal was fired
 614     QTRY_COMPARE(itemsChangedSply.count(), 1);
 615     QList<QVariant> args = itemsChangedSply.takeFirst();
 616     KItemRangeList range = args.at(0).value<KItemRangeList>();
 617     QCOMPARE(range.first().index, tempDirIndex);
 618     QCOMPARE(range.first().count, 1);
 619     QSet<QByteArray> roles = args.at(1).value<QSet<QByteArray> >();
 620     QCOMPARE(roles.size(), 1);
 621     QCOMPARE(*roles.begin(), QByteArrayLiteral("text"));
 622     QCOMPARE(m_model->item(tempDirIndex)->text(), QStringLiteral("Renamed place"));
 623
 624     // check if the item was updated in the other model
 625     QTRY_COMPARE(other->item(tempDirIndex)->text(), QStringLiteral("Renamed place"));
 626 }
 627
 628 void PlacesItemModelTest::testEditAfterCreation()
 629 {
 630     int tempDirIndex = 1;
 631     if (m_hasDesktopFolder) {
 632         tempDirIndex++;
 633     }
 634     if (m_hasDownloadsFolder) {
 635         tempDirIndex++;
 636     }
 637
 638     const QUrl tempUrl = QUrl::fromLocalFile(QStandardPaths::writableLocation(QStandardPaths::TempLocation));
 639     QSignalSpy itemsInsertedSpy(m_model, &PlacesItemModel::itemsInserted);
 640
 641     // create a new place
 642     createPlaceItem(QStringLiteral("Temporary Dir"), tempUrl, QString());
 643     QTRY_COMPARE(itemsInsertedSpy.count(), 1);
 644
 645     PlacesItemModel *model = new PlacesItemModel();
 646     QTRY_COMPARE(model->count(), m_model->count());
 647
 648     // make sure that the new item will be removed later
 649     schedulePlaceRemoval(tempDirIndex + 2);
 650
 651     // modify place text
 652     PlacesItem *item = m_model->placesItem(tempDirIndex);
 653     item->setText(QStringLiteral("Renamed place"));
 654     m_model->refresh();
 655
 656     // check if the second model got the changes
 657     QTRY_COMPARE(model->count(), m_model->count());
 658     QTRY_COMPARE(model->placesItem(tempDirIndex)->text(), m_model->placesItem(tempDirIndex)->text());
 659     QTRY_COMPARE(model->placesItem(tempDirIndex)->bookmark().metaDataItem(QStringLiteral("OnlyInApp")),
 660                  m_model->placesItem(tempDirIndex)->bookmark().metaDataItem(QStringLiteral("OnlyInApp")));
 661     QTRY_COMPARE(model->placesItem(tempDirIndex)->icon(), m_model->placesItem(tempDirIndex)->icon());
 662     QTRY_COMPARE(model->placesItem(tempDirIndex)->url(), m_model->placesItem(tempDirIndex)->url());
 663 }
 664
 665 void PlacesItemModelTest::testEditMetadata()
 666 {
 667     int tempDirIndex = 1;
 668     if (m_hasDesktopFolder) {
 669         tempDirIndex++;
 670     }
 671     if (m_hasDownloadsFolder) {
 672         tempDirIndex++;
 673     }
 674
 675     const QUrl tempUrl = QUrl::fromLocalFile(QStandardPaths::writableLocation(QStandardPaths::TempLocation));
 676     QSignalSpy itemsInsertedSpy(m_model, &PlacesItemModel::itemsInserted);
 677
 678     // create a new place
 679     createPlaceItem(QStringLiteral("Temporary Dir"), tempUrl, QString());
 680     QTRY_COMPARE(itemsInsertedSpy.count(), 1);
 681
 682     // check if the new entry was created
 683     PlacesItemModel *model = new PlacesItemModel();
 684     QTRY_COMPARE(model->count(), m_model->count());
 685
 686     // make sure that the new item will be removed later
 687     schedulePlaceRemoval(tempDirIndex + 2);
 688
 689     // modify place metadata
 690     PlacesItem *item = m_model->placesItem(tempDirIndex);
 691     item->bookmark().setMetaDataItem(QStringLiteral("OnlyInApp"), KAboutData::applicationData().componentName());
 692     m_model->refresh();
 693
 694     // check if the place was modified in both models
 695     QTRY_COMPARE(model->placesItem(tempDirIndex)->bookmark().metaDataItem(QStringLiteral("OnlyInApp")),
 696                  KAboutData::applicationData().componentName());
 697     QTRY_COMPARE(model->placesItem(tempDirIndex)->text(), m_model->placesItem(tempDirIndex)->text());
 698     QTRY_COMPARE(model->placesItem(tempDirIndex)->bookmark().metaDataItem(QStringLiteral("OnlyInApp")),
 699                  m_model->placesItem(tempDirIndex)->bookmark().metaDataItem(QStringLiteral("OnlyInApp")));
 700     QTRY_COMPARE(model->placesItem(tempDirIndex)->icon(), m_model->placesItem(tempDirIndex)->icon());
 701     QTRY_COMPARE(model->placesItem(tempDirIndex)->url(), m_model->placesItem(tempDirIndex)->url());
 702 }
 703
 704 void PlacesItemModelTest::testRefresh()
 705 {
 706     int tempDirIndex = 3;
 707     if (m_hasDesktopFolder) {
 708         tempDirIndex++;
 709     }
 710     if (m_hasDownloadsFolder) {
 711         tempDirIndex++;
 712     }
 713
 714     const QUrl tempUrl = QUrl::fromLocalFile(QStandardPaths::writableLocation(QStandardPaths::TempLocation));
 715     QSignalSpy itemsInsertedSpy(m_model, &PlacesItemModel::itemsInserted);
 716
 717     // create a new place
 718     createPlaceItem(QStringLiteral("Temporary Dir"), tempUrl, QString());
 719     QTRY_COMPARE(itemsInsertedSpy.count(), 1);
 720
 721     PlacesItemModel *model = new PlacesItemModel();
 722     QTRY_COMPARE(model->count(), m_model->count());
 723
 724     // make sure that the new item will be removed later
 725     schedulePlaceRemoval(tempDirIndex);
 726
 727     PlacesItem *item = m_model->placesItem(tempDirIndex);
 728     PlacesItem *sameItem = model->placesItem(tempDirIndex);
 729     QCOMPARE(item->text(), sameItem->text());
 730
 731     // modify place text
 732     item->setText(QStringLiteral("Renamed place"));
 733
 734     // item from another model is not affected at the moment
 735     QVERIFY(item->text() != sameItem->text());
 736
 737     // propagate change
 738     m_model->refresh();
 739
 740     // item must be equal
 741     QTRY_COMPARE(item->text(), sameItem->text());
 742 }
 743
 744 void PlacesItemModelTest::testIcons_data()
 745 {
 746     QTest::addColumn<QUrl>("url");
 747     QTest::addColumn<QString>("expectedIconName");
 748
 749     // places
 750     QTest::newRow("Places - Home") << QUrl::fromLocalFile(QDir::homePath()) << QStringLiteral("user-home");
 751
 752     // baloo -search
 753     QTest::newRow("Baloo - Documents") << QUrl("search:/documents") << QStringLiteral("folder-text");
 754
 755     // baloo - timeline
 756     QTest::newRow("Baloo - Today") << QUrl("timeline:/today") << QStringLiteral("go-jump-today");
 757
 758     // devices
 759     QTest::newRow("Devices - Floppy") << QUrl("file:///media/floppy0") << QStringLiteral("blockdevice");
 760 }
 761
 762 void PlacesItemModelTest::testIcons()
 763 {
 764     QFETCH(QUrl, url);
 765     QFETCH(QString, expectedIconName);
 766
 767     PlacesItem *item = m_model->placesItem(indexOf(url));
 768     QCOMPARE(item->icon(), expectedIconName);
 769
 770     for (int r = 0; r < m_model->count(); r++) {
 771         QVERIFY(!m_model->placesItem(r)->icon().isEmpty());
 772     }
 773 }
 774
 775 void PlacesItemModelTest::testDragAndDrop()
 776 {
 777     int lastIndex = 2; // last index of places group
 778     if (m_hasDesktopFolder) {
 779         lastIndex++;
 780     }
 781     if (m_hasDownloadsFolder) {
 782         lastIndex++;
 783     }
 784
 785     QList<QVariant> args;
 786     KItemRangeList range;
 787     QStringList urls = initialUrls();
 788     QSignalSpy itemsInsertedSpy(m_model, &PlacesItemModel::itemsInserted);
 789     QSignalSpy itemsRemovedSpy(m_model, &PlacesItemModel::itemsRemoved);
 790
 791     CHECK_PLACES_URLS(initialUrls());
 792     // Move the home directory to the end of the places group
 793     QMimeData *dropData = createMimeData(QList<int>() << 0);
 794     m_model->dropMimeDataBefore(m_model->count() - 1, dropData);
 795     urls.move(0, lastIndex);
 796     delete dropData;
 797
 798     QTRY_COMPARE(itemsInsertedSpy.count(), 1);
 799     QTRY_COMPARE(itemsRemovedSpy.count(), 1);
 800
 801     // remove item from actual position
 802     args = itemsRemovedSpy.takeFirst();
 803     range = args.at(0).value<KItemRangeList>();
 804     QCOMPARE(range.size(), 1);
 805     QCOMPARE(range.at(0).count, 1);
 806     QCOMPARE(range.at(0).index, 0);
 807
 808     // insert intem in his group
 809     args = itemsInsertedSpy.takeFirst();
 810     range = args.at(0).value<KItemRangeList>();
 811     QCOMPARE(range.size(), 1);
 812     QCOMPARE(range.at(0).count, 1);
 813     QCOMPARE(range.at(0).index, lastIndex);
 814
 815     CHECK_PLACES_URLS(urls);
 816
 817     itemsInsertedSpy.clear();
 818     itemsRemovedSpy.clear();
 819
 820     // Move home directory item back to its original position
 821     dropData = createMimeData(QList<int>() << lastIndex);
 822     m_model->dropMimeDataBefore(0, dropData);
 823     urls.move(lastIndex, 0);
 824     delete dropData;
 825
 826     QTRY_COMPARE(itemsInsertedSpy.count(), 1);
 827     QTRY_COMPARE(itemsRemovedSpy.count(), 1);
 828
 829     // remove item from actual position
 830     args = itemsRemovedSpy.takeFirst();
 831     range = args.at(0).value<KItemRangeList>();
 832     QCOMPARE(range.size(), 1);
 833     QCOMPARE(range.at(0).count, 1);
 834     QCOMPARE(range.at(0).index, lastIndex);
 835
 836     // insert intem in the requested position
 837     args = itemsInsertedSpy.takeFirst();
 838     range = args.at(0).value<KItemRangeList>();
 839     QCOMPARE(range.size(), 1);
 840     QCOMPARE(range.at(0).count, 1);
 841     QCOMPARE(range.at(0).index, 0);
 842
 843     CHECK_PLACES_URLS(urls);
 844 }
 845
 846 void PlacesItemModelTest::testHideDevices()
 847 {
 848     QSignalSpy itemsRemoved(m_model, &PlacesItemModel::itemsRemoved);
 849     QStringList urls = initialUrls();
 850
 851     m_model->setGroupHidden(KFilePlacesModel::RemovableDevicesType, true);
 852     QTRY_VERIFY(m_model->isGroupHidden(KFilePlacesModel::RemovableDevicesType));
 853     QTRY_COMPARE(itemsRemoved.count(), 3);
 854
 855     // remove removable-devices
 856     urls.removeOne(QStringLiteral("/media/floppy0"));
 857     urls.removeOne(QStringLiteral("/media/XO-Y4"));
 858     urls.removeOne(QStringLiteral("/media/cdrom"));
 859
 860     // check if the correct urls was removed
 861     CHECK_PLACES_URLS(urls);
 862
 863     delete m_model;
 864     m_model = new PlacesItemModel();
 865     QTRY_COMPARE(m_model->count(), urls.count());
 866     CHECK_PLACES_URLS(urls);
 867
 868     // revert changes
 869     m_model->setGroupHidden(KFilePlacesModel::RemovableDevicesType, false);
 870     urls = initialUrls();
 871     QTRY_COMPARE(m_model->count(), urls.count());
 872     CHECK_PLACES_URLS(urls);
 873 }
 874
 875 void PlacesItemModelTest::testDuplicatedEntries()
 876 {
 877     QStringList urls = initialUrls();
 878     // create a duplicated entry on bookmark
 879     KBookmarkManager *bookmarkManager = KBookmarkManager::managerForFile(bookmarksFile(), QStringLiteral("kfilePlaces"));
 880     KBookmarkGroup root = bookmarkManager->root();
 881     KBookmark bookmark = root.addBookmark(QStringLiteral("Duplicated Search Videos"), QUrl("search:/videos"), {});
 882
 883     const QString id = QUuid::createUuid().toString();
 884     bookmark.setMetaDataItem(QStringLiteral("ID"), id);
 885     bookmark.setMetaDataItem(QStringLiteral("OnlyInApp"), KAboutData::applicationData().componentName());
 886     bookmarkManager->emitChanged(bookmarkManager->root());
 887
 888     PlacesItemModel *newModel = new PlacesItemModel();
 889     QTRY_COMPARE(placesUrls(newModel).count(QStringLiteral("search:/videos")), 1);
 890     QTRY_COMPARE(urls, placesUrls(newModel));
 891     delete newModel;
 892 }
 893
 894 void PlacesItemModelTest::renameAfterCreation()
 895 {
 896     int tempDirIndex = 1;
 897     if (m_hasDesktopFolder) {
 898         tempDirIndex++;
 899     }
 900     if (m_hasDownloadsFolder) {
 901         tempDirIndex++;
 902     }
 903
 904     const QUrl tempUrl = QUrl::fromLocalFile(QStandardPaths::writableLocation(QStandardPaths::TempLocation));
 905     QStringList urls = initialUrls();
 906     PlacesItemModel *model = new PlacesItemModel();
 907
 908     CHECK_PLACES_URLS(urls);
 909     QTRY_COMPARE(model->count(), m_model->count());
 910
 911     // create a new place
 912     createPlaceItem(QStringLiteral("Temporary Dir"), tempUrl, QString());
 913     urls.insert(tempDirIndex + 2, tempUrl.toLocalFile());
 914
 915     // make sure that the new item will be removed later
 916     schedulePlaceRemoval(tempDirIndex + 2);
 917
 918     CHECK_PLACES_URLS(urls);
 919     QCOMPARE(model->count(), m_model->count());
 920
 921
 922     // modify place text
 923     QSignalSpy changedSpy(m_model, &PlacesItemModel::itemsChanged);
 924
 925     PlacesItem *item = m_model->placesItem(tempDirIndex);
 926     item->setText(QStringLiteral("New Temporary Dir"));
 927     item->setUrl(item->url());
 928     item->setIcon(item->icon());
 929     m_model->refresh();
 930
 931     QTRY_COMPARE(changedSpy.count(), 1);
 932
 933     // check if the place was modified in both models
 934     QTRY_COMPARE(m_model->placesItem(tempDirIndex)->text(), QStringLiteral("New Temporary Dir"));
 935     QTRY_COMPARE(model->placesItem(tempDirIndex)->text(), QStringLiteral("New Temporary Dir"));
 936 }
 937
 938 QTEST_MAIN(PlacesItemModelTest)
 939
 940 #include "placesitemmodeltest.moc"