(#140) Verify properties

Author: colinangusmackay

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogConverterSettingsTests.TestPropertiesAsync.verified.txt

@@ -0,0 +1,10 @@
+[
+  {
+    FormattedMessage: A message with 2 properties.,
+    Properties: {
+      {OriginalFormat}: A {TypeOfThing} with {PropertyCount} properties.,
+      PropertyCount: 2,
+      TypeOfThing: message
+    }
+  }
+]

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogConverterSettingsTests.cs

@@ -0,0 +1,22 @@
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using NUnit.Framework;
+using Stravaig.Extensions.Logging.Diagnostics.Verify;
+using VerifyNUnit;
+using VerifyTests;
+
+namespace Stravaig.Extensions.Logging.Diagnostics.Tests.Verify;
+
+[TestFixture]
+public class VerifyLogConverterSettingsTests
+{
+    [Test]
+    public async Task TestPropertiesAsync()
+    {
+        var logger = new TestCaptureLogger<VerifyLogConverterSettingsTests>();
+        logger.LogInformation("A {TypeOfThing} with {PropertyCount} properties.", "message", 2);
+        var settings = new VerifySettings()
+            .AddStravaigTests(Settings.FormattedMessage | Settings.Properties);
+        await Verifier.Verify(logger.GetLogs(), settings);
+    }
+}

src/Stravaig.Extensions.Logging.Diagnostics.Verify/LogEntryConverter.cs

@@ -1,27 +1,34 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.Linq;
 using VerifyTests;
 
 namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
 
 internal class LogEntryConverter : WriteOnlyJsonConverter<IEnumerable<LogEntry>>
 {
+    internal const string DefaultNonDeterministicPropertyValueSubstitute = "*** NONDETERMINISTIC ***";
     private readonly Settings _settings;
+    private readonly IReadOnlySet<string> _nonDeterministicPropertyNames;
+    private readonly string _nonDeterministicPropertyValueSubstitute;
 
     public LogEntryConverter()
-        : this(Settings.Default)
+        : this(Settings.Default, ImmutableHashSet<string>.Empty, DefaultNonDeterministicPropertyValueSubstitute)
     {
 
     }
 
-    public LogEntryConverter(Settings settings)
+    public LogEntryConverter(Settings settings, IReadOnlySet<string> nonDeterministicPropertyNames, string nonDeterministicPropertyValueSubstitute)
     {
         _settings = settings;
+        _nonDeterministicPropertyNames = nonDeterministicPropertyNames;
+        _nonDeterministicPropertyValueSubstitute = nonDeterministicPropertyValueSubstitute;
     }
 
     private class Context
     {
-        internal Settings Settings { get; }
+        private Settings Settings { get; }
         internal VerifyJsonWriter Writer { get; }
         private int _sequence;
         internal int CadenceOffset { get; set; }
@@ -35,6 +42,9 @@ private class Context
         internal bool IsWritingExceptionType => Using(Settings.ExceptionType);
         internal bool IsWritingInnerException => Using(Settings.InnerException);
         internal bool IsWritingStackTrace => Using(Settings.StackTrace);
+        internal bool IsWritingProperties => Using(Settings.Properties);
+        internal bool IsWritingMessageTemplate => Using(Settings.MessageTemplate);
+        internal bool HideNonDeterministicProperties => Using(Settings.HideNonDeterministicProperties);
 
         internal int CurrentSequence(LogEntry logEntry) =>
             Using(Settings.KeepSequenceCadence)
@@ -75,7 +85,9 @@ public override void Write(VerifyJsonWriter writer, IEnumerable<LogEntry> logEnt
             WriteSequence(ctx, logEntry);
             WriteLogLevel(ctx, logEntry);
             WriteCategoryName(ctx, logEntry);
+            WriteMessageTemplate(ctx, logEntry);
             WriteFormattedMessage(ctx, logEntry);
+            WriteProperties(ctx, logEntry);
             WriteException(ctx, logEntry);
 
             writer.WriteEndObject();
@@ -85,6 +97,37 @@ public override void Write(VerifyJsonWriter writer, IEnumerable<LogEntry> logEnt
         writer.WriteEndArray();
     }
 
+    private void WriteProperties(Context ctx, LogEntry logEntry)
+    {
+        if (ctx.IsWritingProperties)
+        {
+            ctx.Writer.WritePropertyName(nameof(Settings.Properties));
+            ctx.Writer.WriteStartObject();
+            foreach (var property in logEntry.Properties.OrderBy(p => p.Key))
+            {
+                bool isNonDeterministic = _nonDeterministicPropertyNames.Contains(property.Key);
+                if (isNonDeterministic && ctx.HideNonDeterministicProperties)
+                    continue;
+                ctx.Writer.WritePropertyName(property.Key);
+                
+                if (isNonDeterministic)
+                    ctx.Writer.WriteValue(_nonDeterministicPropertyValueSubstitute);
+                else
+                    ctx.Writer.WriteValue(property.Value);
+            }
+            ctx.Writer.WriteEndObject();
+        }
+    }
+
+    private void WriteMessageTemplate(Context ctx, LogEntry logEntry)
+    {
+        if (ctx.IsWritingMessageTemplate)
+        {
+            ctx.Writer.WritePropertyName(nameof(Settings.MessageTemplate));
+            ctx.Writer.WriteValue(logEntry.OriginalMessage);
+        }
+    }
+
     private static void WriteException(Context ctx, LogEntry logEntry)
     {
         var ex = logEntry.Exception;

src/Stravaig.Extensions.Logging.Diagnostics.Verify/Settings.cs

@@ -63,6 +63,12 @@ public enum Settings
 
     StackTrace = 0x0000_0200,
 
+    MessageTemplate = 0x0000_0400,
+    
+    Properties = 0x0000_0800,
+    
+    HideNonDeterministicProperties = 0x0000_1000,
+    
     /// <summary>
     /// Indicates the default settings are to be used.
     /// </summary>

src/Stravaig.Extensions.Logging.Diagnostics.Verify/VerifySettingsExtensions.cs

@@ -1,3 +1,7 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.Linq;
 using VerifyTests;
 
 namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
@@ -9,16 +13,19 @@ public static class VerifySettingsExtensions
     /// </summary>
     /// <param name="verifySettings">The verify settings object to modify.</param>
     /// <param name="settings">The settings for verifying the tests.</param>
+    /// <param name="nonDeterministicPropertyNames">A collection of property names to exclude from the output because their values are non-deterministic</param>
     /// <returns>The verify Settings object.</returns>
-    public static VerifySettings AddStravaigTests(this VerifySettings verifySettings, Settings settings = Settings.Default)
+    
+    public static VerifySettings AddStravaigTests(this VerifySettings verifySettings, Settings settings = Settings.Default, IEnumerable<string>? nonDeterministicPropertyNames = null, string nonDeterministicPropertyValueSubstitute = LogEntryConverter.DefaultNonDeterministicPropertyValueSubstitute)
     {
+        var nonDeterministicPropertySet = ImmutableHashSet.Create(StringComparer.Ordinal, nonDeterministicPropertyNames?.ToArray() ?? Array.Empty<string>());
         verifySettings.AddExtraSettings(jsonSettings =>
         {
             // Remove the default version if it exists.
             jsonSettings.Converters.RemoveAll(c => c is LogEntryConverter);
 
             // Create replacement converter.
-            var logEntryConverter = new LogEntryConverter(settings);
+            var logEntryConverter = new LogEntryConverter(settings, nonDeterministicPropertySet, nonDeterministicPropertyValueSubstitute);
             jsonSettings.Converters.Add(logEntryConverter);
         });
         return verifySettings;