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

trim test/ section names in xml reporter

- BDD-style test names have leading spaces for alignment in the console reporter
Commit
a1e87a4b7df92061af9fc4c7f1c39fe98c68890d
Author
Phil Nash ·
Parents
ef950202393f

Files · Download .tar.gz

Changes

 include/internal/catch_common.h                 | 10 ----
 include/reporters/catch_reporter_xml.hpp        |  4 +-
 projects/SelfTest/Baselines/xml.sw.approved.txt | 68 ++++++++++++-------------
 3 files changed, 36 insertions(+), 46 deletions(-)

diff --git a/include/internal/catch_common.h b/include/internal/catch_common.h
index 957ce257..5b091b0a 100644
--- a/include/internal/catch_common.h
+++ b/include/internal/catch_common.h
@@ -57,16 +57,6 @@ namespace Catch {
             delete it->second;
     }
 
-    template<typename ContainerT, typename Function>
-    inline void forEach( ContainerT& container, Function function ) {
-        std::for_each( container.begin(), container.end(), function );
-    }
-
-    template<typename ContainerT, typename Function>
-    inline void forEach( ContainerT const& container, Function function ) {
-        std::for_each( container.begin(), container.end(), function );
-    }
-
     bool startsWith( std::string const& s, std::string const& prefix );
     bool endsWith( std::string const& s, std::string const& suffix );
     bool contains( std::string const& s, std::string const& infix );
