Add the ability to set the JsonSerializerOptions

Author: dnperfors

CHANGELOG.md

@@ -15,6 +15,7 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - `CreateClient` now accepts `DelegateHandlers` in order to chain Handlers. The InnerHandler property of each handler is set automatically and the `TestableHttpMessageHandler` is automatically set as the last handler. This is showcased with Polly in the integration tests.
 - Added support for .NET Framework 4.6.2, .NET Framework 4.7 and .NET Framework 4.8 by running the tests against these versions.
 - Added several `Responses`, including `Delayed`, `Timeout`, `Configured`, `Sequenced`, `StatusCode` and `Json`. These responses can now be used inside the `RespondWith`.
+- Added the possibility to set and override the JsonSerializerOptions.
 
 ### Changed
 - `TestableHttpClient` now works with the `Responses` class, making it easier to configure responses.

src/TestableHttpClient.NFluent/FluentHttpRequestMessagesChecks.cs

@@ -8,12 +8,15 @@ internal class FluentHttpRequestMessagesChecks : FluentSut<IEnumerable<HttpReque
     private IEnumerable<HttpRequestMessage> requests;
     private readonly List<string> requestConditions = new List<string>();
 
-    public FluentHttpRequestMessagesChecks(IEnumerable<HttpRequestMessage> httpRequestMessages)
+    public FluentHttpRequestMessagesChecks(IEnumerable<HttpRequestMessage> httpRequestMessages, TestableHttpMessageHandlerOptions? options = null)
         : base(httpRequestMessages, Check.Reporter, false)
     {
         requests = httpRequestMessages ?? throw new ArgumentNullException(nameof(httpRequestMessages));
+        Options = options ?? new TestableHttpMessageHandlerOptions();
     }
 
+    public TestableHttpMessageHandlerOptions Options { get; }
+
     public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, string condition) => WithFilter(requestFilter, null, condition);
 
     public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int expectedNumberOfRequests, string condition) => WithFilter(requestFilter, (int?)expectedNumberOfRequests, condition);

src/TestableHttpClient/HttpRequestMessageAsserter.cs

@@ -11,15 +11,21 @@ internal class HttpRequestMessageAsserter : IHttpRequestMessagesCheck
     /// Construct a new HttpRequestMessageAsserter.
     /// </summary>
     /// <param name="httpRequestMessages">The list of requests to assert on.</param>
-    public HttpRequestMessageAsserter(IEnumerable<HttpRequestMessage> httpRequestMessages)
+    /// <param name="options">Options that could be used by several assertions.</param>
+    public HttpRequestMessageAsserter(IEnumerable<HttpRequestMessage> httpRequestMessages, TestableHttpMessageHandlerOptions? options = null)
     {
         Requests = httpRequestMessages ?? throw new ArgumentNullException(nameof(httpRequestMessages));
+        Options = options ?? new TestableHttpMessageHandlerOptions();
     }
 
     /// <summary>
     /// The list of requests received from <seealso cref="TestableHttpMessageHandler"/>.
     /// </summary>
     public IEnumerable<HttpRequestMessage> Requests { get; private set; }
+    /// <summary>
+    /// Options that could be used by several assertions.
+    /// </summary>
+    public TestableHttpMessageHandlerOptions Options { get; }
 
     private void Assert(int? expectedCount = null)
     {

src/TestableHttpClient/HttpRequestMessagesCheckExtensions.cs

@@ -405,7 +405,26 @@ private static IHttpRequestMessagesCheck WithContent(this IHttpRequestMessagesCh
     /// <param name="jsonObject">The object representation of the expected request content.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
     /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
-    public static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject) => WithJsonContent(check, jsonObject, null);
+    public static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject) => WithJsonContent(check, jsonObject, null, null);
+
+    /// <summary>
+    /// Asserts wheter requests are made with specific json content.
+    /// </summary>
+    /// <param name="check">The implementation that hold all the request messages.</param>
+    /// <param name="jsonObject">The object representation of the expected request content.</param>
+    /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
+    public static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject, JsonSerializerOptions jsonSerializerOptions) => WithJsonContent(check, jsonObject, jsonSerializerOptions, null);
+
+    /// <summary>
+    /// Asserts wheter requests are made with specific json content.
+    /// </summary>
+    /// <param name="check">The implementation that hold all the request messages.</param>
+    /// <param name="jsonObject">The object representation of the expected request content.</param>
+    /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
+    /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
+    public static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject, int expectedNumberOfRequests) => WithJsonContent(check, jsonObject, null, (int?)expectedNumberOfRequests);
 
     /// <summary>
     /// Asserts wheter requests are made with specific json content.
