Merge lp:~alan-griffiths/mir/in-process-server-test-fixture into lp:mir

[Alan Griffiths]

tests: test fixture to run an in-process Mir server

tests: test fixture to run an in-process Mir server

I was really doing this to simplify testing message passing but, as we've changed direction I've split it out. It makes sense as a separate MP anyway.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1289
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/534/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/433
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/429
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/39/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/260
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/260/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/263
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/263/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/39
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/39/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/75/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2345

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

review: Needs Fixing (continuous-integration)

[Chris Halse Rogers (raof)]

You appear to have a half-finished tests/acceptance-tests/test_message_passing.cpp in the merge.

With that removed, looks good to me.

review: Needs Fixing

[Daniel van Vugt (vanvugt)]

1. Aren't these two statements potentially in conflict?...
6 + * Copyright © 2013 Canonical Ltd.
20 + * Authored by: Alan Griffiths <email address hidden>
Should you be putting your Canonical email address there instead?

2. Local variable "display_server" masks member variable of the same name:
214 +mir::DisplayServer* mtf::InProcessServer::start_mir_server()
If would be clearer to use a different name.

review: Needs Fixing

[Alan Griffiths (alan-griffiths)]

> 1. Aren't these two statements potentially in conflict?...
> 6 + * Copyright © 2013 Canonical Ltd.
> 20 + * Authored by: Alan Griffiths <email address hidden>
> Should you be putting your Canonical email address there instead?

What's the conflict? I do this work for Octopull Limited and the copyright is assigned to Canonical Ltd.

> 2. Local variable "display_server" masks member variable of the same name:
> 214 +mir::DisplayServer* mtf::InProcessServer::start_mir_server()
> If would be clearer to use a different name.

ack - fixed

[Alan Griffiths (alan-griffiths)]

> You appear to have a half-finished tests/acceptance-
> tests/test_message_passing.cpp in the merge.
>
> With that removed, looks good to me.

I don't think I can just remove it - as then there would be no test of this fixture. But I agree, the current version is misleading.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1290
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/548/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/459
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/455
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/65/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/274
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/274/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/277
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/277/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/65
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/65/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/99/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2419

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1291
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/550/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/462
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/458
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/67/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/276
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/276/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/279
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/279/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/67
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/67/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/101/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2428

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1291
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/554/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/470
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/466
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/76
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/280
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/280/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/283
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/283/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/76
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/76/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/111
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2454

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

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-autolanding/246/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/475/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/471
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/81
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-autolanding/148
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-autolanding/148/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-autolanding/149
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-autolanding/149/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/81
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/81/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/114
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2466

review: Needs Fixing (continuous-integration)

[Alan Griffiths (alan-griffiths)]

Failure looks like a blip in the dependencies: re-approving

[Daniel van Vugt (vanvugt)]

Why do we have "blips"?

[Alan Griffiths (alan-griffiths)]

> Why do we have "blips"?

I don't know. But, if real, the errors reported should affect CI builds and other targets, not just autolanding.

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-autolanding/249/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/480/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/476
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/86
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-autolanding/151
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-autolanding/151/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-autolanding/152
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-autolanding/152/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/86
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/86/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/118
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2485

review: Needs Fixing (continuous-integration)

[Alan Griffiths (alan-griffiths)]

OK the blip was bug 1262305 - and that comes from a duff "partial chroot" setup that picked up some native system headers and the having a native g++4.8.2 vs armhf g++ g++4.8.1.

Re-approving now fix has landed

[Chris Halse Rogers (raof)]

Hurray! No more stub test :)

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== added file 'include/test/mir_test_framework/in_process_server.h'
--- include/test/mir_test_framework/in_process_server.h	1970-01-01 00:00:00 +0000
+++ include/test/mir_test_framework/in_process_server.h	2013-12-17 10:31:58 +0000
@@ -0,0 +1,61 @@
+/*
+ * Copyright © 2013 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]>
+ */
+
+#ifndef MIR_TEST_FRAMEWORK_IN_PROCESS_SERVER_H_
+#define MIR_TEST_FRAMEWORK_IN_PROCESS_SERVER_H_
+
+#include <gtest/gtest.h>
+
+#include <string>
+#include <thread>
+
+namespace mir
+{
+class DisplayServer;
+class DefaultServerConfiguration;
+}
+
+
+namespace mir_test_framework
+{
+/// Fixture for running Mir server in test process
+struct InProcessServer : testing::Test
+{
+    ~InProcessServer();
+
+    /// Starts the server
+    /// \warning don't forget to call this if you override SetUp()
+    void SetUp() override;
+
+    /// Stops the server
+    /// \warning don't forget to call this if you override TearDown()
+    void TearDown() override;
+
+    /// \return a connection string for a new client to connect to the server
+    std::string new_connection();
+
+private:
+    mir::DisplayServer* start_mir_server();
+    virtual mir::DefaultServerConfiguration& server_config() = 0;
+
+    std::thread server_thread;
+    mir::DisplayServer* display_server = 0;
+};
+}
+
+#endif /* MIR_TEST_FRAMEWORK_IN_PROCESS_SERVER_H_ */

