Mir

Merge lp:~andreas-pokorny/mir/probe-libinput-platform into lp:mir

probe-libinput-platform
Merge into development-branch

Proposed by Andreas Pokorny on 2015-10-01

Status:	Merged
Approved by:	Andreas Pokorny on 2015-10-05
Approved revision:	2984
Merged at revision:	2991
Proposed branch:	lp:~andreas-pokorny/mir/probe-libinput-platform
Merge into:	lp:mir
Diff against target:	340 lines (+196/-6) 11 files modified debian/mir-test-tools.install (+1/-0) include/test/mir_test_framework/executable_path.h (+1/-0) src/CMakeLists.txt (+1/-0) src/common/symbols.map (+3/-3) src/platforms/evdev/platform_factory.cpp (+36/-1) tests/CMakeLists.txt (+1/-0) tests/acceptance-tests/CMakeLists.txt (+0/-2) tests/mir_test_framework/CMakeLists.txt (+1/-0) tests/mir_test_framework/executable_path.cpp (+18/-0) tests/umock-acceptance-tests/CMakeLists.txt (+34/-0) tests/umock-acceptance-tests/test_libinput.cpp (+100/-0)
To merge this branch:	bzr merge lp:~andreas-pokorny/mir/probe-libinput-platform
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
Alan Griffiths			Approve on 2015-10-05
PS Jenkins bot	continuous-integration		Approve on 2015-10-05
Alexandros Frantzis (community)			Approve on 2015-10-05
Brandon Schaefer (community)		2015-10-01	Approve on 2015-10-01
Review via email: mp+273046@code.launchpad.net

Commit Message

Add more checks in input-evdev platform probing and add umockdev acceptance tests

Now input-evdev claims to be capable of operation when it is not loaded within a nested server and is capable of opening at least one of the evdev devices it finds. mir_umock_acceptance_tests is a class of acceptance tests that require device access.

Description of the Change

A step towards automatically probing and loading all available and working input platforms. By probing that libinput is not running in a nested server or has no permission to open evdev devices.

This also adds an acceptance test that relies on libinput and umockdev to a new test binary which should in the end be the only binary of our ci tests that rely on umockdev.

PS Jenkins bot (ps-jenkins) wrote on 2015-10-01:

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

review: Needs Fixing (continuous-integration)

lp:~andreas-pokorny/mir/probe-libinput-platform updated on 2015-10-01

2978. By Andreas Pokorny on 2015-10-01: disable test for now..
2979. By Andreas Pokorny on 2015-10-01: slight comment clarification and typo

Brandon Schaefer (brandontschaefer) wrote on 2015-10-01:

Besides CI being angry LGTM

review: Approve

PS Jenkins bot (ps-jenkins) wrote on 2015-10-01:

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

review: Needs Fixing (continuous-integration)

Alan Griffiths (alan-griffiths) wrote on 2015-10-01:

*Needs Discussion*

+// ThrowBack alert:
+// This test uses utility headers an external user cannot use, for the sake of this
+// test those utilities just remove some verobsity and avoid code duplication.
+#include "src/include/common/mir/shared_library.h"

I don't think any harm would result from publishing this header?

review: Needs Information

lp:~andreas-pokorny/mir/probe-libinput-platform updated on 2015-10-02

2980. By Andreas Pokorny on 2015-10-02: merge lp:mir
2981. By Andreas Pokorny on 2015-10-02: install new acceptance test binary

Andreas Pokorny (andreas-pokorny) wrote on 2015-10-02:

> *Needs Discussion*
>
> +// ThrowBack alert:
> +// This test uses utility headers an external user cannot use, for the sake
> of this
> +// test those utilities just remove some verobsity and avoid code
> duplication.
> +#include "src/include/common/mir/shared_library.h"
>
> I don't think any harm would result from publishing this header?

Ok..

lp:~andreas-pokorny/mir/probe-libinput-platform updated on 2015-10-02

2982. By Andreas Pokorny on 2015-10-02: ship shared_library

PS Jenkins bot (ps-jenkins) wrote on 2015-10-02:

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

review: Approve (continuous-integration)

PS Jenkins bot (ps-jenkins) wrote on 2015-10-02:

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

review: Approve (continuous-integration)

