Merge lp:~mir-team/mir/set-state-remove-mir-wait into lp:mir

[Brandon Schaefer]

Remove the wait handle for set_state and use the old version for tests.

Remove the wait handle for set_state and use the old version for tests.

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

FAILED: Continuous integration, rev:3936
https://mir-jenkins.ubuntu.com/job/mir-ci/2698/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3504/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3572
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3562
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3562
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3562
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3531
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3531/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3531
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3531/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3531/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3531
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3531/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3531
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3531/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3531
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3531/artifact/output/*zip*/output.zip

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

review: Needs Fixing (continuous-integration)

[Alan Griffiths (alan-griffiths)]

Using the old version seems like storing up problems for later.

/1/ We should have tests that validate the new versions.

/2/ While the old versions do need tests in this release, they are going to be deleted in 0.1.

I'd like to see corresponding tests covering both new and old APIs (and the latter tests can simply be deleted with the APIs).

review: Needs Information

[Cemil Azizoglu (cemil-azizoglu)]

I agree with Alan.

We need to port the instances where this API is used to the new way including the tests. In the process of doing that we'll eliminate the possibility of releasing something that isn't useful/useable. We won't know that until/unless we do the work ourselves.

Don't worry about the time too much. Let's do the right thing.

review: Needs Fixing

Unmerged revisions

3936. By Brandon Schaefer on 2017-01-13

* Remove mir_wait_handle

=== modified file 'include/client/mir_toolkit/mir_surface.h'
--- include/client/mir_toolkit/mir_surface.h	2017-01-13 22:52:30 +0000
+++ include/client/mir_toolkit/mir_surface.h	2017-01-13 22:52:30 +0000
@@ -678,10 +678,9 @@
  * Change the state of a window.
  *   \param [in] window  The window to operate on
  *   \param [in] state   The new state of the window
- *   \return             A wait handle that can be passed to mir_wait_for
  */
