Add Unscoped Capture Logger and Add Unit Tests

Author: Riyuzak2510

src/catch2/catch_message.cpp

@@ -112,4 +112,15 @@ namespace Catch {
         m_captured++;
     }
 
+     void Capturer::captureUnscopedValue( size_t index, std::string const& value ) {
+        m_messages[index].message += value;
+        getResultCapture().emplaceUnscopedMessage(Catch::MessageBuilder(
+            m_messages[index].macroName,
+            m_messages[index].lineInfo,
+            m_messages[index].type) << m_messages[index].message);
+        if(index == m_messages.size() - 1){
+            m_messages.clear();
+        }
+    }
+
 } // end namespace Catch

src/catch2/catch_message.hpp

@@ -73,6 +73,19 @@ namespace Catch {
 
         ~Capturer();
 
+        void captureUnscopedValue( size_t index, std::string const& value );
+
+        template<typename T>
+        void captureUnscopedValues( size_t index, T const& value ) {
+            captureUnscopedValue( index, Catch::Detail::stringify( value ) );
+        }
+
+        template<typename T, typename... Ts>
+        void captureUnscopedValues( size_t index, T const& value, Ts const&... values ) {
+            captureUnscopedValue( index, Catch::Detail::stringify(value) );
+            captureUnscopedValues( index+1, values... );
+        }
+
         void captureValue( size_t index, std::string const& value );
 
         template<typename T>
@@ -85,6 +98,10 @@ namespace Catch {
             captureValue( index, Catch::Detail::stringify(value) );
             captureValues( index+1, values... );
         }
+
+         std::vector<MessageInfo> getMessageDetails() const {
+            return m_messages;
+        }
     };
 
 } // end namespace Catch
