(#140) Create initial test

Author: colinangusmackay

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

@@ -11,6 +11,7 @@
         <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
         <PackageReference Include="Shouldly" Version="4.2.1" />
+        <PackageReference Include="Verify.NUnit" Version="20.6.0" />
     </ItemGroup>
 
     <ItemGroup Condition=" '$(TargetFramework)' == 'net6.0' ">
@@ -28,6 +29,7 @@
     </ItemGroup>
 
     <ItemGroup>
+      <ProjectReference Include="..\Stravaig.Extensions.Logging.Diagnostics.Verify\Stravaig.Extensions.Logging.Diagnostics.Verify.csproj" />
       <ProjectReference Include="..\Stravaig.Extensions.Logging.Diagnostics.XUnit\Stravaig.Extensions.Logging.Diagnostics.XUnit.csproj" />
       <ProjectReference Include="..\Stravaig.Extensions.Logging.Diagnostics\Stravaig.Extensions.Logging.Diagnostics.csproj" />
     </ItemGroup>

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

@@ -0,0 +1,15 @@
+using System.Runtime.CompilerServices;
+using DiffEngine;
+using Stravaig.Extensions.Logging.Diagnostics.Verify;
+
+namespace Stravaig.Extensions.Logging.Diagnostics.Tests.Verify;
+
+public static class ModuleInitialiser
+{
+    [ModuleInitializer]
+    public static void InitVerifyStravaigLoggingCapture()
+    {
+        DiffTools.UseOrder(DiffTool.Rider, DiffTool.VisualStudioCode);
+        VerifyStravaigLoggingCapture.Initialise();
+    }
+}

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyDefaultSettingsTests.TestExplicitDefaultAsync.verified.txt

@@ -0,0 +1,38 @@
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyDefaultSettingsTests,
+    FormattedMessage: This is the first default log message
+  },
+  {
+    Sequence: 1,
+    LogLevel: Warning,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyDefaultSettingsTests,
+    FormattedMessage: This is a warning
+  },
+  {
+    Sequence: 2,
+    LogLevel: Error,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyDefaultSettingsTests,
+    FormattedMessage: An exception was thrown. See the exception for details.,
+    Exception: {
+      Message: I'm a fake exception to be put in the log.,
+      Type: System.ApplicationException
+    }
+  },
+  {
+    Sequence: 3,
+    LogLevel: Critical,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyDefaultSettingsTests,
+    FormattedMessage: An exception was thrown, which caused another exception to be thrown.,
+    Exception: {
+      Message: An application exception happened,
+      Type: System.ApplicationException,
+      InnerException: {
+        Message: An invalid operation happened.,
+        Type: System.InvalidOperationException
+      }
+    }
+  }
+]

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

@@ -0,0 +1,63 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+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 VerifyDefaultSettingsTests
+{
+    [Test]
+    public async Task TestExplicitDefaultAsync()
+    {
+        var settings = new VerifySettings().AddStravaigTests();
+        var logs = GetLogEntries();
+        await Verifier.Verify(logs, settings);
+    }
+
+    public async Task TestImplicitDefaultAwait()
+    {
+        // The settings are added as part of the module initialiser
+        var logs = GetLogEntries();
+        await Verifier.Verify(logs);
+    }
+
+    private IEnumerable<LogEntry> GetLogEntries()
+    {
+        var logger = new TestCaptureLogger<VerifyDefaultSettingsTests>();
+        logger.LogInformation("This is the first default log message");
+        logger.LogWarning("This is a warning");
+        try
+        {
+            throw new ApplicationException("I'm a fake exception to be put in the log.");
+        }
+        catch (Exception ex)
+        {
+            logger.LogError(ex, "An exception was thrown. See the exception for details.");
+        }
+
+        try
+        {
+            try
+            {
+                throw new InvalidOperationException("An invalid operation happened.");
+            }
+            catch (Exception ex)
+            {
+                throw new ApplicationException("An application exception happened", ex);
+            }
+        }
+        catch (Exception ex)
+        {
+            logger.LogCritical(ex, "An exception was thrown, which caused another exception to be thrown.");
+        }
+
+        return logger.GetLogs();
+    }
+}

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

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using VerifyTests;
 
@@ -28,6 +29,10 @@ private class Context
         internal bool IsWritingLogLevel => Using(Settings.LogLevel);
         internal bool IsWritingCategoryName => Using(Settings.CategoryName);
         internal bool IsWritingFormattedMessage => Using(Settings.FormattedMessage);
