Add some changelog and update some integrationtests

Author: dnperfors

CHANGELOG.md

@@ -7,16 +7,18 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [0.12] - unplanned
 ### Deprecated
 - The methods `WithRequestHeader` and `WithContentHeader` are deprecated, please use `WithHeader` instead.
-- The `WithFilter` method is deprecated and will be made internal or be removed. If there is a specific assertion that is missing, please open an issue.
+- The `WithFilter` method is deprecated and will be removed. If there is a specific assertion that is missing, please open an issue.
 
 ### Removed
 - .NET 6.0 target, since it is no longer supported
 - .NET Framework 4.6.2, 4.7.0 and 4.7.2, since these can't be tested using xUnit v3
-- automatic nuget updates by dependabot, since we want to test against the lowest supported nuget version and most of the time dependabot does not choose the right package.
+- Automatic nuget updates by dependabot, since we want to test against the lowest supported nuget version and most of the time dependabot does not choose the right package.
 
 ### Added
 - Support for .NET 9.0
 - Support for .NET 10.0
+- The class `RequestBuilder` to 'build' requests for assertion
+- The methods `TestableHttpClient.ShouldHaveMadeRequests(Action<RequestBuilder>)` and `TestableHttpClient.ShouldHaveMadeRequests(int, Action<RequestBuilder>)` as the new assertion mechanism
 
 ### Changed
 - The TestableHttpMessageHandler now makes a clone of the original request, so that the original request can be disposed.  

src/TestableHttpClient/IHttpRequestMessagesCheck.cs

@@ -16,7 +16,7 @@ public interface IHttpRequestMessagesCheck
     /// <param name="requestFilter">The filter to filter requests with before asserting.</param>
     /// <param name="condition">The name of the condition, used in the exception message.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
-    [Obsolete("WithFilter will be made internal, since it should no longer be necesary to use.")]
+    [Obsolete("WithFilter will be made removed, since it should no longer be necesary to use.")]
     public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, string condition);
 
     /// <summary>
@@ -26,7 +26,7 @@ public interface IHttpRequestMessagesCheck
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <param name="condition">The name of the condition, used in the exception message.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
-    [Obsolete("WithFilter will be made internal, since it should no longer be necesary to use.")]
+    [Obsolete("WithFilter will be made removed, since it should no longer be necesary to use.")]
     public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int expectedNumberOfRequests, string condition);
 
     /// <summary>
@@ -36,7 +36,7 @@ public interface IHttpRequestMessagesCheck
     /// <param name="expectedNumberOfRequests">The expected number of requests, when null is passed "at least one" is presumed.</param>
     /// <param name="condition">The name of the condition, used in the exception message.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
-    [Obsolete("WithFilter will be made internal, since it should no longer be necesary to use.")]
+    [Obsolete("WithFilter will be made removed, since it should no longer be necesary to use.")]
     public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int? expectedNumberOfRequests, string condition);
 
     /// <summary>

test/TestableHttpClient.IntegrationTests/AssertingRequests.cs

@@ -32,6 +32,9 @@ public async Task AssertingCallsAreNotMadeToSpecificUri()
 
         _ = await client.GetAsync("https://httpbin.org/get", TestContext.Current.CancellationToken);
 
+        testHandler.ShouldHaveMadeRequests(0, x => x.WithRequestUri("https://example.org"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(0, x => x.WithRequestUri("https://httpbin.org/get")));
+
         testHandler.ShouldHaveMadeRequestsTo("https://example.org", 0);
         Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequestsTo("https://httpbin.org/get", 0));
     }
@@ -63,15 +66,15 @@ public async Task AssertingCallsUsingUriPattern()
 
         _ = await client.GetAsync("https://httpbin.org/get", TestContext.Current.CancellationToken);
 