@@ -415,16 +434,16 @@ private static IHttpRequestMessagesCheck WithContent(this IHttpRequestMessagesCh
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
     /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
-    public static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject, int expectedNumberOfRequests) => WithJsonContent(check, jsonObject, (int?)expectedNumberOfRequests);
+    public static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject, JsonSerializerOptions jsonSerializerOptions, int expectedNumberOfRequests) => WithJsonContent(check, jsonObject, jsonSerializerOptions, (int?)expectedNumberOfRequests);
 
-    private static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject, int? expectedNumberOfRequests)
+    private static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject, JsonSerializerOptions? jsonSerializerOptions, int? expectedNumberOfRequests)
     {
         if (check == null)
         {
             throw new ArgumentNullException(nameof(check));
         }
 
-        var jsonString = JsonSerializer.Serialize(jsonObject);
+        var jsonString = JsonSerializer.Serialize(jsonObject, jsonSerializerOptions ?? check.Options.JsonSerializerOptions);
         return check.WithFilter(x => x.HasContent(jsonString) && x.HasContentHeader("Content-Type", "application/json*"), expectedNumberOfRequests, $"json content '{jsonString}'");
     }
 

src/TestableHttpClient/HttpResponseContext.cs

@@ -5,10 +5,11 @@
 /// </summary>
 public class HttpResponseContext
 {
-    public HttpResponseContext(HttpRequestMessage httpRequestMessage, HttpResponseMessage httpResponseMessage)
+    public HttpResponseContext(HttpRequestMessage httpRequestMessage, HttpResponseMessage httpResponseMessage, TestableHttpMessageHandlerOptions? options = null)
     {
         HttpRequestMessage = httpRequestMessage;
         HttpResponseMessage = httpResponseMessage;
+        Options = options ?? new TestableHttpMessageHandlerOptions();
     }
 
     /// <summary>
@@ -19,4 +20,5 @@ public HttpResponseContext(HttpRequestMessage httpRequestMessage, HttpResponseMe
     /// The response message that will be send back to the HttpClient.
     /// </summary>
     public HttpResponseMessage HttpResponseMessage { get; }
+    public TestableHttpMessageHandlerOptions Options { get; }
 }

src/TestableHttpClient/IHttpRequestMessagesCheck.cs

@@ -5,6 +5,11 @@
 /// </summary>
 public interface IHttpRequestMessagesCheck
 {
+    /// <summary>
+    /// Options that could be used by several asserters.
+    /// </summary>
+    TestableHttpMessageHandlerOptions Options { get; }
+
     /// <summary>
     /// Asserts whether requests comply with a specific filter.
     /// </summary>

src/TestableHttpClient/Response/JsonResponse.cs

@@ -10,10 +10,11 @@ public JsonResponse(object? content, string? contentType = null)
 
     public object? Content { get; }
     public string ContentType { get; }
+    public JsonSerializerOptions? JsonSerializerOptions { get; set; }
 
     protected override Task<HttpContent?> GetContentAsync(HttpResponseContext context, CancellationToken cancellationToken)
     {
-        string json = JsonSerializer.Serialize(Content);
+        string json = JsonSerializer.Serialize(Content, JsonSerializerOptions ?? context.Options.JsonSerializerOptions);
         return Task.FromResult<HttpContent?>(new StringContent(json, Encoding.UTF8, ContentType));
     }
 }

src/TestableHttpClient/Responses.cs

@@ -70,15 +70,15 @@ public static class Responses
     /// <param name="content">The content to serialize.</param>
     /// <param name="contentType">The content type of the response, defaults to 'application/json'.</param>
     /// <returns>A response with specific content.</returns>
-    public static IResponse Json(object? content, string? contentType = null) => new JsonResponse(content, contentType);
+    public static IResponse Json(object? content, string? contentType = null, JsonSerializerOptions? jsonSerializerOptions = null) => new JsonResponse(content, contentType) { JsonSerializerOptions = jsonSerializerOptions };
     /// <summary>
     /// Create a response with json content and a specific status code.
     /// </summary>
     /// <param name="content">The content to serialize.</param>
     /// <param name="statusCode">The status code for the response.</param>
     /// <param name="contentType">The content type of the response, defaults to 'application/json'.</param>
     /// <returns>A response with specific content.</returns>
-    public static IResponse Json(object? content, HttpStatusCode statusCode, string? contentType = null) => new JsonResponse(content, contentType) { StatusCode = statusCode };
+    public static IResponse Json(object? content, HttpStatusCode statusCode, string? contentType = null, JsonSerializerOptions? jsonSerializerOptions = null) => new JsonResponse(content, contentType) { StatusCode = statusCode, JsonSerializerOptions = jsonSerializerOptions };
     /// <summary>
     /// Entrypoint for extensions.
     /// </summary>

src/TestableHttpClient/TestableHttpMessageHandler.cs

@@ -12,6 +12,8 @@ public class TestableHttpMessageHandler : HttpMessageHandler
     private IResponse response = new HttpResponse(HttpStatusCode.OK);
     private Func<HttpRequestMessage, HttpResponseMessage>? responseFactory;
 
+    public TestableHttpMessageHandlerOptions Options { get; } = new TestableHttpMessageHandlerOptions();
+
     /// <summary>
     /// Gets the collection of captured requests made using this HttpMessageHandler.
     /// </summary>
@@ -29,7 +31,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
         else
         {
             responseMessage = new();
-            HttpResponseContext context = new(request, responseMessage);
+            HttpResponseContext context = new(request, responseMessage, Options);
             await response.ExecuteAsync(context, cancellationToken).ConfigureAwait(false);
         }
 

src/TestableHttpClient/TestableHttpMessageHandlerAssertionExtensions.cs

@@ -17,7 +17,7 @@ public static IHttpRequestMessagesCheck ShouldHaveMadeRequests(this TestableHttp
             throw new ArgumentNullException(nameof(handler));
         }
 
-        return new HttpRequestMessageAsserter(handler.Requests).WithRequestUri("*");
+        return new HttpRequestMessageAsserter(handler.Requests, handler.Options).WithRequestUri("*");
     }
 
     /// <summary>
@@ -36,7 +36,7 @@ public static IHttpRequestMessagesCheck ShouldHaveMadeRequests(this TestableHttp
             throw new ArgumentNullException(nameof(handler));
         }
 
-        return new HttpRequestMessageAsserter(handler.Requests).WithRequestUri("*", expectedNumberOfRequests);
+        return new HttpRequestMessageAsserter(handler.Requests, handler.Options).WithRequestUri("*", expectedNumberOfRequests);
     }
 
     /// <summary>
@@ -60,7 +60,7 @@ public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHt
             throw new ArgumentNullException(nameof(pattern));
         }
 
-        return new HttpRequestMessageAsserter(handler.Requests).WithRequestUri(pattern);
+        return new HttpRequestMessageAsserter(handler.Requests, handler.Options).WithRequestUri(pattern);
     }
 
     /// <summary>
@@ -85,6 +85,6 @@ public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHt
             throw new ArgumentNullException(nameof(pattern));
         }
 
-        return new HttpRequestMessageAsserter(handler.Requests).WithRequestUri(pattern, expectedNumberOfRequests);
+        return new HttpRequestMessageAsserter(handler.Requests, handler.Options).WithRequestUri(pattern, expectedNumberOfRequests);
     }
 }