Show ansi colors in azdo and gh actions CI (#49014)

Author: nohwnd

src/Cli/dotnet/Commands/Test/Terminal/AnsiTerminalTestProgressFrame.cs

@@ -34,7 +34,7 @@ public void AppendTestWorkerProgress(TestProgressState progress, RenderedProgres
 
         terminal.Append('[');
         charsTaken++;
-        terminal.SetColor(TerminalColor.Green);
+        terminal.SetColor(TerminalColor.DarkGreen);
         terminal.Append('✓');
         charsTaken++;
         string passedText = passed.ToString(CultureInfo.CurrentCulture);
@@ -45,7 +45,7 @@ public void AppendTestWorkerProgress(TestProgressState progress, RenderedProgres
         terminal.Append('/');
         charsTaken++;
 
-        terminal.SetColor(TerminalColor.Red);
+        terminal.SetColor(TerminalColor.DarkRed);
         terminal.Append('x');
         charsTaken++;
         string failedText = failed.ToString(CultureInfo.CurrentCulture);
@@ -56,7 +56,7 @@ public void AppendTestWorkerProgress(TestProgressState progress, RenderedProgres
         terminal.Append('/');
         charsTaken++;
 
-        terminal.SetColor(TerminalColor.Yellow);
+        terminal.SetColor(TerminalColor.DarkYellow);
         terminal.Append('↓');
         charsTaken++;
         string skippedText = skipped.ToString(CultureInfo.CurrentCulture);

src/Cli/dotnet/Commands/Test/Terminal/NonAnsiTerminal.cs

@@ -1,135 +1,52 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using System.Globalization;
+using Microsoft.DotNet.Cli.Commands.Test.Terminal;
 
-namespace Microsoft.DotNet.Cli.Commands.Test.Terminal;
+namespace Microsoft.Testing.Platform.OutputDevice.Terminal;
 
 /// <summary>
 /// Non-ANSI terminal that writes text using the standard Console.Foreground color capabilities to stay compatible with
 /// standard Windows command line, and other command lines that are not capable of ANSI, or when output is redirected.
 /// </summary>
-internal sealed class NonAnsiTerminal : ITerminal
+internal sealed class NonAnsiTerminal : SimpleTerminal
 {
-    private readonly IConsole _console;
     private readonly ConsoleColor _defaultForegroundColor;
-    private readonly StringBuilder _stringBuilder = new();
-    private bool _isBatching;
+    private bool? _colorNotSupported;
 
     public NonAnsiTerminal(IConsole console)
-    {
-        _console = console;
-        _defaultForegroundColor = _console.GetForegroundColor();
-    }
-
-    public int Width => _console.IsOutputRedirected ? int.MaxValue : _console.BufferWidth;
+        : base(console)
+        => _defaultForegroundColor = IsForegroundColorNotSupported() ? ConsoleColor.Black : console.GetForegroundColor();
 
-    public int Height => _console.IsOutputRedirected ? int.MaxValue : _console.BufferHeight;
-
-    public void Append(char value)
+    public override void SetColor(TerminalColor color)
     {
-        if (_isBatching)
-        {
-            _stringBuilder.Append(value);
-        }
-        else
+        if (IsForegroundColorNotSupported())
         {
-            _console.Write(value);
+            return;
         }
-    }
 
-    public void Append(string value)
-    {
-        if (_isBatching)
-        {
-            _stringBuilder.Append(value);
-        }
-        else
-        {
-            _console.Write(value);
-        }
-    }
-
-    public void AppendLine()
-    {
-        if (_isBatching)
-        {
-            _stringBuilder.AppendLine();
-        }
-        else
-        {
-            _console.WriteLine();
-        }
+        Console.SetForegroundColor(ToConsoleColor(color));
     }
 
-    public void AppendLine(string value)
+    public override void ResetColor()
     {
-        if (_isBatching)
-        {
-            _stringBuilder.AppendLine(value);
-        }
-        else
+        if (IsForegroundColorNotSupported())
         {
-            _console.WriteLine(value);
+            return;
         }
-    }
-
-    public void AppendLink(string path, int? lineNumber)
-    {
-        Append(path);
-        if (lineNumber.HasValue)
-        {
-            Append($":{lineNumber}");
-        }
-    }
-
-    public void SetColor(TerminalColor color)
-    {
-        if (_isBatching)
-        {
-            _console.Write(_stringBuilder.ToString());
-            _stringBuilder.Clear();
-        }
-
-        _console.SetForegroundColor(ToConsoleColor(color));
-    }
-
-    public void ResetColor()
-    {
-        if (_isBatching)
-        {
-            _console.Write(_stringBuilder.ToString());
-            _stringBuilder.Clear();
-        }
-
-        _console.SetForegroundColor(_defaultForegroundColor);
-    }
-
-    public void ShowCursor()
-    {
-        // nop
-    }
 
-    public void HideCursor()
-    {
-        // nop
+        Console.SetForegroundColor(_defaultForegroundColor);
     }
 
-    public void StartUpdate()
+    private bool IsForegroundColorNotSupported()
     {
-        if (_isBatching)
-        {
-            throw new InvalidOperationException(CliCommandStrings.ConsoleIsAlreadyInBatchingMode);
-        }
+        _colorNotSupported ??= RuntimeInformation.IsOSPlatform(OSPlatform.Create("ANDROID")) ||
+            RuntimeInformation.IsOSPlatform(OSPlatform.Create("IOS")) ||
+            RuntimeInformation.IsOSPlatform(OSPlatform.Create("TVOS")) ||
+            RuntimeInformation.IsOSPlatform(OSPlatform.Create("WASI")) ||
+            RuntimeInformation.IsOSPlatform(OSPlatform.Create("BROWSER"));
 
-        _stringBuilder.Clear();
-        _isBatching = true;
-    }
-
-    public void StopUpdate()
-    {
-        _console.Write(_stringBuilder.ToString());
-        _isBatching = false;
+        return _colorNotSupported.Value;
     }
 
     private ConsoleColor ToConsoleColor(TerminalColor color) => color switch
@@ -153,111 +70,4 @@ public void StopUpdate()
         TerminalColor.White => ConsoleColor.White,
         _ => _defaultForegroundColor,
     };
-
-    public void EraseProgress()
-    {
-        // nop
-    }
-
-    public void RenderProgress(TestProgressState?[] progress)
-    {
-        int count = 0;
-        foreach (TestProgressState? p in progress)
-        {
-            if (p == null)
-            {
-                continue;
-            }
-
-            count++;
-
-            string durationString = HumanReadableDurationFormatter.Render(p.Stopwatch.Elapsed);
-
-            int passed = p.PassedTests;
-            int failed = p.FailedTests;
-            int skipped = p.SkippedTests;
-            int retried = p.RetriedFailedTests;
-
-            // Use just ascii here, so we don't put too many restrictions on fonts needing to
-            // properly show unicode, or logs being saved in particular encoding.
-            Append('[');
-            SetColor(TerminalColor.DarkGreen);
-            Append('+');
-            Append(passed.ToString(CultureInfo.CurrentCulture));
-            ResetColor();
-
-            Append('/');
-
-            SetColor(TerminalColor.DarkRed);
-            Append('x');
-            Append(failed.ToString(CultureInfo.CurrentCulture));
-            ResetColor();
-
-            Append('/');
-
-            SetColor(TerminalColor.DarkYellow);
-            Append('?');
-            Append(skipped.ToString(CultureInfo.CurrentCulture));
-            ResetColor();
-
-            if (retried > 0)
-            {
-                Append('/');
-                SetColor(TerminalColor.Gray);
-                Append('r');
-                Append(retried.ToString(CultureInfo.CurrentCulture));
-                ResetColor();
-            }
-
-            Append(']');
-
-            Append(' ');
-            Append(p.AssemblyName);
-
-            if (p.TargetFramework != null || p.Architecture != null)
-            {
-                Append(" (");
-                if (p.TargetFramework != null)
-                {
-                    Append(p.TargetFramework);
-                    Append('|');
-                }
-
-                if (p.Architecture != null)
-                {
-                    Append(p.Architecture);
-                }
-
-                Append(')');
-            }
-
-            TestDetailState? activeTest = p.TestNodeResultsState?.GetRunningTasks(1).FirstOrDefault();
-            if (!string.IsNullOrWhiteSpace(activeTest?.Text))
-            {
-                Append(" - ");
-                Append(activeTest.Text);
-                Append(' ');
-            }
-
-            Append(durationString);
-
-            AppendLine();
-        }
-
-        // Do not render empty lines when there is nothing to show.
-        if (count > 0)
-        {
-            AppendLine();
-        }
-    }
-
-    public void StartBusyIndicator()
-    {
-        // nop
-    }
-
-    public void StopBusyIndicator()
-    {
-        // nop
-    }
 }

src/Cli/dotnet/Commands/Test/Terminal/SimpleAnsiTerminal.cs

@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Microsoft.DotNet.Cli.Commands.Test.Terminal;
+
+namespace Microsoft.Testing.Platform.OutputDevice.Terminal;
+
+
+/// <summary>
+/// Simple terminal that uses 4-bit ANSI for colors but does not move cursor and does not do other fancy stuff to stay compatible with CI systems like AzDO.
+/// The colors are set on start of every line to properly color multiline strings in AzDO output.
+/// </summary>
+internal sealed class SimpleAnsiTerminal : SimpleTerminal
+{
+    private string? _foregroundColor;
+    private bool _prependColor;
+
+    public SimpleAnsiTerminal(IConsole console)
+        : base(console)
+    {
+    }
+
+    public override void Append(string value)
+    {
+        // Previous write appended line, so we need to prepend color.
+        if (_prependColor)
+        {
+            Console.Write(_foregroundColor);
+            // This line is not adding new line at the end, so we don't need to prepend color on next line.
+            _prependColor = false;
+        }
+
+        Console.Write(SetColorPerLine(value));
+    }
+
+    public override void AppendLine(string value)
+    {
+        // Previous write appended line, so we need to prepend color.
+        if (_prependColor)
+        {
+            Console.Write(_foregroundColor);
+        }
+
+        Console.WriteLine(SetColorPerLine(value));
+        // This call appended new line so the next write to console needs to prepend color.
+        _prependColor = true;
+    }
+
+    public override void SetColor(TerminalColor color)
+    {
+        string setColor = $"{AnsiCodes.CSI}{(int)color}{AnsiCodes.SetColor}";
+        _foregroundColor = setColor;
+        Console.Write(setColor);
+        // This call set the color for current line, no need to prepend on next write.
+        _prependColor = false;
+    }
+
+    public override void ResetColor()
+    {
+        _foregroundColor = null;
+        _prependColor = false;
+        Console.Write(AnsiCodes.SetDefaultColor);
+    }
+
+    private string? SetColorPerLine(string value)
+        => _foregroundColor == null ? value : value.Replace("\n", $"\n{_foregroundColor}");
+}