Merge lp:~townsend/unity8/fix-lp1392187 into lp:unity8

[Christopher Townsend]

Add a wrapper for handling the /org/gnome/SessionManager/EndSessionDialog DBus object used by indicator-session. This allows indicator-session to properly talk to the Unity 8 session management functions.

In the Action handler section, a "Reboot" action translates to a shutdown due to how indicator-session interacts with Unity.

* Are there any related MPs required for this MP to build/function as expected?
No

* Did you perform an exploratory manual test run of your code change and any related functionality?
Yes

* Did you make sure that your branch does not contain spurious tags?
Yes

* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
N/A

 * If you changed the UI, has there been a design review?
N/A

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1579
http://jenkins.qa.ubuntu.com/job/unity8-ci/5221/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1129
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-vivid/385
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-amd64-ci/386
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-i386-ci/386
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1007
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1127
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1127/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/17708

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5221/rebuild

review: Needs Fixing (continuous-integration)

[Albert Astals Cid (aacid)]

Can you please explain a bit more because a Reboot turns into a Shutdown?

review: Needs Information

[Christopher Townsend (townsend)]

Hey Albert,

I will try to explain, but I'm not privy to the original reason behind this:)

In Unity (7) land and indicator-session, a Reboot request from indicator-session is supposed to bring up a dialogue that asks the user if they want to either Reboot or Shutdown. This is what my other MP is supposed to fix (https://code.launchpad.net/~townsend/unity8/fix-lp1416074/+merge/248364).

The actual Shutdown request is when you press the power button and a dialogue is brought up that asks the user if they want to Lock, Logout, Reboot, or Shutdown the system.

So that said, the Reboot method is overloaded by the dialogue in that Reboot will either Reboot or Shutdown. This MP only fixes a part of that and the other MP I referenced fixes the other part.

I hope this explains it for you. If not, please ping me and we can hash it out.

Thanks for looking at this!

[Albert Astals Cid (aacid)]

Ok, this branch together with https://code.launchpad.net/~townsend/unity8/fix-lp1416074/+merge/248364 makes more sense, let's wait until that one is ready for merging

[lp:~townsend/unity8/fix-lp1392187]

1580. By Christopher Townsend on 2015-02-25

Merge trunk.

[Albert Astals Cid (aacid)]

 * Did you perform an exploratory manual test run of the code change and any related functionality?
Yes, it does fix the bugs in the desktop and can't find any difference on the phone

 * Did CI run pass?
Known broken tests.

 * Did you make sure that the branch does not contain spurious tags?
Yes

review: Approve

=== modified file 'plugins/Unity/Session/dbusunitysessionservice.cpp'
--- plugins/Unity/Session/dbusunitysessionservice.cpp	2014-10-09 15:00:32 +0000
+++ plugins/Unity/Session/dbusunitysessionservice.cpp	2015-02-25 13:48:45 +0000
@@ -71,3 +71,52 @@
 {
   Q_EMIT shutdownRequested(false);
 }
+
+enum class Action : unsigned
+{
+  LOGOUT = 0,
+  SHUTDOWN,
+  REBOOT,
+  NONE
+};
+
+DBusGnomeSessionManagerWrapper::DBusGnomeSessionManagerWrapper()
+    : UnityDBusObject("/org/gnome/SessionManager/EndSessionDialog", "com.canonical.Unity")
+{
+}
+
+DBusGnomeSessionManagerWrapper::~DBusGnomeSessionManagerWrapper()
+{
+}
+
+void DBusGnomeSessionManagerWrapper::Open(const unsigned type, const unsigned arg_1, const unsigned max_wait, const QList<QDBusObjectPath> &inhibitors)
+{
+  Q_UNUSED(arg_1);
+  Q_UNUSED(max_wait);
+  Q_UNUSED(inhibitors);
+
+  QDBusConnection connection = QDBusConnection::sessionBus();
+  QDBusInterface iface1 ("com.canonical.Unity",
+                         "/com/canonical/Unity/Session",
+                         "com.canonical.Unity.Session",
+                         connection);
+
+  Action action = (Action)type;
+
+  switch (action)
+  {
+    case Action::LOGOUT:
+      iface1.call("RequestLogout");
+      break;
+
+    case Action::REBOOT:
+      iface1.call("RequestShutdown");
+      break;
+
+    case Action::SHUTDOWN:
+      break;
+
+    default:
+      break;
+  }
+}

=== modified file 'plugins/Unity/Session/dbusunitysessionservice.h'
--- plugins/Unity/Session/dbusunitysessionservice.h	2014-12-11 13:41:26 +0000
+++ plugins/Unity/Session/dbusunitysessionservice.h	2015-02-25 13:48:45 +0000
@@ -17,8 +17,13 @@
 #ifndef DBUSUNITYSESSIONSERVICE_H
 #define DBUSUNITYSESSIONSERVICE_H
 
+#include <QDBusObjectPath>
+
 #include "unitydbusobject.h"
 
+typedef QList<QDBusObjectPath> QDbusList;
+Q_DECLARE_METATYPE(QList<QDBusObjectPath>)
+
 /**
  * DBusUnitySessionService provides com.canonical.Unity.Session dbus
  * interface.
@@ -49,7 +54,7 @@
      * @param have_inhibitors if there are any special running applications
      *        which inhibit the logout.
      */
-    void logoutRequested(bool have_inhibitors);
+    Q_SCRIPTABLE void logoutRequested(bool have_inhibitors);
 
     /**
      * rebootRequested signal
@@ -59,7 +64,7 @@
      * @param have_inhibitors if there are any special running applications
      *        which inhibit the reboot.
      */
-    void rebootRequested(bool have_inhibitors);
+    Q_SCRIPTABLE void rebootRequested(bool have_inhibitors);
 
     /**
      * shutdownRequested signal
@@ -69,7 +74,7 @@
      * @param have_inhibitors if there are any special running applications
      *        which inhibit the shutdown.
      */
-    void shutdownRequested(bool have_inhibitors);
+    Q_SCRIPTABLE void shutdownRequested(bool have_inhibitors);
 
 
     /**
@@ -141,4 +146,16 @@
 
 };
 
+class DBusGnomeSessionManagerWrapper : public UnityDBusObject
+{
+    Q_OBJECT
+    Q_CLASSINFO("D-Bus Interface", "org.gnome.SessionManager.EndSessionDialog")
+
+public:
+    DBusGnomeSessionManagerWrapper();
+    ~DBusGnomeSessionManagerWrapper();
+
+public Q_SLOTS:
+    Q_SCRIPTABLE void Open(const unsigned int type, const unsigned int arg_1, const unsigned int max_wait, const QList<QDBusObjectPath> &inhibitors);
+};
 #endif // DBUSUNITYSESSIONSERVICE_H

=== modified file 'plugins/Unity/Session/plugin.cpp'
--- plugins/Unity/Session/plugin.cpp	2014-08-26 23:33:17 +0000
+++ plugins/Unity/Session/plugin.cpp	2015-02-25 13:48:45 +0000
@@ -26,6 +26,7 @@
 
 static QObject *dbusunitysessionservice_provider(QQmlEngine */*engine*/, QJSEngine */*jsEngine*/)
 {
+    new DBusGnomeSessionManagerWrapper();
     return new DBusUnitySessionService();
 }
 

