Ignore case on uri matching, unless told otherwise.

Author: dnperfors

CHANGELOG.md

@@ -23,6 +23,7 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - When `HttpResponseMessage.Content` is null after `IResponse.ExecuteAsync` was called, an empty `StringContent` is added (Up until .NET 6.0, since Content is always filled there).
 - The `HttpRequestMessage` is always added to the response, which is now possible, since we no longer allow reusing responses.
 - Added `ConfigureAwait(false)` to all calls, since we now use async/await in the library.
+- The check on request uri is now case insensitive by default, when test url's that are case sensitive set the `ignoreCase` parameter to false.
 
 ## [0.7] - 2022-09-22
 ### Changed

src/TestableHttpClient/HttpRequestMessageExtensions.cs

@@ -205,7 +205,7 @@ public static bool HasContentHeader(this HttpRequestMessage httpRequestMessage,
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the correct uri on.</param>
     /// <param name="pattern">A pattern to match with the request uri, supports * as wildcards.</param>
     /// <returns>true when the request uri matches the pattern; otherwise, false.</returns>
-    public static bool HasMatchingUri(this HttpRequestMessage httpRequestMessage, string pattern)
+    public static bool HasMatchingUri(this HttpRequestMessage httpRequestMessage, string pattern, bool ignoreCase = true)
     {
         if (httpRequestMessage == null)
         {
@@ -222,7 +222,7 @@ public static bool HasMatchingUri(this HttpRequestMessage httpRequestMessage, st
             null => throw new ArgumentNullException(nameof(pattern)),
             "" => false,
             "*" => true,
-            _ => StringMatcher.Matches(httpRequestMessage.RequestUri.AbsoluteUri, pattern),
+            _ => StringMatcher.Matches(httpRequestMessage.RequestUri.AbsoluteUri, pattern, ignoreCase),
         };
     }
 

src/TestableHttpClient/HttpRequestMessagesCheckExtensions.cs

@@ -8,7 +8,9 @@ public static class HttpRequestMessagesCheckExtensions
     /// <param name="check">The implementation that hold all the request messages.</param>
     /// <param name="pattern">The uri pattern that is expected.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
-    public static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessagesCheck check, string pattern) => WithRequestUri(check, pattern, null);
+    public static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessagesCheck check, string pattern) => WithRequestUri(check, pattern, true, null);
+
+    public static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessagesCheck check, string pattern, bool ignoreCase) => WithRequestUri(check, pattern, ignoreCase, null);
 
     /// <summary>
     /// Asserts whether requests were made to a given URI based on a pattern.
@@ -17,9 +19,10 @@ public static class HttpRequestMessagesCheckExtensions
     /// <param name="pattern">The uri pattern that is expected.</param>
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
-    public static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessagesCheck check, string pattern, int expectedNumberOfRequests) => WithRequestUri(check, pattern, (int?)expectedNumberOfRequests);
+    public static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessagesCheck check, string pattern, int expectedNumberOfRequests) => WithRequestUri(check, pattern, true, (int?)expectedNumberOfRequests);
+    public static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessagesCheck check, string pattern, bool ignoreCase, int expectedNumberOfRequests) => WithRequestUri(check, pattern, ignoreCase, (int?)expectedNumberOfRequests);
 
-    private static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessagesCheck check, string pattern, int? expectedNumberOfRequests)
+    private static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessagesCheck check, string pattern, bool ignoreCase, int? expectedNumberOfRequests)
     {
         if (check == null)
         {
@@ -37,7 +40,7 @@ private static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessage
             condition = $"uri pattern '{pattern}'";
         }
 
-        return check.WithFilter(x => x.HasMatchingUri(pattern), expectedNumberOfRequests, condition);
+        return check.WithFilter(x => x.HasMatchingUri(pattern, ignoreCase), expectedNumberOfRequests, condition);
     }
 
     /// <summary>

src/TestableHttpClient/TestableHttpMessageHandlerAssertionExtensions.cs

@@ -49,6 +49,21 @@ public static IHttpRequestMessagesCheck ShouldHaveMadeRequests(this TestableHttp
     /// <exception cref="HttpRequestMessageAssertionException">When no requests are made</exception>
     [AssertionMethod]
     public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHttpMessageHandler handler, string pattern)
