ProxySettings : Add logic to not save some requests depending on Http…

…Methods (#900) * Add ExcludedHttpMethods to ProxySettings * tst * fix * SaveMappingSettings * .
WireMock-Net · Mar 9, 2023 · 674fa89 · 674fa89
1 parent 61cdc13
commit 674fa89
Show file tree

Hide file tree

Showing 9 changed files with 140 additions and 12 deletions.
diff --git a/src/WireMock.Net/Matchers/MatchScores.cs b/src/WireMock.Net/Matchers/MatchScores.cs
@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 
 namespace WireMock.Matchers;

diff --git a/src/WireMock.Net/Proxy/ProxyHelper.cs b/src/WireMock.Net/Proxy/ProxyHelper.cs
@@ -1,8 +1,10 @@
 using System;
+using System.Linq;
 using System.Net.Http;
 using System.Threading.Tasks;
 using Stef.Validation;
 using WireMock.Http;
+using WireMock.Matchers;
 using WireMock.Serialization;
 using WireMock.Settings;
 using WireMock.Util;
@@ -47,12 +49,33 @@ public ProxyHelper(WireMockServerSettings settings)
         var responseMessage = await HttpResponseMessageHelper.CreateAsync(httpResponseMessage, requiredUri, originalUri, deserializeJson, decompressGzipAndDeflate).ConfigureAwait(false);
 
         IMapping? newMapping = null;
-        if (HttpStatusRangeParser.IsMatch(proxyAndRecordSettings.SaveMappingForStatusCodePattern, responseMessage.StatusCode) &&
-            (proxyAndRecordSettings.SaveMapping || proxyAndRecordSettings.SaveMappingToFile))
+
+        var saveMappingSettings = proxyAndRecordSettings.SaveMappingSettings;
+
+        bool save = true;
+        if (saveMappingSettings != null)
+        {
+            save &= Check(saveMappingSettings.StatusCodePattern,
+                () => HttpStatusRangeParser.IsMatch(saveMappingSettings.StatusCodePattern, responseMessage.StatusCode)
+            );
+
+            save &= Check(saveMappingSettings.HttpMethods,
+                () => saveMappingSettings.HttpMethods.Value.Contains(requestMessage.Method, StringComparer.OrdinalIgnoreCase)
+            );
+        }
+
+        if (save && (proxyAndRecordSettings.SaveMapping || proxyAndRecordSettings.SaveMappingToFile))
         {
             newMapping = _proxyMappingConverter.ToMapping(mapping, proxyAndRecordSettings, requestMessage, responseMessage);
         }
 
         return (responseMessage, newMapping);
     }
+
+    private static bool Check<T>(ProxySaveMappingSetting<T>? saveMappingSetting, Func<bool> action)
+    {
+        var isMatch = saveMappingSetting is null || action();
+        var matchBehaviour = saveMappingSetting?.MatchBehaviour ?? MatchBehaviour.AcceptOnMatch;
+        return isMatch == (matchBehaviour == MatchBehaviour.AcceptOnMatch);
+    }
 }
diff --git a/src/WireMock.Net/Serialization/ProxyMappingConverter.cs b/src/WireMock.Net/Serialization/ProxyMappingConverter.cs
@@ -26,8 +26,12 @@ public ProxyMappingConverter(WireMockServerSettings settings, IGuidUtils guidUti
         _dateTimeUtils = Guard.NotNull(dateTimeUtils);
     }
 
