aboutsummaryrefslogtreecommitdiffstats
path: root/engine/plain_helpers.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'engine/plain_helpers.cpp')
-rw-r--r--engine/plain_helpers.cpp238
1 files changed, 238 insertions, 0 deletions
diff --git a/engine/plain_helpers.cpp b/engine/plain_helpers.cpp
new file mode 100644
index 000000000000..52b1bc74fe10
--- /dev/null
+++ b/engine/plain_helpers.cpp
@@ -0,0 +1,238 @@
+// Copyright 2011 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.
+
+extern "C" {
+#include <sys/stat.h>
+
+#include <unistd.h>
+
+extern char** environ;
+}
+
+#include <cstdlib>
+#include <cstring>
+#include <fstream>
+#include <iostream>
+#include <sstream>
+
+#include "utils/env.hpp"
+#include "utils/format/containers.ipp"
+#include "utils/format/macros.hpp"
+#include "utils/fs/operations.hpp"
+#include "utils/fs/path.hpp"
+#include "utils/optional.ipp"
+#include "utils/test_utils.ipp"
+
+namespace fs = utils::fs;
+
+using utils::optional;
+
+
+namespace {
+
+
+/// Gets the name of the test case to run.
+///
+/// We use the value of the TEST_CASE environment variable if present, or
+/// else the basename of the test program.
+///
+/// \param arg0 Value of argv[0] as passed to main().
+///
+/// \return A test case name. The name may not be valid.
+static std::string
+guess_test_case_name(const char* arg0)
+{
+ const optional< std::string > test_case_env = utils::getenv("TEST_CASE");
+ if (test_case_env) {
+ return test_case_env.get();
+ } else {
+ return fs::path(arg0).leaf_name();
+ }
+}
+
+
+/// Logs an error message and exits the test with an error code.
+///
+/// \param str The error message to log.
+static void
+fail(const std::string& str)
+{
+ std::cerr << str << '\n';
+ std::exit(EXIT_FAILURE);
+}
+
+
+/// A test case that validates the TEST_ENV_* variables.
+static void
+test_check_configuration_variables(void)
+{
+ std::set< std::string > vars;
+ char** iter;
+ for (iter = environ; *iter != NULL; ++iter) {
+ if (std::strstr(*iter, "TEST_ENV_") == *iter) {
+ vars.insert(*iter);
+ }
+ }
+
+ std::set< std::string > exp_vars;
+ exp_vars.insert("TEST_ENV_first=some value");
+ exp_vars.insert("TEST_ENV_second=some other value");
+ if (vars != exp_vars) {
+ fail(F("Expected: %s\nFound: %s\n") % exp_vars % vars);
+ }
+}
+
+
+/// A test case that crashes.
+static void
+test_crash(void)
+{
+ utils::abort_without_coredump();
+}
+
+
+/// A test case that exits with a non-zero exit code, and not 1.
+static void
+test_fail(void)
+{
+ std::exit(8);
+}
+
+
+/// A test case that passes.
+static void
+test_pass(void)
+{
+}
+
+
+/// A test case that spawns a subchild that gets stuck.
+///
+/// This test case is used by the caller to validate that the whole process tree
+/// is terminated when the test case is killed.
+static void
+test_spawn_blocking_child(void)
+{
+ pid_t pid = ::fork();
+ if (pid == -1)
+ fail("Cannot fork subprocess");
+ else if (pid == 0) {
+ for (;;)
+ ::pause();
+ } else {
+ const fs::path name = fs::path(utils::getenv("CONTROL_DIR").get()) /
+ "pid";
+ std::ofstream pidfile(name.c_str());
+ if (!pidfile)
+ fail("Failed to create the pidfile");
+ pidfile << pid;
+ pidfile.close();
+ }
+}
+
+
+/// A test case that times out.
+///
+/// Note that the timeout is defined in the Kyuafile, as the plain interface has
+/// no means for test programs to specify this by themselves.
+static void
+test_timeout(void)
+{
+ ::sleep(10);
+ const fs::path control_dir = fs::path(utils::getenv("CONTROL_DIR").get());
+ std::ofstream file((control_dir / "cookie").c_str());
+ if (!file)
+ fail("Failed to create the control cookie");
+ file.close();
+}
+
+
+/// A test case that performs basic checks on the runtime environment.
+///
+/// If the runtime environment does not look clean (according to the rules in
+/// the Kyua runtime properties), the test fails.
+static void
+test_validate_isolation(void)
+{
+ if (utils::getenv("HOME").get() == "fake-value")
+ fail("HOME not reset");
+ if (utils::getenv("LANG"))
+ fail("LANG not unset");
+}
+
+
+} // anonymous namespace
+
+
+/// Entry point to the test program.
+///
+/// The caller can select which test case to run by defining the TEST_CASE
+/// environment variable. This is not "standard", in the sense this is not a
+/// generic property of the plain test case interface.
+///
+/// \todo It may be worth to split this binary into separate, smaller binaries,
+/// one for every "test case". We use this program as a dispatcher for
+/// different "main"s, the only reason being to keep the amount of helper test
+/// programs to a minimum. However, putting this each function in its own
+/// binary could simplify many other things.
+///
+/// \param argc The number of CLI arguments.
+/// \param argv The CLI arguments themselves. These are not used because
+/// Kyua will not pass any arguments to the plain test program.
+int
+main(int argc, char** argv)
+{
+ if (argc != 1) {
+ std::cerr << "No arguments allowed; select the test case with the "
+ "TEST_CASE variable";
+ return EXIT_FAILURE;
+ }
+
+ const std::string& test_case = guess_test_case_name(argv[0]);
+
+ if (test_case == "check_configuration_variables")
+ test_check_configuration_variables();
+ else if (test_case == "crash")
+ test_crash();
+ else if (test_case == "fail")
+ test_fail();
+ else if (test_case == "pass")
+ test_pass();
+ else if (test_case == "spawn_blocking_child")
+ test_spawn_blocking_child();
+ else if (test_case == "timeout")
+ test_timeout();
+ else if (test_case == "validate_isolation")
+ test_validate_isolation();
+ else {
+ std::cerr << "Unknown test case";
+ return EXIT_FAILURE;
+ }
+
+ return EXIT_SUCCESS;
+}