Make API more consistent

* Renamed several members on HttpResponseMessageBuilder
* Mark HasHttpVersion with string parameter as obsolete.
* Do not support null for expectedContent
* Add missing HasContent methods on HttpRequestMessageExtensions and HttpResponseMessageExtensions.

Author: dnperfors

src/TestableHttpClient.NFluent/HttpResponseMessageChecks.cs

@@ -222,19 +222,17 @@ public static class HttpResponseMessageChecks
         /// <param name="check">The fluent check to be extended.</param>
         /// <param name="expectedContent">The content that the response should contain, this could be a pattern that includes an astrix ('*').</param>
         /// <returns>A check link.</returns>
-        public static ICheckLink<ICheck<HttpResponseMessage?>> HasContent(this ICheck<HttpResponseMessage?> check, string? expectedContent)
+        public static ICheckLink<ICheck<HttpResponseMessage?>> HasContent(this ICheck<HttpResponseMessage?> check, string expectedContent)
         {
             var checkLogic = ExtensibilityHelper.BeginCheck(check)
                 .SetSutName("response")
                 .FailIfNull();
 
             if (expectedContent == null)
             {
-#pragma warning disable CS8602 // Dereference of a possibly null reference. Justification = "Null reference check is performed by the FailIfNull check"
-                checkLogic.CheckSutAttributes(sut => sut.Content, "content")
-#pragma warning restore CS8602 // Dereference of a possibly null reference.
-                    .FailWhen(sut => sut != null, "The {0} should be null.", MessageOption.NoCheckedBlock | MessageOption.NoExpectedBlock)
-                    .OnNegate("The {0} should not be null.", MessageOption.NoCheckedBlock | MessageOption.NoExpectedBlock)
+                checkLogic
+                    .Fail("The expected content should not be null, but it is.", MessageOption.NoCheckedBlock | MessageOption.NoExpectedBlock)
+                    .CantBeNegated($"{nameof(HasContent)} with {nameof(expectedContent)} set to null")
                     .EndCheck();
             }
             else if (expectedContent.Contains("*"))

src/TestableHttpClient.NFluent/TestableHttpClient.NFluent.csproj

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8">
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

src/TestableHttpClient/HttpRequestMessageAsserter.cs

@@ -281,6 +281,11 @@ public HttpRequestMessageAsserter WithJsonContent(object? 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)

src/TestableHttpClient/HttpRequestMessageExtensions.cs

@@ -225,6 +225,21 @@ public static bool HasMatchingUri(this HttpRequestMessage httpRequestMessage, st
             };
         }
 
+        /// <summary>
+        /// Determines whether the request has content.
+        /// </summary>
+        /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check for content.</param>
+        /// <returns>true when the request has content; otherwise, false.</returns>
+        public static bool HasContent(this HttpRequestMessage httpRequestMessage)
+        {
+            if (httpRequestMessage == null)
+            {
+                throw new ArgumentNullException(nameof(httpRequestMessage));
+            }
+
+            return httpRequestMessage.Content != null;
+        }
+
         /// <summary>
         /// Determines whether the request content matches a string pattern.
         /// </summary>

src/TestableHttpClient/HttpResponseMessageBuilder.cs

@@ -24,7 +24,18 @@ public sealed class HttpResponseMessageBuilder
         /// </summary>
         /// <param name="httpVersion">The <see cref="HttpVersion"/> of the response.</param>
         /// <returns>The <see cref="HttpResponseMessageBuilder"/> for further building of the response.</returns>
+        [Obsolete("Renamed to WithHttpVersion.", true)]
         public HttpResponseMessageBuilder WithVersion(Version httpVersion)
