To do so, a few dependencies have been imported: * external/bsd/lutok * external/mit/lua * external/public-domain/sqlite * external/public-domain/xz The Kyua framework is the new generation of ATF (Automated Test Framework), it is composed of: * external/bsd/atf * external/bsd/kyua-atf-compat * external/bsd/kyua-cli * external/bsd/kyua-tester * tests Kyua/ATF being written in C++, it depends on libstdc++ which is provided by GCC. As this is not part of the sources, Kyua is only compiled when the native GCC utils are installed. To install Kyua do the following: * In a cross-build enviromnent, add the following to the build.sh commandline: -V MKBINUTILS=yes -V MKGCCCMDS=yes WARNING: At this point the import is still experimental, and not supported on native builds (a.k.a make build). Change-Id: I26aee23c5bbd2d64adcb7c1beb98fe0d479d7ada
277 lines
9 KiB
C++
277 lines
9 KiB
C++
// Copyright 2011 Google Inc.
|
|
// 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/common.hpp"
|
|
|
|
#include <algorithm>
|
|
|
|
#include "engine/filters.hpp"
|
|
#include "engine/test_case.hpp"
|
|
#include "engine/test_program.hpp"
|
|
#include "engine/test_result.hpp"
|
|
#include "utils/cmdline/exceptions.hpp"
|
|
#include "utils/cmdline/parser.ipp"
|
|
#include "utils/datetime.hpp"
|
|
#include "utils/env.hpp"
|
|
#include "utils/format/macros.hpp"
|
|
#include "utils/logging/macros.hpp"
|
|
#include "utils/fs/exceptions.hpp"
|
|
#include "utils/fs/operations.hpp"
|
|
#include "utils/fs/path.hpp"
|
|
#include "utils/optional.ipp"
|
|
|
|
namespace cmdline = utils::cmdline;
|
|
namespace datetime = utils::datetime;
|
|
namespace fs = utils::fs;
|
|
|
|
using utils::none;
|
|
using utils::optional;
|
|
|
|
|
|
/// Standard definition of the option to specify the build root.
|
|
const cmdline::path_option cli::build_root_option(
|
|
"build-root",
|
|
"Path to the built test programs, if different from the location of the "
|
|
"Kyuafile scripts",
|
|
"path");
|
|
|
|
|
|
/// Standard definition of the option to specify a Kyuafile.
|
|
const cmdline::path_option cli::kyuafile_option(
|
|
'k', "kyuafile",
|
|
"Path to the test suite definition",
|
|
"file", "Kyuafile");
|
|
|
|
|
|
/// Standard definition of the option to specify the store.
|
|
const cmdline::path_option cli::store_option(
|
|
's', "store",
|
|
"Path to the store database",
|
|
"file", "~/.kyua/store.db");
|
|
|
|
|
|
/// Gets the path to the build root, if any.
|
|
///
|
|
/// This is just syntactic sugar to simplify quierying the 'build_root_option'.
|
|
///
|
|
/// \param cmdline The parsed command line.
|
|
///
|
|
/// \return The path to the build root, if specified; none otherwise.
|
|
optional< fs::path >
|
|
cli::build_root_path(const cmdline::parsed_cmdline& cmdline)
|
|
{
|
|
optional< fs::path > build_root;
|
|
if (cmdline.has_option(build_root_option.long_name()))
|
|
build_root = cmdline.get_option< cmdline::path_option >(
|
|
build_root_option.long_name());
|
|
return build_root;
|
|
}
|
|
|
|
|
|
/// Gets the value of the HOME environment variable with path validation.
|
|
///
|
|
/// \return The value of the HOME environment variable if it is a valid path;
|
|
/// none if it is not defined or if it contains an invalid path.
|
|
optional< fs::path >
|
|
cli::get_home(void)
|
|
{
|
|
const optional< std::string > home = utils::getenv("HOME");
|
|
if (home) {
|
|
try {
|
|
return utils::make_optional(fs::path(home.get()));
|
|
} catch (const fs::error& e) {
|
|
LW(F("Invalid value '%s' in HOME environment variable: %s") %
|
|
home.get() % e.what());
|
|
return none;
|
|
}
|
|
} else
|
|
return none;
|
|
}
|
|
|
|
|
|
/// Gets the path to the Kyuafile to be loaded.
|
|
///
|
|
/// This is just syntactic sugar to simplify quierying the 'kyuafile_option'.
|
|
///
|
|
/// \param cmdline The parsed command line.
|
|
///
|
|
/// \return The path to the Kyuafile to be loaded.
|
|
fs::path
|
|
cli::kyuafile_path(const cmdline::parsed_cmdline& cmdline)
|
|
{
|
|
return cmdline.get_option< cmdline::path_option >(
|
|
kyuafile_option.long_name());
|
|
}
|
|
|
|
|
|
/// Gets the path to the store to be used.
|
|
///
|
|
/// This has the side-effect of creating the directory in which to store the
|
|
/// database if and only if the path to the database matches the default value.
|
|
/// When the user does not specify an override for the location of the database,
|
|
/// he should not care about the directory existing. Any of this is not a big
|
|
/// deal though, because logs are also stored within ~/.kyua and thus we will
|
|
/// most likely end up creating the directory anyway.
|
|
///
|
|
/// \param cmdline The parsed command line.
|
|
///
|
|
/// \return The path to the store to be used.
|
|
///
|
|
/// \throw fs::error If the creation of the directory fails.
|
|
fs::path
|
|
cli::store_path(const cmdline::parsed_cmdline& cmdline)
|
|
{
|
|
fs::path store = cmdline.get_option< cmdline::path_option >(
|
|
store_option.long_name());
|
|
if (store == fs::path(store_option.default_value())) {
|
|
const optional< fs::path > home = cli::get_home();
|
|
if (home) {
|
|
store = home.get() / ".kyua/store.db";
|
|
fs::mkdir_p(store.branch_path(), 0777);
|
|
} else {
|
|
store = fs::path("kyua-store.db");
|
|
LW("HOME not defined; creating store database in current "
|
|
"directory");
|
|
}
|
|
}
|
|
LI(F("Store database set to: %s") % store);
|
|
return store;
|
|
}
|
|
|
|
|
|
/// Parses a set of command-line arguments to construct test filters.
|
|
///
|
|
/// \param args The command-line arguments representing test filters.
|
|
///
|
|
/// \throw cmdline:error If any of the arguments is invalid, or if they
|
|
/// represent a non-disjoint collection of filters.
|
|
std::set< engine::test_filter >
|
|
cli::parse_filters(const cmdline::args_vector& args)
|
|
{
|
|
std::set< engine::test_filter > filters;
|
|
|
|
try {
|
|
for (cmdline::args_vector::const_iterator iter = args.begin();
|
|
iter != args.end(); iter++) {
|
|
const engine::test_filter filter(engine::test_filter::parse(*iter));
|
|
if (filters.find(filter) != filters.end())
|
|
throw cmdline::error(F("Duplicate filter '%s'") % filter.str());
|
|
filters.insert(filter);
|
|
}
|
|
check_disjoint_filters(filters);
|
|
} catch (const std::runtime_error& e) {
|
|
throw cmdline::error(e.what());
|
|
}
|
|
|
|
return filters;
|
|
}
|
|
|
|
|
|
/// Reports the filters that have not matched any tests as errors.
|
|
///
|
|
/// \param unused The collection of unused filters to report.
|
|
/// \param ui The user interface object through which errors are to be reported.
|
|
///
|
|
/// \return True if there are any unused filters. The caller should report this
|
|
/// as an error to the user by means of a non-successful exit code.
|
|
bool
|
|
cli::report_unused_filters(const std::set< engine::test_filter >& unused,
|
|
cmdline::ui* ui)
|
|
{
|
|
for (std::set< engine::test_filter >::const_iterator iter = unused.begin();
|
|
iter != unused.end(); iter++) {
|
|
cmdline::print_warning(ui, F("No test cases matched by the filter '%s'")
|
|
% (*iter).str());
|
|
}
|
|
|
|
return !unused.empty();
|
|
}
|
|
|
|
|
|
/// Formats a time delta for user presentation.
|
|
///
|
|
/// \param delta The time delta to format.
|
|
///
|
|
/// \return A user-friendly representation of the time delta.
|
|
std::string
|
|
cli::format_delta(const datetime::delta& delta)
|
|
{
|
|
return F("%.3ss") % (delta.seconds + (delta.useconds / 1000000.0));
|
|
}
|
|
|
|
|
|
/// Formats a test case result for user presentation.
|
|
///
|
|
/// \param result The result to format.
|
|
///
|
|
/// \return A user-friendly representation of the result.
|
|
std::string
|
|
cli::format_result(const engine::test_result& result)
|
|
{
|
|
std::string text;
|
|
|
|
using engine::test_result;
|
|
switch (result.type()) {
|
|
case test_result::broken: text = "broken"; break;
|
|
case test_result::expected_failure: text = "expected_failure"; break;
|
|
case test_result::failed: text = "failed"; break;
|
|
case test_result::passed: text = "passed"; break;
|
|
case test_result::skipped: text = "skipped"; break;
|
|
}
|
|
INV(!text.empty());
|
|
|
|
if (!result.reason().empty())
|
|
text += ": " + result.reason();
|
|
|
|
return text;
|
|
}
|
|
|
|
|
|
/// Formats the identifier of a test case for user presentation.
|
|
///
|
|
/// \param test_case The test case whose identifier to format.
|
|
///
|
|
/// \return A string representing the test case uniquely within a test suite.
|
|
std::string
|
|
cli::format_test_case_id(const engine::test_case& test_case)
|
|
{
|
|
return F("%s:%s") % test_case.container_test_program().relative_path() %
|
|
test_case.name();
|
|
}
|
|
|
|
|
|
/// Formats a filter using the same syntax of a test case.
|
|
///
|
|
/// \param test_filter The filter to format.
|
|
///
|
|
/// \return A string representing the test filter.
|
|
std::string
|
|
cli::format_test_case_id(const engine::test_filter& test_filter)
|
|
{
|
|
return F("%s:%s") % test_filter.test_program % test_filter.test_case;
|
|
}
|