#140 Add Guid property tests

colinangusmackay · colinangusmackay · commit e061f1f25ff4 · 2024-10-26T23:00:01.000+01:00
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyDefaultSettingsTests.cs b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyDefaultSettingsTests.cs
@@ -1,5 +1,4 @@
 using System;
-using System.Collections;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogConverterSettingsTests.cs b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogConverterSettingsTests.cs
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.GuidProperties.DotNet6_0.received.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.GuidProperties.DotNet6_0.received.txt
@@ -0,0 +1,16 @@
+﻿[
+  {
+    FormattedMessage: Thing 40e4cfcb-2e13-4ce5-83dd-e2f1056fd173 is good.,
+    Properties: {
+      {OriginalFormat}: Thing {id} is good.,
+      id: Guid_1
+    }
+  },
+  {
+    FormattedMessage: Thing a3022d80-1726-488c-9dd6-7e588fe1311b is good too.,
+    Properties: {
+      {OriginalFormat}: Thing {id} is good too.,
+      id: Guid_2
+    }
+  }
+]
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.GuidProperties.verified.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.GuidProperties.verified.txt
@@ -0,0 +1 @@
+﻿
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.GuidProperties_scrubGuids=False.verified.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.GuidProperties_scrubGuids=False.verified.txt
@@ -0,0 +1,16 @@
+﻿[
+  {
+    FormattedMessage: Thing 40e4cfcb-2e13-4ce5-83dd-e2f1056fd173 is good.,
+    Properties: {
+      {OriginalFormat}: Thing {id} is good.,
+      id: 40e4cfcb-2e13-4ce5-83dd-e2f1056fd173
+    }
+  },
+  {
+    FormattedMessage: Thing a3022d80-1726-488c-9dd6-7e588fe1311b is good too.,
+    Properties: {
+      {OriginalFormat}: Thing {id} is good too.,
+      id: a3022d80-1726-488c-9dd6-7e588fe1311b
+    }
+  }
+]
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.GuidProperties_scrubGuids=True.verified.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.GuidProperties_scrubGuids=True.verified.txt
@@ -0,0 +1,16 @@
+﻿[
+  {
+    FormattedMessage: Thing 40e4cfcb-2e13-4ce5-83dd-e2f1056fd173 is good.,
+    Properties: {
+      {OriginalFormat}: Thing {id} is good.,
+      id: Guid_1
+    }
+  },
+  {
+    FormattedMessage: Thing a3022d80-1726-488c-9dd6-7e588fe1311b is good too.,
+    Properties: {
+      {OriginalFormat}: Thing {id} is good too.,
+      id: Guid_2
+    }
+  }
+]
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestPropertiesAsync.verified.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestPropertiesAsync.verified.txt
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestRedactedPropertiesAsync_setting=CaseInsensitivePropertyMatch.verified.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestRedactedPropertiesAsync_setting=CaseInsensitivePropertyMatch.verified.txt
@@ -0,0 +1,9 @@
+﻿[
+  {
+    FormattedMessage: This is shown: show me, this is redacted: hide me; and this might be redacted if case insensitive maybe hide me,
+    Properties: {
+      {OriginalFormat}: This is shown: {StandardProperty}, this is redacted: {NondeterministicProperty}; and this might be redacted if case insensitive {CaseDependentNondeterministicProperty},
+      StandardProperty: show me
+    }
+  }
+]
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestRedactedPropertiesAsync_setting=None.verified.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestRedactedPropertiesAsync_setting=None.verified.txt
@@ -0,0 +1,10 @@
+﻿[
+  {
+    FormattedMessage: This is shown: show me, this is redacted: hide me; and this might be redacted if case insensitive maybe hide me,
+    Properties: {
+      {OriginalFormat}: This is shown: {StandardProperty}, this is redacted: {NondeterministicProperty}; and this might be redacted if case insensitive {CaseDependentNondeterministicProperty},
+      CaseDependentNondeterministicProperty: maybe hide me,
+      StandardProperty: show me
+    }
+  }
+]
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestRedactedPropertiesAsync_setting=RedactNonDeterministic, CaseInsensitivePropertyMatch.verified.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestRedactedPropertiesAsync_setting=RedactNonDeterministic, CaseInsensitivePropertyMatch.verified.txt
@@ -0,0 +1,11 @@
+﻿[
+  {
+    FormattedMessage: This is shown: show me, this is redacted: hide me; and this might be redacted if case insensitive maybe hide me,
+    Properties: {
+      {OriginalFormat}: This is shown: {StandardProperty}, this is redacted: {NondeterministicProperty}; and this might be redacted if case insensitive {CaseDependentNondeterministicProperty},
+      CaseDependentNondeterministicProperty: *** Nondeterministic ***,
+      NondeterministicProperty: *** Nondeterministic ***,
+      StandardProperty: show me
+    }
+  }
+]
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestRedactedPropertiesAsync_setting=RedactNonDeterministic.verified.txt b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.TestRedactedPropertiesAsync_setting=RedactNonDeterministic.verified.txt
@@ -0,0 +1,11 @@
+﻿[
+  {
+    FormattedMessage: This is shown: show me, this is redacted: hide me; and this might be redacted if case insensitive maybe hide me,
+    Properties: {
+      {OriginalFormat}: This is shown: {StandardProperty}, this is redacted: {NondeterministicProperty}; and this might be redacted if case insensitive {CaseDependentNondeterministicProperty},
+      CaseDependentNondeterministicProperty: maybe hide me,
+      NondeterministicProperty: *** Nondeterministic ***,
+      StandardProperty: show me
+    }
+  }
+]
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.cs b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifyLogPropertyTests.cs
@@ -0,0 +1,83 @@
+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 VerifyLogPropertyTests
+{
+    [Test]
+    public async Task TestPropertiesAsync()
+    {
+        var logger = new TestCaptureLogger<VerifyLogPropertyTests>();
+        logger.LogInformation("A {TypeOfThing} with {PropertyCount} properties.", "message", 2);
+        var settings = new VerifySettings()
+            .AddCapturedLogs(new LoggingCaptureVerifySettings
+            {
+                Sequence = Sequence.Hide,
+                LogLevel = false,
+                CategoryName = false,
+                Message = MessageSetting.Formatted,
+                Properties = PropertySetting.Verify,
+            });
+        await Verifier.Verify(logger.GetLogs(), settings);
+    }
+    
+    [Test]
+    [TestCase(PropertySetting.None)]
+    [TestCase(PropertySetting.RedactNonDeterministic)]
+    [TestCase(PropertySetting.CaseInsensitivePropertyMatch)]
+    [TestCase(PropertySetting.CaseInsensitivePropertyMatch | PropertySetting.RedactNonDeterministic)]
+    public async Task TestRedactedPropertiesAsync(PropertySetting setting)
+    {
+        var logger = new TestCaptureLogger<VerifyLogPropertyTests>();
+        logger.LogInformation(
+            "This is shown: {StandardProperty}, this is redacted: {NondeterministicProperty}; and this might be redacted if case insensitive {CaseDependentNondeterministicProperty}",
+            "show me",
+            "hide me",
+            "maybe hide me");
+        var settings = new VerifySettings()
+            .AddCapturedLogs(new LoggingCaptureVerifySettings
+            {
+                Sequence = Sequence.Hide,
+                LogLevel = false,
+                CategoryName = false,
+                Message = MessageSetting.Formatted,
+                Properties = PropertySetting.Verify | setting,
+                NondeterministicPropertyNames = ["NondeterministicProperty", "caseDependentNondeterministicProperty"],
+            });
+        settings.UseParameters(setting);
+        await Verifier.Verify(logger.GetLogs(), settings);
+    }
+    
+    [Test]
+    [TestCase(true)]
+    [TestCase(false)]
+    public async Task GuidProperties(bool scrubGuids)
+    {
+        var id1 = new Guid("40e4cfcb-2e13-4ce5-83dd-e2f1056fd173");
+        var id2 = new Guid("a3022d80-1726-488c-9dd6-7e588fe1311b");
+        var logger = new TestCaptureLogger<VerifyLogPropertyTests>();
+        logger.LogInformation("Thing {id} is good.", id1);
+        logger.LogInformation("Thing {id} is good too.", id2);
+        var settings = new VerifySettings()
+            .AddCapturedLogs(new LoggingCaptureVerifySettings
+            {
+                Sequence = Sequence.Hide,
+                LogLevel = false,
+                CategoryName = false,
+                Message = MessageSetting.Formatted,
+                Properties = PropertySetting.Verify,
+                NondeterministicPropertyNames = ["ndId"],
+            });
+        settings.UseParameters(scrubGuids);
+        if (!scrubGuids)
+            settings.DontScrubGuids();
+        await Verifier.Verify(logger.GetLogs(), settings);
+    }
+}
diff --git a/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifySequenceTests.cs b/src/Stravaig.Extensions.Logging.Diagnostics.Tests/Verify/VerifySequenceTests.cs
@@ -39,7 +39,7 @@ public async Task CadenceSequenceTest(LogLevel minLevel)
     {
         var logs = GetLogs().Where(l => l.LogLevel >= minLevel);
         VerifySettings verifySettings = new VerifySettings()
-            .AddCapturedLogs(new LoggingCaptureVerifySettings()
+            .AddCapturedLogs(new LoggingCaptureVerifySettings
             {
                 Message = MessageSetting.Formatted,
                 Sequence = Sequence.ShowAsCadence,

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`using System;`
`2`		`-using System.Collections;`
`3`	`2`	`using System.Collections.Generic;`
`4`	`3`	`using System.Threading.Tasks;`
`5`	`4`	`using Microsoft.Extensions.Logging;`