Merge lp:~alan-griffiths/mir/migrate-tests-to-miral into lp:mir

[Alan Griffiths]

Migrate ClientSurfaces.* tests to miral APIs

Migrate ClientSurfaces.* tests to miral APIs

This is the first of a number of tests that rely on the legacy window management code. (I.e. include/test/mir/shell/canonical_window_manager.h)

The changes to mtf::AsyncServerRunner make it feasible to migrate the remaining tests and then ditch that legacy code.

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

PASSED: Continuous integration, rev:4254
https://mir-jenkins.ubuntu.com/job/mir-ci/3667/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/5019
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/5251
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=artful/5239
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/5239
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/5239
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5062
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=artful/5062/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5062
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/5062/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5062
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=artful/5062/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5062
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/5062/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5062
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/5062/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5062
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=artful/5062/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5062
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=mesa,release=zesty/5062/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5062
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/5062/artifact/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

LGTM

review: Approve

=== modified file 'include/test/mir_test_framework/async_server_runner.h'
--- include/test/mir_test_framework/async_server_runner.h	2017-07-28 17:00:43 +0000
+++ include/test/mir_test_framework/async_server_runner.h	2017-09-18 11:45:09 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2014 Canonical Ltd.
+ * Copyright © 2014-2017 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 2 or 3,
@@ -23,6 +23,7 @@
 #include "mir/test/auto_unblock_thread.h"
 
 #include "mir/server.h"
+#include "miral/set_window_management_policy.h"
 
 #include <condition_variable>
 #include <list>
@@ -56,10 +57,21 @@
 
     mir::Server server;
 
+    template<typename Policy, typename ...Args>
+    void override_window_management_policy(Args& ... args)
+    {
+        set_window_management_policy =
+            miral::set_window_management_policy<Policy>(args...);
+    }
+
 private:
     std::list<TemporaryEnvironmentValue> env;
     mir::test::AutoJoinThread server_thread;
 
+    // Once we migrate away from "legacy" window management stubs this can become
+    // SetWindowManagementPolicy set_window_management_policy;
+    std::function<void(mir::Server&)> set_window_management_policy;
+
     std::mutex mutex;
     std::condition_variable started;
     bool server_running{false};

=== added file 'include/test/mir_test_framework/canonical_window_manager_policy.h'
--- include/test/mir_test_framework/canonical_window_manager_policy.h	1970-01-01 00:00:00 +0000
+++ include/test/mir_test_framework/canonical_window_manager_policy.h	2017-09-18 11:45:09 +0000
@@ -0,0 +1,38 @@
+/*
+ * Copyright © 2017 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 2 or 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: Alan Griffiths <[e-mail]>
+ */
+
+#ifndef MIR_TEST_FRAMEWORK_CANONICAL_WINDOW_MANAGER_POLICY_H
+#define MIR_TEST_FRAMEWORK_CANONICAL_WINDOW_MANAGER_POLICY_H
+
+#include <miral/canonical_window_manager.h>
+
+namespace mir_test_framework
+{
+struct CanonicalWindowManagerPolicy : miral::CanonicalWindowManagerPolicy
+{
+    using miral::CanonicalWindowManagerPolicy::CanonicalWindowManagerPolicy;
+
+    bool handle_keyboard_event(MirKeyboardEvent const*) override { return false; }
+
+    bool handle_pointer_event(MirPointerEvent const*) override { return false; }
+
+    bool handle_touch_event(MirTouchEvent const*) override { return false; }
+};
+}
+
+#endif //MIR_TEST_FRAMEWORK_CANONICAL_WINDOW_MANAGER_POLICY_H

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2017-09-07 05:58:13 +0000
+++ tests/CMakeLists.txt	2017-09-18 11:45:09 +0000
@@ -43,6 +43,7 @@
 # public headers (only public headers should be accessed by acceptance tests)
 include_directories(
   ${PROJECT_SOURCE_DIR}/include/platform
+  ${PROJECT_SOURCE_DIR}/include/miral
   ${PROJECT_SOURCE_DIR}/include/server
   ${PROJECT_SOURCE_DIR}/include/client
   ${PROJECT_SOURCE_DIR}/include/common
@@ -100,13 +101,16 @@
 )
 
 target_link_libraries(mir-test-assist
+PUBLIC
   mirclient
+  miral
   mirserver
 
   mir-test-doubles-platform-static
   ${Boost_LIBRARIES}
   ${GTEST_BOTH_LIBRARIES}
   ${GMOCK_LIBRARY}
+PRIVATE
   ${GMOCK_MAIN_LIBRARY}
   ${CMAKE_THREAD_LIBS_INIT} # Link in pthread.
 )

