Merge lp:~alan-griffiths/miral/test-active-window into lp:miral

[Alan Griffiths]

Add some initial tests of tools.active_window() and fixes that make them pass

Add some initial tests of tools.active_window() and fixes that make them pass

Experimenting with mircade I found that restoring the only window from a hidden state left active_window() unset. So these initial tests cover this minimal case and the fixture is ready to support additional tests (which I plan to work on soon).

[lp:~alan-griffiths/miral/test-active-window]

450. By Alan Griffiths on 2016-11-16

tweak code

451. By Alan Griffiths on 2016-11-16

 More tests, tighter conditions

452. By Alan Griffiths on 2016-11-16

Ensure a single window is notified of focus loss when hidden

[Cemil Azizoglu (cemil-azizoglu)]

Looks good

review: Approve

[Gerry Boland (gerboland)]

review: Approve

=== modified file 'miral/basic_window_manager.cpp'
--- miral/basic_window_manager.cpp	2016-11-15 12:19:31 +0000
+++ miral/basic_window_manager.cpp	2016-11-16 12:50:51 +0000
@@ -863,6 +863,9 @@
         return;
     }
 
+    bool const was_hidden = window_info.state() == mir_surface_state_hidden ||
+                            window_info.state() == mir_surface_state_minimized;
+
     policy->advise_state_change(window_info, value);
     window_info.state(value);
 
@@ -886,11 +889,18 @@
                     auto const w = candidate;
                     return !(select_active_window(w));
                 });
+
+            if (window == active_window())
+                select_active_window({});
+
+            mru_active_windows.erase(window);
         }
         break;
 
     default:
         mir_surface->show();
+        if (was_hidden && !active_window())
+            select_active_window(window);
     }
 }
 

=== modified file 'test/CMakeLists.txt'
--- test/CMakeLists.txt	2016-11-15 12:18:29 +0000
+++ test/CMakeLists.txt	2016-11-16 12:50:51 +0000
@@ -40,7 +40,9 @@
     modify_window_state.cpp
     test_server.cpp         test_server.h
     test_window_manager_tools.h
