Merge branch 'master' into stef-fluent

Author: StefH

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.5.46 (23 December 2023)
+- [#1044](https://github.com/WireMock-Net/WireMock.Net/pull/1044) - WireMockServerSettingsParser [refactor] contributed by [StefH](https://github.com/StefH)
+- [#1046](https://github.com/WireMock-Net/WireMock.Net/pull/1046) - Change FindRequestByMappingGuidAsync to return a collection of entries contributed by [tlevesque-ueat](https://github.com/tlevesque-ueat)
+
 # 1.5.45 (21 December 2023)
 - [#1036](https://github.com/WireMock-Net/WireMock.Net/pull/1036) - Update Handlebars Transformer logic (ReplaceNodeOptions) [feature] contributed by [StefH](https://github.com/StefH)
 - [#1043](https://github.com/WireMock-Net/WireMock.Net/pull/1043) - FindRequestByMappingGuidAsync [feature] contributed by [StefH](https://github.com/StefH)

Directory.Build.props

@@ -4,7 +4,7 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <VersionPrefix>1.5.45</VersionPrefix>
+        <VersionPrefix>1.5.46</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.45
+SET version=1.5.46
 
 GitHubReleaseNotes --output CHANGELOG.md --skip-empty-releases --exclude-labels question invalid doc duplicate --version %version% --token %GH_TOKEN%
 

PackageReleaseNotes.txt

@@ -1,6 +1,5 @@
-# 1.5.45 (21 December 2023)
-- #1036 Update Handlebars Transformer logic (ReplaceNodeOptions) [feature]
-- #1043 FindRequestByMappingGuidAsync [feature]
-- #1039 [Admin API] Find a request that matched a given mapping [feature]
+# 1.5.46 (23 December 2023)
+- #1044 WireMockServerSettingsParser [refactor]
+- #1046 Change FindRequestByMappingGuidAsync to return a collection of entries
 
 The full release notes can be found here: https://github.com/WireMock-Net/WireMock.Net/blob/master/CHANGELOG.md

src/WireMock.Net.RestClient/IWireMockAdminApi.cs

@@ -201,12 +201,12 @@ public interface IWireMockAdminApi
     Task<IList<LogEntryModel>> FindRequestsAsync([Body] RequestModel model, CancellationToken cancellationToken = default);
 
     /// <summary>
-    /// Find a request based on the Mapping Guid.
+    /// Find requests based on the Mapping Guid.
     /// </summary>
     /// <param name="mappingGuid">The Mapping Guid</param>
     /// <param name="cancellationToken">The optional cancellationToken.</param>
     [Get("requests/find")]
-    Task<LogEntryModel?> FindRequestByMappingGuidAsync([Query] Guid mappingGuid, CancellationToken cancellationToken = default);
+    Task<IList<LogEntryModel>> FindRequestsByMappingGuidAsync([Query] Guid mappingGuid, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Get all scenarios
@@ -304,4 +304,4 @@ public interface IWireMockAdminApi
     /// <param name="cancellationToken">The optional cancellationToken.</param>
     [Post("openapi/save")]
     Task<StatusModel> OpenApiSaveAsync([Body] string text, CancellationToken cancellationToken = default);
-}
+}

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

@@ -99,7 +99,7 @@ private void InitAdmin()
 
         // __admin/requests/find
         Given(Request.Create().WithPath(AdminRequests + "/find").UsingPost()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(RequestsFind));
-        Given(Request.Create().WithPath(AdminRequests + "/find").UsingGet().WithParam("mappingGuid", new NotNullOrEmptyMatcher())).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(RequestFindByMappingGuid));
+        Given(Request.Create().WithPath(AdminRequests + "/find").UsingGet().WithParam("mappingGuid", new NotNullOrEmptyMatcher())).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(RequestsFindByMappingGuid));
 
         // __admin/scenarios
         Given(Request.Create().WithPath(AdminScenarios).UsingGet()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(ScenariosGet));
@@ -602,21 +602,17 @@ private IResponseMessage RequestsFind(IRequestMessage requestMessage)
         return ToJson(result);
     }
 
-    private IResponseMessage RequestFindByMappingGuid(IRequestMessage requestMessage)
+    private IResponseMessage RequestsFindByMappingGuid(IRequestMessage requestMessage)
     {
         if (requestMessage.Query != null &&
             requestMessage.Query.TryGetValue("mappingGuid", out var value) &&
             Guid.TryParse(value.ToString(), out var mappingGuid)
         )
         {
-            var logEntry = LogEntries.SingleOrDefault(le => !le.RequestMessage.Path.StartsWith("/__admin/") && le.MappingGuid == mappingGuid);
-            if (logEntry != null)
-            {
-                var logEntryMapper = new LogEntryMapper(_options);
-                return ToJson(logEntryMapper.Map(logEntry));
-            }
-
-            return ResponseMessageBuilder.Create(HttpStatusCode.OK);
+            var logEntries = LogEntries.Where(le => !le.RequestMessage.Path.StartsWith("/__admin/") && le.MappingGuid == mappingGuid);
+            var logEntryMapper = new LogEntryMapper(_options);
+            var result = logEntries.Select(logEntryMapper.Map);
+            return ToJson(result);
         }
 
         return ResponseMessageBuilder.Create(HttpStatusCode.BadRequest);
@@ -833,4 +829,4 @@ private static T[] DeserializeObjectToArray<T>(object value)
         var singleResult = ((JObject)value).ToObject<T>();
         return new[] { singleResult! };
     }