+    {
+        return handler.ShouldHaveMadeRequestsTo(pattern, true);
+    }
+
+    /// <summary>
+    /// Validates that requests to a specific uri have been made, throws an exception when no requests were made.
+    /// </summary>
+    /// <param name="handler">The <see cref="TestableHttpMessageHandler"/> that should be asserted.</param>
+    /// <param name="pattern">The uri pattern to validate against, the pattern supports *.</param>
+    /// <param name="ignoreCase">The uri validation should ignore cases.</param>
+    /// <returns>An <see cref="IHttpRequestMessagesCheck"/> that can be used for additional assertions.</returns>
+    /// <exception cref="ArgumentNullException">handler is `null` or pattern is `null`</exception>
+    /// <exception cref="HttpRequestMessageAssertionException">When no requests are made</exception>
+    [AssertionMethod]
+    public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHttpMessageHandler handler, string pattern, bool ignoreCase)
     {
         if (handler == null)
         {
@@ -60,7 +75,7 @@ public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHt
             throw new ArgumentNullException(nameof(pattern));
         }
 
-        return new HttpRequestMessageAsserter(handler.Requests, handler.Options).WithRequestUri(pattern);
+        return new HttpRequestMessageAsserter(handler.Requests, handler.Options).WithRequestUri(pattern, ignoreCase);
     }
 
     /// <summary>
@@ -74,6 +89,21 @@ public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHt
     /// <exception cref="HttpRequestMessageAssertionException">When no requests are made</exception>
     [AssertionMethod]
     public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHttpMessageHandler handler, string pattern, int expectedNumberOfRequests)
+    {
+        return handler.ShouldHaveMadeRequestsTo(pattern, true, expectedNumberOfRequests);
+    }
+
+    /// <summary>
+    /// Validates that requests to a specific uri have been made, throws an exception when no requests were made.
+    /// </summary>
+    /// <param name="handler">The <see cref="TestableHttpMessageHandler"/> that should be asserted.</param>
+    /// <param name="pattern">The uri pattern to validate against, the pattern supports *.</param>
+    /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
+    /// <returns>An <see cref="IHttpRequestMessagesCheck"/> that can be used for additional assertions.</returns>
+    /// <exception cref="ArgumentNullException">handler is `null` or pattern is `null`</exception>
+    /// <exception cref="HttpRequestMessageAssertionException">When no requests are made</exception>
+    [AssertionMethod]
+    public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHttpMessageHandler handler, string pattern, bool ignoreCase, int expectedNumberOfRequests)
     {
         if (handler == null)
         {
@@ -85,6 +115,6 @@ public static IHttpRequestMessagesCheck ShouldHaveMadeRequestsTo(this TestableHt
             throw new ArgumentNullException(nameof(pattern));
         }
 
-        return new HttpRequestMessageAsserter(handler.Requests, handler.Options).WithRequestUri(pattern, expectedNumberOfRequests);
+        return new HttpRequestMessageAsserter(handler.Requests, handler.Options).WithRequestUri(pattern, ignoreCase, expectedNumberOfRequests);
     }
 }

src/TestableHttpClient/Utils/StringMatcher.cs

@@ -4,15 +4,15 @@ namespace TestableHttpClient.Utils;
 
 internal static class StringMatcher
 {
-    internal static bool Matches(string value, string pattern)
+    internal static bool Matches(string value, string pattern, bool ignoreCase = false)
     {
         var escapedPattern = Regex.Escape(pattern);
 #if NETSTANDARD2_0
         var regex = escapedPattern.Replace("\\*", "(.*)");
 #else
         var regex = escapedPattern.Replace("\\*", "(.*)", StringComparison.InvariantCultureIgnoreCase);
 #endif
-
-        return Regex.IsMatch(value, $"^{regex}$");
+        RegexOptions options = ignoreCase ? RegexOptions.IgnoreCase : RegexOptions.None;
+        return Regex.IsMatch(value, $"^{regex}$", options);
     }
 }

test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasMatchingUri.cs

