Progmasoft Git

catch3

Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.

Clonegit clone https://git.progmasoft.com/catch3

Rename config::colourMode to config::defaultConfigMode

This describes the actual intention much better.
Commit
d5bfce4d84f5dda55e1b77d2002a2726732130c6
Author
Martin Hořeňovský ·
Parents
c43947eb473d

Files · Download .tar.gz

Changes

 src/catch2/catch_config.cpp                            | 2 +-
 src/catch2/catch_config.hpp                            | 4 ++--
 src/catch2/catch_session.cpp                           | 4 ++--
 src/catch2/interfaces/catch_interfaces_config.hpp      | 2 +-
 src/catch2/internal/catch_commandline.cpp              | 7 +++----
 tests/SelfTest/Baselines/compact.sw.approved.txt       | 8 ++++----
 tests/SelfTest/Baselines/compact.sw.multi.approved.txt | 8 ++++----
 tests/SelfTest/Baselines/console.sw.approved.txt       | 8 ++++----
 tests/SelfTest/Baselines/console.sw.multi.approved.txt | 8 ++++----
 tests/SelfTest/Baselines/tap.sw.approved.txt           | 8 ++++----
 tests/SelfTest/Baselines/tap.sw.multi.approved.txt     | 8 ++++----
 tests/SelfTest/Baselines/xml.sw.approved.txt           | 8 ++++----
 tests/SelfTest/Baselines/xml.sw.multi.approved.txt     | 8 ++++----
 tests/SelfTest/IntrospectiveTests/CmdLine.tests.cpp    | 8 ++++----
 14 files changed, 45 insertions(+), 46 deletions(-)

diff --git a/src/catch2/catch_config.cpp b/src/catch2/catch_config.cpp
index 75a92883..33ef9bdd 100644
--- a/src/catch2/catch_config.cpp
+++ b/src/catch2/catch_config.cpp
@@ -127,7 +127,7 @@ namespace Catch {
     uint32_t Config::rngSeed() const                   { return m_data.rngSeed; }
     unsigned int Config::shardCount() const            { return m_data.shardCount; }
     unsigned int Config::shardIndex() const            { return m_data.shardIndex; }
-    ColourMode Config::colourMode() const              { return m_data.colourMode; }
+    ColourMode Config::defaultColourMode() const       { return m_data.defaultColourMode; }
     bool Config::shouldDebugBreak() const              { return m_data.shouldDebugBreak; }
     int Config::abortAfter() const                     { return m_data.abortAfter; }
     bool Config::showInvisibles() const                { return m_data.showInvisibles; }
diff --git a/src/catch2/catch_config.hpp b/src/catch2/catch_config.hpp
index 324d634c..6b4a9205 100644
--- a/src/catch2/catch_config.hpp
+++ b/src/catch2/catch_config.hpp
@@ -56,7 +56,7 @@ namespace Catch {
         ShowDurations showDurations = ShowDurations::DefaultForReporter;
         double minDuration = -1;
         TestRunOrder runOrder = TestRunOrder::Declared;
-        ColourMode colourMode = ColourMode::PlatformDefault;
+        ColourMode defaultColourMode = ColourMode::PlatformDefault;
         WaitForKeypress::When waitForKeypress = WaitForKeypress::Never;
 
         std::string defaultOutputFilename;
@@ -104,7 +104,7 @@ namespace Catch {
         uint32_t rngSeed() const override;
         unsigned int shardCount() const override;
         unsigned int shardIndex() const override;
-        ColourMode colourMode() const override;
+        ColourMode defaultColourMode() const override;
         bool shouldDebugBreak() const override;
         int abortAfter() const override;
         bool showInvisibles() const override;
diff --git a/src/catch2/catch_session.cpp b/src/catch2/catch_session.cpp
index 74731cd0..86295844 100644
--- a/src/catch2/catch_session.cpp
+++ b/src/catch2/catch_session.cpp
@@ -51,7 +51,7 @@ namespace Catch {
                     ReporterConfig(
                         config,
                         stream,
-                        spec.colourMode().valueOr( config->colourMode() ),
+                        spec.colourMode().valueOr( config->defaultColourMode() ),
                         spec.customOptions() ) );
             }
 
@@ -70,7 +70,7 @@ namespace Catch {
                     ReporterConfig( config,
                                     stream,
                                     reporterSpec.colourMode().valueOr(
-                                        config->colourMode() ),
+                                        config->defaultColourMode() ),
                                     reporterSpec.customOptions() ) ) );
                 reporterIdx++;
             }
