1 // Copyright 2024 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_prepare.hpp"
30
31 #include "cli/common.ipp"
32 #include "engine/prepare/prepare.hpp"
33 #include "utils/cmdline/options.hpp"
34
35 namespace cmdline = utils::cmdline;
36 namespace config = utils::config;
37 namespace prepare = engine::prepare;
38
39 using cli::cmd_prepare;
40
41
42 /// Default constructor for cmd_prepare.
cmd_prepare(void)43 cmd_prepare::cmd_prepare(void) : cli_command(
44 "prepare", "[handler-name ...]", 0, -1,
45 "Prepares environment and declared requirements before testing")
46 {
47 add_option(kyuafile_option);
48 add_option(build_root_option);
49 add_option(cmdline::bool_option('n', "dry-run", "Do not alter the system"));
50 }
51
52
53 /// Entry point for the "prepare" subcommand.
54 ///
55 /// \param ui Object to interact with the I/O of the program.
56 /// \param cmdline Representation of the command line to the subcommand.
57 /// \param user_config The runtime configuration of the program.
58 ///
59 /// \return 0 if successful, 1 otherwise.
60 int
run(cmdline::ui * ui,const cmdline::parsed_cmdline & cmdline,const config::tree & user_config)61 cmd_prepare::run(cmdline::ui* ui, const cmdline::parsed_cmdline& cmdline,
62 const config::tree& user_config)
63 {
64 // List available preparation handlers
65 if (cmdline.arguments().empty()) {
66 for (auto& h : prepare::handlers()) {
67 ui->out(h->name(), false);
68 ui->out("\t\t\t", false);
69 ui->out(h->description());
70 }
71 return EXIT_SUCCESS;
72 }
73
74 // Or run the given ones
75 return prepare::run(cmdline.arguments(), ui, cmdline, user_config);
76 }
77