diff --git a/include/reporters/catch_reporter_xml.hpp b/include/reporters/catch_reporter_xml.hpp
index 11ecd910..15aa828f 100644
--- a/include/reporters/catch_reporter_xml.hpp
+++ b/include/reporters/catch_reporter_xml.hpp
@@ -59,7 +59,7 @@ namespace Catch {
         virtual void StartSection( const std::string& sectionName, const std::string& description ) {
             if( m_sectionDepth++ > 0 ) {
                 m_xml.startElement( "Section" )
-                    .writeAttribute( "name", sectionName )
+                    .writeAttribute( "name", trim( sectionName ) )
                     .writeAttribute( "description", description );
             }
         }
@@ -76,7 +76,7 @@ namespace Catch {
         }
 
         virtual void StartTestCase( const Catch::TestCaseInfo& testInfo ) {
-            m_xml.startElement( "TestCase" ).writeAttribute( "name", testInfo.name );
+            m_xml.startElement( "TestCase" ).writeAttribute( "name", trim( testInfo.name ) );
             m_currentTestSuccess = true;
         }
 
diff --git a/projects/SelfTest/Baselines/xml.sw.approved.txt b/projects/SelfTest/Baselines/xml.sw.approved.txt
index ded8c1f2..8b90d872 100644
--- a/projects/SelfTest/Baselines/xml.sw.approved.txt
+++ b/projects/SelfTest/Baselines/xml.sw.approved.txt
@@ -6671,18 +6671,18 @@ there&quot;
       <OverallResult success="true"/>
     </TestCase>
     <TestCase name="Scenario: Do that thing with the thing">
-      <Section name="   Given: This stuff exists">
+      <Section name="Given: This stuff exists">
         <OverallResults successes="0" failures="0"/>
       </Section>
-      <Section name="   Given: This stuff exists">
-        <Section name="    When: I do this">
+      <Section name="Given: This stuff exists">
+        <Section name="When: I do this">
           <OverallResults successes="0" failures="0"/>
         </Section>
         <OverallResults successes="0" failures="0"/>
       </Section>
-      <Section name="   Given: This stuff exists">
-        <Section name="    When: I do this">
-          <Section name="    Then: it should do this">
+      <Section name="Given: This stuff exists">
+        <Section name="When: I do this">
+          <Section name="Then: it should do this">
             <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
               <Original>
                 itDoesThis()
@@ -6697,9 +6697,9 @@ there&quot;
         </Section>
         <OverallResults successes="1" failures="0"/>
       </Section>
-      <Section name="   Given: This stuff exists">
-        <Section name="    When: I do this">
-          <Section name="    Then: it should do this">
+      <Section name="Given: This stuff exists">
+        <Section name="When: I do this">
+          <Section name="Then: it should do this">
             <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
               <Original>
                 itDoesThis()
@@ -6708,7 +6708,7 @@ there&quot;
                 true
               </Expanded>
             </Expression>
-            <Section name="     And: do that">
+            <Section name="And: do that">
               <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
                 <Original>
                   itDoesThat()
@@ -6728,7 +6728,7 @@ there&quot;
       <OverallResult success="true"/>
     </TestCase>
     <TestCase name="Scenario: Vector resizing affects size and capacity">
-      <Section name="   Given: an empty vector">
+      <Section name="Given: an empty vector">
         <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
           <Original>
             v.size() == 0
@@ -6739,7 +6739,7 @@ there&quot;
         </Expression>
         <OverallResults successes="1" failures="0"/>
       </Section>
-      <Section name="   Given: an empty vector">
+      <Section name="Given: an empty vector">
         <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
           <Original>
             v.size() == 0
@@ -6748,12 +6748,12 @@ there&quot;
             0 == 0
           </Expanded>
         </Expression>
-        <Section name="    When: it is made larger">
+        <Section name="When: it is made larger">
           <OverallResults successes="0" failures="0"/>
         </Section>
         <OverallResults successes="1" failures="0"/>
       </Section>
-      <Section name="   Given: an empty vector">
+      <Section name="Given: an empty vector">
         <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
           <Original>
             v.size() == 0
@@ -6762,8 +6762,8 @@ there&quot;
             0 == 0
           </Expanded>
         </Expression>
-        <Section name="    When: it is made larger">
-          <Section name="    Then: the size and capacity go up">
+        <Section name="When: it is made larger">
+          <Section name="Then: the size and capacity go up">
             <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
               <Original>
                 v.size() == 10
@@ -6786,7 +6786,7 @@ there&quot;
         </Section>
         <OverallResults successes="3" failures="0"/>
       </Section>
-      <Section name="   Given: an empty vector">
+      <Section name="Given: an empty vector">
         <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
           <Original>
             v.size() == 0
@@ -6795,8 +6795,8 @@ there&quot;
             0 == 0
           </Expanded>
         </Expression>
-        <Section name="    When: it is made larger">
-          <Section name="    Then: the size and capacity go up">
+        <Section name="When: it is made larger">
+          <Section name="Then: the size and capacity go up">
             <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
               <Original>
                 v.size() == 10
@@ -6822,7 +6822,7 @@ there&quot;
         </Section>
         <OverallResults successes="3" failures="0"/>
       </Section>
-      <Section name="   Given: an empty vector">
+      <Section name="Given: an empty vector">
         <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
           <Original>
             v.size() == 0
@@ -6831,8 +6831,8 @@ there&quot;
             0 == 0
           </Expanded>
         </Expression>
-        <Section name="    When: it is made larger">
-          <Section name="    Then: the size and capacity go up">
+        <Section name="When: it is made larger">
+          <Section name="Then: the size and capacity go up">
             <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
               <Original>
                 v.size() == 10
@@ -6850,7 +6850,7 @@ there&quot;
               </Expanded>
             </Expression>
             <Section name="And when: it is made smaller again">
-              <Section name="    Then: the size goes down but the capacity stays the same">
+              <Section name="Then: the size goes down but the capacity stays the same">
                 <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
                   <Original>
                     v.size() == 5
@@ -6877,7 +6877,7 @@ there&quot;
         </Section>
         <OverallResults successes="5" failures="0"/>
       </Section>
-      <Section name="   Given: an empty vector">
+      <Section name="Given: an empty vector">
         <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
           <Original>
             v.size() == 0
@@ -6886,12 +6886,12 @@ there&quot;
             0 == 0
           </Expanded>
         </Expression>
-        <Section name="    When: we reserve more space">
+        <Section name="When: we reserve more space">
           <OverallResults successes="0" failures="0"/>
         </Section>
         <OverallResults successes="1" failures="0"/>
       </Section>
-      <Section name="   Given: an empty vector">
+      <Section name="Given: an empty vector">
         <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
           <Original>
             v.size() == 0
@@ -6900,8 +6900,8 @@ there&quot;
             0 == 0
           </Expanded>
         </Expression>
-        <Section name="    When: we reserve more space">
-          <Section name="    Then: The capacity is increased but the size remains the same">
+        <Section name="When: we reserve more space">
+          <Section name="Then: The capacity is increased but the size remains the same">
             <Expression success="true" filename="/Users/philnash/Dev/OSS/Catch/projects/SelfTest/BDDTests.cpp" >
               <Original>
                 v.capacity() >= 10
@@ -6927,18 +6927,18 @@ there&quot;
       <OverallResult success="true"/>
     </TestCase>
     <TestCase name="Scenario: This is a really long scenario name to see how the list command deals with wrapping">
-      <Section name="   Given: A section name that is so long that it cannot fit in a single console width">
+      <Section name="Given: A section name that is so long that it cannot fit in a single console width">
         <OverallResults successes="0" failures="0"/>
       </Section>
-      <Section name="   Given: A section name that is so long that it cannot fit in a single console width">
-        <Section name="    When: The test headers are printed as part of the normal running of the scenario">
+      <Section name="Given: A section name that is so long that it cannot fit in a single console width">
+        <Section name="When: The test headers are printed as part of the normal running of the scenario">
           <OverallResults successes="0" failures="0"/>
         </Section>
         <OverallResults successes="0" failures="0"/>
       </Section>
-      <Section name="   Given: A section name that is so long that it cannot fit in a single console width">
-        <Section name="    When: The test headers are printed as part of the normal running of the scenario">
-          <Section name="    Then: The, deliberately very long and overly verbose (you see what I did there?) section names must wrap, along with an indent">
+      <Section name="Given: A section name that is so long that it cannot fit in a single console width">
+        <Section name="When: The test headers are printed as part of the normal running of the scenario">
+          <Section name="Then: The, deliberately very long and overly verbose (you see what I did there?) section names must wrap, along with an indent">
             <OverallResults successes="1" failures="0"/>
           </Section>
           <OverallResults successes="1" failures="0"/>