v5.4.5 (#88)

- *Fixed:* Added `TesterBase.JsonMediaTypeNames` which provides a list of valid JSON media types to be used to determine JSON-related payloads in tests.
- *Fixed:* Added Xunit `ApiTestFixture.OnConfiguration` to enable configuration to be perform prior to test execution.

Author: chullybun

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Represents the **NuGet** versions.
 
+## v5.4.5
+- *Fixed:* Added `TesterBase.JsonMediaTypeNames` which provides a list of valid JSON media types to be used to determine JSON-related payloads in tests.
+- *Fixed:* Added Xunit `ApiTestFixture.OnConfiguration` to enable configuration to be perform prior to test execution.
+
 ## v5.4.4
 - *Fixed:* The `XunitLocalTestImplementor.SetLocalImplementor` has been made public.
 - *Fixed:* Added `TesterBase.ReplaceTestFrameworkImplementor` to enable dynamic replacement.

Common.targets

@@ -1,6 +1,6 @@
 <Project>
 	<PropertyGroup>
-		<Version>5.4.4</Version>
+		<Version>5.4.5</Version>
 		<LangVersion>preview</LangVersion>
 		<Authors>Avanade</Authors>
 		<Company>Avanade</Company>

src/UnitTestEx.Xunit/ApiTestFixture.cs

@@ -15,6 +15,16 @@ public class ApiTestFixture<TEntryPoint> : IDisposable where TEntryPoint : class
         private ApiTester<TEntryPoint>? _apiTester = ApiTester.Create<TEntryPoint>(() => new XunitLocalTestImplementor());
         private bool _disposed;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ApiTestFixture{TEntryPoint}"/> class.
+        /// </summary>
+        public ApiTestFixture() => OnConfiguration();
+
+        /// <summary>
+        /// Provides an opportunity to perform initial <see cref="Test"/> configuration before use.
+        /// </summary>
+        protected virtual void OnConfiguration() { }
+
         /// <summary>
         /// Gets the shared <see cref="ApiTester{TEntryPoint}"/> for testing.
         /// </summary>

src/UnitTestEx/Abstractions/TesterBase.cs

@@ -51,6 +51,11 @@ static TesterBase()
             }
         }
 
+        /// <summary>
+        /// Gets the default JSON media type names used for JSON serialization/deserialization.
+        /// </summary>
+        public static string[] JsonMediaTypeNames { get; set; } = [MediaTypeNames.Application.Json, "application/json-patch+json", "application/problem+json", "application/merge-patch+json"];
+
         /// <summary>
         /// Initializes a new instance of the <see cref="TesterBase"/> class.
         /// </summary>
@@ -248,7 +253,7 @@ internal void LogHttpResponseMessage(HttpResponseMessage res, Stopwatch? sw)
 
             object? jo = null;
             var content = res.Content.ReadAsStringAsync().GetAwaiter().GetResult();
