Merge lp:~afrantzis/mir/fix-1465231-test-client-input-race into lp:mir

[Alexandros Frantzis]

tests: Don't handle spurious events that can cause TestClientInput tests to fail

tests: Don't handle spurious events that can cause TestClientInput tests to fail

This MP removes the event handler before destroying surfaces, to avoid handling spurious events unrelated to the tests (e.g. pointer leave events when the surface is destroyed), which can cause test expectations to fail.

The problem affects all TestClientInput tests and could explain other spurious CI failures we have seen in the past in these tests.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2661
http://jenkins.qa.ubuntu.com/job/mir-ci/4099/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/2846
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-wily-amd64-build/359
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/2794
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/255
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/255/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/2794
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/2794/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/5626
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21193

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

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

lgtm

review: Approve

[Alberto Aguirre (albaguirre)]

LGTM

review: Approve

=== modified file 'tests/acceptance-tests/test_client_input.cpp'
--- tests/acceptance-tests/test_client_input.cpp	2015-05-27 17:39:11 +0000
+++ tests/acceptance-tests/test_client_input.cpp	2015-06-15 14:43:21 +0000
@@ -66,6 +66,10 @@
 const int surface_width = 100;
 const int surface_height = 100;
 
+void null_event_handler(MirSurface*, MirEvent const*, void*)
+{
+}
+
 struct Client
 {
     MirSurface* surface{nullptr};
@@ -120,6 +124,10 @@
     }
     ~Client()
     {
+        // Remove the event handler to avoid handling spurious events unrelated
+        // to the tests (e.g. pointer leave events when the surface is destroyed),
+        // which can cause test expectations to fail.
+        mir_surface_set_event_handler(surface, null_event_handler, nullptr);
         mir_surface_release_sync(surface);
         mir_connection_release(connection);
     }