Add isOutputRedirected parameter to GetFormatStyleString() method (#14397)

SteveL-MSFT · adityapatwardhan · commit c1401377d472 · 2021-09-15T11:12:26.000-07:00
diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs
@@ -1215,7 +1215,7 @@ public override void WriteDebugLine(string message)
             {
                 if (SupportsVirtualTerminal)
                 {
-                    WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Debug) + StringUtil.Format(ConsoleHostUserInterfaceStrings.DebugFormatString, message) + PSStyle.Instance.Reset);
+                    WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Debug, Console.IsOutputRedirected) + StringUtil.Format(ConsoleHostUserInterfaceStrings.DebugFormatString, message) + PSStyle.Instance.Reset);
                 }
                 else
                 {
@@ -1276,7 +1276,7 @@ public override void WriteVerboseLine(string message)
             {
                 if (SupportsVirtualTerminal)
                 {
-                    WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Verbose) + StringUtil.Format(ConsoleHostUserInterfaceStrings.VerboseFormatString, message) + PSStyle.Instance.Reset);
+                    WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Verbose, Console.IsOutputRedirected) + StringUtil.Format(ConsoleHostUserInterfaceStrings.VerboseFormatString, message) + PSStyle.Instance.Reset);
                 }
                 else
                 {
@@ -1320,7 +1320,7 @@ public override void WriteWarningLine(string message)
             {
                 if (SupportsVirtualTerminal)
                 {
-                    WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Warning) + StringUtil.Format(ConsoleHostUserInterfaceStrings.WarningFormatString, message) + PSStyle.Instance.Reset);
+                    WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Warning, Console.IsOutputRedirected) + StringUtil.Format(ConsoleHostUserInterfaceStrings.WarningFormatString, message) + PSStyle.Instance.Reset);
                 }
                 else
                 {
diff --git a/src/System.Management.Automation/engine/Utils.cs b/src/System.Management.Automation/engine/Utils.cs
@@ -1617,13 +1617,12 @@ internal enum FormatStyle
             Debug,
         }
 
-        internal static string GetFormatStyleString(FormatStyle formatStyle)
+        internal static string GetFormatStyleString(FormatStyle formatStyle, bool isOutputRedirected)
         {
             // redirected console gets plaintext output to preserve existing behavior
             if (!InternalTestHooks.BypassOutputRedirectionCheck &&
                 ((PSStyle.Instance.OutputRendering == OutputRendering.PlainText) ||
-                (formatStyle == FormatStyle.Error && Console.IsErrorRedirected) ||
-                (formatStyle != FormatStyle.Error && Console.IsOutputRedirected)))
+                isOutputRedirected))
             {
                 return string.Empty;
             }
diff --git a/test/powershell/engine/Formatting/OutputRendering.Tests.ps1 b/test/powershell/engine/Formatting/OutputRendering.Tests.ps1
@@ -2,14 +2,6 @@
 # Licensed under the MIT License.
 
 Describe 'OutputRendering tests' {
-    BeforeAll {
-        $th = New-TestHost
-        $rs = [runspacefactory]::Createrunspace($th)
-        $rs.open()
-        $ps = [powershell]::Create()
-        $ps.Runspace = $rs
-    }
-
     BeforeEach {
         if ($null -ne $PSStyle) {
             $oldOutputRendering = $PSStyle.OutputRendering
@@ -20,8 +12,6 @@ Describe 'OutputRendering tests' {
         if ($null -ne $PSStyle) {
             $PSStyle.OutputRendering = $oldOutputRendering
         }
-
-        $ps.Commands.Clear()
     }
 
     It 'OutputRendering works for "<outputRendering>" to the host' -TestCases @(

Original file line number	Diff line number	Diff line change
`@@ -1215,7 +1215,7 @@ public override void WriteDebugLine(string message)`
`1215`	`1215`	`{`
`1216`	`1216`	`if (SupportsVirtualTerminal)`
`1217`	`1217`	`{`
`1218`		`- WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Debug) + StringUtil.Format(ConsoleHostUserInterfaceStrings.DebugFormatString, message) + PSStyle.Instance.Reset);`
	`1218`	`+ WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Debug, Console.IsOutputRedirected) + StringUtil.Format(ConsoleHostUserInterfaceStrings.DebugFormatString, message) + PSStyle.Instance.Reset);`
`1219`	`1219`	`}`
`1220`	`1220`	`else`
`1221`	`1221`	`{`
`@@ -1276,7 +1276,7 @@ public override void WriteVerboseLine(string message)`
`1276`	`1276`	`{`
`1277`	`1277`	`if (SupportsVirtualTerminal)`
`1278`	`1278`	`{`
`1279`		`- WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Verbose) + StringUtil.Format(ConsoleHostUserInterfaceStrings.VerboseFormatString, message) + PSStyle.Instance.Reset);`
	`1279`	`+ WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Verbose, Console.IsOutputRedirected) + StringUtil.Format(ConsoleHostUserInterfaceStrings.VerboseFormatString, message) + PSStyle.Instance.Reset);`
`1280`	`1280`	`}`
`1281`	`1281`	`else`
`1282`	`1282`	`{`
`@@ -1320,7 +1320,7 @@ public override void WriteWarningLine(string message)`
`1320`	`1320`	`{`
`1321`	`1321`	`if (SupportsVirtualTerminal)`
`1322`	`1322`	`{`
`1323`		`- WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Warning) + StringUtil.Format(ConsoleHostUserInterfaceStrings.WarningFormatString, message) + PSStyle.Instance.Reset);`
	`1323`	`+ WriteLine(Utils.GetFormatStyleString(Utils.FormatStyle.Warning, Console.IsOutputRedirected) + StringUtil.Format(ConsoleHostUserInterfaceStrings.WarningFormatString, message) + PSStyle.Instance.Reset);`
`1324`	`1324`	`}`
`1325`	`1325`	`else`
`1326`	`1326`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1617,13 +1617,12 @@ internal enum FormatStyle`
`1617`	`1617`	`Debug,`
`1618`	`1618`	`}`
`1619`	`1619`
`1620`		`- internal static string GetFormatStyleString(FormatStyle formatStyle)`
	`1620`	`+ internal static string GetFormatStyleString(FormatStyle formatStyle, bool isOutputRedirected)`
`1621`	`1621`	`{`
`1622`	`1622`	`// redirected console gets plaintext output to preserve existing behavior`
`1623`	`1623`	`if (!InternalTestHooks.BypassOutputRedirectionCheck &&`
`1624`	`1624`	`((PSStyle.Instance.OutputRendering == OutputRendering.PlainText) \|\|`
`1625`		`- (formatStyle == FormatStyle.Error && Console.IsErrorRedirected) \|\|`
`1626`		`- (formatStyle != FormatStyle.Error && Console.IsOutputRedirected)))`
	`1625`	`+ isOutputRedirected))`
`1627`	`1626`	`{`
`1628`	`1627`	`return string.Empty;`
`1629`	`1628`	`}`