Added a test for Configuration.Extensions.Hybrid,LoggerConfigurationMSSqlServerExtensions.

ckadluba · ckadluba · commit f7416914a9b3 · 2020-04-07T00:44:28.000+02:00
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Extensions/Hybrid/LoggerConfigurationMSSqlServerExtensions.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Extensions/Hybrid/LoggerConfigurationMSSqlServerExtensions.cs
@@ -71,7 +71,40 @@ public static LoggerConfiguration MSSqlServer(
             ColumnOptions columnOptions = null,
             IConfigurationSection columnOptionsSection = null,
             string schemaName = "dbo",
-            ITextFormatter logEventFormatter = null)
+            ITextFormatter logEventFormatter = null) =>
+            loggerConfiguration.MSSqlServerInternal(
+                connectionString: connectionString,
+                tableName: tableName,
+                appConfiguration: appConfiguration,
+                restrictedToMinimumLevel: restrictedToMinimumLevel,
+                batchPostingLimit: batchPostingLimit,
+                period: period,
+                formatProvider: formatProvider,
+                autoCreateSqlTable: autoCreateSqlTable,
+                columnOptions: columnOptions,
+                columnOptionsSection: columnOptionsSection,
+                schemaName: schemaName,
+                logEventFormatter: logEventFormatter,
+                applySystemConfiguration: new ApplySystemConfiguration(),
+                applyMicrosoftExtensionsConfiguration: new ApplyMicrosoftExtensionsConfiguration());
+
+        // Internal overload with parameters applySystemConfiguration and applyMicrosoftExtensionsConfiguration used by tests to inject mocks
+        internal static LoggerConfiguration MSSqlServerInternal(
+            this LoggerSinkConfiguration loggerConfiguration,
+            string connectionString,
+            string tableName,
+            IConfiguration appConfiguration = null,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
+            int batchPostingLimit = MSSqlServerSink.DefaultBatchPostingLimit,
+            TimeSpan? period = null,
+            IFormatProvider formatProvider = null,
+            bool autoCreateSqlTable = false,
+            ColumnOptions columnOptions = null,
+            IConfigurationSection columnOptionsSection = null,
+            string schemaName = "dbo",
+            ITextFormatter logEventFormatter = null,
+            IApplySystemConfiguration applySystemConfiguration = null,
+            IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration = null)
         {
             if (loggerConfiguration == null)
                 throw new ArgumentNullException(nameof(loggerConfiguration));
@@ -82,19 +115,17 @@ public static LoggerConfiguration MSSqlServer(
 
             if (ConfigurationManager.GetSection(AppConfigSectionName) is MSSqlServerConfigurationSection serviceConfigSection)
             {
-                var systemConfiguration = new ApplySystemConfiguration();
-                colOpts = systemConfiguration.ConfigureColumnOptions(serviceConfigSection, colOpts);
-                connStr = systemConfiguration.GetConnectionString(connStr);
+                colOpts = applySystemConfiguration.ConfigureColumnOptions(serviceConfigSection, colOpts);
+                connStr = applySystemConfiguration.GetConnectionString(connStr);
 
                 if (appConfiguration != null || columnOptionsSection != null)
                     SelfLog.WriteLine("Warning: Both System.Configuration (app.config or web.config) and Microsoft.Extensions.Configuration are being applied to the MSSQLServer sink.");
             }
 
             if (appConfiguration != null || columnOptionsSection != null)
             {
-                var microsoftExtensionsConfiguration = new ApplyMicrosoftExtensionsConfiguration();
-                connStr = microsoftExtensionsConfiguration.GetConnectionString(connStr, appConfiguration);
-                colOpts = microsoftExtensionsConfiguration.ConfigureColumnOptions(colOpts, columnOptionsSection);
+                connStr = applyMicrosoftExtensionsConfiguration.GetConnectionString(connStr, appConfiguration);
+                colOpts = applyMicrosoftExtensionsConfiguration.ConfigureColumnOptions(colOpts, columnOptionsSection);
             }
 
             return loggerConfiguration.Sink(
@@ -138,7 +169,36 @@ public static LoggerConfiguration MSSqlServer(
             ColumnOptions columnOptions = null,
             IConfigurationSection columnOptionsSection = null,
             string schemaName = "dbo",
-            ITextFormatter logEventFormatter = null)
+            ITextFormatter logEventFormatter = null) =>
+            loggerAuditSinkConfiguration.MSSqlServerInternal(
+                connectionString: connectionString,
+                tableName: tableName,
+                appConfiguration: appConfiguration,
+                restrictedToMinimumLevel: restrictedToMinimumLevel,
+                formatProvider: formatProvider,
+                autoCreateSqlTable: autoCreateSqlTable,
+                columnOptions: columnOptions,
+                columnOptionsSection: columnOptionsSection,
+                schemaName: schemaName,
+                logEventFormatter: logEventFormatter,
+                applySystemConfiguration: new ApplySystemConfiguration(),
+                applyMicrosoftExtensionsConfiguration: new ApplyMicrosoftExtensionsConfiguration());
+
+        // Internal overload with parameters applySystemConfiguration and applyMicrosoftExtensionsConfiguration used by tests to inject mocks
+        internal static LoggerConfiguration MSSqlServerInternal(
+            this LoggerAuditSinkConfiguration loggerAuditSinkConfiguration,
+            string connectionString,
+            string tableName,
+            IConfiguration appConfiguration = null,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
+            IFormatProvider formatProvider = null,
+            bool autoCreateSqlTable = false,
+            ColumnOptions columnOptions = null,
+            IConfigurationSection columnOptionsSection = null,
+            string schemaName = "dbo",
+            ITextFormatter logEventFormatter = null,
+            IApplySystemConfiguration applySystemConfiguration = null,
+            IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration = null)
         {
             if (loggerAuditSinkConfiguration == null)
                 throw new ArgumentNullException(nameof(loggerAuditSinkConfiguration));
@@ -148,19 +208,17 @@ public static LoggerConfiguration MSSqlServer(
 
             if (ConfigurationManager.GetSection(AppConfigSectionName) is MSSqlServerConfigurationSection serviceConfigSection)
             {
-                var systemConfiguration = new ApplySystemConfiguration();
-                colOpts = systemConfiguration.ConfigureColumnOptions(serviceConfigSection, colOpts);
-                connStr = systemConfiguration.GetConnectionString(connStr);
+                colOpts = applySystemConfiguration.ConfigureColumnOptions(serviceConfigSection, colOpts);
+                connStr = applySystemConfiguration.GetConnectionString(connStr);
 
                 if (appConfiguration != null || columnOptionsSection != null)
                     SelfLog.WriteLine("Warning: Both System.Configuration (app.config or web.config) and Microsoft.Extensions.Configuration are being applied to the MSSQLServer sink.");
             }
 
             if (appConfiguration != null || columnOptionsSection != null)
             {
-                var microsoftExtensionsConfiguration = new ApplyMicrosoftExtensionsConfiguration();
-                connStr = microsoftExtensionsConfiguration.GetConnectionString(connStr, appConfiguration);
-                colOpts = microsoftExtensionsConfiguration.ConfigureColumnOptions(colOpts, columnOptionsSection);
+                connStr = applyMicrosoftExtensionsConfiguration.GetConnectionString(connStr, appConfiguration);
+                colOpts = applyMicrosoftExtensionsConfiguration.ConfigureColumnOptions(colOpts, columnOptionsSection);
             }
 
             return loggerAuditSinkConfiguration.Sink(
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Extensions/System.Configuration/LoggerConfigurationMSSqlServerExtensions.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Extensions/System.Configuration/LoggerConfigurationMSSqlServerExtensions.cs
@@ -64,7 +64,7 @@ public static LoggerConfiguration MSSqlServer(
             ColumnOptions columnOptions = null,
             string schemaName = "dbo",
             ITextFormatter logEventFormatter = null) =>
-            loggerConfiguration.MSSqlServer(
+            loggerConfiguration.MSSqlServerInternal(
                 configSectionName: AppConfigSectionName,
                 connectionString,
                 tableName,
@@ -75,10 +75,11 @@ public static LoggerConfiguration MSSqlServer(
                 autoCreateSqlTable,
                 columnOptions,
                 schemaName,
-                logEventFormatter);
+                logEventFormatter,
+                new ApplySystemConfiguration());
 
-        // Internal overload with parameter configSectionName used by tests to override the config section
-        internal static LoggerConfiguration MSSqlServer(
+        // Internal overload with parameters configSectionName and applySystemConfiguration used by tests to override the config section and inject mock
+        internal static LoggerConfiguration MSSqlServerInternal(
             this LoggerSinkConfiguration loggerConfiguration,
             string configSectionName,
             string connectionString,
@@ -90,19 +91,19 @@ internal static LoggerConfiguration MSSqlServer(
             bool autoCreateSqlTable = false,
             ColumnOptions columnOptions = null,
             string schemaName = "dbo",
-            ITextFormatter logEventFormatter = null)
+            ITextFormatter logEventFormatter = null,
+            IApplySystemConfiguration applySystemConfiguration = null)
         {
             if (loggerConfiguration == null)
                 throw new ArgumentNullException(nameof(loggerConfiguration));
 
             var defaultedPeriod = period ?? MSSqlServerSink.DefaultPeriod;
             var colOpts = columnOptions ?? new ColumnOptions();
 
-            var systemConfiguration = new ApplySystemConfiguration();
             if (ConfigurationManager.GetSection(configSectionName) is MSSqlServerConfigurationSection serviceConfigSection)
-                colOpts = systemConfiguration.ConfigureColumnOptions(serviceConfigSection, colOpts);
+                colOpts = applySystemConfiguration.ConfigureColumnOptions(serviceConfigSection, colOpts);
 
-            connectionString = systemConfiguration.GetConnectionString(connectionString);
+            connectionString = applySystemConfiguration.GetConnectionString(connectionString);
 
             return loggerConfiguration.Sink(
                 new MSSqlServerSink(
@@ -145,7 +146,7 @@ public static LoggerConfiguration MSSqlServer(
             ColumnOptions columnOptions = null,
             string schemaName = "dbo",
             ITextFormatter logEventFormatter = null) =>
-            loggerAuditSinkConfiguration.MSSqlServer(
+            loggerAuditSinkConfiguration.MSSqlServerInternal(
                 configSectionName: AppConfigSectionName,
                 connectionString,
                 tableName,
@@ -154,10 +155,11 @@ public static LoggerConfiguration MSSqlServer(
                 autoCreateSqlTable,
                 columnOptions,
                 schemaName,
-                logEventFormatter);
+                logEventFormatter,
+                new ApplySystemConfiguration());
 
-        // Internal overload with parameter configSectionName used by tests to override the config section
-        internal static LoggerConfiguration MSSqlServer(
+        // Internal overload with parameters configSectionName and applySystemConfiguration used by tests to override the config section and inject mock
+        internal static LoggerConfiguration MSSqlServerInternal(
             this LoggerAuditSinkConfiguration loggerAuditSinkConfiguration,
             string configSectionName,
             string connectionString,
@@ -167,18 +169,18 @@ internal static LoggerConfiguration MSSqlServer(
             bool autoCreateSqlTable = false,
             ColumnOptions columnOptions = null,
             string schemaName = "dbo",
-            ITextFormatter logEventFormatter = null)
+            ITextFormatter logEventFormatter = null,
+            IApplySystemConfiguration applySystemConfiguration = null)
         {
             if (loggerAuditSinkConfiguration == null)
                 throw new ArgumentNullException(nameof(loggerAuditSinkConfiguration));
 
             var colOpts = columnOptions ?? new ColumnOptions();
 
-            var systemConfiguration = new ApplySystemConfiguration();
             if (ConfigurationManager.GetSection(configSectionName) is MSSqlServerConfigurationSection serviceConfigSection)
-                colOpts = systemConfiguration.ConfigureColumnOptions(serviceConfigSection, colOpts);
+                colOpts = applySystemConfiguration.ConfigureColumnOptions(serviceConfigSection, colOpts);
 
-            connectionString = systemConfiguration.GetConnectionString(connectionString);
+            connectionString = applySystemConfiguration.GetConnectionString(connectionString);
 
             return loggerAuditSinkConfiguration.Sink(
                 new MSSqlServerAuditSink(
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/Microsoft.Extensions.Configuration/ApplyMicrosoftExtensionsConfiguration.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/Microsoft.Extensions.Configuration/ApplyMicrosoftExtensionsConfiguration.cs
@@ -6,7 +6,7 @@ namespace Serilog.Sinks.MSSqlServer
     /// <summary>
     /// Configures the sink's connection string and ColumnOtions object.
     /// </summary>
-    internal class ApplyMicrosoftExtensionsConfiguration
+    internal class ApplyMicrosoftExtensionsConfiguration : IApplyMicrosoftExtensionsConfiguration
     {
         private readonly IMicrosoftExtensionsConnectionStringProvider _connectionStringProvider;
         private readonly IMicrosoftExtensionsColumnOptionsProvider _columnOptionsProvider;
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/Microsoft.Extensions.Configuration/IApplyMicrosoftExtensionsConfiguration.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/Microsoft.Extensions.Configuration/IApplyMicrosoftExtensionsConfiguration.cs
@@ -0,0 +1,10 @@
+﻿using Microsoft.Extensions.Configuration;
+
+namespace Serilog.Sinks.MSSqlServer
+{
+    internal interface IApplyMicrosoftExtensionsConfiguration
+    {
+        ColumnOptions ConfigureColumnOptions(ColumnOptions columnOptions, IConfigurationSection config);
+        string GetConnectionString(string nameOrConnectionString, IConfiguration appConfiguration);
+    }
+}
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/ApplySystemConfiguration.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/ApplySystemConfiguration.cs
@@ -6,7 +6,7 @@ namespace Serilog.Sinks.MSSqlServer
     /// <summary>
     /// Configures the sink's connection string and ColumnOtions object.
     /// </summary>
-    internal class ApplySystemConfiguration
+    internal class ApplySystemConfiguration : IApplySystemConfiguration
     {
         private readonly ISystemConfigurationConnectionStringProvider _connectionStringProvider;
         private readonly ISystemConfigurationColumnOptionsProvider _columnOptionsProvider;
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/IApplySystemConfiguration.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/IApplySystemConfiguration.cs
@@ -0,0 +1,10 @@
+﻿using Serilog.Configuration;
+
+namespace Serilog.Sinks.MSSqlServer
+{
+    internal interface IApplySystemConfiguration
+    {
+        ColumnOptions ConfigureColumnOptions(MSSqlServerConfigurationSection config, ColumnOptions columnOptions);
+        string GetConnectionString(string nameOrConnectionString);
+    }
+}
diff --git a/src/Serilog.Sinks.MSSqlServer/Serilog.Sinks.MSSqlServer.csproj b/src/Serilog.Sinks.MSSqlServer/Serilog.Sinks.MSSqlServer.csproj
@@ -79,6 +79,10 @@
     <Compile Include="Configuration\Implementations\System.Configuration\**\*.cs" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Remove="Configuration\Implementations\Microsoft.Extensions.Configuration\IApplyMicrosoftExtensionsConfiguration.cs" />
+  </ItemGroup>
+
   <ItemGroup>
     <None Include="Images\serilog-sink-nuget.png" Pack="true" PackagePath="" />
   </ItemGroup>
diff --git a/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Extensions/Hybrid/LoggerConfigurationMSSqlServerExtensionsTests.cs b/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Extensions/Hybrid/LoggerConfigurationMSSqlServerExtensionsTests.cs
@@ -0,0 +1,33 @@
+﻿using Microsoft.Extensions.Configuration;
+using Moq;
+using Xunit;
+
+namespace Serilog.Sinks.MSSqlServer.Tests.Configuration.Extensions.Hybrid
+{
+    public class LoggerConfigurationMSSqlServerExtensionsTests
+    {
+        [Fact]
+        public void MSSqlServerCallsApplyMicrosoftExtensionsConfigurationGetConnectionString()
+        {
+            // Arrange
+            const string connectionString = "TestConnectionString";
+            var loggerConfiguration = new LoggerConfiguration();
+            var applyMicrosoftExtensionsConfigurationMock = new Mock<IApplyMicrosoftExtensionsConfiguration>();
+            applyMicrosoftExtensionsConfigurationMock.Setup(c => c.GetConnectionString(It.IsAny<string>(), It.IsAny<IConfiguration>()))
+                .Returns(connectionString);
+            var appConfigurationMock = new Mock<IConfiguration>();
+            var columnOptionsSectionMock = new Mock<IConfigurationSection>();
+
+            // Act
+            loggerConfiguration.WriteTo.MSSqlServerInternal(
+                connectionString: connectionString,
+                tableName: "TestTableName",
+                appConfiguration: appConfigurationMock.Object,
+                columnOptionsSection: columnOptionsSectionMock.Object,
+                applyMicrosoftExtensionsConfiguration: applyMicrosoftExtensionsConfigurationMock.Object);
+
+            // Assert
+            applyMicrosoftExtensionsConfigurationMock.Verify(c => c.GetConnectionString(connectionString, appConfigurationMock.Object));
+        }
+    }
+}
diff --git a/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Extensions/System.Configuration/ConfigurationExtensionsTests.cs b/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Extensions/System.Configuration/ConfigurationExtensionsTests.cs
@@ -45,11 +45,12 @@ public void CustomStandardColumnNames()
             var standardNames = new List<string> { "CustomMessage", "CustomMessageTemplate", "CustomLevel", "CustomTimeStamp", "CustomException", "CustomProperties" };
 
             var loggerConfiguration = new LoggerConfiguration();
-            Log.Logger = loggerConfiguration.WriteTo.MSSqlServer(
+            Log.Logger = loggerConfiguration.WriteTo.MSSqlServerInternal(
                 configSectionName: "CustomStandardColumnNames",
                 connectionString: DatabaseFixture.LogEventsConnectionString,
                 tableName: DatabaseFixture.LogTableName,
-                autoCreateSqlTable: true)
+                autoCreateSqlTable: true,
+                applySystemConfiguration: new ApplySystemConfiguration())
                 .CreateLogger();
             Log.CloseAndFlush();
 
@@ -71,11 +72,12 @@ public void CustomStandardColumnNames()
         public void CustomizedColumnList()
         {
             var loggerConfiguration = new LoggerConfiguration();
-            Log.Logger = loggerConfiguration.WriteTo.MSSqlServer(
+            Log.Logger = loggerConfiguration.WriteTo.MSSqlServerInternal(
                 configSectionName: "CustomizedColumnList",
                 connectionString: DatabaseFixture.LogEventsConnectionString,
                 tableName: DatabaseFixture.LogTableName,
-                autoCreateSqlTable: true)
+                autoCreateSqlTable: true,
+                applySystemConfiguration: new ApplySystemConfiguration())
                 .CreateLogger();
             Log.CloseAndFlush();
 
diff --git a/test/Serilog.Sinks.MSSqlServer.Tests/Serilog.Sinks.MSSqlServer.Tests.csproj b/test/Serilog.Sinks.MSSqlServer.Tests/Serilog.Sinks.MSSqlServer.Tests.csproj
@@ -68,6 +68,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
+    <Compile Include="Configuration\Extensions\Hybrid\**\*.cs" />
     <Compile Include="Configuration\Extensions\Microsoft.Extensions.Configuration\**\*.cs" />
     <Compile Include="Configuration\Implementations\Microsoft.Extensions.Configuration\**\*.cs" />
     <Compile Include="Configuration\Implementations\System.Configuration\**\*.cs" />

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace Serilog.Sinks.MSSqlServer`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// Configures the sink's connection string and ColumnOtions object.`
`8`	`8`	`/// </summary>`
`9`		`- internal class ApplyMicrosoftExtensionsConfiguration`
	`9`	`+ internal class ApplyMicrosoftExtensionsConfiguration : IApplyMicrosoftExtensionsConfiguration`
`10`	`10`	`{`
`11`	`11`	`private readonly IMicrosoftExtensionsConnectionStringProvider _connectionStringProvider;`
`12`	`12`	`private readonly IMicrosoftExtensionsColumnOptionsProvider _columnOptionsProvider;`