Adds assertion for the used HttpMethod of a request.

Author: dnperfors

src/HttpClientTestHelpers/HttpRequestMessageAsserter.cs

@@ -5,22 +5,37 @@
 
 namespace HttpClientTestHelpers
 {
+    /// <summary>
+    /// This class makes it easy to create assertions on a collection of <seealso cref="HttpRequestMessage"/>s.
+    /// </summary>
     public class HttpRequestMessageAsserter
     {
         private readonly List<string> _expectedConditions = new List<string>();
         private readonly bool _negate = false;
 
+        /// <summary>
+        /// Construct a new HttpRequestMessageAsserter.
+        /// </summary>
+        /// <param name="httpRequestMessages">The list of requests to assert on.</param>
         public HttpRequestMessageAsserter(IEnumerable<HttpRequestMessage> httpRequestMessages)
+            : this(httpRequestMessages, false)
         {
-            Requests = httpRequestMessages ?? throw new ArgumentNullException(nameof(httpRequestMessages));
         }
 
+        /// <summary>
+        /// Construct a new HttpRequestMessageAsserter.
+        /// </summary>
+        /// <param name="httpRequestMessages">The list of requests to assert on.</param>
+        /// <param name="negate">Whether or not all assertions should be negated.</param>
         public HttpRequestMessageAsserter(IEnumerable<HttpRequestMessage> httpRequestMessages, bool negate)
         {
             Requests = httpRequestMessages ?? throw new ArgumentNullException(nameof(httpRequestMessages));
             _negate = negate;
         }
 
+        /// <summary>
+        /// The list of requests received from <seealso cref="TestableHttpMessageHandler"/>.
+        /// </summary>
         public IEnumerable<HttpRequestMessage> Requests { get; private set; }
 
         private void Assert(int? count = null)
@@ -66,16 +81,52 @@ private void Assert(int? count = null)
             }
         }
 
-        public HttpRequestMessageAsserter WithUriPattern(string pattern)
+        /// <summary>
+        /// Asserts whether requests comply with a specific filter.
+        /// </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)
         {
-            if (pattern != "*")
+            if (!string.IsNullOrEmpty(condition))
             {
-                _expectedConditions.Add($"uri pattern '{pattern}'");
+                _expectedConditions.Add(condition);
             }
 
-            Requests = Requests.Where(x => x.HasMatchingUri(pattern));
+            Requests = Requests.Where(requestFilter);
             Assert();
             return this;
         }
+
+        /// <summary>
+        /// Asserts wheter 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)
+        {
+            string condition = string.Empty;
+            if (pattern != "*")
+            {
+                condition = $"uri pattern '{pattern}'";
+            }
+            return With(x => x.HasMatchingUri(pattern), condition);
+        }
+
+        /// <summary>
+        /// Asserts wheter 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}'");
+        }
     }
 }

test/HttpClientTestHelpers.Tests/HttpRequestMessageAsserterTests.cs

@@ -50,5 +50,48 @@ public void WithUriPattern_RequestWithStarPatternAndNoRequests_ThrowsHttpRequest
             var exception = Assert.Throws<HttpRequestMessageAssertionException>(() => sut.WithUriPattern("*"));
             Assert.Equal("Expected at least one request to be made, but no requests were made.", exception.Message);
         }
+
+#nullable disable
+        [Fact]
+        public void WithHttpmethod_NullHttpMethod_ThrowsArgumentNullException()
+        {
+            var sut = new HttpRequestMessageAsserter(Enumerable.Empty<HttpRequestMessage>());
+
+            var exception = Assert.Throws<ArgumentNullException>(() => sut.WithHttpMethod(null));
+
+            Assert.Equal("httpMethod", exception.ParamName);
+        }
+#nullable restore
+
+        [Fact]
+        public void WithHttpmethod_NoRequests_ThrowsHttpRequestMessageAssertionExceptionWithSpecificMessage()
+        {
+            var sut = new HttpRequestMessageAsserter(Enumerable.Empty<HttpRequestMessage>());
+
+            var exception = Assert.Throws<HttpRequestMessageAssertionException>(() => sut.WithHttpMethod(HttpMethod.Get));
+
+            Assert.Equal("Expected at least one request to be made with HTTP Method 'GET', but no requests were made.", exception.Message);
+        }
+
+        [Fact]
+        public void WithHttpmethod_RequestsWithIncorrectHttpMethod_ThrowsHttpRequestMessageAssertionExceptionWithSpecificMessage()
+        {
+            var sut = new HttpRequestMessageAsserter(new[] { new HttpRequestMessage(HttpMethod.Post, new Uri("https://example.com")) });
+
+            var exception = Assert.Throws<HttpRequestMessageAssertionException>(() => sut.WithHttpMethod(HttpMethod.Get));
+
+            Assert.Equal("Expected at least one request to be made with HTTP Method 'GET', but no requests were made.", exception.Message);
+        }
+
+        [Fact]
+        public void WithHttpMethod_RequestsWithCorrectMethod_ReturnsHttpRequestMessageAsserter()
+        {
+            var sut = new HttpRequestMessageAsserter(new[] { new HttpRequestMessage(HttpMethod.Get, new Uri("https://example.com")) });
+
+            var result = sut.WithHttpMethod(HttpMethod.Get);
+
+            Assert.NotNull(result);
+            Assert.IsType<HttpRequestMessageAsserter>(result);
+        }
     }
 }