lp:~andreas-pokorny/mir/probe-libinput-platform updated on 2015-10-05

2983. By Andreas Pokorny on 2015-10-05: remove debug output

Alexandros Frantzis (afrantzis) wrote on 2015-10-05:

OK. Perhaps also move the SharedLibrary entries in the common/symbols.map from the "supposed to be private" section to the public section.

I don't like exposing internal helper functions/classes just for our own convenience, but since these end up in libmircommon (which is not supposed to be accessed by normal users), it's fine.

review: Approve

Alan Griffiths (alan-griffiths) wrote on 2015-10-05:

+ // dumb assumption - nobody runs this test cases as root..
+ // or allows accessing evdev input devices from non privileged users.

I wonder if we could express this in code.

Alan Griffiths (alan-griffiths) wrote on 2015-10-05:

Nit: We should update src/common/symbols.map to reflect the publishing of mir::SharedLibrary::*.

[aside] The mix of public and non-public symbols in libmircommon looks entirely accidental and without reason. Maybe we should review this design?

review: Needs Fixing

lp:~andreas-pokorny/mir/probe-libinput-platform updated on 2015-10-05

2984. By Andreas Pokorny on 2015-10-05: move Shared Library to disclosed section

PS Jenkins bot (ps-jenkins) wrote on 2015-10-05:

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

review: Approve (continuous-integration)

PS Jenkins bot (ps-jenkins) wrote on 2015-10-05:

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

review: Approve (continuous-integration)

Alan Griffiths (alan-griffiths) wrote on 2015-10-05:

thanks

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Andreas Pokorny

Emanuele Antonio Faraone

Gerry Boland

Mir development team

 === modified file 'debian/mir-test-tools.install'
 --- debian/mir-test-tools.install	2015-09-24 15:42:21 +0000
 +++ debian/mir-test-tools.install	2015-10-05 09:54:18 +0000
@@ -1,6 +1,7 @@
  usr/bin/mir_stress
  usr/bin/mir_unit_tests
  usr/bin/mir_acceptance_tests
++usr/bin/mir_umock_acceptance_tests
  usr/bin/mir_integration_tests*
  usr/bin/mir_performance_tests
  usr/bin/mir_privileged_tests
 === renamed file 'src/include/common/mir/shared_library.h' => 'include/common/mir/shared_library.h'
 === modified file 'include/test/mir_test_framework/executable_path.h'
 --- include/test/mir_test_framework/executable_path.h	2015-09-08 21:22:41 +0000
 +++ include/test/mir_test_framework/executable_path.h	2015-10-05 09:54:18 +0000
@@ -28,6 +28,7 @@
  std::string library_path();
  std::string udev_recordings_path();
  std::string server_platform(std::string const& name);
++std::string server_input_platform(std::string const& name);
  std::string client_platform(std::string const& name);
+ }
  #endif /* MIR_TEST_FRAMEWORK_EXECUTABLE_PATH_H_ */
 === modified file 'src/CMakeLists.txt'
 --- src/CMakeLists.txt	2015-09-29 13:41:51 +0000
 +++ src/CMakeLists.txt	2015-10-05 09:54:18 +0000
@@ -48,6 +48,7 @@
  # We need the ABI versions in the tests
  set(MIR_SERVER_GRAPHICS_PLATFORM_ABI ${MIR_SERVER_GRAPHICS_PLATFORM_ABI} PARENT_SCOPE)
++set(MIR_SERVER_INPUT_PLATFORM_ABI ${MIR_SERVER_INPUT_PLATFORM_ABI} PARENT_SCOPE)
  set(MIR_CLIENT_PLATFORM_ABI ${MIR_CLIENT_PLATFORM_ABI} PARENT_SCOPE)
  set(MIR_INPUT_PLATFORM_VERSION_SCRIPT ${MIR_INPUT_PLATFORM_VERSION_SCRIPT} PARENT_SCOPE)
  set(MIR_CLIENT_PLATFORM_VERSION ${MIR_CLIENT_PLATFORM_VERSION} PARENT_SCOPE)
 === modified file 'src/common/symbols.map'
 --- src/common/symbols.map	2015-09-17 06:06:28 +0000
 +++ src/common/symbols.map	2015-10-05 09:54:18 +0000
