Merge lp:~vanvugt/mir/crashing-server into lp:mir

[Daniel van Vugt]

tests: Add a "crashing_server" binary to ease testing of debugability issues
arising from crashes in compositor threads (like LP: #1237332).

Hopefully it can some day be automated with some simple scripted analysis
of the resulting core file. But for now that's not possible while the basic
default server requires root/VT access to start at all.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1586
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/1446/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/1768
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/1766
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/1337/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/1178
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/1178/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/1183
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/1183/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/1340
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/1340/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/1233/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/6555

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/1446/rebuild

review: Needs Fixing (continuous-integration)

[lp:~vanvugt/mir/crashing-server]

1587. By Daniel van Vugt on 2014-05-01

Merge latest development-branch

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1587
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/1463/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/1790
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/1788
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/1357/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/1195
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/1195/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/1200
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/1200/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/1360
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/1360/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/1253/console
    FAILURE: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/6614/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/1463/rebuild

review: Needs Fixing (continuous-integration)

[Kevin DuBois (kdub)]

This might bring up the 'acceptance test fixture is somewhat bulky' topic, but it seems like this could have an acceptance test, so we're not so reliant on using this server to check for how a crash looks, and so the "please crash nicely with debug info" requirement gets tested in CI. It might be more fiddling with the test fixtures, but in the end we have an automated test.

*needs info/discussion

review: Needs Information

[Daniel van Vugt (vanvugt)]

Initially I thought that was not feasible because it requires multiple processes and actually crashing the server process. But now I remember our original acceptance test architecture is indeed multi-process, it could be done. So long as you can find _where_ the resulting core file is.

But that kind of automation a harder problem than this manual testing demo. I don't think we should block waiting for a completely automated solution. They're not dependent activities.

[lp:~vanvugt/mir/crashing-server]

1588. By Daniel van Vugt on 2014-05-02

Merge latest development-branch

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1588
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/1491/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/10
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/11
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/11
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/8/console
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/8/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/8
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/8/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/17
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/17/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/1284
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/6684

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/1491/rebuild

review: Needs Fixing (continuous-integration)

[Alan Griffiths (alan-griffiths)]

It is always worth investing the time to automate testing for desired features.

review: Needs Fixing

[Daniel van Vugt (vanvugt)]

But that kind of automation a harder problem than this manual testing demo. I don't think we should block waiting for a completely automated solution. They're not dependent activities.

[lp:~vanvugt/mir/crashing-server]

1589. By Daniel van Vugt on 2014-05-05

Merge latest development-branch

[Daniel van Vugt (vanvugt)]

The above comment should be in quotes (LP stripped them), referring to comments from 2014-05-02.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1589
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/1513/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/41
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/42
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/42
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/32
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/32/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/30
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/30/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/48
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/48/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/1312
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/6764

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/1513/rebuild

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

Come to think of it, if we replace the unrecoverable critical exceptions in the compositor/DRM/KMS with "errors" (abort etc) then this proposal wouldn't be a valid example any more. The throw would need to become abort() or some other raise().

[Daniel van Vugt (vanvugt)]

Work in progress (possibly indefinitely). This branch:
   lp:~vanvugt/mir/fatal-error
will introduce nicer automated testing of crash handling.

Unmerged revisions

1589. By Daniel van Vugt on 2014-05-05

Merge latest development-branch

1588. By Daniel van Vugt on 2014-05-02

Merge latest development-branch

1587. By Daniel van Vugt on 2014-05-01

Merge latest development-branch

1586. By Daniel van Vugt on 2014-04-30

tests: Add a "crashing_server" binary to ease testing of debugability issues
arising from crashes in compositor threads (like LP: #1237332).

Hopefully it can some day be automated with some simple scripted analysis
of the resulting core file. But for now that's not possible while the basic
default server requires root/VT access to start at all.

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2014-03-26 05:48:59 +0000
+++ tests/CMakeLists.txt	2014-05-05 03:28:07 +0000
@@ -45,5 +45,6 @@
 add_subdirectory(mir_test_doubles/)
 add_subdirectory(client-language/)
 add_subdirectory(mir-stress/)
+add_subdirectory(fatal/)
 
 mir_add_memcheck_test()

=== added directory 'tests/fatal'
=== added file 'tests/fatal/CMakeLists.txt'
--- tests/fatal/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/fatal/CMakeLists.txt	2014-05-05 03:28:07 +0000
@@ -0,0 +1,8 @@
+add_executable(mir_crashing_server
+  crashing_server.cpp
+)
+
+target_link_libraries(mir_crashing_server
+  mirserver
+)
+

=== added file 'tests/fatal/crashing_server.cpp'
--- tests/fatal/crashing_server.cpp	1970-01-01 00:00:00 +0000
+++ tests/fatal/crashing_server.cpp	2014-05-05 03:28:07 +0000
@@ -0,0 +1,84 @@
+/*
+ * Copyright © 2014 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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/>.
+ *
+ * Authored by: Daniel van Vugt <[e-mail]>
+ *
+ *
+ * This is a test server designed to crash on composition of the first frame.
+ * It's designed to test the quality of the core files and stack traces
+ * that result.
+ */
+
+#include "mir/server_configuration.h"
+#include "mir/default_server_configuration.h"
+#include "mir/compositor/display_buffer_compositor_factory.h"
+#include "mir/compositor/display_buffer_compositor.h"
+#include "mir/report_exception.h"
+#include "mir/run_mir.h"
+#include <iostream>
+
+using namespace mir;
+using namespace mir::compositor;
+
+class CrashingServerConfiguration : public DefaultServerConfiguration
+{
+public:
+    CrashingServerConfiguration(int argc, char const* argv[])
+        : DefaultServerConfiguration(argc, argv)
+    {
+    }
+
+    std::shared_ptr<DisplayBufferCompositorFactory>
+        the_display_buffer_compositor_factory() override
+    {
+        class CrashingDisplayBufferCompositor : public DisplayBufferCompositor
+        {
+        public:
+            bool composite() override
+            {
+                throw std::runtime_error("He's dead, Jim");
+                return false;
+            }
+        };
+
+        class CrashingDisplayBufferCompositorFactory :
+            public DisplayBufferCompositorFactory
+        {
+        public:
+            std::unique_ptr<DisplayBufferCompositor>
+                create_compositor_for(graphics::DisplayBuffer&) override
+            {
+                auto raw = new CrashingDisplayBufferCompositor();
+                return std::unique_ptr<CrashingDisplayBufferCompositor>(raw);
+            }
+        };
+
+        return std::make_shared<CrashingDisplayBufferCompositorFactory>();
+    }
+};
+
+int main(int argc, char const* argv[])
+try
+{
+    CrashingServerConfiguration config(argc, argv);
+
+    run_mir(config, [](mir::DisplayServer&){} );
+    return 0;
+}
+catch (...)
+{
+    mir::report_exception(std::cerr);
+    return 1;
+}