1.5.56

* Fix Request.Create().WithBodyAsJson(...)

* [CodeFactor] Apply fixes

---------

Co-authored-by: codefactor-io <support@codefactor.io>

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.5.56 (03 June 2024)
+- [#1111](https://github.com/WireMock-Net/WireMock.Net/pull/1111) - Fix Request.Create().WithBodyAsJson(...) [bug] contributed by [StefH](https://github.com/StefH)
+- [#1112](https://github.com/WireMock-Net/WireMock.Net/pull/1112) - Add "/__admin/health" endpoint [feature] contributed by [StefH](https://github.com/StefH)
+- [#1110](https://github.com/WireMock-Net/WireMock.Net/issues/1110) - Connection prematurely closed BEFORE response  [bug]
+
 # 1.5.55 (22 May 2024)
 - [#1107](https://github.com/WireMock-Net/WireMock.Net/pull/1107) - When only Port is provided, bind to * (Fixes #1100) [bug] contributed by [StefH](https://github.com/StefH)
 

Directory.Build.props

@@ -4,7 +4,7 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <VersionPrefix>1.5.55</VersionPrefix>
+        <VersionPrefix>1.5.56</VersionPrefix>
         <PackageIcon>WireMock.Net-Logo.png</PackageIcon>
         <PackageProjectUrl>https://github.com/WireMock-Net/WireMock.Net</PackageProjectUrl>
         <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>

Generate-ReleaseNotes.cmd

@@ -1,6 +1,6 @@
 rem https://github.com/StefH/GitHubReleaseNotes
 
-SET version=1.5.55
+SET version=1.5.56
 
 GitHubReleaseNotes --output CHANGELOG.md --skip-empty-releases --exclude-labels question invalid doc duplicate example --version %version% --token %GH_TOKEN%
 

PackageReleaseNotes.txt

@@ -1,4 +1,6 @@
-# 1.5.55 (22 May 2024)
-- #1107 When only Port is provided, bind to * (Fixes #1100) [bug]
+# 1.5.56 (03 June 2024)
+- #1111 Fix Request.Create().WithBodyAsJson(...) [bug]
+- #1112 Add "/__admin/health" endpoint [feature]
+- #1110 Connection prematurely closed BEFORE response  [bug]
 
 The full release notes can be found here: https://github.com/WireMock-Net/WireMock.Net/blob/master/CHANGELOG.md

examples/WireMock.Net.Console.Net452.Classic/MainApp.cs

@@ -97,34 +97,30 @@ message HelloReply {
 
         private static void RunOnLocal()
         {
-            var localIP = Dns.GetHostEntry(Dns.GetHostName()).AddressList.First(a => a.AddressFamily == AddressFamily.InterNetwork);
-
-            //try
-            //{
-            //    var server = WireMockServer.Start(new WireMockServerSettings
-            //    {
-            //        Urls = new[] { $"http://{localIP}:9091" },
-            //        StartAdminInterface = true
-            //    });
-            //    System.Console.WriteLine($"1: {string.Join(", ", server.Urls)}");
-
-            //    System.Console.WriteLine("Press any key to stop...");
-            //    System.Console.ReadKey();
-            //    server.Stop();
-            //}
-            //catch (Exception e)
-            //{
-            //    System.Console.WriteLine(e);
-            //}
-
             try
             {
                 var server = WireMockServer.Start(new WireMockServerSettings
                 {
                     Port = 9091,
-                    StartAdminInterface = true
+                    StartAdminInterface = true,
+                    Logger = new WireMockConsoleLogger()
                 });
-                System.Console.WriteLine($"2: {string.Join(", ", server.Urls)}");
+                System.Console.WriteLine(string.Join(", ", server.Urls));
+
+                var requestJson = new { PricingContext = new { Market = "USA" } };
+                var responseJson = new { Market = "{{JsonPath.SelectToken request.body \"$.PricingContext.Market\"}}" };
+                server
+                    .Given(Request.Create()
+                        //.WithBody(new JsonMatcher(requestJson))
+                        .WithBodyAsJson(requestJson)
+                        .WithPath("/pricing")
+                        .UsingPost()
+                    )
+                    .RespondWith(Response.Create()
+                        .WithHeader("Content-Type", "application/json")
+                        .WithBodyAsJson(responseJson)
+                        .WithTransformer(true)
+                    );
 
                 System.Console.WriteLine("Press any key to stop...");
                 System.Console.ReadKey();
@@ -134,24 +130,6 @@ message HelloReply {
             {
                 System.Console.WriteLine(e);
             }
-
-            //try
-            //{
-            //    var server = WireMockServer.Start(new WireMockServerSettings
-            //    {
-            //        Urls = new[] { "http://*:9091" },
-            //        StartAdminInterface = true
-            //    });
-            //    System.Console.WriteLine($"3: {string.Join(", ", server.Urls)}");
-
-            //    System.Console.WriteLine("Press any key to stop...");
-            //    System.Console.ReadKey();
-            //    server.Stop();
-            //}
-            //catch (Exception e)
-            //{
-            //    System.Console.WriteLine(e);
-            //}
         }
 
         public static void Run()
@@ -251,7 +229,9 @@ message HelloReply {
             server.SetBasicAuthentication("a", "b");
             //server.SetAzureADAuthentication("6c2a4722-f3b9-4970-b8fc-fac41e29stef", "8587fde1-7824-42c7-8592-faf92b04stef");
 
-            // server.AllowPartialMapping();
+            //var http = new HttpClient();
+            //var response = await http.GetAsync($"{_wireMockServer.Url}/pricing");
+            //var value = await response.Content.ReadAsStringAsync();
 
 #if PROTOBUF
             var protoBufJsonMatcher = new JsonPartialWildcardMatcher(new { name = "*" });
@@ -395,7 +375,6 @@ message HelloReply {
                         .WithHeader("Content-Type", "text/plain")
                 );
 
-
             server
                 .Given(Request.Create()
                     .UsingMethod("GET")

src/WireMock.Net.RestClient/IWireMockAdminApi.cs

@@ -24,12 +24,24 @@ public interface IWireMockAdminApi
     [Header("Authorization")]
     AuthenticationHeaderValue Authorization { get; set; }
 
+    /// <summary>
+    /// Get health status.
+    /// </summary>
+    /// <param name="cancellationToken">The optional cancellationToken.</param>
+    /// <returns>
+    /// Returns HttpStatusCode <c>200</c> with a value <c>Healthy</c> to indicate that WireMock.Net is healthy.
+    /// Else it returns HttpStatusCode <c>404</c>.
+    /// </returns>
+    [Get("health")]
+    [AllowAnyStatusCode]
+    Task<string> GetHealthAsync(CancellationToken cancellationToken = default);
+
     /// <summary>
     /// Get the settings.
     /// </summary>
     /// <returns>SettingsModel</returns>
     [Get("settings")]
-    Task<SettingsModel> GetSettingsAsync();
+    Task<SettingsModel> GetSettingsAsync(CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Update the settings.

src/WireMock.Net/RequestBuilders/IBodyRequestBuilder.cs

@@ -51,23 +51,13 @@ public interface IBodyRequestBuilder : IProtoBufRequestBuilder
     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).
+    /// WithBodyAsJson: A <see cref="JsonMatcher"/> will be used to match this object.
     /// </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>

src/WireMock.Net/RequestBuilders/Request.WithBody.cs

@@ -2,8 +2,6 @@
 // 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;
@@ -37,19 +35,7 @@ public partial class Request
     /// <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;
+        return WithBody(new IMatcher[] { new JsonMatcher(matchBehaviour, body) });
     }
 
     /// <inheritdoc />

src/WireMock.Net/Server/WireMockServer.Admin.cs

@@ -31,6 +31,7 @@ public partial class WireMockServer
 {
     private const int EnhancedFileSystemWatcherTimeoutMs = 1000;
     private const string AdminFiles = "/__admin/files";
+    private const string AdminHealth = "/__admin/health";
     private const string AdminMappings = "/__admin/mappings";
     private const string AdminMappingsCode = "/__admin/mappings/code";
     private const string AdminMappingsWireMockOrg = "/__admin/mappings/wiremock.org";
@@ -54,6 +55,9 @@ public partial class WireMockServer
     #region InitAdmin
     private void InitAdmin()
     {
+        // __admin/health
+        Given(Request.Create().WithPath(AdminHealth).UsingGet()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(HealthGet));
+
         // __admin/settings
         Given(Request.Create().WithPath(AdminSettings).UsingGet()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(SettingsGet));
         Given(Request.Create().WithPath(AdminSettings).UsingMethod("PUT", "POST").WithHeader(HttpKnownHeaderNames.ContentType, AdminRequestContentTypeJson)).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(SettingsUpdate));
@@ -218,6 +222,22 @@ public partial class WireMockServer
     }
     #endregion
 
+    #region Health
+    private static IResponseMessage HealthGet(IRequestMessage requestMessage)
+    {
+        return new ResponseMessage
+        {
+            BodyData = new BodyData
+            {
+                DetectedBodyType = BodyType.String,
+                BodyAsString = "Healthy"
+            },
+            StatusCode = (int)HttpStatusCode.OK,
+            Headers = new Dictionary<string, WireMockList<string>> { { HttpKnownHeaderNames.ContentType, new WireMockList<string>(WireMockConstants.ContentTypeTextPlain) } }
+        };
+    }
+    #endregion
+
     #region Settings
     private IResponseMessage SettingsGet(IRequestMessage requestMessage)
     {
@@ -830,4 +850,4 @@ public partial class WireMockServer
         var singleResult = ((JObject)value).ToObject<T>();
         return new[] { singleResult! };
     }
-}
+}

test/WireMock.Net.Tests/AdminApi/WireMockAdminApiTests.cs

@@ -41,6 +41,18 @@ public partial class WireMockAdminApiTests
         VerifyNewtonsoftJson.Enable(VerifySettings);
     }
 
+    [Fact]
+    public async Task IWireMockAdminApi_GetHealthAsync()
+    {
+        // Arrange
+        var server = WireMockServer.StartWithAdminInterface();
+        var api = RestClient.For<IWireMockAdminApi>(server.Urls[0]);
+
+        // Act
+        var status = await api.GetHealthAsync().ConfigureAwait(false);
+        status.Should().Be("Healthy");
+    }
+
     [Fact]
     public async Task IWireMockAdminApi_GetSettingsAsync()
     {

test/WireMock.Net.Tests/RequestBuilders/RequestBuilderWithBodyTests.cs

@@ -3,8 +3,6 @@ using FluentAssertions;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
-using JsonConverter.Abstractions;
-using Moq;
 using Newtonsoft.Json;
 using NFluent;
 using WireMock.Matchers;
@@ -293,7 +291,7 @@ public class RequestBuilderWithBodyTests
     }
 
     [Fact]
-    public void Request_WithBodyAsJson_Object_JsonPathMatcher_true()
+    public void Request_WithBody_Object_JsonPathMatcher_true()
     {
         // Arrange
         var spec = Request.Create().UsingAnyMethod().WithBody(new JsonPathMatcher("$..things[?(@.name == 'RequiredThing')]"));
@@ -316,7 +314,7 @@ public class RequestBuilderWithBodyTests
     }
 
     [Fact]
-    public void Request_WithBodyAsJson_Array_JsonPathMatcher_1()
+    public void Request_WithBody_Array_JsonPathMatcher_1()
     {
         // Arrange
         var spec = Request.Create().UsingAnyMethod().WithBody(new JsonPathMatcher("$..books[?(@.price < 10)]"));
@@ -339,7 +337,7 @@ public class RequestBuilderWithBodyTests
     }
 
     [Fact]
-    public void Request_WithBodyAsJson_Array_JsonPathMatcher_2()
+    public void Request_WithBody_Array_JsonPathMatcher_2()
     {
         // Arrange
         var spec = Request.Create().UsingAnyMethod().WithBody(new JsonPathMatcher("$..[?(@.Id == 1)]"));
@@ -363,7 +361,7 @@ public class RequestBuilderWithBodyTests
     }
 
     [Fact]
-    public void Request_WithBodyAsObject_ExactObjectMatcher_true()
+    public void Request_WithBody_ExactObjectMatcher_true()
     {
         // Assign
         object body = DateTime.MinValue;
@@ -384,7 +382,7 @@ public class RequestBuilderWithBodyTests
     }
 
     [Fact]
-    public void Request_WithBodyAsJson_UsingObject()
+    public void Request_WithBodyAsJson_UsingObject_UsesJsonMatcher()
     {
         // Assign
         object body = new
@@ -395,34 +393,8 @@ public class RequestBuilderWithBodyTests
 
         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
+            BodyAsJson = body,
+            DetectedBodyType = BodyType.Json
         };
 
         // Act

test/WireMock.Net.Tests/ResponseBuilders/ResponseWithHandlebarsJsonPathTests.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Text;
 using System.Threading.Tasks;
+using FluentAssertions;
 using Moq;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
@@ -354,7 +355,7 @@ public class ResponseWithHandlebarsJsonPathTests
     public async Task Response_ProvideResponse_Transformer_WithBodyAsFile_JsonPath()
     {
         // Assign
-        string jsonString = "{ \"MyUniqueNumber\": \"1\" }";
+        const string jsonString = "{ \"MyUniqueNumber\": \"1\" }";
         var bodyData = new BodyData
         {
             BodyAsString = jsonString,
@@ -365,15 +366,17 @@ public class ResponseWithHandlebarsJsonPathTests
         };
         var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "POST", ClientIp, bodyData);
 
-        string jsonPath = "\"$.MyUniqueNumber\"";
         var responseBuilder = Response.Create()
             .WithTransformer()
-            .WithBodyFromFile(@"c:\\{{JsonPath.SelectToken request.body " + jsonPath + "}}\\test.json"); // why use a \\ here ?
+
+            // We need to use `c:\\\\` here because when just using `c:\\\`, the `\\` it will be interpreted as an escape character to skip / exclude / escape the whole {{}} expression.
+            // See https://handlebarsjs.com/guide/expressions.html#escaping-handlebars-expressions
+            .WithBodyFromFile("c:\\\\{{JsonPath.SelectToken request.body \"$.MyUniqueNumber\" }}\\test.json");
 
         // Act
         var response = await responseBuilder.ProvideResponseAsync(_mappingMock.Object, request, _settings).ConfigureAwait(false);
 
         // Assert
-        Check.That(response.Message.BodyData.BodyAsFile).Equals(@"c:\1\test.json");
+        response.Message.BodyData?.BodyAsFile.Should().Be(@"c:\1\test.json");
     }
 }

test/WireMock.Net.Tests/WireMockServer.Proxy.cs

@@ -117,7 +117,7 @@ public class WireMockServerProxyTests
         }
 
         // Assert
-        server.Mappings.Should().HaveCount(35);
+        server.Mappings.Should().HaveCount(36);
     }
 
     [Fact]

test/WireMock.Net.Tests/WireMockServer.Settings.cs

@@ -81,7 +81,7 @@ public class WireMockServerSettingsTests
 
         // Assert
         server.Mappings.Should().NotBeNull();
-        server.Mappings.Should().HaveCount(33);
+        server.Mappings.Should().HaveCount(34);
         server.Mappings.All(m => m.Priority == WireMockConstants.AdminPriority).Should().BeTrue();
     }
 
@@ -100,9 +100,9 @@ public class WireMockServerSettingsTests
 
         // Assert
         server.Mappings.Should().NotBeNull();
-        server.Mappings.Should().HaveCount(34);
+        server.Mappings.Should().HaveCount(35);
 
-        server.Mappings.Count(m => m.Priority == WireMockConstants.AdminPriority).Should().Be(33);
+        server.Mappings.Count(m => m.Priority == WireMockConstants.AdminPriority).Should().Be(34);
         server.Mappings.Count(m => m.Priority == WireMockConstants.ProxyPriority).Should().Be(1);
     }