Merge lp:~andreas-pokorny/mir/move-cookie-test-to-acceptance-tests into lp:mir

[Andreas Pokorny]

Create real cookies from fake input

To detect that new devices reported by udev are valid and have not been removed or stale while being added Libinput
matches device ids through various methods - one of them fstat(device_fd...) is currently not caught by umockdev.
Until that is resolved in umockdev we have to refrain from using that to inject user input.

This change uses fake input devices to do the same - bypassing the evdev platform in this case.

The original test relied on working umockdev - which isnt the case with the libinput platform anymore. So for the time being tests like those need to use the fake input devices.

At some point we might be able to move it back..

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3050
http://jenkins.qa.ubuntu.com/job/mir-ci/5380/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/4610
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3517
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4552
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-wily-touch/510/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1534
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1534/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/510
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/510/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4553
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4553/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/7178
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24498
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-wily-armhf/511/console

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

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

So these udev_recordings can each be replaced with a single event without changing the meaning of the tests?

review: Needs Information

[Andreas Pokorny (andreas-pokorny)]

> So these udev_recordings can each be replaced with a single event without
> changing the meaning of the tests?

The way the test is written only the last event counts.. So this test should have the same coverage.

[Andreas Pokorny (andreas-pokorny)]

Removing this in favor of: https://code.launchpad.net/~mir-team/mir/cookie-umock-to-fake-input-tests/+merge/275588

Unmerged revisions

3050. By Andreas Pokorny on 2015-10-23

Add a todo - when umockdev works again we should add another test that also includes evdev input

3049. By Andreas Pokorny on 2015-10-23

Moving Cookie client test to a acceptance test and using fake input devices instead

To detect that new devices reported by udev are valid and have not been removed or stale while being added Libinput
matches device ids through various methods - one of them fstat(device_fd...) is currently not caught by umockdev.
Until that is resolved in umockdev we have to refrain from using that to inject user input.

This change uses fake input devices to do the same - bypassing the evdev platform in this case.

=== modified file 'tests/acceptance-tests/CMakeLists.txt'
--- tests/acceptance-tests/CMakeLists.txt	2015-10-07 16:41:50 +0000
+++ tests/acceptance-tests/CMakeLists.txt	2015-10-23 08:40:13 +0000
@@ -11,6 +11,7 @@
   server_configuration_options.cpp
   server_signal_handling.cpp
   test_application_not_responding_detection.cpp
+  test_client_cookie.cpp
   test_client_header_version.cpp
   test_client_input.cpp
   test_client_library.cpp

=== renamed file 'tests/umock-acceptance-tests/test_client_cookie.cpp' => 'tests/acceptance-tests/test_client_cookie.cpp'
--- tests/umock-acceptance-tests/test_client_cookie.cpp	2015-10-15 18:40:48 +0000
+++ tests/acceptance-tests/test_client_cookie.cpp	2015-10-23 08:40:13 +0000
@@ -16,15 +16,23 @@
  * Authored by: Christopher James Halse Rogers <[e-mail]>
  */
 
-#include "mir_test_framework/udev_environment.h"
 #include "mir_test_framework/connected_client_with_a_surface.h"
 #include "mir/test/wait_condition.h"
+#include "mir_test_framework/fake_input_device.h"
+#include "mir_test_framework/stub_server_platform_factory.h"
+
+#include "mir/input/device_capability.h"
+#include "mir/input/input_device_info.h"
 #include "mir/cookie_factory.h"
 
-#include "boost/throw_exception.hpp"
+#include <linux/input.h>
+#include <boost/throw_exception.hpp>
 
+// TODO we should have another test in the umockdev based acceptance test that also
+// includes our prefered input platforms and setups.
 
 namespace mtf = mir_test_framework;
+namespace mi = mir::input;
 
 namespace
 {
@@ -37,9 +45,6 @@
 public:
     ClientCookies()
     {
-        // Needed because the headless server sets stub_input.so
-        add_to_environment("MIR_SERVER_PLATFORM_INPUT_LIB", nullptr);
-
         server.override_the_cookie_factory([this] ()
             { return mir::cookie::CookieFactory::create_saving_secret(cookie_secret); });
     }
@@ -58,36 +63,24 @@
         mir_buffer_stream_swap_buffers_sync(mir_surface_get_buffer_stream(surface));
     }
 