diff --git a/src/catch2/interfaces/catch_interfaces_config.hpp b/src/catch2/interfaces/catch_interfaces_config.hpp
index fb3b2977..968c868e 100644
--- a/src/catch2/interfaces/catch_interfaces_config.hpp
+++ b/src/catch2/interfaces/catch_interfaces_config.hpp
@@ -84,7 +84,7 @@ namespace Catch {
         virtual uint32_t rngSeed() const = 0;
         virtual unsigned int shardCount() const = 0;
         virtual unsigned int shardIndex() const = 0;
-        virtual ColourMode colourMode() const = 0;
+        virtual ColourMode defaultColourMode() const = 0;
         virtual std::vector<std::string> const& getSectionsToRun() const = 0;
         virtual Verbosity verbosity() const = 0;
 
diff --git a/src/catch2/internal/catch_commandline.cpp b/src/catch2/internal/catch_commandline.cpp
index 46b6d9d0..d16e7e37 100644
--- a/src/catch2/internal/catch_commandline.cpp
+++ b/src/catch2/internal/catch_commandline.cpp
@@ -97,8 +97,7 @@ namespace Catch {
                     return ParserResult::runtimeError("Could not parse '" + seed + "' as seed");
                 }
             };
-        auto const setColourMode = [&]( std::string const&
-                                             colourMode ) {
+        auto const setDefaultColourMode = [&]( std::string const& colourMode ) {
             Optional<ColourMode> maybeMode = Catch::Detail::stringToColourMode(toLower( colourMode ));
             if ( !maybeMode ) {
                 return ParserResult::runtimeError(
@@ -112,7 +111,7 @@ namespace Catch {
                     "colour mode '" + colourMode +
                     "' is not supported in this binary" );
             }
-            config.colourMode = mode;
+            config.defaultColourMode = mode;
             return ParserResult::ok( ParseResultType::Matched );
         };
         auto const setWaitForKeypress = [&]( std::string const& keypress ) {
@@ -290,7 +289,7 @@ namespace Catch {
             | Opt( setRngSeed, "'time'|'random-device'|number" )
                 ["--rng-seed"]
                 ( "set a specific seed for random numbers" )
-            | Opt( setColourMode, "ansi|win32|none|default" )
+            | Opt( setDefaultColourMode, "ansi|win32|none|default" )
                 ["--colour-mode"]
                 ( "what color mode should be used as default" )
             | Opt( config.libIdentify )
diff --git a/tests/SelfTest/Baselines/compact.sw.approved.txt b/tests/SelfTest/Baselines/compact.sw.approved.txt
index cabb1733..96fb47ce 100644
--- a/tests/SelfTest/Baselines/compact.sw.approved.txt
+++ b/tests/SelfTest/Baselines/compact.sw.approved.txt
@@ -1381,13 +1381,13 @@ CmdLine.tests.cpp:<line number>: passed: config.abortAfter == 1 for: 1 == 1
 CmdLine.tests.cpp:<line number>: passed: config.shouldDebugBreak for: true
 CmdLine.tests.cpp:<line number>: passed: config.noThrow == true for: true == true
 CmdLine.tests.cpp:<line number>: passed: cli.parse({"test"}) for: {?}
-CmdLine.tests.cpp:<line number>: passed: config.colourMode == ColourMode::PlatformDefault for: 0 == 0
+CmdLine.tests.cpp:<line number>: passed: config.defaultColourMode == ColourMode::PlatformDefault for: 0 == 0
 CmdLine.tests.cpp:<line number>: passed: cli.parse( { "test", "--colour-mode", "default" } ) for: {?}
-CmdLine.tests.cpp:<line number>: passed: config.colourMode == ColourMode::PlatformDefault for: 0 == 0
+CmdLine.tests.cpp:<line number>: passed: config.defaultColourMode == ColourMode::PlatformDefault for: 0 == 0
 CmdLine.tests.cpp:<line number>: passed: cli.parse({"test", "--colour-mode", "ansi"}) for: {?}
-CmdLine.tests.cpp:<line number>: passed: config.colourMode == ColourMode::ANSI for: 1 == 1
+CmdLine.tests.cpp:<line number>: passed: config.defaultColourMode == ColourMode::ANSI for: 1 == 1
 CmdLine.tests.cpp:<line number>: passed: cli.parse({"test", "--colour-mode", "none"}) for: {?}
-CmdLine.tests.cpp:<line number>: passed: config.colourMode == ColourMode::None for: 3 == 3
+CmdLine.tests.cpp:<line number>: passed: config.defaultColourMode == ColourMode::None for: 3 == 3
 CmdLine.tests.cpp:<line number>: passed: !result for: true
 CmdLine.tests.cpp:<line number>: passed: result.errorMessage(), ContainsSubstring( "colour mode must be one of" ) for: "colour mode must be one of: default, ansi, win32, or none. 'wrong' is not recognised" contains: "colour mode must be one of"
 CmdLine.tests.cpp:<line number>: passed: cli.parse({ "test", "--benchmark-samples=200" }) for: {?}
diff --git a/tests/SelfTest/Baselines/compact.sw.multi.approved.txt b/tests/SelfTest/Baselines/compact.sw.multi.approved.txt
index 2b8e2731..c1ac5044 100644
--- a/tests/SelfTest/Baselines/compact.sw.multi.approved.txt
+++ b/tests/SelfTest/Baselines/compact.sw.multi.approved.txt
@@ -1379,13 +1379,13 @@ CmdLine.tests.cpp:<line number>: passed: config.abortAfter == 1 for: 1 == 1
 CmdLine.tests.cpp:<line number>: passed: config.shouldDebugBreak for: true
 CmdLine.tests.cpp:<line number>: passed: config.noThrow == true for: true == true
 CmdLine.tests.cpp:<line number>: passed: cli.parse({"test"}) for: {?}
-CmdLine.tests.cpp:<line number>: passed: config.colourMode == ColourMode::PlatformDefault for: 0 == 0
+CmdLine.tests.cpp:<line number>: passed: config.defaultColourMode == ColourMode::PlatformDefault for: 0 == 0
 CmdLine.tests.cpp:<line number>: passed: cli.parse( { "test", "--colour-mode", "default" } ) for: {?}
-CmdLine.tests.cpp:<line number>: passed: config.colourMode == ColourMode::PlatformDefault for: 0 == 0
+CmdLine.tests.cpp:<line number>: passed: config.defaultColourMode == ColourMode::PlatformDefault for: 0 == 0
 CmdLine.tests.cpp:<line number>: passed: cli.parse({"test", "--colour-mode", "ansi"}) for: {?}
-CmdLine.tests.cpp:<line number>: passed: config.colourMode == ColourMode::ANSI for: 1 == 1
+CmdLine.tests.cpp:<line number>: passed: config.defaultColourMode == ColourMode::ANSI for: 1 == 1
 CmdLine.tests.cpp:<line number>: passed: cli.parse({"test", "--colour-mode", "none"}) for: {?}
-CmdLine.tests.cpp:<line number>: passed: config.colourMode == ColourMode::None for: 3 == 3
+CmdLine.tests.cpp:<line number>: passed: config.defaultColourMode == ColourMode::None for: 3 == 3
 CmdLine.tests.cpp:<line number>: passed: !result for: true
 CmdLine.tests.cpp:<line number>: passed: result.errorMessage(), ContainsSubstring( "colour mode must be one of" ) for: "colour mode must be one of: default, ansi, win32, or none. 'wrong' is not recognised" contains: "colour mode must be one of"
 CmdLine.tests.cpp:<line number>: passed: cli.parse({ "test", "--benchmark-samples=200" }) for: {?}
diff --git a/tests/SelfTest/Baselines/console.sw.approved.txt b/tests/SelfTest/Baselines/console.sw.approved.txt
index 4ae9ebcc..938e96b0 100644
--- a/tests/SelfTest/Baselines/console.sw.approved.txt
+++ b/tests/SelfTest/Baselines/console.sw.approved.txt
@@ -10014,7 +10014,7 @@ with expansion:
   {?}
 
 CmdLine.tests.cpp:<line number>: PASSED:
-  REQUIRE( config.colourMode == ColourMode::PlatformDefault )
+  REQUIRE( config.defaultColourMode == ColourMode::PlatformDefault )
 with expansion:
   0 == 0
 
@@ -10032,7 +10032,7 @@ with expansion:
   {?}
 
 CmdLine.tests.cpp:<line number>: PASSED:
-  REQUIRE( config.colourMode == ColourMode::PlatformDefault )
+  REQUIRE( config.defaultColourMode == ColourMode::PlatformDefault )
 with expansion:
   0 == 0
 
@@ -10050,7 +10050,7 @@ with expansion:
   {?}
 
 CmdLine.tests.cpp:<line number>: PASSED:
-  REQUIRE( config.colourMode == ColourMode::ANSI )
+  REQUIRE( config.defaultColourMode == ColourMode::ANSI )
 with expansion:
   1 == 1
 
@@ -10068,7 +10068,7 @@ with expansion:
   {?}
 
 CmdLine.tests.cpp:<line number>: PASSED:
-  REQUIRE( config.colourMode == ColourMode::None )
+  REQUIRE( config.defaultColourMode == ColourMode::None )
 with expansion:
   3 == 3
 
diff --git a/tests/SelfTest/Baselines/console.sw.multi.approved.txt b/tests/SelfTest/Baselines/console.sw.multi.approved.txt
index 356457f3..dea69f25 100644
--- a/tests/SelfTest/Baselines/console.sw.multi.approved.txt
+++ b/tests/SelfTest/Baselines/console.sw.multi.approved.txt
@@ -10012,7 +10012,7 @@ with expansion:
   {?}
 
 CmdLine.tests.cpp:<line number>: PASSED:
-  REQUIRE( config.colourMode == ColourMode::PlatformDefault )
+  REQUIRE( config.defaultColourMode == ColourMode::PlatformDefault )
 with expansion:
   0 == 0
 
@@ -10030,7 +10030,7 @@ with expansion:
   {?}
 
 CmdLine.tests.cpp:<line number>: PASSED:
-  REQUIRE( config.colourMode == ColourMode::PlatformDefault )
+  REQUIRE( config.defaultColourMode == ColourMode::PlatformDefault )
 with expansion:
   0 == 0
 
@@ -10048,7 +10048,7 @@ with expansion:
   {?}
 
 CmdLine.tests.cpp:<line number>: PASSED:
-  REQUIRE( config.colourMode == ColourMode::ANSI )
+  REQUIRE( config.defaultColourMode == ColourMode::ANSI )
 with expansion:
   1 == 1
 
@@ -10066,7 +10066,7 @@ with expansion:
   {?}
 
 CmdLine.tests.cpp:<line number>: PASSED:
-  REQUIRE( config.colourMode == ColourMode::None )
+  REQUIRE( config.defaultColourMode == ColourMode::None )
 with expansion:
   3 == 3
 
diff --git a/tests/SelfTest/Baselines/tap.sw.approved.txt b/tests/SelfTest/Baselines/tap.sw.approved.txt
index 3bbb1b25..6c38f276 100644
--- a/tests/SelfTest/Baselines/tap.sw.approved.txt
+++ b/tests/SelfTest/Baselines/tap.sw.approved.txt
@@ -2609,19 +2609,19 @@ ok {test-number} - config.noThrow == true for: true == true
 # Process can be configured on command line
 ok {test-number} - cli.parse({"test"}) for: {?}
 # Process can be configured on command line
-ok {test-number} - config.colourMode == ColourMode::PlatformDefault for: 0 == 0
+ok {test-number} - config.defaultColourMode == ColourMode::PlatformDefault for: 0 == 0
 # Process can be configured on command line
 ok {test-number} - cli.parse( { "test", "--colour-mode", "default" } ) for: {?}
 # Process can be configured on command line
-ok {test-number} - config.colourMode == ColourMode::PlatformDefault for: 0 == 0
+ok {test-number} - config.defaultColourMode == ColourMode::PlatformDefault for: 0 == 0
 # Process can be configured on command line
 ok {test-number} - cli.parse({"test", "--colour-mode", "ansi"}) for: {?}
 # Process can be configured on command line
-ok {test-number} - config.colourMode == ColourMode::ANSI for: 1 == 1
+ok {test-number} - config.defaultColourMode == ColourMode::ANSI for: 1 == 1
 # Process can be configured on command line
 ok {test-number} - cli.parse({"test", "--colour-mode", "none"}) for: {?}
 # Process can be configured on command line
-ok {test-number} - config.colourMode == ColourMode::None for: 3 == 3
+ok {test-number} - config.defaultColourMode == ColourMode::None for: 3 == 3
 # Process can be configured on command line
 ok {test-number} - !result for: true
 # Process can be configured on command line
diff --git a/tests/SelfTest/Baselines/tap.sw.multi.approved.txt b/tests/SelfTest/Baselines/tap.sw.multi.approved.txt
index 70327011..35777386 100644
--- a/tests/SelfTest/Baselines/tap.sw.multi.approved.txt
+++ b/tests/SelfTest/Baselines/tap.sw.multi.approved.txt
@@ -2607,19 +2607,19 @@ ok {test-number} - config.noThrow == true for: true == true
 # Process can be configured on command line
 ok {test-number} - cli.parse({"test"}) for: {?}
 # Process can be configured on command line
-ok {test-number} - config.colourMode == ColourMode::PlatformDefault for: 0 == 0
+ok {test-number} - config.defaultColourMode == ColourMode::PlatformDefault for: 0 == 0
 # Process can be configured on command line
 ok {test-number} - cli.parse( { "test", "--colour-mode", "default" } ) for: {?}
 # Process can be configured on command line
-ok {test-number} - config.colourMode == ColourMode::PlatformDefault for: 0 == 0
+ok {test-number} - config.defaultColourMode == ColourMode::PlatformDefault for: 0 == 0
 # Process can be configured on command line
 ok {test-number} - cli.parse({"test", "--colour-mode", "ansi"}) for: {?}
 # Process can be configured on command line
-ok {test-number} - config.colourMode == ColourMode::ANSI for: 1 == 1
+ok {test-number} - config.defaultColourMode == ColourMode::ANSI for: 1 == 1
 # Process can be configured on command line
 ok {test-number} - cli.parse({"test", "--colour-mode", "none"}) for: {?}
 # Process can be configured on command line
-ok {test-number} - config.colourMode == ColourMode::None for: 3 == 3
+ok {test-number} - config.defaultColourMode == ColourMode::None for: 3 == 3
 # Process can be configured on command line
 ok {test-number} - !result for: true
 # Process can be configured on command line
diff --git a/tests/SelfTest/Baselines/xml.sw.approved.txt b/tests/SelfTest/Baselines/xml.sw.approved.txt
index a491eb75..d2710bd3 100644
--- a/tests/SelfTest/Baselines/xml.sw.approved.txt
+++ b/tests/SelfTest/Baselines/xml.sw.approved.txt
@@ -12208,7 +12208,7 @@ C
         </Expression>
         <Expression success="true" type="REQUIRE" filename="tests/<exe-name>/IntrospectiveTests/CmdLine.tests.cpp" >
           <Original>
-            config.colourMode == ColourMode::PlatformDefault
+            config.defaultColourMode == ColourMode::PlatformDefault
           </Original>
           <Expanded>
             0 == 0
@@ -12230,7 +12230,7 @@ C
         </Expression>
         <Expression success="true" type="REQUIRE" filename="tests/<exe-name>/IntrospectiveTests/CmdLine.tests.cpp" >
           <Original>
-            config.colourMode == ColourMode::PlatformDefault
+            config.defaultColourMode == ColourMode::PlatformDefault
           </Original>
           <Expanded>
             0 == 0
@@ -12252,7 +12252,7 @@ C
         </Expression>
         <Expression success="true" type="REQUIRE" filename="tests/<exe-name>/IntrospectiveTests/CmdLine.tests.cpp" >
           <Original>
-            config.colourMode == ColourMode::ANSI
+            config.defaultColourMode == ColourMode::ANSI
           </Original>
           <Expanded>
             1 == 1
@@ -12274,7 +12274,7 @@ C
         </Expression>
         <Expression success="true" type="REQUIRE" filename="tests/<exe-name>/IntrospectiveTests/CmdLine.tests.cpp" >
           <Original>
-            config.colourMode == ColourMode::None
+            config.defaultColourMode == ColourMode::None
           </Original>
           <Expanded>
             3 == 3
diff --git a/tests/SelfTest/Baselines/xml.sw.multi.approved.txt b/tests/SelfTest/Baselines/xml.sw.multi.approved.txt
index 66006e48..085a5cad 100644
--- a/tests/SelfTest/Baselines/xml.sw.multi.approved.txt
+++ b/tests/SelfTest/Baselines/xml.sw.multi.approved.txt
@@ -12208,7 +12208,7 @@ C
         </Expression>
         <Expression success="true" type="REQUIRE" filename="tests/<exe-name>/IntrospectiveTests/CmdLine.tests.cpp" >
           <Original>
-            config.colourMode == ColourMode::PlatformDefault
+            config.defaultColourMode == ColourMode::PlatformDefault
           </Original>
           <Expanded>
             0 == 0
@@ -12230,7 +12230,7 @@ C
         </Expression>
         <Expression success="true" type="REQUIRE" filename="tests/<exe-name>/IntrospectiveTests/CmdLine.tests.cpp" >
           <Original>
-            config.colourMode == ColourMode::PlatformDefault
+            config.defaultColourMode == ColourMode::PlatformDefault
           </Original>
           <Expanded>
             0 == 0
@@ -12252,7 +12252,7 @@ C
         </Expression>
         <Expression success="true" type="REQUIRE" filename="tests/<exe-name>/IntrospectiveTests/CmdLine.tests.cpp" >
           <Original>
-            config.colourMode == ColourMode::ANSI
+            config.defaultColourMode == ColourMode::ANSI
           </Original>
           <Expanded>
             1 == 1
@@ -12274,7 +12274,7 @@ C
         </Expression>
         <Expression success="true" type="REQUIRE" filename="tests/<exe-name>/IntrospectiveTests/CmdLine.tests.cpp" >
           <Original>
-            config.colourMode == ColourMode::None
+            config.defaultColourMode == ColourMode::None
           </Original>
           <Expanded>
             3 == 3
diff --git a/tests/SelfTest/IntrospectiveTests/CmdLine.tests.cpp b/tests/SelfTest/IntrospectiveTests/CmdLine.tests.cpp
index 7599adbe..30cc3a0d 100644
--- a/tests/SelfTest/IntrospectiveTests/CmdLine.tests.cpp
+++ b/tests/SelfTest/IntrospectiveTests/CmdLine.tests.cpp
@@ -566,25 +566,25 @@ TEST_CASE( "Process can be configured on command line", "[config][command-line]"
         SECTION( "without option" ) {
             CHECK(cli.parse({"test"}));
 
-            REQUIRE( config.colourMode == ColourMode::PlatformDefault );
+            REQUIRE( config.defaultColourMode == ColourMode::PlatformDefault );
         }
 
         SECTION( "auto" ) {
             CHECK( cli.parse( { "test", "--colour-mode", "default" } ) );
 
-            REQUIRE( config.colourMode == ColourMode::PlatformDefault );
+            REQUIRE( config.defaultColourMode == ColourMode::PlatformDefault );
         }
 
         SECTION( "yes" ) {
             CHECK(cli.parse({"test", "--colour-mode", "ansi"}));
 
-            REQUIRE( config.colourMode == ColourMode::ANSI );
+            REQUIRE( config.defaultColourMode == ColourMode::ANSI );
         }
 
         SECTION( "no" ) {
             CHECK(cli.parse({"test", "--colour-mode", "none"}));
 
-            REQUIRE( config.colourMode == ColourMode::None );
+            REQUIRE( config.defaultColourMode == ColourMode::None );
         }
 
         SECTION( "error" ) {