Merge pull request #207 from Stravaig-Projects/#177/blank-entry-at-strat

177 Blank entry at the start causes subsequent entries to be skewed

Author: colinangusmackay

release-notes/wip-release-notes.md

@@ -6,21 +6,6 @@ Date: ???
 
 ### Bugs
 
-### Features
-
-### Miscellaneous
-
-### Dependent Packages
-
-- .NET 6.0
-  - No changes
-- .NET 5.0
-  - No changes
-- .NET Core 3.1
-  - No changes
-- General
-  - No changes
-
----
+- #177 : Fix serilog issue where it skews the config keys and values when there is a config key with an empty top-level path element.
 
 

src/Stravaig.Configuration.Diagnostics.AdHocTests/Stravaig.Configuration.Diagnostics.AdHocTests.csproj

@@ -4,6 +4,7 @@
         <TargetFrameworks>netcoreapp3.1;net5.0;net6.0</TargetFrameworks>
         <IsPackable>false</IsPackable>
         <RootNamespace>Stravaig.Extensions.Configuration.Diagnostics.AdHocTests</RootNamespace>
+        <LangVersion>10</LangVersion>
     </PropertyGroup>
 
     <ItemGroup Condition=" '$(TargetFramework)' == 'netcoreapp3.1' ">

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

@@ -28,6 +28,8 @@ public MessageEntry Render(IConfiguration configuration, ConfigurationDiagnostic
 
             foreach (var kvp in configKeyValues)
             {
+                if (string.IsNullOrWhiteSpace(kvp.Key))
+                    continue;
                 string configurationKeyPlaceholder = Placeholder(kvp.Key);
                 string potentiallyObfuscatedValue = Obfuscate(kvp, options);
 

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

@@ -0,0 +1,59 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.Extensions.Configuration;
+using NUnit.Framework;
+using Shouldly;
+using Stravaig.Configuration.Diagnostics.Logging;
+using Stravaig.Extensions.Logging.Diagnostics.Render;
+
+namespace Stravaig.Extensions.Configuration.Diagnostics.Tests.RegressionTests;
+
+[TestFixture]
+public class LoggingEmptyKeyConfigTests : LoggerExtensionsTestBase
+{
+    [Test]
+    public void TwoEmptyKeys()
+    {
+        SetupConfig(c =>
+        {
+            c.AddInMemoryCollection(new[]
+            {
+                new KeyValuePair<string, string>(":EmptyTopLevel", "The top level key is empty"),
+                new KeyValuePair<string, string>("A:Regular:Key", "This is a normal key"),
+            });
+        });
+        
+        Console.WriteLine("---Enumerate over the config values---");
+        var configValues = ConfigRoot.AsEnumerable()
+            .OrderBy(e => e.Key)
+            .ToArray();
+        foreach (var configElement in configValues)
+            Console.WriteLine($"[{configElement.Key}] = \"{configElement.Value}\"");
+        
+        Console.WriteLine("---Log output---");
+        SetupLogger();
+        Logger.LogConfigurationValuesAsInformation(ConfigRoot);
+
+        Console.WriteLine("---Captured log output---");
+        var logs = GetLogs();
+        logs.RenderLogs(Formatter.SimpleBySequence, Console.WriteLine);
+
+        logs.Count.ShouldBe(1);
+        var log = logs[0];
+        var properties = log.PropertyDictionary;
+        properties["_EmptyTopLevel"].ShouldBe("The top level key is empty");
+        properties["A_Regular_Key"].ShouldBe("This is a normal key");
+        var nullProperties = properties
+            .Where(p => p.Key is not ("_EmptyTopLevel" or "A_Regular_Key" or "{OriginalFormat}"))
+            .ToArray();
+        
+#if NET6_0_OR_GREATER
+        foreach(var nullProperty in nullProperties)
+            nullProperty.Value.ShouldBeNull($"Property \"{nullProperty.Key}\" should have a null value.");
+#else
+        foreach(var nullProperty in nullProperties)
+            nullProperty.Value.ShouldBe("(null)", $"Property \"{nullProperty.Key}\" should have a dummy null value.");
+#endif
+    }
+}

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

@@ -0,0 +1,56 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.Extensions.Configuration;
+using NUnit.Framework;
+using Shouldly;
+using Stravaig.Configuration.Diagnostics.Serilog;
+
+namespace Stravaig.Extensions.Configuration.Diagnostics.Tests.RegressionTests;
+
+[TestFixture]
+public class SerilogEmptyKeyConfigTests : SerilogTestBase
+{
+    [Test]
+    public void TwoEmptyKeys()
+    {
+        SetupConfig(c =>
+        {
+            c.AddInMemoryCollection(new[]
+            {
+                new KeyValuePair<string, string>(":EmptyTopLevel", "The top level key is empty"),
+                new KeyValuePair<string, string>("A:Regular:Key", "This is a normal key"),
+            });
+        });
+
+        Console.WriteLine("---Enumerate over the config values---");
+        var configValues = ConfigRoot.AsEnumerable()
+            .OrderBy(e => e.Key)
+            .ToArray();
+        foreach (var configElement in configValues)
+            Console.WriteLine($"[{configElement.Key}] = \"{configElement.Value}\"");
+
+        Console.WriteLine("---Log output---");
+        SetupLogger(true);
+        Logger.LogConfigurationValuesAsInformation(ConfigRoot);
+
+        Console.WriteLine("---JSON log output---");
+        var jsonLogs = GetLogs();
+        foreach (var logEntry in jsonLogs)
+            Console.WriteLine(logEntry);
+
+        jsonLogs.Count.ShouldBe(1);
+        var log = jsonLogs[0];
+        var properties = log["Properties"];
+        properties.Value<string>("_EmptyTopLevel").ShouldBe("The top level key is empty");
+        properties.Value<string>("A_Regular_Key").ShouldBe("This is a normal key");
+
+        var nullProperties = properties
+            .Select(p => p.Path.Split('.').Last())
+            .Where(p => p is not ("_EmptyTopLevel" or "A_Regular_Key"))
+            .ToArray();
+
+        foreach (var nullProperty in nullProperties)
+            properties.Value<string>(nullProperty).ShouldBeNull($"Property \"{nullProperty}\" should have a null value.");
+    }
+}

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

@@ -4,6 +4,7 @@
         <TargetFrameworks>netcoreapp3.1;net5.0;net6.0</TargetFrameworks>
         <IsPackable>false</IsPackable>
         <RootNamespace>Stravaig.Extensions.Configuration.Diagnostics.Tests</RootNamespace>
+        <LangVersion>10</LangVersion>
     </PropertyGroup>
 
     <ItemGroup>