Merge pull request #77 from tjaart/add_apply_theme_on_output_redirection_option

Add apply theme on output redirection option

Author: nblumhardt

src/Serilog.Sinks.Console/ConsoleLoggerConfigurationExtensions.cs

@@ -48,6 +48,7 @@ public static class ConsoleLoggerConfigurationExtensions
         /// <param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
         /// <param name="theme">The theme to apply to the styled output. If not specified,
         /// uses <see cref="SystemConsoleTheme.Literate"/>.</param>
+        /// <param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
         /// <returns>Configuration object allowing method chaining.</returns>
         public static LoggerConfiguration Console(
             this LoggerSinkConfiguration sinkConfiguration,
@@ -56,13 +57,14 @@ public static LoggerConfiguration Console(
             IFormatProvider formatProvider = null,
             LoggingLevelSwitch levelSwitch = null,
             LogEventLevel? standardErrorFromLevel = null,
-            ConsoleTheme theme = null,
+            ConsoleTheme theme = null, 
+            bool applyThemeToRedirectedOutput = false,
             object syncRoot = null)
         {
             if (sinkConfiguration == null) throw new ArgumentNullException(nameof(sinkConfiguration));
             if (outputTemplate == null) throw new ArgumentNullException(nameof(outputTemplate));
 
-            var appliedTheme = System.Console.IsOutputRedirected || System.Console.IsErrorRedirected ?
+            var appliedTheme = !applyThemeToRedirectedOutput && (System.Console.IsOutputRedirected || System.Console.IsErrorRedirected) ?
                 ConsoleTheme.None :
                 theme ?? SystemConsoleThemes.Literate;
 

test/Serilog.Sinks.Console.Tests/Configuration/ConsoleLoggerConfigurationExtensionsTests.cs

@@ -0,0 +1,63 @@
+using System;
+using System.IO;
+using System.Linq;
+using Xunit;
+using Serilog.Sinks.SystemConsole.Themes;
+
+namespace Serilog.Sinks.Console.Tests.Configuration
+{
+    public class ConsoleLoggerConfigurationExtensionsTests
+    {
+        [Fact]
+        public void OutputFormattingIsIgnored()
+        {
+            using (var stream = new MemoryStream())
+            {
+                var sw = new StreamWriter(stream);
+
+                System.Console.SetOut(sw);
+                var config = new LoggerConfiguration()
+                    .WriteTo.Console(theme: AnsiConsoleTheme.Literate,
+                        applyThemeToRedirectedOutput: false);
+
+                var logger = config.CreateLogger();
+
+                logger.Error("test");
+                stream.Position = 0;
+
+                using (var streamReader = new StreamReader(stream))
+                {
+                    var result = streamReader.ReadToEnd();
+                    var controlCharacterCount = result.Count(c => Char.IsControl(c) && !Char.IsWhiteSpace(c));
+                    Assert.Equal(0, controlCharacterCount);
+                }
+            }
+        }
+        
+        [Fact]
+        public void OutputFormattingIsPresent()
+        {
+            using (var stream = new MemoryStream())
+            {
+                var sw = new StreamWriter(stream);
+
+                System.Console.SetOut(sw);
+                var config = new LoggerConfiguration()
+                    .WriteTo.Console(theme: AnsiConsoleTheme.Literate,
+                        applyThemeToRedirectedOutput: true);
+
+                var logger = config.CreateLogger();
+
+                logger.Error("test");
+                stream.Position = 0;
+
+                using (var streamReader = new StreamReader(stream))
+                {
+                    var result = streamReader.ReadToEnd();
+                    var controlCharacterCount = result.Count(c => Char.IsControl(c) && !Char.IsWhiteSpace(c));
+                    Assert.NotEqual(0, controlCharacterCount);
+                }
+            }
+        }
+    }
+}

test/Serilog.Sinks.Console.Tests/Output/OutputTemplateRendererTests.cs

@@ -143,7 +143,7 @@ public void DefaultLevelLengthIsFullText()
         }
 
         [Fact]
-        public void AligmentAndWidthCanBeCombined()
+        public void AlignmentAndWidthCanBeCombined()
         {
             var formatter = new OutputTemplateRenderer(ConsoleTheme.None, "{Level,5:w3}", CultureInfo.InvariantCulture);
             var evt = DelegatingSink.GetLogEvent(l => l.Information("Hello"));