Merge lp:~alan-griffiths/mir/nested-mir-can-hide-cursor into lp:mir

[Alan Griffiths]

tests: Test to prove the nested server can hide the cursor

tests: Test to prove the nested server can hide the cursor

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3000
http://jenkins.qa.ubuntu.com/job/mir-ci/5168/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/4312
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3219
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4254/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-wily-touch/212/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1322
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1322/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/212/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4255
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4255/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/6916/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/23995
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-wily-armhf/213/console

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

review: Needs Fixing (continuous-integration)

[Alan Griffiths (alan-griffiths)]

Failure is lp:1502896

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3001
http://jenkins.qa.ubuntu.com/job/mir-ci/5176/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/4320
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3227
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4262
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-wily-touch/220/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1330
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1330/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/220/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4263
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4263/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/6922
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24004
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-wily-armhf/221/console

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

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

nits, the rest lgtm:

+struct CursorImage : public mg::CursorImage
+public:
+struct CursorWrapper : public mg::Cursor
redundant 'public's

+ geom::Size size() const { return { 24, 24 }; }
+ connection, 24, 24, mir_pixel_format_argb_8888, mir_buffer_usage_software);
+ std::array<uint8_t, 4*8*24*24> data;

could have less repeating of '24' if we had a "int cursor_side_length{24}" somewhere.

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3003
http://jenkins.qa.ubuntu.com/job/mir-ci/5190/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/4337
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3244
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4279
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-wily-touch/237/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1344
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1344/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/237/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4280
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4280/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/6939
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24025
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-wily-armhf/238/console

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

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

lgtm, thanks

review: Approve

=== modified file 'tests/acceptance-tests/test_nested_mir.cpp'
--- tests/acceptance-tests/test_nested_mir.cpp	2015-10-05 17:08:39 +0000
+++ tests/acceptance-tests/test_nested_mir.cpp	2015-10-07 08:33:53 +0000
@@ -113,6 +113,76 @@
 
 std::chrono::seconds const timeout{10};
 
+// We can't rely on the test environment to have X cursors, so we provide some of our own
+auto const cursor_names = {
+//        mir_disabled_cursor_name,
+    mir_arrow_cursor_name,
+    mir_busy_cursor_name,
+    mir_caret_cursor_name,
+    mir_default_cursor_name,
+    mir_pointing_hand_cursor_name,
+    mir_open_hand_cursor_name,
+    mir_closed_hand_cursor_name,
+    mir_horizontal_resize_cursor_name,
+    mir_vertical_resize_cursor_name,
+    mir_diagonal_resize_bottom_to_top_cursor_name,
+    mir_diagonal_resize_top_to_bottom_cursor_name,
+    mir_omnidirectional_resize_cursor_name,
+    mir_vsplit_resize_cursor_name,
+    mir_hsplit_resize_cursor_name,
+    mir_crosshair_cursor_name };
+
+int const cursor_size = 24;
+
+struct CursorImage : mg::CursorImage
+{
+    CursorImage(char const* name) :
+        id{std::find(begin(cursor_names), end(cursor_names), name) - begin(cursor_names)},
+        data{{uint8_t(id)}}
+    {
+    }
+
+    void const* as_argb_8888() const { return data.data(); }
+
+    geom::Size size() const { return {cursor_size, cursor_size}; }
+
+    geom::Displacement hotspot() const { return {0, 0}; }
+
+    ptrdiff_t id;
+    std::array<uint8_t, MIR_BYTES_PER_PIXEL(mir_pixel_format_argb_8888) * cursor_size * cursor_size> data;
+};
+
+struct CursorImages : mir::input::CursorImages
+{
+public:
+
+    std::shared_ptr<mg::CursorImage> image(std::string const& cursor_name, geom::Size const& /*size*/)
+    {
+        return std::make_shared<CursorImage>(cursor_name.c_str());
+    }
+};
+
+struct CursorWrapper : mg::Cursor
+{
+    CursorWrapper(std::shared_ptr<mg::Cursor> const& wrapped) : wrapped{wrapped} {}
+    void show() override { if (!hidden) wrapped->show(); }
+    void show(mg::CursorImage const& cursor_image) override { if (!hidden) wrapped->show(cursor_image); }
+    void hide() override { wrapped->hide(); }
+
+    void move_to(geom::Point position) override { wrapped->move_to(position); }
+
+    void set_hidden(bool hidden)
+    {
+        this->hidden = hidden;
+        if (hidden) hide();
+        else show();
+    }
+
+private:
+    std::shared_ptr<mg::Cursor> const wrapped;
+    bool hidden{false};
+};
+
 class NestedMirRunner : public mtf::HeadlessNestedServerRunner
 {
 public:
@@ -122,6 +192,11 @@
         server.override_the_host_lifecycle_event_listener([this]
             { return the_mock_host_lifecycle_event_listener(); });
 
+        server.wrap_cursor([&](std::shared_ptr<mg::Cursor> const& wrapped)
+            { return cursor_wrapper = std::make_shared<CursorWrapper>(wrapped); });
+
+        server.override_the_cursor_images([] { return std::make_shared<CursorImages>(); });
+
         start_server();
     }
 
@@ -136,6 +211,8 @@
             { return std::make_shared<NiceMock<MockHostLifecycleEventListener>>(); });
     }
 
+    std::shared_ptr<CursorWrapper> cursor_wrapper;
+
 private:
     mir::CachedPtr<MockHostLifecycleEventListener> mock_host_lifecycle_event_listener;
 };