-            if (!string.IsNullOrEmpty(content) && res.Content?.Headers?.ContentType?.MediaType == MediaTypeNames.Application.Json)
+            if (!string.IsNullOrEmpty(content) && JsonMediaTypeNames.Contains(res.Content?.Headers?.ContentType?.MediaType))
             {
                 try
                 {

src/UnitTestEx/Assertors/ActionResultAssertor.cs

@@ -9,6 +9,7 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Net.Mime;
@@ -332,7 +333,7 @@ internal ActionResultAssertor AssertContentResult<TValue>(TValue expectedValue,
             AssertResultType<ContentResult>();
 
             var cr = (ContentResult)Result;
-            if (expectedValue != null && cr.Content != null && cr.ContentType == MediaTypeNames.Application.Json)
+            if (expectedValue != null && cr.Content != null && TesterBase.JsonMediaTypeNames.Contains(cr.ContentType))
                 return AssertValue(expectedValue, JsonSerializer.Deserialize<TValue>(cr.Content)!, pathsToIgnore);
             else
                 return AssertValue(expectedValue, cr.Content!, pathsToIgnore);

src/UnitTestEx/Assertors/HttpResponseMessageAssertor.cs

@@ -2,6 +2,7 @@
 
 using Microsoft.Net.Http.Headers;
 using System;
+using System.Linq;
 using System.Net.Http;
 using System.Net.Mime;
 using UnitTestEx.Abstractions;
@@ -79,7 +80,7 @@ public HttpResponseMessageAssertor AssertValue<TValue>(TValue? expectedValue, pa
                 return this;
             }
 
-            if (Response.Content.Headers?.ContentType?.MediaType == MediaTypeNames.Application.Json)
+            if (TesterBase.JsonMediaTypeNames.Contains(Response.Content.Headers?.ContentType?.MediaType))
             {
                 var json = Response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
                 if (expectedValue == null)

src/UnitTestEx/Mocking/MockHttpClientRequest.cs

@@ -186,35 +186,26 @@ private bool RequestPredicate(HttpRequestMessage request)
 
             var body = request.Content!.ReadAsStringAsync().GetAwaiter().GetResult();
 
-            switch (_mediaType.ToLowerInvariant())
+            if (TesterBase.JsonMediaTypeNames.Contains(_mediaType.ToLowerInvariant()))
             {
-                // Deserialize the JSON and compare.
-                case MediaTypeNames.Application.Json:
-                    try
-                    {
-                        var content = _content is string cstring ? cstring : JsonSerializer.Serialize(_content);
-                        var options = JsonComparerOptions.Clone();
-                        options.JsonSerializer ??= JsonSerializer;
-                        var jcr = new JsonElementComparer(options).Compare(content, body, _pathsToIgnore);
-                        if (jcr.HasDifferences && _traceRequestComparisons)
-                            Implementor.WriteLine($"UnitTestEx > Mismatched HTTP request {request.Method} {request.RequestUri} mocked vs actual trace comparison differences:{Environment.NewLine}{jcr}");
-
-                        return jcr.AreEqual;
-                    }
-                    catch
-                    {
-                        return false;
-                    }
-
-                // For any other content type, just compare the body.
-                case MediaTypeNames.Text.Plain:
-                case MediaTypeNames.Text.Xml:
-                case MediaTypeNames.Text.Html:
-                case MediaTypeNames.Application.Soap:
-                case MediaTypeNames.Application.Xml:
-                default:
-                    return body == _content?.ToString();
+                try
+                {
+                    var content = _content is string cstring ? cstring : JsonSerializer.Serialize(_content);
+                    var options = JsonComparerOptions.Clone();
+                    options.JsonSerializer ??= JsonSerializer;
+                    var jcr = new JsonElementComparer(options).Compare(content, body, _pathsToIgnore);
+                    if (jcr.HasDifferences && _traceRequestComparisons)
+                        Implementor.WriteLine($"UnitTestEx > Mismatched HTTP request {request.Method} {request.RequestUri} mocked vs actual trace comparison differences:{Environment.NewLine}{jcr}");
+
+                    return jcr.AreEqual;
+                }
+                catch
+                {
+                    return false;
+                }
             }
+            else
+                 return body == _content?.ToString();
         }
 
         /// <inheritdoc/>
@@ -235,7 +226,7 @@ public override string ToString()
             if (_content == null)
                 return "'No content'";
 
-            if (_mediaType?.ToLowerInvariant() == MediaTypeNames.Application.Json && _content is not string)
+            if (TesterBase.JsonMediaTypeNames.Contains(_mediaType?.ToLowerInvariant()) && _content is not string)
                 return JsonSerializer.Serialize(_content);
 
             return _content.ToString();

tests/UnitTestEx.Xunit.Test/ProductApiTestFixture.cs

@@ -0,0 +1,18 @@
+using System;
+
+namespace UnitTestEx.Xunit.Test
+{
+    public class ProductApiTestFixture<TStartup> : ApiTestFixture<TStartup> where TStartup : class
+    {
+        private static int _counter = 0;
+
+        protected override void OnConfiguration()
+        {
+            _counter++;
+            if (_counter > 1)
+            {
+                throw new InvalidOperationException("ProductApiTestFixture should only be instantiated once per test run.");
+            }
+        }
+    }
+}

tests/UnitTestEx.Xunit.Test/ProductControllerTest.cs

@@ -10,9 +10,9 @@
 
 namespace UnitTestEx.Xunit.Test
 {
-    public class ProductControllerTest : WithApiTester<Startup>
+    public class ProductControllerTest : WithApiTester<Startup>, IClassFixture<ProductApiTestFixture<Startup>>
     {
-        public ProductControllerTest(ApiTestFixture<Startup> fixture, ITestOutputHelper output) : base(fixture, output) { }
+        public ProductControllerTest(ProductApiTestFixture<Startup> fixture, ITestOutputHelper output) : base(fixture, output) { }
 
         [Fact]
         public void Notfound()