diff options
| author | Martin Hořeňovský | 2021-11-07 23:31:44 +0100 |
|---|---|---|
| committer | Martin Hořeňovský | 2021-11-09 11:50:03 +0100 |
| commit | 8780425385787242092333d72e30b2217cb2f6b3 (patch) | |
| tree | df69ea71c89b4ae1808d3be1e4dbfe314e06f1df | |
| parent | 7800fe970864199aa6c064aa49baa5fb3463a817 (diff) | |
| download | catch3-8780425385787242092333d72e30b2217cb2f6b3.tar.gz | |
Make reporter lookup case insensitive, registration case preserving
Previously registration was case preserving, but lookup used
lowercased reporter name, so a reporter whose name contained
upper case character could not be requested by the user.
| -rw-r--r-- | docs/release-notes.md | 2 | ||||
| -rw-r--r-- | src/catch2/interfaces/catch_interfaces_combined_tu.cpp | 13 | ||||
| -rw-r--r-- | src/catch2/interfaces/catch_interfaces_reporter_registry.hpp | 6 | ||||
| -rw-r--r-- | src/catch2/internal/catch_commandline.cpp | 5 | ||||
| -rw-r--r-- | tests/ExtraTests/CMakeLists.txt | 22 | ||||
| -rw-r--r-- | tests/ExtraTests/X23-CasingInReporterNames.cpp | 40 |
6 files changed, 84 insertions, 4 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md index 9e97925f..8fd5b9a1 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -177,6 +177,8 @@ new design. * Various ways of failing a benchmark are now counted and reporter properly * The ULP matcher now handles comparing numbers with different signs properly (#2152) * Universal ADL-found operators should no longer break decomposition (#2121) +* Reporter selection is properly case-insensitive + * Previously it forced lower cased name, which would fail for reporters with upper case characters in name ### Other changes diff --git a/src/catch2/interfaces/catch_interfaces_combined_tu.cpp b/src/catch2/interfaces/catch_interfaces_combined_tu.cpp index 7acf0a12..0f2f406b 100644 --- a/src/catch2/interfaces/catch_interfaces_combined_tu.cpp +++ b/src/catch2/interfaces/catch_interfaces_combined_tu.cpp @@ -76,8 +76,21 @@ namespace Catch { #include <catch2/interfaces/catch_interfaces_reporter_registry.hpp> +#include <catch2/internal/catch_string_manip.hpp> + +#include <algorithm> + namespace Catch { + IReporterRegistry::~IReporterRegistry() = default; + bool IReporterRegistry::CaseInsensitiveCmp::operator()(std::string const& lhs, std::string const& rhs) const { + return std::lexicographical_compare(lhs.begin(), lhs.end(), + rhs.begin(), rhs.end(), + [](char l, char r) { + return toLower(l) < toLower(r); + }); + } + } diff --git a/src/catch2/interfaces/catch_interfaces_reporter_registry.hpp b/src/catch2/interfaces/catch_interfaces_reporter_registry.hpp index 54871cce..0228f9c3 100644 --- a/src/catch2/interfaces/catch_interfaces_reporter_registry.hpp +++ b/src/catch2/interfaces/catch_interfaces_reporter_registry.hpp @@ -24,7 +24,11 @@ namespace Catch { using IReporterFactoryPtr = Detail::unique_ptr<IReporterFactory>; struct IReporterRegistry { - using FactoryMap = std::map<std::string, IReporterFactoryPtr>; + struct CaseInsensitiveCmp { + bool operator()(std::string const& lhs, std::string const& rhs) const; + }; + + using FactoryMap = std::map<std::string, IReporterFactoryPtr, CaseInsensitiveCmp>; using Listeners = std::vector<IReporterFactoryPtr>; virtual ~IReporterRegistry(); // = default diff --git a/src/catch2/internal/catch_commandline.cpp b/src/catch2/internal/catch_commandline.cpp index 6cf71b77..02056da5 100644 --- a/src/catch2/internal/catch_commandline.cpp +++ b/src/catch2/internal/catch_commandline.cpp @@ -140,11 +140,10 @@ namespace Catch { auto const setReporter = [&]( std::string const& reporter ) { IReporterRegistry::FactoryMap const& factories = getRegistryHub().getReporterRegistry().getFactories(); - auto lcReporter = toLower( reporter ); - auto result = factories.find( lcReporter ); + auto result = factories.find( reporter ); if( factories.end() != result ) - config.reporterName = lcReporter; + config.reporterName = reporter; else return ParserResult::runtimeError( "Unrecognized reporter, '" + reporter + "'. Check available with --list-reporters" ); return ParserResult::ok( ParseResultType::Matched ); diff --git a/tests/ExtraTests/CMakeLists.txt b/tests/ExtraTests/CMakeLists.txt index f2add6d6..0dd0f0cf 100644 --- a/tests/ExtraTests/CMakeLists.txt +++ b/tests/ExtraTests/CMakeLists.txt @@ -197,6 +197,28 @@ add_test( ) +add_executable(CasingInReporterNames ${TESTS_DIR}/X23-CasingInReporterNames.cpp) +target_link_libraries(CasingInReporterNames PRIVATE Catch2::Catch2WithMain) +add_test( + NAME Reporters::registration-is-case-preserving + COMMAND CasingInReporterNames --list-reporters +) +set_tests_properties( + Reporters::registration-is-case-preserving + PROPERTIES + PASS_REGULAR_EXPRESSION "testReporterCASED" +) +add_test( + NAME Reporters::selection-is-case-insensitive + COMMAND CasingInReporterNames -r testReportercased +) +set_tests_properties( + Reporters::selection-is-case-insensitive + PROPERTIES + PASS_REGULAR_EXPRESSION "TestReporter constructed" +) + + add_executable(DuplicatedTestCases-SameNameAndTags ${TESTS_DIR}/X31-DuplicatedTestCases.cpp) target_link_libraries(DuplicatedTestCases-SameNameAndTags PRIVATE Catch2::Catch2WithMain) add_test( diff --git a/tests/ExtraTests/X23-CasingInReporterNames.cpp b/tests/ExtraTests/X23-CasingInReporterNames.cpp new file mode 100644 index 00000000..48c0b30d --- /dev/null +++ b/tests/ExtraTests/X23-CasingInReporterNames.cpp @@ -0,0 +1,40 @@ + +// Copyright Catch2 Authors +// Distributed under the Boost Software License, Version 1.0. +// (See accompanying file LICENSE_1_0.txt or copy at +// https://www.boost.org/LICENSE_1_0.txt) + +// SPDX-License-Identifier: BSL-1.0 + +/**\file + * Test that reporter registration is case-preserving, selection is + * case-insensitive. + * + * This is done by registering a custom reporter that prints out a marker + * string upon construction and then invoking the binary with different + * casings of the name. + */ + +#include <catch2/reporters/catch_reporter_streaming_base.hpp> +#include <catch2/catch_reporter_registrars.hpp> + +#include <iostream> + +class TestReporter : public Catch::StreamingReporterBase { +public: + TestReporter(Catch::ReporterConfig const& _config): + StreamingReporterBase(_config) { + std::cout << "TestReporter constructed\n"; + } + + static std::string getDescription() { + return "Reporter for testing casing handling in reporter registration/selection"; + } + + ~TestReporter() override; +}; + +TestReporter::~TestReporter() = default; + +CATCH_REGISTER_REPORTER("testReporterCASED", TestReporter) + |