Merge lp:~mir-team/mir/cookie-umock-to-fake-input-tests into lp:mir

[Brandon Schaefer]

Move the test_client_cookies to using fake input device vs using umock.

Added touch screen tests as well.

Move the test_client_cookies to using fake input device vs using umock.

Added touch screen tests as well.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3054
http://jenkins.qa.ubuntu.com/job/mir-ci/5391/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/4626
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3533
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4568
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-wily-touch/526/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1545
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1545/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/526
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/526/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4569
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4569/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/7193
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24531
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-wily-armhf/527/console

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

review: Approve (continuous-integration)

[Andreas Pokorny (andreas-pokorny)]

lgtm

review: Approve

[Alexandros Frantzis (afrantzis)]

Looks good.

review: Approve

=== 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 21:36:51 +0000
@@ -51,6 +51,7 @@
   test_surface_specification.cpp
   test_system_compositor_window_manager.cpp
   test_session_mediator_report.cpp
+  test_client_cookie.cpp
 )
 
 if (MIR_TEST_PLATFORM STREQUAL "mesa-kms" OR MIR_TEST_PLATFORM STREQUAL "mesa-x11")

=== 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 21:36:51 +0000
@@ -14,17 +14,25 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * Authored by: Christopher James Halse Rogers <[e-mail]>
+ *              Brandon Schaefer <[e-mail]>
  */
 
-#include "mir_test_framework/udev_environment.h"
+#include "mir/input/input_device_info.h"
+#include "mir_test_framework/fake_input_device.h"
+
+#include "mir_test_framework/stub_server_platform_factory.h"
 #include "mir_test_framework/connected_client_with_a_surface.h"
-#include "mir/test/wait_condition.h"
+#include "mir/test/spin_wait.h"
 #include "mir/cookie_factory.h"
 
 #include "boost/throw_exception.hpp"
 
+#include <linux/input.h>
 
 namespace mtf = mir_test_framework;
+namespace mt = mir::test;
+namespace mi = mir::input;
+namespace mis = mir::input::synthesis;
 
 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,19 @@
         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;
-};
-
-// Need to setup the device before the server gets setup
-struct ClientCookiesKeyboard : ClientCookies
-{
-    ClientCookiesKeyboard()
-    {
-        mock_devices.add_standard_device("laptop-keyboard");
-    }
-};
-
-struct ClientCookiesMouse : ClientCookies
-{
-    ClientCookiesMouse()
-    {
-        mock_devices.add_standard_device("laptop-mouse");
-    }
+    std::vector<MirCookie> out_cookies;
+
+    std::unique_ptr<mtf::FakeInputDevice> fake_keyboard{
+        mtf::add_fake_input_device(mi::InputDeviceInfo{"keyboard", "keyboard-uid" , mi::DeviceCapability::keyboard})
+        };
+    std::unique_ptr<mtf::FakeInputDevice> fake_pointer{
+        mtf::add_fake_input_device(mi::InputDeviceInfo{"mouse", "mouse-uid" , mi::DeviceCapability::pointer})
+        };
+   std::unique_ptr<mtf::FakeInputDevice> fake_touch_screen{
+       mtf::add_fake_input_device(mi::InputDeviceInfo{
+       "touch screen", "touch-screen-uid", mi::DeviceCapability::touchscreen | mi::DeviceCapability::multitouch})
+       };
 };
 
 namespace
@@ -103,45 +91,96 @@
         if (itype == mir_input_event_type_key)
         {
             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->out_cookies.push_back(mir_keyboard_event_get_cookie(kev));
         }
         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->out_cookies.push_back(mir_pointer_event_get_cookie(pev));
         }
         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->out_cookies.push_back(mir_touch_event_get_cookie(tev));
         }
     }
 }
-}
-
-TEST_F(ClientCookiesKeyboard, keyboard_events_have_attestable_cookies)
-{
-    read_evemu_file("laptop-keyboard-hello");
-    auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
-
-    EXPECT_TRUE(factory->attest_timestamp(out_cookie));
-}
-
-TEST_F(ClientCookiesMouse, pointer_motion_events_do_not_have_attestable_cookies)
-{
-    read_evemu_file("laptop-mouse-motion");
-    auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
-
-    EXPECT_FALSE(factory->attest_timestamp(out_cookie));
-}
-
-TEST_F(ClientCookiesMouse, pointer_click_events_have_attestable_cookies)
-{
-    read_evemu_file("laptop-mouse-click");
-    auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
-
-    EXPECT_TRUE(factory->attest_timestamp(out_cookie));
+
+bool wait_for_n_events(size_t n, std::vector<MirCookie>& cookies)
+{
+    bool all_events = mt::spin_wait_for_condition_or_timeout(
+        [&n, &cookies]
+        {
+            return cookies.size() >= n;
+        },
+        std::chrono::seconds{max_wait});
+
+   EXPECT_TRUE(all_events);
+   return all_events;
+}
+}
+
+TEST_F(ClientCookies, keyboard_events_have_attestable_cookies)
+{
+    fake_keyboard->emit_event(mis::a_key_down_event().of_scancode(KEY_M));
+    if (wait_for_n_events(1, out_cookies))
+    {
+        auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
+        EXPECT_TRUE(factory->attest_timestamp(out_cookies.back()));
+    }
+}
+
+TEST_F(ClientCookies, pointer_motion_events_do_not_have_attestable_cookies)
+{
+    fake_pointer->emit_event(mis::a_pointer_event().with_movement(1, 1));
+    if (wait_for_n_events(1, out_cookies))
+    {
+        auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
+        EXPECT_FALSE(factory->attest_timestamp(out_cookies.back()));
+    }
+}
+
+TEST_F(ClientCookies, pointer_click_events_have_attestable_cookies)
+{
+    fake_pointer->emit_event(mis::a_button_down_event().of_button(BTN_LEFT).with_action(mis::EventAction::Down));
+    fake_pointer->emit_event(mis::a_button_up_event().of_button(BTN_LEFT));
+    if (wait_for_n_events(2, out_cookies))
+    {
+        auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
+        EXPECT_TRUE(factory->attest_timestamp(out_cookies.back()));
+    }
+}
+
+TEST_F(ClientCookies, touch_motion_events_do_not_have_attestable_cookies)
+{
+    fake_touch_screen->emit_event(
+         mis::a_touch_event()
+        .at_position({0, 0})
+        );
+
+    fake_touch_screen->emit_event(
+         mis::a_touch_event()
+        .with_action(mis::TouchParameters::Action::Move)
+        .at_position({1, 1})
+        );
+
+    if (wait_for_n_events(2, out_cookies))
+    {
+        auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
+        EXPECT_FALSE(factory->attest_timestamp(out_cookies.back()));
+    }
+}
+
+TEST_F(ClientCookies, touch_click_events_have_attestable_cookies)
+{
+    fake_touch_screen->emit_event(
+         mis::a_touch_event()
+        .at_position({0, 0})
+        );
+
+    if (wait_for_n_events(1, out_cookies))
+    {
+        auto factory = mir::cookie::CookieFactory::create_from_secret(cookie_secret);
+        EXPECT_TRUE(factory->attest_timestamp(out_cookies.back()));
+    }
 }

=== 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 21:36:51 +0000
@@ -10,7 +10,6 @@
 mir_add_wrapped_executable(
   mir_umock_acceptance_tests
 
-  test_client_cookie.cpp
   test_libinput.cpp
   )