Merge pull request #135 from Stravaig-Projects/#111-dots-bug-no-opt-out

Bug #111 Values not rendering if property key contains dots.

Author: colinangusmackay

release-notes/wip-release-notes.md

@@ -6,6 +6,8 @@ Date: ???
 
 ### Bugs
 
+- #111: Dots also get converted to underlines in structured keys.
+
 ### Features
 
 ### Miscellaneous

src/.editorconfig

@@ -16,7 +16,7 @@ guidelines=80 1px dotted 80FF00FF, 100 1px dashed B0FF0000, 120 2px solid FFFF00
 csharp_new_line_before_members_in_object_initializers=false
 csharp_preferred_modifier_order=public, private, protected, internal, new, abstract, virtual, sealed, override, static, readonly, extern, unsafe, volatile, async:suggestion
 csharp_style_var_elsewhere=true:suggestion
-csharp_style_var_for_built_in_types=true:suggestion
+csharp_style_var_for_built_in_types=false
 csharp_style_var_when_type_is_apparent=true:suggestion
 dotnet_style_parentheses_in_arithmetic_binary_operators=never_if_unnecessary:none
 dotnet_style_parentheses_in_other_binary_operators=never_if_unnecessary:none

src/Stravaig.Configuration.Diagnostics.Core/Renderers/Renderer.cs

@@ -8,7 +8,7 @@ namespace Stravaig.Configuration.Diagnostics.Renderers
     public abstract class Renderer
     {
         private const string PlaceholderPartJoin = "_";
-        
+
         /// <summary>
         /// Creates a safely named placeholder for use in structured renderers.
         /// </summary>
@@ -17,9 +17,9 @@ public abstract class Renderer
         protected string Placeholder(params string[] parts)
         {
             StringBuilder placeholderBuilder = new StringBuilder();
-            placeholderBuilder.Append("{");
+            placeholderBuilder.Append('{');
             int partPos = 0;
-            foreach (var part in parts)
+            foreach (string part in parts)
             {
                 if (string.IsNullOrWhiteSpace(part))
                     continue;
@@ -31,18 +31,18 @@ protected string Placeholder(params string[] parts)
                 foreach (char character in part)
                 {
                     if (charPos == 0 && character >= '0' && character <= '9')
-                        placeholderBuilder.Append("_");
-                    if (char.IsLetterOrDigit(character) || character == '.')
-                        placeholderBuilder.Append(character);
-                    else
-                        placeholderBuilder.Append("_");
+                        placeholderBuilder.Append('_');
+                    placeholderBuilder.Append(
+                        char.IsLetterOrDigit(character)
+                            ? character
+                            : '_');
                     charPos++;
                 }
 
                 partPos++;
             }
 
-            placeholderBuilder.Append("}");
+            placeholderBuilder.Append('}');
             return placeholderBuilder.ToString();
         }
     }

src/Stravaig.Configuration.Diagnostics.Tests/RegressionTests/DotsBugLoggerExtensionTests.cs

@@ -0,0 +1,38 @@
+using System.Collections.Generic;
+using Microsoft.Extensions.Configuration;
+using NUnit.Framework;
+using Shouldly;
+using Stravaig.Configuration.Diagnostics.Logging;
+
+namespace Stravaig.Extensions.Configuration.Diagnostics.Tests.RegressionTests
+{
+    [TestFixture]
+    public class DotsBugLoggerExtensionTests : LoggerExtensionsTestBase
+    {
+        [Test]
+        public void ConfigElementsWithDotsShouldRenderPropertiesInMessage()
+        {
+            SetupConfig(c =>
+            {
+                c.AddInMemoryCollection(new[]
+                {
+                    new KeyValuePair<string, string>("ItemA", "Alpha"),
+                    new KeyValuePair<string, string>("ItemB", "Beta"),
+                    new KeyValuePair<string, string>("ItemB.A", "Beta-Alpha"),
+                    new KeyValuePair<string, string>("ItemC", "Gamma"),
+                });
+            });
+            SetupLogger();
+
+            Logger.LogConfigurationValuesAsInformation(ConfigRoot);
+
+            var logs = GetLogs();
+            logs.Count.ShouldBe(1);
+            var log = logs[0];
+            log.FormattedMessage.ShouldContain("ItemC : Gamma");
+            log.FormattedMessage.ShouldContain("ItemB.A : Beta-Alpha");
+            log.FormattedMessage.ShouldContain("ItemB : Beta");
+            log.FormattedMessage.ShouldContain("ItemA : Alpha");
+        }
+    }
+}

