Add support for header matching

Author: dnperfors

src/TestableHttpClient/Utils/HttpRequestMessagePattern.cs

@@ -5,8 +5,7 @@ internal sealed class HttpRequestMessagePattern
     public Value<HttpMethod> Method { get; init; } = Value.Any<HttpMethod>();
     public UriPattern RequestUri { get; init; } = UriPattern.Any;
     public Value<Version> Version { get; init; } = Value.Any<Version>();
-
-    // public ??? Headers { get; init; }
+    public Dictionary<Value<string>, Value<string>> Headers { get; init; } = new() { [Value.Any<string>()] = Value.Any<string>() };
     public Value<string> Content { get; init; } = Value.Any<string>();
 
     public HttpRequestMessagePatternMatchingResult Matches(HttpRequestMessage httpRequestMessage, HttpRequestMessagePatternMatchingOptions options) =>
@@ -15,9 +14,46 @@ public HttpRequestMessagePatternMatchingResult Matches(HttpRequestMessage httpRe
             Method = Method.Matches(httpRequestMessage.Method, false),
             RequestUri = RequestUri.Matches(httpRequestMessage.RequestUri, options.RequestUriMatchingOptions),
             Version = Version.Matches(httpRequestMessage.Version, false),
+            Headers = MatchesHeaders(httpRequestMessage),
             Content = MatchesContent(httpRequestMessage.Content)
         };
 
+    private bool MatchesHeaders(HttpRequestMessage httpRequestMessage)
+    {
+        IEnumerable<KeyValuePair<string, IEnumerable<string>>> requestHeaders = httpRequestMessage.Headers;
+        if (httpRequestMessage.Content is not null)
+        {
+            requestHeaders = requestHeaders.Concat(httpRequestMessage.Content.Headers);
+        }
+
+        return MatchesHeaders(requestHeaders.ToDictionary(x => x.Key, x => string.Join(", ", x.Value), StringComparer.OrdinalIgnoreCase));
+    }
+
+    private bool MatchesHeaders(Dictionary<string, string> requestHeaders)
+    {
+        if (Headers.Count == 0 && requestHeaders.Count > 0)
+        {
+            return false;
+        }
+
+        foreach (var header in Headers)
+        {
+            bool matched = false;
+
+            foreach (var requestHeader in requestHeaders)
+            {
+                matched |= header.Key.Matches(requestHeader.Key, true) && header.Value.Matches(requestHeader.Value, true);
+            }
+
+            if (!matched)
+            {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
     private bool MatchesContent(HttpContent? requestContent)
     {
         if (requestContent == null)
@@ -41,6 +77,7 @@ internal sealed class HttpRequestMessagePatternMatchingResult
     public bool Method { get; init; }
     public bool RequestUri { get; init; }
     public bool Version { get; init; }
+    public bool Headers { get; init; }
     public bool Content { get; init; }
 }
 

test/TestableHttpClient.Tests/Utils/HttpRequestMessagePatternTests.cs

@@ -27,6 +27,8 @@ public void Matches_HttpRequestMessageWithAnyHttpMethod_MatchesAllHttpMethods(st
 
     [Theory]
     [InlineData("GET", true)]
+    [InlineData("get", true)]
+    [InlineData("Get", true)]
     [InlineData("POST", true)]
     [InlineData("PATCH", false)]
     [InlineData("PUT", false)]
@@ -127,4 +129,106 @@ public void Matches_HttpRequestMessageWithNotMatchingBody_DoesNotMatchExactBody(
 
         Assert.False(sut.Matches(matchingRequest, defaultOptions).Content);
     }
+
+    [Fact]
+    public void Matches_HttpRequestMessageWithNoHeaders_DoesMatchNoHeaders()
+    {
+        HttpRequestMessagePattern sut = new()
+        {
+            Headers = new()
+        };
+
+        using HttpRequestMessage matchingRequest = new();
+
+        Assert.True(sut.Matches(matchingRequest, defaultOptions).Headers);
+    }
+
+    [Fact]
+    public void Matches_HttpRequestMessageWithHeaders_DoesNotMatchNoHeaders()
+    {
+        HttpRequestMessagePattern sut = new()
+        {
+            Headers = new()
+        };
+
+        using HttpRequestMessage matchingRequest = new();
+        matchingRequest.Headers.Host = "localhost";
+
+        Assert.False(sut.Matches(matchingRequest, defaultOptions).Headers);
+    }
+
+    [Fact]
+    public void Matches_HttpRequestMessageWithHeaders_DoesMatchAnyHeaders()
+    {
+        HttpRequestMessagePattern sut = new();
+
+        using HttpRequestMessage matchingRequest = new();
+        matchingRequest.Headers.Host = "localhost";
+
+        Assert.True(sut.Matches(matchingRequest, defaultOptions).Headers);
+    }
+
+    [Theory]
+    [InlineData("Host")]
+    [InlineData("host")]
+    [InlineData("HOST")]
+    public void Matches_HttpRequestMessageWithHeaders_DoesMatchExactHeaders(string headerName)
+    {
+        HttpRequestMessagePattern sut = new()
+        {
+            Headers = new() { [Value.Exact(headerName)] = Value.Exact("localhost") }
+        };
+
+        using HttpRequestMessage matchingRequest = new();
+        matchingRequest.Headers.Host = "localhost";
+
+        Assert.True(sut.Matches(matchingRequest, defaultOptions).Headers);
+
+        matchingRequest.Headers.Host = "localhost2";
+        Assert.False(sut.Matches(matchingRequest, defaultOptions).Headers);
+    }
+
+    [Fact]
+    public void Matches_HttpRequestMessageWithHeaders_DoesMatchExactContentHeaders()
+    {
+        HttpRequestMessagePattern sut = new()
+        {
+            Headers = new() { [Value.Exact("Content-Disposition")] = Value.Exact("inline") }
+        };
+
+        using HttpRequestMessage matchingRequest = new()
+        {
+            Content = new StringContent("")
+        };
+        matchingRequest.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("inline");
+
+        Assert.True(sut.Matches(matchingRequest, defaultOptions).Headers);
+
+        matchingRequest.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment");
+        Assert.False(sut.Matches(matchingRequest, defaultOptions).Headers);
+    }
+
+    [Fact]
+    public void Matches_HttpRequestMessageWithHeaders_AnyDoesNotOverrideExactHeader()
+    {
+        HttpRequestMessagePattern sut = new()
+        {
+            Headers = new()
+            {
+                [Value.Any<string>()] = Value.Any<string>(),
+                [Value.Exact("Content-Disposition")] = Value.Exact("inline"),
+            }
+        };
+
+        using HttpRequestMessage matchingRequest = new()
+        {
+            Content = new StringContent("")
+        };
+        matchingRequest.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("inline");
+
+        Assert.True(sut.Matches(matchingRequest, defaultOptions).Headers);
+
+        matchingRequest.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment");
+        Assert.False(sut.Matches(matchingRequest, defaultOptions).Headers);
+    }
 }