+        {
+            return WithHttpVersion(httpVersion);
+        }
+
+        /// <summary>
+        /// Specifies the version of the response.
+        /// </summary>
+        /// <param name="httpVersion">The <see cref="HttpVersion"/> of the response.</param>
+        /// <returns>The <see cref="HttpResponseMessageBuilder"/> for further building of the response.</returns>
+        public HttpResponseMessageBuilder WithHttpVersion(Version httpVersion)
         {
             httpResponseMessage.Version = httpVersion;
             return this;
@@ -35,7 +46,18 @@ public HttpResponseMessageBuilder WithVersion(Version httpVersion)
         /// </summary>
         /// <param name="statusCode">The <see cref="HttpStatusCode"/> of the response.</param>
         /// <returns>The <see cref="HttpResponseMessageBuilder"/> for further building of the response.</returns>
-        public HttpResponseMessageBuilder WithStatusCode(HttpStatusCode statusCode)
+        [Obsolete("Renamed to WithHttpStatusCode.", true)]
+        public HttpResponseMessageBuilder WithStatusCode(HttpStatusCode httpStatusCode)
+        {
+            return WithHttpStatusCode(httpStatusCode);
+        }
+
+        /// <summary>
+        /// Specifies the status code of the response.
+        /// </summary>
+        /// <param name="statusCode">The <see cref="HttpStatusCode"/> of the response.</param>
+        /// <returns>The <see cref="HttpResponseMessageBuilder"/> for further building of the response.</returns>
+        public HttpResponseMessageBuilder WithHttpStatusCode(HttpStatusCode statusCode)
         {
             httpResponseMessage.StatusCode = statusCode;
             return this;
@@ -46,7 +68,18 @@ public HttpResponseMessageBuilder WithStatusCode(HttpStatusCode statusCode)
         /// </summary>
         /// <param name="responseHeaderBuilder">The builder for configuring the response headers.</param>
         /// <returns>The <see cref="HttpResponseMessageBuilder"/> for further building of the response.</returns>
+        [Obsolete("Renamed to WithResponseHeaders.", true)]
         public HttpResponseMessageBuilder WithHeaders(Action<HttpResponseHeaders> responseHeaderBuilder)
+        {
+            return WithResponseHeaders(responseHeaderBuilder);
+        }
+
+        /// <summary>
+        /// Configure request headers using a builder by directly accessing the <see cref="HttpResponseHeaders"/>.
+        /// </summary>
+        /// <param name="responseHeaderBuilder">The builder for configuring the response headers.</param>
+        /// <returns>The <see cref="HttpResponseMessageBuilder"/> for further building of the response.</returns>
+        public HttpResponseMessageBuilder WithResponseHeaders(Action<HttpResponseHeaders> responseHeaderBuilder)
         {
             if (responseHeaderBuilder == null)
             {
@@ -63,7 +96,19 @@ public HttpResponseMessageBuilder WithHeaders(Action<HttpResponseHeaders> respon
         /// <param name="header">The name of the header to add.</param>
         /// <param name="value">The value of the header to add.</param>
         /// <returns>The <see cref="HttpResponseMessageBuilder"/> for further building of the response.</returns>
+        [Obsolete("Renamed to WithResponseHeader.", true)]
         public HttpResponseMessageBuilder WithHeader(string header, string value)
+        {
+            return WithResponseHeader(header, value);
+        }
+
+        /// <summary>
+        /// Adds a request header to the response.
+        /// </summary>
+        /// <param name="header">The name of the header to add.</param>
+        /// <param name="value">The value of the header to add.</param>
+        /// <returns>The <see cref="HttpResponseMessageBuilder"/> for further building of the response.</returns>
+        public HttpResponseMessageBuilder WithResponseHeader(string header, string value)
         {
             if (string.IsNullOrEmpty(header))
             {

src/TestableHttpClient/HttpResponseMessageExtensions.cs

@@ -36,6 +36,7 @@ public static bool HasHttpVersion(this HttpResponseMessage httpResponseMessage,
         /// <param name="httpResponseMessage">A <see cref="HttpResponseMessage"/> to check the correct version on.</param>
         /// <param name="httpVersion">The expected version.</param>
         /// <returns>true when the HttpVersion matches; otherwise, false.</returns>
+        [Obsolete("Use overload with System.Version instead.", true)]
         public static bool HasHttpVersion(this HttpResponseMessage httpResponseMessage, string httpVersion)
         {
             if (httpResponseMessage == null)
@@ -198,6 +199,20 @@ public static bool HasContentHeader(this HttpResponseMessage httpResponseMessage
             return httpResponseMessage.Content.Headers.HasHeader(headerName, headerValue);
         }
 
+        /// <summary>
+        /// Determines whether the response has content.
+        /// </summary>
+        /// <param name="httpResponseMessage">A <see cref="HttpResponseMessage"/> to check for content.</param>
+        /// <returns>true when the response has content; otherwise, false.</returns>
+        public static bool HasContent(this HttpResponseMessage httpResponseMessage)
+        {
+            if (httpResponseMessage == null)
+            {
+                throw new ArgumentNullException(nameof(httpResponseMessage));
+            }
+            return httpResponseMessage.Content != null;
+        }
+
         /// <summary>
         /// Determines whether the response content matches a string pattern.
         /// </summary>

src/TestableHttpClient/TestableHttpClient.csproj

@@ -8,11 +8,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8">
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="System.Text.Json" Version="4.7.1" />
+    <PackageReference Include="System.Text.Json" Version="4.7.2" />
   </ItemGroup>
 
   <Import Project="..\SharedUtilities\SharedUtilities.projitems" Label="Shared" />

test/TestableHttpClient.IntegrationTests/ConfigureResponses.cs

@@ -44,7 +44,7 @@ public async Task UsingTestHandlerWithCustomResponseUsingBuilder_ReturnsCustomRe
             using var testHandler = new TestableHttpMessageHandler();
             testHandler.RespondWith(response =>
             {
-                response.WithStatusCode(HttpStatusCode.Created)
+                response.WithHttpStatusCode(HttpStatusCode.Created)
                         .WithStringContent("HttpClient testing is easy");
             });
 
@@ -59,8 +59,8 @@ public async Task UsingTestHandlerWithCustomResponseUsingBuilder_ReturnsCustomRe
         public async Task UsingTestHandlerWithMultipleCustomRepsonse_ReturnsLastCustomResponse()
         {
             using var testHandler = new TestableHttpMessageHandler();
-            testHandler.RespondWith(response => response.WithStatusCode(HttpStatusCode.Created).WithStringContent("HttpClient testing is easy"));
-            testHandler.RespondWith(response => response.WithStatusCode(HttpStatusCode.NotFound).WithJsonContent("Not Found"));
+            testHandler.RespondWith(response => response.WithHttpStatusCode(HttpStatusCode.Created).WithStringContent("HttpClient testing is easy"));
+            testHandler.RespondWith(response => response.WithHttpStatusCode(HttpStatusCode.NotFound).WithJsonContent("Not Found"));
 
             using var httpClient = new HttpClient(testHandler);
             var result = await httpClient.GetAsync("http://httpbin.org/status/201");
@@ -73,7 +73,7 @@ public async Task UsingTestHandlerWithMultipleCustomRepsonse_ReturnsLastCustomRe
         public async Task UsingTestHandlerWithCustomResponse_AlwaysReturnsSameCustomResponse()
         {
             using var testHandler = new TestableHttpMessageHandler();
-            testHandler.RespondWith(response => response.WithStatusCode(HttpStatusCode.Created).WithStringContent("HttpClient testing is easy"));
+            testHandler.RespondWith(response => response.WithHttpStatusCode(HttpStatusCode.Created).WithStringContent("HttpClient testing is easy"));
 
             using var httpClient = new HttpClient(testHandler);
             var urls = new[]

test/TestableHttpClient.IntegrationTests/TestableHttpClient.IntegrationTests.csproj

@@ -10,15 +10,21 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Http" Version="3.1.4" />
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8">
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
     <PackageReference Include="Moq" Version="4.14.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
-    <PackageReference Include="coverlet.collector" Version="1.2.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="coverlet.collector" Version="1.2.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
   <ItemGroup>

test/TestableHttpClient.IntegrationTests/UsingIHttpClientFactory.cs

@@ -15,7 +15,7 @@ public async Task ConfigureIHttpClientFactoryToUseTestableHttpClient()
         {
             // Create TestableHttpMessageHandler as usual.
             var testableHttpMessageHandler = new TestableHttpMessageHandler();
-            testableHttpMessageHandler.RespondWith(response => response.WithStatusCode(HttpStatusCode.OK));
+            testableHttpMessageHandler.RespondWith(response => response.WithHttpStatusCode(HttpStatusCode.OK));
 
             // Create a mock for IHttpClientFactory
             var httpClientFactoryMock = new Mock<IHttpClientFactory>();
@@ -34,10 +34,10 @@ public async Task ConfigureIHttpClientFactoryToUseTestableHttpClient()
         public async Task ConfigureMultiplehttpClientFactories()
         {
             var testableGithubHandler = new TestableHttpMessageHandler();
-            testableGithubHandler.RespondWith(response => response.WithStatusCode(HttpStatusCode.OK).WithHeader("Server", "github"));
+            testableGithubHandler.RespondWith(response => response.WithHttpStatusCode(HttpStatusCode.OK).WithResponseHeader("Server", "github"));
 
             var testableHttpBinHandler = new TestableHttpMessageHandler();
-            testableHttpBinHandler.RespondWith(response => response.WithStatusCode(HttpStatusCode.NotFound).WithHeader("Server", "httpbin"));
+            testableHttpBinHandler.RespondWith(response => response.WithHttpStatusCode(HttpStatusCode.NotFound).WithResponseHeader("Server", "httpbin"));
 
             // Create a mock for IHttpClientFactory
             var httpClientFactoryMock = new Mock<IHttpClientFactory>();