Deprecate HasRequestHeader and HasResponseHeader and move tests for WithHeader to HttpRequestMessageAsserter;

Author: dnperfors

src/TestableHttpClient/HttpRequestMessageExtensions.cs

@@ -33,13 +33,24 @@ internal static bool HasHttpMethod(this HttpRequestMessage httpRequestMessage, H
         return httpRequestMessage.Method == httpMethod;
     }
 
-    /// <summary>
-    /// Determines whether a specific header is set on a request.
-    /// </summary>
-    /// <remarks>This method only checks headers in <see cref="HttpRequestHeaders"/></remarks>
-    /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the request header on.</param>
-    /// <param name="headerName">The name of the header to locate on the request.</param>
-    /// <returns>true when the request contains a header with the specified name; otherwise, false.</returns>
+    internal static bool HasHeader(this HttpRequestMessage httpRequestMessage, string headerName)
+    {
+        Guard.ThrowIfNull(httpRequestMessage);
+        Guard.ThrowIfNullOrEmpty(headerName);
+
+        return httpRequestMessage.Headers.HasHeader(headerName) || (httpRequestMessage.Content is not null && httpRequestMessage.Content.Headers.HasHeader(headerName));
+    }
+
+    internal static bool HasHeader(this HttpRequestMessage httpRequestMessage, string headerName, string headerValue)
+    {
+        Guard.ThrowIfNull(httpRequestMessage);
+        Guard.ThrowIfNullOrEmpty(headerName);
+        Guard.ThrowIfNullOrEmpty(headerValue);
+
+        return httpRequestMessage.Headers.HasHeader(headerName, headerValue) || (httpRequestMessage.Content is not null && httpRequestMessage.Content.Headers.HasHeader(headerName, headerValue));
+    }
+
+    [Obsolete("Use HasHeader instead.")]
     internal static bool HasRequestHeader(this HttpRequestMessage httpRequestMessage, string headerName)
     {
         Guard.ThrowIfNull(httpRequestMessage);
@@ -48,14 +59,7 @@ internal static bool HasRequestHeader(this HttpRequestMessage httpRequestMessage
         return httpRequestMessage.Headers.HasHeader(headerName);
     }
 
-    /// <summary>
-    /// Determines whether a specific header with a specific value is set on a request.
-    /// </summary>
-    /// <remarks>This method only checks headers in <see cref="HttpRequestHeaders"/></remarks>
-    /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the request header on.</param>
-    /// <param name="headerName">The name of the header to locate on the request.</param>
-    /// <param name="headerValue">The value the header should have. Wildcard is supported.</param>
-    /// <returns>true when the request contains a header with the specified name and value; otherwise, false.</returns>
+    [Obsolete("Use HasHeader instead.")]
     internal static bool HasRequestHeader(this HttpRequestMessage httpRequestMessage, string headerName, string headerValue)
     {
         Guard.ThrowIfNull(httpRequestMessage);
@@ -65,13 +69,7 @@ internal static bool HasRequestHeader(this HttpRequestMessage httpRequestMessage
         return httpRequestMessage.Headers.HasHeader(headerName, headerValue);
     }
 
-    /// <summary>
-    /// Determines whether a specific header is set on a request.
-    /// </summary>
-    /// <remarks>This method only checks headers in <see cref="HttpContentHeaders"/></remarks>
-    /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the content header on.</param>
-    /// <param name="headerName">The name of the header to locate on the request content.</param>
-    /// <returns>true when the request contains a header with the specified name; otherwise, false.</returns>
+    [Obsolete("Use HasHeader instead.")]
     internal static bool HasContentHeader(this HttpRequestMessage httpRequestMessage, string headerName)
     {
         Guard.ThrowIfNull(httpRequestMessage);
@@ -85,14 +83,7 @@ internal static bool HasContentHeader(this HttpRequestMessage httpRequestMessage
         return httpRequestMessage.Content.Headers.HasHeader(headerName);
     }
 
-    /// <summary>
-    /// Determines whether a specific header with a specific value is set on a request.
-    /// </summary>
-    /// <remarks>This method only checks headers in <see cref="HttpContentHeaders"/></remarks>
-    /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the content header on.</param>
-    /// <param name="headerName">The name of the header to locate on the request content.</param>
-    /// <param name="headerValue">The value the header should have. Wildcard is supported.</param>
-    /// <returns>true when the request contains a header with the specified name and value; otherwise, false.</returns>
+    [Obsolete("Use HasHeader instead.")]
     internal static bool HasContentHeader(this HttpRequestMessage httpRequestMessage, string headerName, string headerValue)
     {
         Guard.ThrowIfNull(httpRequestMessage);

src/TestableHttpClient/HttpRequestMessagesCheckExtensions.cs

@@ -92,6 +92,7 @@ private static IHttpRequestMessagesCheck WithHttpVersion(this IHttpRequestMessag
     /// <param name="check">The implementation that hold all the request messages.</param>
     /// <param name="headerName">The name of the header that is expected.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("Use WithHeader instead.")]
     public static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMessagesCheck check, string headerName) => WithRequestHeader(check, headerName, (int?)null);
 
     /// <summary>
@@ -102,8 +103,10 @@ private static IHttpRequestMessagesCheck WithHttpVersion(this IHttpRequestMessag
     /// <param name="headerName">The name of the header that is expected.</param>
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("Use WithHeader instead.")]
     public static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMessagesCheck check, string headerName, int expectedNumberOfRequests) => WithRequestHeader(check, headerName, (int?)expectedNumberOfRequests);
 
+    [Obsolete("Use WithHeader instead.")]
     private static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMessagesCheck check, string headerName, int? expectedNumberOfRequests)
     {
         Guard.ThrowIfNull(check);
@@ -120,6 +123,7 @@ private static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMess
     /// <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="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("Use WithHeader instead.")]
     public static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMessagesCheck check, string headerName, string headerValue) => WithRequestHeader(check, headerName, headerValue, null);
 
     /// <summary>
@@ -131,8 +135,10 @@ private static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMess
     /// <param name="headerValue">The value of the expected header, supports wildcards.</param>
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("Use WithHeader instead.")]
     public static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMessagesCheck check, string headerName, string headerValue, int expectedNumberOfRequests) => WithRequestHeader(check, headerName, headerValue, (int?)expectedNumberOfRequests);
 
