#783: Add -useansicolor flag to console runner (v2)

src/common/ConsoleHelper.cs

@@ -69,6 +69,12 @@ static void ResetColorANSI()
 
         static void ResetColorConsole()
             => Console.ResetColor();
+
+        internal static void UseAnsiColor()
+        {
+            ResetColor = ResetColorANSI;
+            SetForegroundColor = SetForegroundColorANSI;
+        }
     }
 }
 

src/xunit.console/CommandLine.cs

@@ -56,6 +56,8 @@ protected CommandLine(string[] args, Predicate<string> fileExists = null)
 
         public bool StopOnFail { get; protected set; }
 
+        public bool UseAnsiColor { get; protected set; }
+
         public bool Wait { get; protected set; }
 
         public IRunnerReporter ChooseReporter(IReadOnlyList<IRunnerReporter> reporters)
@@ -390,6 +392,11 @@ protected XunitProject Parse(Predicate<string> fileExists)
 
                     project.Filters.ExcludedNamespaces.Add(option.Value);
                 }
+                else if (optionName == "useansicolor")
+                {
+                    GuardNoOptionValue(option);
+                    UseAnsiColor = true;
+                }
                 else
                 {
                     // Might be a result output file...

src/xunit.console/ConsoleRunner.cs

@@ -30,6 +30,9 @@ public int EntryPoint(string[] args)
         {
             commandLine = CommandLine.Parse(args);
 
+            if (commandLine.UseAnsiColor)
+                ConsoleHelper.UseAnsiColor();
+
             try
             {
                 var reporters = GetAvailableRunnerReporters();
@@ -76,7 +79,7 @@ public int EntryPoint(string[] args)
                 if (commandLine.Debug)
                     Debugger.Launch();
 
-                logger = new ConsoleRunnerLogger(!commandLine.NoColor, consoleLock);
+                logger = new ConsoleRunnerLogger(!commandLine.NoColor, commandLine.UseAnsiColor, consoleLock);
                 reporterMessageHandler = MessageSinkWithTypesAdapter.Wrap(reporter.CreateMessageHandler(logger));
 
                 if (!commandLine.NoLogo)
@@ -240,6 +243,7 @@ void PrintUsage(IReadOnlyList<IRunnerReporter> reporters)
             Console.WriteLine("  -pause                    : pause before doing any work, to help attach a debugger");
 #endif
             Console.WriteLine("  -debug                    : launch the debugger to debug the tests");
+            Console.WriteLine("  -useansicolor             : force using ANSI color output on Windows (non-Windows always uses ANSI colors)");
             Console.WriteLine("  -serialize                : serialize all test cases (for diagnostic purposes only)");
             Console.WriteLine("  -trait \"name=value\"       : only run tests with matching name/value traits");
             Console.WriteLine("                            : if specified more than once, acts as an OR operation");

src/xunit.runner.utility/Utility/ConsoleRunnerLogger.cs

@@ -1,35 +1,52 @@
 #if NETFRAMEWORK || NETCOREAPP
 
 using System;
+using System.ComponentModel;
 
 namespace Xunit
 {
     /// <summary>
-    /// An implementation of <see cref="IRunnerLogger"/> which logs messages
-    /// to <see cref="Console"/> and <see cref="Console.Error"/>.
+    /// An implementation of <see cref="IRunnerLogger"/> which logs messages to <see cref="Console"/>.
     /// </summary>
     public class ConsoleRunnerLogger : IRunnerLogger
     {
         readonly object lockObject;
         readonly bool useColors;
 
+        /// <summary/>
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        [Obsolete("Please use the new overload with the useAnsiColor flag")]
+        public ConsoleRunnerLogger(bool useColors) : this(useColors, useAnsiColor: false, new object()) { }
+
+        /// <summary/>
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        [Obsolete("Please use the new overload with the useAnsiColor flag")]
+        public ConsoleRunnerLogger(bool useColors, object lockObject) : this(useColors, useAnsiColor: false, lockObject) { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="ConsoleRunnerLogger"/> class.
         /// </summary>
         /// <param name="useColors">A flag to indicate whether colors should be used when
         /// logging messages.</param>
-        public ConsoleRunnerLogger(bool useColors) : this(useColors, new object()) { }
+        /// <param name="useAnsiColor">A flag to indicate whether ANSI colors should be
+        /// forced on Windows.</param>
+        public ConsoleRunnerLogger(bool useColors, bool useAnsiColor) : this(useColors, useAnsiColor, new object()) { }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ConsoleRunnerLogger"/> class.
         /// </summary>
         /// <param name="useColors">A flag to indicate whether colors should be used when
         /// logging messages.</param>
+        /// <param name="useAnsiColor">A flag to indicate whether ANSI colors should be
+        /// forced on Windows.</param>
         /// <param name="lockObject">The lock object used to prevent console clashes.</param>
-        public ConsoleRunnerLogger(bool useColors, object lockObject)
+        public ConsoleRunnerLogger(bool useColors, bool useAnsiColor, object lockObject)
         {
             this.useColors = useColors;
             this.lockObject = lockObject;
+
+            if (useAnsiColor)
+                ConsoleHelper.UseAnsiColor();
         }
 
         /// <inheritdoc/>
@@ -40,7 +57,7 @@ public void LogError(StackFrameInfo stackFrame, string message)
         {
             lock (LockObject)
                 using (SetColor(ConsoleColor.Red))
-                    Console.Error.WriteLine(message);
+                    Console.WriteLine(message);
         }
 
         /// <inheritdoc/>