Merge pull request #141 from sungam3r/audit

Add AuditTo support

Author: nblumhardt

src/Serilog.Sinks.Console/ConsoleAuditLoggerConfigurationExtensions.cs

@@ -0,0 +1,109 @@
+// Copyright 2017 Serilog Contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using Serilog.Configuration;
+using Serilog.Core;
+using Serilog.Events;
+using Serilog.Formatting;
+using Serilog.Sinks.SystemConsole;
+using Serilog.Sinks.SystemConsole.Output;
+using Serilog.Sinks.SystemConsole.Themes;
+using System;
+
+namespace Serilog
+{
+    /// <summary>
+    /// Adds the AuditTo.Console() extension method to <see cref="LoggerAuditSinkConfiguration"/>.
+    /// </summary>
+    public static class ConsoleAuditLoggerConfigurationExtensions
+    {
+        /// <summary>
+        /// Writes log events to <see cref="System.Console"/>.
+        /// </summary>
+        /// <param name="sinkConfiguration">Logger sink configuration.</param>
+        /// <param name="restrictedToMinimumLevel">The minimum level for
+        /// events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
+        /// <param name="outputTemplate">A message template describing the format used to write to the sink.
+        /// The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
+        /// <param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
+        /// will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
+        /// the lock is held.</param>
+        /// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
+        /// <param name="levelSwitch">A switch allowing the pass-through minimum level
+        /// to be changed at runtime.</param>
+        /// <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>
+        /// <exception cref="ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
+        /// <exception cref="ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
+        public static LoggerConfiguration Console(
+            this LoggerAuditSinkConfiguration sinkConfiguration,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
+            string outputTemplate = ConsoleLoggerConfigurationExtensions.DefaultConsoleOutputTemplate,
+            IFormatProvider? formatProvider = null,
+            LoggingLevelSwitch? levelSwitch = null,
+            LogEventLevel? standardErrorFromLevel = null,
+            ConsoleTheme? theme = null,
+            bool applyThemeToRedirectedOutput = false,
+            object? syncRoot = null)
+        {
+            if (sinkConfiguration is null) throw new ArgumentNullException(nameof(sinkConfiguration));
+            if (outputTemplate is null) throw new ArgumentNullException(nameof(outputTemplate));
+
+            var appliedTheme = !applyThemeToRedirectedOutput && (System.Console.IsOutputRedirected || System.Console.IsErrorRedirected) ?
+                ConsoleTheme.None :
+                theme ?? SystemConsoleThemes.Literate;
+
+            syncRoot ??= ConsoleLoggerConfigurationExtensions.DefaultSyncRoot;
+
+            var formatter = new OutputTemplateRenderer(appliedTheme, outputTemplate, formatProvider);
+            return sinkConfiguration.Sink(new ConsoleSink(appliedTheme, formatter, standardErrorFromLevel, syncRoot), restrictedToMinimumLevel, levelSwitch);
+        }
+
+        /// <summary>
+        /// Writes log events to <see cref="System.Console"/>.
+        /// </summary>
+        /// <param name="sinkConfiguration">Logger sink configuration.</param>
+        /// <param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
+        /// control plain text formatting, use the overload that accepts an output template.</param>
+        /// <param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
+        /// will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
+        /// the lock is held.</param>
+        /// <param name="restrictedToMinimumLevel">The minimum level for
+        /// events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
+        /// <param name="levelSwitch">A switch allowing the pass-through minimum level
+        /// to be changed at runtime.</param>
+        /// <param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
+        /// <returns>Configuration object allowing method chaining.</returns>
+        /// <exception cref="ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
+        /// <exception cref="ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
+        public static LoggerConfiguration Console(
+            this LoggerAuditSinkConfiguration sinkConfiguration,
+            ITextFormatter formatter,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
+            LoggingLevelSwitch? levelSwitch = null,
+            LogEventLevel? standardErrorFromLevel = null,
+            object? syncRoot = null)
+        {
+            if (sinkConfiguration is null) throw new ArgumentNullException(nameof(sinkConfiguration));
+            if (formatter is null) throw new ArgumentNullException(nameof(formatter));
+
+            syncRoot ??= ConsoleLoggerConfigurationExtensions.DefaultSyncRoot;
+
+            return sinkConfiguration.Sink(new ConsoleSink(ConsoleTheme.None, formatter, standardErrorFromLevel, syncRoot), restrictedToMinimumLevel, levelSwitch);
+        }
+    }
+}

