Merge lp:~alan-griffiths/miral/DragActiveWindow-tests into lp:miral

[Alan Griffiths]

Test that rules for user positioning of surfaces are applied by WindowManagerTools::drag_active_window()

[Gerry Boland (gerboland)]

Looks good

review: Approve

=== modified file 'test/CMakeLists.txt'
--- test/CMakeLists.txt	2016-09-15 16:07:43 +0000
+++ test/CMakeLists.txt	2016-09-16 08:39:38 +0000
@@ -33,6 +33,7 @@
     persistent_surface_store.cpp
     runner.cpp
     window_placement.cpp
+    drag_active_window.cpp
     test_server.cpp         test_server.h
     test_window_manager_tools.h
 )

=== added file 'test/drag_active_window.cpp'
--- test/drag_active_window.cpp	1970-01-01 00:00:00 +0000
+++ test/drag_active_window.cpp	2016-09-16 08:39:38 +0000
@@ -0,0 +1,151 @@
+/*
+ * Copyright © 2016 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: Alan Griffiths <[e-mail]>
+ */
+
+#include "test_window_manager_tools.h"
+#include <mir/event_printer.h>
+
+using namespace miral;
+using namespace testing;
+namespace mt = mir::test;
+using mir::operator<<;
+
+namespace
+{
+X const display_left{0};
+Y const display_top{0};
+Width const display_width{640};
+Height const display_height{480};
+
+Rectangle const display_area{{display_left,  display_top},
+                             {display_width, display_height}};
+
+auto const null_window = Window{};
+
+auto
+create_surface(std::shared_ptr<mir::scene::Session> const& session, mir::scene::SurfaceCreationParameters const& params)
+-> mir::frontend::SurfaceId
+{
+    // This type is Mir-internal, I hope we don't need to create it here
+    std::shared_ptr<mir::frontend::EventSink> const sink;
+
+    return session->create_surface(params, sink);
+}
+
+struct DragActiveWindow : TestWindowManagerTools, WithParamInterface<MirSurfaceType>
+{
+    Size const initial_parent_size{600, 400};
+
+    Window window;
+
+    void SetUp() override
+    {
+        basic_window_manager.add_display(display_area);
+        basic_window_manager.add_session(session);
+    }
+
+    void create_window_of_type(MirSurfaceType type)
+    {
+        mir::scene::SurfaceCreationParameters creation_parameters;
+        creation_parameters.type = type;
+        creation_parameters.size = initial_parent_size;
+
+        EXPECT_CALL(*window_manager_policy, advise_new_window(_))
+            .WillOnce(
+                Invoke(
+                    [this](WindowInfo const& window_info)
+                        { window = window_info.window(); }));
+
+        basic_window_manager.add_surface(session, creation_parameters, &create_surface);
+        basic_window_manager.select_active_window(window);
+
+        // Clear the expectations used to capture parent & child
+        Mock::VerifyAndClearExpectations(window_manager_policy);
+    }
+};
+}
+
+using ForMoveableTypes = DragActiveWindow;
+using ForUnmoveableTypes = DragActiveWindow;
+
+TEST_P(ForMoveableTypes, moves)
+{
+    create_window_of_type(GetParam());
+
+    Displacement const movement{10, 10};
+    auto const initial_position = window.top_left();
+    auto const expected_position = initial_position + movement;
+
+    EXPECT_CALL(*window_manager_policy, advise_move_to(_, expected_position));
+
+    window_manager_tools.drag_active_window(movement);
+
+    EXPECT_THAT(window.top_left(), Eq(expected_position))
+                << "Type: " << GetParam();
+}
+
+TEST_P(ForUnmoveableTypes, doesnt_move)
+{
+    create_window_of_type(GetParam());
+
+    Displacement const movement{10, 10};
+    auto const expected_position = window.top_left();
+
+    EXPECT_CALL(*window_manager_policy, advise_move_to(_, _)).Times(0);
+
+    window_manager_tools.drag_active_window(movement);
+
+    EXPECT_THAT(window.top_left(), Eq(expected_position))
+                << "Type: " << GetParam();
+}
+
+// When a surface is moved interactively
+// -------------------------------------
+// Regular, floating regular, dialog, and satellite surfaces should be user-movable.
+// Popups, glosses, and tips should not be.
+// Freestyle surfaces may or may not be, as specified by the app.
+//                              Mir and Unity: Surfaces, input, and displays (v0.3)
+INSTANTIATE_TEST_CASE_P(DragActiveWindow, ForMoveableTypes, ::testing::Values(
+    mir_surface_type_normal,
+    mir_surface_type_utility,
+    mir_surface_type_dialog,
+//    mir_surface_type_overlay,
+//    mir_surface_type_gloss,
+    mir_surface_type_freestyle,
+//    mir_surface_type_popover,
+//    mir_surface_type_menu,
+//    mir_surface_type_inputmethod,
+    mir_surface_type_satellite
+//    mir_surface_type_tip,
+//    mir_surface_types
+));
+
+
+INSTANTIATE_TEST_CASE_P(DragActiveWindow, ForUnmoveableTypes, ::testing::Values(
+//    mir_surface_type_normal,
+//    mir_surface_type_utility,
+//    mir_surface_type_dialog,
+    mir_surface_type_overlay,
+    mir_surface_type_gloss,
+//    mir_surface_type_freestyle,
+    mir_surface_type_popover,
+    mir_surface_type_menu,
+    mir_surface_type_inputmethod,
+//    mir_surface_type_satellite,
+    mir_surface_type_tip
+//    mir_surface_types
+));