Merge pull request #282 from ckadluba/refactor-SinkTraits

Completed unit tests for StandarrdColumnDataGenerator

Author: ckadluba

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/Dependencies/SinkDependenciesFactory.cs

@@ -26,7 +26,9 @@ internal static SinkDependencies Create(
                         sinkOptions.AzureServiceTokenProviderResource));
             var logEventDataGenerator =
                 new LogEventDataGenerator(columnOptions,
-                    new StandardColumnDataGenerator(columnOptions, formatProvider, logEventFormatter),
+                    new StandardColumnDataGenerator(columnOptions, formatProvider,
+                        new XmlPropertyFormatter(),
+                        logEventFormatter),
                     new PropertiesColumnDataGenerator(columnOptions));
 
             var sinkDependencies = new SinkDependencies

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/Output/IXmlPropertyFormatter.cs

@@ -0,0 +1,24 @@
+// Copyright 2020 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.Events;
+
+namespace Serilog.Sinks.MSSqlServer.Output
+{
+    internal interface IXmlPropertyFormatter
+    {
+        string GetValidElementName(string name);
+        string Simplify(LogEventPropertyValue value, ColumnOptions.PropertiesColumnOptions options);
+    }
+}

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/Output/StandardColumnDataGenerator.cs

@@ -14,18 +14,22 @@ internal class StandardColumnDataGenerator : IStandardColumnDataGenerator
     {
         private readonly ColumnOptions _columnOptions;
         private readonly IFormatProvider _formatProvider;
+        private readonly IXmlPropertyFormatter _xmlPropertyFormatter;
         private readonly ITextFormatter _logEventFormatter;
         private readonly ISet<string> _additionalColumnPropertyNames;
 
         public StandardColumnDataGenerator(
             ColumnOptions columnOptions,
             IFormatProvider formatProvider,
+            IXmlPropertyFormatter xmlPropertyFormatter,
             ITextFormatter logEventFormatter)
         {
             _columnOptions = columnOptions ?? throw new ArgumentNullException(nameof(columnOptions));
 
             _formatProvider = formatProvider;
 
+            _xmlPropertyFormatter = xmlPropertyFormatter ?? throw new ArgumentNullException(nameof(xmlPropertyFormatter));
+
             if (_columnOptions.Store.Contains(StandardColumn.LogEvent))
                 _logEventFormatter = logEventFormatter ?? new JsonLogEventFormatter(_columnOptions, this);
 
@@ -113,15 +117,15 @@ private string ConvertPropertiesToXmlStructure(IEnumerable<KeyValuePair<string,
 
             foreach (var property in properties)
             {
-                var value = XmlPropertyFormatter.Simplify(property.Value, options);
+                var value = _xmlPropertyFormatter.Simplify(property.Value, options);
                 if (options.OmitElementIfEmpty && string.IsNullOrEmpty(value))
                 {
                     continue;
                 }
 
                 if (options.UsePropertyKeyAsElementName)
                 {
-                    sb.AppendFormat(CultureInfo.InvariantCulture, "<{0}>{1}</{0}>", XmlPropertyFormatter.GetValidElementName(property.Key), value);
+                    sb.AppendFormat(CultureInfo.InvariantCulture, "<{0}>{1}</{0}>", _xmlPropertyFormatter.GetValidElementName(property.Key), value);
                 }
                 else
                 {

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/Output/XmlPropertyFormatter.cs

@@ -21,27 +21,13 @@
 
 namespace Serilog.Sinks.MSSqlServer.Output
 {
-    /// <summary>
-    ///     Converts <see cref="LogEventProperty" /> values into simple scalars,
-    ///     dictionaries and lists so that they can be persisted in MSSqlServer.
-    /// </summary>
-    internal static class XmlPropertyFormatter
+    internal class XmlPropertyFormatter : IXmlPropertyFormatter
     {
-        /// <summary>
-        /// Regex to trasnform any non-xml char into ?, acoiding any exceptions on inserting the xml properties into the database
-        /// </summary>
         private static readonly Regex _invalidXMLChars = new Regex(
             @"(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F\uFEFF\uFFFE\uFFFF]",
             RegexOptions.Compiled);
 
-        /// <summary>
-        ///     Simplify the object so as to make handling the serialized
-        ///     representation easier.
-        /// </summary>
-        /// <param name="value">The value to simplify (possibly null).</param>
-        /// <param name="options">Options to use during formatting</param>
-        /// <returns>A simplified representation.</returns>
-        public static string Simplify(LogEventPropertyValue value, ColumnOptions.PropertiesColumnOptions options)
+        public string Simplify(LogEventPropertyValue value, ColumnOptions.PropertiesColumnOptions options)
         {
             if (value is ScalarValue scalar)
                 return SimplifyScalar(scalar.Value);
@@ -183,7 +169,7 @@ public static string Simplify(LogEventPropertyValue value, ColumnOptions.Propert
             return null;
         }
 
-        public static string GetValidElementName(string name)
+        public string GetValidElementName(string name)
         {
             if (string.IsNullOrWhiteSpace(name))
             {

test/Serilog.Sinks.MSSqlServer.Tests/Sinks/MSSqlServer/Output/JsonLogEventFormatterTests.cs

@@ -23,7 +23,7 @@ public JsonLogEventFormatterTests()
             _testColumnOptions.Store.Add(StandardColumn.LogEvent);
 
             // TODO use mock for _testColumnsDataGenerator
-            _testStandardColumnDataGenerator = new StandardColumnDataGenerator(_testColumnOptions, formatProvider: null, logEventFormatter: null);
+            _testStandardColumnDataGenerator = new StandardColumnDataGenerator(_testColumnOptions, formatProvider: null, new XmlPropertyFormatter(), logEventFormatter: null);
 
             _sut = new JsonLogEventFormatter(_testColumnOptions, _testStandardColumnDataGenerator);
         }