+    [Obsolete("Use WithHeader instead.")]
     private static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMessagesCheck check, string headerName, string headerValue, int? expectedNumberOfRequests)
     {
         Guard.ThrowIfNull(check);
@@ -149,6 +155,7 @@ private static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMess
     /// <param name="check">The implementation that hold all the request messages.</param>
     /// <param name="headerName">The name of the header that is expected.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("Use WithHeader instead.")]
     public static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMessagesCheck check, string headerName) => WithContentHeader(check, headerName, (int?)null);
 
     /// <summary>
@@ -159,8 +166,10 @@ private static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMess
     /// <param name="headerName">The name of the header that is expected.</param>
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("Use WithHeader instead.")]
     public static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMessagesCheck check, string headerName, int expectedNumberOfRequests) => WithContentHeader(check, headerName, (int?)expectedNumberOfRequests);
 
+    [Obsolete("Use WithHeader instead.")]
     private static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMessagesCheck check, string headerName, int? expectedNumberOfRequests)
     {
         Guard.ThrowIfNull(check);
@@ -177,6 +186,7 @@ private static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMess
     /// <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="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("Use WithHeader instead.")]
     public static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMessagesCheck check, string headerName, string headerValue) => WithContentHeader(check, headerName, headerValue, null);
 
     /// <summary>
@@ -188,8 +198,10 @@ private static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMess
     /// <param name="headerValue">The value of the expected header, supports wildcards.</param>
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("Use WithHeader instead.")]
     public static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMessagesCheck check, string headerName, string headerValue, int expectedNumberOfRequests) => WithContentHeader(check, headerName, headerValue, (int?)expectedNumberOfRequests);
 