@@ -105,6 +122,14 @@ namespace Catch {
                              #__VA_ARGS__##_catch_sr );   \
     varName.captureValues( 0, __VA_ARGS__ )
 
+///////////////////////////////////////////////////////////////////////////////
+#define INTERNAL_CATCH_UNSCOPED_CAPTURE( varName, macroName, ... ) \
+    Catch::Capturer varName( macroName##_catch_sr,                 \
+                             CATCH_INTERNAL_LINEINFO,              \
+                             Catch::ResultWas::Info,               \
+                             #__VA_ARGS__##_catch_sr );            \
+    varName.captureUnscopedValues( 0, __VA_ARGS__ );
+
 ///////////////////////////////////////////////////////////////////////////////
 #define INTERNAL_CATCH_INFO( macroName, log ) \
     const Catch::ScopedMessage INTERNAL_CATCH_UNIQUE_NAME( scopedMessage )( Catch::MessageBuilder( macroName##_catch_sr, CATCH_INTERNAL_LINEINFO, Catch::ResultWas::Info ) << log )
@@ -120,27 +145,33 @@ namespace Catch {
   #define CATCH_UNSCOPED_INFO( msg ) INTERNAL_CATCH_UNSCOPED_INFO( "CATCH_UNSCOPED_INFO", msg )
   #define CATCH_WARN( msg ) INTERNAL_CATCH_MSG( "CATCH_WARN", Catch::ResultWas::Warning, Catch::ResultDisposition::ContinueOnFailure, msg )
   #define CATCH_CAPTURE( ... ) INTERNAL_CATCH_CAPTURE( INTERNAL_CATCH_UNIQUE_NAME(capturer), "CATCH_CAPTURE", __VA_ARGS__ )
+  #define CATCH_UNSCOPED_CAPTURE( ... ) INTERNAL_CATCH_UNSCOPED_CAPTURE( INTERNAL_CATCH_UNIQUE_NAME(capturer), "CATCH_UNSCOPED_CAPTURE", __VA_ARGS__ )
 
 #elif defined(CATCH_CONFIG_PREFIX_MESSAGES) && defined(CATCH_CONFIG_DISABLE)
 
   #define CATCH_INFO( msg )          (void)(0)
   #define CATCH_UNSCOPED_INFO( msg ) (void)(0)
   #define CATCH_WARN( msg )          (void)(0)
   #define CATCH_CAPTURE( ... )       (void)(0)
+  #define CATCH_UNSCOPED_CAPTURE( ... ) (void)(0)
+
 
 #elif !defined(CATCH_CONFIG_PREFIX_MESSAGES) && !defined(CATCH_CONFIG_DISABLE)
 
   #define INFO( msg ) INTERNAL_CATCH_INFO( "INFO", msg )
   #define UNSCOPED_INFO( msg ) INTERNAL_CATCH_UNSCOPED_INFO( "UNSCOPED_INFO", msg )
   #define WARN( msg ) INTERNAL_CATCH_MSG( "WARN", Catch::ResultWas::Warning, Catch::ResultDisposition::ContinueOnFailure, msg )
   #define CAPTURE( ... ) INTERNAL_CATCH_CAPTURE( INTERNAL_CATCH_UNIQUE_NAME(capturer), "CAPTURE", __VA_ARGS__ )
+  #define UNSCOPED_CAPTURE( ... ) INTERNAL_CATCH_UNSCOPED_CAPTURE( INTERNAL_CATCH_UNIQUE_NAME(capturer), "UNSCOPED_CAPTURE", __VA_ARGS__ )
+
 
 #elif !defined(CATCH_CONFIG_PREFIX_MESSAGES) && defined(CATCH_CONFIG_DISABLE)
 
   #define INFO( msg )          (void)(0)
   #define UNSCOPED_INFO( msg ) (void)(0)
   #define WARN( msg )          (void)(0)
   #define CAPTURE( ... )       (void)(0)
+  #define UNSCOPED_CAPTURE( ... ) (void)(0)
 
 #endif // end of user facing macro declarations
 

tests/SelfTest/Baselines/automake.sw.approved.txt

@@ -295,6 +295,8 @@ Message from section two
 :test-result: PASS Tracker
 :test-result: PASS Trim strings
 :test-result: PASS Type conversions of RangeEquals and similar
+:test-result: PASS UNSCOPED CAPTURE can deal with complex expressions
+:test-result: PASS UNSCOPED_CAPTURE parses string and character constants
 :test-result: FAIL Unexpected exceptions can be translated
 :test-result: PASS Upcasting special member functions
 :test-result: PASS Usage of AllMatch range matcher
@@ -394,6 +396,7 @@ b1!
 :test-result: PASS shortened hide tags are split apart
 :test-result: SKIP skipped tests can optionally provide a reason
 :test-result: PASS splitString
+:test-result: FAIL stacks unscoped capture in loops
 :test-result: FAIL stacks unscoped info in loops
 :test-result: PASS startsWith
 :test-result: PASS std::map is convertible string

tests/SelfTest/Baselines/automake.sw.multi.approved.txt

@@ -288,6 +288,8 @@
 :test-result: PASS Tracker
 :test-result: PASS Trim strings
 :test-result: PASS Type conversions of RangeEquals and similar
+:test-result: PASS UNSCOPED CAPTURE can deal with complex expressions
+:test-result: PASS UNSCOPED_CAPTURE parses string and character constants
 :test-result: FAIL Unexpected exceptions can be translated
 :test-result: PASS Upcasting special member functions
 :test-result: PASS Usage of AllMatch range matcher
@@ -383,6 +385,7 @@
 :test-result: PASS shortened hide tags are split apart
 :test-result: SKIP skipped tests can optionally provide a reason
 :test-result: PASS splitString
+:test-result: FAIL stacks unscoped capture in loops
 :test-result: FAIL stacks unscoped info in loops
 :test-result: PASS startsWith
 :test-result: PASS std::map is convertible string

tests/SelfTest/Baselines/compact.sw.approved.txt

@@ -2184,6 +2184,8 @@ MatchersRanges.tests.cpp:<line number>: passed: a, !RangeEquals( b ) for: { 1, 2
 MatchersRanges.tests.cpp:<line number>: passed: a, UnorderedRangeEquals( b ) for: { 1, 2, 3 } unordered elements are { 3, 2, 1 }
 MatchersRanges.tests.cpp:<line number>: passed: vector_a, RangeEquals( array_a_plus_1, close_enough ) for: { 1, 2, 3 } elements are { 2, 3, 4 }
 MatchersRanges.tests.cpp:<line number>: passed: vector_a, UnorderedRangeEquals( array_a_plus_1, close_enough ) for: { 1, 2, 3 } unordered elements are { 2, 3, 4 }
+Message.tests.cpp:<line number>: passed: with 14 messages: 'a := 1' and 'b := 2' and 'c := 3' and 'a + b := 3' and 'a+b := 3' and 'c > b := true' and 'a == 1 := true' and '' and '' and '' and '' and '' and '' and ''
+Message.tests.cpp:<line number>: passed: with 22 messages: '("comma, in string", "escaped, \", ") := "escaped, ", "' and '"single quote in string,'," := "single quote in string,',"' and '"some escapes, \\,\\\\" := "some escapes, \,\\"' and '' and '' and '' and '"some, ), unmatched, } prenheses {[<" := "some, ), unmatched, } prenheses {[<"' and '' and ''"' := '"'' and ''\'' := '''' and '',' := ','' and ''}' := '}'' and '')' := ')'' and ''(' := '('' and ''{' := '{'' and '' and '' and '' and '' and '' and '' and ''
 Exception.tests.cpp:<line number>: failed: unexpected exception with message: '3.14000000000000012'
 UniquePtr.tests.cpp:<line number>: passed: bptr->i == 3 for: 3 == 3
 UniquePtr.tests.cpp:<line number>: passed: bptr->i == 3 for: 3 == 3
@@ -2710,6 +2712,8 @@ Skip.tests.cpp:<line number>: skipped: 'skipping because answer = 43'
 StringManip.tests.cpp:<line number>: passed: splitStringRef("", ','), Equals(std::vector<StringRef>()) for: {  } Equals: {  }
 StringManip.tests.cpp:<line number>: passed: splitStringRef("abc", ','), Equals(std::vector<StringRef>{"abc"}) for: { abc } Equals: { abc }
 StringManip.tests.cpp:<line number>: passed: splitStringRef("abc,def", ','), Equals(std::vector<StringRef>{"abc", "def"}) for: { abc, def } Equals: { abc, def }
+Message.tests.cpp:<line number>: failed: false with 5 messages: '"Count 1 to 3..." := "Count 1 to 3..."' and '' and '' and '' and ''
+Message.tests.cpp:<line number>: failed: false with 6 messages: '' and '"Count 4 to 6..." := "Count 4 to 6..."' and '' and '' and '' and ''
 Message.tests.cpp:<line number>: failed: false with 4 messages: 'Count 1 to 3...' and '1' and '2' and '3'
 Message.tests.cpp:<line number>: failed: false with 4 messages: 'Count 4 to 6...' and '4' and '5' and '6'
 StringManip.tests.cpp:<line number>: passed: !(startsWith("", 'c')) for: !false
@@ -2871,7 +2875,12 @@ InternalBenchmark.tests.cpp:<line number>: passed: med == 18. for: 18.0 == 18.0
 InternalBenchmark.tests.cpp:<line number>: passed: q3 == 23. for: 23.0 == 23.0
 Misc.tests.cpp:<line number>: passed:
 Misc.tests.cpp:<line number>: passed:
+<<<<<<< HEAD
 test cases:  432 |  314 passed |  95 failed | 6 skipped | 17 failed as expected
 assertions: 2290 | 2092 passed | 157 failed | 41 failed as expected
+=======
+test cases:  434 |  315 passed |  96 failed | 6 skipped | 17 failed as expected
+assertions: 2292 | 2092 passed | 159 failed | 41 failed as expected
+>>>>>>> b280084d (Changing Baseline Files for New Tests)
 
 

tests/SelfTest/Baselines/compact.sw.multi.approved.txt

@@ -2177,6 +2177,8 @@ MatchersRanges.tests.cpp:<line number>: passed: a, !RangeEquals( b ) for: { 1, 2
 MatchersRanges.tests.cpp:<line number>: passed: a, UnorderedRangeEquals( b ) for: { 1, 2, 3 } unordered elements are { 3, 2, 1 }
 MatchersRanges.tests.cpp:<line number>: passed: vector_a, RangeEquals( array_a_plus_1, close_enough ) for: { 1, 2, 3 } elements are { 2, 3, 4 }
 MatchersRanges.tests.cpp:<line number>: passed: vector_a, UnorderedRangeEquals( array_a_plus_1, close_enough ) for: { 1, 2, 3 } unordered elements are { 2, 3, 4 }
+Message.tests.cpp:<line number>: passed: with 14 messages: 'a := 1' and 'b := 2' and 'c := 3' and 'a + b := 3' and 'a+b := 3' and 'c > b := true' and 'a == 1 := true' and '' and '' and '' and '' and '' and '' and ''
+Message.tests.cpp:<line number>: passed: with 22 messages: '("comma, in string", "escaped, \", ") := "escaped, ", "' and '"single quote in string,'," := "single quote in string,',"' and '"some escapes, \\,\\\\" := "some escapes, \,\\"' and '' and '' and '' and '"some, ), unmatched, } prenheses {[<" := "some, ), unmatched, } prenheses {[<"' and '' and ''"' := '"'' and ''\'' := '''' and '',' := ','' and ''}' := '}'' and '')' := ')'' and ''(' := '('' and ''{' := '{'' and '' and '' and '' and '' and '' and '' and ''
 Exception.tests.cpp:<line number>: failed: unexpected exception with message: '3.14000000000000012'
 UniquePtr.tests.cpp:<line number>: passed: bptr->i == 3 for: 3 == 3
 UniquePtr.tests.cpp:<line number>: passed: bptr->i == 3 for: 3 == 3
@@ -2699,6 +2701,8 @@ Skip.tests.cpp:<line number>: skipped: 'skipping because answer = 43'
 StringManip.tests.cpp:<line number>: passed: splitStringRef("", ','), Equals(std::vector<StringRef>()) for: {  } Equals: {  }
 StringManip.tests.cpp:<line number>: passed: splitStringRef("abc", ','), Equals(std::vector<StringRef>{"abc"}) for: { abc } Equals: { abc }
 StringManip.tests.cpp:<line number>: passed: splitStringRef("abc,def", ','), Equals(std::vector<StringRef>{"abc", "def"}) for: { abc, def } Equals: { abc, def }
+Message.tests.cpp:<line number>: failed: false with 5 messages: '"Count 1 to 3..." := "Count 1 to 3..."' and '' and '' and '' and ''
+Message.tests.cpp:<line number>: failed: false with 6 messages: '' and '"Count 4 to 6..." := "Count 4 to 6..."' and '' and '' and '' and ''
 Message.tests.cpp:<line number>: failed: false with 4 messages: 'Count 1 to 3...' and '1' and '2' and '3'
 Message.tests.cpp:<line number>: failed: false with 4 messages: 'Count 4 to 6...' and '4' and '5' and '6'
 StringManip.tests.cpp:<line number>: passed: !(startsWith("", 'c')) for: !false
@@ -2860,7 +2864,12 @@ InternalBenchmark.tests.cpp:<line number>: passed: med == 18. for: 18.0 == 18.0
 InternalBenchmark.tests.cpp:<line number>: passed: q3 == 23. for: 23.0 == 23.0
 Misc.tests.cpp:<line number>: passed:
 Misc.tests.cpp:<line number>: passed:
+<<<<<<< HEAD
 test cases:  432 |  314 passed |  95 failed | 6 skipped | 17 failed as expected
 assertions: 2290 | 2092 passed | 157 failed | 41 failed as expected
+=======
+test cases:  434 |  315 passed |  96 failed | 6 skipped | 17 failed as expected
+assertions: 2292 | 2092 passed | 159 failed | 41 failed as expected
+>>>>>>> b280084d (Changing Baseline Files for New Tests)
 
 

tests/SelfTest/Baselines/console.std.approved.txt

@@ -1678,6 +1678,31 @@ Skip.tests.cpp:<line number>: SKIPPED:
 explicitly with message:
   skipping because answer = 43
 
+-------------------------------------------------------------------------------
+stacks unscoped capture in loops
+-------------------------------------------------------------------------------
+Message.tests.cpp:<line number>
+...............................................................................
+
+Message.tests.cpp:<line number>: FAILED:
+  CHECK( false )
+with messages:
+  "Count 1 to 3..." := "Count 1 to 3..."
+
+
+
+
+
+Message.tests.cpp:<line number>: FAILED:
+  CHECK( false )
+with messages:
+
+  "Count 4 to 6..." := "Count 4 to 6..."
+
+
+
+
+
 -------------------------------------------------------------------------------
 stacks unscoped info in loops
 -------------------------------------------------------------------------------
@@ -1719,6 +1744,11 @@ due to unexpected exception with message:
   Why would you throw a std::string?
 
 ===============================================================================
+<<<<<<< HEAD
 test cases:  432 |  332 passed |  76 failed | 7 skipped | 17 failed as expected
 assertions: 2269 | 2092 passed | 136 failed | 41 failed as expected
+=======
+test cases:  434 |  333 passed |  77 failed | 7 skipped | 17 failed as expected
+assertions: 2271 | 2092 passed | 138 failed | 41 failed as expected
+>>>>>>> b280084d (Changing Baseline Files for New Tests)
 

tests/SelfTest/Baselines/console.sw.approved.txt

@@ -14178,6 +14178,61 @@ MatchersRanges.tests.cpp:<line number>: PASSED:
 with expansion:
   { 1, 2, 3 } unordered elements are { 2, 3, 4 }
 
+-------------------------------------------------------------------------------
+UNSCOPED CAPTURE can deal with complex expressions
+-------------------------------------------------------------------------------
+Message.tests.cpp:<line number>
+...............................................................................
+
+Message.tests.cpp:<line number>: PASSED:
+with messages:
+  a := 1
+  b := 2
+  c := 3
+  a + b := 3
+  a+b := 3
+  c > b := true
+  a == 1 := true
+
+
+
+
+
+
+
+
+-------------------------------------------------------------------------------
+UNSCOPED_CAPTURE parses string and character constants
+-------------------------------------------------------------------------------
+Message.tests.cpp:<line number>
+...............................................................................
+
+Message.tests.cpp:<line number>: PASSED:
+with messages:
+  ("comma, in string", "escaped, \", ") := "escaped, ", "
+  "single quote in string,'," := "single quote in string,',"
+  "some escapes, \\,\\\\" := "some escapes, \,\\"
+
+
+
+  "some, ), unmatched, } prenheses {[<" := "some, ), unmatched, } prenheses {[
+  <"
+
+  '"' := '"'
+  '\'' := '''
+  ',' := ','
+  '}' := '}'
+  ')' := ')'
+  '(' := '('
+  '{' := '{'
+
+
+
+
+
+
+
+
 -------------------------------------------------------------------------------
 Unexpected exceptions can be translated
 -------------------------------------------------------------------------------
@@ -18063,6 +18118,31 @@ StringManip.tests.cpp:<line number>: PASSED:
 with expansion:
   { abc, def } Equals: { abc, def }
 
+-------------------------------------------------------------------------------
+stacks unscoped capture in loops
+-------------------------------------------------------------------------------
+Message.tests.cpp:<line number>
+...............................................................................
+
+Message.tests.cpp:<line number>: FAILED:
+  CHECK( false )
+with messages:
+  "Count 1 to 3..." := "Count 1 to 3..."
+
+
+
+
+
+Message.tests.cpp:<line number>: FAILED:
+  CHECK( false )
+with messages:
+
+  "Count 4 to 6..." := "Count 4 to 6..."
+
+
+
+
+
 -------------------------------------------------------------------------------
 stacks unscoped info in loops
 -------------------------------------------------------------------------------
@@ -19200,6 +19280,11 @@ Misc.tests.cpp:<line number>
 Misc.tests.cpp:<line number>: PASSED:
 
 ===============================================================================
+<<<<<<< HEAD
 test cases:  432 |  314 passed |  95 failed | 6 skipped | 17 failed as expected
 assertions: 2290 | 2092 passed | 157 failed | 41 failed as expected
+=======
+test cases:  434 |  315 passed |  96 failed | 6 skipped | 17 failed as expected
+assertions: 2292 | 2092 passed | 159 failed | 41 failed as expected
+>>>>>>> b280084d (Changing Baseline Files for New Tests)