+        internal bool IsWritingException => Using(Settings.Exception);
+        internal bool IsWritingExceptionMessage => Using(Settings.ExceptionMessage);
+        internal bool IsWritingExceptionType => Using(Settings.ExceptionType);
+        internal bool IsWritingInnerException => Using(Settings.InnerException);
 
         internal int CurrentSequence(LogEntry logEntry) =>
             Using(Settings.KeepSequenceCadence)
@@ -69,6 +74,7 @@ public override void Write(VerifyJsonWriter writer, IEnumerable<LogEntry> logEnt
             WriteLogLevel(ctx, logEntry);
             WriteCategoryName(ctx, logEntry);
             WriteFormattedMessage(ctx, logEntry);
+            WriteException(ctx, logEntry);
 
             writer.WriteEndObject();
             ctx.MoveToNextLogEntry();
@@ -77,6 +83,40 @@ public override void Write(VerifyJsonWriter writer, IEnumerable<LogEntry> logEnt
         writer.WriteEndArray();
     }
 
+    private static void WriteException(Context ctx, LogEntry logEntry)
+    {
+        var ex = logEntry.Exception;
+        if (ex != null && ctx.IsWritingException)
+        {
+            ctx.Writer.WritePropertyName(nameof(logEntry.Exception));
+            WriteException(ctx, ex);
+        }
+    }
+
+    private static void WriteException(Context ctx, Exception ex)
+    {
+        ctx.Writer.WriteStartObject();
+        if (ctx.IsWritingExceptionMessage)
+        {
+            ctx.Writer.WritePropertyName(nameof(ex.Message));
+            ctx.Writer.WriteValue(ex.Message);
+        }
+
+        if (ctx.IsWritingExceptionType)
+        {
+            ctx.Writer.WritePropertyName(nameof(Type));
+            ctx.Writer.WriteValue(ex.GetType().FullName);
+        }
+
+        if (ex.InnerException != null && ctx.IsWritingInnerException)
+        {
+            ctx.Writer.WritePropertyName(nameof(ex.InnerException));
+            WriteException(ctx, ex.InnerException);
+        }
+
+        ctx.Writer.WriteEndObject();
+    }
+
     private static void WriteFormattedMessage(Context ctx, LogEntry logEntry)
     {
         if (ctx.IsWritingFormattedMessage)

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

@@ -41,13 +41,35 @@ public enum Settings
     /// </summary>
     FormattedMessage = 0x0000_0010,
 
+    /// <summary>
+    /// Indicates that the exception is to be written out, if it exists.
+    /// </summary>
+    Exception = 0x0000_0020,
+    
+    /// <summary>
+    /// Indicates that the exception type is to be written out.
+    /// </summary>
+    ExceptionType = 0x0000_0040,
+    
+    /// <summary>
+    /// Indicates that the exception message is to be written out.
+    /// </summary>
+    ExceptionMessage = 0x0000_0080,
+    
+    /// <summary>
+    /// Indicates that inner exceptions are to be written out.
+    /// </summary>
+    InnerException = 0x0000_0100,
+    
     /// <summary>
     /// Indicates the default settings are to be used.
     /// </summary>
-    Default = Sequence | LogLevel | CategoryName | FormattedMessage,
-}
-
-internal static class SettingsExtensions
-{
-   
+    Default = Sequence |
+              LogLevel |
+              CategoryName |
+              FormattedMessage |
+              Exception |
+              ExceptionType |
+              ExceptionMessage |
+              InnerException,
 }

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

@@ -0,0 +1,15 @@
+using VerifyTests;
+
+namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
+
+public static class VerifySettingsExtensions
+{
+    public static VerifySettings AddStravaigTests(this VerifySettings verifySettings)
+    {
+        verifySettings.AddExtraSettings(jsonSettings =>
+        {
+            jsonSettings.Converters.Add(new LogEntryConverter());
+        });
+        return verifySettings;
+    }
+}

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

@@ -1,8 +1,6 @@
 using System;
-using System.Text.Json;
 using Argon;
 using VerifyTests;
-using JsonSerializer = Argon.JsonSerializer;
 
 namespace Stravaig.Extensions.Logging.Diagnostics.Verify;
 

src/Stravaig.Extensions.Logging.Diagnostics.sln.DotSettings

@@ -2,5 +2,6 @@
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=LogMessageIsSentenceProblem/@EntryIndexedValue">DO_NOT_SHOW</s:String>
 	<s:Boolean x:Key="/Default/CodeInspection/Highlighting/RunLongAnalysisInSwa/@EntryValue">True</s:Boolean>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/SweaWarningsMode/@EntryValue">ShowAndRun</s:String>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Initialiser/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Shouldly/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Stravaig/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>