1.5.37

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.5.37 (27 September 2023)
+- [#998](https://github.com/WireMock-Net/WireMock.Net/pull/998) - Add JmesPathMatcher UnitTests [test] contributed by [StefH](https://github.com/StefH)
+- [#1004](https://github.com/WireMock-Net/WireMock.Net/pull/1004) - Fix MappingModel to map IgnoreCase and RejectOnMatch for Headers, Cookies and Parameters [bug] contributed by [StefH](https://github.com/StefH)
+- [#1003](https://github.com/WireMock-Net/WireMock.Net/issues/1003) - Store Mapping per POST request ignores "IgnoreCase" property of HeaderModel [bug]
+
 # 1.5.36 (21 September 2023)
 - [#986](https://github.com/WireMock-Net/WireMock.Net/pull/986) - Write logging in case a Matcher throws an exception [feature] contributed by [StefH](https://github.com/StefH)
 - [#996](https://github.com/WireMock-Net/WireMock.Net/pull/996) - Remove dependency on Microsoft.AspNet.WebApi.Client [feature] contributed by [StefH](https://github.com/StefH)

Directory.Build.props

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

PackageReleaseNotes.txt

@@ -1,8 +1,6 @@
-# 1.5.36 (21 September 2023)
-- #986 Write logging in case a Matcher throws an exception [feature]
-- #996 Remove dependency on Microsoft.AspNet.WebApi.Client [feature]
-- #1002 Fixed logic for SaveUnmatchedRequests [bug]
-- #974 HttpClient extension methods causes ambiguous invocations in .NET 7 [bug]
-- #1001 SaveUnmatchedRequests stopped working [bug]
+# 1.5.37 (27 September 2023)
+- #998 Add JmesPathMatcher UnitTests [test]
+- #1004 Fix MappingModel to map IgnoreCase and RejectOnMatch for Headers, Cookies and Parameters [bug]
+- #1003 Store Mapping per POST request ignores "IgnoreCase" property of HeaderModel [bug]
 
 The full release notes can be found here: https://github.com/WireMock-Net/WireMock.Net/blob/master/CHANGELOG.md

src/WireMock.Net.Abstractions/Admin/Mappings/ParamModel.cs

@@ -16,6 +16,11 @@ public class ParamModel
     /// </summary>
     public bool? IgnoreCase { get; set; }
 
+    /// <summary>
+    /// Gets or sets the Reject on match for the Param Name.
+    /// </summary>
+    public bool? RejectOnMatch { get; set; }
+
     /// <summary>
     /// Gets or sets the matchers.
     /// </summary>

src/WireMock.Net/Matchers/JSONPathMatcher.cs

@@ -118,8 +118,9 @@ public class JsonPathMatcher : IStringMatcher, IObjectMatcher
 
         // The SelectToken method can accept a string path to a child token ( i.e. "Manufacturers[0].Products[0].Price").
         // In that case it will return a JValue (some type) which does not implement the IEnumerable interface.
-        return MatchScores.ToScore(
-            _patterns.Select(pattern => array.SelectToken(pattern.GetPattern()) != null).ToArray(), MatchOperator);
+        var values = _patterns.Select(pattern => array.SelectToken(pattern.GetPattern()) != null).ToArray();
+        
+        return MatchScores.ToScore(values, MatchOperator);
     }
 
     // https://github.com/WireMock-Net/WireMock.Net/issues/965

src/WireMock.Net/Matchers/Request/RequestMessageCookieMatcher.cs

@@ -11,9 +11,15 @@ namespace WireMock.Matchers.Request;
 /// <inheritdoc cref="IRequestMatcher"/>
 public class RequestMessageCookieMatcher : IRequestMatcher
 {
-    private readonly MatchBehaviour _matchBehaviour;
+    /// <summary>
+    /// MatchBehaviour
+    /// </summary>
+    public MatchBehaviour MatchBehaviour { get; }
 
-    private readonly bool _ignoreCase;
+    /// <summary>
+    /// IgnoreCase
+    /// </summary>
+    public bool IgnoreCase { get; }
 
     /// <summary>
     /// The functions
@@ -39,8 +45,8 @@ public class RequestMessageCookieMatcher : IRequestMatcher
     /// <param name="matchBehaviour">The match behaviour.</param>
     public RequestMessageCookieMatcher(MatchBehaviour matchBehaviour, string name, string pattern, bool ignoreCase)
     {
-        _matchBehaviour = matchBehaviour;
-        _ignoreCase = ignoreCase;
+        MatchBehaviour = matchBehaviour;
+        IgnoreCase = ignoreCase;
         Name = Guard.NotNull(name);
         Matchers = new IStringMatcher[] { new WildcardMatcher(matchBehaviour, Guard.NotNull(pattern), ignoreCase) };
     }
@@ -67,10 +73,10 @@ public class RequestMessageCookieMatcher : IRequestMatcher
     /// <param name="ignoreCase">Ignore the case from the pattern.</param>
     public RequestMessageCookieMatcher(MatchBehaviour matchBehaviour, string name, bool ignoreCase, params IStringMatcher[] matchers)
     {
-        _matchBehaviour = matchBehaviour;
+        MatchBehaviour = matchBehaviour;
         Name = Guard.NotNull(name);
         Matchers = Guard.NotNull(matchers);
-        _ignoreCase = ignoreCase;
+        IgnoreCase = ignoreCase;
     }
 
     /// <summary>
@@ -96,11 +102,11 @@ public class RequestMessageCookieMatcher : IRequestMatcher
     {
         if (requestMessage.Cookies == null)
         {
-            return MatchBehaviourHelper.Convert(_matchBehaviour, MatchScores.Mismatch);
+            return MatchBehaviourHelper.Convert(MatchBehaviour, MatchScores.Mismatch);
         }
 
         // Check if we want to use IgnoreCase to compare the Cookie-Name and Cookie-Value
-        var cookies = !_ignoreCase ? requestMessage.Cookies : new Dictionary<string, string>(requestMessage.Cookies, StringComparer.OrdinalIgnoreCase);
+        var cookies = !IgnoreCase ? requestMessage.Cookies : new Dictionary<string, string>(requestMessage.Cookies, StringComparer.OrdinalIgnoreCase);
 
         if (Funcs != null)
         {
@@ -114,7 +120,7 @@ public class RequestMessageCookieMatcher : IRequestMatcher
 
         if (!cookies.ContainsKey(Name))
         {
-            return MatchBehaviourHelper.Convert(_matchBehaviour, MatchScores.Mismatch);
+            return MatchBehaviourHelper.Convert(MatchBehaviour, MatchScores.Mismatch);
         }
 
         return Matchers.Max(m => m.IsMatch(cookies[Name]));

src/WireMock.Net/Matchers/Request/RequestMessageHeaderMatcher.cs

@@ -12,8 +12,15 @@ namespace WireMock.Matchers.Request;
 /// <inheritdoc cref="IRequestMatcher"/>
 public class RequestMessageHeaderMatcher : IRequestMatcher
 {
-    private readonly MatchBehaviour _matchBehaviour;
-    private readonly bool _ignoreCase;
+    /// <summary>
+    /// MatchBehaviour
+    /// </summary>
+    public MatchBehaviour MatchBehaviour { get; }
+
+    /// <summary>
+    /// IgnoreCase
+    /// </summary>
+    public bool IgnoreCase { get; }
 
     /// <summary>
     /// The functions
@@ -47,8 +54,8 @@ public class RequestMessageHeaderMatcher : IRequestMatcher
         Guard.NotNull(name);
         Guard.NotNull(pattern);
 
-        _matchBehaviour = matchBehaviour;
-        _ignoreCase = ignoreCase;
+        MatchBehaviour = matchBehaviour;
+        IgnoreCase = ignoreCase;
         Name = name;
         Matchers = new IStringMatcher[] { new WildcardMatcher(matchBehaviour, pattern, ignoreCase) };
     }
@@ -80,11 +87,11 @@ public class RequestMessageHeaderMatcher : IRequestMatcher
         Guard.NotNull(name);
         Guard.NotNull(matchers);
 
-        _matchBehaviour = matchBehaviour;
+        MatchBehaviour = matchBehaviour;
         MatchOperator = matchOperator;
         Name = name;
         Matchers = matchers;
-        _ignoreCase = ignoreCase;
+        IgnoreCase = ignoreCase;
     }
 
     /// <summary>
@@ -108,11 +115,11 @@ public class RequestMessageHeaderMatcher : IRequestMatcher
     {
         if (requestMessage.Headers == null)
         {
-            return MatchBehaviourHelper.Convert(_matchBehaviour, MatchScores.Mismatch);
+            return MatchBehaviourHelper.Convert(MatchBehaviour, MatchScores.Mismatch);
         }
 
         // Check if we want to use IgnoreCase to compare the Header-Name and Header-Value(s)
-        var headers = !_ignoreCase ? requestMessage.Headers : new Dictionary<string, WireMockList<string>>(requestMessage.Headers, StringComparer.OrdinalIgnoreCase);
+        var headers = !IgnoreCase ? requestMessage.Headers : new Dictionary<string, WireMockList<string>>(requestMessage.Headers, StringComparer.OrdinalIgnoreCase);
 
         if (Funcs != null)
         {
@@ -124,7 +131,7 @@ public class RequestMessageHeaderMatcher : IRequestMatcher
         {
             if (!headers.ContainsKey(Name))
             {
-                return MatchBehaviourHelper.Convert(_matchBehaviour, MatchScores.Mismatch);
+                return MatchBehaviourHelper.Convert(MatchBehaviour, MatchScores.Mismatch);
             }
 
             var results = new List<MatchResult>();
@@ -138,6 +145,6 @@ public class RequestMessageHeaderMatcher : IRequestMatcher
             return MatchResult.From(results, MatchOperator);
         }
 
-        return MatchBehaviourHelper.Convert(_matchBehaviour, MatchScores.Mismatch);
+        return MatchBehaviourHelper.Convert(MatchBehaviour, MatchScores.Mismatch);
     }
 }

src/WireMock.Net/Matchers/Request/RequestMessageParamMatcher.cs

@@ -29,7 +29,7 @@ public class RequestMessageParamMatcher : IRequestMatcher
     /// <summary>
     /// Defines if the key should be matched using case-ignore.
     /// </summary>
-    public bool? IgnoreCase { get; }
+    public bool IgnoreCase { get; }
 
     /// <summary>
     /// The matchers.
@@ -96,7 +96,7 @@ public class RequestMessageParamMatcher : IRequestMatcher
             return MatchScores.ToScore(requestMessage.Query != null && Funcs.Any(f => f(requestMessage.Query)));
         }
 
-        var valuesPresentInRequestMessage = ((RequestMessage)requestMessage).GetParameter(Key, IgnoreCase ?? false);
+        var valuesPresentInRequestMessage = ((RequestMessage)requestMessage).GetParameter(Key, IgnoreCase);
         if (valuesPresentInRequestMessage == null)
         {
             // Key is not present at all, just return Mismatch

src/WireMock.Net/Serialization/MappingConverter.cs

@@ -259,19 +259,24 @@ internal class MappingConverter
                 Headers = headerMatchers.Any() ? headerMatchers.Select(hm => new HeaderModel
                 {
                     Name = hm.Name,
-                    Matchers = _mapper.Map(hm.Matchers)
+                    IgnoreCase = hm.IgnoreCase ? true : null,
+                    RejectOnMatch = hm.MatchBehaviour == MatchBehaviour.RejectOnMatch ? true : null,
+                    Matchers = _mapper.Map(hm.Matchers),
                 }).ToList() : null,
 
                 Cookies = cookieMatchers.Any() ? cookieMatchers.Select(cm => new CookieModel
                 {
                     Name = cm.Name,
+                    IgnoreCase = cm.IgnoreCase ? true : null,
+                    RejectOnMatch = cm.MatchBehaviour == MatchBehaviour.RejectOnMatch ? true : null,
                     Matchers = _mapper.Map(cm.Matchers)
                 }).ToList() : null,
 
                 Params = paramsMatchers.Any() ? paramsMatchers.Select(pm => new ParamModel
                 {
                     Name = pm.Key,
-                    IgnoreCase = pm.IgnoreCase == true ? true : null,
+                    IgnoreCase = pm.IgnoreCase ? true : null,
+                    RejectOnMatch = pm.MatchBehaviour == MatchBehaviour.RejectOnMatch ? true : null,
                     Matchers = _mapper.Map(pm.Matchers)
                 }).ToList() : null
             },

test/WireMock.Net.Tests/Matchers/JmesPathMatcherTests.cs

@@ -1,4 +1,5 @@
 using System;
+using FluentAssertions;
 using Newtonsoft.Json.Linq;
 using NFluent;
 using WireMock.Matchers;
@@ -163,4 +164,30 @@ public class JmesPathMatcherTests
         // Assert
         Check.That(match).IsEqualTo(0.0);
     }
+
+    [Fact]
+    public void JmesPathMatcher_IsMatch_MultiplePatternsUsingMatchOperatorAnd()
+    {
+        // Assign 
+        var matcher = new JmesPathMatcher(MatchOperator.And, "things.x == 'RequiredThing'", "things.x == 'abc'");
+
+        // Act 
+        double score = matcher.IsMatch(JObject.Parse("{ \"things\": { \"x\": \"RequiredThing\" } }")).Score;
+
+        // Assert 
+        score.Should().Be(0);
+    }
+
+    [Fact]
+    public void JmesPathMatcher_IsMatch_MultiplePatternsUsingMatchOperatorOr()
+    {
+        // Assign 
+        var matcher = new JmesPathMatcher(MatchOperator.Or, "things.x == 'RequiredThing'", "things.x == 'abc'");
+
+        // Act 
+        double score = matcher.IsMatch(JObject.Parse("{ \"things\": { \"x\": \"RequiredThing\" } }")).Score;
+
+        // Assert 
+        score.Should().Be(1);
+    }
 }

test/WireMock.Net.Tests/Matchers/JsonPathMatcherTests.cs

@@ -1,4 +1,5 @@
 using System;
+using FluentAssertions;
 using Newtonsoft.Json.Linq;
 using NFluent;
 using WireMock.Matchers;
@@ -324,4 +325,52 @@ public class JsonPathMatcherTests
         // Assert 
         Check.That(match).IsEqualTo(1.0);
     }
+
+    [Fact]
+    public void JsonPathMatcher_IsMatch_MultiplePatternsUsingMatchOperatorAnd()
+    {
+        // Assign 
+        var matcher = new JsonPathMatcher(MatchBehaviour.AcceptOnMatch, MatchOperator.And, "$.arr[0].sub[0].subline1", "$.arr[0].line2");
+
+        // Act 
+        double match = matcher.IsMatch(JObject.Parse(@"{
+            ""name"": ""PathSelectorTest"",
+            ""test"": ""test"",
+            ""test2"": ""test2"",
+            ""arr"": [{
+                ""line1"": ""line1"",
+                ""sub"":[
+                {
+                    ""subline1"":""subline1""
+                }]
+            }]
+        }")).Score;
+
+        // Assert 
+        match.Should().Be(0);
+    }
+
+    [Fact]
+    public void JsonPathMatcher_IsMatch_MultiplePatternsUsingMatchOperatorOr()
+    {
+        // Assign 
+        var matcher = new JsonPathMatcher(MatchBehaviour.AcceptOnMatch, MatchOperator.Or, "$.arr[0].sub[0].subline2", "$.arr[0].line1");
+
+        // Act 
+        double match = matcher.IsMatch(JObject.Parse(@"{
+            ""name"": ""PathSelectorTest"",
+            ""test"": ""test"",
+            ""test2"": ""test2"",
+            ""arr"": [{
+                ""line1"": ""line1"",
+                ""sub"":[
+                {
+                    ""subline1"":""subline1""
+                }]
+            }]
+        }")).Score;
+
+        // Assert 
+        match.Should().Be(1);
+    }
 }

test/WireMock.Net.Tests/Serialization/MappingConverterTests.ToMappingModel_WithHeader_And_Cookie_ReturnsCorrectModel.verified.txt

@@ -0,0 +1,122 @@
+{
+  Guid: Guid_1,
+  UpdatedAt: DateTime_1,
+  Request: {
+    Headers: [
+      {
+        Name: MatchBehaviour.RejectOnMatch,
+        Matchers: [
+          {
+            Name: WildcardMatcher,
+            Pattern: hv-1,
+            IgnoreCase: true,
+            RejectOnMatch: true
+          }
+        ],
+        IgnoreCase: true,
+        RejectOnMatch: true
+      },
+      {
+        Name: MatchBehaviour.AcceptOnMatch,
+        Matchers: [
+          {
+            Name: WildcardMatcher,
+            Pattern: hv-2,
+            IgnoreCase: true
+          }
+        ],
+        IgnoreCase: true
+      },
+      {
+        Name: IgnoreCase_false,
+        Matchers: [
+          {
+            Name: WildcardMatcher,
+            Pattern: hv-3,
+            IgnoreCase: false
+          }
+        ]
+      },
+      {
+        Name: IgnoreCase_true,
+        Matchers: [
+          {
+            Name: WildcardMatcher,
+            Pattern: hv-4,
+            IgnoreCase: true
+          }
+        ],
+        IgnoreCase: true
+      },
+      {
+        Name: ExactMatcher,
+        Matchers: [
+          {
+            Name: ExactMatcher,
+            Pattern: h-exact,
+            IgnoreCase: false
+          }
+        ]
+      }
+    ],
+    Cookies: [
+      {
+        Name: MatchBehaviour.RejectOnMatch,
+        Matchers: [
+          {
+            Name: WildcardMatcher,
+            Pattern: cv-1,
+            IgnoreCase: true,
+            RejectOnMatch: true
+          }
+        ],
+        IgnoreCase: true,
+        RejectOnMatch: true
+      },
+      {
+        Name: MatchBehaviour.AcceptOnMatch,
+        Matchers: [
+          {
+            Name: WildcardMatcher,
+            Pattern: cv-2,
+            IgnoreCase: true
+          }
+        ],
+        IgnoreCase: true
+      },
+      {
+        Name: IgnoreCase_false,
+        Matchers: [
+          {
+            Name: WildcardMatcher,
+            Pattern: cv-3,
+            IgnoreCase: false
+          }
+        ]
+      },
+      {
+        Name: IgnoreCase_true,
+        Matchers: [
+          {
+            Name: WildcardMatcher,
+            Pattern: cv-4,
+            IgnoreCase: true
+          }
+        ],
+        IgnoreCase: true
+      },
+      {
+        Name: ExactMatcher,
+        Matchers: [
+          {
+            Name: ExactMatcher,
+            Pattern: c-exact,
+            IgnoreCase: false
+          }
+        ]
+      }
+    ]
+  },
+  Response: {},
+  UseWebhooksFireAndForget: false
+}

test/WireMock.Net.Tests/Serialization/MappingConverterTests.ToMappingModel_WithParam_ReturnsCorrectModel.verified.txt

@@ -0,0 +1,59 @@
+{
+  Guid: Guid_1,
+  UpdatedAt: DateTime_1,
+  Request: {
+    Params: [
+      {
+        Name: MatchBehaviour.RejectOnMatch,
+        RejectOnMatch: true
+      },
+      {
+        Name: MatchBehaviour.RejectOnMatch|IgnoreCase_false,
+        RejectOnMatch: true
+      },
+      {
+        Name: IgnoreCase_false,
+        Matchers: [
+          {
+            Name: ExactMatcher,
+            Pattern: pv-3a,
+            IgnoreCase: false
+          },
+          {
+            Name: ExactMatcher,
+            Pattern: pv-3b,
+            IgnoreCase: false
+          }
+        ]
+      },
+      {
+        Name: IgnoreCase_true,
+        IgnoreCase: true,
+        Matchers: [
+          {
+            Name: ExactMatcher,
+            Pattern: pv-3a,
+            IgnoreCase: true
+          },
+          {
+            Name: ExactMatcher,
+            Pattern: pv-3b,
+            IgnoreCase: true
+          }
+        ]
+      },
+      {
+        Name: ExactMatcher,
+        Matchers: [
+          {
+            Name: ExactMatcher,
+            Pattern: exact,
+            IgnoreCase: false
+          }
+        ]
+      }
+    ]
+  },
+  Response: {},
+  UseWebhooksFireAndForget: false
+}

test/WireMock.Net.Tests/Serialization/MappingConverterTests.cs

@@ -5,6 +5,7 @@ using System.Threading;
 using System.Threading.Tasks;
 using FluentAssertions;
 using VerifyXunit;
+using WireMock.Matchers;
 using WireMock.Models;
 using WireMock.RequestBuilders;
 using WireMock.ResponseBuilders;
@@ -362,6 +363,60 @@ public partial class MappingConverterTests
         return Verifier.Verify(model);
     }
 
+    [Fact]
+    public Task ToMappingModel_WithHeader_And_Cookie_ReturnsCorrectModel()
+    {
+        // Assign
+        var request = Request.Create()
+            .WithHeader("MatchBehaviour.RejectOnMatch", "hv-1", MatchBehaviour.RejectOnMatch)
+            .WithHeader("MatchBehaviour.AcceptOnMatch", "hv-2", MatchBehaviour.AcceptOnMatch)
+            .WithHeader("IgnoreCase_false", "hv-3", false)
+            .WithHeader("IgnoreCase_true", "hv-4")
+            .WithHeader("ExactMatcher", new ExactMatcher("h-exact"))
+
+            .WithCookie("MatchBehaviour.RejectOnMatch", "cv-1", MatchBehaviour.RejectOnMatch)
+            .WithCookie("MatchBehaviour.AcceptOnMatch", "cv-2", MatchBehaviour.AcceptOnMatch)
+            .WithCookie("IgnoreCase_false", "cv-3", false)
+            .WithCookie("IgnoreCase_true", "cv-4")
+            .WithCookie("ExactMatcher", new ExactMatcher("c-exact"))
+            ;
+        var response = Response.Create();
+        var mapping = new Mapping(_guid, _updatedAt, null, null, null, _settings, request, response, 0, null, null, null, null, null, false, null, data: null, probability: null);
+
+        // Act
+        var model = _sut.ToMappingModel(mapping);
+
+        // Assert
+        model.Should().NotBeNull();
+
+        // Verify
+        return Verifier.Verify(model);
+    }
+
+    [Fact]
+    public Task ToMappingModel_WithParam_ReturnsCorrectModel()
+    {
+        // Assign
+        var request = Request.Create()
+                .WithParam("MatchBehaviour.RejectOnMatch", MatchBehaviour.RejectOnMatch)
+                .WithParam("MatchBehaviour.RejectOnMatch|IgnoreCase_false", false, MatchBehaviour.RejectOnMatch)
+                .WithParam("IgnoreCase_false", false, "pv-3a", "pv-3b")
+                .WithParam("IgnoreCase_true", true, "pv-3a", "pv-3b")
+                .WithParam("ExactMatcher", new ExactMatcher("exact"))
+            ;
+        var response = Response.Create();
+        var mapping = new Mapping(_guid, _updatedAt, null, null, null, _settings, request, response, 0, null, null, null, null, null, false, null, data: null, probability: null);
+
+        // Act
+        var model = _sut.ToMappingModel(mapping);
+
+        // Assert
+        model.Should().NotBeNull();
+
+        // Verify
+        return Verifier.Verify(model);
+    }
+
 #if GRAPHQL
     [Fact]
     public Task ToMappingModel_Request_WithBodyAsGraphQLSchema_ReturnsCorrectModel()