Merge lp:~afrantzis/unity-system-compositor/fix-1473418-external-spinner-tests into lp:unity-system-compositor

[Alexandros Frantzis]

Wait a bit for spinner process to appear in AnExternalSpinner tests

Wait a bit for spinner process to appear in AnExternalSpinner tests

[lp:~afrantzis/unity-system-compositor/fix-1473418-external-spinner-tests]

225. By Alexandros Frantzis on 2015-07-10

Add forgotten files

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:225
http://jenkins.qa.ubuntu.com/job/unity-system-compositor-ci/241/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-amd64-ci/29
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-armhf-ci/29
        deb: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-armhf-ci/29/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-system-compositor-wily-i386-ci/29

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-system-compositor-ci/241/rebuild

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

lgtm

review: Approve

=== modified file 'tests/integration-tests/CMakeLists.txt'
--- tests/integration-tests/CMakeLists.txt	2015-04-07 13:36:48 +0000
+++ tests/integration-tests/CMakeLists.txt	2015-07-10 12:10:34 +0000
@@ -32,6 +32,7 @@
   run_command.cpp
   dbus_bus.cpp
   dbus_client.cpp
+  spin_wait.cpp
   test_dbus_event_loop.cpp
   test_unity_screen_service.cpp
   test_external_spinner.cpp

=== added file 'tests/integration-tests/spin_wait.cpp'
--- tests/integration-tests/spin_wait.cpp	1970-01-01 00:00:00 +0000
+++ tests/integration-tests/spin_wait.cpp	2015-07-10 12:10:34 +0000
@@ -0,0 +1,39 @@
+/*
+ * Copyright © 2015 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: Alexandros Frantzis <[e-mail]>
+ */
+
+#include "spin_wait.h"
+
+#include <thread>
+
+bool usc::test::spin_wait_for_condition_or_timeout(
+    std::function<bool()> const& condition,
+    std::chrono::milliseconds timeout,
+    std::chrono::milliseconds spin_period)
+{
+    auto const end = std::chrono::steady_clock::now() + timeout;
+    bool condition_fulfilled = false;
+    
+    while (std::chrono::steady_clock::now() < end &&
+           !(condition_fulfilled = condition()))
+    {
+        std::this_thread::sleep_for(spin_period);
+    }   
+
+    return condition_fulfilled;
+}
+

=== added file 'tests/integration-tests/spin_wait.h'
--- tests/integration-tests/spin_wait.h	1970-01-01 00:00:00 +0000
+++ tests/integration-tests/spin_wait.h	2015-07-10 12:10:34 +0000
@@ -0,0 +1,39 @@
+/*
+ * Copyright © 2015 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: Alexandros Frantzis <[e-mail]>
+ */
+
+#ifndef USC_SPIN_WAIT_H_
+#define USC_SPIN_WAIT_H_
+
+#include <functional>
+#include <chrono>
+
+namespace usc
+{
+namespace test
+{
+
+
+bool spin_wait_for_condition_or_timeout(
+    std::function<bool()> const& condition,
+    std::chrono::milliseconds timeout,
+    std::chrono::milliseconds spin_period = std::chrono::milliseconds{10});
+
+}
+}
+
+#endif

=== modified file 'tests/integration-tests/test_external_spinner.cpp'
--- tests/integration-tests/test_external_spinner.cpp	2015-04-01 17:11:57 +0000
+++ tests/integration-tests/test_external_spinner.cpp	2015-07-10 12:10:34 +0000
@@ -18,6 +18,7 @@
 
 #include "src/external_spinner.h"
 #include "run_command.h"
+#include "spin_wait.h"
 
 #include <fstream>
 #include <chrono>
@@ -74,12 +75,21 @@
 {
     std::vector<pid_t> spinner_pids()
     {
-        return pidof(spinner_cmd);
+        std::vector<pid_t> pids;
+
+        usc::test::spin_wait_for_condition_or_timeout(
+            [&pids, this] { pids = pidof(spinner_cmd); return !pids.empty(); },
+            timeout);
+
+        if (pids.empty())
+            BOOST_THROW_EXCEPTION(std::runtime_error("spinner_pids timed out"));
+
+        return pids;
     }
 
     std::vector<std::string> environment_of_spinner()
     {
-        auto const pids = pidof(spinner_cmd);
+        auto const pids = spinner_pids();
         if (pids.size() > 1)
             BOOST_THROW_EXCEPTION(std::runtime_error("Detected multiple spinner processes"));
         std::vector<std::string> env;
@@ -96,19 +106,14 @@
 
     void wait_for_spinner_to_terminate()
     {
-        auto const timeout = std::chrono::milliseconds{3000};
-        auto const expire = std::chrono::steady_clock::now() + timeout;
-
-        while (spinner_pids().size() > 0)
-        {
-            if (std::chrono::steady_clock::now() > expire)
-                BOOST_THROW_EXCEPTION(std::runtime_error("wait_for_no_spinner timed out"));
-            std::this_thread::sleep_for(std::chrono::milliseconds{10});
-        }
+        usc::test::spin_wait_for_condition_or_timeout(
+            [this] { return pidof(spinner_cmd).empty(); },
+            timeout);
     }
 
     std::string const spinner_cmd{executable_path() + "/usc_test_helper_wait_for_signal"};
     std::string const mir_socket{"usc_mir_socket"};
+    std::chrono::milliseconds const timeout{3000};
     usc::ExternalSpinner spinner{spinner_cmd, mir_socket};
 };