=== modified file 'tests/plugins/Unity/Session/sessionbackendtest.cpp'
--- tests/plugins/Unity/Session/sessionbackendtest.cpp	2014-10-08 13:34:21 +0000
+++ tests/plugins/Unity/Session/sessionbackendtest.cpp	2015-02-25 13:48:45 +0000
@@ -26,6 +26,14 @@
 
 #include "dbusunitysessionservice.h"
 
+enum class Action : unsigned
+{
+  LOGOUT = 0,
+  SHUTDOWN,
+  REBOOT,
+  NONE
+};
+
 class SessionBackendTest : public QObject
 {
     Q_OBJECT
@@ -33,32 +41,96 @@
 private Q_SLOTS:
 
     void initTestCase() {
+        dbusUnitySession = new QDBusInterface ("com.canonical.Unity",
+                                               "/com/canonical/Unity/Session",
+                                               "com.canonical.Unity.Session",
+                                               QDBusConnection::sessionBus());
     }
 
-    void testDbusIfaceMethods_data() {
+    void testUnitySessionLogoutRequested_data() {
         QTest::addColumn<QString>("method");
 
         QTest::newRow("Logout") << "RequestLogout";
     }
 
-    void testDbusIfaceMethods() {
+    void testUnitySessionLogoutRequested() {
         QFETCH(QString, method);
 
         DBusUnitySessionService dbusUnitySessionService;
         QCoreApplication::processEvents(); // to let the service register on DBus
 
-        QDBusConnection con = QDBusConnection::sessionBus();
-        QDBusInterface interface ("com.canonical.Unity",
-                                  "/com/canonical/Unity/Session",
-                                  "com.canonical.Unity.Session",
-                                  con);
-        QDBusReply<void> reply;
-
-        QCOMPARE(interface.isValid(), true);
-        reply = interface.call(method);
-        QCOMPARE(reply.isValid(), true);
-
-    }
+        QSignalSpy spy(&dbusUnitySessionService, SIGNAL(logoutRequested(bool)));
+
+        QDBusReply<void> reply = dbusUnitySession->call(method);
+        QCOMPARE(reply.isValid(), true);
+
+        QCOMPARE(spy.count(), 1);
+    }
+
+    void testGnomeSessionWrapperLogoutRequested() {
+        DBusUnitySessionService dbusUnitySessionService;
+        QCoreApplication::processEvents(); // to let the service register on DBus
+
+        // Spy on the logoutRequested signal on the /com/canonical/Unity/Session object
+        // as proof we are actually calling the actual method.
+        QSignalSpy spy(&dbusUnitySessionService, SIGNAL(logoutRequested(bool)));
+
+        DBusGnomeSessionManagerWrapper dbusGnomeSessionManagerWrapper;
+        QCoreApplication::processEvents(); // to let the service register on DBus
+
+        QDBusInterface dbusGnomeSessionWrapper ("com.canonical.Unity",
+                                                "/org/gnome/SessionManager/EndSessionDialog",
+                                                "org.gnome.SessionManager.EndSessionDialog",
+                                                QDBusConnection::sessionBus());
+
+        QCOMPARE(dbusGnomeSessionWrapper.isValid(), true);
+
+        // Set the QVariant as a QList<QDBusObjectPath> type
+        QDbusList var;
+        QVariant inhibitors;
+        inhibitors.setValue(var);
+
+        QDBusReply<void> reply = dbusGnomeSessionWrapper.call("Open", (unsigned)Action::LOGOUT, (unsigned)0, (unsigned)0, inhibitors);
+        QCOMPARE(reply.isValid(), true);
+
+        // Make sure we see the signal being emitted.
+        QCOMPARE(spy.count(), 1);
+    }
+
+    void testGnomeSessionWrapperShutdownRequested() {
+        DBusUnitySessionService dbusUnitySessionService;
+        QCoreApplication::processEvents(); // to let the service register on DBus
+
+        // Spy on the shutdownRequested signal on the /com/canonical/Unity/Session object
+        // as proof we are actually calling the actual method.
+        QSignalSpy spy(&dbusUnitySessionService, SIGNAL(shutdownRequested(bool)));
+
+        DBusGnomeSessionManagerWrapper dbusGnomeSessionManagerWrapper;
+        QCoreApplication::processEvents(); // to let the service register on DBus
+
+        QDBusInterface dbusGnomeSessionWrapper ("com.canonical.Unity",
+                                                "/org/gnome/SessionManager/EndSessionDialog",
+                                                "org.gnome.SessionManager.EndSessionDialog",
+                                                QDBusConnection::sessionBus());
+
+        QCOMPARE(dbusGnomeSessionWrapper.isValid(), true);
+
+        // Set the QVariant as a QList<QDBusObjectPath> type
+        QDbusList var;
+        QVariant inhibitors;
+        inhibitors.setValue(var);
+
+        // * Reboot action translates to the shutdown signal due to some weird idiosyncracy
+        //   in the indicator-session/Unity interaction. *
+        QDBusReply<void> reply = dbusGnomeSessionWrapper.call("Open", (unsigned)Action::REBOOT, (unsigned)0, (unsigned)0, inhibitors);
+        QCOMPARE(reply.isValid(), true);
+
+        // Make sure we see the signal being emitted.
+        QCOMPARE(spy.count(), 1);
+    }
+
+private:
+    QDBusInterface *dbusUnitySession;
 };
 
 QTEST_GUILESS_MAIN(SessionBackendTest)