-MirWaitHandle* mir_window_set_state(MirWindow* window,
-                                     MirWindowState state);
+void mir_window_set_state(MirWindow* window,
+                          MirWindowState state);
 
 /**
  * Get the current state of a window.

=== modified file 'src/client/mir_surface_api.cpp'
--- src/client/mir_surface_api.cpp	2017-01-13 22:52:30 +0000
+++ src/client/mir_surface_api.cpp	2017-01-13 22:52:30 +0000
@@ -528,6 +528,23 @@
     }
 }
 
+static MirWaitHandle* mir_window_set_state_helper(
+    MirWindow* window,
+    MirWindowState state)
+{
+    mir::require(mir_window_is_valid(window));
+
+    try
+    {
+        return window->configure(mir_window_attrib_state, state);
+    }
+    catch (std::exception const& ex)
+    {
+        MIR_LOG_UNCAUGHT_EXCEPTION(ex);
+        return nullptr;
+    }
+}
+
 class WindowSync
 {
 public:
@@ -657,17 +674,9 @@
     return type;
 }
 
-MirWaitHandle* mir_window_set_state(MirWindow* window, MirWindowState state)
+void mir_window_set_state(MirWindow* window, MirWindowState state)
 {
-    try
-    {
-        return window ? window->configure(mir_window_attrib_state, state) : nullptr;
-    }
-    catch (std::exception const& ex)
-    {
-        MIR_LOG_UNCAUGHT_EXCEPTION(ex);
-        return nullptr;
-    }
+    mir_window_set_state_helper(window, state);
 }
 
 MirWindowState mir_window_get_state(MirWindow* window)
@@ -1189,7 +1198,7 @@
 
 MirWaitHandle* mir_surface_set_state(MirSurface* surf, MirSurfaceState state)
 {
-    return mir_window_set_state(surf, static_cast<MirWindowState>(state));
+    return mir_window_set_state_helper(surf, static_cast<MirWindowState>(state));
 }
 
 MirSurfaceState mir_surface_get_state(MirSurface* surf)

=== modified file 'tests/acceptance-tests/test_client_library.cpp'
--- tests/acceptance-tests/test_client_library.cpp	2017-01-12 16:45:44 +0000
+++ tests/acceptance-tests/test_client_library.cpp	2017-01-13 22:52:30 +0000
@@ -246,14 +246,17 @@
     {
         for (int i = 0; i < 10; i++)
         {
-            mir_wait_for_one(mir_window_set_state(surf,
-                                            mir_window_state_maximized));
-            mir_wait_for_one(mir_window_set_state(surf,
-                                            mir_window_state_restored));
-            mir_wait_for_one(mir_window_set_state(surf,
-                                            mir_window_state_fullscreen));
-            mir_wait_for_one(mir_window_set_state(surf,
-                                            mir_window_state_minimized));
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+            mir_wait_for_one(mir_surface_set_state(surf,
+                                            mir_surface_state_maximized));
+            mir_wait_for_one(mir_surface_set_state(surf,
+                                            mir_surface_state_restored));
+            mir_wait_for_one(mir_surface_set_state(surf,
+                                            mir_surface_state_fullscreen));
+            mir_wait_for_one(mir_surface_set_state(surf,
+                                            mir_surface_state_minimized));
+#pragma GCC diagnostic pop
         }
     }
 };
@@ -405,24 +408,30 @@
 
     EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_restored));
 
-    mir_wait_for(mir_window_set_state(window, mir_window_state_fullscreen));
-    EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_fullscreen));
-
-    mir_wait_for(mir_window_set_state(window, static_cast<MirWindowState>(999)));
-    EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_fullscreen));
-
-    mir_wait_for(mir_window_set_state(window, mir_window_state_horizmaximized));
-    EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_horizmaximized));
-
-    mir_wait_for(mir_window_set_state(window, static_cast<MirWindowState>(888)));
-    EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_horizmaximized));
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+    mir_wait_for(mir_surface_set_state(window, mir_surface_state_fullscreen));
+    EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_fullscreen));
+
+    mir_wait_for(mir_surface_set_state(window, static_cast<MirSurfaceState>(999)));
+    EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_fullscreen));
+
+    mir_wait_for(mir_surface_set_state(window, mir_surface_state_horizmaximized));
+    EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_horizmaximized));
+
+    mir_wait_for(mir_surface_set_state(window, static_cast<MirSurfaceState>(888)));
+    EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_horizmaximized));
+#pragma GCC diagnostic pop
 
     // Stress-test synchronization logic with some flooding
     for (int i = 0; i < 100; i++)
     {
         mir_window_set_state(window, mir_window_state_maximized);
         mir_window_set_state(window, mir_window_state_restored);
-        mir_wait_for(mir_window_set_state(window, mir_window_state_fullscreen));
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+        mir_wait_for(mir_surface_set_state(window, mir_surface_state_fullscreen));
+#pragma GCC diagnostic pop
         ASSERT_THAT(mir_window_get_state(window), Eq(mir_window_state_fullscreen));
     }
 

=== modified file 'tests/acceptance-tests/test_client_surface_events.cpp'
--- tests/acceptance-tests/test_client_surface_events.cpp	2017-01-11 20:17:22 +0000
+++ tests/acceptance-tests/test_client_surface_events.cpp	2017-01-13 22:52:30 +0000
@@ -196,9 +196,11 @@
 
 TEST_F(ClientSurfaceEvents, surface_receives_state_events)
 {
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
     {
-        mir_wait_for(mir_window_set_state(window, mir_window_state_fullscreen));
-        mir_wait_for(mir_window_set_state(other_surface, mir_window_state_vertmaximized));
+        mir_wait_for(mir_surface_set_state(window, mir_surface_state_fullscreen));
+        mir_wait_for(mir_surface_set_state(other_surface, mir_surface_state_vertmaximized));
 
         std::lock_guard<decltype(last_event_mutex)> last_event_lock{last_event_mutex};
 
@@ -206,7 +208,7 @@
     }
 
     {
-        mir_wait_for(mir_window_set_state(window, static_cast<MirWindowState>(999)));
+        mir_wait_for(mir_surface_set_state(window, static_cast<MirSurfaceState>(999)));
 
         std::lock_guard<decltype(last_event_mutex)> last_event_lock{last_event_mutex};
         EXPECT_THAT(last_event, mt::WindowEvent(mir_window_attrib_state, mir_window_state_fullscreen));
@@ -215,7 +217,7 @@
     reset_last_event();
 
     {
-        mir_wait_for(mir_window_set_state(window, mir_window_state_vertmaximized));
+        mir_wait_for(mir_surface_set_state(window, mir_surface_state_vertmaximized));
 
         std::lock_guard<decltype(last_event_mutex)> last_event_lock{last_event_mutex};
 
@@ -225,13 +227,14 @@
     reset_last_event();
 
     {
-        mir_wait_for(mir_window_set_state(window, static_cast<MirWindowState>(777)));
-        mir_wait_for(mir_window_set_state(other_surface, mir_window_state_maximized));
+        mir_wait_for(mir_surface_set_state(window, static_cast<MirSurfaceState>(777)));
+        mir_wait_for(mir_surface_set_state(other_surface, mir_surface_state_maximized));
 
         std::lock_guard<decltype(last_event_mutex)> last_event_lock{last_event_mutex};
 
         EXPECT_EQ(nullptr, last_event);
     }
+#pragma GCC diagnostic pop
 }
 
 struct OrientationEvents : ClientSurfaceEvents, ::testing::WithParamInterface<MirOrientation> {};
@@ -274,6 +277,7 @@
     }
 }
 
+
 TEST_F(ClientSurfaceEvents, surface_receives_close_event)
 {
     set_event_filter(mir_event_type_close_window);

=== modified file 'tests/acceptance-tests/test_shell_control_of_surface_configuration.cpp'
--- tests/acceptance-tests/test_shell_control_of_surface_configuration.cpp	2017-01-12 16:45:44 +0000
+++ tests/acceptance-tests/test_shell_control_of_surface_configuration.cpp	2017-01-13 22:52:30 +0000
@@ -87,8 +87,10 @@
 {
     EXPECT_CALL(*mock_window_manager,
         set_surface_attribute(_, _, mir_window_attrib_state, Eq(mir_window_state_maximized)));
-
-    mir_wait_for(mir_window_set_state(window, mir_window_state_maximized));
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+    mir_wait_for(mir_surface_set_state(window, mir_surface_state_maximized));
+#pragma GCC diagnostic pop
 
     EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_maximized));
 }
@@ -108,8 +110,10 @@
     EXPECT_CALL(*mock_window_manager,
         set_surface_attribute(_, _, mir_window_attrib_state, Eq(mir_window_state_maximized)))
         .WillOnce(Invoke(set_to_vertmax));
-
-    mir_wait_for(mir_window_set_state(window, mir_window_state_maximized));
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+    mir_wait_for(mir_surface_set_state(window, mir_surface_state_maximized));
+#pragma GCC diagnostic pop
 
     EXPECT_THAT(mir_window_get_state(window), Eq(mir_window_state_vertmaximized));
 }

=== modified file 'tests/acceptance-tests/test_surface_modifications.cpp'
--- tests/acceptance-tests/test_surface_modifications.cpp	2017-01-10 23:55:25 +0000
+++ tests/acceptance-tests/test_surface_modifications.cpp	2017-01-13 22:52:30 +0000
@@ -572,8 +572,11 @@
     EXPECT_CALL(surface_observer, hidden_set_to(is_visible(initial_state)));
     EXPECT_CALL(surface_observer, hidden_set_to(is_visible(new_state)));
 
-    mir_wait_for(mir_window_set_state(window, initial_state));
-    mir_wait_for(mir_window_set_state(window, new_state));
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+    mir_wait_for(mir_surface_set_state(window, static_cast<MirSurfaceState>(initial_state)));
+    mir_wait_for(mir_surface_set_state(window, static_cast<MirSurfaceState>(new_state)));
+#pragma GCC diagnostic pop
 }
 
 INSTANTIATE_TEST_CASE_P(SurfaceModifications, SurfaceStateCase,