Exposed parameter to pass collection instead of forcing reliance on singleton collection. Added unit tests. Updated documentation.

gowon · gowon · commit 1448b7f80056 · 2020-05-13T00:55:08.000-04:00
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 A Serilog sink that exposes a simple interface to retrieve and change LoggingLevelSwitches at runtime.
 
-## Using
+## Installing via NuGet
 
 To get started install the *Serilog.Sinks.DynamicSwitch* package:
 
@@ -18,10 +18,14 @@ PM> Install-Package Serilog.Sinks.DynamicSwitch
 or
 
 ```bash
-$ dotnet add package Serilog.Sinks.DynamicSwitch
+dotnet add package Serilog.Sinks.DynamicSwitch
 ```
 
-To start using the DynamicSwitch, the sink can be setup as follows:
+## Using
+
+### Setup sinks
+
+A DynamicSwitch sink can be set up in the standard way while constructing a `LoggerConfiguration`. A specific `LoggingLevelSwitchCollection` object can be passed to the configuration; if one is not specified, a static global collection is used that be referenced using `LoggingLevelSwitchCollection.Current`. Each DynamicSwitch must be uniquely named. The following is a simple example:
 
 ```csharp
 var logLevel = new LoggingLevelSwitch(LogEventLevel.Warning);
@@ -32,7 +36,7 @@ var log = new LoggerConfiguration()
     .CreateLogger();
 ```
 
-If using `appsettings.json` for configuration, the following example shows how to configure DynamicSwitch sinks:
+If using `appsettings.json` for configuration, the following example shows how to configure DynamicSwitch sinks along with attached level switches:
 
 ```javascript
 {
@@ -82,7 +86,9 @@ If using `appsettings.json` for configuration, the following example shows how t
 }
 ```
 
