Merge lp:~osomon/unity-2d/listaggregatormodel-unittests into lp:unity-2d/3.0

[Olivier Tilloy]

[libunity-2d] Unit test the ListAggregatorModel class.

[Florian Boucault (fboucault)]

Awesome work.

Trivial conflict remaining in .bzrignore. Please merge once resolved.

review: Approve

[lp:~osomon/unity-2d/listaggregatormodel-unittests]

599. By Olivier Tilloy on 2011-06-15

Merged the latest changes from the trunk, thus resolving a minor conflict.

=== modified file '.bzrignore'
--- .bzrignore	2011-06-15 13:10:39 +0000
+++ .bzrignore	2011-06-15 14:43:29 +0000
@@ -21,9 +21,11 @@
 panel/applets/indicator-config.h
 panel/applets/registraradaptor.*
 panel/lib/libuqpanel.so*
+panel/tests/Testing
 panel/tests/homebuttonapplettest
 
 libunity-2d-private/src/libunity-2d-private.so.*
+libunity-2d-private/tests/Testing
 libunity-2d-private/tests/config-test.h
 libunity-2d-private/tests/gnomesessionclienttest.sh
 libunity-2d-private/tests/gnomesessionclienttesthelper
@@ -34,6 +36,7 @@
 libunity-2d-private/tests/mouseareademo
 libunity-2d-private/tests/paneltest
 libunity-2d-private/tests/unity2dtrtest
+libunity-2d-private/tests/listaggregatormodeltest
 libunity-2d-private/Unity2d/qrc_launchermenu.cxx
 
 po/*.gmo

=== modified file 'libunity-2d-private/Unity2d/listaggregatormodel.cpp'
--- libunity-2d-private/Unity2d/listaggregatormodel.cpp	2011-06-09 16:16:36 +0000
+++ libunity-2d-private/Unity2d/listaggregatormodel.cpp	2011-06-15 14:43:29 +0000
@@ -38,13 +38,21 @@
 void
 ListAggregatorModel::appendModel(const QVariant& model)
 {
+    static const char* errorMsg = "Unable to append a model that is not of type QAbstractListModel.";
+    if (!model.isValid()) {
+        UQ_WARNING << errorMsg << "Invalid model.";
+        return;
+    }
     QObject* object = qvariant_cast<QObject*>(model);
+    if (object == NULL) {
+        UQ_WARNING << errorMsg << model << "is of type" << model.typeName();
+        return;
+    }
     QAbstractItemModel* list = qobject_cast<QAbstractListModel*>(object);
     if (list == NULL) {
         list = qobject_cast<QSortFilterProxyModel*>(object);
         if (list == NULL) {
-            UQ_WARNING << "Unable to append model that is not of type QAbstractListModel."
-                       << object->objectName() << "is of type" << object->metaObject()->className();
+            UQ_WARNING << errorMsg << object->objectName() << "is of type" << object->metaObject()->className();
             return;
         }
     }

=== modified file 'libunity-2d-private/Unity2d/listaggregatormodel.h'
--- libunity-2d-private/Unity2d/listaggregatormodel.h	2011-06-09 16:16:36 +0000
+++ libunity-2d-private/Unity2d/listaggregatormodel.h	2011-06-15 14:43:29 +0000
@@ -41,6 +41,9 @@
     ListAggregatorModel(QObject* parent = 0);
     ~ListAggregatorModel();
 
+    /* Allow test fixtures to access protected and private members. */
+    friend class ListAggregatorModelTest;
+
     QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const;
     Q_INVOKABLE int rowCount(const QModelIndex& parent = QModelIndex()) const;
     Q_INVOKABLE QVariant get(int row) const;

=== modified file 'libunity-2d-private/tests/CMakeLists.txt'
--- libunity-2d-private/tests/CMakeLists.txt	2011-06-07 16:34:46 +0000
+++ libunity-2d-private/tests/CMakeLists.txt	2011-06-15 14:43:29 +0000
@@ -37,6 +37,7 @@
     paneltest
     unity2dtrtest
     launchermenutest
