minix/external/bsd/kyua-cli/dist/cli/cmd_list.cpp
Lionel Sambuc 11be35a165 Importing NetBSD "Kyua" test framework
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
2013-07-23 20:43:41 +02:00

154 lines
5.4 KiB
C++

// Copyright 2010 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/cmd_list.hpp"
#include <cstdlib>
#include <utility>
#include <vector>
#include "cli/common.ipp"
#include "engine/drivers/list_tests.hpp"
#include "engine/filters.hpp"
#include "engine/test_case.hpp"
#include "engine/test_program.hpp"
#include "utils/cmdline/options.hpp"
#include "utils/cmdline/parser.ipp"
#include "utils/cmdline/ui.hpp"
#include "utils/defs.hpp"
#include "utils/format/macros.hpp"
#include "utils/fs/path.hpp"
namespace cmdline = utils::cmdline;
namespace config = utils::config;
namespace fs = utils::fs;
namespace list_tests = engine::drivers::list_tests;
namespace {
/// Hooks for list_tests to print test cases as they come.
class progress_hooks : public list_tests::base_hooks {
/// The ui object to which to print the test cases.
cmdline::ui* _ui;
/// Whether to print test case details or just their names.
bool _verbose;
public:
/// Initializes the hooks.
///
/// \param ui_ The ui object to which to print the test cases.
/// \param verbose_ Whether to print test case details or just their names.
progress_hooks(cmdline::ui* ui_, const bool verbose_) :
_ui(ui_),
_verbose(verbose_)
{
}
/// Reports a test case as soon as it is found.
///
/// \param test_case The test case to report.
void
got_test_case(const engine::test_case& test_case)
{
cli::detail::list_test_case(_ui, _verbose, test_case);
}
};
} // anonymous namespace
/// Lists a single test case.
///
/// \param [out] ui Object to interact with the I/O of the program.
/// \param verbose Whether to be verbose or not.
/// \param test_case The test case to print.
void
cli::detail::list_test_case(cmdline::ui* ui, const bool verbose,
const engine::test_case& test_case)
{
const std::string id = format_test_case_id(test_case);
if (!verbose) {
ui->out(id);
} else {
ui->out(F("%s (%s)") % id %
test_case.container_test_program().test_suite_name());
// TODO(jmmv): Running these for every test case is probably not the
// fastest thing to do.
const engine::metadata default_md = engine::metadata_builder().build();
const engine::properties_map default_props = default_md.to_properties();
const engine::metadata& test_md = test_case.get_metadata();
const engine::properties_map test_props = test_md.to_properties();
for (engine::properties_map::const_iterator iter = test_props.begin();
iter != test_props.end(); iter++) {
const engine::properties_map::const_iterator default_iter =
default_props.find((*iter).first);
if (default_iter == default_props.end() ||
(*iter).second != (*default_iter).second)
ui->out(F(" %s = %s") % (*iter).first % (*iter).second);
}
}
}
/// Default constructor for cmd_list.
cli::cmd_list::cmd_list(void) :
cli_command("list", "[test-program ...]", 0, -1,
"Lists test cases and their meta-data")
{
add_option(build_root_option);
add_option(kyuafile_option);
add_option(cmdline::bool_option('v', "verbose", "Show properties"));
}
/// Entry point for the "list" subcommand.
///
/// \param ui Object to interact with the I/O of the program.
/// \param cmdline Representation of the command line to the subcommand.
/// \param unused_user_config The runtime configuration of the program.
///
/// \return 0 to indicate success.
int
cli::cmd_list::run(cmdline::ui* ui, const cmdline::parsed_cmdline& cmdline,
const config::tree& UTILS_UNUSED_PARAM(user_config))
{
progress_hooks hooks(ui, cmdline.has_option("verbose"));
const list_tests::result result = list_tests::drive(
kyuafile_path(cmdline), build_root_path(cmdline),
parse_filters(cmdline.arguments()), hooks);
return report_unused_filters(result.unused_filters, ui) ?
EXIT_FAILURE : EXIT_SUCCESS;
}