Merge lp:~alan-griffiths/mir/fix-1302689 into lp:mir

[Alan Griffiths]

tests: Provide an integration test that focusing on a session raises its default surface.

tests: Provide an integration test that focusing on a session raises its default surface.

We didn't quite have a test that covers this, but adding the test seems to disprove the assertion in lp:1302689 that this doesn't work.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1541
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/1255/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/1503
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/1501
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/1079
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/987
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/987/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/992
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/992/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/1080
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/1080/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/998
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/5660

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/1255/rebuild

review: Approve (continuous-integration)

[Chris Halse Rogers (raof)]

LGTM

review: Approve

[Alexandros Frantzis (afrantzis)]

Looks good.

Nit:

108 + the_surface_stack_model()

Missing "override". I have fallen into the trap of "overriding" non-existent methods a couple of times during test development, rendering my results meaningless.

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1542
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/1258/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/1506
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/1504
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/1082
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/990
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/990/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/995
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/995/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/1083
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/1083/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/1001
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/5671

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/1258/rebuild

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

Not sure there is any bug yet. But this change doesn't hurt.

review: Approve

=== modified file 'src/server/shell/default_focus_mechanism.cpp'
--- src/server/shell/default_focus_mechanism.cpp	2014-04-03 13:17:52 +0000
+++ src/server/shell/default_focus_mechanism.cpp	2014-04-07 10:44:44 +0000
@@ -54,7 +54,7 @@
         surface->configure(mir_surface_attrib_focus, mir_surface_focused);
         currently_focused_surface = surface;
 
-        surface_coordinator->raise(std::static_pointer_cast<ms::Surface>(surface)); // TODO deal with cast
+        surface_coordinator->raise(surface);
         surface->take_input_focus(input_targeter);
     }
     else

=== modified file 'tests/integration-tests/CMakeLists.txt'
--- tests/integration-tests/CMakeLists.txt	2014-03-06 06:05:17 +0000
+++ tests/integration-tests/CMakeLists.txt	2014-04-07 10:44:44 +0000
@@ -13,6 +13,7 @@
   test_server_client_types.cpp
   test_session_manager.cpp
   test_session.cpp
+  session_management.cpp
 )
 
 add_subdirectory(client/)

=== added file 'tests/integration-tests/session_management.cpp'
--- tests/integration-tests/session_management.cpp	1970-01-01 00:00:00 +0000
+++ tests/integration-tests/session_management.cpp	2014-04-07 10:44:44 +0000
@@ -0,0 +1,153 @@
+/*
+ * Copyright © 2014 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 "mir/frontend/session.h"
+#include "mir/frontend/shell.h"
+#include "mir/input/input_configuration.h"
+
+#include "mir/shell/surface_creation_parameters.h"
+#include "mir/shell/session.h"
+#include "mir/shell/focus_controller.h"
+
+#include "mir/scene/surface.h"
+#include "src/server/scene/surface_stack.h"
+
+#include "mir_test_doubles/null_event_sink.h"
+#include "mir_test_framework/stubbed_server_configuration.h"
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include <vector>
+
+namespace mf = mir::frontend;
+namespace mo = mir::options;
+namespace ms = mir::scene;
+namespace msh = mir::shell;
+namespace mtd = mir::test::doubles;
+
+using namespace testing;
+
+namespace
+{
+struct TestSurfaceStack : public ms::SurfaceStack
+{
+    using ms::SurfaceStack::SurfaceStack;
+
+    MOCK_METHOD3(add_surface, void(
+        std::shared_ptr<ms::Surface> const& surface,
+        ms::DepthId depth,
+        mir::input::InputReceptionMode input_mode));
+
+    MOCK_METHOD1(raise, void(
+        std::weak_ptr<ms::Surface> const& surface));
+
+    void default_add_surface(
+        std::shared_ptr<ms::Surface> const& surface,
+        ms::DepthId depth,
+        mir::input::InputReceptionMode input_mode)
+    {
+        ms::SurfaceStack::add_surface(surface, depth, input_mode);
+    }
+
+    void default_raise(std::weak_ptr<ms::Surface> const& surface)
+    {
+        ms::SurfaceStack::raise(surface);
+    }
+
+};
+
+struct TestConfiguration : public mir_test_framework::StubbedServerConfiguration
+{
+
+    std::shared_ptr<ms::SurfaceStackModel>
+    the_surface_stack_model() override
+    {
+        return surface_stack(
+            [this]()
+            {
+                auto const scene_report = the_scene_report();
+
+                test_surface_stack = std::make_shared<TestSurfaceStack>(
+                    the_input_registrar(),
+                    scene_report);
+
+                the_input_configuration()->set_input_targets(test_surface_stack);
+
+                return test_surface_stack;
+            });
+    }
+
+    std::shared_ptr<TestSurfaceStack> test_surface_stack;
+};
+
+struct SessionManagement : Test
+{
+    TestConfiguration builder;
+    std::shared_ptr<mf::EventSink> const event_sink = std::make_shared<mtd::NullEventSink>();
+    std::shared_ptr<mf::Shell> const session_manager = builder.the_frontend_shell();
+    std::shared_ptr<TestSurfaceStack> const& test_surface_stack = builder.test_surface_stack;
+
+    void SetUp()
+    {
+        ASSERT_THAT(test_surface_stack, Ne(nullptr));
+        ON_CALL(*test_surface_stack, add_surface(_,_,_))
+            .WillByDefault(Invoke(test_surface_stack.get(), &TestSurfaceStack::default_add_surface));
+        ON_CALL(*test_surface_stack, raise(_))
+            .WillByDefault(Invoke(test_surface_stack.get(), &TestSurfaceStack::default_raise));
+    }
+};
+
+MATCHER_P(WeakPtrTo, p, "")
+{
+  return arg.lock() == p;
+}
+}
+
+TEST_F(SessionManagement, creating_a_surface_adds_it_to_scene)
+{
+    msh::SurfaceCreationParameters params;
+
+    auto const session = session_manager->open_session(0, __PRETTY_FUNCTION__, event_sink);
+
+    EXPECT_CALL(*test_surface_stack, add_surface(_,_,_)).Times(1);
+    session->create_surface(params);
+}
+
+TEST_F(SessionManagement, focus_on_a_session_raises_its_surface)
+{
+    EXPECT_CALL(*test_surface_stack, add_surface(_,_,_)).Times(AnyNumber());
+
+    msh::SurfaceCreationParameters params;
+
+    auto const session1 = session_manager->open_session(0, __PRETTY_FUNCTION__, event_sink);
+    auto const surface1 = session1->create_surface(params);
+
+    auto const session2 = session_manager->open_session(0, __PRETTY_FUNCTION__, event_sink);
+    auto surface2 = session2->create_surface(params);
+
+    auto const focus_controller = builder.the_focus_controller();
+    auto const shell_session = std::dynamic_pointer_cast<msh::Session>(session1);
+
+    EXPECT_CALL(*test_surface_stack, raise(WeakPtrTo(session1->get_surface(surface1)))).Times(1);
+
+    focus_controller->set_focus_to(shell_session);
+
+    session1->destroy_surface(surface1);
+    session2->destroy_surface(surface2);
+}