-}
+}

test/WireMock.Net.Tests/WireMockAdminApiTests.cs

@@ -1,5 +1,6 @@
 #if !(NET452 || NET461 || NETCOREAPP3_1)
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Net;
@@ -25,6 +26,7 @@
 using WireMock.ResponseBuilders;
 using WireMock.Server;
 using WireMock.Settings;
+using WireMock.Types;
 using Xunit;
 
 namespace WireMock.Net.Tests;
@@ -254,7 +256,7 @@ public async Task IWireMockAdminApi_FindRequestsAsync()
     }
 
     [Fact]
-    public async Task IWireMockAdminApi_FindRequestByMappingGuidAsync_Found()
+    public async Task IWireMockAdminApi_FindRequestsByMappingGuidAsync_Found()
     {
         // Arrange
         var mappingGuid = Guid.NewGuid();
@@ -269,21 +271,33 @@ public async Task IWireMockAdminApi_FindRequestByMappingGuidAsync_Found()
             .RespondWith(Response.Create());
 
         var serverUrl = "http://localhost:" + server.Ports[0];
-        await new HttpClient().GetAsync(serverUrl + "/foo").ConfigureAwait(false);
+        using var client = new HttpClient();
+        await client.GetAsync(serverUrl + "/foo").ConfigureAwait(false);
+        await client.GetAsync(serverUrl + "/foo?bar=baz").ConfigureAwait(false);
         var api = RestClient.For<IWireMockAdminApi>(serverUrl);
 
         // Act
-        var logEntryModel = await api.FindRequestByMappingGuidAsync(mappingGuid).ConfigureAwait(false);
+        var logEntryModels = await api.FindRequestsByMappingGuidAsync(mappingGuid).ConfigureAwait(false);
 
         // Assert
-        logEntryModel.Should().NotBeNull();
-        logEntryModel!.Request.Method.Should().Be("GET");
-        logEntryModel!.Request.Body.Should().BeNull();
-        logEntryModel!.Request.Path.Should().Be("/foo");
+        logEntryModels.Should().HaveCount(2);
+        logEntryModels[0].Should().NotBeNull();
+        logEntryModels[0]!.Request.Method.Should().Be("GET");
+        logEntryModels[0]!.Request.Body.Should().BeNull();
+        logEntryModels[0]!.Request.Path.Should().Be("/foo");
+        logEntryModels[0]!.Request.Query.Should().BeNullOrEmpty();
+        logEntryModels[1].Should().NotBeNull();
+        logEntryModels[1]!.Request.Method.Should().Be("GET");
+        logEntryModels[1]!.Request.Body.Should().BeNull();
+        logEntryModels[1]!.Request.Path.Should().Be("/foo");
+        logEntryModels[1]!.Request.Query.Should().BeEquivalentTo(new Dictionary<string, WireMockList<string>>
+        {
+            {"bar", new WireMockList<string>("baz")}
+        });
     }
 
     [Fact]
-    public async Task IWireMockAdminApi_FindRequestByMappingGuidAsync_NotFound()
+    public async Task IWireMockAdminApi_FindRequestsByMappingGuidAsync_NotFound()
     {
         // Arrange
         var server = WireMockServer.Start(new WireMockServerSettings
@@ -301,14 +315,14 @@ public async Task IWireMockAdminApi_FindRequestByMappingGuidAsync_NotFound()
         var api = RestClient.For<IWireMockAdminApi>(serverUrl);
 
         // Act
-        var logEntryModel = await api.FindRequestByMappingGuidAsync(Guid.NewGuid()).ConfigureAwait(false);
+        var logEntryModels = await api.FindRequestsByMappingGuidAsync(Guid.NewGuid()).ConfigureAwait(false);
 
         // Assert
-        logEntryModel.Should().BeNull();
+        logEntryModels.Should().BeEmpty();
     }
 
     [Fact]
-    public async Task IWireMockAdminApi_FindRequestByMappingGuidAsync_Invalid_ShouldReturnBadRequest()
+    public async Task IWireMockAdminApi_FindRequestsByMappingGuidAsync_Invalid_ShouldReturnBadRequest()
     {
         // Arrange
         var server = WireMockServer.Start(new WireMockServerSettings
@@ -1001,4 +1015,4 @@ public async Task IWireMockAdminApi_OpenApiSave_Yml()
         server.Stop();
     }
 }
-#endif
+#endif