minix/external/bsd/kyua-cli/dist/cli/cmd_report.cpp

393 lines
14 KiB
C++
Raw Normal View History

// 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/cmd_report.hpp"
#include <cstddef>
#include <cstdlib>
#include <fstream>
#include <map>
#include <vector>
#include "cli/common.ipp"
#include "engine/action.hpp"
#include "engine/context.hpp"
#include "engine/drivers/scan_action.hpp"
#include "engine/test_result.hpp"
#include "utils/cmdline/exceptions.hpp"
#include "utils/cmdline/parser.ipp"
#include "utils/defs.hpp"
#include "utils/format/macros.hpp"
#include "utils/optional.ipp"
namespace cmdline = utils::cmdline;
namespace config = utils::config;
namespace datetime = utils::datetime;
namespace fs = utils::fs;
namespace scan_action = engine::drivers::scan_action;
using cli::cmd_report;
using utils::optional;
namespace {
/// Collection of result types.
///
/// This is a vector rather than a set because we want to respect the order in
/// which the user provided the types.
typedef std::vector< engine::test_result::result_type > result_types;
/// Converts a set of result type names to identifiers.
///
/// \param names The collection of names to process; may be empty.
///
/// \return The result type identifiers corresponding to the input names.
///
/// \throw std::runtime_error If any name in the input names is invalid.
static result_types
parse_types(const std::vector< std::string >& names)
{
using engine::test_result;
typedef std::map< std::string, test_result::result_type > types_map;
types_map valid_types;
valid_types["broken"] = test_result::broken;
valid_types["failed"] = test_result::failed;
valid_types["passed"] = test_result::passed;
valid_types["skipped"] = test_result::skipped;
valid_types["xfail"] = test_result::expected_failure;
result_types types;
for (std::vector< std::string >::const_iterator iter = names.begin();
iter != names.end(); ++iter) {
const types_map::const_iterator match = valid_types.find(*iter);
if (match == valid_types.end())
throw std::runtime_error(F("Unknown result type '%s'") % *iter);
else
types.push_back((*match).second);
}
return types;
}
/// Generates a plain-text report intended to be printed to the console.
class console_hooks : public scan_action::base_hooks {
/// Indirection to print the output to the correct file stream.
cli::file_writer _writer;
/// Whether to include the runtime context in the output or not.
const bool _show_context;
/// Collection of result types to include in the report.
const result_types& _results_filters;
/// The action ID loaded.
int64_t _action_id;
/// The total run time of the tests.
datetime::delta _runtime;
/// Representation of a single result.
struct result_data {
/// The relative path to the test program.
fs::path binary_path;
/// The name of the test case.
std::string test_case_name;
/// The result of the test case.
engine::test_result result;
/// The duration of the test case execution.
datetime::delta duration;
/// Constructs a new results data.
///
/// \param binary_path_ The relative path to the test program.
/// \param test_case_name_ The name of the test case.
/// \param result_ The result of the test case.
/// \param duration_ The duration of the test case execution.
result_data(const fs::path& binary_path_,
const std::string& test_case_name_,
const engine::test_result& result_,
const datetime::delta& duration_) :
binary_path(binary_path_), test_case_name(test_case_name_),
result(result_), duration(duration_)
{
}
};
/// Results received, broken down by their type.
///
/// Note that this may not include all results, as keeping the whole list in
/// memory may be too much.
std::map< engine::test_result::result_type,
std::vector< result_data > > _results;
/// Prints the execution context to the output.
///
/// \param context The context to dump.
void
print_context(const engine::context& context)
{
_writer("===> Execution context");
_writer(F("Current directory: %s") % context.cwd());
const std::map< std::string, std::string >& env = context.env();
if (env.empty())
_writer("No environment variables recorded");
else {
_writer("Environment variables:");
for (std::map< std::string, std::string >::const_iterator
iter = env.begin(); iter != env.end(); iter++) {
_writer(F(" %s=%s") % (*iter).first % (*iter).second);
}
}
}
/// Counts how many results of a given type have been received.
std::size_t
count_results(const engine::test_result::result_type type)
{
const std::map< engine::test_result::result_type,
std::vector< result_data > >::const_iterator iter =
_results.find(type);
if (iter == _results.end())
return 0;
else
return (*iter).second.size();
}
/// Prints a set of results.
void
print_results(const engine::test_result::result_type type,
const char* title)
{
const std::map< engine::test_result::result_type,
std::vector< result_data > >::const_iterator iter2 =
_results.find(type);
if (iter2 == _results.end())
return;
const std::vector< result_data >& all = (*iter2).second;
_writer(F("===> %s") % title);
for (std::vector< result_data >::const_iterator iter = all.begin();
iter != all.end(); iter++) {
_writer(F("%s:%s -> %s [%s]") % (*iter).binary_path %
(*iter).test_case_name %
cli::format_result((*iter).result) %
cli::format_delta((*iter).duration));
}
}
public:
/// Constructor for the hooks.
///
/// \param ui_ The user interface object of the caller command.
/// \param outfile_ The file to which to send the output.
/// \param show_context_ Whether to include the runtime context in
/// the output or not.
/// \param results_filters_ The result types to include in the report.
/// Cannot be empty.
console_hooks(cmdline::ui* ui_, const fs::path& outfile_,
const bool show_context_,
const result_types& results_filters_) :
_writer(ui_, outfile_),
_show_context(show_context_),
_results_filters(results_filters_)
{
PRE(!results_filters_.empty());
}
/// Callback executed when an action is found.
///
/// \param action_id The identifier of the loaded action.
/// \param action The action loaded from the database.
void
got_action(const int64_t action_id, const engine::action& action)
{
_action_id = action_id;
if (_show_context)
print_context(action.runtime_context());
}
/// Callback executed when a test results is found.
///
/// \param iter Container for the test result's data.
void
got_result(store::results_iterator& iter)
{
_runtime += iter.duration();
const engine::test_result result = iter.result();
_results[result.type()].push_back(
result_data(iter.test_program()->relative_path(),
iter.test_case_name(), iter.result(), iter.duration()));
}
/// Prints the tests summary.
void
print_tests(void)
{
using engine::test_result;
typedef std::map< test_result::result_type, const char* > types_map;
types_map titles;
titles[engine::test_result::broken] = "Broken tests";
titles[engine::test_result::expected_failure] = "Expected failures";
titles[engine::test_result::failed] = "Failed tests";
titles[engine::test_result::passed] = "Passed tests";
titles[engine::test_result::skipped] = "Skipped tests";
for (result_types::const_iterator iter = _results_filters.begin();
iter != _results_filters.end(); ++iter) {
const types_map::const_iterator match = titles.find(*iter);
INV_MSG(match != titles.end(), "Conditional does not match user "
"input validation in parse_types()");
print_results((*match).first, (*match).second);
}
const std::size_t broken = count_results(test_result::broken);
const std::size_t failed = count_results(test_result::failed);
const std::size_t passed = count_results(test_result::passed);
const std::size_t skipped = count_results(test_result::skipped);
const std::size_t xfail = count_results(test_result::expected_failure);
const std::size_t total = broken + failed + passed + skipped + xfail;
_writer("===> Summary");
_writer(F("Action: %s") % _action_id);
_writer(F("Test cases: %s total, %s skipped, %s expected failures, "
"%s broken, %s failed") %
total % skipped % xfail % broken % failed);
_writer(F("Total time: %s") % cli::format_delta(_runtime));
}
};
} // anonymous namespace
const fs::path cli::file_writer::_stdout_path("/dev/stdout");
const fs::path cli::file_writer::_stderr_path("/dev/stderr");
/// Constructs a new file_writer wrapper.
///
/// \param ui_ The UI object of the caller command.
/// \param path_ The path to the output file.
cli::file_writer::file_writer(cmdline::ui* const ui_, const fs::path& path_) :
_ui(ui_), _output_path(path_)
{
if (path_ != _stdout_path && path_ != _stderr_path) {
_output_file.reset(new std::ofstream(path_.c_str()));
if (!*(_output_file)) {
throw std::runtime_error(F("Cannot open output file %s") % path_);
}
}
}
/// Destructor.
cli::file_writer::~file_writer(void)
{
}
/// Writes a message to the selected output.
///
/// \param message The message to write; should not include a termination
/// new line.
void
cli::file_writer::operator()(const std::string& message)
{
if (_output_path == _stdout_path)
_ui->out(message);
else if (_output_path == _stderr_path)
_ui->err(message);
else {
INV(_output_file.get() != NULL);
(*_output_file) << message << '\n';
}
}
/// Default constructor for cmd_report.
cmd_report::cmd_report(void) : cli_command(
"report", "", 0, 0,
"Generates a user-friendly, plain-text report with the result of a "
"previous action")
{
add_option(store_option);
add_option(cmdline::bool_option(
"show-context", "Include the execution context in the report"));
add_option(cmdline::int_option(
"action", "The action to report; if not specified, defaults to the "
"latest action in the database", "id"));
add_option(cmdline::path_option(
"output", "The file to which to write the report",
"path", "/dev/stdout"));
add_option(cmdline::list_option(
"results-filter", "Comma-separated list of result types to include in "
"the report", "types", "skipped,xfail,broken,failed"));
}
/// Entry point for the "report" 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 if everything is OK, 1 if the statement is invalid or if there is
/// any other problem.
int
cmd_report::run(cmdline::ui* ui, const cmdline::parsed_cmdline& cmdline,
const config::tree& UTILS_UNUSED_PARAM(user_config))
{
optional< int64_t > action_id;
if (cmdline.has_option("action"))
action_id = cmdline.get_option< cmdline::int_option >("action");
result_types types = parse_types(
cmdline.get_option< cmdline::list_option >("results-filter"));
if (types.empty()) {
types.push_back(engine::test_result::passed);
types.push_back(engine::test_result::skipped);
types.push_back(engine::test_result::expected_failure);
types.push_back(engine::test_result::broken);
types.push_back(engine::test_result::failed);
}
console_hooks hooks(
ui, cmdline.get_option< cmdline::path_option >("output"),
cmdline.has_option("show-context"), types);
scan_action::drive(store_path(cmdline), action_id, hooks);
hooks.print_tests();
return EXIT_SUCCESS;
}