Fix isPC property of Unity/Platform plugin

- Also add tests

Author: pete-woods

CMakeLists.txt

@@ -69,6 +69,7 @@ find_package(Qt5Gui 5.6 REQUIRED)
 find_package(Qt5DBus 5.6 REQUIRED)
 find_package(Qt5Concurrent 5.6 REQUIRED)
 find_package(Qt5Sql 5.6 REQUIRED)
+find_package(Qt5Test 5.6 REQUIRED)
 
 pkg_check_modules(APPLICATION_API REQUIRED unity-shell-application=27)
 pkg_check_modules(GEONAMES REQUIRED geonames>=0.2)
@@ -79,6 +80,10 @@ pkg_check_modules(QMENUMODEL REQUIRED qmenumodel)
 pkg_check_modules(GD3 REQUIRED gnome-desktop-3.0)
 pkg_check_modules(UAL REQUIRED ubuntu-app-launch-3)
 pkg_check_modules(UBUNTUGESTURES REQUIRED UbuntuGestures)
+pkg_check_modules(QTDBUSTEST REQUIRED
+    libqtdbustest-1
+    libqtdbusmock-1
+    )
 
 ### Check UbuntuGestures private headers. No pkg-config (.pc) file is provided for them
 find_path(UBUNTUGESTUREPRIV

debian/control

@@ -29,6 +29,8 @@ Build-Depends: cmake,
                libpam0g-dev,
                libpulse-dev,
                libqmenumodel-dev (>= 0.2.12),
+               libqtdbusmock1-dev (>= 0.7),
+               libqtdbustest1-dev,
                libqt5svg5-dev,
                libqt5xmlpatterns5-dev,
                libsystemsettings-dev,

plugins/Unity/Platform/platform.cpp

@@ -17,9 +17,11 @@
 #include "platform.h"
 
 #include <QDBusConnection>
+#include <QSet>
+#include <QString>
 
 Platform::Platform(QObject *parent)
-    : QObject(parent)
+    : QObject(parent), m_isPC(true), m_isMultiSession(true)
 {
     QMetaObject::invokeMethod(this, "init");
 }
@@ -31,8 +33,13 @@ void Platform::init()
     QDBusInterface seatIface("org.freedesktop.login1", "/org/freedesktop/login1/seat/self", "org.freedesktop.login1.Seat",
                              QDBusConnection::systemBus(), this);
 
+    // From the docs at https://www.freedesktop.org/wiki/Software/systemd/hostnamed/
+    // the options are "desktop", "laptop", "server", "tablet", "handset", as well
+    // as the special chassis types "vm" and "container".
     m_chassis = iface.property("Chassis").toString();
-    m_isPC = (m_chassis == "desktop" || m_chassis == "laptop" || m_chassis == "server");
+
+    // A PC is not a phone or tablet.
+    m_isPC = !QSet<QString>{"handset", "tablet"}.contains(m_chassis);
     m_isMultiSession = seatIface.property("CanMultiSession").toBool() && seatIface.property("CanGraphical").toBool();
 }
 

tests/CMakeLists.txt

@@ -20,6 +20,7 @@ add_subdirectory(uqmlscene)
 # Use our custom implementation of qmlscene and import dbus-test-runner
 add_executable(qmlscene ALIAS uqmlscene)
 import_executables(dbus-test-runner)
+import_executables(qdbus-simple-test-runner)
 
 set(UNITY_PLUGINPATH "${CMAKE_BINARY_DIR}/plugins" CACHE PATH "Path to pre-built unity8 plugin dir.")
 set(UNITY_MOCKPATH "${CMAKE_BINARY_DIR}/tests/mocks" CACHE PATH "Path to pre-built unity8 mock dir.")

tests/plugins/Unity/CMakeLists.txt

@@ -1,3 +1,4 @@
 add_subdirectory(Indicators)
 add_subdirectory(Launcher)
+add_subdirectory(Platform)
 add_subdirectory(Session)

tests/plugins/Unity/Platform/CMakeLists.txt