-    void read_evemu_file(std::string const& evemu_file)
-    {
-        mock_devices.load_device_evemu(evemu_file);
-
-        udev_read_recording.wait_for_at_most_seconds(max_wait);
-        if (!udev_read_recording.woken())
-            BOOST_THROW_EXCEPTION(std::runtime_error("Timeout waiting for udev to read the recording '" + evemu_file + "'"));
-    }
 
     std::vector<uint8_t> cookie_secret;
-    mtf::UdevEnvironment mock_devices;
     MirCookie out_cookie{0, 0};
-    mir::test::WaitCondition udev_read_recording;
+    mir::test::WaitCondition client_input_received;
+    
 };
 
 // Need to setup the device before the server gets setup
 struct ClientCookiesKeyboard : ClientCookies
 {
-    ClientCookiesKeyboard()
-    {
-        mock_devices.add_standard_device("laptop-keyboard");
-    }
+    std::unique_ptr<mtf::FakeInputDevice> fake_keyboard{
+        mtf::add_fake_input_device(mi::InputDeviceInfo{"keyboard", "keyboard-uid", mi::DeviceCapability::keyboard})};
 };
 
 struct ClientCookiesMouse : ClientCookies
 {
-    ClientCookiesMouse()
-    {
-        mock_devices.add_standard_device("laptop-mouse");
-    }
+    std::unique_ptr<mtf::FakeInputDevice> fake_mouse{
+        mtf::add_fake_input_device(mi::InputDeviceInfo{"mouse", "mouse-uid", mi::DeviceCapability::pointer})};
 };
 
 namespace
@@ -104,19 +97,19 @@
         {
             auto kev = mir_input_event_get_keyboard_event(iev);
             client->out_cookie = mir_keyboard_event_get_cookie(kev);
-            client->udev_read_recording.wake_up_everyone();
+            client->client_input_received.wake_up_everyone();
         }
         else if (itype == mir_input_event_type_pointer)
         {
             auto pev = mir_input_event_get_pointer_event(iev);
             client->out_cookie = mir_pointer_event_get_cookie(pev);
-            client->udev_read_recording.wake_up_everyone();
+            client->client_input_received.wake_up_everyone();
         }
         else if (itype == mir_input_event_type_touch)
         {
             auto tev = mir_input_event_get_touch_event(iev);
             client->out_cookie = mir_touch_event_get_cookie(tev);
-            client->udev_read_recording.wake_up_everyone();
+            client->client_input_received.wake_up_everyone();
         }
     }
 }
@@ -124,7 +117,9 @@
 
 TEST_F(ClientCookiesKeyboard, keyboard_events_have_attestable_cookies)
 {
-    read_evemu_file("laptop-keyboard-hello");
+    fake_keyboard->emit_event(mtf::synthesis::a_key_down_event().of_scancode(KEY_ENTER));
+    client_input_received.wait_for_at_most_seconds(10);
+
     auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
 
     EXPECT_TRUE(factory->attest_timestamp(out_cookie));
@@ -132,7 +127,9 @@
 
 TEST_F(ClientCookiesMouse, pointer_motion_events_do_not_have_attestable_cookies)
 {
-    read_evemu_file("laptop-mouse-motion");
+    fake_mouse->emit_event(mtf::synthesis::a_pointer_event().with_movement(20,-19));
+    client_input_received.wait_for_at_most_seconds(10);
+
     auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
 
     EXPECT_FALSE(factory->attest_timestamp(out_cookie));
@@ -140,7 +137,8 @@
 
 TEST_F(ClientCookiesMouse, pointer_click_events_have_attestable_cookies)
 {
-    read_evemu_file("laptop-mouse-click");
+    fake_mouse->emit_event(mtf::synthesis::a_button_down_event().of_button(BTN_LEFT));
+    client_input_received.wait_for_at_most_seconds(10);
     auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
 
     EXPECT_TRUE(factory->attest_timestamp(out_cookie));

=== modified file 'tests/umock-acceptance-tests/CMakeLists.txt'
--- tests/umock-acceptance-tests/CMakeLists.txt	2015-10-06 18:15:53 +0000
+++ tests/umock-acceptance-tests/CMakeLists.txt	2015-10-23 08:40:13 +0000
@@ -10,7 +10,6 @@
 mir_add_wrapped_executable(
   mir_umock_acceptance_tests
 
-  test_client_cookie.cpp
   test_libinput.cpp
   )