diagnose test failure

Author: bart-vmware

src/Common/test/TestResources/FluentAssertionsExtensions.cs

@@ -18,18 +18,10 @@ public static class FluentAssertionsExtensions
         Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping
     };
 
-    /// <summary>
-    /// Asserts that a JSON-formatted string matches the specified JSON text, ignoring differences in insignificant whitespace and line endings. Using this
-    /// extension enables writing assertions on JSON in a more readable fashion.
-    /// </summary>
-    /// <param name="source">
-    /// The source JSON to assert on.
-    /// </param>
-    /// <param name="expected">
-    /// The expected JSON text.
-    /// </param>
     [CustomAssertion]
-    public static void BeJson(this StringAssertions source, string expected)
+#pragma warning disable S2360 // Optional parameters should not be used
+    public static void BeJson(this StringAssertions source, string expected, string? because = null)
+#pragma warning restore S2360 // Optional parameters should not be used
     {
         ArgumentNullException.ThrowIfNull(source);
         ArgumentNullException.ThrowIfNull(expected);
@@ -40,7 +32,7 @@ public static void BeJson(this StringAssertions source, string expected)
         string sourceText = ToJsonString(sourceJson);
         string expectedText = ToJsonString(expectedJson);
 
-        sourceText.Should().Be(expectedText);
+        sourceText.Should().Be(expectedText, because);
     }
 
     private static string ToJsonString(JsonDocument document)

src/Management/test/Endpoint.Test/Actuators/Info/InfoActuatorTest.cs

@@ -174,7 +174,7 @@ public async Task Endpoint_returns_expected_data(HostBuilderType hostBuilderType
                 "version": "{{AppFileVersion}}"
               }
             }
-            """);
+            """, responseBody);
     }
 
     [Fact]