-    public IMapping ToMapping(IMapping? mapping, ProxyAndRecordSettings proxyAndRecordSettings, IRequestMessage requestMessage, ResponseMessage responseMessage)
+    public IMapping? ToMapping(IMapping? mapping, ProxyAndRecordSettings proxyAndRecordSettings, IRequestMessage requestMessage, ResponseMessage responseMessage)
     {
+        var useDefinedRequestMatchers = proxyAndRecordSettings.UseDefinedRequestMatchers;
+        var excludedHeaders = new List<string>(proxyAndRecordSettings.ExcludedHeaders ?? new string[] { }) { "Cookie" };
+        var excludedCookies = proxyAndRecordSettings.ExcludedCookies ?? new string[0];
+
         var request = (Request?)mapping?.RequestMatcher;
         var clientIPMatcher = request?.GetRequestMessageMatcher<RequestMessageClientIPMatcher>();
         var pathMatcher = request?.GetRequestMessageMatcher<RequestMessagePathMatcher>();
@@ -37,11 +41,6 @@ public IMapping ToMapping(IMapping? mapping, ProxyAndRecordSettings proxyAndReco
         var methodMatcher = request?.GetRequestMessageMatcher<RequestMessageMethodMatcher>();
         var bodyMatcher = request?.GetRequestMessageMatcher<RequestMessageBodyMatcher>();
 
-        var useDefinedRequestMatchers = proxyAndRecordSettings.UseDefinedRequestMatchers;
-
-        var excludedHeaders = new List<string>(proxyAndRecordSettings.ExcludedHeaders ?? new string[] { }) { "Cookie" };
-        var excludedCookies = proxyAndRecordSettings.ExcludedCookies ?? new string[] { };
-
         var newRequest = Request.Create();
 
         // ClientIP

diff --git a/src/WireMock.Net/Settings/ProxyAndRecordSettings.cs b/src/WireMock.Net/Settings/ProxyAndRecordSettings.cs
@@ -28,9 +28,28 @@ public class ProxyAndRecordSettings : HttpClientSettings
     /// <summary>
     /// Only save request/response to the internal Mappings if the status code is included in this pattern. (Note that SaveMapping must also be set to true.)
     /// The pattern can contain a single value like "200", but also ranges like "2xx", "100,300,600" or "100-299,6xx" are supported.
+    ///
+    /// Deprecated : use SaveMappingSettings.
+    /// </summary>
+    [PublicAPI]
+    public string SaveMappingForStatusCodePattern
+    {
+        set
+        {
+            if (SaveMappingSettings is null)
+            {
+                SaveMappingSettings = new ProxySaveMappingSettings();
+            }
+
+            SaveMappingSettings.StatusCodePattern = value;
+        }
+    }
+
+    /// <summary>
+    /// Additional SaveMappingSettings.
     /// </summary>
     [PublicAPI]
-    public string SaveMappingForStatusCodePattern { get; set; } = "*";
+    public ProxySaveMappingSettings? SaveMappingSettings { get; set; }
 
     /// <summary>
     /// Defines a list from headers which will be excluded from the saved mappings.

diff --git a/src/WireMock.Net/Settings/ProxySaveMappingSetting.cs b/src/WireMock.Net/Settings/ProxySaveMappingSetting.cs
@@ -0,0 +1,20 @@
+using WireMock.Matchers;
+
+namespace WireMock.Settings;
+
+public class ProxySaveMappingSetting<T>
+{
+    public MatchBehaviour MatchBehaviour { get; } = MatchBehaviour.AcceptOnMatch;
+
+    public T Value { get; private set; }
+
+    public ProxySaveMappingSetting(T value, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        Value = value;
+        MatchBehaviour = matchBehaviour;
+    }
+
+    public static implicit operator ProxySaveMappingSetting<T>(T value) => new ProxySaveMappingSetting<T>(value);
+
+    public static implicit operator T(ProxySaveMappingSetting<T> @this) => @this.Value;
+}
diff --git a/src/WireMock.Net/Settings/ProxySaveMappingSettings.cs b/src/WireMock.Net/Settings/ProxySaveMappingSettings.cs
@@ -0,0 +1,22 @@
+using JetBrains.Annotations;
+
+namespace WireMock.Settings;
+
+/// <summary>
+/// ProxySaveMappingSettings
+/// </summary>
+public class ProxySaveMappingSettings
+{
+    /// <summary>
+    /// Only save request/response to the internal Mappings if the status code is included in this pattern. (Note that SaveMapping must also be set to true.)
+    /// The pattern can contain a single value like "200", but also ranges like "2xx", "100,300,600" or "100-299,6xx" are supported.
+    /// </summary>
+    [PublicAPI]
+    public ProxySaveMappingSetting<string>? StatusCodePattern { get; set; } = "*";
+
+    /// <summary>
+    /// Only save these Http Methods. (Note that SaveMapping must also be set to true.)
+    /// </summary>
+    [PublicAPI]
+    public ProxySaveMappingSetting<string[]>? HttpMethods { get; set; }
+}
diff --git a/src/WireMock.Net/Settings/WireMockServerSettingsParser.cs b/src/WireMock.Net/Settings/WireMockServerSettingsParser.cs
@@ -4,6 +4,7 @@
 using JetBrains.Annotations;
 using Stef.Validation;
 using WireMock.Logging;
+using WireMock.Matchers;
 using WireMock.Types;
 using WireMock.Util;
 
@@ -111,7 +112,12 @@ public static bool TryParseArguments(string[] args, [NotNullWhen(true)] out Wire
                 SaveMappingToFile = parser.GetBoolValue("SaveMappingToFile"),
                 UseDefinedRequestMatchers = parser.GetBoolValue(nameof(ProxyAndRecordSettings.UseDefinedRequestMatchers)),
                 AppendGuidToSavedMappingFile = parser.GetBoolValue(nameof(ProxyAndRecordSettings.AppendGuidToSavedMappingFile)),
-                Url = proxyUrl!
+                Url = proxyUrl!,
+                SaveMappingSettings = new ProxySaveMappingSettings
+                {
+                    StatusCodePattern = parser.GetStringValue("SaveMappingForStatusCodePattern", "*"),
+                    // HttpMethods = new ProxySaveMappingSetting<string[]>(parser.GetValues("DoNotSaveMappingForHttpMethods", new string[0]), MatchBehaviour.RejectOnMatch)
+                }
             };
 
             string? proxyAddress = parser.GetStringValue("WebProxyAddress");

diff --git a/test/WireMock.Net.Tests/Serialization/ProxyMappingConverterTests.cs b/test/WireMock.Net.Tests/Serialization/ProxyMappingConverterTests.cs
@@ -1,6 +1,7 @@
 #if !(NET452 || NET461 || NETCOREAPP3_1)
 using System;
 using System.Threading.Tasks;
+using FluentAssertions;
 using Moq;
 using VerifyTests;
 using VerifyXunit;
@@ -70,7 +71,7 @@ public Task ToMapping_UseDefinedRequestMatchers_True()
         var responseMessage = new ResponseMessage();
 
         // Act
-        var proxyMapping = _sut.ToMapping(mappingMock.Object, proxyAndRecordSettings, requestMessageMock.Object, responseMessage);
+        var proxyMapping = _sut.ToMapping(mappingMock.Object, proxyAndRecordSettings, requestMessageMock.Object, responseMessage)!;
 
         // Assert
         var model = _mappingConverter.ToMappingModel(proxyMapping);

diff --git a/test/WireMock.Net.Tests/WireMockServer.Proxy.cs b/test/WireMock.Net.Tests/WireMockServer.Proxy.cs
@@ -248,6 +248,45 @@ public async Task WireMockServer_Proxy_With_SaveMappingForStatusCodePattern_Is_F
         fileSystemHandlerMock.Verify(f => f.WriteMappingFile(It.IsAny<string>(), It.IsAny<string>()), Times.Never);
     }
 
+    [Fact]
+    public async Task WireMockServer_Proxy_With_DoNotSaveMappingForHttpMethod_Should_Not_SaveMapping()
+    {
+        // Assign
+        var fileSystemHandlerMock = new Mock<IFileSystemHandler>();
+        fileSystemHandlerMock.Setup(f => f.GetMappingFolder()).Returns("m");
+
+        var settings = new WireMockServerSettings
+        {
+            ProxyAndRecordSettings = new ProxyAndRecordSettings
+            {
+                Url = "http://www.google.com",
+                SaveMapping = true,
+                SaveMappingToFile = true,
+                SaveMappingSettings = new ProxySaveMappingSettings
+                {
+                    HttpMethods = new ProxySaveMappingSetting<string[]>(new string[] { "GET" }, MatchBehaviour.RejectOnMatch) // To make sure that we don't want this mapping
+                }
+            },
+            FileSystemHandler = fileSystemHandlerMock.Object
+        };
+        var server = WireMockServer.Start(settings);
+
+        // Act
+        var requestMessage = new HttpRequestMessage
+        {
+            Method = HttpMethod.Get,
+            RequestUri = new Uri(server.Urls[0])
+        };
+        var httpClientHandler = new HttpClientHandler { AllowAutoRedirect = false };
+        await new HttpClient(httpClientHandler).SendAsync(requestMessage).ConfigureAwait(false);
+
+        // Assert
+        server.Mappings.Should().HaveCount(1);
+
+        // Verify
+        fileSystemHandlerMock.Verify(f => f.WriteMappingFile(It.IsAny<string>(), It.IsAny<string>()), Times.Never);
+    }
+
     [Fact]
     public async Task WireMockServer_Proxy_Should_log_proxied_requests()
     {