-        testHandler.ShouldHaveMadeRequests().WithRequestUri("https://*");
-        testHandler.ShouldHaveMadeRequests().WithRequestUri("https://*.org/get");
-        testHandler.ShouldHaveMadeRequests().WithRequestUri("https://httpbin.org/*");
-        testHandler.ShouldHaveMadeRequests().WithRequestUri("*://httpbin.org/get");
-        testHandler.ShouldHaveMadeRequests().WithRequestUri("https://httpbin.org/get");
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithRequestUri("http://httpbin.org/get"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithRequestUri("https://httpbin.org/"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithRequestUri("https://*/post"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithRequestUri("https://example.org/"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("https://*"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("https://*.org/get"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("https://httpbin.org/*"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("*://httpbin.org/get"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("https://httpbin.org/get"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("http://httpbin.org/get")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("https://httpbin.org/")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("https://*/post")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("https://example.org/")));
     }
 
     [Fact]
@@ -95,9 +98,9 @@ public async Task AssertingCallWithQueryParameters()
 
         _ = await client.GetAsync("https://httpbin.org/get?email=admin@example.com", TestContext.Current.CancellationToken);
 
-        testHandler.ShouldHaveMadeRequests().WithRequestUri("?email=admin@example.com");
-        testHandler.ShouldHaveMadeRequests().WithRequestUri("?email=*");
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithRequestUri("?email=admin%40example.com"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("?email=admin@example.com"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("?email=*"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithRequestUri("?email=admin%40example.com")));
     }
 
     [Fact]
@@ -110,6 +113,11 @@ public async Task AssertingHttpMethods()
         using StringContent content = new("");
         _ = await client.PostAsync("https://httpbin.org/post", content, TestContext.Current.CancellationToken);
 
+        testHandler.ShouldHaveMadeRequests(x => x.WithMethod(HttpMethod.Get).WithRequestUri("*/get"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithMethod(HttpMethod.Post).WithRequestUri("*/get")));
+        testHandler.ShouldHaveMadeRequests(x => x.WithMethod(HttpMethod.Post).WithRequestUri("*/post"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithMethod(HttpMethod.Get).WithRequestUri("*/post")));
+
         testHandler.ShouldHaveMadeRequestsTo("*/get").WithHttpMethod(HttpMethod.Get);
         Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequestsTo("*/get").WithHttpMethod(HttpMethod.Post));
         testHandler.ShouldHaveMadeRequestsTo("*/post").WithHttpMethod(HttpMethod.Post);
@@ -124,13 +132,13 @@ public async Task AssertingHeaders()
         client.DefaultRequestHeaders.Add("api-version", "1.0");
         _ = await client.GetAsync("https://httpbin.org/get", TestContext.Current.CancellationToken);
 
-        testHandler.ShouldHaveMadeRequests().WithHeader("api-version");
-        testHandler.ShouldHaveMadeRequests().WithHeader("api-version", "1.0");
-        testHandler.ShouldHaveMadeRequests().WithHeader("api-version", "1*");
+        testHandler.ShouldHaveMadeRequests(x => x.WithHeader("api-version"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithHeader("api-version", "1.0"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithHeader("api-version", "1*"));
 
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithHeader("my-version"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithHeader("api-version", "1"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithHeader("api-version", "2*"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithHeader("my-version")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithHeader("api-version", "1")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithHeader("api-version", "2*")));
     }
 
     [Fact]
@@ -142,15 +150,15 @@ public async Task AssertingContentHeaders()
         using StringContent content = new("", Encoding.UTF8, "application/json");
         _ = await client.PostAsync("https://httpbin.org/post", content, TestContext.Current.CancellationToken);
 
-        testHandler.ShouldHaveMadeRequests().WithHeader("content-type");
-        testHandler.ShouldHaveMadeRequests().WithHeader("Content-Type");
-        testHandler.ShouldHaveMadeRequests().WithHeader("Content-Type", "application/json; charset=utf-8");
-        testHandler.ShouldHaveMadeRequests().WithHeader("Content-Type", "application/json*");
-        testHandler.ShouldHaveMadeRequests().WithHeader("Content-Type", "*charset=utf-8");
+        testHandler.ShouldHaveMadeRequests(x => x.WithHeader("content-type"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithHeader("Content-Type"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithHeader("Content-Type", "application/json; charset=utf-8"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithHeader("Content-Type", "application/json*"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithHeader("Content-Type", "*charset=utf-8"));
 
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithHeader("Content-Disposition"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithHeader("Content-Type", "application/json"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithHeader("Content-Type", "*=utf-16"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithHeader("Content-Disposition")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithHeader("Content-Type", "application/json")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithHeader("Content-Type", "*=utf-16")));
     }
 
     [Fact]
@@ -162,12 +170,12 @@ public async Task AssertingContent()
         using StringContent content = new("my special content");
         _ = await client.PostAsync("https://httpbin.org/post", content, TestContext.Current.CancellationToken);
 
-        testHandler.ShouldHaveMadeRequests().WithContent("my special content");
-        testHandler.ShouldHaveMadeRequests().WithContent("my*content");
-        testHandler.ShouldHaveMadeRequests().WithContent("*");
+        testHandler.ShouldHaveMadeRequests(x => x.WithContent("my special content"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithContent("my*content"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithContent("*"));
 
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContent(""));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContent("my"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithContent("")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithContent("my")));
     }
 
     [Fact]
@@ -181,12 +189,12 @@ public async Task AssertingContent_WhenOriginalContentIsDisposed()
             _ = await client.PostAsync("https://httpbin.org/post", content, TestContext.Current.CancellationToken);
         }
 
-        testHandler.ShouldHaveMadeRequests().WithContent("my special content");
-        testHandler.ShouldHaveMadeRequests().WithContent("my*content");
-        testHandler.ShouldHaveMadeRequests().WithContent("*");
+        testHandler.ShouldHaveMadeRequests(x => x.WithContent("my special content"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithContent("my*content"));
+        testHandler.ShouldHaveMadeRequests(x => x.WithContent("*"));
 
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContent(""));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContent("my"));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithContent("")));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests(x => x.WithContent("my")));
     }
 
     [Fact]