Merge lp:~raof/mir/acceptance-test-for-unfocus-on-surface-release into lp:mir

[Chris Halse Rogers]

Acceptance tests for unfocus-on-surface-release behaviour.

We guarantee that for every focus event a MirSurface will receive exactly one
unfocus event, but we didn't have an acceptance test for this behaviour when
destroying a focused surface. Add one.

I want this because I want to remove the unit-test for this behaviour as it requires a ridiculous amount of setup and some of my other changes break that setup.

Also, we probably should have an acceptance test for this anyway :)

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3550
https://mir-jenkins.ubuntu.com/job/mir-ci/1171/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/1318
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/1369
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/1360
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/1360
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/1332
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/1332/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/1332
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/1332/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1332
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1332/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/1332
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/1332/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/1332
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/1332/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1171/rebuild

review: Approve (continuous-integration)

[Alexandros Frantzis (afrantzis)]

It seems like we reimplementing parts of googlemock. Can't we implement the test by using existing googlemock functionality instead (e.g. a mock function called in event_callback)?

review: Needs Information

[Alexandros Frantzis (afrantzis)]

> It seems like we reimplementing parts of googlemock.

To be more clear, that we are reimplementing functionality already provided by googlemock.

[Chris Halse Rogers (raof)]

This appeared to be the sensible extension of what the existing tests did; I'll see how GMocking it looks.

[Chris Halse Rogers (raof)]

Ok, that looks much better.

[Kevin DuBois (kdub)]

looks good to me

review: Approve

[Alexandros Frantzis (afrantzis)]

Looks good.

review: Approve

=== modified file 'tests/acceptance-tests/test_client_surface_events.cpp'
--- tests/acceptance-tests/test_client_surface_events.cpp	2016-06-22 23:10:36 +0000
+++ tests/acceptance-tests/test_client_surface_events.cpp	2016-06-24 00:22:35 +0000
@@ -304,6 +304,128 @@
 
 namespace
 {
+bool is_focus_event_with_value(MirEvent const* event, MirSurfaceFocusState state)
+{
+    if (mir_event_get_type(event) != mir_event_type_surface)
+    {
+        return false;
+    }
+
+    auto surface_event = mir_event_get_surface_event(event);
+    if (mir_surface_event_get_attribute(surface_event) != mir_surface_attrib_focus)
+    {
+        return false;
+    }
+    return mir_surface_event_get_attribute_value(surface_event) == state;
+}
+
+bool is_focus_event(MirEvent const* event)
+{
+    return is_focus_event_with_value(event, mir_surface_focused);
+}
+
+bool is_unfocus_event(MirEvent const* event)
+{
+    return is_focus_event_with_value(event, mir_surface_unfocused);
+}
+}
+
+TEST_F(ClientSurfaceEvents, focused_window_receives_unfocus_event_on_release)
+{
+    using namespace testing;
+    using namespace std::chrono_literals;
+
+    auto surface = mtf::make_any_surface(connection);
+
+    mt::Signal focus_received;
+    mir_surface_set_event_handler(
+        surface,
+        [](MirSurface*, MirEvent const* event, void* ctx)
+        {
+            auto& done = *reinterpret_cast<mt::Signal*>(ctx);
+            if (is_focus_event(event))
+            {
+                done.raise();
+            }
+        },
+        &focus_received);
+
+    // Swap buffers to get the surface into the scene so it can be focused.
+    auto buffer_stream = mir_surface_get_buffer_stream(surface);
+    mir_buffer_stream_swap_buffers_sync(buffer_stream);
+
+    ASSERT_TRUE(focus_received.wait_for(10s));
+
+    mt::Signal unfocus_received;
+    mir_surface_set_event_handler(
+        surface,
+        [](MirSurface*, MirEvent const* event, void* ctx)
+        {
+            auto& done = *reinterpret_cast<mt::Signal*>(ctx);
+            if (is_unfocus_event(event))
+            {
+                done.raise();
+            }
+        },
+        &unfocus_received);
+
+    mir_surface_release_sync(surface);
+
+    EXPECT_TRUE(unfocus_received.wait_for(10s));
+}
+
+TEST_F(ClientSurfaceEvents, unfocused_window_does_not_receive_unfocus_event_on_release)
+{
+    using namespace testing;
+    using namespace std::chrono_literals;
+
+    auto surface = mtf::make_any_surface(connection);
+
+    mt::Signal focus_received;
+    mir_surface_set_event_handler(
+        surface,
+        [](MirSurface*, MirEvent const* event, void* ctx)
+        {
+            auto& done = *reinterpret_cast<mt::Signal*>(ctx);
+            if (is_focus_event(event))
+            {
+                done.raise();
+            }
+        },
+        &focus_received);
+
+    // Swap buffers to get the surface into the scene so it can be focused.
+    auto buffer_stream = mir_surface_get_buffer_stream(surface);
+    mir_buffer_stream_swap_buffers_sync(buffer_stream);
+
+    ASSERT_TRUE(focus_received.wait_for(10s));
+
+    mt::Signal unfocus_received;
+    mir_surface_set_event_handler(
+        surface,
+        [](MirSurface*, MirEvent const* event, void* ctx)
+        {
+            auto& done = *reinterpret_cast<mt::Signal*>(ctx);
+            if (is_unfocus_event(event))
+            {
+                done.raise();
+            }
+        },
+        &unfocus_received);
+
+    // Add a new surface that will take focus.
+    auto focus_grabbing_surface = mtf::make_any_surface(connection);
+    mir_buffer_stream_swap_buffers_sync(mir_surface_get_buffer_stream(focus_grabbing_surface));
+
+    ASSERT_TRUE(unfocus_received.wait_for(10s));
+
+    unfocus_received.reset();
+
+    mir_surface_release_sync(surface);
+
+    EXPECT_FALSE(unfocus_received.wait_for(1s));
+}
+
 class WrapShellGeneratingCloseEvent : public mir::shell::ShellWrapper
 {
     using mir::shell::ShellWrapper::ShellWrapper;
@@ -345,7 +467,6 @@
         signal->raise();
     }
 }
-}
 
 TEST_F(ClientSurfaceStartupEvents, receives_event_sent_during_surface_construction)
 {