1 // Copyright 2011 The Kyua Authors.
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 "drivers/debug_test.hpp"
35 #include "engine/filters.hpp"
36 #include "utils/cmdline/exceptions.hpp"
37 #include "utils/cmdline/options.hpp"
38 #include "utils/cmdline/parser.ipp"
39 #include "utils/cmdline/ui.hpp"
40 #include "utils/format/macros.hpp"
41
42 namespace cmdline = utils::cmdline;
43 namespace config = utils::config;
44
45 using cli::cmd_debug;
46
47
48 /// Default constructor for cmd_debug.
cmd_debug(void)49 cmd_debug::cmd_debug(void) : cli_command(
50 "debug", "test_case", 1, 1,
51 "Executes a single test case providing facilities for debugging")
52 {
53 add_option(build_root_option);
54 add_option(kyuafile_option);
55
56 add_option(cmdline::path_option(
57 "stdout", "Where to direct the standard output of the test case",
58 "path", "/dev/stdout"));
59
60 add_option(cmdline::path_option(
61 "stderr", "Where to direct the standard error of the test case",
62 "path", "/dev/stderr"));
63 }
64
65
66 /// Entry point for the "debug" subcommand.
67 ///
68 /// \param ui Object to interact with the I/O of the program.
69 /// \param cmdline Representation of the command line to the subcommand.
70 /// \param user_config The runtime debuguration of the program.
71 ///
72 /// \return 0 if everything is OK, 1 if any of the necessary documents cannot be
73 /// opened.
74 int
run(cmdline::ui * ui,const cmdline::parsed_cmdline & cmdline,const config::tree & user_config)75 cmd_debug::run(cmdline::ui* ui, const cmdline::parsed_cmdline& cmdline,
76 const config::tree& user_config)
77 {
78 const std::string& test_case_name = cmdline.arguments()[0];
79 if (test_case_name.find(':') == std::string::npos)
80 throw cmdline::usage_error(F("'%s' is not a test case identifier "
81 "(missing ':'?)") % test_case_name);
82 const engine::test_filter filter = engine::test_filter::parse(
83 test_case_name);
84
85 const drivers::debug_test::result result = drivers::debug_test::drive(
86 kyuafile_path(cmdline), build_root_path(cmdline), filter, user_config,
87 cmdline.get_option< cmdline::path_option >("stdout"),
88 cmdline.get_option< cmdline::path_option >("stderr"));
89
90 ui->out(F("%s -> %s") % cli::format_test_case_id(result.test_case) %
91 cli::format_result(result.test_result));
92
93 return result.test_result.good() ? EXIT_SUCCESS : EXIT_FAILURE;
94 }
95