Assert exceptions with Verify instead of FluentAssertions

0xced · 0xced · commit 3306f9941c77 · 2024-12-19T21:50:35.000+01:00
Not sure it makes better / more readable tests. Also mutation tests score goes down from 100% to 96.91% (not investigated why)
diff --git a/tests/IndentationSettingsTest.IndentationSettingsToString_indentation=Space_size=2.verified.txt b/tests/IndentationSettingsTest.IndentationSettingsToString_indentation=Space_size=2.verified.txt
@@ -0,0 +1 @@
+﻿  
diff --git a/tests/IndentationSettingsTest.IndentationSettingsToString_indentation=Space_size=4.verified.txt b/tests/IndentationSettingsTest.IndentationSettingsToString_indentation=Space_size=4.verified.txt
@@ -0,0 +1 @@
+﻿    
diff --git a/tests/IndentationSettingsTest.IndentationSettingsToString_indentation=Tab_size=2.verified.txt b/tests/IndentationSettingsTest.IndentationSettingsToString_indentation=Tab_size=2.verified.txt
@@ -0,0 +1 @@
+﻿		
diff --git a/tests/IndentationSettingsTest.IndentationSettingsToString_indentation=Tab_size=4.verified.txt b/tests/IndentationSettingsTest.IndentationSettingsToString_indentation=Tab_size=4.verified.txt
@@ -0,0 +1 @@
+﻿				
diff --git a/tests/IndentationSettingsTest.InvalidIndentation.verified.txt b/tests/IndentationSettingsTest.InvalidIndentation.verified.txt
@@ -0,0 +1,11 @@
+﻿{
+  Type: ArgumentOutOfRangeException,
+  Message:
+The value of argument 'indentation' (-1) is invalid for enum type 'Indentation'. (Parameter 'indentation')
+Actual value was -1.,
+  ActualValue: -1,
+  ParamName: indentation,
+  StackTrace:
+at Serilog.Formatting.Log4Net.IndentationSettings..ctor(Indentation indentation, Byte size)
+at Serilog.Formatting.Log4Net.Tests.IndentationSettingsTest.<>c.<InvalidIndentation>b__1_0()
+}
diff --git a/tests/IndentationSettingsTest.InvalidSize.verified.txt b/tests/IndentationSettingsTest.InvalidSize.verified.txt
@@ -0,0 +1,11 @@
+﻿{
+  Type: ArgumentOutOfRangeException,
+  Message:
+The value of argument 'size' must be greater than 0. (Parameter 'size')
+Actual value was 0.,
+  ActualValue: 0,
+  ParamName: size,
+  StackTrace:
+at Serilog.Formatting.Log4Net.IndentationSettings..ctor(Indentation indentation, Byte size)
+at Serilog.Formatting.Log4Net.Tests.IndentationSettingsTest.<>c.<InvalidSize>b__2_0()
+}
diff --git a/tests/IndentationSettingsTest.cs b/tests/IndentationSettingsTest.cs
@@ -1,17 +1,17 @@
-using System;
-using FluentAssertions;
+using System.Threading.Tasks;
+using VerifyXunit;
 using Xunit;
 
 namespace Serilog.Formatting.Log4Net.Tests;
 
 public class IndentationSettingsTest
 {
     [Theory]
-    [InlineData(Indentation.Space, 2, "  ")]
-    [InlineData(Indentation.Tab, 2, "\t\t")]
-    [InlineData(Indentation.Space, 4, "    ")]
-    [InlineData(Indentation.Tab, 4, "\t\t\t\t")]
-    public void IndentationSettingsToString(Indentation indentation, byte size, string expectedString)
+    [InlineData(Indentation.Space, 2)]
+    [InlineData(Indentation.Tab, 2)]
+    [InlineData(Indentation.Space, 4)]
+    [InlineData(Indentation.Tab, 4)]
+    public Task IndentationSettingsToString(Indentation indentation, byte size)
     {
         // Arrange
         var indentationSettings = new IndentationSettings(indentation, size);
@@ -20,28 +20,18 @@ public void IndentationSettingsToString(Indentation indentation, byte size, stri
         var indentationString = indentationSettings.ToString();
 
         // Assert
-        indentationString.Should().Be(expectedString);
+        return Verifier.Verify(indentationString).UseParameters(indentation, size);
     }
 
     [Fact]
-    public void InvalidIndentation()
+    public Task InvalidIndentation()
     {
-        // Act
-        var action = () => new IndentationSettings((Indentation)(-1), size: 1);
-
-        // Assert
-        action.Should().ThrowExactly<ArgumentOutOfRangeException>()
-            .Which.Message.Should().StartWith("The value of argument 'indentation' (-1) is invalid for enum type 'Indentation'.");
+        return Verifier.Throws(() => new IndentationSettings((Indentation)(-1), size: 1));
     }
 
     [Fact]
-    public void InvalidSize()
+    public Task InvalidSize()
     {
-        // Act
-        var action = () => new IndentationSettings(indentation: default, size: 0);
-
-        // Assert
-        action.Should().ThrowExactly<ArgumentOutOfRangeException>()
-            .Which.Message.Should().StartWith("The value of argument 'size' must be greater than 0.");
+        return Verifier.Throws(() => new IndentationSettings(indentation: default, size: 0));
     }
 }
diff --git a/tests/LineEndingTest.InvalidLineEnding.verified.txt b/tests/LineEndingTest.InvalidLineEnding.verified.txt
@@ -0,0 +1,14 @@
+﻿{
+  Type: ArgumentOutOfRangeException,
+  Message:
+The value of argument 'lineEnding' (4) is invalid for enum type 'LineEnding'. (Parameter 'lineEnding')
+Actual value was 4.,
+  ActualValue: 4,
+  ParamName: lineEnding,
+  StackTrace:
+at Serilog.Formatting.Log4Net.LineEndingExtensions.ToCharacters(LineEnding lineEnding)
+at Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.CreateXmlWriterSettings(LineEnding lineEnding, IndentationSettings indentationSettings)
+at Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.Build()
+at Serilog.Formatting.Log4Net.Log4NetTextFormatter..ctor(Action`1 configureOptions)
+at Serilog.Formatting.Log4Net.Tests.LineEndingTest.<>c.<InvalidLineEnding>b__0_0()
+}
diff --git a/tests/LineEndingTest.cs b/tests/LineEndingTest.cs
@@ -1,17 +1,14 @@
-using System;
-using FluentAssertions;
+using System.Threading.Tasks;
+using VerifyXunit;
 using Xunit;
 
 namespace Serilog.Formatting.Log4Net.Tests;
 
 public class LineEndingTest
 {
     [Fact]
-    public void InvalidLineEnding()
+    public Task InvalidLineEnding()
     {
-        Action action = () => _ = new Log4NetTextFormatter(c => c.UseLineEnding((LineEnding)4));
-
-        action.Should().ThrowExactly<ArgumentOutOfRangeException>()
-            .WithMessage("The value of argument 'lineEnding' (4) is invalid for enum type 'LineEnding'.*");
+        return Verifier.Throws(() => _ = new Log4NetTextFormatter(c => c.UseLineEnding((LineEnding)4)));
     }
 }
diff --git a/tests/Log4NetTextFormatterTest.ExceptionFormatterThrowing.verified.txt b/tests/Log4NetTextFormatterTest.ExceptionFormatterThrowing.verified.txt
@@ -0,0 +1,8 @@
+﻿{
+  target: null,
+  SelfLog:
+[Serilog.Formatting.Log4Net.Log4NetTextFormatter] An exception was thrown while formatting an exception. Using the default exception formatter.
+System.InvalidOperationException: 💥 Boom 💥
+   at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c.<ExceptionFormatterThrowing>b__29_1(Exception _) in {ProjectDirectory}Log4NetTextFormatterTest.cs:line 466
+   at Serilog.Formatting.Log4Net.Log4NetTextFormatter.FormatException(Exception exception) in {SolutionDirectory}src/Log4NetTextFormatter.cs:line 424
+}
diff --git a/tests/Log4NetTextFormatterTest.FilterPropertyThrowing.verified.txt b/tests/Log4NetTextFormatterTest.FilterPropertyThrowing.verified.txt
@@ -0,0 +1,8 @@
+﻿{
+  target: null,
+  SelfLog:
+[Serilog.Formatting.Log4Net.Log4NetTextFormatter] An exception was thrown while filtering property 'two'. Including the property in the log4net event.
+System.InvalidOperationException: Can't handle property 'two'.
+   at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c.<FilterPropertyThrowing>b__24_1(LogEvent _, String propertyName) in {ProjectDirectory}Log4NetTextFormatterTest.cs:line 389
+   at Serilog.Formatting.Log4Net.Log4NetTextFormatter.IncludeProperty(LogEvent logEvent, String propertyName) in {SolutionDirectory}src/Log4NetTextFormatter.cs:line 266
+}
diff --git a/tests/Log4NetTextFormatterTest.InvalidLogEventLevelThrowsArgumentOutOfRangeException.verified.txt b/tests/Log4NetTextFormatterTest.InvalidLogEventLevelThrowsArgumentOutOfRangeException.verified.txt
@@ -0,0 +1,13 @@
+﻿{
+  Type: ArgumentOutOfRangeException,
+  Message:
+The value of argument 'level' (-1) is invalid for enum type 'LogEventLevel'. (Parameter 'level')
+Actual value was -1.,
+  ActualValue: -1,
+  ParamName: level,
+  StackTrace:
+at Serilog.Formatting.Log4Net.Log4NetTextFormatter.LogLevel(LogEventLevel level)
+at Serilog.Formatting.Log4Net.Log4NetTextFormatter.WriteEvent(LogEvent logEvent, XmlWriter writer)
+at Serilog.Formatting.Log4Net.Log4NetTextFormatter.Format(LogEvent logEvent, TextWriter output)
+at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c__DisplayClass9_0.<InvalidLogEventLevelThrowsArgumentOutOfRangeException>b__0()
+}
diff --git a/tests/Log4NetTextFormatterTest.NullLogEventThrowsArgumentNullException.verified.txt b/tests/Log4NetTextFormatterTest.NullLogEventThrowsArgumentNullException.verified.txt
@@ -0,0 +1,8 @@
+﻿{
+  Type: ArgumentNullException,
+  Message: Value cannot be null.,
+  ParamName: logEvent,
+  StackTrace:
+at Serilog.Formatting.Log4Net.Log4NetTextFormatter.Format(LogEvent logEvent, TextWriter output)
+at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c__DisplayClass4_0.<NullLogEventThrowsArgumentNullException>b__0()
+}
diff --git a/tests/Log4NetTextFormatterTest.NullOutputThrowsArgumentNullException.verified.txt b/tests/Log4NetTextFormatterTest.NullOutputThrowsArgumentNullException.verified.txt
@@ -0,0 +1,8 @@
+﻿{
+  Type: ArgumentNullException,
+  Message: Value cannot be null.,
+  ParamName: output,
+  StackTrace:
+at Serilog.Formatting.Log4Net.Log4NetTextFormatter.Format(LogEvent logEvent, TextWriter output)
+at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c__DisplayClass5_0.<NullOutputThrowsArgumentNullException>b__0()
+}
diff --git a/tests/Log4NetTextFormatterTest.SettingExceptionFormatterToNullThrowsArgumentNullException.verified.txt b/tests/Log4NetTextFormatterTest.SettingExceptionFormatterToNullThrowsArgumentNullException.verified.txt
@@ -0,0 +1,10 @@
+﻿{
+  Type: ArgumentNullException,
+  Message: The exception formatter can not be null.,
+  ParamName: formatException,
+  StackTrace:
+at Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.UseExceptionFormatter(ExceptionFormatter formatException)
+at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c.<SettingExceptionFormatterToNullThrowsArgumentNullException>b__7_1(Log4NetTextFormatterOptionsBuilder c)
+at Serilog.Formatting.Log4Net.Log4NetTextFormatter..ctor(Action`1 configureOptions)
+at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c.<SettingExceptionFormatterToNullThrowsArgumentNullException>b__7_0()
+}
diff --git a/tests/Log4NetTextFormatterTest.SettingPropertyFilterToNullThrowsArgumentNullException.verified.txt b/tests/Log4NetTextFormatterTest.SettingPropertyFilterToNullThrowsArgumentNullException.verified.txt
@@ -0,0 +1,10 @@
+﻿{
+  Type: ArgumentNullException,
+  Message: The property filter can not be null.,
+  ParamName: filterProperty,
+  StackTrace:
+at Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.UsePropertyFilter(PropertyFilter filterProperty)
+at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c.<SettingPropertyFilterToNullThrowsArgumentNullException>b__6_1(Log4NetTextFormatterOptionsBuilder c)
+at Serilog.Formatting.Log4Net.Log4NetTextFormatter..ctor(Action`1 configureOptions)
+at Serilog.Formatting.Log4Net.Tests.Log4NetTextFormatterTest.<>c.<SettingPropertyFilterToNullThrowsArgumentNullException>b__6_0()
+}
diff --git a/tests/Log4NetTextFormatterTest.cs b/tests/Log4NetTextFormatterTest.cs
@@ -4,7 +4,6 @@
 using System.IO;
 using System.Runtime.ExceptionServices;
 using System.Threading.Tasks;
-using FluentAssertions;
 using Serilog.Core;
 using Serilog.Events;
 using Serilog.Parsing;
@@ -16,9 +15,6 @@ namespace Serilog.Formatting.Log4Net.Tests;
 
 public sealed class Log4NetTextFormatterTest : IDisposable
 {
-    private readonly TextWriter _selfLogWriter;
-    private string? SelfLogValue => _selfLogWriter.ToString();
-
     /// <summary>
     /// Create a <see cref="DictionaryValue"/> containing two entries, mapping scalar values 1 to "one" and "two" to 2.
     /// </summary>
@@ -43,18 +39,19 @@ private static LogEvent CreateLogEvent(LogEventLevel level = Events.LogEventLeve
 
     public Log4NetTextFormatterTest()
     {
-        _selfLogWriter = new StringWriter();
-        Debugging.SelfLog.Enable(_selfLogWriter);
+        Recording.Start();
+        // Strip the SelfLog date prefix (29 characters)
+        Debugging.SelfLog.Enable(message => Recording.Add("SelfLog", message[29..]));
     }
 
     public void Dispose()
     {
         Debugging.SelfLog.Disable();
-        _selfLogWriter.Dispose();
+        Recording.Clear();
     }
 
     [Fact]
-    public void NullLogEventThrowsArgumentNullException()
+    public Task NullLogEventThrowsArgumentNullException()
     {
         // Arrange
         var formatter = new Log4NetTextFormatter();
@@ -63,12 +60,11 @@ public void NullLogEventThrowsArgumentNullException()
         var action = () => formatter.Format(null!, TextWriter.Null);
 
         // Assert
-        action.Should().ThrowExactly<ArgumentNullException>().WithParameterName("logEvent")
-            .Which.StackTrace!.TrimStart().Should().StartWith("at Serilog.Formatting.Log4Net.Log4NetTextFormatter.Format");
+        return Verifier.Throws(action);
     }
 
     [Fact]
-    public void NullOutputThrowsArgumentNullException()
+    public Task NullOutputThrowsArgumentNullException()
     {
         // Arrange
         var logEvent = CreateLogEvent();
@@ -78,32 +74,27 @@ public void NullOutputThrowsArgumentNullException()
         var action = () => formatter.Format(logEvent, null!);
 
         // Assert
-        action.Should().ThrowExactly<ArgumentNullException>().WithParameterName("output")
-            .Which.StackTrace!.TrimStart().Should().StartWith("at Serilog.Formatting.Log4Net.Log4NetTextFormatter.Format");
+        return Verifier.Throws(action);
     }
 
     [Fact]
-    public void SettingPropertyFilterToNullThrowsArgumentNullException()
+    public Task SettingPropertyFilterToNullThrowsArgumentNullException()
     {
         // Act
         Action action = () => _ = new Log4NetTextFormatter(c => c.UsePropertyFilter(null!));
 
         // Assert
-        action.Should().ThrowExactly<ArgumentNullException>()
-            .WithMessage("The property filter can not be null.*")
-            .And.ParamName.Should().Be("filterProperty");
+        return Verifier.Throws(action);
     }
 
     [Fact]
-    public void SettingExceptionFormatterToNullThrowsArgumentNullException()
+    public Task SettingExceptionFormatterToNullThrowsArgumentNullException()
     {
         // Act
         Action action = () => _ = new Log4NetTextFormatter(c => c.UseExceptionFormatter(null!));
 
         // Assert
-        action.Should().ThrowExactly<ArgumentNullException>()
-            .WithMessage("The exception formatter can not be null.*")
-            .And.ParamName.Should().Be("formatException");
+        return Verifier.Throws(action);
     }
 
     [Theory]
@@ -128,7 +119,7 @@ public Task LogEventLevel(LogEventLevel level)
     }
 
     [Fact]
-    public void InvalidLogEventLevelThrowsArgumentOutOfRangeException()
+    public Task InvalidLogEventLevelThrowsArgumentOutOfRangeException()
     {
         // Arrange
         var logEvent = CreateLogEvent((LogEventLevel)(-1));
@@ -138,8 +129,7 @@ public void InvalidLogEventLevelThrowsArgumentOutOfRangeException()
         var action = () => formatter.Format(logEvent, TextWriter.Null);
 
         // Assert
-        action.Should().ThrowExactly<ArgumentOutOfRangeException>()
-            .And.Message.Should().StartWith("The value of argument 'level' (-1) is invalid for enum type 'LogEventLevel'.");
+        return Verifier.Throws(action);
     }
 
     [Theory]
@@ -403,7 +393,6 @@ public Task FilterPropertyThrowing()
         formatter.Format(logEvent, output);
 
         // Assert
-        SelfLogValue.Should().Contain("[Serilog.Formatting.Log4Net.Log4NetTextFormatter] An exception was thrown while filtering property 'two'.");
         return Verify(output);
     }
 
@@ -480,7 +469,6 @@ public Task ExceptionFormatterThrowing()
         formatter.Format(logEvent, output);
 
         // Assert
-        SelfLogValue.Should().Contain("[Serilog.Formatting.Log4Net.Log4NetTextFormatter] An exception was thrown while formatting an exception.");
         return Verify(output);
     }
 
diff --git a/tests/Serilog.Formatting.Log4Net.Tests.csproj b/tests/Serilog.Formatting.Log4Net.Tests.csproj
@@ -7,7 +7,6 @@
 
   <ItemGroup>
     <PackageReference Include="coverlet.collector" Version="6.0.2" PrivateAssets="all" />
-    <PackageReference Include="FluentAssertions" Version="7.0.0" />
     <PackageReference Include="GitHubActionsTestLogger" Version="2.4.1" PrivateAssets="all" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageReference Include="PublicApiGenerator" Version="11.3.0" />

Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,14 @@`
`1`		`-using System;`
`2`		`-using FluentAssertions;`
	`1`	`+using System.Threading.Tasks;`
	`2`	`+using VerifyXunit;`
`3`	`3`	`using Xunit;`
`4`	`4`
`5`	`5`	`namespace Serilog.Formatting.Log4Net.Tests;`
`6`	`6`
`7`	`7`	`public class LineEndingTest`
`8`	`8`	`{`
`9`	`9`	`[Fact]`
`10`		`- public void InvalidLineEnding()`
	`10`	`+ public Task InvalidLineEnding()`
`11`	`11`	`{`
`12`		`- Action action = () => _ = new Log4NetTextFormatter(c => c.UseLineEnding((LineEnding)4));`
`13`		`-`
`14`		`- action.Should().ThrowExactly<ArgumentOutOfRangeException>()`
`15`		`- .WithMessage("The value of argument 'lineEnding' (4) is invalid for enum type 'LineEnding'.*");`
	`12`	`+ return Verifier.Throws(() => _ = new Log4NetTextFormatter(c => c.UseLineEnding((LineEnding)4)));`
`16`	`13`	`}`
`17`	`14`	`}`