@@ -2,11 +2,10 @@
 
 public partial class HttpRequestMessageExtensionsTests
 {
-#nullable disable
     [Fact]
     public void HasMatchingUri_NullHttpRequestMessage_ThrowsArgumentNullException()
     {
-        HttpRequestMessage sut = null;
+        HttpRequestMessage sut = null!;
         var exception = Assert.Throws<ArgumentNullException>(() => sut.HasMatchingUri("*"));
         Assert.Equal("httpRequestMessage", exception.ParamName);
     }
@@ -15,10 +14,9 @@ public void HasMatchingUri_NullHttpRequestMessage_ThrowsArgumentNullException()
     public void HasMatchingUri_NullPattern_ThrowsArgumentNullException()
     {
         using var sut = new HttpRequestMessage { RequestUri = new Uri("https://example.com") };
-        var exception = Assert.Throws<ArgumentNullException>(() => sut.HasMatchingUri(null));
+        var exception = Assert.Throws<ArgumentNullException>(() => sut.HasMatchingUri(null!));
         Assert.Equal("pattern", exception.ParamName);
     }
-#nullable restore
 
     [Fact]
     public void HasMatchingUri_EmptyPattern_ReturnsFalse()
@@ -43,13 +41,31 @@ public void HasMatchingUri_NullRequestUri_ReturnsFalse()
     [InlineData("https://example.com/*")]
     [InlineData("https://*/")]
     [InlineData("https://*/*")]
+    [InlineData("HTTPS://Example.com/")]
+    [InlineData("*://Example.com/")]
     public void HasMatchingUri_WithPatternFor_ReturnsTrue(string pattern)
     {
         using var sut = new HttpRequestMessage { RequestUri = new Uri("https://example.com") };
 
         Assert.True(sut.HasMatchingUri(pattern));
     }
 
+    [Theory]
+    [InlineData("*", true)]
+    [InlineData("https://example.com*", true)]
+    [InlineData("https://example.com/", true)]
+    [InlineData("https://example.com/*", true)]
+    [InlineData("https://*/", true)]
+    [InlineData("https://*/*", true)]
+    [InlineData("HTTPS://Example.com/", false)]
+    [InlineData("*://Example.com/", false)]
+    public void HasMatchingUri_WithPatternForAndNotIgnoringCase_ReturnsFalse(string pattern, bool expectedResult)
+    {
+        using var sut = new HttpRequestMessage { RequestUri = new Uri("https://example.com") };
+
+        Assert.Equal(expectedResult, sut.HasMatchingUri(pattern, ignoreCase: false));
+    }
+
     [Fact]
     public void HasMatchingUri_PatternWithMultipleWildCards_ReturnsTrue()
     {

test/TestableHttpClient.Tests/HttpRequestMessagesCheckExtensionsTests/WithRequestUri.cs

@@ -4,11 +4,10 @@ namespace TestableHttpClient.Tests.HttpRequestMessagesCheckExtensionsTests;
 
 public class WithRequestUri
 {
-#nullable disable
     [Fact]
     public void WithRequestUri_WithoutNumberOfRequests_NullCheck_ThrowsArgumentNullException()
     {
-        IHttpRequestMessagesCheck sut = null;
+        IHttpRequestMessagesCheck sut = null!;
 
         var exception = Assert.Throws<ArgumentNullException>(() => sut.WithRequestUri("*"));
 
@@ -18,7 +17,7 @@ public void WithRequestUri_WithoutNumberOfRequests_NullCheck_ThrowsArgumentNullE
     [Fact]
     public void WithRequestUri_WithNumberOfRequests_NullCheck_ThrowsArgumentNullException()
     {
-        IHttpRequestMessagesCheck sut = null;
+        IHttpRequestMessagesCheck sut = null!;
 
         var exception = Assert.Throws<ArgumentNullException>(() => sut.WithRequestUri("*", 2));
 
@@ -37,7 +36,6 @@ public void WithRequestUri_NullOrEmptyPattern_ThrowsArgumentNullException(string
         Assert.Equal("pattern", exception.ParamName);
         sut.Verify(x => x.WithFilter(Its.AnyPredicate(), It.IsAny<int?>(), It.IsAny<string>()), Times.Never());
     }
-#nullable restore
 
     [Fact]
     public void WithRequestUri_WithoutNumberOfRequests_CallsWithCorrectly()
@@ -50,11 +48,21 @@ public void WithRequestUri_WithoutNumberOfRequests_CallsWithCorrectly()
     }
 
     [Fact]
-    public void WithRequestUri_WithNumberOfRequests_CallsWithCorrectly()
+    public void WithRequestUri_WithoutNumberOfRequestsAndNotIgnoringCase_CallsWithCorrectly()
     {
         var sut = new Mock<IHttpRequestMessagesCheck>();
 
-        sut.Object.WithRequestUri("https://example.com/", 2);
+        sut.Object.WithRequestUri("https://example.com/", ignoreCase: false);
+
+        sut.Verify(x => x.WithFilter(Its.AnyPredicate(), null, "uri pattern 'https://example.com/'"));
+    }
+
+    [Fact]
+    public void WithRequestUri_WithNumberOfRequestsAndNotIgnoringCase_CallsWithCorrectly()
+    {
+        var sut = new Mock<IHttpRequestMessagesCheck>();
+
+        sut.Object.WithRequestUri("https://example.com/", ignoreCase: false, 2);
 
         sut.Verify(x => x.WithFilter(Its.AnyPredicate(), (int?)2, "uri pattern 'https://example.com/'"));
     }

test/TestableHttpClient.Tests/TestabeHttpMessageHandlerAssertionExtensionsTests/ShouldHaveMadeRequestsTo.cs

@@ -46,7 +46,6 @@ public void ShouldHaveMadeRequestsTo_WhenNoRequestsWereMade_ThrowsHttpRequestMes
         Assert.Throws<HttpRequestMessageAssertionException>(() => sut.ShouldHaveMadeRequestsTo("https://example.com/"));
     }
 
-
     [Fact]
     public void ShouldHaveMadeRequestsToWithNumberOfRequests_WhenNoRequestsWereMadeAndOneIsExpected_ThrowsHttpRequestMessageAssertionException()
     {
@@ -68,7 +67,7 @@ public void ShouldHaveMadeRequestsToWithNumberOfRequests_WhenNoRequestsWereMadeA
     }
 
     [Fact]
-    public async Task ShouldHaveMadeRequestsTo_WhenMatchinRequestsWereMade_ReturnsHttpRequestMessageAsserter()
+    public async Task ShouldHaveMadeRequestsTo_WhenMatchingRequestsWithSameCaseWereMade_ReturnsHttpRequestMessageAsserter()
     {
         using var sut = new TestableHttpMessageHandler();
         using var client = new HttpClient(sut);
@@ -83,7 +82,7 @@ public async Task ShouldHaveMadeRequestsTo_WhenMatchinRequestsWereMade_ReturnsHt
     }
 
     [Fact]
-    public async Task ShouldHaveMadeRequestsToWithNumberOfRequests_WhenMatchinRequestsWereMade_ReturnsHttpRequestMessageAsserter()
+    public async Task ShouldHaveMadeRequestsToWithNumberOfRequests_WhenMatchingRequestsWithSameCaseWereMade_ReturnsHttpRequestMessageAsserter()
     {
         using var sut = new TestableHttpMessageHandler();
         using var client = new HttpClient(sut);
@@ -96,4 +95,56 @@ public async Task ShouldHaveMadeRequestsToWithNumberOfRequests_WhenMatchinReques
         Assert.IsType<HttpRequestMessageAsserter>(result);
         Assert.Same(sut.Options, result.Options);
     }
+
+    [Fact]
+    public async Task ShouldHaveMadeRequestsTo_WhenMatchingRequestsWithDifferentCaseWereMade_ReturnsHttpRequestMessageAsserter()
+    {
+        using var sut = new TestableHttpMessageHandler();
+        using var client = new HttpClient(sut);
+
+        _ = await client.GetAsync(new Uri("https://Example.com/Test"));
+
+        var result = sut.ShouldHaveMadeRequestsTo("https://example.com/test");
+
+        Assert.NotNull(result);
+        Assert.IsType<HttpRequestMessageAsserter>(result);
+        Assert.Same(sut.Options, result.Options);
+    }
+
+    [Fact]
+    public async Task ShouldHaveMadeRequestsTo_WhenMatchingRequestsWithDifferentCaseWereMadeAndNotIgnoringCase_ThrowsException()
+    {
+        using var sut = new TestableHttpMessageHandler();
+        using var client = new HttpClient(sut);
+
+        _ = await client.GetAsync(new Uri("https://Example.com/Test"));
+
+        Assert.Throws<HttpRequestMessageAssertionException>(() => sut.ShouldHaveMadeRequestsTo("https://example.com/test", ignoreCase: false));
+    }
+
+    [Fact]
+    public async Task ShouldHaveMadeRequestsToWithNumberOfRequests_WhenMatchingRequestsWithDifferentCaseWereMade_ReturnsHttpRequestMessageAsserter()
+    {
+        using var sut = new TestableHttpMessageHandler();
+        using var client = new HttpClient(sut);
+
+        _ = await client.GetAsync(new Uri("https://Example.com/Test"));
+
+        var result = sut.ShouldHaveMadeRequestsTo("https://example.com/test", 1);
+
+        Assert.NotNull(result);
+        Assert.IsType<HttpRequestMessageAsserter>(result);
+        Assert.Same(sut.Options, result.Options);
+    }
+
+    [Fact]
+    public async Task ShouldHaveMadeRequestsToWithNumberOfRequests_WhenMatchingRequestsWithDifferentCaseWereMadeAndNotIgnoringCase_ShouldThrowException()
+    {
+        using var sut = new TestableHttpMessageHandler();
+        using var client = new HttpClient(sut);
+
+        _ = await client.GetAsync(new Uri("https://Example.com/Test"));
+
+        Assert.Throws<HttpRequestMessageAssertionException>(() => sut.ShouldHaveMadeRequestsTo("https://example.com/test", ignoreCase: false, 1));
+    }
 }