Interactive display for terminals

samples/Playground/Program.cs

@@ -44,10 +44,7 @@ public static async Task<int> Main(string[] args)
             });
             await discoveryResponse.WaitCompletionAsync();
 
-            ResponseListener runRequest = await client.RunTestsAsync(Guid.NewGuid(), testNodeUpdates.Select(x => x.Node).ToArray(), node =>
-            {
-                return Task.CompletedTask;
-            });
+            ResponseListener runRequest = await client.RunTestsAsync(Guid.NewGuid(), testNodeUpdates.Select(x => x.Node).ToArray(), node => Task.CompletedTask);
             await runRequest.WaitCompletionAsync();
 
             return 0;

src/Platform/Microsoft.Testing.Platform/OutputDevice/ConsoleDisplayService.cs

@@ -621,28 +621,3 @@ private async Task ConsoleWriteLineAsync(string? text, ConsoleColor? color = nul
         return stringBuilder.ToString();
     }
 }
-
-internal static class OutputFormatter
-{
-    public static string FormatString(string? text)
-    {
-        if (text == null)
-        {
-            return "<null>";
-        }
-
-        if (text == string.Empty)
-        {
-            return "<empty>";
-        }
-
-#pragma warning disable IDE0046 // Convert to conditional expression
-        if (RoslynString.IsNullOrWhiteSpace(text))
-        {
-            return text.Replace("\r", "\\r").Replace("\n", "\\n").Replace("\t", "\\t");
-        }
-#pragma warning restore IDE0046 // Convert to conditional expression
-
-        return text;
-    }
-}

src/Platform/Microsoft.Testing.Platform/OutputDevice/OutputDeviceManager.cs

@@ -32,7 +32,7 @@ internal async Task<IPlatformOutputDevice> BuildAsync(ServiceProvider servicePro
             }
         }
 
-        return new ConsoleOutputDevice(
+        return new ConsoleLoggerOutputDevice(
             serviceProvider.GetTestApplicationCancellationTokenSource(),
             serviceProvider.GetConsole(),
             serviceProvider.GetTestApplicationModuleInfo(),
@@ -46,6 +46,7 @@ internal async Task<IPlatformOutputDevice> BuildAsync(ServiceProvider servicePro
             loggingState.CommandLineParseResult.IsOptionSet(PlatformCommandLineProvider.DiscoverTestsOptionKey),
             loggingState.CommandLineParseResult.IsOptionSet(PlatformCommandLineProvider.ServerOptionKey),
             PlatformCommandLineProvider.GetMinimumExpectedTests(loggingState.CommandLineParseResult),
-            loggingState.FileLoggerProvider);
+            loggingState.FileLoggerProvider,
+            serviceProvider.GetClock());
     }
 }

src/Platform/Microsoft.Testing.Platform/OutputDevice/OutputFormatter.cs

@@ -0,0 +1,29 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Testing.Platform.OutputDevice;
+
+internal static class OutputFormatter
+{
+    public static string FormatString(string? text)
+    {
+        if (text == null)
+        {
+            return "<null>";
+        }
+
+        if (text == string.Empty)
+        {
+            return "<empty>";
+        }
+
+#pragma warning disable IDE0046 // Convert to conditional expression
+        if (RoslynString.IsNullOrWhiteSpace(text))
+        {
+            return text.Replace("\r", "\\r").Replace("\n", "\\n").Replace("\t", "\\t");
+        }
+#pragma warning restore IDE0046 // Convert to conditional expression
+
+        return text;
+    }
+}

src/Platform/Microsoft.Testing.Platform/UI/AnsiCodes.cs

