Add Unscoped Capture Logger #3010

Riyuzak2510 · 2025-07-30T05:47:40Z

Adding Unscoped Capture Logger as a part of #2954

Description

Added Unscoped Capture Logger Feature as required to print details related to Capture

Added New Macro UNSCOPED_CAPTURE

GitHub Issues

Closes #2954

codecov · 2025-07-30T06:51:46Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.95%. Comparing base (3e82ef9) to head (5abeb26).

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #3010      +/-   ##
==========================================
+ Coverage   90.92%   90.95%   +0.03%     
==========================================
  Files         201      201              
  Lines        8653     8659       +6     
==========================================
+ Hits         7867     7875       +8     
+ Misses        786      784       -2

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

src/catch2/catch_message.cpp

horenmar · 2025-08-10T20:58:53Z

src/catch2/catch_message.hpp

+         std::vector<MessageInfo> getMessageDetails() const {
+            return m_messages;
+        }


This is not used anymore. For next time, this shouldn't be returning the vector by value, but by reference, and be ref-qualified if needed.

horenmar · 2025-08-10T21:01:15Z

src/catch2/catch_message.hpp

+        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... );
+        }
+


Let's not duplicate these, and instead add bool isScoped parameter to the constructor of Capturer, which will be kept to decide whether captureValue should create scoped or unscoped msg.

yeah modified this

horenmar · 2025-08-10T21:04:52Z

src/catch2/catch_message.cpp

+        getResultCapture().emplaceUnscopedMessage(Catch::MessageBuilder(
+            m_messages[index].macroName,
+            m_messages[index].lineInfo,
+            m_messages[index].type) << m_messages[index].message);


No need to copy the value into message first and then write it into the msg builder stream.

horenmar · 2025-08-10T21:06:55Z

src/catch2/catch_message.hpp

  #define UNSCOPED_INFO( msg ) (void)(0)
  #define WARN( msg )          (void)(0)
  #define CAPTURE( ... )       (void)(0)
+  #define UNSCOPED_CAPTURE( ... ) (void)(0)


Please re-align the empty definitions for the whole block. (And same for the one around line 150)

tests/SelfTest/UsageTests/Message.tests.cpp

Riyuzak2510 · 2025-08-13T08:57:26Z

@horenmar feel free to take a look

…or Capturer

horenmar · 2025-08-19T11:16:43Z

src/catch2/catch_message.hpp

        std::vector<MessageInfo> m_messages;
        IResultCapture& m_resultCapture;
        size_t m_captured = 0;
+        bool isScoped;


Take a second look at how the other class variables are named.

horenmar · 2025-08-19T11:18:20Z

src/catch2/catch_message.cpp

-        m_resultCapture.pushScopedMessage( m_messages[index] );
-        m_captured++;
+        if(isScoped){
+            assert( index < m_messages.size() );


The assert should live at the start of the function, both branches access m_messages[index].

horenmar · 2025-08-19T11:24:57Z

src/catch2/catch_message.cpp

+            if(index == m_messages.size() - 1){
+                m_messages.clear();
+            }


No need to clear this here, instead check in destructor whether m_isScoped is true and change it accordingly.

Riyuzak2510 force-pushed the UNSCOPED_CAPTURE_LOGGER branch from b6d1042 to d34e490 Compare July 30, 2025 06:10

Riyuzak2510 force-pushed the UNSCOPED_CAPTURE_LOGGER branch 6 times, most recently from 4e18ef2 to 98c9b6f Compare August 6, 2025 16:18

Riyuzak2510 commented Aug 6, 2025

View reviewed changes

src/catch2/catch_message.cpp Outdated Show resolved Hide resolved

Riyuzak2510 force-pushed the UNSCOPED_CAPTURE_LOGGER branch from c3d0075 to abfdfcf Compare August 6, 2025 17:53

horenmar reviewed Aug 10, 2025

View reviewed changes

tests/SelfTest/UsageTests/Message.tests.cpp Outdated Show resolved Hide resolved

Riyuzak2510 force-pushed the UNSCOPED_CAPTURE_LOGGER branch from 466e345 to d1ede1a Compare August 13, 2025 08:17

Riyuzak2510 added 2 commits August 13, 2025 14:06

Add Unscoped Capture Logger and Add Unit Tests

33e047a

Editing Baseline Files to Accomodate tests for UNSCOPED CAPTURE

e91c431

Riyuzak2510 force-pushed the UNSCOPED_CAPTURE_LOGGER branch from d1ede1a to 7c551dd Compare August 13, 2025 08:55

Riyuzak2510 force-pushed the UNSCOPED_CAPTURE_LOGGER branch from 7c551dd to 9f4c665 Compare August 13, 2025 09:01

Riyuzak2510 requested a review from horenmar August 13, 2025 09:04

Refactoring Code to Adjust Scoped Logic into the common constructor f…

5abeb26

…or Capturer

Riyuzak2510 force-pushed the UNSCOPED_CAPTURE_LOGGER branch from 9f4c665 to 5abeb26 Compare August 13, 2025 16:39

horenmar reviewed Aug 19, 2025

View reviewed changes

Uh oh!

Add Unscoped Capture Logger #3010

Are you sure you want to change the base?

Add Unscoped Capture Logger #3010

Uh oh!

Conversation

Riyuzak2510 commented Jul 30, 2025

Description

GitHub Issues

Uh oh!

codecov bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Riyuzak2510 commented Aug 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Jul 30, 2025 •

edited

Loading