RequestBuilder : add WithBodyAsJson and WithBody (with IJsonConverter) (#908)

StefH · web-flow · commit 66245409f901 · 2023-03-22T15:47:58.000+01:00
* RequestBuilder : add WithBodyAsJson and WithBody (with IJsonConverter)

* tests
diff --git a/src/WireMock.Net/RequestBuilders/IBodyRequestBuilder.cs b/src/WireMock.Net/RequestBuilders/IBodyRequestBuilder.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using JsonConverter.Abstractions;
 using WireMock.Matchers;
 using WireMock.Matchers.Request;
 using WireMock.Util;
@@ -46,10 +47,28 @@ public interface IBodyRequestBuilder : IRequestMatcher
     /// WithBody: Body as object
     /// </summary>
     /// <param name="body">The body.</param>
-    /// <param name="matchBehaviour">The match behaviour.</param>
+    /// <param name="matchBehaviour">The match behaviour [default is AcceptOnMatch].</param>
     /// <returns>The <see cref="IRequestBuilder"/>.</returns>
     IRequestBuilder WithBody(object body, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch);
 
+    /// <summary>
+    /// WithBody : Body as a string response based on a object (which will be converted to a JSON string using NewtonSoft.Json).
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="matchBehaviour">The match behaviour [default is AcceptOnMatch].</param>
+    /// <returns>A <see cref="IRequestBuilder"/>.</returns>
+    IRequestBuilder WithBodyAsJson(object body, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch);
+
+    /// <summary>
+    /// WithBody : Body as a string response based on a object (which will be converted to a JSON string using the <see cref="IJsonConverter"/>).
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="converter">The JsonConverter.</param>
+    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
+    /// <param name="matchBehaviour">The match behaviour [default is AcceptOnMatch].</param>
+    /// <returns>A <see cref="IRequestBuilder"/>.</returns>
+    IRequestBuilder WithBodyAsJson(object body, IJsonConverter converter, JsonConverterOptions? options = null, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch);
+
     /// <summary>
     /// WithBody: func (string)
     /// </summary>
diff --git a/src/WireMock.Net/RequestBuilders/Request.WithBody.cs b/src/WireMock.Net/RequestBuilders/Request.WithBody.cs
@@ -2,10 +2,12 @@
 // For more details see 'mock4net/LICENSE.txt' and 'mock4net/readme.md' in this project root.
 using System;
 using System.Collections.Generic;
+using JsonConverter.Abstractions;
+using Newtonsoft.Json;
+using Stef.Validation;
 using WireMock.Matchers;
 using WireMock.Matchers.Request;
 using WireMock.Util;
-using Stef.Validation;
 
 namespace WireMock.RequestBuilders;
 
@@ -32,6 +34,24 @@ public IRequestBuilder WithBody(object body, MatchBehaviour matchBehaviour = Mat
         return this;
     }
 
+    /// <inheritdoc />
+    public IRequestBuilder WithBodyAsJson(object body, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        var bodyAsJsonString = JsonConvert.SerializeObject(body);
+        _requestMatchers.Add(new RequestMessageBodyMatcher(matchBehaviour, bodyAsJsonString));
+        return this;
+    }
+
+    /// <inheritdoc />
+    public IRequestBuilder WithBodyAsJson(object body, IJsonConverter converter, JsonConverterOptions? options = null, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        Guard.NotNull(converter);
+
+        var bodyAsJsonString = converter.Serialize(body, options);
+        _requestMatchers.Add(new RequestMessageBodyMatcher(matchBehaviour, bodyAsJsonString));
+        return this;
+    }
+
     /// <inheritdoc />
     public IRequestBuilder WithBody(IMatcher matcher)
     {
diff --git a/src/WireMock.Net/ResponseBuilders/IBodyResponseBuilder.cs b/src/WireMock.Net/ResponseBuilders/IBodyResponseBuilder.cs
@@ -92,7 +92,7 @@ public interface IBodyResponseBuilder : IFaultResponseBuilder
     /// </summary>
     /// <param name="body">The body.</param>
     /// <param name="converter">The JsonConverter.</param>
-    /// <param name="options">The IJsonConverterOption [optional].</param>
+    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
     /// <returns>A <see cref="IResponseBuilder"/>.</returns>
     IResponseBuilder WithBody(object body, IJsonConverter converter, JsonConverterOptions? options = null);
 
@@ -102,7 +102,7 @@ public interface IBodyResponseBuilder : IFaultResponseBuilder
     /// <param name="body">The body.</param>
     /// <param name="encoding">The body encoding, can be <c>null</c>.</param>
     /// <param name="converter">The JsonConverter.</param>
-    /// <param name="options">The IJsonConverterOption [optional].</param>
+    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
     /// <returns>A <see cref="IResponseBuilder"/>.</returns>
     IResponseBuilder WithBody(object body, Encoding? encoding, IJsonConverter converter, JsonConverterOptions? options = null);
 }
diff --git a/test/WireMock.Net.Tests/RequestWithBodyTests.cs b/test/WireMock.Net.Tests/RequestWithBodyTests.cs
@@ -2,6 +2,8 @@
 using System.Collections.Generic;
 using System.Text;
 using FluentAssertions;
+using JsonConverter.Abstractions;
+using Moq;
 using Newtonsoft.Json;
 using NFluent;
 using WireMock.Matchers;
@@ -134,7 +136,7 @@ public void Request_WithBodyExactMatcher()
         }
 
         [Fact]