src/Stravaig.Configuration.Diagnostics.Tests/RegressionTests/DotsBugSerilog.cs

@@ -0,0 +1,44 @@
+using System;
+using System.Collections.Generic;
+using Microsoft.Extensions.Configuration;
+using NUnit.Framework;
+using Shouldly;
+using Stravaig.Configuration.Diagnostics.Serilog;
+using Stravaig.Extensions.Configuration.Diagnostics.Tests.__Extensions;
+
+namespace Stravaig.Extensions.Configuration.Diagnostics.Tests.RegressionTests
+{
+    [TestFixture]
+    public class DotsBugSerilog : SerilogTestBase
+    {
+        [Test]
+        public void ConfigElementsWithDotsShouldRenderPropertiesInMessage()
+        {
+            SetupConfig(c =>
+            {
+                c.AddInMemoryCollection(new[]
+                {
+                    new KeyValuePair<string, string>("ItemA", "Alpha"),
+                    new KeyValuePair<string, string>("ItemB", "Beta"),
+                    new KeyValuePair<string, string>("ItemB.A", "Beta-Alpha"),
+                    new KeyValuePair<string, string>("ItemC", "Gamma"),
+                });
+            });
+            SetupLogger(true);
+
+            Logger.LogConfigurationValuesAsInformation(ConfigRoot);
+
+            var logs = GetLogs();
+            logs.Count.ShouldBe(1);
+            var log = logs[0];
+            
+            Console.WriteLine(log.GetMessage());
+            Console.WriteLine(log.GetMessageTemplate());            
+            
+            log.GetMessage().ShouldContain("ItemC : \"Gamma\"");
+            log.GetMessage().ShouldContain("ItemB.A : \"Beta-Alpha\"");
+            log.GetMessage().ShouldContain("ItemB : \"Beta\"");
+            log.GetMessage().ShouldContain("ItemA : \"Alpha\"");
+        }
+    }
+}

src/Stravaig.Configuration.Diagnostics.Tests/SerilogTestBase.cs

@@ -16,13 +16,16 @@ public abstract class SerilogTestBase : TestBase
         protected ILogger Logger;
         private StringBuilder _logStringBuilder;
         private TextWriter _logTextWriter;
-        protected void SetupLogger()
+        protected void SetupLogger(bool writeToConsole = false)
         {
             _logStringBuilder = new StringBuilder();
             _logTextWriter = new StringWriter(_logStringBuilder);
-            Logger = new LoggerConfiguration()
+            var loggerConfiguration = new LoggerConfiguration()
                 .WriteTo.TextWriter(new JsonFormatter(renderMessage: true), _logTextWriter)
-                .MinimumLevel.Verbose()
+                .MinimumLevel.Verbose();
+            if (writeToConsole)
+                loggerConfiguration = loggerConfiguration.WriteTo.Console();
+            Logger = loggerConfiguration
                 .CreateLogger();
         }
 

src/Stravaig.Configuration.Diagnostics.Tests/Stravaig.Configuration.Diagnostics.Tests.csproj

@@ -13,6 +13,7 @@
         <PackageReference Include="Serilog" Version="2.10.0" />
         <PackageReference Include="Serilog.Extensions.Logging" Version="3.0.1" />
         <PackageReference Include="Serilog.Formatting.Compact" Version="1.1.0" />
+        <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" /> 
         <PackageReference Include="Serilog.Sinks.TextWriter" Version="2.1.0" />
         <PackageReference Include="Shouldly" Version="4.0.3" />
         <PackageReference Include="Stravaig.Extensions.Logging.Diagnostics" Version="0.4.2" />

version.txt

@@ -1 +1 @@
-0.6.2
+0.7.0