mirror of
https://github.com/catchorg/Catch2.git
synced 2025-09-17 02:25:38 +02:00
Pipe --list* through reporters
This allows us to provide machine-readable listings through the XMLReporter and it will also allow users to define their own listing format that does whatever their own tools need.
This commit is contained in:
@@ -23,65 +23,22 @@
|
||||
|
||||
#include <limits>
|
||||
#include <algorithm>
|
||||
#include <iomanip>
|
||||
#include <set>
|
||||
|
||||
namespace Catch {
|
||||
namespace {
|
||||
|
||||
struct TagInfo {
|
||||
void add(std::string const& spelling);
|
||||
std::string all() const;
|
||||
|
||||
std::set<std::string> spellings;
|
||||
std::size_t count = 0;
|
||||
};
|
||||
|
||||
|
||||
void listTests(Config const& config) {
|
||||
void listTests(IStreamingReporter& reporter, Config const& config) {
|
||||
TestSpec testSpec = config.testSpec();
|
||||
if (config.hasTestFilters())
|
||||
Catch::cout() << "Matching test cases:\n";
|
||||
else {
|
||||
Catch::cout() << "All available test cases:\n";
|
||||
}
|
||||
|
||||
auto matchedTestCases = filterTests(getAllTestCasesSorted(config), testSpec, config);
|
||||
for (auto const& testCaseInfo : matchedTestCases) {
|
||||
Colour::Code colour = testCaseInfo.isHidden()
|
||||
? Colour::SecondaryText
|
||||
: Colour::None;
|
||||
Colour colourGuard(colour);
|
||||
|
||||
Catch::cout() << Column(testCaseInfo.name).initialIndent(2).indent(4) << "\n";
|
||||
if (config.verbosity() >= Verbosity::High) {
|
||||
Catch::cout() << Column(Catch::Detail::stringify(testCaseInfo.lineInfo)).indent(4) << std::endl;
|
||||
std::string description = testCaseInfo.description;
|
||||
if (description.empty())
|
||||
description = "(NO DESCRIPTION)";
|
||||
Catch::cout() << Column(description).indent(4) << std::endl;
|
||||
}
|
||||
if (!testCaseInfo.tags.empty())
|
||||
Catch::cout() << Column(testCaseInfo.tagsAsString()).indent(6) << "\n";
|
||||
}
|
||||
|
||||
if (!config.hasTestFilters())
|
||||
Catch::cout() << pluralise(matchedTestCases.size(), "test case") << '\n' << std::endl;
|
||||
else
|
||||
Catch::cout() << pluralise(matchedTestCases.size(), "matching test case") << '\n' << std::endl;
|
||||
reporter.listTests(matchedTestCases, config);
|
||||
}
|
||||
|
||||
void listTags(Config const& config) {
|
||||
void listTags(IStreamingReporter& reporter, Config const& config) {
|
||||
TestSpec testSpec = config.testSpec();
|
||||
if (config.hasTestFilters())
|
||||
Catch::cout() << "Tags for matching test cases:\n";
|
||||
else {
|
||||
Catch::cout() << "All available tags:\n";
|
||||
}
|
||||
std::vector<TestCase> matchedTestCases = filterTests(getAllTestCasesSorted(config), testSpec, config);
|
||||
|
||||
std::map<std::string, TagInfo> tagCounts;
|
||||
|
||||
std::vector<TestCase> matchedTestCases = filterTests(getAllTestCasesSorted(config), testSpec, config);
|
||||
for (auto const& testCase : matchedTestCases) {
|
||||
for (auto const& tagName : testCase.getTestCaseInfo().tags) {
|
||||
std::string lcaseTagName = toLower(tagName);
|
||||
@@ -92,38 +49,24 @@ namespace Catch {
|
||||
}
|
||||
}
|
||||
|
||||
for (auto const& tagCount : tagCounts) {
|
||||
ReusableStringStream rss;
|
||||
rss << " " << std::setw(2) << tagCount.second.count << " ";
|
||||
auto str = rss.str();
|
||||
auto wrapper = Column(tagCount.second.all())
|
||||
.initialIndent(0)
|
||||
.indent(str.size())
|
||||
.width(CATCH_CONFIG_CONSOLE_WIDTH - 10);
|
||||
Catch::cout() << str << wrapper << '\n';
|
||||
std::vector<TagInfo> infos; infos.reserve(tagCounts.size());
|
||||
for (auto const& tagc : tagCounts) {
|
||||
infos.push_back(std::move(tagc.second));
|
||||
}
|
||||
Catch::cout() << pluralise(tagCounts.size(), "tag") << '\n' << std::endl;
|
||||
|
||||
reporter.listTags(infos, config);
|
||||
}
|
||||
|
||||
void listReporters() {
|
||||
Catch::cout() << "Available reporters:\n";
|
||||
IReporterRegistry::FactoryMap const& factories = getRegistryHub().getReporterRegistry().getFactories();
|
||||
std::size_t maxNameLen = 0;
|
||||
for (auto const& factoryKvp : factories)
|
||||
maxNameLen = (std::max)(maxNameLen, factoryKvp.first.size());
|
||||
void listReporters(IStreamingReporter& reporter, Config const& config) {
|
||||
std::vector<ReporterDescription> descriptions;
|
||||
|
||||
for (auto const& factoryKvp : factories) {
|
||||
Catch::cout()
|
||||
<< Column(factoryKvp.first + ":")
|
||||
.indent(2)
|
||||
.width(5 + maxNameLen)
|
||||
+ Column(factoryKvp.second->getDescription())
|
||||
.initialIndent(0)
|
||||
.indent(2)
|
||||
.width(CATCH_CONFIG_CONSOLE_WIDTH - maxNameLen - 8)
|
||||
<< "\n";
|
||||
IReporterRegistry::FactoryMap const& factories = getRegistryHub().getReporterRegistry().getFactories();
|
||||
descriptions.reserve(factories.size());
|
||||
for (auto const& fac : factories) {
|
||||
descriptions.push_back({ fac.first, fac.second->getDescription() });
|
||||
}
|
||||
Catch::cout() << std::endl;
|
||||
|
||||
reporter.listReporters(descriptions, config);
|
||||
}
|
||||
|
||||
} // end anonymous namespace
|
||||
@@ -149,20 +92,20 @@ namespace Catch {
|
||||
return out;
|
||||
}
|
||||
|
||||
bool list( std::shared_ptr<Config> const& config ) {
|
||||
bool list( IStreamingReporter& reporter, std::shared_ptr<Config> const& config ) {
|
||||
bool listed = false;
|
||||
getCurrentMutableContext().setConfig( config );
|
||||
if (config->listTests()) {
|
||||
listed = true;
|
||||
listTests(*config);
|
||||
listTests(reporter, *config);
|
||||
}
|
||||
if (config->listTags()) {
|
||||
listed = true;
|
||||
listTags(*config);
|
||||
listTags(reporter, *config);
|
||||
}
|
||||
if (config->listReporters()) {
|
||||
listed = true;
|
||||
listReporters();
|
||||
listReporters(reporter, *config);
|
||||
}
|
||||
return listed;
|
||||
}
|
||||
|
Reference in New Issue
Block a user