+    listaggregatormodeltest
     )
 
 add_custom_target(unity2dtr_po COMMAND

=== added file 'libunity-2d-private/tests/listaggregatormodeltest.cpp'
--- libunity-2d-private/tests/listaggregatormodeltest.cpp	1970-01-01 00:00:00 +0000
+++ libunity-2d-private/tests/listaggregatormodeltest.cpp	2011-06-15 14:43:29 +0000
@@ -0,0 +1,381 @@
+/*
+ * Copyright (C) 2011 Canonical, Ltd.
+ *
+ * Authors:
+ *  Olivier Tilloy <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+// local
+#include <listaggregatormodel.h>
+
+// Qt
+#include <QTest>
+#include <QStringListModel>
+#include <QSignalSpy>
+#include <QModelIndex>
+#include <QSortFilterProxyModel>
+#include <QAbstractListModel>
+
+class QMovableStringListModel : public QAbstractListModel
+{
+    Q_OBJECT
+
+public:
+    QMovableStringListModel(const QStringList& lst, QObject* parent = 0)
+        : QAbstractListModel(parent)
+        , m_lst(lst)
+    {
+    }
+
+    int rowCount(const QModelIndex& parent = QModelIndex()) const
+    {
+        return m_lst.size();
+    }
+
+    QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const
+    {
+        if (!index.isValid() || index.row() < 0 || index.row() >= m_lst.size()) {
+           return QVariant();
+        }
+        return QVariant(m_lst[index.row()]);
+    }
+
+    Q_INVOKABLE void move(int from, int to)
+    {
+        if (from < 0 || from >= m_lst.size() || to < 0 || to >= m_lst.size() || from == to) {
+            return;
+        }
+        QModelIndex parent;
+        beginMoveRows(parent, from, from, parent, to + (to > from ? 1 : 0));
+        m_lst.move(from, to);
+        endMoveRows();
+    }
+
+private:
+    QStringList m_lst;
+};
+
+class ListAggregatorModelTest : public QObject
+{
+    Q_OBJECT
+
+private Q_SLOTS:
+
+    void testRoleNames()
+    {
+        ListAggregatorModel model;
+        const QHash<int, QByteArray> roleNames = model.roleNames();
+        QCOMPARE(roleNames.size(), 1);
+        QVERIFY(roleNames.contains(0));
+        QCOMPARE(roleNames[0], QByteArray("item"));
+    }
+
+    void testAppendModelWrongType()
+    {
+        ListAggregatorModel model;
+        QVERIFY(model.m_models.isEmpty());
+        QTest::ignoreMessage(QtWarningMsg, "void ListAggregatorModel::appendModel(const QVariant&): Unable to append a model that is not of type QAbstractListModel. Invalid model. ");
+        model.appendModel(QVariant());
+        QVERIFY(model.m_models.isEmpty());
+        QTest::ignoreMessage(QtWarningMsg, "void ListAggregatorModel::appendModel(const QVariant&): Unable to append a model that is not of type QAbstractListModel. QVariant(bool, true) is of type bool ");
+        model.appendModel(QVariant(true));
+        QVERIFY(model.m_models.isEmpty());
+        QTest::ignoreMessage(QtWarningMsg, "void ListAggregatorModel::appendModel(const QVariant&): Unable to append a model that is not of type QAbstractListModel. \"\" is of type QObject ");
+        model.appendModel(QVariant::fromValue(new QObject));
+        QVERIFY(model.m_models.isEmpty());
+    }
+
+    void testAggregateListModel()
+    {
+        ListAggregatorModel model;
+        QVERIFY(model.m_models.isEmpty());
+        QCOMPARE(model.rowCount(), 0);
+
+        qRegisterMetaType<QModelIndex>("QModelIndex");
+        QSignalSpy spyOnRowsAboutToBeInserted(&model, SIGNAL(rowsAboutToBeInserted(const QModelIndex&, int, int)));
+        QSignalSpy spyOnRowsInserted(&model, SIGNAL(rowsInserted(const QModelIndex&, int, int)));
+        QList<QVariant> signal;
+
+        QStringListModel list1(QStringList() << "aa" << "ab" << "ac");
+        model.aggregateListModel(&list1);
+        QCOMPARE(model.m_models.size(), 1);
+        QCOMPARE(qobject_cast<QStringListModel*>(model.m_models[0]), &list1);
+        QCOMPARE(model.rowCount(), 3);
+        QCOMPARE(spyOnRowsAboutToBeInserted.count(), 1);
+        signal = spyOnRowsAboutToBeInserted.takeFirst();
+        QCOMPARE(signal[1].toInt(), 0);
+        QCOMPARE(signal[2].toInt(), 2);
+        QCOMPARE(spyOnRowsInserted.count(), 1);
+        signal = spyOnRowsInserted.takeFirst();
+        QCOMPARE(signal[1].toInt(), 0);
+        QCOMPARE(signal[2].toInt(), 2);
+
+        QStringListModel list2(QStringList() << "ba" << "bb" << "bc" << "bd");
+        model.aggregateListModel(&list2);
+        QCOMPARE(model.m_models.size(), 2);
+        QCOMPARE(qobject_cast<QStringListModel*>(model.m_models[1]), &list2);
+        QCOMPARE(model.rowCount(), 7);
+        QCOMPARE(spyOnRowsAboutToBeInserted.count(), 1);
+        signal = spyOnRowsAboutToBeInserted.takeFirst();
+        QCOMPARE(signal[1].toInt(), 3);
+        QCOMPARE(signal[2].toInt(), 6);
+        QCOMPARE(spyOnRowsInserted.count(), 1);
+        signal = spyOnRowsInserted.takeFirst();
+        QCOMPARE(signal[1].toInt(), 3);
+        QCOMPARE(signal[2].toInt(), 6);
+    }
+
+    void testRemoveListModel()
+    {
+        ListAggregatorModel model;
+
+        qRegisterMetaType<QModelIndex>("QModelIndex");
+        QSignalSpy spyOnRowsAboutToBeRemoved(&model, SIGNAL(rowsAboutToBeRemoved(const QModelIndex&, int, int)));
+        QSignalSpy spyOnRowsRemoved(&model, SIGNAL(rowsRemoved(const QModelIndex&, int, int)));
+        QList<QVariant> signal;
+
+        QStringListModel list1(QStringList() << "aa" << "ab" << "ac");
+        model.aggregateListModel(&list1);
+        QStringListModel list2(QStringList() << "ba" << "bb" << "bc" << "bd");
+        model.aggregateListModel(&list2);
+        QStringListModel list3(QStringList() << "ca" << "cb");
+        model.aggregateListModel(&list3);
+
+        model.removeListModel(&list2);
+        QCOMPARE(model.m_models.size(), 2);
+        QCOMPARE(qobject_cast<QStringListModel*>(model.m_models[0]), &list1);
+        QCOMPARE(qobject_cast<QStringListModel*>(model.m_models[1]), &list3);
+        QCOMPARE(model.rowCount(), 5);
+        QCOMPARE(spyOnRowsAboutToBeRemoved.count(), 1);
+        signal = spyOnRowsAboutToBeRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 3);
+        QCOMPARE(signal[2].toInt(), 6);
+        QCOMPARE(spyOnRowsRemoved.count(), 1);
+        signal = spyOnRowsRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 3);
+        QCOMPARE(signal[2].toInt(), 6);
+    }
+
+    void testData()
+    {
+        ListAggregatorModel model;
+        model.aggregateListModel(new QStringListModel(QStringList() << "aa" << "ab" << "ac", &model));
+        model.aggregateListModel(new QStringListModel(QStringList() << "ba" << "bb" << "bc" << "bd", &model));
+        model.aggregateListModel(new QStringListModel(QStringList() << "ca" << "cb", &model));
+        QStringList data = QStringList() << "aa" << "ab" << "ac" << "ba" << "bb" << "bc" << "bd" << "ca" << "cb";
+        for (int i = 0; i < model.rowCount(); ++i) {
+            QCOMPARE(model.data(model.index(i)).toString(), data[i]);
+        }
+    }
+
+    void testGet()
+    {
+        ListAggregatorModel model;
+        model.aggregateListModel(new QStringListModel(QStringList() << "aa" << "ab" << "ac", &model));
+        model.aggregateListModel(new QStringListModel(QStringList() << "ba" << "bb" << "bc" << "bd", &model));
+        model.aggregateListModel(new QStringListModel(QStringList() << "ca" << "cb", &model));
+        QStringList data = QStringList() << "aa" << "ab" << "ac" << "ba" << "bb" << "bc" << "bd" << "ca" << "cb";
+        for (int i = 0; i < model.rowCount(); ++i) {
+            QCOMPARE(model.get(i).toString(), data[i]);
+        }
+    }
+
+    void testComputeOffset()
+    {
+        ListAggregatorModel model;
+        QStringListModel list1(QStringList() << "aa" << "ab" << "ac");
+        model.aggregateListModel(&list1);
+        QStringListModel list2(QStringList() << "ba" << "bb" << "bc" << "bd");
+        model.aggregateListModel(&list2);
+        QStringListModel list3(QStringList() << "ca" << "cb");
+        model.aggregateListModel(&list3);
+
+        QCOMPARE(model.computeOffset(&list1), 0);
+        QCOMPARE(model.computeOffset(&list2), 3);
+        QCOMPARE(model.computeOffset(&list3), 7);
+    }
+
+    void testModelAtIndex()
+    {
+        ListAggregatorModel model;
+        QStringListModel list1(QStringList() << "aa" << "ab" << "ac");
+        model.aggregateListModel(&list1);
+        QStringListModel list2(QStringList() << "ba" << "bb" << "bc" << "bd");
+        model.aggregateListModel(&list2);
+        QStringListModel list3(QStringList() << "ca" << "cb");
+        model.aggregateListModel(&list3);
+
+        QCOMPARE(model.modelAtIndex(0), &list1);
+        QCOMPARE(model.modelAtIndex(1), &list1);
+        QCOMPARE(model.modelAtIndex(2), &list1);
+        QCOMPARE(model.modelAtIndex(3), &list2);
+        QCOMPARE(model.modelAtIndex(4), &list2);
+        QCOMPARE(model.modelAtIndex(5), &list2);
+        QCOMPARE(model.modelAtIndex(6), &list2);
+        QCOMPARE(model.modelAtIndex(7), &list3);
+        QCOMPARE(model.modelAtIndex(8), &list3);
+    }
+
+    void testRemoveRows()
+    {
+        ListAggregatorModel model;
+
+        qRegisterMetaType<QModelIndex>("QModelIndex");
+        QSignalSpy spyOnRowsAboutToBeRemoved(&model, SIGNAL(rowsAboutToBeRemoved(const QModelIndex&, int, int)));
+        QSignalSpy spyOnRowsRemoved(&model, SIGNAL(rowsRemoved(const QModelIndex&, int, int)));
+        QList<QVariant> signal;
+
+        model.aggregateListModel(new QStringListModel(QStringList() << "aa" << "ab" << "ac", &model));
+        model.aggregateListModel(new QStringListModel(QStringList() << "ba" << "bb" << "bc" << "bd", &model));
+        model.aggregateListModel(new QStringListModel(QStringList() << "ca" << "cb", &model));
+
+        // Invalid boundaries, doesn’t remove anything.
+        QVERIFY(!model.removeRows(-1, 2));
+        QCOMPARE(model.rowCount(), 9);
+        QCOMPARE(spyOnRowsAboutToBeRemoved.count(), 0);
+        QCOMPARE(spyOnRowsRemoved.count(), 0);
+        QVERIFY(!model.removeRows(10, 2));
+        QCOMPARE(model.rowCount(), 9);
+        QCOMPARE(spyOnRowsAboutToBeRemoved.count(), 0);
+        QCOMPARE(spyOnRowsRemoved.count(), 0);
+        QVERIFY(!model.removeRows(2, 0));
+        QCOMPARE(model.rowCount(), 9);
+        QCOMPARE(spyOnRowsAboutToBeRemoved.count(), 0);
+        QCOMPARE(spyOnRowsRemoved.count(), 0);
+
+        // Remove two rows from the beginning, only modifies the first model.
+        QVERIFY(model.removeRows(0, 2));
+        QCOMPARE(model.rowCount(), 7);
+        QCOMPARE(spyOnRowsAboutToBeRemoved.count(), 1);
+        signal = spyOnRowsAboutToBeRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 0);
+        QCOMPARE(signal[2].toInt(), 1);
+        QCOMPARE(spyOnRowsRemoved.count(), 1);
+        signal = spyOnRowsRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 0);
+        QCOMPARE(signal[2].toInt(), 1);
+        checkModelData(&model, QStringList() << "ac" << "ba" << "bb" << "bc" << "bd" << "ca" << "cb");
+
+        // Request to remove three rows starting from the last index,
+        // only one row is actually removed.
+        QVERIFY(model.removeRows(6, 3));
+        QCOMPARE(model.rowCount(), 6);
+        QCOMPARE(spyOnRowsAboutToBeRemoved.count(), 1);
+        signal = spyOnRowsAboutToBeRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 6);
+        QCOMPARE(signal[2].toInt(), 6);
+        QCOMPARE(spyOnRowsRemoved.count(), 1);
+        signal = spyOnRowsRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 6);
+        QCOMPARE(signal[2].toInt(), 6);
+        checkModelData(&model, QStringList() << "ac" << "ba" << "bb" << "bc" << "bd" << "ca");
+
+        // Remove rows that span two models.
+        QVERIFY(model.removeRows(3, 3));
+        QCOMPARE(model.rowCount(), 3);
+        QCOMPARE(spyOnRowsAboutToBeRemoved.count(), 2);
+        signal = spyOnRowsAboutToBeRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 3);
+        QCOMPARE(signal[2].toInt(), 4);
+        signal = spyOnRowsAboutToBeRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 3);
+        QCOMPARE(signal[2].toInt(), 3);
+        QCOMPARE(spyOnRowsRemoved.count(), 2);
+        signal = spyOnRowsRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 3);
+        QCOMPARE(signal[2].toInt(), 4);
+        signal = spyOnRowsRemoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 3);
+        QCOMPARE(signal[2].toInt(), 3);
+        checkModelData(&model, QStringList() << "ac" << "ba" << "bb");
+    }
+
+    void testMove()
+    {
+        ListAggregatorModel model;
+
+        qRegisterMetaType<QModelIndex>("QModelIndex");
+        QSignalSpy spyOnRowsAboutToBeMoved(&model, SIGNAL(rowsAboutToBeMoved(const QModelIndex&, int, int, const QModelIndex&, int)));
+        QSignalSpy spyOnRowsMoved(&model, SIGNAL(rowsMoved(const QModelIndex&, int, int, const QModelIndex&, int)));
+        QList<QVariant> signal;
+
+        model.aggregateListModel(new QStringListModel(QStringList() << "aa" << "ab" << "ac", &model));
+        model.aggregateListModel(new QMovableStringListModel(QStringList() << "ba" << "bb" << "bc" << "bd", &model));
+        QStringListModel proxiedModel(QStringList() << "ca" << "cb");
+        QSortFilterProxyModel proxyModel;
+        proxyModel.setSourceModel(&proxiedModel);
+        model.aggregateListModel(&proxyModel);
+
+        // Moving rows from one model to another is forbidden.
+        QTest::ignoreMessage(QtWarningMsg, "void ListAggregatorModel::move(int, int): cannot move an item from one model to another ");
+        model.move(1, 5);
+        QCOMPARE(spyOnRowsAboutToBeMoved.count(), 0);
+        QCOMPARE(spyOnRowsMoved.count(), 0);
+        checkModelData(&model, QStringList() << "aa" << "ab" << "ac" << "ba" << "bb" << "bc" << "bd" << "ca" << "cb");
+
+        // Cannot move rows in a QSortFilterProxyModel.
+        QTest::ignoreMessage(QtWarningMsg, "void ListAggregatorModel::move(int, int): cannot move the items of a QSortFilterProxyModel ");
+        model.move(8, 7);
+        QCOMPARE(spyOnRowsAboutToBeMoved.count(), 0);
+        QCOMPARE(spyOnRowsMoved.count(), 0);
+        checkModelData(&model, QStringList() << "aa" << "ab" << "ac" << "ba" << "bb" << "bc" << "bd" << "ca" << "cb");
+
+        // 'move' is not defined for a QStringListModel, won’t have any effect.
+        QTest::ignoreMessage(QtWarningMsg, "QMetaObject::invokeMethod: No such method QStringListModel::move(int,int)");
+        model.move(0, 2);
+        QCOMPARE(spyOnRowsAboutToBeMoved.count(), 0);
+        QCOMPARE(spyOnRowsMoved.count(), 0);
+        checkModelData(&model, QStringList() << "aa" << "ab" << "ac" << "ba" << "bb" << "bc" << "bd" << "ca" << "cb");
+
+        // Actually move rows in a model that supports the operation.
+        model.move(4, 6);
+        QCOMPARE(spyOnRowsAboutToBeMoved.count(), 1);
+        signal = spyOnRowsAboutToBeMoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 4);
+        QCOMPARE(signal[2].toInt(), 4);
+        QCOMPARE(signal[4].toInt(), 7);
+        QCOMPARE(spyOnRowsMoved.count(), 1);
+        signal = spyOnRowsMoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 4);
+        QCOMPARE(signal[2].toInt(), 4);
+        QCOMPARE(signal[4].toInt(), 7);
+        checkModelData(&model, QStringList() << "aa" << "ab" << "ac" << "ba" << "bc" << "bd" << "bb" << "ca" << "cb");
+        model.move(5, 4);
+        QCOMPARE(spyOnRowsAboutToBeMoved.count(), 1);
+        signal = spyOnRowsAboutToBeMoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 5);
+        QCOMPARE(signal[2].toInt(), 5);
+        QCOMPARE(signal[4].toInt(), 4);
+        QCOMPARE(spyOnRowsMoved.count(), 1);
+        signal = spyOnRowsMoved.takeFirst();
+        QCOMPARE(signal[1].toInt(), 5);
+        QCOMPARE(signal[2].toInt(), 5);
+        QCOMPARE(signal[4].toInt(), 4);
+        checkModelData(&model, QStringList() << "aa" << "ab" << "ac" << "ba" << "bd" << "bc" << "bb" << "ca" << "cb");
+    }
+
+private:
+    void checkModelData(ListAggregatorModel* model, const QStringList& data)
+    {
+        for (int i = 0; i < model->rowCount(); ++i) {
+            QCOMPARE(model->get(i).toString(), data[i]);
+        }
+    }
+};
+
+QTEST_MAIN(ListAggregatorModelTest)
+
+#include "listaggregatormodeltest.moc"
+