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

Refactored printResultType and printMessage to work off a single switch

Commit
313481006fb2f2bd59eec547ec42c76c51faa836
Author
Phil Nash ·
Parents
3b970e20e9ef

Files · Download .tar.gz

Changes

 include/reporters/catch_reporter_console.hpp | 143 ++++++++++++++++-----------
 1 file changed, 88 insertions(+), 55 deletions(-)

diff --git a/include/reporters/catch_reporter_console.hpp b/include/reporters/catch_reporter_console.hpp
index c9ef00ee..f83b4434 100644
--- a/include/reporters/catch_reporter_console.hpp
+++ b/include/reporters/catch_reporter_console.hpp
@@ -48,40 +48,98 @@ namespace Catch {
                 stream << result.getSourceInfo() << ":\n";
             }
             
+            ResultComponents components( result );
             bool endsWithNewLine = false;
             if( _assertionStats.totals.assertions.total() > 0 ) {
-                endsWithNewLine = printOriginalExpression( result );
-                endsWithNewLine = printResultType( result );
-                endsWithNewLine |= printReconstructedExpression( result );
+                printOriginalExpression( result );
+                printResultType( components );
+                endsWithNewLine = printReconstructedExpression( result );
             }
-            endsWithNewLine |= printMessage( result );
+            endsWithNewLine |= printMessage( components );
             if( !endsWithNewLine )
                 stream << "\n";
             stream << std::endl;
         }
         
-        bool printResultType( AssertionResult const& _result ) {
-            switch( _result.getResultType() ) {
-                case ResultWas::Info:
-                case ResultWas::Warning:
-                    break;
-                case ResultWas::Ok:
-                    {
-                        TextColour successColour( TextColour::Success );
-                        stream << "passed ";
-                    }
-                    break;
-                default:
-                    if( _result.isOk() ) {
-                        TextColour okAnywayColour( TextColour::Success );
-                        stream << "failed - but was ok ";
-                    }
-                    else {
-                        TextColour errorColour( TextColour::Error );
-                        stream << "failed ";
-                    }
+        struct ResultComponents {
+            ResultComponents( AssertionResult const& _result )
+            : colour( TextColour::None )
+            {
+                switch( _result.getResultType() ) {
+                    case ResultWas::Ok:
+                        colour = TextColour::Success;
+                        passOrFail = "passed";
+                        if( _result.hasMessage() ){
+                            messageLabel = "with message";
+                            message = _result.getMessage();
+                        }
+                        break;
+                    case ResultWas::ExpressionFailed:
+                        if( _result.isOk() ) {
+                            colour = TextColour::Success;
+                            passOrFail = "failed - but was ok";
+                        }
+                        else {
+                            colour = TextColour::Error;
+                            passOrFail = "failed";
+                        }
+                        if( _result.hasMessage() ){
+                            messageLabel = "with message";
+                            message = _result.getMessage();
+                        }
+                        break;
+                    case ResultWas::ThrewException:
+                        colour = TextColour::Error;
+                        passOrFail = "failed";
+                        messageLabel = "due to unexpected exception with message";
+                        message = _result.getMessage();
+                        break;
+                    case ResultWas::DidntThrowException:
+                        colour = TextColour::Error;
+                        passOrFail = "failed";
+                        messageLabel = "because no exception was thrown where one was expected";
+                        break;
+                    case ResultWas::Info:
+                        messageLabel = "info";
+                        message = _result.getMessage();
+                        break;
+                    case ResultWas::Warning:
+                        messageLabel = "warning";
+                        message = _result.getMessage();
+                        break;
+                    case ResultWas::ExplicitFailure:
+                        passOrFail = "failed";
+                        colour = TextColour::Error;
+                        messageLabel = "explicitly with message";
+                        message = _result.getMessage();
+                        break;
+                    case ResultWas::Exception:
+                        passOrFail = "failed";
+                        colour = TextColour::Error;
+                        if( _result.hasMessage() ){
+                            messageLabel = "with message";
+                            message = _result.getMessage();
+                        }
+                        break;
+                    case ResultWas::Unknown: // These cases are here to prevent compiler warnings
+                    case ResultWas::FailureBit:
+                        passOrFail = "** internal error **";
+                        colour = TextColour::Error;
+                        break;
+                }
+            }
+            
+            TextColour::Colours colour;
+            std::string passOrFail;
+            std::string messageLabel;
+            std::string message;
+        };
+
+        void printResultType( ResultComponents const& _components ) {
+            if( !_components.passOrFail.empty() ) {
+                TextColour colour( _components.colour );
+                stream << _components.passOrFail << " ";
             }
-            return false;
         }
         bool printOriginalExpression( AssertionResult const& _result ) {
             if( _result.hasExpression() ) {
@@ -106,43 +164,18 @@ namespace Catch {
             }
             return false;
         }        
-        bool printMessage( AssertionResult const& _result ) {
-            std::pair<std::string, std::string> message = getMessage( _result );
+        bool printMessage( ResultComponents const& _components ) {
             bool endsWithNewLine = false;
-            if( !message.first.empty() ) {
-                stream << message.first << ":" << "\n";
+            if( !_components.messageLabel.empty() ) {
+                stream << _components.messageLabel << ":" << "\n";
                 endsWithNewLine = true;
             }
-            if( !message.second.empty() ) {
-                stream << wrapLongStrings( message.second ) << "\n";
+            if( !_components.message.empty() ) {
+                stream << wrapLongStrings( _components.message ) << "\n";
                 endsWithNewLine = true;
             }
             return endsWithNewLine;
         }
-        std::pair<std::string, std::string> getMessage( AssertionResult const& _result ) {
-            switch( _result.getResultType() ) {
-                case ResultWas::ThrewException:
-                    return std::make_pair( "due to unexpected exception with message", _result.getMessage() );
-                case ResultWas::DidntThrowException:
-                    return std::make_pair( "because no exception was thrown where one was expected", "" );
-                case ResultWas::Info:
-                    return std::make_pair( "info", _result.getMessage() );
-                case ResultWas::Warning:
-                    return std::make_pair( "warning", _result.getMessage() );
-                case ResultWas::ExplicitFailure:
-                    return std::make_pair( "explicitly with message", _result.getMessage() );
-
-                case ResultWas::Unknown: // These cases are here to prevent compiler warnings
-                case ResultWas::Ok:
-                case ResultWas::FailureBit:
-                case ResultWas::ExpressionFailed:
-                case ResultWas::Exception:
-                    if( _result.hasMessage() )
-                        return std::make_pair( "with message", _result.getMessage() );
-                    else
-                        return std::make_pair( "", "" );
-            }
-        }
                 
         virtual void sectionEnded( SectionStats const& _sectionStats ) {
             if( _sectionStats.missingAssertions ) {