From e5280b2c5722ab93419905d886e8675ee912bd25 Mon Sep 17 00:00:00 2001
From: Peter Huene <peter.huene@puppetlabs.com>
Date: Wed, 11 Feb 2015 12:40:20 -0800
Subject: [PATCH] Add --force-colour option to force colour output.

Adding a --force-colour option to force colour output on POSIX systems,
provided a debugger is not attached.

This allows for Catch to output colours even if STDOUT is not a tty,
which can be the case when the test executable is being spawned by a
parent process (e.g. CMake's ctest).
---
 include/internal/catch_commandline.hpp         |  4 ++++
 include/internal/catch_config.hpp              |  4 +++-
 include/internal/catch_console_colour_impl.hpp |  3 ++-
 include/internal/catch_interfaces_config.h     |  1 +
 projects/SelfTest/TestMain.cpp                 | 18 +++++++++++++++++-
 5 files changed, 27 insertions(+), 3 deletions(-)

diff --git a/include/internal/catch_commandline.hpp b/include/internal/catch_commandline.hpp
index a17059f4..8b085365 100644
--- a/include/internal/catch_commandline.hpp
+++ b/include/internal/catch_commandline.hpp
@@ -170,6 +170,10 @@ namespace Catch {
             .describe( "set a specific seed for random numbers" )
             .bind( &setRngSeed, "'time'|number" );
 
+        cli["--force-colour"]
+            .describe( "force colourised output" )
+            .bind( &ConfigData::forceColour );
+
         return cli;
     }
 
diff --git a/include/internal/catch_config.hpp b/include/internal/catch_config.hpp
index 3e332087..1f3ca64a 100644
--- a/include/internal/catch_config.hpp
+++ b/include/internal/catch_config.hpp
@@ -37,6 +37,7 @@ namespace Catch {
             noThrow( false ),
             showHelp( false ),
             showInvisibles( false ),
+            forceColour( false ),
             abortAfter( -1 ),
             rngSeed( 0 ),
             verbosity( Verbosity::Normal ),
@@ -55,6 +56,7 @@ namespace Catch {
         bool noThrow;
         bool showHelp;
         bool showInvisibles;
+        bool forceColour;
 
         int abortAfter;
         unsigned int rngSeed;
@@ -131,7 +133,6 @@ namespace Catch {
 
         std::string getReporterName() const { return m_data.reporterName; }
 
-
         int abortAfter() const { return m_data.abortAfter; }
 
         TestSpec const& testSpec() const { return m_testSpec; }
@@ -148,6 +149,7 @@ namespace Catch {
         virtual ShowDurations::OrNot showDurations() const { return m_data.showDurations; }
         virtual RunTests::InWhatOrder runOrder() const  { return m_data.runOrder; }
         virtual unsigned int rngSeed() const    { return m_data.rngSeed; }
+        virtual bool forceColour() const { return m_data.forceColour; }
 
     private:
         ConfigData m_data;
diff --git a/include/internal/catch_console_colour_impl.hpp b/include/internal/catch_console_colour_impl.hpp
index a62550bd..2c4b36c3 100644
--- a/include/internal/catch_console_colour_impl.hpp
+++ b/include/internal/catch_console_colour_impl.hpp
@@ -143,7 +143,8 @@ namespace {
     };
 
     IColourImpl* platformColourInstance() {
-        return isatty(STDOUT_FILENO)
+        Ptr<IConfig const> config = getCurrentContext().getConfig();
+        return (config && config->forceColour()) || isatty(STDOUT_FILENO)
             ? PosixColourImpl::instance()
             : NoColourImpl::instance();
     }
diff --git a/include/internal/catch_interfaces_config.h b/include/internal/catch_interfaces_config.h
index 5f30ac1d..1281bd7e 100644
--- a/include/internal/catch_interfaces_config.h
+++ b/include/internal/catch_interfaces_config.h
@@ -56,6 +56,7 @@ namespace Catch {
         virtual TestSpec const& testSpec() const = 0;
         virtual RunTests::InWhatOrder runOrder() const = 0;
         virtual unsigned int rngSeed() const = 0;
+        virtual bool forceColour() const = 0;
     };
 }
 
diff --git a/projects/SelfTest/TestMain.cpp b/projects/SelfTest/TestMain.cpp
index 4b60a4f5..7cb7ca42 100644
--- a/projects/SelfTest/TestMain.cpp
+++ b/projects/SelfTest/TestMain.cpp
@@ -182,7 +182,23 @@ TEST_CASE( "Process can be configured on command line", "[config][command-line]"
             CHECK( config.shouldDebugBreak );
             CHECK( config.noThrow == true );
         }
-    }        
+    }
+
+    SECTION( "force-colour", "") {
+        SECTION( "--force-colour", "" ) {
+            const char* argv[] = { "test", "--force-colour" };
+            CHECK_NOTHROW( parseIntoConfig( argv, config ) );
+
+            REQUIRE( config.forceColour );
+        }
+
+        SECTION( "without --force-colour", "" ) {
+            const char* argv[] = { "test" };
+            CHECK_NOTHROW( parseIntoConfig( argv, config ) );
+
+            REQUIRE( !config.forceColour );
+        }
+    }
 }