#140: Refactor (WIP)

Author: colinangusmackay

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

@@ -0,0 +1,17 @@
+using System;
+
+namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
+
+[Flags]
+public enum ExceptionSetting
+{
+    None = 0x0,
+    
+    Type = 0x1,
+    
+    Message = 0x2,
+    
+    StackTrace = 0x4,
+    
+    IncludeInnerExceptions = 0x8,
+}

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

@@ -8,22 +8,16 @@ 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;
+    private readonly LoggingCaptureVerifySettings _settings;
 
     public LogEntryConverter()
-        : this(Settings.Default, ImmutableHashSet<string>.Empty, DefaultNonDeterministicPropertyValueSubstitute)
+        : this(LoggingCaptureVerifySettings.Default)
     {
-        
     }
 
-    public LogEntryConverter(Settings settings, IReadOnlySet<string> nonDeterministicPropertyNames, string nonDeterministicPropertyValueSubstitute)
+    public LogEntryConverter(LoggingCaptureVerifySettings settings)
     {
         _settings = settings;
-        _nonDeterministicPropertyNames = nonDeterministicPropertyNames;
-        _nonDeterministicPropertyValueSubstitute = nonDeterministicPropertyValueSubstitute;
     }
 
     private class Context

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

@@ -0,0 +1,85 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.Linq;
+using Microsoft.Extensions.Logging;
+
+namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
+
+public class LoggingCaptureVerifySettings
+{
+    private const string DefaultNonDeterministicPropertyValueSubstitute = "*** NONDETERMINISTIC ***";
+
+    /// <summary>
+    /// The default settings for verifying captured logs. This is a reasonable
+    /// set of defaults that should not contain deterministic information.
+    /// </summary>
+    public static readonly LoggingCaptureVerifySettings Default = new();
+
+    private readonly PropertySetting _properties = PropertySetting.None;
+    private ImmutableHashSet<string> _nondeterministicPropertyNames = [];
+
+    /// <summary>
+    /// Gets how the Sequence number is to be verified.
+    /// Default is ShowAsConsecutive.
+    /// </summary>
+    public Sequence Sequence { get; init; } = Sequence.ShowAsConsecutive;
+
+    /// <summary>
+    /// Gets the minimum log level to be verified.
+    /// Default is to verify all (i.e. Trace and above.)
+    /// </summary>
+    public LogLevel MinLogLevel { get; init; } = LogLevel.Trace;
+
+    /// <summary>
+    /// Gets whether the category name is to be verified.
+    /// Default is true.
+    /// </summary>
+    public bool CategoryName { get; init; } = true;
+
+    /// <summary>
+    /// Gets how the message is to be verified.
+    /// Default is Template.
+    /// </summary>
+    public MessageSetting Message { get; init; } = MessageSetting.Template;
+
+    /// <summary>
+    /// Gets the parts of the exception to be verified if it exists.
+    /// Default is Type.
+    /// </summary>
+    public ExceptionSetting Exception { get; init; } = ExceptionSetting.Type;
+
+    /// <summary>
+    /// Gets how the properties from the log are to be verified.
+    /// Default is None.
+    /// </summary>
+    public PropertySetting Properties
+    {
+        get => _properties;
+        init
+        {
+            _properties = value;
+            BuildNondeterministicPropertySet(_nondeterministicPropertyNames);
+        }
+    }
+
+    /// <summary>
+    /// A list of property names that contain non-deterministic information.
+    /// </summary>
+    public IEnumerable<string> NondeterministicPropertyNames
+    {
+        get => _nondeterministicPropertyNames;
+        init => BuildNondeterministicPropertySet(value);
+    }
+    
+    /// <summary>
+    /// Gets the value to replace nondeterministic properties with.
+    /// </summary>
+    public string NondeterministicPropertySubstitute { get; init; } = "*** Nondeterministic ***";
+    
+    private void BuildNondeterministicPropertySet(IEnumerable<string> values)
+    {
+        _nondeterministicPropertyNames = values.ToImmutableHashSet((Properties & PropertySetting.CaseInsensitivePropertyMatch) == PropertySetting.CaseInsensitivePropertyMatch ? StringComparer.OrdinalIgnoreCase : StringComparer.Ordinal);
+    }
+
+}

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

@@ -0,0 +1,21 @@
+namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
+
+public enum MessageSetting
+{
+    /// <summary>
+    /// The message is not to be verified.
+    /// </summary>
+    None,
+    
+    /// <summary>
+    /// The formatted message is to be verified.
+    /// </summary>
+    /// <remarks>Formatted messages may contain non-deterministic information,
+    /// in which case this should not be used to prevent brittle tests.</remarks>
+    Formatted,
+    
+    /// <summary>
+    /// The message template is to be verified.
+    /// </summary>
+    Template,
+}

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

