Merge lp:~robertcarr/mir/power-control-swap-buffer-acceptance-test into lp:mir

[Robert Carr]

Add acceptance test for behavior of client power control and buffer advancing.

While discussing this feature today with mterry I noticed we have no acceptance test for it!

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1453
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/995/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/1141
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/1139
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/724
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/727
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/727/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/732
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/732/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/725
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/725/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/687
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/4502

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

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

looks okay to me

review: Approve

[Alan Griffiths (alan-griffiths)]

80 +// when the client makes a swap buffers request, swap buffers will block until the screen is reenabled. However even if on the
81 +// client side, swap buffers is called asynchronously, the server side RPC thread will not process another request from this client
82 +// until swap buffers completes

As swap_buffers is non-blocking I don't think this has been true since -r 1398. Am I missing something?

review: Needs Information

=== modified file 'tests/acceptance-tests/CMakeLists.txt'
--- tests/acceptance-tests/CMakeLists.txt	2014-02-10 09:07:48 +0000
+++ tests/acceptance-tests/CMakeLists.txt	2014-03-05 20:28:14 +0000
@@ -20,6 +20,7 @@
   test_server_shutdown.cpp
   test_client_focus_notification.cpp
   test_client_authorization.cpp
+  test_client_power_control.cpp
   test_shell_control_of_surface_configuration.cpp
   test_nested_mir.cpp
   test_display_configuration.cpp

=== added file 'tests/acceptance-tests/test_client_power_control.cpp'
--- tests/acceptance-tests/test_client_power_control.cpp	1970-01-01 00:00:00 +0000
+++ tests/acceptance-tests/test_client_power_control.cpp	2014-03-05 20:28:14 +0000
@@ -0,0 +1,115 @@
+/*
+ * 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: Robert Carr <[e-mail]>
+ */
+
+#include "mir_test_framework/display_server_test_fixture.h"
+
+#include "mir_toolkit/mir_client_library.h"
+
+#include <gtest/gtest.h>
+#include <gmock/gmock.h>
+
+namespace mtf = mir_test_framework;
+
+namespace 
+{
+char const* const mir_test_socket = mtf::test_socket_file().c_str();
+
+static void set_power_modes_to_off(MirDisplayConfiguration *conf)
+{
+    for (unsigned i = 0; i < conf->num_outputs; i++)
+    {
+        auto &output = conf->outputs[i];
+
+        output.power_mode = mir_power_mode_off;
+    }
+}
+
+static void expect_power_modes_are_on(MirDisplayConfiguration *conf)
+{
+    for (unsigned i = 0; i < conf->num_outputs; i++)
+    {
+        auto &output = conf->outputs[i];
+
+        EXPECT_EQ(mir_power_mode_on, output.power_mode);
+    }
+}
+
+static void with_configuration(MirConnection *connection, std::function<void(MirDisplayConfiguration*)> const& exec)
+{
+    auto conf = mir_connection_create_display_config(connection);
+    exec(conf);
+    mir_display_config_destroy(conf);
+}
+}
+
+using ClientPowerControl = BespokeDisplayServerTestFixture;
+
+// When a client has requested to turn the display off, we re-enable it when the client makes a buffer swapping request.
+// This behavior is required due to the serial manner in which we process requests on the server side. If the display is off
+// when the client makes a swap buffers request, swap buffers will block until the screen is reenabled. However even if on the 
+// client side, swap buffers is called asynchronously, the server side RPC thread will not process another request from this client
+// until swap buffers completes. Thus its unfortunately not possible for the client to turn the screen back on!
+TEST_F(ClientPowerControl, client_advancing_buffer_will_override_power_request_made_by_same_client)
+{
+    TestingServerConfiguration server_config;
+    launch_server_process(server_config);
+
+    struct Client : TestingClientConfiguration
+    {
+        void exec()
+        {
+            auto connection = mir_connect_sync(mir_test_socket, __PRETTY_FUNCTION__);
+
+            with_configuration(connection, 
+                [&](MirDisplayConfiguration *c)
+                {
+                    set_power_modes_to_off(c);
+                    mir_connection_apply_display_config(connection, c);
+                });
+            
+            MirSurfaceParameters const params =
+            {
+                __PRETTY_FUNCTION__,
+                1, 1,
+                mir_pixel_format_abgr_8888,
+                mir_buffer_usage_hardware,
+                mir_display_output_id_invalid
+            };
+            auto s = mir_connection_create_surface_sync(connection, &params);
+
+            // Creating a surface advances buffers and thus should flip the power request back to on.
+            with_configuration(connection, expect_power_modes_are_on);
+
+            // Flip them back off.
+            with_configuration(connection, 
+                [&](MirDisplayConfiguration *c)
+                {
+                    set_power_modes_to_off(c);
+                    mir_connection_apply_display_config(connection, c);
+                });
+
+            mir_surface_swap_buffers_sync(s);
+            with_configuration(connection, expect_power_modes_are_on);
+            
+            mir_surface_release_sync(s);
+            mir_connection_release(connection);
+        }
+    } client_config;
+
+    launch_client_process(client_config);
+}