@@ -498,7 +575,7 @@
     server.the_cursor_listener()->cursor_moved_to(489, 9);
 
     auto stream = mir_connection_create_buffer_stream_sync(
-        connection, 24, 24, mir_pixel_format_argb_8888, mir_buffer_usage_software);
+        connection, cursor_size, cursor_size, mir_pixel_format_argb_8888, mir_buffer_usage_software);
     mir_buffer_stream_swap_buffers_sync(stream);
 
     {
@@ -531,75 +608,9 @@
     mir_connection_release(connection);
 }
 
-// We can't rely on the test environment to have X cursors, so we provide some of our own
-namespace 
-{
-static auto const cursor_names = {
-//        mir_disabled_cursor_name,
-    mir_arrow_cursor_name,
-    mir_busy_cursor_name,
-    mir_caret_cursor_name,
-    mir_default_cursor_name,
-    mir_pointing_hand_cursor_name,
-    mir_open_hand_cursor_name,
-    mir_closed_hand_cursor_name,
-    mir_horizontal_resize_cursor_name,
-    mir_vertical_resize_cursor_name,
-    mir_diagonal_resize_bottom_to_top_cursor_name,
-    mir_diagonal_resize_top_to_bottom_cursor_name,
-    mir_omnidirectional_resize_cursor_name,
-    mir_vsplit_resize_cursor_name,
-    mir_hsplit_resize_cursor_name,
-    mir_crosshair_cursor_name };
-
-struct CursorImage : public mg::CursorImage
-{
-    CursorImage(char const* name) :
-        id{std::find(begin(cursor_names), end(cursor_names), name) - begin(cursor_names)},
-        data{{uint8_t(id)}}
-    {
-    }
-
-    void const* as_argb_8888() const { return data.data(); }
-
-    geom::Size size() const { return { 24, 24 }; }
-
-    geom::Displacement hotspot() const { return {0, 0}; }
-
-    ptrdiff_t id;
-    std::array<uint8_t, 4*8*24*24> data;
-};
-
-struct CursorImages : mir::input::CursorImages
-{
-public:
-
-    std::shared_ptr<mg::CursorImage> image(std::string const& cursor_name, geom::Size const& /*size*/)
-    {
-        return std::make_shared<CursorImage>(cursor_name.c_str());
-    }
-};
-
-class NestedMirRunnerWithCursorImages : public mtf::HeadlessNestedServerRunner
-{
-public:
-    NestedMirRunnerWithCursorImages(std::string const& connection_string)
-        : mtf::HeadlessNestedServerRunner(connection_string)
-    {
-        server.override_the_cursor_images([] { return std::make_shared<CursorImages>(); });
-        start_server();
-    }
-
-    ~NestedMirRunnerWithCursorImages()
-    {
-        stop_server();
-    }
-};
-}
-
 TEST_F(NestedServer, named_cursor_image_changes_are_forwarded_to_host)
 {
-    NestedMirRunnerWithCursorImages nested_mir{new_connection()};
+    NestedMirRunner nested_mir{new_connection()};
 
     auto const connection = mir_connect_sync(nested_mir.new_connection().c_str(), __PRETTY_FUNCTION__);
     auto const surface = make_and_paint_surface(connection);
@@ -630,3 +641,54 @@
     mir_surface_release_sync(surface);
     mir_connection_release(connection);
 }
+
+TEST_F(NestedServer, can_hide_the_host_cursor)
+{
+    int const frames = 10;
+    NestedMirRunner nested_mir{new_connection()};
+
+    auto const connection = mir_connect_sync(nested_mir.new_connection().c_str(), __PRETTY_FUNCTION__);
+    auto const surface = make_and_paint_surface(connection);
+    auto const mock_cursor = the_mock_cursor();
+
+    auto const spec = mir_connection_create_spec_for_changes(connection);
+    mir_surface_spec_set_fullscreen_on_output(spec, 1);
+    mir_surface_apply_spec(surface, spec);
+    mir_surface_spec_release(spec);
+
+    server.the_cursor_listener()->cursor_moved_to(489, 9);
+
+    auto stream = mir_connection_create_buffer_stream_sync(
+        connection, cursor_size, cursor_size, mir_pixel_format_argb_8888, mir_buffer_usage_software);
+    mir_buffer_stream_swap_buffers_sync(stream);
+
+    {
+        mt::WaitCondition condition;
+        EXPECT_CALL(*mock_cursor, show(_)).Times(1)
+            .WillRepeatedly(InvokeWithoutArgs([&] { condition.wake_up_everyone(); }));
+
+        auto conf = mir_cursor_configuration_from_buffer_stream(stream, 0, 0);
+        mir_wait_for(mir_surface_configure_cursor(surface, conf));
+        mir_cursor_configuration_destroy(conf);
+
+        condition.wait_for_at_most_seconds(1);
+        Mock::VerifyAndClearExpectations(mock_cursor.get());
+    }
+
+    nested_mir.cursor_wrapper->set_hidden(true);
+
+    EXPECT_CALL(*mock_cursor, show(_)).Times(0);
+
+    for (int i = 0; i != frames; ++i)
+    {
+        mir_buffer_stream_swap_buffers_sync(stream);
+    }
+
+    mir_buffer_stream_release_sync(stream);
+    mir_surface_release_sync(surface);
+    mir_connection_release(connection);
+
+    // Need to verify before test server teardown deletes the
+    // surface as the host cursor then reverts to default.
+    Mock::VerifyAndClearExpectations(mock_cursor.get());
+}