Merge pull request #181 from Stravaig-Projects/#159/damaged-connection-string

#159: LogAllConnectionStrings message is corrupted on damaged connection string

Author: colinangusmackay

release-notes/wip-release-notes.md

@@ -8,6 +8,10 @@ Date: ???
 
 - #176: Add support for .NET 6.0
 
+### Bugs
+
+- #159: Fix for when multiple connection strings cannot be interpreted.Do you
+
 ### Dependent Packages
 
 - .NET 6.0

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

@@ -59,7 +59,7 @@ public MessageEntry Render(IConfiguration config, ConfigurationDiagnosticsOption
                     return new MessageEntry(
                         new AggregateException("Multiple errors occurred when rendering the connection strings.", exceptions),
                         messageTemplate.ToString(),
-                        properties);
+                        properties.ToArray());
             }
         }
     }

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

@@ -0,0 +1,39 @@
+using System;
+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 BadConnectionStringTests : LoggerExtensionsTestBase
+    {
+        [Test]
+        public void MultipleConnectionStringCannotBeInterpreted()
+        {
+            SetupConfig(c =>
+            {
+                c.AddInMemoryCollection(new[]
+                {
+                    new KeyValuePair<string, string>("ConnectionStrings:Bad1", "*** I'm the first placeholder, value to be filled in by another provider ***"),
+                    new KeyValuePair<string, string>("ConnectionStrings:Good", "server=TheServer;database=TheDatabase;userName=TheUserName;password=ThePassword"),
+                    new KeyValuePair<string, string>("ConnectionStrings:Bad2", "*** I'm the second placeholder, value to be filled in by another provider ***"),
+                });
+            });
+            SetupLogger();
+            
+            Logger.LogAllConnectionStringsAsInformation(ConfigRoot);
+            
+            var logs = GetLogs();
+            var log = logs[0];
+
+            log.Exception.ShouldBeOfType<AggregateException>();
+            ((AggregateException)log.Exception).InnerExceptions.Count.ShouldBe(2);
+            ((AggregateException)log.Exception).InnerExceptions.ShouldAllBe(e => e.GetType() == typeof(ArgumentException));
+            log.OriginalMessage.ShouldContain("The \"{Bad1_name}\" connection string value could not be interpreted as a connection string.");
+            log.OriginalMessage.ShouldContain("The \"{Bad2_name}\" connection string value could not be interpreted as a connection string.");
+        }
+    }
+}

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

@@ -16,7 +16,7 @@
         <PackageReference Include="Serilog.Sinks.Console" Version="4.0.0" /> 
         <PackageReference Include="Serilog.Sinks.TextWriter" Version="2.1.0" />
         <PackageReference Include="Shouldly" Version="4.0.3" />
-        <PackageReference Include="Stravaig.Extensions.Logging.Diagnostics" Version="1.1.3" />
+        <PackageReference Include="Stravaig.Extensions.Logging.Diagnostics" Version="1.2.0" />
         <PackageReference Include="Stravaig.Jailbreak" Version="0.1.0" />
     </ItemGroup>
 

version.txt

@@ -1 +1 @@
-1.0.5
+1.1.0