Add ANSI support for output (#2199)

pester · Aug 11, 2022 · 13fb4a2 · 13fb4a2
1 parent 959851c
commit 13fb4a2
Show file tree

Hide file tree

Showing 12 changed files with 589 additions and 139 deletions.
diff --git a/src/Main.ps1 b/src/Main.ps1
@@ -922,6 +922,25 @@ function Invoke-Pester {
             $pluginConfiguration = @{}
             $pluginData = @{}
             $plugins = @()
+
+            # Verify this before WriteScreenPlugin because of Write-PesterStart and Write-PesterDebugMessage
+            if ($PesterPreference.Output.RenderMode.Value -notin 'Auto', 'Ansi', 'ConsoleColor', 'Plaintext') {
+                throw "Unsupported Output.RenderMode option '$($PesterPreference.Output.RenderMode.Value)'"
+            }
+
+            if ($PesterPreference.Output.RenderMode.Value -eq 'Auto') {
+                if ($null -ne $env:NO_COLOR) {
+                    # https://no-color.org/)
+                    $PesterPreference.Output.RenderMode = 'Plaintext'
+                }
+                elseif (($supportsVT = $host.UI.psobject.Properties['SupportsVirtualTerminal']) -and $supportsVT.Value) {
+                    $PesterPreference.Output.RenderMode = 'Ansi'
+                }
+                else {
+                    $PesterPreference.Output.RenderMode = 'ConsoleColor'
+                }
+            }
+
             if ('None' -ne $PesterPreference.Output.Verbosity.Value) {
                 $plugins += Get-WriteScreenPlugin -Verbosity $PesterPreference.Output.Verbosity.Value
             }
@@ -1105,7 +1124,7 @@ function Invoke-Pester {
             if ($PesterPreference.CodeCoverage.Enabled.Value) {
                 if ($PesterPreference.Output.Verbosity.Value -ne "None") {
                     $sw = [Diagnostics.Stopwatch]::StartNew()
-                    & $SafeCommands["Write-Host"] -ForegroundColor Magenta "Processing code coverage result."
+                    Write-PesterHostMessage -ForegroundColor Magenta "Processing code coverage result."
                 }
                 $breakpoints = @($run.PluginData.Coverage.CommandCoverage)
                 $measure = if (-not $PesterPreference.CodeCoverage.UseBreakpoints.Value) { @($run.PluginData.Coverage.Tracer.Hits) }
@@ -1163,7 +1182,7 @@ function Invoke-Pester {
 
                 $stringWriter.ToString() | & $SafeCommands['Out-File'] $resolvedPath -Encoding $PesterPreference.CodeCoverage.OutputEncoding.Value -Force
                 if ($PesterPreference.Output.Verbosity.Value -in "Detailed", "Diagnostic") {
-                    & $SafeCommands["Write-Host"] -ForegroundColor Magenta "Code Coverage result processed in $($sw.ElapsedMilliseconds) ms."
+                    Write-PesterHostMessage -ForegroundColor Magenta "Code Coverage result processed in $($sw.ElapsedMilliseconds) ms."
                 }
                 $reportText = Write-CoverageReport $coverageReport
 

diff --git a/src/Pester.RSpec.ps1 b/src/Pester.RSpec.ps1
@@ -408,6 +408,9 @@ function New-PesterConfiguration {
       CIFormat: The CI format of error output in build logs, options are None, Auto, AzureDevops and GithubActions.
       Default value: 'Auto'
 
+      RenderMode: The mode used to render console output, options are Auto, Ansi, ConsoleColor and Plaintext.
+      Default value: 'Auto'
+
     TestDrive:
       Enabled: Enable TestDrive.
       Default value: $true

diff --git a/src/Pester.Runtime.ps1 b/src/Pester.Runtime.ps1
@@ -1297,7 +1297,7 @@ function Assert-Success {
 
     if ($anyFailed) {
         $Message = $Message + ":`n$err"
-        & $SafeCommands["Write-Host"] -ForegroundColor Red $Message
+        Write-PesterHostMessage -ForegroundColor Red $Message
         throw $Message
     }
 }

diff --git a/src/Pester.Utility.ps1 b/src/Pester.Utility.ps1
@@ -326,9 +326,9 @@ function Write-PesterDebugMessage {
         $Message = (&$LazyMessage) -join "`n"
     }
 
-    & $script:SafeCommands['Write-Host'] -ForegroundColor Black -BackgroundColor $color  "${Scope}: $Message "
+    Write-PesterHostMessage -ForegroundColor Black -BackgroundColor $color  "${Scope}: $Message "
     if ($null -ne $ErrorRecord) {
-        & $script:SafeCommands['Write-Host'] -ForegroundColor Black -BackgroundColor $color "$ErrorRecord"
+        Write-PesterHostMessage -ForegroundColor Black -BackgroundColor $color "$ErrorRecord"
     }
 }
 

diff --git a/src/csharp/Pester/OutputConfiguration.cs b/src/csharp/Pester/OutputConfiguration.cs
@@ -25,6 +25,7 @@ public class OutputConfiguration : ConfigurationSection
         private StringOption _verbosity;
         private StringOption _stackTraceVerbosity;
         private StringOption _ciFormat;
+        private StringOption _renderMode;
 
         public static OutputConfiguration Default { get { return new OutputConfiguration(); } }
         public static OutputConfiguration ShallowClone(OutputConfiguration configuration)
@@ -39,6 +40,7 @@ public OutputConfiguration(IDictionary configuration) : this()
                 configuration.AssignObjectIfNotNull<string>(nameof(Verbosity), v => Verbosity = v);
                 configuration.AssignObjectIfNotNull<string>(nameof(StackTraceVerbosity), v => StackTraceVerbosity = v);
                 configuration.AssignObjectIfNotNull<string>(nameof(CIFormat), v => CIFormat = v);
+                configuration.AssignObjectIfNotNull<string>(nameof(RenderMode), v => RenderMode = v);
             }
         }
 
@@ -47,6 +49,7 @@ public OutputConfiguration() : base("Output configuration")
             Verbosity = new StringOption("The verbosity of output, options are None, Normal, Detailed and Diagnostic.", "Normal");
             StackTraceVerbosity = new StringOption("The verbosity of stacktrace output, options are None, FirstLine, Filtered and Full.", "Filtered");
             CIFormat = new StringOption("The CI format of error output in build logs, options are None, Auto, AzureDevops and GithubActions.", "Auto");
+            RenderMode = new StringOption("The mode used to render console output, options are Auto, Ansi, ConsoleColor and Plaintext.", "Auto");
         }
 
         public StringOption Verbosity
@@ -97,6 +100,22 @@ public StringOption CIFormat
             }
         }
 
