Merge pull request #76 from Stravaig-Projects/#75-all-connection-string-keys

Make structured connection string keys more concise

Author: colinangusmackay

release-notes/wip-release-notes.md

@@ -12,6 +12,7 @@ Date: ???
 * #35: Create Func matcher. Can now specify a predicate function that matches the key of secrets.
 * #42: Logging all connection strings now does so in a single log message.
 * #43: All logging is now using structured renderers.
+* #75: Make the connection string structured renderer keys more concise.
 
 ### Miscellaneous
 

src/Stravaig.Extensions.Configuration.Diagnostics.Tests/ConnectionStringLogTests.cs

@@ -173,6 +173,37 @@ public void LogAllConnectionStringsWithOneDodgyConnectionString(LogLevel level)
         [Test]
         [TestCaseSource(typeof(LogLevelSource))]
         public void LogAllConnectionStringsGoodConnectionString(LogLevel level)
+        {
+            var options = SetupGoodConnectionStringTest();
+            Logger.LogAllConnectionStrings(ConfigRoot, level, options);
+            ValidateGoodConnectionStringTest(level);
+        }
+        
+        [Test]
+        public void LogAllConnectionStringsAsInformationGoodConnectionString()
+        {
+            var options = SetupGoodConnectionStringTest();
+            Logger.LogAllConnectionStringsAsInformation(ConfigRoot, options);
+            ValidateGoodConnectionStringTest(LogLevel.Information);
+        }
+
+        [Test]
+        public void LogAllConnectionStringsAsDebugGoodConnectionString()
+        {
+            var options = SetupGoodConnectionStringTest();
+            Logger.LogAllConnectionStringsAsDebug(ConfigRoot, options);
+            ValidateGoodConnectionStringTest(LogLevel.Debug);
+        }
+
+        [Test]
+        public void LogAllConnectionStringsAsTraceGoodConnectionString()
+        {
+            var options = SetupGoodConnectionStringTest();
+            Logger.LogAllConnectionStringsAsTrace(ConfigRoot, options);
+            ValidateGoodConnectionStringTest(LogLevel.Trace);
+        }
+        
+        private ConfigurationDiagnosticsOptions SetupGoodConnectionStringTest()
         {
             SetupConfig(builder =>
             {
@@ -189,20 +220,26 @@ public void LogAllConnectionStringsGoodConnectionString(LogLevel level)
                 });
             });
             var options = SetupOptions();
-            Logger.LogAllConnectionStrings(ConfigRoot, level, options);
+            return options;
+        }
+
+        private void ValidateGoodConnectionStringTest(LogLevel level)
+        {
             var logs = GetLogs();
             logs.Count.ShouldBe(1);
             Console.WriteLine(logs[0].OriginalMessage);
             logs[0].LogLevel.ShouldBe(level);
             logs[0].FormattedMessage.ShouldContain("The following connection strings were found");
             logs[0].FormattedMessage.ShouldContain(SqlServerTrustedSecurityKey);
             logs[0].FormattedMessage.ShouldContain(SqlServerStandardSecurityKey);
-            
-            logs[0].OriginalMessage.ShouldContain("The following connection strings were found: {preamble_SqlServerStandardSecurity_name}, {preamble_SqlServerTrustedSecurity_name}.");
+
+            logs[0].OriginalMessage
+                .ShouldContain(
+                    "The following connection strings were found: {preamble_SqlServerStandardSecurity_name}, {preamble_SqlServerTrustedSecurity_name}.");
             logs[0].OriginalMessage.ShouldContain("Connection string (named {SqlServerTrustedSecurity_name}) parameters:");
             logs[0].OriginalMessage.ShouldContain("Connection string (named {SqlServerStandardSecurity_name}) parameters:");
         }
-
+        
         [Test]
         [TestCaseSource(typeof(LogLevelSource))]
         public void LogAllConnectionStringsWhenThereAreNone(LogLevel level)

src/Stravaig.Extensions.Configuration.Diagnostics.Tests/RegressionTests/ConnectionStringLoggingWithSerilogTests.cs

@@ -38,10 +38,8 @@ public void KeyValuesRenderedInMessageCorrectly()
 
 
             var properties = (JObject) logObject["Properties"];
-            properties.ShouldContainKey("Simple_database_key");
-            properties.ShouldContainKey("Simple_database_value");
-            properties.ShouldContainKey("Simple_server_key");
-            properties.ShouldContainKey("Simple_server_value");
+            properties.ShouldContainKey("Simple_database");
+            properties.ShouldContainKey("Simple_server");
         }
 
         private static ILogger<ConnectionStringLoggingWithSerilogTests> SetupLogger(StringWriter writer)

src/Stravaig.Extensions.Configuration.Diagnostics/Renderers/StructuredConnectionStringRenderer.cs

@@ -92,8 +92,7 @@ private void AddConnectionStringKeysAndValues(
                         ? options.Obfuscator.Obfuscate((string) builder[key])
                         : (string) builder[key];
 
-                messageTemplate.AppendLine($" * {Placeholder(name, key, nameof(key))} = {Placeholder(name, key, nameof(value))}");
-                args.Add(key);
+                messageTemplate.AppendLine($" * [{name}].[{key}] = {Placeholder(name, key)}");
                 args.Add(value);
             }
         }