=== modified file 'tests/acceptance-tests/test_client_surfaces.cpp'
--- tests/acceptance-tests/test_client_surfaces.cpp	2017-07-28 17:00:43 +0000
+++ tests/acceptance-tests/test_client_surfaces.cpp	2017-09-18 11:45:09 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2012-2014 Canonical Ltd.
+ * Copyright © 2012-2017 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 2 or 3 as
@@ -19,13 +19,15 @@
 #include "mir_toolkit/mir_client_library.h"
 #include "mir_toolkit/debug/surface.h"
 
-#include "mir/test/doubles/mock_window_manager.h"
+#include "miral/application_info.h"
 
 #include "mir/scene/session.h"
 #include "mir/geometry/rectangle.h"
 
+#include "mir_test_framework/canonical_window_manager_policy.h"
 #include "mir_test_framework/connected_client_headless_server.h"
 #include "mir_test_framework/any_surface.h"
+
 #include "mir/test/validity_matchers.h"
 #include "mir/test/fake_shared.h"
 
@@ -36,14 +38,31 @@
 #include <mutex>
 
 namespace mtf = mir_test_framework;
-namespace mtd = mir::test::doubles;
 namespace msh = mir::shell;
 namespace ms = mir::scene;
 namespace mt = mir::test;
 namespace mg = mir::geometry;
+using namespace testing;
 
 namespace
 {
+struct MockWindowManagementPolicy : mtf::CanonicalWindowManagerPolicy
+{
+    MockWindowManagementPolicy(
+        miral::WindowManagerTools const& tools,
+        MockWindowManagementPolicy*& self) :
+        mtf::CanonicalWindowManagerPolicy(tools)
+    {
+        self = this;
+        ON_CALL(*this, place_new_window(_, _)).WillByDefault(ReturnArg<1>());
+    }
+
+    MOCK_METHOD2(place_new_window,
+        miral::WindowSpecification(miral::ApplicationInfo const& app_info, miral::WindowSpecification const& request_parameters));
+
+    MOCK_METHOD1(advise_new_window, void (miral::WindowInfo const& window_info));
+};
+
 struct ClientSurfaces : mtf::ConnectedClientHeadlessServer
 {
     static const int max_surface_count = 5;
@@ -51,14 +70,13 @@
 
     void SetUp() override
     {
-        server.override_the_window_manager_builder([this](msh::FocusController*)
-        {
-            return mt::fake_shared(window_manager);
-        });
-        ConnectedClientHeadlessServer::SetUp();
+        override_window_management_policy<MockWindowManagementPolicy>(mock_wm_policy);
+        mtf::ConnectedClientHeadlessServer::SetUp();
+
+        ASSERT_THAT(mock_wm_policy, NotNull());
     }
 
-    testing::NiceMock<mtd::MockWindowManager> window_manager;
+    MockWindowManagementPolicy* mock_wm_policy = 0;
 };
 }
 #pragma GCC diagnostic push
@@ -351,22 +369,27 @@
 
     std::shared_ptr<ms::Surface> parent_surface;
     InSequence seq;