+        public StringOption RenderMode
+        {
+            get { return _renderMode; }
+            set
+            {
+                if (_renderMode == null)
+                {
+                    _renderMode = value;
+                }
+                else
+                {
+                    _renderMode = new StringOption(_renderMode, value?.Value);
+                }
+            }
+        }
+
         private string FixMinimal(string value)
         {
             return string.Equals(value, "Minimal", StringComparison.OrdinalIgnoreCase) ? "Normal" : value;

diff --git a/src/functions/Coverage.Plugin.ps1 b/src/functions/Coverage.Plugin.ps1
@@ -17,7 +17,7 @@
         }
 
         if ($PesterPreference.Output.Verbosity.Value -ne "None") {
-            & $SafeCommands["Write-Host"] -ForegroundColor Magenta "Starting code coverage."
+            Write-PesterHostMessage -ForegroundColor Magenta "Starting code coverage."
         }
 
         $config = $Context.Configuration['Coverage']
@@ -45,7 +45,7 @@
             })
 
         if ($PesterPreference.Output.Verbosity.Value -in "Detailed", "Diagnostic") {
-            & $SafeCommands["Write-Host"] -ForegroundColor Magenta "Code Coverage preparation finished after $($sw.ElapsedMilliseconds) ms."
+            Write-PesterHostMessage -ForegroundColor Magenta "Code Coverage preparation finished after $($sw.ElapsedMilliseconds) ms."
         }
     } -End {
         param($Context)

diff --git a/src/functions/Get-SkipRemainingOnFailurePlugin.ps1 b/src/functions/Get-SkipRemainingOnFailurePlugin.ps1
@@ -122,7 +122,7 @@ function Get-SkipRemainingOnFailurePlugin {
             param($Context)
 
             if ($Context.Configuration.SkipRemainingOnFailureCount -gt 0) {
-                & $SafeCommands['Write-Host'] -ForegroundColor $ReportTheme.Skipped "Remaining tests skipped after first failure: $($Context.Configuration.SkipRemainingOnFailureCount)"
+                Write-PesterHostMessage -ForegroundColor $ReportTheme.Skipped "Remaining tests skipped after first failure: $($Context.Configuration.SkipRemainingOnFailureCount)"
             }
         }
     }