-        display_reconfiguration.cpp)
+    display_reconfiguration.cpp
+    active_window.cpp
+)
 
 target_link_libraries(miral-test
     ${MIRTEST_LDFLAGS}

=== added file 'test/active_window.cpp'
--- test/active_window.cpp	1970-01-01 00:00:00 +0000
+++ test/active_window.cpp	2016-11-16 12:50:51 +0000
@@ -0,0 +1,179 @@
+/*
+ * 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_server.h"
+
+#include <miral/toolkit/surface.h>
+#include <miral/toolkit/surface_spec.h>
+#include <mir_toolkit/mir_buffer_stream.h>
+
+#include <miral/application_info.h>
+
+#include <mir/test/signal.h>
+
+#include <gtest/gtest.h>
+
+using namespace testing;
+using namespace miral::toolkit;
+using namespace std::chrono_literals;
+
+namespace
+{
+class FocusChangeSync
+{
+public:
+    void exec(std::function<void()> const& f)
+    {
+        signal.reset();
+        f();
+        signal.wait_for(100ms);
+    }
+
+    static void raise_signal_on_focus_change(MirSurface* /*surface*/, MirEvent const* event, void* context)
+    {
+        if (mir_event_get_type(event) == mir_event_type_surface &&
+            mir_surface_event_get_attribute(mir_event_get_surface_event(event)) == mir_surface_attrib_focus)
+        {
+            ((FocusChangeSync*)context)->signal.raise();
+        }
+    }
+
+    auto signal_raised() -> bool { return signal.raised(); }
+
+private:
+    mir::test::Signal signal;
+};
+
+struct ActiveWindow : public miral::TestServer
+{
+    FocusChangeSync sync1;
+    FocusChangeSync sync2;
+
+    auto create_surface(Connection const& connection, char const* name, FocusChangeSync& sync) -> Surface
+    {
+        auto const spec = SurfaceSpec::for_normal_surface(connection, 50, 50, mir_pixel_format_argb_8888)
+            .set_buffer_usage(mir_buffer_usage_software)
+            .set_event_handler(&FocusChangeSync::raise_signal_on_focus_change, &sync)
+            .set_name(name);
+
+        Surface const surface{spec.create_surface()};
+
+        sync.exec([&]{ mir_buffer_stream_swap_buffers_sync(mir_surface_get_buffer_stream(surface)); });
+        EXPECT_TRUE(sync.signal_raised());
+
+        return surface;
+    }
+
+    void assert_no_active_window()
+    {
+        invoke_tools([&](miral::WindowManagerTools& tools)
+            {
+                auto const window = tools.active_window();
+                ASSERT_FALSE(window);
+            });
+    }
+
+    void assert_active_window_is(char const* const name)
+    {
+        invoke_tools([&](miral::WindowManagerTools& tools)
+            {
+                 auto const window = tools.active_window();
+                 ASSERT_TRUE(window);
+                 auto const& window_info = tools.info_for(window);
+                 ASSERT_THAT(window_info.name(), Eq(name));
+            });
+    }
+};
+}
+
+TEST_F(ActiveWindow, a_single_window_when_ready_becomes_active)
+{
+    char const* const test_name = __PRETTY_FUNCTION__;
+    auto const connection = connect_client(test_name);
+
+    auto const surface = create_surface(connection, test_name, sync1);
+
+    assert_active_window_is(test_name);
+}
+
+TEST_F(ActiveWindow, a_single_window_when_hiding_becomes_inactive)
+{
+    char const* const test_name = __PRETTY_FUNCTION__;
+    auto const connection = connect_client(test_name);
+    auto const surface = create_surface(connection, test_name, sync1);
+
+    sync1.exec([&]{ mir_surface_set_state(surface, mir_surface_state_hidden); });
+
+    EXPECT_TRUE(sync1.signal_raised());
+    assert_no_active_window();
+}
+
+TEST_F(ActiveWindow, a_single_window_when_unhiding_becomes_active)
+{
+    char const* const test_name = __PRETTY_FUNCTION__;
+    auto const connection = connect_client(test_name);
+    auto const surface = create_surface(connection, test_name, sync1);
+    sync1.exec([&]{ mir_surface_set_state(surface, mir_surface_state_hidden); });
+
+    sync1.exec([&]{ mir_surface_set_state(surface, mir_surface_state_restored); });
+    EXPECT_TRUE(sync1.signal_raised());
+
+    assert_active_window_is(test_name);
+}
+
+TEST_F(ActiveWindow, a_second_window_when_ready_becomes_active)
+{
+    char const* const test_name = __PRETTY_FUNCTION__;
+    auto const connection = connect_client(test_name);
+
+    auto const first_surface = create_surface(connection, "first", sync1);
+    auto const surface = create_surface(connection, test_name, sync2);
+
+    assert_active_window_is(test_name);
+}
+
+TEST_F(ActiveWindow, a_second_window_hiding_makes_first_active)
+{
+    char const* const test_name = __PRETTY_FUNCTION__;
+    auto const connection = connect_client(test_name);
+
+    auto const first_surface = create_surface(connection, test_name, sync1);
+    auto const surface = create_surface(connection, "second", sync2);
+
+    sync2.exec([&]{ mir_surface_set_state(surface, mir_surface_state_hidden); });
+
+    EXPECT_TRUE(sync2.signal_raised());
+    assert_active_window_is(test_name);
+}
+
+TEST_F(ActiveWindow, a_second_window_unhiding_leaves_first_active)
+{
+    char const* const test_name = __PRETTY_FUNCTION__;
+    auto const connection = connect_client(test_name);
+
+    auto const first_surface = create_surface(connection, test_name, sync1);
+    auto const surface = create_surface(connection, "second", sync2);
+
+    sync1.exec([&]{ mir_surface_set_state(surface, mir_surface_state_hidden); });
+
+    // Expect this to timeout
+    sync2.exec([&]{ mir_surface_set_state(surface, mir_surface_state_restored); });
+
+    EXPECT_THAT(sync2.signal_raised(), Eq(false));
+    assert_active_window_is(test_name);
+}