-    EXPECT_CALL(window_manager, add_surface(_,_,_)).WillOnce(Invoke([&parent_surface](auto session, auto params, auto builder)
-    {
-        auto id = builder(session, params);
-        parent_surface = session->surface(id);
-        return id;
-    }));
-    EXPECT_CALL(window_manager, add_surface(_,_,_)).WillOnce(Invoke([&parent_surface, server_rect, edge_attachment](auto session, auto params, auto builder)
-    {
-        EXPECT_THAT(params.parent.lock(), Eq(parent_surface));
-        EXPECT_TRUE(params.aux_rect.is_set());
-        EXPECT_THAT(params.aux_rect.value(), Eq(server_rect));
-        EXPECT_TRUE(params.edge_attachment.is_set());
-        EXPECT_THAT(params.edge_attachment.value(), Eq(edge_attachment));
+    EXPECT_CALL(*mock_wm_policy, place_new_window(_, _)).Times(1);
+    EXPECT_CALL(*mock_wm_policy, advise_new_window(_)).WillOnce(Invoke([&parent_surface](auto const& info)
+        {
+            parent_surface = info.window();
+        }));
 
-        return builder(session, params);
-    }));
+    EXPECT_CALL(*mock_wm_policy, place_new_window(_, _)).WillOnce(Invoke([&](auto const&, auto const& params)
+        {
+            EXPECT_TRUE(params.parent().is_set());
+            EXPECT_THAT(params.parent().value().lock(), Eq(parent_surface));
+            EXPECT_TRUE(params.aux_rect().is_set());
+            EXPECT_THAT(params.aux_rect().value(), Eq(server_rect));
+            EXPECT_TRUE(params.window_placement_gravity().is_set());
+            EXPECT_THAT(params.window_placement_gravity().value(), Eq(mir_placement_gravity_northwest));
+            EXPECT_TRUE(params.aux_rect_placement_gravity().is_set());
+            EXPECT_THAT(params.aux_rect_placement_gravity().value(), Eq(mir_placement_gravity_northeast));
+            EXPECT_TRUE(params.placement_hints().is_set());
+            EXPECT_THAT(params.placement_hints().value(), Eq(mir_placement_hints_flip_x));
+            return params;
+        }));
+    EXPECT_CALL(*mock_wm_policy, advise_new_window(_)).Times(1);
 
     auto window = mtf::make_any_surface(connection);
 

=== modified file 'tests/mir_test_framework/async_server_runner.cpp'
--- tests/mir_test_framework/async_server_runner.cpp	2017-08-30 11:59:02 +0000
+++ tests/mir_test_framework/async_server_runner.cpp	2017-09-18 11:45:09 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2014 Canonical Ltd.
+ * Copyright © 2014-2017 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 2 or 3,
@@ -18,12 +18,14 @@
 
 #include "mir_test_framework/async_server_runner.h"
 #include "mir_test_framework/command_line_server_configuration.h"
+#include "mir_test_framework/canonical_window_manager_policy.h"
 
 #include "mir/fd.h"
 #include "mir/main_loop.h"
 #include "mir/geometry/rectangle.h"
 #include "mir/options/option.h"
 #include "mir/test/doubles/null_logger.h"
+#include <miral/set_window_management_policy.h>
 #include <mir/shell/canonical_window_manager.h>
 
 #include <boost/throw_exception.hpp>
@@ -42,7 +44,8 @@
 std::chrono::seconds const timeout{20};
 }
 
-mtf::AsyncServerRunner::AsyncServerRunner()
+mtf::AsyncServerRunner::AsyncServerRunner() :
+    set_window_management_policy{[](auto&){}}
 {
     configure_from_commandline(server);
 
@@ -56,6 +59,9 @@
 
             return result;
         });
+    // TODO This is here to support tests that rely on the legacy window management code
+    // once they go, then we can set set_window_management_policy appropriately, kill this
+    // and remove msh::CanonicalWindowManager
     server.override_the_window_manager_builder([this](msh::FocusController* focus_controller)
         {
 #pragma GCC diagnostic push
@@ -74,6 +80,8 @@
 
 void mtf::AsyncServerRunner::start_server()
 {
+    set_window_management_policy(server);
+
     server.add_init_callback([&]
         {
             auto const main_loop = server.the_main_loop();

=== modified file 'tests/performance-tests/CMakeLists.txt'
--- tests/performance-tests/CMakeLists.txt	2017-05-08 03:04:26 +0000
+++ tests/performance-tests/CMakeLists.txt	2017-09-18 11:45:09 +0000
@@ -17,11 +17,7 @@
 )
 add_dependencies(mir_glmark2_performance_test GMock)
 target_link_libraries(mir_glmark2_performance_test
-  mir-test-static
-  mir-test-framework-static
-  mir-test-doubles-static
-  mirserver
-  ${GTEST_BOTH_LIBRARIES}
+  mir-test-assist
 )
 
 add_library(mir_system_performance_test STATIC
@@ -40,10 +36,6 @@
   test_client_startup.cpp
 )
 target_link_libraries(mir_client_startup_performance_test
-  mir-test-static
-  mir-test-framework-static
-  mir-test-doubles-static
-  mirserver
-  ${GTEST_BOTH_LIBRARIES}
+  mir-test-assist
 )