Extract check logic to an interface and extension methods.

The interface for asserting a collection of HttpRequestMessages can be shared between the current HttpRequestMessageAsserter and the checks that have to be written for NFluent. Therefore extracting all common logic into extension methods and adding an interface to HttpRequestMessageAsserter will make it easier to implement the NFluent Checks.

Author: dnperfors

CHANGELOG.md

@@ -5,6 +5,34 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+- Introduced `IHttpRequestMessagesCheck` as the public interface for all checks on requests made to `TestableHttpMessageHandler`. It contains the following api:
+  - `With(Func<HttpRequestMessage, bool>, string)`
+  - `Times(int)`
+- Moved some api's from `TestableHttpMessageHandler` to `TestableHttpMessageHandlerAssertionExtensions`:
+  - `ShouldHaveMadeRequests(this TestableHttpMessageHandler)`
+  - `ShouldHaveMadeRequestsTo(this TestableHttpMessageHandler, string)`
+  - `ShouldNotHaveMadeRequests(this TestableHttpMessageHandler)`
+  - `ShouldNotHaveMadeRequestsTo(this TestableHttpMessageHandler, string)`
+- Moved most methods from `HttpRequestMessageAsserter` to `HttpRequestMessagesCheckExtensions`:
+  - `WithRequestUri(this IHttpRequestMessagesCheck, string)` which is renamed from `WithUriPattern(this IHttpRequestMessagesCheck, string)`
+  - `WithHttpMethod(this IHttpRequestMessagesCheck, HttpMethod)`
+  - `WithHttpVersion(this IHttpRequestMessagesCheck, Version)`
+  - `WithRequestHeader(this IHttpRequestMessagesCheck, string)`
+  - `WithRequestHeader(this IHttpRequestMessagesCheck, string, string)`
+  - `WithContentHeader(this IHttpRequestMessagesCheck, string)`
+  - `WithContentHeader(this IHttpRequestMessagesCheck, string, string)`
+  - `WithHeader(this IHttpRequestMessagesCheck, string)`
+  - `WithHeader(this IHttpRequestMessagesCheck, string, string)`
+  - `WithContent(this IHttpRequestMessagesCheck, string)`
+  - `WithJsonContent(this IHttpRequestMessagesCheck, object)`
+  - `WithFormUrlEncodedContent(this IHttpRequestMessagesCheck, IEnumerable<KeyValuePair<string, string>)`
+
+### Deprecated
+- `WithUriPattern(this IHttpRequestMessagesCheck, string)` will be removed in favour of `WithRequestUri(this IHttpRequestMessagesCheck, string)`
+
+### Removed
+- `HttpRequestMessageAsserter` is made internal.
 
 ## [0.4] - 2020-05-26
 ### Removed 

TestableHttpClient.sln

@@ -14,6 +14,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{800147F1-758C-406D-AF75-CB20EB7CDB18}"
 	ProjectSection(SolutionItems) = preProject
 		.editorconfig = .editorconfig
+		CHANGELOG.md = CHANGELOG.md
 		LICENSE = LICENSE
 		README.md = README.md
 	EndProjectSection

src/TestableHttpClient/AssemblyInfo.cs

@@ -0,0 +1,3 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("TestableHttpClient.Tests")]

src/TestableHttpClient/HttpRequestMessageAsserter.cs

