Merge lp:~alan-griffiths/mir/introducing-mir_test_framework-main into lp:mir

[Alan Griffiths]

tests: make it simple for a libmir-test-assist.a user to provide main()

tests: make it simple for a libmir-test-assist.a user to provide main()

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2705
http://jenkins.qa.ubuntu.com/job/mir-ci/4200/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/2999
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-wily-amd64-build/516
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/2947
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/356
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/356/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/2947
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/2947/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/5765
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21486

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/4200/rebuild

review: Approve (continuous-integration)

[Alexandros Frantzis (afrantzis)]

Although a step in the right direction, I think this approach is still too restrictive; we are still forcing *our* way of running the tests, allowing no alternative. For example, this approach doesn't allow users to set some custom googletest behavior, like event handlers.

We should provide a way for users to use our infrastructure independently of any particular (google)test initialization. Since the only prerequisite for using the infrastructure is setting up the test server command line, we would just need to offer an mtf::init() or similar function.

I don't mind offering a convenience mtf::main() as this branch does (but I don't think it's necessary either), but that should be in addition to an mtf::init() type function.

Need discussion

review: Needs Information

[Alexandros Frantzis (afrantzis)]

Looks good.

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:2706
http://jenkins.qa.ubuntu.com/job/mir-ci/4205/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/3009
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-wily-amd64-build/527
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/2957
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/361
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/361/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/2957
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/2957/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/5774
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21504

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/4205/rebuild

review: Approve (continuous-integration)

=== added file 'include/test/mir_test_framework/main.h'
--- include/test/mir_test_framework/main.h	1970-01-01 00:00:00 +0000
+++ include/test/mir_test_framework/main.h	2015-06-26 08:23:20 +0000
@@ -0,0 +1,43 @@
+/*
+ * 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 moredetails.
+ *
+ * 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_MAIN_H
+#define MIR_TEST_FRAMEWORK_MAIN_H
+
+namespace mir_test_framework
+{
+/**
+ * Initialize and run the mir test framework as follows:
+ *
+ *    ::testing::InitGoogleTest(&argc, argv);
+ *    set_commandline(argc, argv);
+ *    return RUN_ALL_TESTS();
+ *
+ * \attention If you override main() for your own purposes call this or do
+ * something equivalent to run the tests.
+ */
+int main(int argc, char* argv[]);
+
+/**
+ * Note the commandline for use in the mir test framework. The parameter list
+ * referenced by argv must remain valid during the tests.
+ */
+void set_commandline(int argc, char* argv[]);
+}
+
+#endif //MIR_TEST_FRAMEWORK_MAIN_H

=== modified file 'tests/mir_test_framework/CMakeLists.txt'
--- tests/mir_test_framework/CMakeLists.txt	2015-06-25 13:55:28 +0000
+++ tests/mir_test_framework/CMakeLists.txt	2015-06-26 08:23:20 +0000
@@ -30,6 +30,7 @@
   headless_nested_server_runner.cpp
   headless_test.cpp
   interprocess_client_server_test.cpp
+  main.cpp
   placement_applying_shell.cpp
   process.cpp
   server_runner.cpp

=== modified file 'tests/mir_test_framework/command_line_server_configuration.cpp'
--- tests/mir_test_framework/command_line_server_configuration.cpp	2015-06-17 05:20:42 +0000
+++ tests/mir_test_framework/command_line_server_configuration.cpp	2015-06-26 08:23:20 +0000
@@ -16,6 +16,8 @@
  */
 
 #include "mir_test_framework/command_line_server_configuration.h"
+#include "mir_test_framework/main.h"
+
 #include "mir/options/default_configuration.h"
 #include "mir/server.h"
 
@@ -44,14 +46,16 @@
     server.set_command_line(::argc, ::argv);
 }
 
-int main(int argc, char** argv)
+void mir_test_framework::set_commandline(int argc, char* argv[])
 {
-    // Override this standard gtest message
-    std::cout << "Running main() from " << basename(__FILE__) << std::endl;
-    ::testing::InitGoogleTest(&argc, argv);
-
     ::argv = const_cast<char const**>(argv);
     ::argc = argc;
+}
 
+int mir_test_framework::main(int argc, char* argv[])
+{
+    ::testing::InitGoogleTest(&argc, argv);
+    set_commandline(argc, argv);
     return RUN_ALL_TESTS();
 }
+

=== added file 'tests/mir_test_framework/main.cpp'
--- tests/mir_test_framework/main.cpp	1970-01-01 00:00:00 +0000
+++ tests/mir_test_framework/main.cpp	2015-06-26 08:23:20 +0000
@@ -0,0 +1,30 @@
+/*
+ * 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: Alan Griffiths <[e-mail]>
+ */
+
+#include "mir_test_framework/main.h"
+
+#include <cstring>
+#include <iostream>
+
+int main(int argc, char* argv[])
+{
+    // Override this standard gtest message
+    std::cout << "Running main() from " << basename(__FILE__) << std::endl;
+
+    mir_test_framework::main(argc, argv);
+}