@@ -65,6 +65,9 @@
      mir::logging::Logger::Logger*;
      mir::logging::Logger::operator*;
      mir::logging::set_logger*;
++    mir::SharedLibrary::load_symbol*;
++    mir::SharedLibrary::?SharedLibrary*;
++    mir::SharedLibrary::SharedLibrary*;
      non-virtual?thunk?to?mir::dispatch::ActionQueue::?ActionQueue*;
      non-virtual?thunk?to?mir::dispatch::Dispatchable::?Dispatchable*;
      non-virtual?thunk?to?mir::dispatch::MultiplexingDispatchable::dispatch*;
@@ -119,9 +122,6 @@
      mir::report::lttng::TracepointProvider::?TracepointProvider*;
      mir::report::lttng::TracepointProvider::TracepointProvider*;
      mir::set_thread_name*;
--    mir::SharedLibrary::load_symbol*;
--    mir::SharedLibrary::?SharedLibrary*;
--    mir::SharedLibrary::SharedLibrary*;
      vtable?for?mir::logging::DumbConsoleLogger;
      vtable?for?mir::time::SteadyClock;
      vtable?for?mir::time::Clock;
 === modified file 'src/platforms/evdev/platform_factory.cpp'
 --- src/platforms/evdev/platform_factory.cpp	2015-09-14 06:13:21 +0000
 +++ src/platforms/evdev/platform_factory.cpp	2015-10-05 09:54:18 +0000
@@ -18,6 +18,15 @@
  #include "platform.h"
  #include "mir/udev/wrapper.h"
++#include "mir/fd.h"
++
++#include <sys/types.h>
++#include <sys/stat.h>
++#include <fcntl.h>
++
++#include <memory>
++#include <string>
++#include <iostream>
  namespace mo = mir::options;
  namespace mi = mir::input;
@@ -33,6 +42,28 @@
      MIR_VERSION_MINOR,
      MIR_VERSION_MICRO
  };
++bool can_open_input_devices()
++{
++    mu::Enumerator input_enumerator{std::make_shared<mu::Context>()};
++    input_enumerator.match_subsystem("input");
++    input_enumerator.scan_devices();
++
++    bool device_found = false;
++
++    for (auto& device : input_enumerator)
++    {
++        if (device.devnode() != nullptr)
++        {
++            device_found = true;
++
++            mir::Fd input_device(::open(device.devnode(), O_RDONLY|O_NONBLOCK));
++            if (input_device > 0)
++                return true;
++        }
++    }
++    return ! device_found;
++}
++
+ }
  mir::UniqueModulePtr<mi::Platform> create_input_platform(
@@ -59,7 +90,11 @@
+     {
          return mi::PlatformPriority::unsupported;
+     }
--    return mi::PlatformPriority::supported;
++
++    if (can_open_input_devices())
++        return mi::PlatformPriority::supported;
++
++    return mi::PlatformPriority::unsupported;
+ }
  mir::ModuleProperties const* describe_input_module()
 === modified file 'tests/CMakeLists.txt'
 --- tests/CMakeLists.txt	2015-09-17 20:32:32 +0000
 +++ tests/CMakeLists.txt	2015-10-05 09:54:18 +0000
@@ -65,6 +65,7 @@
  if (MIR_BUILD_ACCEPTANCE_TESTS)
    add_subdirectory(acceptance-tests/)
++  add_subdirectory(umock-acceptance-tests/)
  endif (MIR_BUILD_ACCEPTANCE_TESTS)
  if (MIR_BUILD_PERFORMANCE_TESTS)
 === modified file 'tests/acceptance-tests/CMakeLists.txt'
 --- tests/acceptance-tests/CMakeLists.txt	2015-09-21 22:33:58 +0000
 +++ tests/acceptance-tests/CMakeLists.txt	2015-10-05 09:54:18 +0000
@@ -3,7 +3,6 @@
  include_directories(
    ${CMAKE_SOURCE_DIR}
    ${PROJECT_SOURCE_DIR}/include/cookie
--  ${UMOCKDEV_INCLUDE_DIRS}
+ )
  set(
@@ -79,7 +78,6 @@
    mirclient-debug-extension
    mirserver
--  ${UMOCKDEV_LIBRARIES}
    ${CMAKE_THREAD_LIBS_INIT} # Link in pthread.
+ )
 === modified file 'tests/mir_test_framework/CMakeLists.txt'
 --- tests/mir_test_framework/CMakeLists.txt	2015-09-18 10:26:57 +0000
 +++ tests/mir_test_framework/CMakeLists.txt	2015-10-05 09:54:18 +0000
