mirror of
https://github.com/opnsense/src.git
synced 2026-02-18 18:20:26 -05:00
26980dceae
A new Kyua concept is added -- "execution environment". A test can be configured to be run within a specific environment. The test case lifecycle is extended respectively: - execenv init (creates a jail or does nothing for default execenv="host") - test exec - cleanup exec (optional) - execenv cleanup (removes a jail or does nothing for default execenv="host") The following new functionality is provided, from bottom to top: 1 ATF based tests - The new "execenv" metadata property can be set to explicitly ask for an execution environment: "host" or "jail". If it's not defined, as all existing tests do, then it implicitly means "host". - The new "execenv.jail.params" metadata property can be optionally defined to ask Kyua to use specific jail(8) parameters during creation of a temporary jail. An example is "vnet allow.raw_sockets". Kyua implicitly adds "children.max" to "execenv_jail_params" parameters with the maximum possible value. A test case can override it. 2 Kyuafile - The same new metadata properties can be defined on Kyuafile level: "execenv" and "execenv_jail_params". - Note that historically ATF uses dotted style of metadata naming, while Kyua uses underscore style. Hence "execenv.jail.params" vs. "execenv_jail_params". 3 kyua.conf, kyua CLI - The new "execenvs" engine configuration variable can be set to a list of execution environments to run only tests designed for. Tests of not listed environments are skipped. - By default, this variable lists all execution environments supported by a Kyua binary, e.g. execenvs="host jail". - This variable can be changed via "kyua.conf" or via kyua CLI's "-v" parameter. For example, "kyua -v execenvs=host test" will run only host-based tests and skip jail-based ones. - Current value of this variable can be examined with "kyua config". [markj] This feature has not landed upstream yet. See the discussion in https://github.com/freebsd/kyua/pull/224 . Having the ability to automatically jail tests allows many network tests to run in parallel, giving a drastic speedup. So, let's import the feature and start using it in main. Signed-off-by: Igor Ostapenko <pm@igoro.pro> Reviewed by: markj, kp Tested by: markj, kp MFC after: 3 months Differential Revision: https://reviews.freebsd.org/D45865 (cherry picked from commit 257e70f1d5ee61037c8c59b116538d3b6b1427a2) Approved by: kp (mentor), markj (mentor)
146 lines
4.8 KiB
C++
146 lines
4.8 KiB
C++
// 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.
|
|
|
|
#include "cli/cmd_config.hpp"
|
|
|
|
#include <cstdlib>
|
|
|
|
#include <atf-c++.hpp>
|
|
|
|
#include "cli/common.ipp"
|
|
#include "engine/config.hpp"
|
|
#include "utils/cmdline/globals.hpp"
|
|
#include "utils/cmdline/parser.hpp"
|
|
#include "utils/cmdline/ui_mock.hpp"
|
|
#include "utils/config/tree.ipp"
|
|
#include "utils/optional.ipp"
|
|
|
|
namespace cmdline = utils::cmdline;
|
|
namespace config = utils::config;
|
|
|
|
using cli::cmd_config;
|
|
using utils::none;
|
|
|
|
|
|
namespace {
|
|
|
|
|
|
/// Instantiates a fake user configuration for testing purposes.
|
|
///
|
|
/// The user configuration is populated with a collection of test-suite
|
|
/// properties and some hardcoded values for the generic configuration options.
|
|
///
|
|
/// \return A new user configuration object.
|
|
static config::tree
|
|
fake_config(void)
|
|
{
|
|
config::tree user_config = engine::default_config();
|
|
user_config.set_string("architecture", "the-architecture");
|
|
user_config.set_string("execenvs", "the-env");
|
|
user_config.set_string("parallelism", "128");
|
|
user_config.set_string("platform", "the-platform");
|
|
//user_config.set_string("unprivileged_user", "");
|
|
user_config.set_string("test_suites.foo.bar", "first");
|
|
user_config.set_string("test_suites.foo.baz", "second");
|
|
return user_config;
|
|
}
|
|
|
|
|
|
} // anonymous namespace
|
|
|
|
|
|
ATF_TEST_CASE_WITHOUT_HEAD(all);
|
|
ATF_TEST_CASE_BODY(all)
|
|
{
|
|
cmdline::args_vector args;
|
|
args.push_back("config");
|
|
|
|
cmd_config cmd;
|
|
cmdline::ui_mock ui;
|
|
ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, fake_config()));
|
|
|
|
ATF_REQUIRE_EQ(6, ui.out_log().size());
|
|
ATF_REQUIRE_EQ("architecture = the-architecture", ui.out_log()[0]);
|
|
ATF_REQUIRE_EQ("execenvs = the-env", ui.out_log()[1]);
|
|
ATF_REQUIRE_EQ("parallelism = 128", ui.out_log()[2]);
|
|
ATF_REQUIRE_EQ("platform = the-platform", ui.out_log()[3]);
|
|
ATF_REQUIRE_EQ("test_suites.foo.bar = first", ui.out_log()[4]);
|
|
ATF_REQUIRE_EQ("test_suites.foo.baz = second", ui.out_log()[5]);
|
|
ATF_REQUIRE(ui.err_log().empty());
|
|
}
|
|
|
|
|
|
ATF_TEST_CASE_WITHOUT_HEAD(some__ok);
|
|
ATF_TEST_CASE_BODY(some__ok)
|
|
{
|
|
cmdline::args_vector args;
|
|
args.push_back("config");
|
|
args.push_back("platform");
|
|
args.push_back("test_suites.foo.baz");
|
|
|
|
cmd_config cmd;
|
|
cmdline::ui_mock ui;
|
|
ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, fake_config()));
|
|
|
|
ATF_REQUIRE_EQ(2, ui.out_log().size());
|
|
ATF_REQUIRE_EQ("platform = the-platform", ui.out_log()[0]);
|
|
ATF_REQUIRE_EQ("test_suites.foo.baz = second", ui.out_log()[1]);
|
|
ATF_REQUIRE(ui.err_log().empty());
|
|
}
|
|
|
|
|
|
ATF_TEST_CASE_WITHOUT_HEAD(some__fail);
|
|
ATF_TEST_CASE_BODY(some__fail)
|
|
{
|
|
cmdline::args_vector args;
|
|
args.push_back("config");
|
|
args.push_back("platform");
|
|
args.push_back("unknown");
|
|
args.push_back("test_suites.foo.baz");
|
|
|
|
cmdline::init("progname");
|
|
|
|
cmd_config cmd;
|
|
cmdline::ui_mock ui;
|
|
ATF_REQUIRE_EQ(EXIT_FAILURE, cmd.main(&ui, args, fake_config()));
|
|
|
|
ATF_REQUIRE_EQ(2, ui.out_log().size());
|
|
ATF_REQUIRE_EQ("platform = the-platform", ui.out_log()[0]);
|
|
ATF_REQUIRE_EQ("test_suites.foo.baz = second", ui.out_log()[1]);
|
|
ATF_REQUIRE_EQ(1, ui.err_log().size());
|
|
ATF_REQUIRE(atf::utils::grep_string("unknown.*not defined",
|
|
ui.err_log()[0]));
|
|
}
|
|
|
|
|
|
ATF_INIT_TEST_CASES(tcs)
|
|
{
|
|
ATF_ADD_TEST_CASE(tcs, all);
|
|
ATF_ADD_TEST_CASE(tcs, some__ok);
|
|
ATF_ADD_TEST_CASE(tcs, some__fail);
|
|
}
|