1*b0d29bc4SBrooks Davis // Copyright 2011 The Kyua Authors. 2*b0d29bc4SBrooks Davis // All rights reserved. 3*b0d29bc4SBrooks Davis // 4*b0d29bc4SBrooks Davis // Redistribution and use in source and binary forms, with or without 5*b0d29bc4SBrooks Davis // modification, are permitted provided that the following conditions are 6*b0d29bc4SBrooks Davis // met: 7*b0d29bc4SBrooks Davis // 8*b0d29bc4SBrooks Davis // * Redistributions of source code must retain the above copyright 9*b0d29bc4SBrooks Davis // notice, this list of conditions and the following disclaimer. 10*b0d29bc4SBrooks Davis // * Redistributions in binary form must reproduce the above copyright 11*b0d29bc4SBrooks Davis // notice, this list of conditions and the following disclaimer in the 12*b0d29bc4SBrooks Davis // documentation and/or other materials provided with the distribution. 13*b0d29bc4SBrooks Davis // * Neither the name of Google Inc. nor the names of its contributors 14*b0d29bc4SBrooks Davis // may be used to endorse or promote products derived from this software 15*b0d29bc4SBrooks Davis // without specific prior written permission. 16*b0d29bc4SBrooks Davis // 17*b0d29bc4SBrooks Davis // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18*b0d29bc4SBrooks Davis // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19*b0d29bc4SBrooks Davis // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20*b0d29bc4SBrooks Davis // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21*b0d29bc4SBrooks Davis // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22*b0d29bc4SBrooks Davis // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23*b0d29bc4SBrooks Davis // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24*b0d29bc4SBrooks Davis // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25*b0d29bc4SBrooks Davis // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26*b0d29bc4SBrooks Davis // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27*b0d29bc4SBrooks Davis // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28*b0d29bc4SBrooks Davis 29*b0d29bc4SBrooks Davis /// \file cli/common.hpp 30*b0d29bc4SBrooks Davis /// Utility functions to implement CLI subcommands. 31*b0d29bc4SBrooks Davis 32*b0d29bc4SBrooks Davis #if !defined(CLI_COMMON_HPP) 33*b0d29bc4SBrooks Davis #define CLI_COMMON_HPP 34*b0d29bc4SBrooks Davis 35*b0d29bc4SBrooks Davis #include <memory> 36*b0d29bc4SBrooks Davis #include <set> 37*b0d29bc4SBrooks Davis #include <vector> 38*b0d29bc4SBrooks Davis 39*b0d29bc4SBrooks Davis #include "engine/filters_fwd.hpp" 40*b0d29bc4SBrooks Davis #include "model/test_program_fwd.hpp" 41*b0d29bc4SBrooks Davis #include "model/test_result.hpp" 42*b0d29bc4SBrooks Davis #include "utils/cmdline/base_command.hpp" 43*b0d29bc4SBrooks Davis #include "utils/cmdline/options_fwd.hpp" 44*b0d29bc4SBrooks Davis #include "utils/cmdline/parser_fwd.hpp" 45*b0d29bc4SBrooks Davis #include "utils/cmdline/ui_fwd.hpp" 46*b0d29bc4SBrooks Davis #include "utils/config/tree_fwd.hpp" 47*b0d29bc4SBrooks Davis #include "utils/datetime_fwd.hpp" 48*b0d29bc4SBrooks Davis #include "utils/fs/path_fwd.hpp" 49*b0d29bc4SBrooks Davis #include "utils/optional_fwd.hpp" 50*b0d29bc4SBrooks Davis 51*b0d29bc4SBrooks Davis namespace cli { 52*b0d29bc4SBrooks Davis 53*b0d29bc4SBrooks Davis 54*b0d29bc4SBrooks Davis extern const utils::cmdline::path_option build_root_option; 55*b0d29bc4SBrooks Davis extern const utils::cmdline::path_option kyuafile_option; 56*b0d29bc4SBrooks Davis extern const utils::cmdline::string_option results_file_create_option; 57*b0d29bc4SBrooks Davis extern const utils::cmdline::string_option results_file_open_option; 58*b0d29bc4SBrooks Davis extern const utils::cmdline::list_option results_filter_option; 59*b0d29bc4SBrooks Davis extern const utils::cmdline::property_option variable_option; 60*b0d29bc4SBrooks Davis 61*b0d29bc4SBrooks Davis 62*b0d29bc4SBrooks Davis /// Base type for commands defined in the cli module. 63*b0d29bc4SBrooks Davis /// 64*b0d29bc4SBrooks Davis /// All commands in Kyua receive a configuration object as their runtime 65*b0d29bc4SBrooks Davis /// data parameter because the configuration file applies to all the 66*b0d29bc4SBrooks Davis /// commands. 67*b0d29bc4SBrooks Davis typedef utils::cmdline::base_command< utils::config::tree > cli_command; 68*b0d29bc4SBrooks Davis 69*b0d29bc4SBrooks Davis 70*b0d29bc4SBrooks Davis /// Scoped, strictly owned pointer to a cli_command. 71*b0d29bc4SBrooks Davis typedef std::auto_ptr< cli_command > cli_command_ptr; 72*b0d29bc4SBrooks Davis 73*b0d29bc4SBrooks Davis 74*b0d29bc4SBrooks Davis /// Collection of result types. 75*b0d29bc4SBrooks Davis /// 76*b0d29bc4SBrooks Davis /// This is a vector rather than a set because we want to respect the order in 77*b0d29bc4SBrooks Davis /// which the user provided the types. 78*b0d29bc4SBrooks Davis typedef std::vector< model::test_result_type > result_types; 79*b0d29bc4SBrooks Davis 80*b0d29bc4SBrooks Davis 81*b0d29bc4SBrooks Davis utils::optional< utils::fs::path > build_root_path( 82*b0d29bc4SBrooks Davis const utils::cmdline::parsed_cmdline&); 83*b0d29bc4SBrooks Davis utils::fs::path kyuafile_path(const utils::cmdline::parsed_cmdline&); 84*b0d29bc4SBrooks Davis std::string results_file_create(const utils::cmdline::parsed_cmdline&); 85*b0d29bc4SBrooks Davis std::string results_file_open(const utils::cmdline::parsed_cmdline&); 86*b0d29bc4SBrooks Davis result_types get_result_types(const utils::cmdline::parsed_cmdline&); 87*b0d29bc4SBrooks Davis 88*b0d29bc4SBrooks Davis std::set< engine::test_filter > parse_filters( 89*b0d29bc4SBrooks Davis const utils::cmdline::args_vector&); 90*b0d29bc4SBrooks Davis bool report_unused_filters(const std::set< engine::test_filter >&, 91*b0d29bc4SBrooks Davis utils::cmdline::ui*); 92*b0d29bc4SBrooks Davis 93*b0d29bc4SBrooks Davis std::string format_delta(const utils::datetime::delta&); 94*b0d29bc4SBrooks Davis std::string format_result(const model::test_result&); 95*b0d29bc4SBrooks Davis std::string format_test_case_id(const model::test_program&, const std::string&); 96*b0d29bc4SBrooks Davis std::string format_test_case_id(const engine::test_filter&); 97*b0d29bc4SBrooks Davis 98*b0d29bc4SBrooks Davis 99*b0d29bc4SBrooks Davis void write_version_header(utils::cmdline::ui*); 100*b0d29bc4SBrooks Davis 101*b0d29bc4SBrooks Davis 102*b0d29bc4SBrooks Davis } // namespace cli 103*b0d29bc4SBrooks Davis 104*b0d29bc4SBrooks Davis #endif // !defined(CLI_COMMON_HPP) 105