@@ -0,0 +1,34 @@
+using System;
+
+namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
+
+/// <summary>
+/// The settings for verifying properties.
+/// </summary>
+[Flags]
+public enum PropertySetting
+{
+    /// <summary>
+    /// The properties are not to be rendered.
+    /// </summary>
+    None = 0x0,
+    
+    /// <summary>
+    /// All property information is shown.
+    /// </summary>
+    /// <remarks>Any nondeterministic properties are ignored, unless
+    /// RedactNonDeterministic is also set.</remarks>
+    Verify = 0x1,
+    
+    /// <summary>
+    /// Nondeterministic properties are shown in a redacted form.
+    /// </summary>
+    /// <remarks>This will have no effect unless Verify is also set.</remarks>
+    RedactNonDeterministic = 0x2,
+    
+    /// <summary>
+    /// When determining property matched against the collection of
+    /// nondeterministic properties, use a case-insensitive check.
+    /// </summary>
+    CaseInsensitivePropertyMatch = 0x4,
+}

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

@@ -0,0 +1,26 @@
+namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
+
+/// <summary>
+/// Indicates the ways that a sequence can be rendered.
+/// </summary>
+public enum Sequence
+{
+    /// <summary>
+    /// Hides the sequence number.
+    /// </summary>
+    Hide,
+    
+    /// <summary>
+    /// Shows the sequence of the logs as a zero based consecutive sequence
+    /// (i.e. 0, 1, 2, 3...) regardless of the actual sequence number of the log
+    /// entry.
+    /// </summary>
+    ShowAsConsecutive,
+    
+    /// <summary>
+    /// Shows the sequence of the logs as a zero based sequence retaining the
+    /// cadence of the original logs. (e.g. the original sequence is 25, 27, 32
+    /// then it will be written as 0, 2, 7)
+    /// </summary>
+    ShowAsCadence,
+}

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

@@ -16,7 +16,7 @@
             Verify extensions for Stravaig Logging Capture for Tests.
         </Description>
         <Nullable>enable</Nullable>
-        <LangVersion>11</LangVersion>
+        <LangVersion>12</LangVersion>
         <RootNamespace>Stravaig.Extensions.Logging.Diagnostics.Verify</RootNamespace>
     </PropertyGroup>
 
@@ -28,7 +28,7 @@
     </ItemGroup>
 
     <ItemGroup>
-      <PackageReference Include="Verify" Version="22.11.1" />
+      <PackageReference Include="Verify" Version="23.5.2" />
     </ItemGroup>
 
     <ItemGroup>

src/Stravaig.Extensions.Logging.Diagnostics.Verify/Stravaig.Extensions.Logging.Diagnostics.Verify.csproj

@@ -1,33 +1,50 @@
-using System;
-using System.Collections.Generic;
-using System.Collections.Immutable;
-using System.Linq;
 using VerifyTests;
 
 namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
 
+/// <summary>
+/// Extension methods for configuring the captured logs verify settings.
+/// </summary>
 public static class VerifySettingsExtensions
 {
     /// <summary>
     /// Adds the settings required for verifying captured log entries using Stravaig Logging Diagnostics.
     /// </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, IEnumerable<string>? nonDeterministicPropertyNames = null, string nonDeterministicPropertyValueSubstitute = LogEntryConverter.DefaultNonDeterministicPropertyValueSubstitute)
+    /// <param name="settings">The settings for verifying the captured logs.</param>
+    public static VerifySettings AddCapturedLogs(this VerifySettings verifySettings, LoggingCaptureVerifySettings settings)
     {
-        var nonDeterministicPropertySet = ImmutableHashSet.Create(StringComparer.Ordinal, nonDeterministicPropertyNames?.ToArray() ?? Array.Empty<string>());
         verifySettings.AddExtraSettings(jsonSettings =>
         {
-            // Remove the default version if it exists.
+            // Removes the default version if it exists.
             jsonSettings.Converters.RemoveAll(c => c is LogEntryConverter);
-            
-            // Create replacement converter.
-            var logEntryConverter = new LogEntryConverter(settings, nonDeterministicPropertySet, nonDeterministicPropertyValueSubstitute);
+
+            var logEntryConverter = new LogEntryConverter(settings);
             jsonSettings.Converters.Add(logEntryConverter);
         });
         return verifySettings;
     }
+    
+    /// <summary>
+    /// Adds the settings required for verifying captured log entries using Stravaig Logging Diagnostics.
+    /// </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>
+    /// <param name="nonDeterministicPropertyValueSubstitute">The value to substitute to mask out non-deterministic property values.</param>
+    /// <returns>The verify Settings object.</returns>
+    // 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, nonDeterministicPropertySet, nonDeterministicPropertyValueSubstitute);
+    //         jsonSettings.Converters.Add(logEntryConverter);
+    //     });
+    //     return verifySettings;
+    // }
 }