-Next, add the level switch collection to your services collection:
+#### Using Dependency Injection
+
+To support the retrieval of switches through dependency injection, there is a simple extention method to add the collection to the services container. If a collection is not passed, the global `LoggingLevelSwitchCollection.Current` will be added to the container:
 
 ```csharp
 .ConfigureServices((hostContext, services) =>
diff --git a/src/Serilog.Sinks.DynamicSwitch/DynamicSwitchSinkExtensions.cs b/src/Serilog.Sinks.DynamicSwitch/DynamicSwitchSinkExtensions.cs
@@ -14,10 +14,20 @@ public static LoggerConfiguration DynamicSwitch(
             string switchName,
             LoggingLevelSwitch levelSwitch,
             LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum)
+        {
+            return DynamicSwitch(configuration, null, switchName, levelSwitch, restrictedToMinimumLevel);
+        }
+
+        public static LoggerConfiguration DynamicSwitch(
+            this LoggerSinkConfiguration configuration,
+            LoggingLevelSwitchCollection collection,
+            string switchName,
+            LoggingLevelSwitch levelSwitch,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum)
         {
             configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
             levelSwitch = levelSwitch ?? throw new ArgumentNullException(nameof(levelSwitch));
-            var collection = LoggingLevelSwitchCollection.Current;
+            collection ??= LoggingLevelSwitchCollection.Current;
 
             if (!collection.TryAdd(switchName, levelSwitch))
             {
diff --git a/src/Serilog.Sinks.DynamicSwitch/Serilog.Sinks.DynamicSwitch.csproj b/src/Serilog.Sinks.DynamicSwitch/Serilog.Sinks.DynamicSwitch.csproj
@@ -4,7 +4,7 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <LangVersion>latest</LangVersion>
     <NoWarn>$(NoWarn);1591</NoWarn>
-    <Version>0.1.0</Version>
+    <Version>1.0.0</Version>
     <Authors>Gowon Patterson</Authors>
     <Description>A Serilog sink that exposes a simple interface to retrieve and change LoggingLevelSwitches at runtime.</Description>
     <Copyright>© Gowon Patterson. All rights reserved.</Copyright>
diff --git a/test/Serilog.Sinks.DynamicSwitch.Tests/DynamicSwitchSinkTests.cs b/test/Serilog.Sinks.DynamicSwitch.Tests/DynamicSwitchSinkTests.cs
@@ -1,21 +1,111 @@
 ﻿namespace Serilog.Sinks.DynamicSwitch.Tests
 {
+    using System;
+    using Core;
     using Events;
+    using Microsoft.Extensions.DependencyInjection;
+    using Support;
     using Xunit;
     using Xunit.Categories;
+    using static Support.LogEventHelper;
 
     public class DynamicSwitchSinkTests
     {
-        private const string SwitchName = "switch";
-        private const LogEventLevel LogLevel = LogEventLevel.Fatal;
+        [UnitTest]
+        [Fact]
+        public void AddMultipleDynamicSwitches()
+        {
+            const string switchName1 = "switch1";
+            const string switchName2 = "switch2";
+            var collection = new LoggingLevelSwitchCollection();
+            var logSwitch = new LoggingLevelSwitch(LogEventLevel.Error);
+            var logSwitch2 = new LoggingLevelSwitch(LogEventLevel.Debug);
+
+            var log = new LoggerConfiguration()
+                .WriteTo.DynamicSwitch(collection, switchName1, logSwitch)
+                .WriteTo.DynamicSwitch(collection, switchName2, logSwitch2)
+                .CreateLogger();
+
+            Assert.Equal(2, collection.Count);
+            Assert.Equal(LogEventLevel.Error, collection[switchName1].MinimumLevel);
+            Assert.Equal(LogEventLevel.Debug, collection[switchName2].MinimumLevel);
+        }
+
+        [UnitTest]
+        [Fact]
+        public void AddMultipleDynamicSwitches_ThrowOnDuplicateNameKey()
+        {
+            const string switchName = "switch";
+            var collection = new LoggingLevelSwitchCollection();
+            var logSwitch = new LoggingLevelSwitch(LogEventLevel.Error);
+            var logSwitch2 = new LoggingLevelSwitch(LogEventLevel.Debug);
+
+            Assert.Throws<ArgumentException>(() =>
+            {
+                new LoggerConfiguration()
+                    .WriteTo.DynamicSwitch(collection, switchName, logSwitch)
+                    .WriteTo.DynamicSwitch(collection, switchName, logSwitch2)
+                    .CreateLogger();
+            });
+        }
 
         [UnitTest]
         [Fact]
         public void ConstructDynamicSwitchSink()
         {
-            var sink = new DynamicSwitchSink(SwitchName);
+            const string switchName = "switch";
+            var sink = new DynamicSwitchSink(switchName);
+            Assert.Equal(sink.Name, switchName);
+        }
+
+        [UnitTest]
+        [Fact]
+        public void UseSingletonCollectionDependencyInjection()
+        {
+            const string switchName = "switch";
+            var logSwitch = new LoggingLevelSwitch(LogEventLevel.Verbose);
+
+            var log = new LoggerConfiguration()
+                .WriteTo.DynamicSwitch(switchName, logSwitch)
+                .CreateLogger();
+
+            var provider = new ServiceCollection()
+                .AddLoggingLevelSwitchCollection()
+                .BuildServiceProvider();
+
+            var collection = provider.GetRequiredService<LoggingLevelSwitchCollection>();
+
+            Assert.Equal(LoggingLevelSwitchCollection.Current, collection);
+            Assert.Single(collection);
+            Assert.Equal(LogEventLevel.Verbose, collection[switchName].MinimumLevel);
+        }
+
+        [UnitTest]
+        [Fact]
+        public void UpdateSwitchFromCollection_ChangeEmitBehavior()
+        {
+            const string switchName = "switch";
+            var collection = new LoggingLevelSwitchCollection();
+            var logSwitch = new LoggingLevelSwitch(LogEventLevel.Error);
+            var a = LogEvent(LogEventLevel.Error, null, "Hello, {Name}!", "Alice");
+            var b = LogEvent(LogEventLevel.Information, null, "Hello, {Name}!", "Bob");
+            var c = LogEvent(LogEventLevel.Warning, null, "Hello, {Name}!", "Charlie");
+
+            var log = new LoggerConfiguration()
+                .WriteTo.Sink(new DummyWithLevelSwitchSink(logSwitch), levelSwitch: logSwitch)
+                .WriteTo.DynamicSwitch(collection, switchName, logSwitch)
+                .CreateLogger();
+
+            log.Write(a);
+            Assert.Single(DummyWithLevelSwitchSink.Emitted);
+
+            log.Write(b);
+            Assert.Single(DummyWithLevelSwitchSink.Emitted);
+
+            collection[switchName].MinimumLevel = LogEventLevel.Debug;
 
-            Assert.Equal(sink.Name, SwitchName);
+            log.Write(c);
+            Assert.Equal(2, DummyWithLevelSwitchSink.Emitted.Count);
         }
     }
 }
diff --git a/test/Serilog.Sinks.DynamicSwitch.Tests/Serilog.Sinks.DynamicSwitch.Tests.csproj b/test/Serilog.Sinks.DynamicSwitch.Tests/Serilog.Sinks.DynamicSwitch.Tests.csproj
@@ -7,6 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.1.4" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.categories" Version="2.0.4" />
diff --git a/test/Serilog.Sinks.DynamicSwitch.Tests/Support/DummyWithLevelSwitchSink.cs b/test/Serilog.Sinks.DynamicSwitch.Tests/Support/DummyWithLevelSwitchSink.cs
@@ -0,0 +1,28 @@
+﻿namespace Serilog.Sinks.DynamicSwitch.Tests.Support
+{
+    using System;
+    using System.Collections.Generic;
+    using Core;
+    using Events;
+
+    public class DummyWithLevelSwitchSink : ILogEventSink
+    {
+        [ThreadStatic]
+        public static LoggingLevelSwitch ControlLevelSwitch;
+
+        [ThreadStatic]
+        // ReSharper disable ThreadStaticFieldHasInitializer
+        public static List<LogEvent> Emitted = new List<LogEvent>();
+        // ReSharper restore ThreadStaticFieldHasInitializer
+
+        public DummyWithLevelSwitchSink(LoggingLevelSwitch loggingControlLevelSwitch)
+        {
+            ControlLevelSwitch = loggingControlLevelSwitch;
+        }
+
+        public void Emit(LogEvent logEvent)
+        {
+            Emitted.Add(logEvent);
+        }
+    }
+}
diff --git a/test/Serilog.Sinks.DynamicSwitch.Tests/Support/LogEventHelper.cs b/test/Serilog.Sinks.DynamicSwitch.Tests/Support/LogEventHelper.cs
@@ -0,0 +1,33 @@
+﻿namespace Serilog.Sinks.DynamicSwitch.Tests.Support
+{
+    using System;
+    using System.Diagnostics.CodeAnalysis;
+    using Events;
+    using Xunit.Sdk;
+
+    [ExcludeFromCodeCoverage]
+    public static class LogEventHelper
+    {
+        public static LogEvent LogEvent(string messageTemplate, params object[] propertyValues)
+        {
+            return LogEvent(null, messageTemplate, propertyValues);
+        }
+
+        public static LogEvent LogEvent(Exception exception, string messageTemplate, params object[] propertyValues)
+        {
+            return LogEvent(LogEventLevel.Information, exception, messageTemplate, propertyValues);
+        }
+
+        public static LogEvent LogEvent(LogEventLevel level, Exception exception, string messageTemplate,
+            params object[] propertyValues)
+        {
+            var log = new LoggerConfiguration().CreateLogger();
+            if (!log.BindMessageTemplate(messageTemplate, propertyValues, out var template, out var properties))
+            {
+                throw new XunitException("Template could not be bound.");
+            }
+
+            return new LogEvent(DateTimeOffset.Now, level, exception, template, properties);
+        }
+    }
+}