@@ -0,0 +1,144 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Testing.Platform.UI;
+
+/// <summary>
+/// A collection of standard ANSI/VT100 control codes.
+/// </summary>
+internal static class AnsiCodes
+{
+    /// <summary>
+    ///  Escape character.
+    /// </summary>
+    public const string Esc = "\x1b";
+
+    /// <summary>
+    /// The control sequence introducer.
+    /// </summary>
+    public const string CSI = "\x1b[";
+
+    /// <summary>
+    /// Select graphic rendition.
+    /// </summary>
+    /// <remarks>
+    /// Print <see cref="CSI"/>color-code<see cref="SetColor"/> to change text color.
+    /// </remarks>
+    public const string SetColor = ";1m";
+
+    /// <summary>
+    /// Select graphic rendition - set bold mode.
+    /// </summary>
+    /// <remarks>
+    /// Print <see cref="CSI"/><see cref="SetBold"/> to change text to bold.
+    /// </remarks>
+    public const string SetBold = "1m";
+
+    /// <summary>
+    /// A shortcut to reset color back to normal.
+    /// </summary>
+    public const string SetDefaultColor = CSI + "m";
+
+    /// <summary>
+    /// Non-xterm extension to render a hyperlink.
+    /// </summary>
+    /// <remarks>
+    /// Print <see cref="LinkPrefix"/>url<see cref="LinkInfix"/>text<see cref="LinkSuffix"/> to render a hyperlink.
+    /// </remarks>
+    public const string LinkPrefix = "\x1b]8;;";
+
+    /// <summary>
+    /// <see cref="LinkPrefix"/>.
+    /// </summary>
+    public const string LinkInfix = "\x1b\\";
+
+    /// <summary>
+    /// <see cref="LinkPrefix"/>.
+    /// </summary>
+    public const string LinkSuffix = "\x1b]8;;\x1b\\";
+
+    /// <summary>
+    /// Moves up the specified number of lines and puts cursor at the beginning of the line.
+    /// </summary>
+    /// <remarks>
+    /// Print <see cref="CSI"/>N<see cref="MoveUpToLineStart"/> to move N lines up.
+    /// </remarks>
+    public const string MoveUpToLineStart = "F";
+
+    /// <summary>
+    /// Moves forward (to the right) the specified number of characters.
+    /// </summary>
+    /// <remarks>
+    /// Print <see cref="CSI"/>N<see cref="MoveForward"/> to move N characters forward.
+    /// </remarks>
+    public const string MoveForward = "C";
+
+    /// <summary>
+    /// Moves backward (to the left) the specified number of characters.
+    /// </summary>
+    /// <remarks>
+    /// Print <see cref="CSI"/>N<see cref="MoveBackward"/> to move N characters backward.
+    /// </remarks>
+    public const string MoveBackward = "D";
+
+    /// <summary>
+    /// Clears everything from cursor to end of screen.
+    /// </summary>
+    /// <remarks>
+    /// Print <see cref="CSI"/><see cref="EraseInDisplay"/> to clear.
+    /// </remarks>
+    public const string EraseInDisplay = "J";
+
+    /// <summary>
+    /// Clears everything from cursor to the end of the current line.
+    /// </summary>
+    /// <remarks>
+    /// Print <see cref="CSI"/><see cref="EraseInLine"/> to clear.
+    /// </remarks>
+    public const string EraseInLine = "K";
+
+    /// <summary>
+    /// Hides the cursor.
+    /// </summary>
+    public const string HideCursor = "\x1b[?25l";
+
+    /// <summary>
+    /// Shows/restores the cursor.
+    /// </summary>
+    public const string ShowCursor = "\x1b[?25h";
+
+    /// <summary>
+    /// Set progress state to a busy spinner. <br/>
+    /// Note: this code works only on ConEmu terminals, and conflicts with push a notification code on iTerm2.
+    /// </summary>
+    /// <remarks>
+    /// <see href="https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC">ConEmu specific OSC codes.</see><br/>
+    /// <see href="https://iterm2.com/documentation-escape-codes.html">iTerm2 proprietary escape codes.</see>
+    /// </remarks>
+    public const string SetProgressIndeterminate = "\x1b]9;4;3;\x1b\\";
+
+    /// <summary>
+    /// Remove progress state, restoring taskbar status to normal. <br/>
+    /// Note: this code works only on ConEmu terminals, and conflicts with push a notification code on iTerm2.
+    /// </summary>
+    /// <remarks>
+    /// <see href="https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC">ConEmu specific OSC codes.</see><br/>
+    /// <see href="https://iterm2.com/documentation-escape-codes.html">iTerm2 proprietary escape codes.</see>
+    /// </remarks>
+    public const string RemoveProgress = "\x1b]9;4;0;\x1b\\";
+
+    public static string Colorize(string? s, TerminalColor color)
+        => RoslynString.IsNullOrWhiteSpace(s) ? s ?? string.Empty : $"{CSI}{(int)color}{SetColor}{s}{SetDefaultColor}";
+
+    public static string MakeBold(string? s)
+        => RoslynString.IsNullOrWhiteSpace(s) ? s ?? string.Empty : $"{CSI}{SetBold}{s}{SetDefaultColor}";
+
+    public static string MoveCursorBackward(int count) => $"{CSI}{count}{MoveBackward}";
+
+    /// <summary>
+    /// Moves cursor to the specified column, or the rightmost column if <paramref name="column"/> is greater than the width of the terminal.
+    /// </summary>
+    /// <param name="column">Column index.</param>
+    /// <returns>Control codes to set the desired position.</returns>
+    public static string SetCursorHorizontal(int column) => $"{CSI}{column}G";
+}

