Adds support for asserting a specific amount of requests using .Times().

Author: dnperfors

.editorconfig

@@ -82,3 +82,6 @@ csharp_style_prefer_switch_expression = true:suggestion
 
 dotnet_sort_system_directives_first = true
 dotnet_separate_import_directive_groups = true
+
+# CA1303: Do not pass literals as localized parameters
+dotnet_diagnostic.CA1303.severity = silent

HttpClientTestHelpers.sln

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

README.md

@@ -3,3 +3,12 @@ Using HttpClient in code that is unittested is seen as rather difficult, this li
 
 This library is largly based on the HttpTest functionality from [Flurl](https://flurl.dev), but is focused around the use of HttpClient directly. Since I intend to replace my usage of Flurl.Http with this library, I kept the interface very similar.
 
+# Todo before release
+The following assertions should be able in the first release:
+- WithRequestBody: Compare the body as text
+- WithContentType: Or headers in the body of a httprequestmessage
+
+Preferably the follwing setup for responses:
+- Simulate timeout
+- easier response body creation?
+

src/HttpClientTestHelpers/HttpRequestMessageAsserter.cs

@@ -60,8 +60,10 @@ private void Assert(int? count = null)
             {
                 var expected = count switch
                 {
+                    null => "at least one request to be made",
                     0 => "no requests to be made",
-                    _ => "at least one request to be made",
+                    1 => "one request to be made",
+                    _ => $"{count} requests to be made"
                 };
                 var actual = actualCount switch
                 {
@@ -100,7 +102,7 @@ public HttpRequestMessageAsserter With(Func<HttpRequestMessage, bool> requestFil
         }
 
         /// <summary>
-        /// Asserts wheter requests were made to a given URI based on a pattern.
+        /// 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>
@@ -120,7 +122,7 @@ public HttpRequestMessageAsserter WithUriPattern(string pattern)
         }
 
         /// <summary>
-        /// Asserts wheter requests were made with a given HTTP Method.
+        /// 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>
@@ -135,7 +137,7 @@ public HttpRequestMessageAsserter WithHttpMethod(HttpMethod httpMethod)
         }
 
         /// <summary>
-        /// Asserts wheter requests were made using a specific HTTP Version.
+        /// 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>
@@ -150,7 +152,7 @@ public HttpRequestMessageAsserter WithHttpVersion(Version httpVersion)
         }
 
         /// <summary>
-        /// Asserts wheter requests were made with a specific header name. Values are ignored.
+        /// 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>
@@ -163,6 +165,12 @@ public HttpRequestMessageAsserter WithHeader(string headerName)
             return With(x => x.HasHeader(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))
@@ -175,5 +183,21 @@ public HttpRequestMessageAsserter WithHeader(string headerName, string headerVal
             }
             return With(x => x.HasHeader(headerName, headerValue), $"header '{headerName}' and value '{headerValue}'");
         }
+
+        /// <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)
+        {
+            if(count < 0)
+            {
+                throw new ArgumentException("Count should not be less than zero", nameof(count));
+            }
+
+            Assert(count);
+            return this;
+        }
     }
 }

test/HttpClientTestHelpers.Tests/HttpRequestMessageAsserterTests.cs

@@ -282,5 +282,45 @@ public void WithHeaderNameAndValue_RequestWithMatchinHeader_ReturnsHttpRequestMe
             Assert.NotNull(result);
             Assert.IsType<HttpRequestMessageAsserter>(result);
         }
+
+        [Fact]
+        public void Times_ValueLessThan0_ThrowsArgumentException()
+        {
+            var sut = new HttpRequestMessageAsserter(Enumerable.Empty<HttpRequestMessage>());
+
+            var exception = Assert.Throws<ArgumentException>(() => sut.Times(-1));
+
+            Assert.Equal("count", exception.ParamName);
+        }
+
+        [Fact]
+        public void Times_NoRequestsAndCount1_ThrowsHttpRequestMessageAssertionExceptionWithSpecificMessage()
+        {
+            var sut = new HttpRequestMessageAsserter(Enumerable.Empty<HttpRequestMessage>());
+
+            var exception = Assert.Throws<HttpRequestMessageAssertionException>(() => sut.Times(1));
+
+            Assert.Equal("Expected one request to be made, but no requests were made.", exception.Message);
+        }
+
+        [Fact]
+        public void Times_NoRequestsAndCount2_ThrowsHttpRequestMessageAssertionExceptionWithSpecificMessage()
+        {
+            var sut = new HttpRequestMessageAsserter(Enumerable.Empty<HttpRequestMessage>());
+
+            var exception = Assert.Throws<HttpRequestMessageAssertionException>(() => sut.Times(2));
+
+            Assert.Equal("Expected 2 requests to be made, but no requests were made.", exception.Message);
+        }
+
+        [Fact]
+        public void Times_NoRequestsAndCount0_ReturnsHttpRequestMessageAsserter()
+        {
+            var sut = new HttpRequestMessageAsserter(Enumerable.Empty<HttpRequestMessage>());
+
+            var result = sut.Times(0);
+            Assert.NotNull(result);
+            Assert.IsType<HttpRequestMessageAsserter>(result);
+        }
     }
 }