catch2/include/internal/catch_commandline.cpp

231 lines
10 KiB
C++
Raw Normal View History

2017-07-10 14:25:38 +02:00
/*
* Created by Phil on 02/11/2010.
* Copyright 2010 Two Blue Cubes Ltd. All rights reserved.
*
* Distributed under the Boost Software License, Version 1.0. (See accompanying
* file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
*/
#include "catch_commandline.h"
2017-07-10 14:25:38 +02:00
#include "catch_string_manip.h"
2017-07-10 14:25:38 +02:00
#include "catch_interfaces_registry_hub.h"
#include "catch_interfaces_reporter.h"
2017-07-10 14:25:38 +02:00
#include <fstream>
#include <ctime>
namespace Catch {
clara::Parser makeCommandLineParser( ConfigData& config ) {
using namespace clara;
auto const setWarning = [&]( std::string const& warning ) {
auto warningSet = [&]() {
if( warning == "NoAssertions" )
return WarnAbout::NoAssertions;
if ( warning == "NoTests" )
return WarnAbout::NoTests;
return WarnAbout::Nothing;
}();
if (warningSet == WarnAbout::Nothing)
2017-07-10 14:25:38 +02:00
return ParserResult::runtimeError( "Unrecognised warning: '" + warning + "'" );
config.warnings = static_cast<WarnAbout::What>( config.warnings | warningSet );
2017-07-10 14:25:38 +02:00
return ParserResult::ok( ParseResultType::Matched );
};
auto const loadTestNamesFromFile = [&]( std::string const& filename ) {
std::ifstream f( filename.c_str() );
if( !f.is_open() )
return ParserResult::runtimeError( "Unable to load input file: '" + filename + "'" );
std::string line;
while( std::getline( f, line ) ) {
line = trim(line);
if( !line.empty() && !startsWith( line, '#' ) ) {
if( !startsWith( line, '"' ) )
line = '"' + line + '"';
config.testsOrTags.push_back( line );
config.testsOrTags.emplace_back( "," );
2017-07-10 14:25:38 +02:00
}
}
//Remove comma in the end
if(!config.testsOrTags.empty())
config.testsOrTags.erase( config.testsOrTags.end()-1 );
2017-07-10 14:25:38 +02:00
return ParserResult::ok( ParseResultType::Matched );
};
auto const setTestOrder = [&]( std::string const& order ) {
if( startsWith( "declared", order ) )
config.runOrder = RunTests::InDeclarationOrder;
else if( startsWith( "lexical", order ) )
config.runOrder = RunTests::InLexicographicalOrder;
else if( startsWith( "random", order ) )
config.runOrder = RunTests::InRandomOrder;
else
return clara::ParserResult::runtimeError( "Unrecognised ordering: '" + order + "'" );
return ParserResult::ok( ParseResultType::Matched );
};
auto const setRngSeed = [&]( std::string const& seed ) {
if( seed != "time" )
return clara::detail::convertInto( seed, config.rngSeed );
config.rngSeed = static_cast<unsigned int>( std::time(nullptr) );
2017-07-10 14:25:38 +02:00
return ParserResult::ok( ParseResultType::Matched );
};
auto const setColourUsage = [&]( std::string const& useColour ) {
auto mode = toLower( useColour );
if( mode == "yes" )
config.useColour = UseColour::Yes;
else if( mode == "no" )
config.useColour = UseColour::No;
else if( mode == "auto" )
config.useColour = UseColour::Auto;
else
return ParserResult::runtimeError( "colour mode must be one of: auto, yes or no. '" + useColour + "' not recognised" );
return ParserResult::ok( ParseResultType::Matched );
};
auto const setWaitForKeypress = [&]( std::string const& keypress ) {
auto keypressLc = toLower( keypress );
if (keypressLc == "never")
config.waitForKeypress = WaitForKeypress::Never;
else if( keypressLc == "start" )
config.waitForKeypress = WaitForKeypress::BeforeStart;
else if( keypressLc == "exit" )
config.waitForKeypress = WaitForKeypress::BeforeExit;
else if( keypressLc == "both" )
config.waitForKeypress = WaitForKeypress::BeforeStartAndExit;
else
return ParserResult::runtimeError( "keypress argument must be one of: never, start, exit or both. '" + keypress + "' not recognised" );
return ParserResult::ok( ParseResultType::Matched );
};
2017-07-10 14:25:38 +02:00
auto const setVerbosity = [&]( std::string const& verbosity ) {
auto lcVerbosity = toLower( verbosity );
if( lcVerbosity == "quiet" )
config.verbosity = Verbosity::Quiet;
else if( lcVerbosity == "normal" )
config.verbosity = Verbosity::Normal;
else if( lcVerbosity == "high" )
config.verbosity = Verbosity::High;
else
return ParserResult::runtimeError( "Unrecognised verbosity, '" + verbosity + "'" );
return ParserResult::ok( ParseResultType::Matched );
};
auto const setReporter = [&]( std::string const& reporter ) {
IReporterRegistry::FactoryMap const& factories = getRegistryHub().getReporterRegistry().getFactories();
auto lcReporter = toLower( reporter );
auto result = factories.find( lcReporter );
if( factories.end() != result )
config.reporterName = lcReporter;
else
return ParserResult::runtimeError( "Unrecognized reporter, '" + reporter + "'. Check available with --list-reporters" );
return ParserResult::ok( ParseResultType::Matched );
};
2017-07-10 14:25:38 +02:00
auto cli
= ExeName( config.processName )
2017-09-26 00:12:00 +02:00
| Help( config.showHelp )
| Opt( config.listTests )
2017-07-10 14:25:38 +02:00
["-l"]["--list-tests"]
( "list all/matching test cases" )
2017-09-26 00:12:00 +02:00
| Opt( config.listTags )
2017-07-10 14:25:38 +02:00
["-t"]["--list-tags"]
( "list all/matching tags" )
2017-09-26 00:12:00 +02:00
| Opt( config.showSuccessfulTests )
2017-07-10 14:25:38 +02:00
["-s"]["--success"]
( "include successful tests in output" )
2017-09-26 00:12:00 +02:00
| Opt( config.shouldDebugBreak )
2017-07-10 14:25:38 +02:00
["-b"]["--break"]
( "break into debugger on failure" )
2017-09-26 00:12:00 +02:00
| Opt( config.noThrow )
2017-07-10 14:25:38 +02:00
["-e"]["--nothrow"]
( "skip exception tests" )
2017-09-26 00:12:00 +02:00
| Opt( config.showInvisibles )
2017-07-10 14:25:38 +02:00
["-i"]["--invisibles"]
( "show invisibles (tabs, newlines)" )
2017-09-26 00:12:00 +02:00
| Opt( config.outputFilename, "filename" )
2017-07-10 14:25:38 +02:00
["-o"]["--out"]
( "output filename" )
| Opt( setReporter, "name" )
2017-07-10 14:25:38 +02:00
["-r"]["--reporter"]
( "reporter to use (defaults to console)" )
2017-09-26 00:12:00 +02:00
| Opt( config.name, "name" )
2017-07-10 14:25:38 +02:00
["-n"]["--name"]
( "suite name" )
2017-09-26 00:12:00 +02:00
| Opt( [&]( bool ){ config.abortAfter = 1; } )
2017-07-10 14:25:38 +02:00
["-a"]["--abort"]
( "abort at first failure" )
2017-09-26 00:12:00 +02:00
| Opt( [&]( int x ){ config.abortAfter = x; }, "no. failures" )
2017-07-10 14:25:38 +02:00
["-x"]["--abortx"]
( "abort after x failures" )
2017-09-26 00:12:00 +02:00
| Opt( setWarning, "warning name" )
2017-07-10 14:25:38 +02:00
["-w"]["--warn"]
( "enable warnings" )
2017-09-26 00:12:00 +02:00
| Opt( [&]( bool flag ) { config.showDurations = flag ? ShowDurations::Always : ShowDurations::Never; }, "yes|no" )
2017-07-10 14:25:38 +02:00
["-d"]["--durations"]
( "show test durations" )
| Opt( config.minDuration, "seconds" )
["-D"]["--min-duration"]
( "show test durations for tests taking at least the given number of seconds" )
2017-09-26 00:12:00 +02:00
| Opt( loadTestNamesFromFile, "filename" )
2017-07-10 14:25:38 +02:00
["-f"]["--input-file"]
( "load test names to run from a file" )
2017-09-26 00:12:00 +02:00
| Opt( config.filenamesAsTags )
2017-07-10 14:25:38 +02:00
["-#"]["--filenames-as-tags"]
( "adds a tag for the filename" )
2017-09-26 00:12:00 +02:00
| Opt( config.sectionsToRun, "section name" )
2017-07-10 14:25:38 +02:00
["-c"]["--section"]
( "specify section to run" )
2017-09-26 00:12:00 +02:00
| Opt( setVerbosity, "quiet|normal|high" )
2017-07-10 14:25:38 +02:00
["-v"]["--verbosity"]
( "set output verbosity" )
2017-09-26 00:12:00 +02:00
| Opt( config.listTestNamesOnly )
2017-07-10 14:25:38 +02:00
["--list-test-names-only"]
( "list all/matching test cases names only" )
2017-09-26 00:12:00 +02:00
| Opt( config.listReporters )
2017-07-10 14:25:38 +02:00
["--list-reporters"]
( "list all reporters" )
2017-09-26 00:12:00 +02:00
| Opt( setTestOrder, "decl|lex|rand" )
2017-07-10 14:25:38 +02:00
["--order"]
( "test case order (defaults to decl)" )
2017-09-26 00:12:00 +02:00
| Opt( setRngSeed, "'time'|number" )
2017-07-10 14:25:38 +02:00
["--rng-seed"]
( "set a specific seed for random numbers" )
2017-09-26 00:12:00 +02:00
| Opt( setColourUsage, "yes|no" )
2017-07-10 14:25:38 +02:00
["--use-colour"]
( "should output be colourised" )
2017-09-26 00:12:00 +02:00
| Opt( config.libIdentify )
["--libidentify"]
( "report name and version according to libidentify standard" )
| Opt( setWaitForKeypress, "never|start|exit|both" )
["--wait-for-keypress"]
( "waits for a keypress before exiting" )
| Opt( config.benchmarkSamples, "samples" )
["--benchmark-samples"]
( "number of samples to collect (default: 100)" )
| Opt( config.benchmarkResamples, "resamples" )
["--benchmark-resamples"]
( "number of resamples for the bootstrap (default: 100000)" )
| Opt( config.benchmarkConfidenceInterval, "confidence interval" )
["--benchmark-confidence-interval"]
( "confidence interval for the bootstrap (between 0 and 1, default: 0.95)" )
| Opt( config.benchmarkNoAnalysis )
["--benchmark-no-analysis"]
( "perform only measurements; do not perform any analysis" )
| Opt( config.benchmarkWarmupTime, "benchmarkWarmupTime" )
["--benchmark-warmup-time"]
( "amount of time in milliseconds spent on warming up each test (default: 100)" )
| Arg( config.testsOrTags, "test name|pattern|tags" )
2017-07-10 14:25:38 +02:00
( "which test or tests to use" );
return cli;
}
} // end namespace Catch