#140: Add tests for message setting + docs

Author: colinangusmackay

docs/docs/library/verify-extensions.md

@@ -74,3 +74,4 @@ The reson it doesn't emit the formatted message or exception message by default
 * Configure the [Sequence](verify/sequence.md)
 * Verify the [LogLevel](verify/log-level.md)
 * Verify the [CategoryName](verify/category-name.md)
+* Verify the log [Message](verify/message.md)

docs/docs/library/verify/message.md

@@ -0,0 +1,69 @@
+---
+layout: default
+title: Verify Logs - Message Settings
+---
+
+# Verify the log message
+
+Typically, this is the most important part of the log entry. By default the message template is verified.
+
+There are three settings:
+* `None`: Does not verify the log message.
+* `Formatted`: Verifies the formatted log message with the values filled in. Depending on what the values are this may produce nondeterminisitc output.
+* `Template`: Verifies the log template.
+
+The default value is `Template`.
+
+```csharp
+public async Task VerifyWarningLogsAreEmittedCorrectlyTestAsync()
+{
+    // ... Code that produces logs
+    
+    VerifySettings verifySettings = new VerifySettings()
+        .AddCapturedLogs(new LoggingCaptureVerifySettings()
+        {
+            Message = MessageSetting.Formatted,
+        });
+
+    await Verifier.Verify(logs, verifySettings);
+}
+```
+
+## Example Output
+
+### None
+
+```
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests
+  }
+]
+```
+
+### Formatted
+```
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests,
+    FormattedMessage: This is a test of the Formatted message setting.
+  }
+]
+```
+
+### Template
+
+```
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests,
+    MessageTemplate: This is a test of the {SettingName} message setting.
+  }
+]
+```

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyMessageSettingTests.VerifyMessageSettingAsync_setting=Formatted.verified.txt

@@ -0,0 +1,16 @@
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests,
+    FormattedMessage: This is a test of the Formatted message setting.
+  },
+  {
+    Sequence: 1,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests,
+    FormattedMessage:
+This is a multiline log message.
+This is the second line of the message.
+  }
+]

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyMessageSettingTests.VerifyMessageSettingAsync_setting=None.verified.txt

@@ -0,0 +1,12 @@
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests
+  },
+  {
+    Sequence: 1,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests
+  }
+]

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyMessageSettingTests.VerifyMessageSettingAsync_setting=Template.verified.txt

@@ -0,0 +1,16 @@
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests,
+    MessageTemplate: This is a test of the {SettingName} message setting.
+  },
+  {
+    Sequence: 1,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyMessageSettingTests,
+    MessageTemplate:
+This is a multiline log message.
+This is the second line of the message.
+  }
+]

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

@@ -0,0 +1,35 @@
+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 VerifyMessageSettingTests
+{
+    [Test]
+    [TestCase(MessageSetting.None)]
+    [TestCase(MessageSetting.Formatted)]
+    [TestCase(MessageSetting.Template)]
+    public async Task VerifyMessageSettingAsync(MessageSetting setting)
+    {
+        var logger = new TestCaptureLogger<VerifyMessageSettingTests>();
+        logger.LogInformation("This is a test of the {SettingName} message setting.", setting);
+        logger.LogInformation("This is a multiline log message.\nThis is the second line of the message.");
+        var logs = logger.GetLogs();
+
+        VerifySettings verifySettings = new VerifySettings()
+            .AddCapturedLogs(new LoggingCaptureVerifySettings()
+            {
+                Message = setting,
+            });
+        verifySettings.UseParameters(setting);
+
+        await Verifier.Verify(logs, verifySettings);
+        
+    }
+}