+    [Obsolete("Use WithHeader instead.")]
     private static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMessagesCheck check, string headerName, string headerValue, int? expectedNumberOfRequests)
     {
         Guard.ThrowIfNull(check);
@@ -221,7 +233,7 @@ private static IHttpRequestMessagesCheck WithHeader(this IHttpRequestMessagesChe
         Guard.ThrowIfNull(check);
         Guard.ThrowIfNullOrEmpty(headerName);
 
-        return check.WithFilter(x => x.HasRequestHeader(headerName) || x.HasContentHeader(headerName), expectedNumberOfRequests, $"header '{headerName}'");
+        return check.WithFilter(x => x.HasHeader(headerName), expectedNumberOfRequests, $"header '{headerName}'");
     }
 
     /// <summary>
@@ -249,7 +261,7 @@ private static IHttpRequestMessagesCheck WithHeader(this IHttpRequestMessagesChe
         Guard.ThrowIfNullOrEmpty(headerName);
         Guard.ThrowIfNullOrEmpty(headerValue);
 
-        return check.WithFilter(x => x.HasRequestHeader(headerName, headerValue) || x.HasContentHeader(headerName, headerValue), expectedNumberOfRequests, $"header '{headerName}' and value '{headerValue}'");
+        return check.WithFilter(x => x.HasHeader(headerName, headerValue), expectedNumberOfRequests, $"header '{headerName}' and value '{headerValue}'");
     }
 
     /// <summary>
@@ -319,7 +331,7 @@ private static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessag
 
         var jsonString = JsonSerializer.Serialize(jsonObject, jsonSerializerOptions ?? check.Options.JsonSerializerOptions);
 
-        return check.WithFilter(x => x.HasContent(jsonString) && x.HasContentHeader("Content-Type", "application/json*"), expectedNumberOfRequests, $"json content '{jsonString}'");
+        return check.WithFilter(x => x.HasContent(jsonString) && x.HasHeader("Content-Type", "application/json*"), expectedNumberOfRequests, $"json content '{jsonString}'");
     }
 
     /// <summary>
@@ -347,6 +359,6 @@ private static IHttpRequestMessagesCheck WithFormUrlEncodedContent(this IHttpReq
         using var content = new FormUrlEncodedContent(nameValueCollection);
         var contentString = content.ReadAsStringAsync().Result;
 
-        return check.WithFilter(x => x.HasContent(contentString) && x.HasContentHeader("Content-Type", "application/x-www-form-urlencoded*"), expectedNumberOfRequests, $"form url encoded content '{contentString}'");
+        return check.WithFilter(x => x.HasContent(contentString) && x.HasHeader("Content-Type", "application/x-www-form-urlencoded*"), expectedNumberOfRequests, $"form url encoded content '{contentString}'");
     }
 }

test/TestableHttpClient.IntegrationTests/AssertingRequests.cs

@@ -117,20 +117,20 @@ public async Task AssertingHttpMethods()
     }
 
     [Fact]
-    public async Task AssertingRequestHeaders()
+    public async Task AssertingHeaders()
     {
         using TestableHttpMessageHandler testHandler = new();
         using HttpClient client = new(testHandler);
         client.DefaultRequestHeaders.Add("api-version", "1.0");
         _ = await client.GetAsync("https://httpbin.org/get", TestContext.Current.CancellationToken);
 
-        testHandler.ShouldHaveMadeRequests().WithRequestHeader("api-version");
-        testHandler.ShouldHaveMadeRequests().WithRequestHeader("api-version", "1.0");
-        testHandler.ShouldHaveMadeRequests().WithRequestHeader("api-version", "1*");
+        testHandler.ShouldHaveMadeRequests().WithHeader("api-version");
+        testHandler.ShouldHaveMadeRequests().WithHeader("api-version", "1.0");
+        testHandler.ShouldHaveMadeRequests().WithHeader("api-version", "1*");
 
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithRequestHeader("my-version"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithRequestHeader("api-version", "1"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithRequestHeader("api-version", "2*"));
+        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*"));
     }
 
     [Fact]
@@ -142,15 +142,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().WithContentHeader("content-type");
-        testHandler.ShouldHaveMadeRequests().WithContentHeader("Content-Type");
-        testHandler.ShouldHaveMadeRequests().WithContentHeader("Content-Type", "application/json; charset=utf-8");
-        testHandler.ShouldHaveMadeRequests().WithContentHeader("Content-Type", "application/json*");
-        testHandler.ShouldHaveMadeRequests().WithContentHeader("Content-Type", "*charset=utf-8");
+        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");
 
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContentHeader("Content-Disposition"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContentHeader("Content-Type", "application/json"));
-        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContentHeader("Content-Type", "*=utf-16"));
+        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"));
     }
 
     [Fact]

test/TestableHttpClient.IntegrationTests/CreatingClients.cs

@@ -23,7 +23,7 @@ public async Task CreateClientWithConfiguration()
 
         await client.GetAsync("https://httpbin.org/get", TestContext.Current.CancellationToken);
 
-        testableHttpMessageHandler.ShouldHaveMadeRequests().WithRequestHeader("test", "test");
+        testableHttpMessageHandler.ShouldHaveMadeRequests().WithHeader("test", "test");
     }
 
     [Fact]