src/Platform/Microsoft.Testing.Platform/UI/AnsiDetector.cs

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// Portions of the code in this file were ported from the spectre.console by Patrik Svensson, Phil Scott, Nils Andresen
+// https://github.com/spectreconsole/spectre.console/blob/main/src/Spectre.Console/Internal/Backends/Ansi/AnsiDetector.cs
+// and from the supports-ansi project by Qingrong Ke
+// https://github.com/keqingrong/supports-ansi/blob/master/index.js
+using System.Text.RegularExpressions;
+
+namespace Microsoft.Testing.Platform.UI;
+
+internal class AnsiDetector
+{
+    private static readonly Regex[] TerminalsRegexes =
+    {
+        new("^xterm"), // xterm, PuTTY, Mintty
+        new("^rxvt"), // RXVT
+        new("^(?!eterm-color).*eterm.*"), // Accepts eterm, but not eterm-color, which does not support moving the cursor, see #9950.
+        new("^screen"), // GNU screen, tmux
+        new("tmux"), // tmux
+        new("^vt100"), // DEC VT series
+        new("^vt102"), // DEC VT series
+        new("^vt220"), // DEC VT series
+        new("^vt320"), // DEC VT series
+        new("ansi"), // ANSI
+        new("scoansi"), // SCO ANSI
+        new("cygwin"), // Cygwin, MinGW
+        new("linux"), // Linux console
+        new("konsole"), // Konsole
+        new("bvterm"), // Bitvise SSH Client
+        new("^st-256color"), // Suckless Simple Terminal, st
+        new("alacritty"), // Alacritty
+    };
+
+    internal static bool IsAnsiSupported(string termType)
+        => !RoslynString.IsNullOrEmpty(termType) && TerminalsRegexes.Any(regex => regex.IsMatch(termType));
+}

src/Platform/Microsoft.Testing.Platform/UI/AssemblyRun.cs

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Testing.Platform.UI;
+
+internal sealed class AssemblyRun
+{
+    public AssemblyRun(int slotIndex, AssemblyRunStartedUpdate assemblyRunStartedUpdate, StopwatchAbstraction stopwatch)
+    {
+        SlotIndex = slotIndex;
+        AssemblyRunStartedUpdate = assemblyRunStartedUpdate;
+        Stopwatch = stopwatch;
+    }
+
+    public int SlotIndex { get; }
+
+    public AssemblyRunStartedUpdate AssemblyRunStartedUpdate { get; }
+
+    public StopwatchAbstraction Stopwatch { get; }
+
+    public List<string> Attachments { get; } = new();
+
+    public List<IMessage> Messages { get; } = new();
+
+    public int FailedTests { get; internal set; }
+
+    public int PassedTests { get; internal set; }
+
+    public int SkippedTests { get; internal set; }
+
+    public int TotalTests { get; internal set; }
+
+    public int TimedOutTests { get; internal set; }
+
+    public int CancelledTests { get; internal set; }
+}

src/Platform/Microsoft.Testing.Platform/UI/AssemblyRunCompletedUpdate.cs

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Testing.Platform.UI;
+
+internal sealed class AssemblyRunCompletedUpdate(string assembly, string? targetFramework, string? architecture)
+{
+    public string Assembly { get; } = assembly;
+
+    public string? TargetFramework { get; } = targetFramework;
+
+    public string? Architecture { get; } = architecture;
+}

src/Platform/Microsoft.Testing.Platform/UI/AssemblyRunStartedUpdate.cs

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+internal sealed class AssemblyRunStartedUpdate(string assembly, int tests, string? targetFramework, string? architecture)
+{
+    public string Assembly { get; } = assembly;
+
+    public int Tests { get; } = tests;
+
+    public string? TargetFramework { get; } = targetFramework;
+
+    public string? Architecture { get; } = architecture;
+}