1// Copyright 2011 Google Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8// * Redistributions of source code must retain the above copyright
9//   notice, this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above copyright
11//   notice, this list of conditions and the following disclaimer in the
12//   documentation and/or other materials provided with the distribution.
13// * Neither the name of Google Inc. nor the names of its contributors
14//   may be used to endorse or promote products derived from this software
15//   without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29#include "cli/cmd_debug.hpp"
30
31#include <cstdlib>
32
33#include "cli/common.ipp"
34#include "engine/drivers/debug_test.hpp"
35#include "engine/filters.hpp"
36#include "utils/cmdline/exceptions.hpp"
37#include "utils/cmdline/parser.ipp"
38#include "utils/format/macros.hpp"
39
40namespace cmdline = utils::cmdline;
41namespace config = utils::config;
42namespace debug_test = engine::drivers::debug_test;
43
44using cli::cmd_debug;
45
46
47/// Default constructor for cmd_debug.
48cmd_debug::cmd_debug(void) : cli_command(
49    "debug", "test_case", 1, 1,
50    "Executes a single test case providing facilities for debugging")
51{
52    add_option(build_root_option);
53    add_option(kyuafile_option);
54
55    add_option(cmdline::path_option(
56        "stdout", "Where to direct the standard output of the test case",
57        "path", "/dev/stdout"));
58
59    add_option(cmdline::path_option(
60        "stderr", "Where to direct the standard error of the test case",
61        "path", "/dev/stderr"));
62}
63
64
65/// Entry point for the "debug" subcommand.
66///
67/// \param ui Object to interact with the I/O of the program.
68/// \param cmdline Representation of the command line to the subcommand.
69/// \param user_config The runtime debuguration of the program.
70///
71/// \return 0 if everything is OK, 1 if any of the necessary documents cannot be
72/// opened.
73int
74cmd_debug::run(cmdline::ui* ui, const cmdline::parsed_cmdline& cmdline,
75               const config::tree& user_config)
76{
77    const std::string& test_case_name = cmdline.arguments()[0];
78    if (test_case_name.find(':') == std::string::npos)
79        throw cmdline::usage_error(F("'%s' is not a test case identifier "
80                                     "(missing ':'?)") % test_case_name);
81    const engine::test_filter filter = engine::test_filter::parse(
82        test_case_name);
83
84    const debug_test::result result = debug_test::drive(
85        kyuafile_path(cmdline), build_root_path(cmdline), filter, user_config,
86        cmdline.get_option< cmdline::path_option >("stdout"),
87        cmdline.get_option< cmdline::path_option >("stderr"));
88
89    ui->out(F("%s  ->  %s") % cli::format_test_case_id(result.test_case) %
90            cli::format_result(result.test_result));
91
92    return result.test_result.good() ? EXIT_SUCCESS : EXIT_FAILURE;
93}
94