@@ -2,14 +2,13 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Net.Http;
-using System.Text.Json;
 
 namespace TestableHttpClient
 {
     /// <summary>
     /// This class makes it easy to create assertions on a collection of <seealso cref="HttpRequestMessage"/>s.
     /// </summary>
-    public class HttpRequestMessageAsserter
+    internal class HttpRequestMessageAsserter : IHttpRequestMessagesCheck
     {
         private readonly List<string> _expectedConditions = new List<string>();
         private readonly bool _negate = false;
@@ -89,8 +88,8 @@ private void Assert(int? count = null)
         /// </summary>
         /// <param name="requestFilter">The filter to filter requests with before asserting.</param>
         /// <param name="condition">The name of the conditon, used in the exception message.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter With(Func<HttpRequestMessage, bool> requestFilter, string condition)
+        /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+        public IHttpRequestMessagesCheck With(Func<HttpRequestMessage, bool> requestFilter, string condition)
         {
             if (!string.IsNullOrEmpty(condition))
             {
@@ -102,209 +101,12 @@ public HttpRequestMessageAsserter With(Func<HttpRequestMessage, bool> requestFil
             return this;
         }
 
-        /// <summary>
-        /// Asserts whether requests were made to a given URI based on a pattern.
-        /// </summary>
-        /// <param name="pattern">The uri pattern that is expected.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithUriPattern(string pattern)
-        {
-            if (string.IsNullOrEmpty(pattern))
-            {
-                throw new ArgumentNullException(nameof(pattern));
-            }
-
-            var condition = string.Empty;
-            if (pattern != "*")
-            {
-                condition = $"uri pattern '{pattern}'";
-            }
-            return With(x => x.HasMatchingUri(pattern), condition);
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made with a given HTTP Method.
-        /// </summary>
-        /// <param name="httpMethod">The <seealso cref="HttpMethod"/> that is expected.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithHttpMethod(HttpMethod httpMethod)
-        {
-            if (httpMethod == null)
-            {
-                throw new ArgumentNullException(nameof(httpMethod));
-            }
-
-            return With(x => x.HasHttpMethod(httpMethod), $"HTTP Method '{httpMethod}'");
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made using a specific HTTP Version.
-        /// </summary>
-        /// <param name="httpVersion">The <seealso cref="System.Net.HttpVersion"/> that is expected.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithHttpVersion(Version httpVersion)
-        {
-            if (httpVersion == null)
-            {
-                throw new ArgumentNullException(nameof(httpVersion));
-            }
-
-            return With(x => x.HasHttpVersion(httpVersion), $"HTTP Version '{httpVersion}'");
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made with a specific header name. Values are ignored.
-        /// </summary>
-        /// <remarks>This method only asserts headers on <see cref="System.Net.Http.Headers.HttpRequestHeader"/></remarks>
-        /// <param name="headerName">The name of the header that is expected.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithRequestHeader(string headerName)
-        {
-            if (string.IsNullOrEmpty(headerName))
-            {
-                throw new ArgumentNullException(nameof(headerName));
-            }
-            return With(x => x.HasRequestHeader(headerName), $"request header '{headerName}'");
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made with a specific header name and value.
-        /// </summary>
-        /// <remarks>This method only asserts headers on <see cref="System.Net.Http.Headers.HttpRequestHeader"/></remarks>
-        /// <param name="headerName">The name of the header that is expected.</param>
-        /// <param name="headerValue">The value of the expected header, supports wildcards.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithRequestHeader(string headerName, string headerValue)
-        {
-            if (string.IsNullOrEmpty(headerName))
-            {
-                throw new ArgumentNullException(nameof(headerName));
-            }
-            if (string.IsNullOrEmpty(headerValue))
-            {
-                throw new ArgumentNullException(nameof(headerValue));
-            }
-            return With(x => x.HasRequestHeader(headerName, headerValue), $"request header '{headerName}' and value '{headerValue}'");
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made with a specific header name. Values are ignored.
-        /// </summary>
-        /// <remarks>This method only asserts headers on <see cref="System.Net.Http.Headers.HttpContentHeader"/></remarks>
-        /// <param name="headerName">The name of the header that is expected.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithContentHeader(string headerName)
-        {
-            if (string.IsNullOrEmpty(headerName))
-            {
-                throw new ArgumentNullException(nameof(headerName));
-            }
-            return With(x => x.HasContentHeader(headerName), $"content header '{headerName}'");
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made with a specific header name and value.
-        /// </summary>
-        /// <remarks>This method only asserts headers on <see cref="System.Net.Http.Headers.HttpContentHeader"/></remarks>
-        /// <param name="headerName">The name of the header that is expected.</param>
-        /// <param name="headerValue">The value of the expected header, supports wildcards.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithContentHeader(string headerName, string headerValue)
-        {
-            if (string.IsNullOrEmpty(headerName))
-            {
-                throw new ArgumentNullException(nameof(headerName));
-            }
-            if (string.IsNullOrEmpty(headerValue))
-            {
-                throw new ArgumentNullException(nameof(headerValue));
-            }
-            return With(x => x.HasContentHeader(headerName, headerValue), $"content header '{headerName}' and value '{headerValue}'");
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made with a specific header name. Values are ignored.
-        /// </summary>
-        /// <param name="headerName">The name of the header that is expected.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithHeader(string headerName)
-        {
-            if (string.IsNullOrEmpty(headerName))
-            {
-                throw new ArgumentNullException(nameof(headerName));
-            }
-            return With(x => x.HasRequestHeader(headerName) || x.HasContentHeader(headerName), $"header '{headerName}'");
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made with a specific header name and value.
-        /// </summary>
-        /// <param name="headerName">The name of the header that is expected.</param>
-        /// <param name="headerValue">The value of the expected header, supports wildcards.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithHeader(string headerName, string headerValue)
-        {
-            if (string.IsNullOrEmpty(headerName))
-            {
-                throw new ArgumentNullException(nameof(headerName));
-            }
-            if (string.IsNullOrEmpty(headerValue))
-            {
-                throw new ArgumentNullException(nameof(headerValue));
-            }
-            return With(x => x.HasRequestHeader(headerName, headerValue) || x.HasContentHeader(headerName, headerValue), $"header '{headerName}' and value '{headerValue}'");
-        }
-
-        /// <summary>
-        /// Asserts whether requests were made with specific content.
-        /// </summary>
-        /// <param name="pattern">The expected content, supports wildcards.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithContent(string pattern)
-        {
-            if (pattern == null)
-            {
-                throw new ArgumentNullException(nameof(pattern));
-            }
-
-            return With(x => x.HasContent(pattern), $"content '{pattern}'");
-        }
-
-        /// <summary>
-        /// Asserts wheter requests are made with specific json content.
-        /// </summary>
-        /// <param name="jsonObject">The object representation of the expected request content.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithJsonContent(object? jsonObject)
-        {
-            var jsonString = JsonSerializer.Serialize(jsonObject);
-            return With(x => x.HasContent(jsonString) && x.HasContentHeader("Content-Type", "application/json*"), $"json content '{jsonString}'");
-        }
-
-        /// <summary>
-        /// Asserts wheter requests are made with specific url encoded content.
-        /// </summary>
-        /// <param name="nameValueCollection">The collection of key/value pairs that should be url encoded.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter WithFormUrlEncodedContent(IEnumerable<KeyValuePair<string, string>> nameValueCollection)
-        {
-            if (nameValueCollection == null)
-            {
-                throw new ArgumentNullException(nameof(nameValueCollection));
-            }
-
-            using var content = new FormUrlEncodedContent(nameValueCollection);
-            var contentString = content.ReadAsStringAsync().Result;
-
-            return With(x => x.HasContent(contentString) && x.HasContentHeader("Content-Type", "application/x-www-form-urlencoded*"), $"form url encoded content '{contentString}'");
-        }
-
         /// <summary>
         /// Asserts that a specific amount of requests were made.
         /// </summary>
         /// <param name="count">The number of requests that are expected, should be a positive value.</param>
-        /// <returns>The <seealso cref="HttpRequestMessageAsserter"/> for further assertions.</returns>
-        public HttpRequestMessageAsserter Times(int count)
+        /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+        public IHttpRequestMessagesCheck Times(int count)
         {
             if (count < 0)
             {