Merge lp:~alan-griffiths/unity-system-compositor/debug-without-dm into lp:unity-system-compositor

[Alan Griffiths]

debug option to startup without a display manager

debug option to startup without a display manager

 --debug-without-dm disables the display manager connection
 --debug-active-session-name names a session that can become active

For example:

$ sudo bin/unity-system-compositor --debug-without-dm --vt 2 --spinner bin/unity-system-compositor-spinner --arw-file

$ mir_demo_server --host-socket /tmp/mir_socket

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:196
http://jenkins.qa.ubuntu.com/job/unity-system-compositor-ci/180/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-vivid-amd64-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-vivid-armhf-ci/17

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-system-compositor-ci/180/rebuild

review: Approve (continuous-integration)

[Alberto Aguirre (albaguirre)]

Looks useful

review: Approve

[Kevin DuBois (kdub)]

yes, sounds useful

review: Approve

[lp:~alan-griffiths/unity-system-compositor/debug-without-dm]

197. By Alan Griffiths on 2015-06-03

merge lp:unity-system-compositor

198. By Alan Griffiths on 2015-06-03

Add --debug-active-session-name

[Kevin DuBois (kdub)]

new option seems useful to me, still lgtm

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:198
http://jenkins.qa.ubuntu.com/job/unity-system-compositor-ci/222/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-amd64-ci/10
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-armhf-ci/10
        deb: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-armhf-ci/10/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-i386-ci/10

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-system-compositor-ci/222/rebuild

review: Approve (continuous-integration)

[Alberto Aguirre (albaguirre)]

LGTM.

review: Approve

=== modified file 'src/server.cpp'
--- src/server.cpp	2015-04-07 13:36:48 +0000
+++ src/server.cpp	2015-06-03 15:59:34 +0000
@@ -30,6 +30,7 @@
 #include <mir/server_status_listener.h>
 #include <mir/shell/focus_controller.h>
 #include <mir/scene/session.h>
+#include <mir/abnormal_exit.h>
 #include <mir/main_loop.h>
 
 #include <iostream>
@@ -92,12 +93,20 @@
 
     std::shared_ptr<msh::FocusController> const focus_controller;
 };
+const char* const dm_from_fd = "from-dm-fd";
+const char* const dm_to_fd = "to-dm-fd";
+const char* const dm_stub = "debug-without-dm";
+const char* const dm_stub_active = "debug-active-session-name";
 }
 
 usc::Server::Server(int argc, char** argv)
 {
-    add_configuration_option("from-dm-fd", "File descriptor of read end of pipe from display manager [int]", mir::OptionType::integer);
-    add_configuration_option("to-dm-fd",   "File descriptor of write end of pipe to display manager [int]",  mir::OptionType::integer);
+    add_configuration_option(dm_from_fd, "File descriptor of read end of pipe from display manager [int]",
+        mir::OptionType::integer);
+    add_configuration_option(dm_to_fd, "File descriptor of write end of pipe to display manager [int]",
+        mir::OptionType::integer);
+    add_configuration_option(dm_stub, "Run without a display manager (only useful when debugging)", mir::OptionType::null);
+    add_configuration_option(dm_stub_active, "Expected connection when run without a display manager (only useful when debugging)", "nested-mir@:/run/user/1000/mir_socket");
     add_configuration_option("blacklist", "Video blacklist regex to use",  mir::OptionType::string);
     add_configuration_option("version", "Show version of Unity System Compositor",  mir::OptionType::null);
     add_configuration_option("spinner", "Path to spinner executable",  mir::OptionType::string);
@@ -171,15 +180,49 @@
     return the_session_switcher();
 }
 
+namespace
+{
+struct NullDMMessageHandler : usc::DMConnection
+{
+    explicit NullDMMessageHandler(
+        std::shared_ptr<usc::DMMessageHandler> const& dm_message_handler,
+        std::string const& client_name) :
+        dm_message_handler{dm_message_handler},
+        client_name{client_name}
+    {}
+
+    ~NullDMMessageHandler() = default;
+
+    void start() override
+    {
+        dm_message_handler->set_active_session(client_name);
+    };
+
+    std::shared_ptr<usc::DMMessageHandler> const dm_message_handler;
+    std::string const client_name;
+};
+}
+
 std::shared_ptr<usc::DMConnection> usc::Server::the_dm_connection()
 {
     return dm_connection(
-        [this]
+        [this]() -> std::shared_ptr<usc::DMConnection>
         {
-            return std::make_shared<AsioDMConnection>(
-                the_options()->get("from-dm-fd", -1),
-                the_options()->get("to-dm-fd", -1),
-                the_dm_message_handler());
+            if (the_options()->is_set(dm_from_fd) && the_options()->is_set(dm_to_fd))
+            {
+                return std::make_shared<AsioDMConnection>(
+                    the_options()->get(dm_from_fd, -1),
+                    the_options()->get(dm_to_fd, -1),
+                    the_dm_message_handler());
+            }
+            else if (the_options()->is_set(dm_stub))
+            {
+                return std::make_shared<NullDMMessageHandler>(
+                    the_dm_message_handler(),
+                    the_options()->get<std::string>(dm_stub_active));
+            }
+
+            BOOST_THROW_EXCEPTION(mir::AbnormalExit("to and from FDs are required for display manager"));
         });
 }