@@ -16,6 +16,7 @@
      -DMIR_SERVER_PLATFORM_PATH="${MIR_SERVER_PLATFORM_PATH}"
      -DMIR_CLIENT_PLATFORM_ABI_STRING="${MIR_CLIENT_PLATFORM_ABI}"
      -DMIR_SERVER_GRAPHICS_PLATFORM_ABI_STRING="${MIR_SERVER_GRAPHICS_PLATFORM_ABI}"
++    -DMIR_SERVER_INPUT_PLATFORM_ABI_STRING="${MIR_SERVER_INPUT_PLATFORM_ABI}"
      -DMIR_INSTALL_PREFIX="${CMAKE_INSTALL_PREFIX}"
      -DMIR_BUILD_PREFIX="${CMAKE_BINARY_DIR}"
+     )
 === modified file 'tests/mir_test_framework/executable_path.cpp'
 --- tests/mir_test_framework/executable_path.cpp	2015-09-16 00:42:28 +0000
 +++ tests/mir_test_framework/executable_path.cpp	2015-10-05 09:54:18 +0000
@@ -76,6 +76,24 @@
      BOOST_THROW_EXCEPTION(std::runtime_error("Failed to find server platform in standard search locations"));
+ }
++std::string mir_test_framework::server_input_platform(std::string const& name)
++{
++    std::string libname{name};
++
++    if (libname.find(".so") == std::string::npos)
++        libname += ".so." MIR_SERVER_INPUT_PLATFORM_ABI_STRING;
++
++    for (auto const& option :
++         {library_path() + "/server-modules/", library_path() + "/server-platform/", std::string(MIR_SERVER_PLATFORM_PATH) + '/'})
++    {
++        auto path_to_test = option + libname;
++        if (boost::filesystem::exists(path_to_test))
++            return path_to_test;
++    }
++
++    BOOST_THROW_EXCEPTION(std::runtime_error("Failed to find server platform in standard search locations"));
++}
++
  std::string mir_test_framework::client_platform(std::string const& name)
