head 1.1; branch 1.1.1; access; symbols netbsd-11-0-RC4:1.1.1.1 netbsd-11-0-RC3:1.1.1.1 netbsd-11-0-RC2:1.1.1.1 netbsd-11-0-RC1:1.1.1.1 perseant-exfatfs-base-20250801:1.1.1.1 netbsd-11:1.1.1.1.0.50 netbsd-11-base:1.1.1.1 netbsd-10-1-RELEASE:1.1.1.1 perseant-exfatfs-base-20240630:1.1.1.1 perseant-exfatfs:1.1.1.1.0.48 perseant-exfatfs-base:1.1.1.1 netbsd-8-3-RELEASE:1.1.1.1 netbsd-9-4-RELEASE:1.1.1.1 netbsd-10-0-RELEASE:1.1.1.1 netbsd-10-0-RC6:1.1.1.1 netbsd-10-0-RC5:1.1.1.1 netbsd-10-0-RC4:1.1.1.1 netbsd-10-0-RC3:1.1.1.1 netbsd-10-0-RC2:1.1.1.1 netbsd-10-0-RC1:1.1.1.1 netbsd-10:1.1.1.1.0.46 netbsd-10-base:1.1.1.1 netbsd-9-3-RELEASE:1.1.1.1 cjep_sun2x-base1:1.1.1.1 cjep_sun2x:1.1.1.1.0.44 cjep_sun2x-base:1.1.1.1 cjep_staticlib_x-base1:1.1.1.1 netbsd-9-2-RELEASE:1.1.1.1 cjep_staticlib_x:1.1.1.1.0.42 cjep_staticlib_x-base:1.1.1.1 netbsd-9-1-RELEASE:1.1.1.1 phil-wifi-20200421:1.1.1.1 phil-wifi-20200411:1.1.1.1 is-mlppp:1.1.1.1.0.40 is-mlppp-base:1.1.1.1 phil-wifi-20200406:1.1.1.1 netbsd-8-2-RELEASE:1.1.1.1 netbsd-9-0-RELEASE:1.1.1.1 netbsd-9-0-RC2:1.1.1.1 netbsd-9-0-RC1:1.1.1.1 phil-wifi-20191119:1.1.1.1 netbsd-9:1.1.1.1.0.38 netbsd-9-base:1.1.1.1 phil-wifi-20190609:1.1.1.1 netbsd-8-1-RELEASE:1.1.1.1 netbsd-8-1-RC1:1.1.1.1 pgoyette-compat-merge-20190127:1.1.1.1 pgoyette-compat-20190127:1.1.1.1 pgoyette-compat-20190118:1.1.1.1 pgoyette-compat-1226:1.1.1.1 pgoyette-compat-1126:1.1.1.1 pgoyette-compat-1020:1.1.1.1 pgoyette-compat-0930:1.1.1.1 pgoyette-compat-0906:1.1.1.1 netbsd-7-2-RELEASE:1.1.1.1 pgoyette-compat-0728:1.1.1.1 netbsd-8-0-RELEASE:1.1.1.1 phil-wifi:1.1.1.1.0.36 phil-wifi-base:1.1.1.1 pgoyette-compat-0625:1.1.1.1 netbsd-8-0-RC2:1.1.1.1 pgoyette-compat-0521:1.1.1.1 pgoyette-compat-0502:1.1.1.1 pgoyette-compat-0422:1.1.1.1 netbsd-8-0-RC1:1.1.1.1 pgoyette-compat-0415:1.1.1.1 pgoyette-compat-0407:1.1.1.1 pgoyette-compat-0330:1.1.1.1 pgoyette-compat-0322:1.1.1.1 pgoyette-compat-0315:1.1.1.1 netbsd-7-1-2-RELEASE:1.1.1.1 pgoyette-compat:1.1.1.1.0.34 pgoyette-compat-base:1.1.1.1 netbsd-7-1-1-RELEASE:1.1.1.1 matt-nb8-mediatek:1.1.1.1.0.32 matt-nb8-mediatek-base:1.1.1.1 perseant-stdc-iso10646:1.1.1.1.0.30 perseant-stdc-iso10646-base:1.1.1.1 netbsd-8:1.1.1.1.0.28 netbsd-8-base:1.1.1.1 prg-localcount2-base3:1.1.1.1 prg-localcount2-base2:1.1.1.1 prg-localcount2-base1:1.1.1.1 prg-localcount2:1.1.1.1.0.26 prg-localcount2-base:1.1.1.1 pgoyette-localcount-20170426:1.1.1.1 bouyer-socketcan-base1:1.1.1.1 pgoyette-localcount-20170320:1.1.1.1 netbsd-7-1:1.1.1.1.0.24 netbsd-7-1-RELEASE:1.1.1.1 netbsd-7-1-RC2:1.1.1.1 netbsd-7-nhusb-base-20170116:1.1.1.1 bouyer-socketcan:1.1.1.1.0.22 bouyer-socketcan-base:1.1.1.1 pgoyette-localcount-20170107:1.1.1.1 netbsd-7-1-RC1:1.1.1.1 pgoyette-localcount-20161104:1.1.1.1 netbsd-7-0-2-RELEASE:1.1.1.1 localcount-20160914:1.1.1.1 netbsd-7-nhusb:1.1.1.1.0.20 netbsd-7-nhusb-base:1.1.1.1 pgoyette-localcount-20160806:1.1.1.1 pgoyette-localcount-20160726:1.1.1.1 pgoyette-localcount:1.1.1.1.0.18 pgoyette-localcount-base:1.1.1.1 netbsd-7-0-1-RELEASE:1.1.1.1 netbsd-7-0:1.1.1.1.0.16 netbsd-7-0-RELEASE:1.1.1.1 netbsd-7-0-RC3:1.1.1.1 netbsd-7-0-RC2:1.1.1.1 netbsd-7-0-RC1:1.1.1.1 netbsd-7:1.1.1.1.0.14 netbsd-7-base:1.1.1.1 yamt-pagecache:1.1.1.1.0.12 yamt-pagecache-base9:1.1.1.1 tls-earlyentropy:1.1.1.1.0.10 tls-earlyentropy-base:1.1.1.1 riastradh-xf86-video-intel-2-7-1-pre-2-21-15:1.1.1.1 riastradh-drm2-base3:1.1.1.1 kyua-cli-0-7:1.1.1.1 riastradh-drm2-base2:1.1.1.1 riastradh-drm2-base1:1.1.1.1 riastradh-drm2:1.1.1.1.0.2 riastradh-drm2-base:1.1.1.1 khorben-n900:1.1.1.1.0.8 agc-symver:1.1.1.1.0.6 agc-symver-base:1.1.1.1 tls-maxphys-base:1.1.1.1 tls-maxphys:1.1.1.1.0.4 kyua-cli-0-6:1.1.1.1 GOOGLE-CODE:1.1.1; locks; strict; comment @// @; 1.1 date 2013.02.23.12.34.04; author jmmv; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2013.02.23.12.34.04; author jmmv; state Exp; branches 1.1.1.1.4.1 1.1.1.1.12.1; next ; 1.1.1.1.4.1 date 2013.02.23.12.34.04; author tls; state dead; branches; next 1.1.1.1.4.2; 1.1.1.1.4.2 date 2013.02.25.00.26.09; author tls; state Exp; branches; next ; 1.1.1.1.12.1 date 2013.02.23.12.34.04; author yamt; state dead; branches; next 1.1.1.1.12.2; commitid h3iiOYJJCkPr7yBx; 1.1.1.1.12.2 date 2014.05.22.15.45.27; author yamt; state Exp; branches; next ; commitid h3iiOYJJCkPr7yBx; desc @@ 1.1 log @Initial revision @ text @// 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_help.hpp" #include #include #include #include #include "cli/common.ipp" #include "engine/config.hpp" #include "utils/cmdline/commands_map.ipp" #include "utils/cmdline/exceptions.hpp" #include "utils/cmdline/globals.hpp" #include "utils/cmdline/options.hpp" #include "utils/cmdline/parser.hpp" #include "utils/cmdline/ui_mock.hpp" #include "utils/defs.hpp" #include "utils/sanity.hpp" namespace cmdline = utils::cmdline; namespace config = utils::config; using cli::cmd_help; namespace { /// Mock command with a simple definition (no options, no arguments). /// /// Attempting to run this command will result in a crash. It is only provided /// to validate the generation of interactive help. class cmd_mock_simple : public cli::cli_command { public: /// Constructs a new mock command. /// /// \param name_ The name of the command to create. cmd_mock_simple(const char* name_) : cli::cli_command( name_, "", 0, 0, "Simple command") { } /// Runs the mock command. /// /// \param unused_ui Object to interact with the I/O of the program. /// \param unused_cmdline Representation of the command line to the /// subcommand. /// \param unused_user_config The runtime configuration of the program. /// /// \return Nothing because this function is never called. int run(cmdline::ui* UTILS_UNUSED_PARAM(ui), const cmdline::parsed_cmdline& UTILS_UNUSED_PARAM(cmdline), const config::tree& UTILS_UNUSED_PARAM(user_config)) { UNREACHABLE; } }; /// Mock command with a complex definition (some options, some arguments). /// /// Attempting to run this command will result in a crash. It is only provided /// to validate the generation of interactive help. class cmd_mock_complex : public cli::cli_command { public: /// Constructs a new mock command. /// /// \param name_ The name of the command to create. cmd_mock_complex(const char* name_) : cli::cli_command( name_, "[arg1 .. argN]", 0, 2, "Complex command") { add_option(cmdline::bool_option("flag_a", "Flag A")); add_option(cmdline::bool_option('b', "flag_b", "Flag B")); add_option(cmdline::string_option('c', "flag_c", "Flag C", "c_arg")); add_option(cmdline::string_option("flag_d", "Flag D", "d_arg", "foo")); } /// Runs the mock command. /// /// \param unused_ui Object to interact with the I/O of the program. /// \param unused_cmdline Representation of the command line to the /// subcommand. /// \param unused_user_config The runtime configuration of the program. /// /// \return Nothing because this function is never called. int run(cmdline::ui* UTILS_UNUSED_PARAM(ui), const cmdline::parsed_cmdline& UTILS_UNUSED_PARAM(cmdline), const config::tree& UTILS_UNUSED_PARAM(user_config)) { UNREACHABLE; } }; /// Initializes the cmdline library and generates the set of test commands. /// /// \param [out] commands A mapping that is updated to contain the commands to /// use for testing. static void setup(cmdline::commands_map< cli::cli_command >& commands) { cmdline::init("progname"); commands.insert(new cmd_mock_simple("mock_simple")); commands.insert(new cmd_mock_complex("mock_complex")); commands.insert(new cmd_mock_simple("mock_simple_2"), "First"); commands.insert(new cmd_mock_complex("mock_complex_2"), "First"); commands.insert(new cmd_mock_simple("mock_simple_3"), "Second"); } /// Performs a test on the global help (not that of a subcommand). /// /// \param general_options The genral options supported by the tool, if any. /// \param expected_options Expected lines of help output documenting the /// options in general_options. /// \param ui The cmdline::mock_ui object to which to write the output. static void global_test(const cmdline::options_vector& general_options, const std::vector< std::string >& expected_options, cmdline::ui_mock& ui) { cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); cmd_help cmd(&general_options, &mock_commands); ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); std::vector< std::string > expected; expected.push_back("Usage: progname [general_options] command " "[command_options] [args]"); if (!general_options.empty()) { expected.push_back(""); expected.push_back("Available general options:"); std::copy(expected_options.begin(), expected_options.end(), std::back_inserter(expected)); } expected.push_back(""); expected.push_back("Generic commands:"); expected.push_back(" mock_complex Complex command."); expected.push_back(" mock_simple Simple command."); expected.push_back(""); expected.push_back("First commands:"); expected.push_back(" mock_complex_2 Complex command."); expected.push_back(" mock_simple_2 Simple command."); expected.push_back(""); expected.push_back("Second commands:"); expected.push_back(" mock_simple_3 Simple command."); expected.push_back(""); expected.push_back("See kyua(1) for more details."); ATF_REQUIRE(expected == ui.out_log()); ATF_REQUIRE(ui.err_log().empty()); } } // anonymous namespace ATF_TEST_CASE_WITHOUT_HEAD(global__no_options); ATF_TEST_CASE_BODY(global__no_options) { cmdline::ui_mock ui; cmdline::options_vector general_options; global_test(general_options, std::vector< std::string >(), ui); } ATF_TEST_CASE_WITHOUT_HEAD(global__some_options); ATF_TEST_CASE_BODY(global__some_options) { cmdline::ui_mock ui; cmdline::options_vector general_options; const cmdline::bool_option flag_a("flag_a", "Flag A"); general_options.push_back(&flag_a); const cmdline::string_option flag_c('c', "lc", "Flag C", "X"); general_options.push_back(&flag_c); std::vector< std::string > expected; expected.push_back(" --flag_a Flag A."); expected.push_back(" -c X, --lc=X Flag C."); global_test(general_options, expected, ui); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__simple); ATF_TEST_CASE_BODY(subcommand__simple) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_simple"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(atf::utils::grep_collection("^Usage: progname \\[general_options\\] " "mock_simple$", ui.out_log())); ATF_REQUIRE(!atf::utils::grep_collection("Available.*options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("^See kyua-mock_simple\\(1\\) for more " "details.", ui.out_log())); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__complex); ATF_TEST_CASE_BODY(subcommand__complex) { cmdline::options_vector general_options; const cmdline::bool_option global_a("global_a", "Global A"); general_options.push_back(&global_a); const cmdline::string_option global_c('c', "global_c", "Global C", "c_global"); general_options.push_back(&global_c); cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_complex"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(atf::utils::grep_collection( "^Usage: progname \\[general_options\\] mock_complex " "\\[command_options\\] \\[arg1 .. argN\\]$", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("Available general options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--global_a", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--global_c=c_global", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("Available command options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--flag_a *Flag A", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("-b.*--flag_b *Flag B", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "-c c_arg.*--flag_c=c_arg *Flag C", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "--flag_d=d_arg *Flag D.*default.*foo", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "^See kyua-mock_complex\\(1\\) for more details.", ui.out_log())); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__unknown); ATF_TEST_CASE_BODY(subcommand__unknown) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("foobar"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_THROW_RE(cmdline::usage_error, "command foobar.*not exist", cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(ui.out_log().empty()); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(invalid_args); ATF_TEST_CASE_BODY(invalid_args) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_simple"); args.push_back("mock_complex"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_THROW_RE(cmdline::usage_error, "Too many arguments", cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(ui.out_log().empty()); ATF_REQUIRE(ui.err_log().empty()); } ATF_INIT_TEST_CASES(tcs) { ATF_ADD_TEST_CASE(tcs, global__no_options); ATF_ADD_TEST_CASE(tcs, global__some_options); ATF_ADD_TEST_CASE(tcs, subcommand__simple); ATF_ADD_TEST_CASE(tcs, subcommand__complex); ATF_ADD_TEST_CASE(tcs, subcommand__unknown); ATF_ADD_TEST_CASE(tcs, invalid_args); } @ 1.1.1.1 log @Initial import of Kyua CLI, version 0.6: This is the main component of Kyua and its build will be guarded by the MKKYUA knob. core@@ has approved this import. Description: Kyua (pronounced Q.A.) is a testing framework for both developers and users. Kyua is different from most other testing frameworks in that it puts the end user experience before anything else. There are multiple reasons for users to run the tests themselves, and Kyua ensures that they can do so in the most convenient way. This module, kyua-cli, provides the command-line interface to the Kyua runtime system. The major purpose of this tool is to run test cases and generate unified reports for their results. @ text @@ 1.1.1.1.12.1 log @file cmd_help_test.cpp was added on branch yamt-pagecache on 2014-05-22 15:45:27 +0000 @ text @d1 345 @ 1.1.1.1.12.2 log @sync with head. for a reference, the tree before this commit was tagged as yamt-pagecache-tag8. this commit was splitted into small chunks to avoid a limitation of cvs. ("Protocol error: too many arguments") @ text @a0 345 // 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_help.hpp" #include #include #include #include #include "cli/common.ipp" #include "engine/config.hpp" #include "utils/cmdline/commands_map.ipp" #include "utils/cmdline/exceptions.hpp" #include "utils/cmdline/globals.hpp" #include "utils/cmdline/options.hpp" #include "utils/cmdline/parser.hpp" #include "utils/cmdline/ui_mock.hpp" #include "utils/defs.hpp" #include "utils/sanity.hpp" namespace cmdline = utils::cmdline; namespace config = utils::config; using cli::cmd_help; namespace { /// Mock command with a simple definition (no options, no arguments). /// /// Attempting to run this command will result in a crash. It is only provided /// to validate the generation of interactive help. class cmd_mock_simple : public cli::cli_command { public: /// Constructs a new mock command. /// /// \param name_ The name of the command to create. cmd_mock_simple(const char* name_) : cli::cli_command( name_, "", 0, 0, "Simple command") { } /// Runs the mock command. /// /// \param unused_ui Object to interact with the I/O of the program. /// \param unused_cmdline Representation of the command line to the /// subcommand. /// \param unused_user_config The runtime configuration of the program. /// /// \return Nothing because this function is never called. int run(cmdline::ui* UTILS_UNUSED_PARAM(ui), const cmdline::parsed_cmdline& UTILS_UNUSED_PARAM(cmdline), const config::tree& UTILS_UNUSED_PARAM(user_config)) { UNREACHABLE; } }; /// Mock command with a complex definition (some options, some arguments). /// /// Attempting to run this command will result in a crash. It is only provided /// to validate the generation of interactive help. class cmd_mock_complex : public cli::cli_command { public: /// Constructs a new mock command. /// /// \param name_ The name of the command to create. cmd_mock_complex(const char* name_) : cli::cli_command( name_, "[arg1 .. argN]", 0, 2, "Complex command") { add_option(cmdline::bool_option("flag_a", "Flag A")); add_option(cmdline::bool_option('b', "flag_b", "Flag B")); add_option(cmdline::string_option('c', "flag_c", "Flag C", "c_arg")); add_option(cmdline::string_option("flag_d", "Flag D", "d_arg", "foo")); } /// Runs the mock command. /// /// \param unused_ui Object to interact with the I/O of the program. /// \param unused_cmdline Representation of the command line to the /// subcommand. /// \param unused_user_config The runtime configuration of the program. /// /// \return Nothing because this function is never called. int run(cmdline::ui* UTILS_UNUSED_PARAM(ui), const cmdline::parsed_cmdline& UTILS_UNUSED_PARAM(cmdline), const config::tree& UTILS_UNUSED_PARAM(user_config)) { UNREACHABLE; } }; /// Initializes the cmdline library and generates the set of test commands. /// /// \param [out] commands A mapping that is updated to contain the commands to /// use for testing. static void setup(cmdline::commands_map< cli::cli_command >& commands) { cmdline::init("progname"); commands.insert(new cmd_mock_simple("mock_simple")); commands.insert(new cmd_mock_complex("mock_complex")); commands.insert(new cmd_mock_simple("mock_simple_2"), "First"); commands.insert(new cmd_mock_complex("mock_complex_2"), "First"); commands.insert(new cmd_mock_simple("mock_simple_3"), "Second"); } /// Performs a test on the global help (not that of a subcommand). /// /// \param general_options The genral options supported by the tool, if any. /// \param expected_options Expected lines of help output documenting the /// options in general_options. /// \param ui The cmdline::mock_ui object to which to write the output. static void global_test(const cmdline::options_vector& general_options, const std::vector< std::string >& expected_options, cmdline::ui_mock& ui) { cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); cmd_help cmd(&general_options, &mock_commands); ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); std::vector< std::string > expected; expected.push_back("Usage: progname [general_options] command " "[command_options] [args]"); if (!general_options.empty()) { expected.push_back(""); expected.push_back("Available general options:"); std::copy(expected_options.begin(), expected_options.end(), std::back_inserter(expected)); } expected.push_back(""); expected.push_back("Generic commands:"); expected.push_back(" mock_complex Complex command."); expected.push_back(" mock_simple Simple command."); expected.push_back(""); expected.push_back("First commands:"); expected.push_back(" mock_complex_2 Complex command."); expected.push_back(" mock_simple_2 Simple command."); expected.push_back(""); expected.push_back("Second commands:"); expected.push_back(" mock_simple_3 Simple command."); expected.push_back(""); expected.push_back("See kyua(1) for more details."); ATF_REQUIRE(expected == ui.out_log()); ATF_REQUIRE(ui.err_log().empty()); } } // anonymous namespace ATF_TEST_CASE_WITHOUT_HEAD(global__no_options); ATF_TEST_CASE_BODY(global__no_options) { cmdline::ui_mock ui; cmdline::options_vector general_options; global_test(general_options, std::vector< std::string >(), ui); } ATF_TEST_CASE_WITHOUT_HEAD(global__some_options); ATF_TEST_CASE_BODY(global__some_options) { cmdline::ui_mock ui; cmdline::options_vector general_options; const cmdline::bool_option flag_a("flag_a", "Flag A"); general_options.push_back(&flag_a); const cmdline::string_option flag_c('c', "lc", "Flag C", "X"); general_options.push_back(&flag_c); std::vector< std::string > expected; expected.push_back(" --flag_a Flag A."); expected.push_back(" -c X, --lc=X Flag C."); global_test(general_options, expected, ui); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__simple); ATF_TEST_CASE_BODY(subcommand__simple) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_simple"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(atf::utils::grep_collection("^Usage: progname \\[general_options\\] " "mock_simple$", ui.out_log())); ATF_REQUIRE(!atf::utils::grep_collection("Available.*options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("^See kyua-mock_simple\\(1\\) for more " "details.", ui.out_log())); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__complex); ATF_TEST_CASE_BODY(subcommand__complex) { cmdline::options_vector general_options; const cmdline::bool_option global_a("global_a", "Global A"); general_options.push_back(&global_a); const cmdline::string_option global_c('c', "global_c", "Global C", "c_global"); general_options.push_back(&global_c); cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_complex"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(atf::utils::grep_collection( "^Usage: progname \\[general_options\\] mock_complex " "\\[command_options\\] \\[arg1 .. argN\\]$", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("Available general options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--global_a", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--global_c=c_global", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("Available command options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--flag_a *Flag A", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("-b.*--flag_b *Flag B", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "-c c_arg.*--flag_c=c_arg *Flag C", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "--flag_d=d_arg *Flag D.*default.*foo", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "^See kyua-mock_complex\\(1\\) for more details.", ui.out_log())); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__unknown); ATF_TEST_CASE_BODY(subcommand__unknown) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("foobar"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_THROW_RE(cmdline::usage_error, "command foobar.*not exist", cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(ui.out_log().empty()); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(invalid_args); ATF_TEST_CASE_BODY(invalid_args) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_simple"); args.push_back("mock_complex"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_THROW_RE(cmdline::usage_error, "Too many arguments", cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(ui.out_log().empty()); ATF_REQUIRE(ui.err_log().empty()); } ATF_INIT_TEST_CASES(tcs) { ATF_ADD_TEST_CASE(tcs, global__no_options); ATF_ADD_TEST_CASE(tcs, global__some_options); ATF_ADD_TEST_CASE(tcs, subcommand__simple); ATF_ADD_TEST_CASE(tcs, subcommand__complex); ATF_ADD_TEST_CASE(tcs, subcommand__unknown); ATF_ADD_TEST_CASE(tcs, invalid_args); } @ 1.1.1.1.4.1 log @file cmd_help_test.cpp was added on branch tls-maxphys on 2013-02-25 00:26:09 +0000 @ text @d1 345 @ 1.1.1.1.4.2 log @resync with head @ text @a0 345 // 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_help.hpp" #include #include #include #include #include "cli/common.ipp" #include "engine/config.hpp" #include "utils/cmdline/commands_map.ipp" #include "utils/cmdline/exceptions.hpp" #include "utils/cmdline/globals.hpp" #include "utils/cmdline/options.hpp" #include "utils/cmdline/parser.hpp" #include "utils/cmdline/ui_mock.hpp" #include "utils/defs.hpp" #include "utils/sanity.hpp" namespace cmdline = utils::cmdline; namespace config = utils::config; using cli::cmd_help; namespace { /// Mock command with a simple definition (no options, no arguments). /// /// Attempting to run this command will result in a crash. It is only provided /// to validate the generation of interactive help. class cmd_mock_simple : public cli::cli_command { public: /// Constructs a new mock command. /// /// \param name_ The name of the command to create. cmd_mock_simple(const char* name_) : cli::cli_command( name_, "", 0, 0, "Simple command") { } /// Runs the mock command. /// /// \param unused_ui Object to interact with the I/O of the program. /// \param unused_cmdline Representation of the command line to the /// subcommand. /// \param unused_user_config The runtime configuration of the program. /// /// \return Nothing because this function is never called. int run(cmdline::ui* UTILS_UNUSED_PARAM(ui), const cmdline::parsed_cmdline& UTILS_UNUSED_PARAM(cmdline), const config::tree& UTILS_UNUSED_PARAM(user_config)) { UNREACHABLE; } }; /// Mock command with a complex definition (some options, some arguments). /// /// Attempting to run this command will result in a crash. It is only provided /// to validate the generation of interactive help. class cmd_mock_complex : public cli::cli_command { public: /// Constructs a new mock command. /// /// \param name_ The name of the command to create. cmd_mock_complex(const char* name_) : cli::cli_command( name_, "[arg1 .. argN]", 0, 2, "Complex command") { add_option(cmdline::bool_option("flag_a", "Flag A")); add_option(cmdline::bool_option('b', "flag_b", "Flag B")); add_option(cmdline::string_option('c', "flag_c", "Flag C", "c_arg")); add_option(cmdline::string_option("flag_d", "Flag D", "d_arg", "foo")); } /// Runs the mock command. /// /// \param unused_ui Object to interact with the I/O of the program. /// \param unused_cmdline Representation of the command line to the /// subcommand. /// \param unused_user_config The runtime configuration of the program. /// /// \return Nothing because this function is never called. int run(cmdline::ui* UTILS_UNUSED_PARAM(ui), const cmdline::parsed_cmdline& UTILS_UNUSED_PARAM(cmdline), const config::tree& UTILS_UNUSED_PARAM(user_config)) { UNREACHABLE; } }; /// Initializes the cmdline library and generates the set of test commands. /// /// \param [out] commands A mapping that is updated to contain the commands to /// use for testing. static void setup(cmdline::commands_map< cli::cli_command >& commands) { cmdline::init("progname"); commands.insert(new cmd_mock_simple("mock_simple")); commands.insert(new cmd_mock_complex("mock_complex")); commands.insert(new cmd_mock_simple("mock_simple_2"), "First"); commands.insert(new cmd_mock_complex("mock_complex_2"), "First"); commands.insert(new cmd_mock_simple("mock_simple_3"), "Second"); } /// Performs a test on the global help (not that of a subcommand). /// /// \param general_options The genral options supported by the tool, if any. /// \param expected_options Expected lines of help output documenting the /// options in general_options. /// \param ui The cmdline::mock_ui object to which to write the output. static void global_test(const cmdline::options_vector& general_options, const std::vector< std::string >& expected_options, cmdline::ui_mock& ui) { cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); cmd_help cmd(&general_options, &mock_commands); ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); std::vector< std::string > expected; expected.push_back("Usage: progname [general_options] command " "[command_options] [args]"); if (!general_options.empty()) { expected.push_back(""); expected.push_back("Available general options:"); std::copy(expected_options.begin(), expected_options.end(), std::back_inserter(expected)); } expected.push_back(""); expected.push_back("Generic commands:"); expected.push_back(" mock_complex Complex command."); expected.push_back(" mock_simple Simple command."); expected.push_back(""); expected.push_back("First commands:"); expected.push_back(" mock_complex_2 Complex command."); expected.push_back(" mock_simple_2 Simple command."); expected.push_back(""); expected.push_back("Second commands:"); expected.push_back(" mock_simple_3 Simple command."); expected.push_back(""); expected.push_back("See kyua(1) for more details."); ATF_REQUIRE(expected == ui.out_log()); ATF_REQUIRE(ui.err_log().empty()); } } // anonymous namespace ATF_TEST_CASE_WITHOUT_HEAD(global__no_options); ATF_TEST_CASE_BODY(global__no_options) { cmdline::ui_mock ui; cmdline::options_vector general_options; global_test(general_options, std::vector< std::string >(), ui); } ATF_TEST_CASE_WITHOUT_HEAD(global__some_options); ATF_TEST_CASE_BODY(global__some_options) { cmdline::ui_mock ui; cmdline::options_vector general_options; const cmdline::bool_option flag_a("flag_a", "Flag A"); general_options.push_back(&flag_a); const cmdline::string_option flag_c('c', "lc", "Flag C", "X"); general_options.push_back(&flag_c); std::vector< std::string > expected; expected.push_back(" --flag_a Flag A."); expected.push_back(" -c X, --lc=X Flag C."); global_test(general_options, expected, ui); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__simple); ATF_TEST_CASE_BODY(subcommand__simple) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_simple"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(atf::utils::grep_collection("^Usage: progname \\[general_options\\] " "mock_simple$", ui.out_log())); ATF_REQUIRE(!atf::utils::grep_collection("Available.*options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("^See kyua-mock_simple\\(1\\) for more " "details.", ui.out_log())); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__complex); ATF_TEST_CASE_BODY(subcommand__complex) { cmdline::options_vector general_options; const cmdline::bool_option global_a("global_a", "Global A"); general_options.push_back(&global_a); const cmdline::string_option global_c('c', "global_c", "Global C", "c_global"); general_options.push_back(&global_c); cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_complex"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_EQ(EXIT_SUCCESS, cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(atf::utils::grep_collection( "^Usage: progname \\[general_options\\] mock_complex " "\\[command_options\\] \\[arg1 .. argN\\]$", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("Available general options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--global_a", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--global_c=c_global", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("Available command options", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("--flag_a *Flag A", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection("-b.*--flag_b *Flag B", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "-c c_arg.*--flag_c=c_arg *Flag C", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "--flag_d=d_arg *Flag D.*default.*foo", ui.out_log())); ATF_REQUIRE(atf::utils::grep_collection( "^See kyua-mock_complex\\(1\\) for more details.", ui.out_log())); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(subcommand__unknown); ATF_TEST_CASE_BODY(subcommand__unknown) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("foobar"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_THROW_RE(cmdline::usage_error, "command foobar.*not exist", cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(ui.out_log().empty()); ATF_REQUIRE(ui.err_log().empty()); } ATF_TEST_CASE_WITHOUT_HEAD(invalid_args); ATF_TEST_CASE_BODY(invalid_args) { cmdline::options_vector general_options; cmdline::commands_map< cli::cli_command > mock_commands; setup(mock_commands); cmdline::args_vector args; args.push_back("help"); args.push_back("mock_simple"); args.push_back("mock_complex"); cmd_help cmd(&general_options, &mock_commands); cmdline::ui_mock ui; ATF_REQUIRE_THROW_RE(cmdline::usage_error, "Too many arguments", cmd.main(&ui, args, engine::default_config())); ATF_REQUIRE(ui.out_log().empty()); ATF_REQUIRE(ui.err_log().empty()); } ATF_INIT_TEST_CASES(tcs) { ATF_ADD_TEST_CASE(tcs, global__no_options); ATF_ADD_TEST_CASE(tcs, global__some_options); ATF_ADD_TEST_CASE(tcs, subcommand__simple); ATF_ADD_TEST_CASE(tcs, subcommand__complex); ATF_ADD_TEST_CASE(tcs, subcommand__unknown); ATF_ADD_TEST_CASE(tcs, invalid_args); } @