=== modified file 'tests/acceptance-tests/test_test_framework.cpp'
--- tests/acceptance-tests/test_test_framework.cpp	2013-09-24 11:07:53 +0000
+++ tests/acceptance-tests/test_test_framework.cpp	2013-12-17 10:31:58 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2012 Canonical Ltd.
+ * Copyright © 2012, 2013 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
@@ -17,8 +17,10 @@
  */
 
 #include "mir_test_framework/display_server_test_fixture.h"
+#include "mir_test_framework/testing_server_configuration.h"
+#include "mir_test_framework/in_process_server.h"
 
-#include "mir/frontend/connector.h"
+#include "mir_toolkit/mir_client_library.h"
 
 #include <gmock/gmock.h>
 #include <gtest/gtest.h>
@@ -64,3 +66,21 @@
         launch_client_process(demo);
     }
 }
+
+namespace
+{
+struct DemoInProcessServer : mir_test_framework::InProcessServer
+{
+    virtual mir::DefaultServerConfiguration& server_config() { return server_config_; }
+
+    TestingServerConfiguration server_config_;
+};
+}
+
+TEST_F(DemoInProcessServer, client_can_connect)
+{
+    auto const connection = mir_connect_sync(new_connection().c_str(), __PRETTY_FUNCTION__);
+    EXPECT_TRUE(mir_connection_is_valid(connection));
+
+    mir_connection_release(connection);
+}

=== modified file 'tests/mir_test_framework/CMakeLists.txt'
--- tests/mir_test_framework/CMakeLists.txt	2013-12-13 03:23:51 +0000
+++ tests/mir_test_framework/CMakeLists.txt	2013-12-17 10:31:58 +0000
@@ -10,6 +10,7 @@
   TEST_FRAMEWORK_SRCS
 
   cross_process_sync.cpp
+  in_process_server.cpp
   testing_server_options.cpp
   input_testing_server_options.cpp
   input_testing_client_configuration.cpp

=== added file 'tests/mir_test_framework/in_process_server.cpp'
--- tests/mir_test_framework/in_process_server.cpp	1970-01-01 00:00:00 +0000
+++ tests/mir_test_framework/in_process_server.cpp	2013-12-17 10:31:58 +0000
@@ -0,0 +1,90 @@
+/*
+ * Copyright © 2013 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_test_framework/in_process_server.h"
+
+#include "mir/default_server_configuration.h"
+#include "mir/display_server.h"
+#include "mir/frontend/connector.h"
+#include "mir/run_mir.h"
+
+#include <gtest/gtest.h>
+
+#include <condition_variable>
+#include <mutex>
+
+namespace mtf = mir_test_framework;
+
+void mtf::InProcessServer::SetUp()
+{
+    display_server = start_mir_server();
+    ASSERT_TRUE(display_server);
+}
+
+std::string mtf::InProcessServer::new_connection()
+{
+    char connect_string[64] = {0};
+    sprintf(connect_string, "fd://%d", server_config().the_connector()->client_socket_fd());
+    return connect_string;
+}
+
+void mtf::InProcessServer::TearDown()
+{
+    ASSERT_TRUE(display_server)
+        << "Did you override SetUp() and forget to call mtf::InProcessServer::SetUp()?";
+    display_server->stop();
+}
+
+mtf::InProcessServer::~InProcessServer()
+{
+    if (server_thread.joinable()) server_thread.join();
+}
+
+mir::DisplayServer* mtf::InProcessServer::start_mir_server()
+{
+    std::mutex mutex;
+    std::condition_variable cv;
+    mir::DisplayServer* result{nullptr};
+
+    server_thread = std::thread([&]
+    {
+        try
+        {
+            mir::run_mir(server_config(), [&](mir::DisplayServer& ds)
+            {
+                std::unique_lock<std::mutex> lock(mutex);
+                result = &ds;
+                cv.notify_one();
+            });
+        }
+        catch (std::exception const& e)
+        {
+            FAIL() << e.what();
+        }
+    });
+
+    using namespace std::chrono;
+    auto const time_limit = system_clock::now() + seconds(2);
+
+    std::unique_lock<std::mutex> lock(mutex);
+
+    while (!result && time_limit > system_clock::now())
+        cv.wait_until(lock, time_limit);
+
+    return result;
+}