-        public void Request_BodyAsString_Using_WildcardMatcher()
+        public void Request_WithBody_BodyDataAsString_Using_WildcardMatcher()
         {
             // Arrange
             var spec = Request.Create().WithPath("/foo").UsingAnyMethod().WithBody(new WildcardMatcher("H*o*"));
@@ -153,7 +155,7 @@ public void Request_BodyAsString_Using_WildcardMatcher()
         }
 
         [Fact]
-        public void Request_BodyAsJson_Using_WildcardMatcher()
+        public void Request_WithBody_BodyDataAsJson_Using_WildcardMatcher()
         {
             // Arrange
             var spec = Request.Create().WithPath("/foo").UsingAnyMethod().WithBody(new WildcardMatcher("*Hello*"));
@@ -349,6 +351,56 @@ public void Request_WithBodyAsObject_ExactObjectMatcher_true()
             Check.That(requestBuilder.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
         }
 
+        [Fact]
+        public void Request_WithBodyAsJson_UsingObject()
+        {
+            // Assign
+            object body = new
+            {
+                Test = "abc"
+            };
+            var requestBuilder = Request.Create().UsingAnyMethod().WithBodyAsJson(body);
+
+            var bodyData = new BodyData
+            {
+                BodyAsString = JsonConvert.SerializeObject(body),
+                DetectedBodyType = BodyType.String
+            };
+
+            // Act
+            var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "POST", ClientIp, bodyData);
+
+            // Assert
+            var requestMatchResult = new RequestMatchResult();
+            Check.That(requestBuilder.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
+        }
+
+        [Fact]
+        public void Request_WithBodyAsJson_WithIJsonConverter_UsingObject()
+        {
+            // Assign
+            var jsonConverterMock = new Mock<IJsonConverter>();
+            jsonConverterMock.Setup(j => j.Serialize(It.IsAny<object>(), It.IsAny<JsonConverterOptions>())).Returns("test");
+            object body = new
+            {
+                Any = "key"
+            };
+            var requestBuilder = Request.Create().UsingAnyMethod().WithBodyAsJson(body, jsonConverterMock.Object);
+
+            var bodyData = new BodyData
+            {
+                BodyAsString = "test",
+                DetectedBodyType = BodyType.String
+            };
+
+            // Act
+            var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "POST", ClientIp, bodyData);
+
+            // Assert
+            var requestMatchResult = new RequestMatchResult();
+            Check.That(requestBuilder.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
+        }
+
         [Theory]
         [InlineData(new byte[] { 1 }, BodyType.Bytes)]
         [InlineData(new byte[] { 48, 49, 50 }, BodyType.Bytes)]
