Add GoogleTest support

NEWS.md

@@ -4,6 +4,8 @@
 
 **NOT RELEASED YET; STILL UNDER DEVELOPMENT.**
 
+* Google Test test support was added.
+
 * Explicitly require C++11 language features when compiling Kyua.
 
 

cli/main.cpp

@@ -56,6 +56,7 @@ extern "C" {
 #include "cli/common.ipp"
 #include "cli/config.hpp"
 #include "engine/atf.hpp"
+#include "engine/googletest.hpp"
 #include "engine/plain.hpp"
 #include "engine/scheduler.hpp"
 #include "engine/tap.hpp"
@@ -102,6 +103,9 @@ register_scheduler_interfaces(void)
     scheduler::register_interface(
         "atf", std::shared_ptr< scheduler::interface >(
             new engine::atf_interface()));
+    scheduler::register_interface(
+        "googletest", std::shared_ptr< scheduler::interface >(
+            new engine::googletest_interface()));
     scheduler::register_interface(
         "plain", std::shared_ptr< scheduler::interface >(
             new engine::plain_interface()));

doc/kyuafile.5.in

@@ -25,7 +25,7 @@
 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.Dd March 23, 2024
+.Dd November 29, 2024
 .Dt KYUAFILE 5
 .Os
 .Sh NAME
@@ -40,6 +40,7 @@
 .Fn fs.files "string path"
 .Fn fs.is_absolute "string path"
 .Fn fs.join "string path" "string path"
+.Fn googletest_test_program "string name" "[string metadata]"
 .Fn include "string path"
 .Fn plain_test_program "string name" "[string metadata]"
 .Fn syntax "int version"
@@ -123,6 +124,16 @@ the test cases in the test program.
 Any metadata properties defined by the test cases themselves override the
 metadata values defined here.
 .Pp
+.Em Google Test test programs
+are those that use the Google Test test infrastructure.
+They can be registered with the
+.Fn googletest_test_program
+table constructor.
+This function takes the
+.Fa name
+of the test program, and a collection of optional metadata settings for the
+test program.
+.Pp
 .Em Plain test programs
 are those that return 0 on success and non-0 on failure; in general, most test
 programs (even those that use fancy unit-testing libraries) behave this way and
@@ -405,6 +416,9 @@ syntax(2)
 
 test_suite('second')
 
+googletest_test_program{name='dont_run_as_root_test',
+                        required_user='unprivileged'}
+
 plain_test_program{name='legacy_test',
                    allowed_architectures='amd64 i386',
                    required_files='/bin/ls',

engine/Kyuafile

@@ -8,6 +8,9 @@ atf_test_program{name="atf_result_test"}
 atf_test_program{name="config_test"}
 atf_test_program{name="exceptions_test"}
 atf_test_program{name="filters_test"}
+atf_test_program{name="googletest_test"}
+atf_test_program{name="googletest_list_test"}
+atf_test_program{name="googletest_result_test"}
 atf_test_program{name="kyuafile_test"}
 atf_test_program{name="plain_test"}
 atf_test_program{name="requirements_test"}

engine/Makefile.am.inc

@@ -46,6 +46,13 @@ libengine_la_SOURCES += engine/exceptions.hpp
 libengine_la_SOURCES += engine/filters.cpp
 libengine_la_SOURCES += engine/filters.hpp
 libengine_la_SOURCES += engine/filters_fwd.hpp
+libengine_la_SOURCES += engine/googletest.cpp
+libengine_la_SOURCES += engine/googletest.hpp
+libengine_la_SOURCES += engine/googletest_list.cpp
+libengine_la_SOURCES += engine/googletest_list.hpp
+libengine_la_SOURCES += engine/googletest_result.cpp
+libengine_la_SOURCES += engine/googletest_result.hpp
+libengine_la_SOURCES += engine/googletest_result_fwd.hpp
 libengine_la_SOURCES += engine/kyuafile.cpp
 libengine_la_SOURCES += engine/kyuafile.hpp
 libengine_la_SOURCES += engine/kyuafile_fwd.hpp
@@ -106,6 +113,26 @@ engine_filters_test_SOURCES = engine/filters_test.cpp
 engine_filters_test_CXXFLAGS = $(ENGINE_CFLAGS) $(ATF_CXX_CFLAGS)
 engine_filters_test_LDADD = $(ENGINE_LIBS) $(ATF_CXX_LIBS)
 
+tests_engine_PROGRAMS += engine/googletest_helpers
+engine_googletest_helpers_SOURCES = engine/googletest_helpers.cpp
+engine_googletest_helpers_CXXFLAGS = $(UTILS_CFLAGS)
+engine_googletest_helpers_LDADD = $(UTILS_LIBS)
+
+tests_engine_PROGRAMS += engine/googletest_test
+engine_googletest_test_SOURCES = engine/googletest_test.cpp
+engine_googletest_test_CXXFLAGS = $(ENGINE_CFLAGS) $(ATF_CXX_CFLAGS)
+engine_googletest_test_LDADD = $(ENGINE_LIBS) $(ATF_CXX_LIBS)
+
+tests_engine_PROGRAMS += engine/googletest_list_test
+engine_googletest_list_test_SOURCES = engine/googletest_list_test.cpp
+engine_googletest_list_test_CXXFLAGS = $(ENGINE_CFLAGS) $(ATF_CXX_CFLAGS)
+engine_googletest_list_test_LDADD = $(ENGINE_LIBS) $(ATF_CXX_LIBS)
+
+tests_engine_PROGRAMS += engine/googletest_result_test
+engine_googletest_result_test_SOURCES = engine/googletest_result_test.cpp
+engine_googletest_result_test_CXXFLAGS = $(ENGINE_CFLAGS) $(ATF_CXX_CFLAGS)
+engine_googletest_result_test_LDADD = $(ENGINE_LIBS) $(ATF_CXX_LIBS)
+
 tests_engine_PROGRAMS += engine/kyuafile_test
 engine_kyuafile_test_SOURCES = engine/kyuafile_test.cpp
 engine_kyuafile_test_CXXFLAGS = $(ENGINE_CFLAGS) $(ATF_CXX_CFLAGS)

engine/googletest.cpp

@@ -0,0 +1,218 @@
+// Copyright 2024 The Kyua Authors.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// * Redistributions of source code must retain the above copyright
+//   notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above copyright
+//   notice, this list of conditions and the following disclaimer in the
+//   documentation and/or other materials provided with the distribution.
+// * Neither the name of Google Inc. nor the names of its contributors
+//   may be used to endorse or promote products derived from this software
+//   without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#include "engine/googletest.hpp"
+
+extern "C" {
+#include <unistd.h>
+}
+
+#include <cerrno>
+#include <cstdlib>
+#include <fstream>
+
+#include "engine/googletest_list.hpp"
+#include "engine/googletest_result.hpp"
+#include "engine/exceptions.hpp"
+#include "model/test_case.hpp"
+#include "model/test_program.hpp"
+#include "model/test_result.hpp"
+#include "utils/defs.hpp"
+#include "utils/env.hpp"
+#include "utils/format/macros.hpp"
+#include "utils/fs/path.hpp"
+#include "utils/logging/macros.hpp"
+#include "utils/optional.ipp"
+#include "utils/process/exceptions.hpp"
+#include "utils/process/operations.hpp"
+#include "utils/process/status.hpp"
+#include "utils/stream.hpp"
+
+namespace config = utils::config;
+namespace fs = utils::fs;
+namespace process = utils::process;
+
+using utils::optional;
+
+
+namespace {
+
+
+/// Basename of the file containing the result written by the googletest
+/// testcase.
+///
+/// TODO: Use more structured output format someday, like the googletest's JSON
+/// or XML format to avoid dealing with upstream formatting changes, as there's
+/// no guarantee that the output format (which is more or less custom/freeform)
+/// won't change in the future, making compatibility with all versions
+/// potentially difficult to scrape for.
+///
+/// Using either format will require pulling in a third party library and
+/// understanding the schema of the format. As it stands in 1.9.0,
+/// googletest doesn't document this expectation very well and instead seems
+/// to rely on third-party solutions for doing structured output via the
+/// listener interfaces.
+
+
+/// Magic numbers returned by exec_list when exec(2) fails.
+enum list_exit_code {
+    exit_eacces = 90,
+    exit_enoent,
+    exit_enoexec,
+};
+
+
+}  // anonymous namespace
+
+
+/// Executes a test program's list operation.
+///
+/// This method is intended to be called within a subprocess and is expected
+/// to terminate execution either by exec(2)ing the test program or by
+/// exiting with a failure.
+///
+/// \param test_program The test program to execute.
+void
+engine::googletest_interface::exec_list(
+    const model::test_program& test_program,
+    const config::properties_map& /*vars*/) const
+{
+    const process::args_vector args{
+        "--gtest_color=no",
+        "--gtest_list_tests",
+    };
+
+    try {
+        process::exec_unsafe(test_program.absolute_path(), args);
+    } catch (const process::system_error& e) {
+        if (e.original_errno() == EACCES)
+            ::_exit(exit_eacces);
+        else if (e.original_errno() == ENOENT)
+            ::_exit(exit_enoent);
+        else if (e.original_errno() == ENOEXEC)
+            ::_exit(exit_enoexec);
+        throw;
+    }
+}
+
+
+/// Computes the test cases list of a test program.
+///
+/// \param status The termination status of the subprocess used to execute
+///     the exec_test() method or none if the test timed out.
+/// \param stdout_path Path to the file containing the stdout of the test.
+///
+/// \return A list of test cases.
+///
+/// \throw error If there is a problem parsing the test case list.
+model::test_cases_map
+engine::googletest_interface::parse_list(
+    const optional< process::status >& status,
+    const fs::path& stdout_path,
+    const fs::path& /* stderr_path */) const
+{
+    if (!status)
+        throw engine::error("Test case list timed out");
+    if (status.get().exited()) {
+        const int exitstatus = status.get().exitstatus();
+        if (exitstatus == EXIT_SUCCESS) {
+            // Nothing to do; fall through.
+        } else if (exitstatus == exit_eacces) {
+            throw engine::error("Permission denied to run test program");
+        } else if (exitstatus == exit_enoent) {
+            throw engine::error("Cannot find test program");
+        } else if (exitstatus == exit_enoexec) {
+            throw engine::error("Invalid test program format");
+        } else {
+            throw engine::error("Test program did not exit cleanly; exited "
+                                "with status: " + std::to_string(exitstatus));
+        }
+    } else {
+        throw engine::error("Test program received signal");
+    }
+
+    std::ifstream input(stdout_path.c_str());
+    if (!input)
+        throw engine::load_error(stdout_path, "Cannot open file for read");
+    const model::test_cases_map test_cases = parse_googletest_list(input);
+
+    return test_cases;
+}
+
+
+/// Executes a test case of the test program.
+///
+/// This method is intended to be called within a subprocess and is expected
+/// to terminate execution either by exec(2)ing the test program or by
+/// exiting with a failure.
+///
+/// \param test_program The test program to execute.
+/// \param test_case_name Name of the test case to invoke.
+/// \param vars User-provided variables to pass to the test program.
+void
+engine::googletest_interface::exec_test(
+    const model::test_program& test_program,
+    const std::string& test_case_name,
+    const config::properties_map& vars,
+    const fs::path& /* control_directory */) const
+{
+    for (config::properties_map::const_iterator iter = vars.begin();
+         iter != vars.end(); ++iter) {
+        utils::setenv(F("TEST_ENV_%s") % (*iter).first, (*iter).second);
+    }
+
+    process::args_vector args{
+        "--gtest_color=no",
+        F("--gtest_filter=%s") % (test_case_name)
+    };
+    process::exec(test_program.absolute_path(), args);
+}
+
+
+/// Computes the result of a test case based on its termination status.
+///
+/// \param status The termination status of the subprocess used to execute
+///     the exec_test() method or none if the test timed out.
+/// \param stdout_path Path to the file containing the stdout of the
+///     test.
+///
+/// \return A test result.
+model::test_result
+engine::googletest_interface::compute_result(
+    const optional< process::status >& status,
+    const fs::path& /* control_directory */,
+    const fs::path& stdout_path,
+    const fs::path& /* stderr_path */) const
+{
+    if (!status) {
+        return model::test_result(model::test_result_broken,
+                                  "Test case body timed out");
+    }
+
+    return calculate_googletest_result(status, stdout_path);
+}