@@ -0,0 +1,25 @@
+
+include_directories(
+    ${Qt5Core_INCLUDE_DIRS}
+    ${Qt5DBus_INCLUDE_DIRS}
+    ${Qt5Test_INCLUDE_DIRS}
+    ${QTDBUSTEST_INCLUDE_DIRS}
+    ${CMAKE_CURRENT_BINARY_DIR}
+    ${CMAKE_SOURCE_DIR}/plugins/Unity/Platform
+)
+
+add_executable(platformtest
+    platformtest.cpp
+    ${CMAKE_SOURCE_DIR}/plugins/Unity/Platform/platform.cpp
+    )
+    
+target_link_libraries(platformtest
+    Qt5::Core
+    Qt5::DBus
+    Qt5::Test
+    ${QTDBUSTEST_LDFLAGS}
+    )
+
+add_unity8_unittest(platformtest qdbus-simple-test-runner
+    ARGS "${CMAKE_BINARY_DIR}/platformtest"
+    )

tests/plugins/Unity/Platform/platformtest.cpp

@@ -0,0 +1,140 @@
+/*
+ * Copyright (C) 2017 Canonical, Ltd.
+ *
+ * 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/>.
+ *
+ * Authors:
+ *  Pete Woods <pete.woods@canonical.com>
+ */
+
+#include "platform.h"
+
+#include <libqtdbustest/DBusTestRunner.h>
+#include <libqtdbusmock/DBusMock.h>
+
+#include <QtTest>
+#include <QDebug>
+
+using namespace QtDBusTest;
+using namespace QtDBusMock;
+
+class PlatformTest: public QObject
+{
+
+Q_OBJECT
+
+private:
+    struct TestFixture
+    {
+        TestFixture() :
+            mock(dbus)
+        {
+        }
+
+        DBusTestRunner dbus;
+        DBusMock mock;
+    };
+
+    QScopedPointer<TestFixture> m_data;
+
+    void registerLogin1(bool canMultiSession, bool canGraphical)
+    {
+        m_data->mock.registerLogin1({{"DefaultSeat", QVariantMap
+			{
+				{"CanMultiSession", canMultiSession},
+				{"CanGraphical", canGraphical}
+			}}}
+        );
+    }
+
+    void registerHostname1(const QString& chassis)
+    {
+        m_data->mock.registerHostname1({
+            {"Chassis", chassis}
+        });
+    }
+
+    void startServices()
+    {
+        m_data->dbus.startServices();
+    }
+
+private Q_SLOTS:
+
+    void init()
+    {
+        m_data.reset(new TestFixture);
+    }
+
+    void cleanup()
+    {
+        m_data.reset();
+    }
+
+    void testIsPC_data()
+    {
+        QTest::addColumn<QString>("chassis");
+        QTest::addColumn<bool>("result");
+
+        QTest::newRow("desktop") << "desktop" << true;
+        QTest::newRow("laptop") << "laptop" << true;
+        QTest::newRow("server") << "server" << true;
+        QTest::newRow("tablet") << "tablet" << false;
+        QTest::newRow("handset") << "handset" << false;
+        QTest::newRow("vm") << "vm" << true;
+        QTest::newRow("container") << "container" << true;
+    }
+
+    void testIsPC()
+    {
+        QFETCH(QString, chassis);
+        QFETCH(bool, result);
+
+        registerLogin1(true, true);
+        registerHostname1(chassis);
+        startServices();
+
+        Platform p;
+        QCOMPARE(p.isPC(), result);
+        QCOMPARE(p.chassis(), chassis);
+    }
+
+    void testIsMultiSession_data()
+    {
+        QTest::addColumn<bool>("canMultiSession");
+        QTest::addColumn<bool>("canGraphical");
+        QTest::addColumn<bool>("result");
+
+        QTest::newRow("") << true << true << true;
+        QTest::newRow("") << true << false << false;
+        QTest::newRow("") << false << true << false;
+        QTest::newRow("") << false << false << false;
+    }
+
+    void testIsMultiSession()
+    {
+        QFETCH(bool, canMultiSession);
+        QFETCH(bool, canGraphical);
+        QFETCH(bool, result);
+
+        registerLogin1(canMultiSession, canGraphical);
+        registerHostname1("desktop");
+        startServices();
+
+        Platform p;
+        QCOMPARE(p.isMultiSession(), result);
+    }
+};
+
+QTEST_GUILESS_MAIN(PlatformTest)
+#include "platformtest.moc"