#140 Add tests and docs for Category Name

Author: colinangusmackay

docs/docs/library/verify-extensions.md

@@ -60,12 +60,17 @@ The verified output might look like this:
 ]
 ```
 
-The default settings emit 5 things - The Sequence number, the log level, the category name (usually the name of the class that generated the log), the message template, and the exception if it exists. The reson it doesn't emit the formatted message or exception message by default is that can be nondeterministic.
+The default settings emit 5 things: 
+* The Sequence number,
+* The log level,
+* The category name (usually the name of the class that generated the log),
+* The message template, and
+* the exception if it exists.
 
-Nondeterministic values in the verified file produce brittle tests, so the parts of the log most likely to be brittle are ommited by default. So things like the formatted message or exception messages are not shown unless explicitly requested.
+The reson it doesn't emit the formatted message or exception message by default is that can be nondeterministic. Nondeterministic values in the verified file produce brittle tests, so the parts of the log most likely to be brittle are ommited by default. Therefore, things like the formatted message or exception messages are not shown unless explicitly requested.
 
 ## How do I set up to verify the things I want?
 
 * Configure the [Sequence](verify/sequence.md)
-* Verify the [LogLevel](verify/loglevel.md)
-
+* Verify the [LogLevel](verify/log-level.md)
+* Verify the [CategoryName](verify/category-name.md)

docs/docs/library/verify/category-name.md

@@ -0,0 +1,84 @@
+---
+layout: default
+title: Verify Logs - Category Name
+---
+
+# Verifying the category name of log entries
+
+Typically the category name will be the name of the type where the logger is used. e.g.
+
+```csharp
+namespace MyApp.Services;
+
+public class MyService
+{
+    public MyService(ILogger<MyService> logger)
+    {
+        _logger = logger;
+    }
+
+    public void DoTheThing()
+    {
+        _logger.LogInformation("Doing the thing.");
+    }
+}
+```
+
+For the above code the category name would be `MyApp.Services.MyService`.
+
+## Configuring verifying the Category Name
+
+The default value is `true`.
+
+```csharp
+public async Task VerifyWarningLogsAreEmittedCorrectlyTestAsync()
+{
+    // ... Code that produces logs
+    
+    VerifySettings verifySettings = new VerifySettings()
+        .AddCapturedLogs(new LoggingCaptureVerifySettings()
+        {
+            CategoryName = true,
+        });
+
+    await Verifier.Verify(logs, verifySettings);
+}
+```
+
+### Example output
+
+#### CategoryName = true
+
+```
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyCategoryNameTests,
+    MessageTemplate: This is the first log. It is from the test class's category.
+  },
+  {
+    Sequence: 1,
+    LogLevel: Information,
+    CategoryName: custom-category-name,
+    MessageTemplate: This is the second log. It has a custom category name.
+  }
+]
+```
+
+#### CategoryName = false
+
+```
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    MessageTemplate: This is the first log. It is from the test class's category.
+  },
+  {
+    Sequence: 1,
+    LogLevel: Information,
+    MessageTemplate: This is the second log. It has a custom category name.
+  }
+]
+```

docs/docs/library/verify/loglevel.md renamed to docs/docs/library/verify/log-level.md

@@ -7,6 +7,8 @@ title: Verify Logs - Sequence
 
 The `LoggingCaptureVerifySettings` has a Boolean `LogLevel` property that defines if the log level is to be verified or not.
 
+The default value is `true`.
+
 ```csharp
 public async Task VerifyWarningLogsAreEmittedCorrectlyTestAsync()
 {

docs/docs/library/verify/sequence.md

@@ -10,6 +10,8 @@ The `LoggingCaptureVerifySettings` has a `Sequence` property that defines how th
 * `ShowAsConsecutive`: The sequence numbers increment consecutively in the verified files. i.e. 0, 1, 2, 3, 4, etc. regardless of whether any logs were filtered out.
 * `ShowAsCadence`: The sequence numbers maintain their cadence in the verified files. This allows you to see that there are skipped logs in the verified files that you are not verifying. Say the the original sequence is 25, 27, 32 then it will be verified as 0, 2, 7.
 
+The default value is `ShowAsConsecutive`
+
 ```csharp
 public async Task VerifyWarningLogsAreEmittedCorrectlyTestAsync()
 {

docs/scripts/contributors.md

@@ -2,17 +2,17 @@
 
 This is a list of all the contributors to this repository in ascending order by the contributor name.
 
-**Colin Mackay** contributed 352 commits from Saturday, 26 September, 2020 @ 20:26:19 +00:00 to Wednesday, 20 March, 2024 @ 22:53:33 +00:00.
+**Colin Mackay** contributed 353 commits from Saturday, 26 September, 2020 @ 20:26:19 +00:00 to Thursday, 21 March, 2024 @ 22:10:09 +00:00.
 
 **dependabot[bot]** contributed 59 commits from Wednesday, 14 October, 2020 @ 19:13:43 +00:00 to Monday, 26 February, 2024 @ 14:54:09 +00:00.
 
 **StravaigBot** contributed 28 commits from Monday, 14 December, 2020 @ 19:28:09 +00:00 to Tuesday, 27 February, 2024 @ 21:50:14 +00:00.
 
 ## Summary
 
-:octocat: 439 commits in total.
+:octocat: 440 commits in total.
 
 :date: From Saturday, 26 September, 2020 @ 20:26:19 +00:00.
 
-:date: Until Wednesday, 20 March, 2024 @ 22:53:33 +00:00.
+:date: Until Thursday, 21 March, 2024 @ 22:10:09 +00:00.
 

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyCategoryNameTests.VerifyCategoryNameAsync_setting=False.verified.txt

@@ -0,0 +1,12 @@
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    MessageTemplate: This is the first log. It is from the test class's category.
+  },
+  {
+    Sequence: 1,
+    LogLevel: Information,
+    MessageTemplate: This is the second log. It has a custom category name.
+  }
+]

src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyCategoryNameTests.VerifyCategoryNameAsync_setting=True.verified.txt

@@ -0,0 +1,14 @@
+[
+  {
+    Sequence: 0,
+    LogLevel: Information,
+    CategoryName: Stravaig.Extensions.Logging.Diagnostics.Tests.Verify.VerifyCategoryNameTests,
+    MessageTemplate: This is the first log. It is from the test class's category.
+  },
+  {
+    Sequence: 1,
+    LogLevel: Information,
+    CategoryName: custom-category-name,
+    MessageTemplate: This is the second log. It has a custom category name.
+  }
+]

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

@@ -0,0 +1,42 @@
+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 VerifyCategoryNameTests
+{
+    [Test]
+    [TestCase(true)]
+    [TestCase(false)]
+    public async Task VerifyCategoryNameAsync(bool setting)
+    {
+        var logs = GetLogs();
+        VerifySettings verifySettings = new VerifySettings()
+            .AddCapturedLogs(new LoggingCaptureVerifySettings()
+            {
+                CategoryName = setting,
+            });
+        verifySettings.UseParameters(setting);
+
+        await Verifier.Verify(logs, verifySettings);
+    }
+    
+    private IReadOnlyList<LogEntry> GetLogs()
+    {
+        var provider = new TestCaptureLoggerProvider();
+        LoggerFactory factory = new LoggerFactory([provider]);
+        ILogger logger = factory.CreateLogger<VerifyCategoryNameTests>();
+        logger.LogInformation("This is the first log. It is from the test class's category.");
+
+        logger = factory.CreateLogger("custom-category-name");
+        logger.LogInformation("This is the second log. It has a custom category name.");
+        
+        return provider.GetAllLogEntries();
+    }
+}