(#140) WIP

Author: colinangusmackay

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

@@ -16,7 +16,8 @@ public class VerifyDefaultSettingsTests
     [Test]
     public async Task TestExplicitDefaultAsync()
     {
-        var settings = new VerifySettings().AddStravaigTests();
+        var settings = new VerifySettings()
+            .AddStravaigTests();
         var logs = GetLogEntries();
         await Verifier.Verify(logs, settings);
     }

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogExceptionTests.VerifyInnerExceptionsAsync.verified.txt

@@ -0,0 +1,32 @@
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyLogExceptionTests,
+    FormattedMessage: An Exception was thrown.,
+    Exception: {
+      Message: Current depth is 5.,
+      Type: System.ApplicationException,
+      InnerException: {
+        Message: Current depth is 4.,
+        Type: System.ApplicationException,
+        InnerException: {
+          Message: Current depth is 3.,
+          Type: System.ApplicationException,
+          InnerException: {
+            Message: Current depth is 2.,
+            Type: System.ApplicationException,
+            InnerException: {
+              Message: Current depth is 1.,
+              Type: System.ApplicationException,
+              InnerException: {
+                Message: This method throws exceptions!,
+                Type: System.InvalidOperationException
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+]

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

@@ -0,0 +1,48 @@
+using System;
+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 VerifyLogExceptionTests
+{
+    [Test]
+    public async Task VerifyInnerExceptionsAsync()
+    {
+        var logger = new TestCaptureLogger<VerifyLogExceptionTests>();
+        try
+        {
+            ThrowAnExceptionWithInnerExceptions(5);
+        }
+        catch (Exception ex)
+        {
+            logger.LogInformation(ex, "An Exception was thrown.");
+        }
+
+        var logs = logger.GetLogs();
+
+        VerifySettings verifySettings = new VerifySettings()
+            .AddStravaigTests(Settings.Default | Settings.StackTrace);
+        await Verifier.Verify(logs, verifySettings);
+    }
+
+    private void ThrowAnExceptionWithInnerExceptions(int depth = 1)
+    {
+        try
+        {
+            if (depth > 0)
+                ThrowAnExceptionWithInnerExceptions(depth - 1);
+        }
+        catch (Exception ex)
+        {
+            throw new ApplicationException($"Current depth is {depth}.", ex);
+        }
+
+        throw new InvalidOperationException($"This method throws exceptions!");
+    }
+}

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

@@ -34,6 +34,7 @@ private class Context
         internal bool IsWritingExceptionMessage => Using(Settings.ExceptionMessage);
         internal bool IsWritingExceptionType => Using(Settings.ExceptionType);
         internal bool IsWritingInnerException => Using(Settings.InnerException);
+        internal bool IsWritingStackTrace => Using(Settings.StackTrace);
 
         internal int CurrentSequence(LogEntry logEntry) =>
             Using(Settings.KeepSequenceCadence)
@@ -115,6 +116,12 @@ private static void WriteException(Context ctx, Exception ex)
             WriteException(ctx, ex.InnerException);
         }
 
+        if (ctx.IsWritingStackTrace)
+        {
+            ctx.Writer.WritePropertyName(nameof(ex.StackTrace));
+            ctx.Writer.WriteValue(ex.StackTrace);
+        }
+
         ctx.Writer.WriteEndObject();
     }
 

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

@@ -61,6 +61,8 @@ public enum Settings
     /// </summary>
     InnerException = 0x0000_0100,
 
+    StackTrace = 0x0000_0200,
+    
     /// <summary>
     /// Indicates the default settings are to be used.
     /// </summary>

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

@@ -4,11 +4,22 @@ namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
 
 public static class VerifySettingsExtensions
 {
-    public static VerifySettings AddStravaigTests(this VerifySettings 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>
+    /// <returns>The verify Settings object.</returns>
+    public static VerifySettings AddStravaigTests(this VerifySettings verifySettings, Settings settings = Settings.Default)
     {
         verifySettings.AddExtraSettings(jsonSettings =>
         {
-            jsonSettings.Converters.Add(new LogEntryConverter());
+            // Remove the default version if it exists.
+            jsonSettings.Converters.RemoveAll(c => c is LogEntryConverter);
+            
+            // Create replacement converter.
+            var logEntryConverter = new LogEntryConverter(settings);
+            jsonSettings.Converters.Add(logEntryConverter);
         });
         return verifySettings;
     }