src/Serilog.Sinks.Console/ConsoleLoggerConfigurationExtensions.cs

@@ -28,8 +28,8 @@ namespace Serilog
     /// </summary>
     public static class ConsoleLoggerConfigurationExtensions
     {
-        static readonly object DefaultSyncRoot = new object();
-        const string DefaultConsoleOutputTemplate = "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}";
+        internal static readonly object DefaultSyncRoot = new object();
+        internal const string DefaultConsoleOutputTemplate = "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}";
 
         /// <summary>
         /// Writes log events to <see cref="System.Console"/>.

test/Serilog.Sinks.Console.Tests/Approval/Serilog.Sinks.Console.approved.txt

@@ -1,5 +1,10 @@
 namespace Serilog
 {
+    public static class ConsoleAuditLoggerConfigurationExtensions
+    {
+        public static Serilog.LoggerConfiguration Console(this Serilog.Configuration.LoggerAuditSinkConfiguration sinkConfiguration, Serilog.Formatting.ITextFormatter formatter, Serilog.Events.LogEventLevel restrictedToMinimumLevel = 0, Serilog.Core.LoggingLevelSwitch? levelSwitch = null, Serilog.Events.LogEventLevel? standardErrorFromLevel = default, object? syncRoot = null) { }
+        public static Serilog.LoggerConfiguration Console(this Serilog.Configuration.LoggerAuditSinkConfiguration sinkConfiguration, Serilog.Events.LogEventLevel restrictedToMinimumLevel = 0, string outputTemplate = "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}", System.IFormatProvider? formatProvider = null, Serilog.Core.LoggingLevelSwitch? levelSwitch = null, Serilog.Events.LogEventLevel? standardErrorFromLevel = default, Serilog.Sinks.SystemConsole.Themes.ConsoleTheme? theme = null, bool applyThemeToRedirectedOutput = false, object? syncRoot = null) { }
+    }
     public static class ConsoleLoggerConfigurationExtensions
     {
         public static Serilog.LoggerConfiguration Console(this Serilog.Configuration.LoggerSinkConfiguration sinkConfiguration, Serilog.Formatting.ITextFormatter formatter, Serilog.Events.LogEventLevel restrictedToMinimumLevel = 0, Serilog.Core.LoggingLevelSwitch? levelSwitch = null, Serilog.Events.LogEventLevel? standardErrorFromLevel = default, object? syncRoot = null) { }

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

@@ -0,0 +1,64 @@
+using System;
+using System.IO;
+using System.Linq;
+using Xunit;
+using Serilog.Sinks.SystemConsole.Themes;
+
+namespace Serilog.Sinks.Console.Tests.Configuration
+{
+    [Collection("ConsoleSequentialTests")]
+    public class ConsoleAuditLoggerConfigurationExtensionsTests
+    {
+        [Fact]
+        public void OutputFormattingIsIgnored()
+        {
+            using (var stream = new MemoryStream())
+            {
+                var sw = new StreamWriter(stream);
+
+                System.Console.SetOut(sw);
+                var config = new LoggerConfiguration()
+                    .AuditTo.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()
+                    .AuditTo.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/Configuration/ConsoleLoggerConfigurationExtensionsTests.cs

@@ -6,6 +6,7 @@
 
 namespace Serilog.Sinks.Console.Tests.Configuration
 {
+    [Collection("ConsoleSequentialTests")]
     public class ConsoleLoggerConfigurationExtensionsTests
     {
         [Fact]