+ {
      std::string libname{name};
 === added directory 'tests/umock-acceptance-tests'
 === added file 'tests/umock-acceptance-tests/CMakeLists.txt'
 --- tests/umock-acceptance-tests/CMakeLists.txt	1970-01-01 00:00:00 +0000
 +++ tests/umock-acceptance-tests/CMakeLists.txt	2015-10-05 09:54:18 +0000
@@ -0,0 +1,34 @@
++include(CMakeDependentOption)
++
++include_directories(
++  ${CMAKE_SOURCE_DIR}
++  ${CMAKE_SOURCE_DIR}/tests/include/
++  ${UMOCKDEV_INCLUDE_DIRS}
++)
++
++mir_add_wrapped_executable(
++  mir_umock_acceptance_tests
++
++  test_libinput.cpp
++  )
++
++add_dependencies(mir_umock_acceptance_tests GMock)
++
++target_link_libraries(mir_umock_acceptance_tests
++  mir-test-assist
++  mir-test-framework-static
++
++  ${UMOCKDEV_LIBRARIES}
++  ${CMAKE_THREAD_LIBS_INIT} # Link in pthread.
++)
++
++CMAKE_DEPENDENT_OPTION(
++  MIR_RUN_ACCEPTANCE_TESTS
++  "Run acceptance tests as part of default testing"
++  ON
++  "MIR_BUILD_ACCEPTANCE_TESTS"
++  OFF)
++
++if (MIR_RUN_ACCEPTANCE_TESTS)
++  mir_discover_tests_with_fd_leak_detection(mir_umock_acceptance_tests LD_PRELOAD=libumockdev-preload.so.0 G_SLICE=always-malloc G_DEBUG=gc-friendly)
++endif (MIR_RUN_ACCEPTANCE_TESTS)
 === added file 'tests/umock-acceptance-tests/test_libinput.cpp'
 --- tests/umock-acceptance-tests/test_libinput.cpp	1970-01-01 00:00:00 +0000
 +++ tests/umock-acceptance-tests/test_libinput.cpp	2015-10-05 09:54:18 +0000
@@ -0,0 +1,100 @@
++/*
++ * Copyright © 2015 Canonical Ltd.
++ *
++ * This program is free software: you can redistribute it and/or modify
++ * it under the terms of the GNU General Public License version 3 as
++ * published by the Free Software Foundation.
++ *
++ * This program is distributed in the hope that it will be useful,
++ * but WITHOUT ANY WARRANTY; without even the implied warranty of
++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++ * GNU General Public License for more details.
++ *
++ * You should have received a copy of the GNU General Public License
++ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
++ *
++ * Authored by: Andreas Pokorny <andreas.pokorny@canonical.com>
++ */
++
++#include "mir/input/platform.h"
++#include "mir/shared_library.h"
++#include "mir/options/option.h"
++
++#include "mir_test_framework/udev_environment.h"
++#include "mir_test_framework/executable_path.h"
++
++#include <gmock/gmock.h>
++#include <gtest/gtest.h>
++
++namespace mtf = mir_test_framework;
++namespace mo = mir::options;
++using namespace ::testing;
++namespace
++{
++
++struct MockOption : mo::Option
++{
++    MOCK_CONST_METHOD1(is_set, bool(char const*));
++    MOCK_CONST_METHOD2(get, bool(char const*, bool));
++    MOCK_CONST_METHOD2(get, int(char const*, int));
++    MOCK_CONST_METHOD2(get, std::string(char const* name, char const*));
++    MOCK_CONST_METHOD1(get, boost::any const&(char const*));
++};
++
++auto get_libinput_platform()
++{
++    auto path = mtf::server_input_platform("input-evdev");
++    return std::make_shared<mir::SharedLibrary>(path);
++}
++
++char const probe_input_platform_symbol[] = "probe_input_platform";
++char const host_socket_opt[] = "host-socket";
++
++}
++
++TEST(LibInput, DISABLED_probes_as_unsupported_without_device_access)
++{
++    NiceMock<MockOption> options;
++
++    // dumb assumption - nobody runs this test cases as root..
++    // or allows accessing evdev input devices from non privileged users.
++    auto library = get_libinput_platform();
++    auto probe_fun = library->load_function<mir::input::ProbePlatform>(probe_input_platform_symbol);
++    EXPECT_THAT(probe_fun(options), Eq(mir::input::PlatformPriority::unsupported));
++}
++
++TEST(LibInput, probes_as_supported_with_at_least_one_device_to_deal_with)
++{
++    mtf::UdevEnvironment env;
++    env.add_standard_device("laptop-keyboard");
++    NiceMock<MockOption> options;
++
++    auto library = get_libinput_platform();
++    auto probe_fun = library->load_function<mir::input::ProbePlatform>(probe_input_platform_symbol);
++    EXPECT_THAT(probe_fun(options), Ge(mir::input::PlatformPriority::supported));
++}
++
++TEST(LibInput, probes_as_unsupported_on_nested_configs)
++{
++    mtf::UdevEnvironment env;
++    env.add_standard_device("laptop-keyboard");
++    NiceMock<MockOption> options;
++    ON_CALL(options,is_set(StrEq(host_socket_opt)))
++        .WillByDefault(Return(true));
++    ON_CALL(options,get(StrEq(host_socket_opt), Matcher<char const*>(_)))
++        .WillByDefault(Return("something"));
++
++    auto library = get_libinput_platform();
++    auto probe_fun = library->load_function<mir::input::ProbePlatform>(probe_input_platform_symbol);
++    EXPECT_THAT(probe_fun(options), Eq(mir::input::PlatformPriority::unsupported));
++}
++
++TEST(LibInput, probes_as_supported_when_umock_dev_available_or_before_input_devices_are_available)
++{
++    mtf::UdevEnvironment env;
++    NiceMock<MockOption> options;
++
++    auto library = get_libinput_platform();
++    auto probe_fun = library->load_function<mir::input::ProbePlatform>(probe_input_platform_symbol);
++    EXPECT_THAT(probe_fun(options), Eq(mir::input::PlatformPriority::supported));
++}