Mark types and methods obsolete that should be internal or are going to be removed.

Author: dnperfors

CHANGELOG.md

@@ -10,6 +10,8 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - `TestableHttpMessageHandler.RespondWith(Func<HttpRequestMessage, HttpResponseMessage>)` had been deprecated, it's functionality is replaced by IResponse.
 - `RespondWith(this TestableHttpMessageHandler, HttpResponseMessage)` has been deprecated, the response is modified with every call, so it doesn't work reliably and is different from how HttpClientHandler works, which creates a HttpResponseMessage for every request.
 - `HttpResponseMessageBuilder` and `RespondWith(this TestableHttpMessageHandler, HttpResponseMessageBuilder)` has been deprecated, it's functionality can be replaced with ConfiguredResponse or a custom IResponse.
+- `HttpRequestMessageExtensions` and `HttpResponseMessageExtensions` were introduced as extensions for easier assertion. However, these types are intended for internal use and will be made internal next release.
+- TestableHttpClient.NFluent is deprecated and will be removed in the next version.
 
 ### Added
 - `CreateClient` now accepts `DelegateHandlers` in order to chain Handlers. The InnerHandler property of each handler is set automatically and the `TestableHttpMessageHandler` is automatically set as the last handler. This is showcased with Polly in the integration tests.

src/TestableHttpClient.NFluent/HttpResponseMessageChecks.cs

@@ -3,6 +3,7 @@
 /// <summary>
 /// A set of NFluent checks to validate <see cref="HttpResponseMessage"/>s.
 /// </summary>
+[Obsolete("These NFluent extensions are no longer supported and will be removed.")]
 public static class HttpResponseMessageChecks
 {
     /// <summary>

src/TestableHttpClient.NFluent/README.md

@@ -1,5 +1,10 @@
 # TestableHttpClient.NFluent
 
+## Status
+The NFluent extensions for TestableHttpClient are being deprecated and will no longer ship with the next version of the library.
+
+---
+
 In integration tests, asserting HttpResponseMessages can be a real challenge, especially since error messages are sometimes not very clear. NFluent is known for giving clear error messages.
 `TestableHttpClient.NFluent` is designed to make it easier to check `HttpResponseMessage`s and `TestableHttpClient`s and give clear error messages.
 

src/TestableHttpClient.NFluent/TestableHttpClientChecks.cs

@@ -3,6 +3,7 @@
 /// <summary>
 /// A set of NFluent checks to check <see cref="TestableHttpMessageHandler"/>.
 /// </summary>
+[Obsolete("These NFluent extensions are no longer supported and will be removed.")]
 public static class TestableHttpClientChecks
 {
     /// <summary>

src/TestableHttpClient/HttpRequestMessageExtensions.cs

@@ -3,6 +3,7 @@
 /// <summary>
 /// A set of static methods for checking values on a <see cref="HttpRequestMessage"/>.
 /// </summary>
+[Obsolete("This class is not intended for public use and will be marked internal in the next release.")]
 public static class HttpRequestMessageExtensions
 {
     /// <summary>
@@ -11,6 +12,7 @@ public static class HttpRequestMessageExtensions
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the correct version on.</param>
     /// <param name="httpVersion">The expected version.</param>
     /// <returns>true when the HttpVersion matches; otherwise, false.</returns>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasHttpVersion(this HttpRequestMessage httpRequestMessage, Version httpVersion)
     {
         if (httpRequestMessage == null)
@@ -32,6 +34,7 @@ public static bool HasHttpVersion(this HttpRequestMessage httpRequestMessage, Ve
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the correct version on.</param>
     /// <param name="httpVersion">The expected version.</param>
     /// <returns>true when the HttpVersion matches; otherwise, false.</returns>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasHttpVersion(this HttpRequestMessage httpRequestMessage, string httpVersion)
     {
         if (httpRequestMessage == null)
@@ -53,6 +56,7 @@ public static bool HasHttpVersion(this HttpRequestMessage httpRequestMessage, st
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the correct method on.</param>
     /// <param name="httpMethod">The expected method.</param>
     /// <returns>true when the HttpMethod matches; otherwise, false.</returns>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasHttpMethod(this HttpRequestMessage httpRequestMessage, HttpMethod httpMethod)
     {
         if (httpRequestMessage == null)
@@ -74,6 +78,7 @@ public static bool HasHttpMethod(this HttpRequestMessage httpRequestMessage, Htt
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the correct method on.</param>
     /// <param name="httpMethod">The expected method.</param>
     /// <returns>true when the HttpMethod matches; otherwise, false.</returns>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasHttpMethod(this HttpRequestMessage httpRequestMessage, string httpMethod)
     {
         if (httpRequestMessage == null)
@@ -96,6 +101,7 @@ public static bool HasHttpMethod(this HttpRequestMessage httpRequestMessage, str
     /// <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>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasRequestHeader(this HttpRequestMessage httpRequestMessage, string headerName)
     {
         if (httpRequestMessage == null)
@@ -119,6 +125,7 @@ public static bool HasRequestHeader(this HttpRequestMessage httpRequestMessage,
     /// <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("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasRequestHeader(this HttpRequestMessage httpRequestMessage, string headerName, string headerValue)
     {
         if (httpRequestMessage == null)
@@ -146,6 +153,7 @@ public static bool HasRequestHeader(this HttpRequestMessage httpRequestMessage,
     /// <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("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasContentHeader(this HttpRequestMessage httpRequestMessage, string headerName)
     {
         if (httpRequestMessage == null)
@@ -174,6 +182,7 @@ public static bool HasContentHeader(this HttpRequestMessage httpRequestMessage,
     /// <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("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasContentHeader(this HttpRequestMessage httpRequestMessage, string headerName, string headerValue)
     {
         if (httpRequestMessage == null)
@@ -205,6 +214,7 @@ public static bool HasContentHeader(this HttpRequestMessage httpRequestMessage,
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the correct uri on.</param>
     /// <param name="pattern">A pattern to match with the request uri, supports * as wildcards.</param>
     /// <returns>true when the request uri matches the pattern; otherwise, false.</returns>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasMatchingUri(this HttpRequestMessage httpRequestMessage, string pattern, bool ignoreCase = true)
     {
         if (httpRequestMessage == null)
@@ -231,6 +241,7 @@ public static bool HasMatchingUri(this HttpRequestMessage httpRequestMessage, st
     /// </summary>
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check for content.</param>
     /// <returns>true when the request has content; otherwise, false.</returns>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasContent(this HttpRequestMessage httpRequestMessage)
     {
         if (httpRequestMessage == null)
@@ -247,6 +258,7 @@ public static bool HasContent(this HttpRequestMessage httpRequestMessage)
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the correct content on.</param>
     /// <param name="pattern">A pattern to match the request content, supports * as wildcards.</param>
     /// <returns>true when the request content matches the pattern; otherwise, false.</returns>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasContent(this HttpRequestMessage httpRequestMessage, string pattern)
     {
         if (httpRequestMessage == null)
@@ -280,6 +292,7 @@ public static bool HasContent(this HttpRequestMessage httpRequestMessage, string
     /// <param name="httpRequestMessage">A <see cref="HttpRequestMessage"/> to check the correct request uir querystring on.</param>
     /// <param name="pattern">A pattern to match the request uri querystring, supports * as wildcards.</param>
     /// <returns>true when the request uri querystring matches the pattern; otherwise, false.</returns>
+    [Obsolete("This method is not intended for public use and will be marked internal in the next release.")]
     public static bool HasQueryString(this HttpRequestMessage httpRequestMessage, string pattern)
     {
         if (httpRequestMessage == null)

src/TestableHttpClient/HttpRequestMessagesCheckExtensions.cs

@@ -1,4 +1,6 @@
-namespace TestableHttpClient;
+using System.Diagnostics.CodeAnalysis;
+
+namespace TestableHttpClient;
 
 public static class HttpRequestMessagesCheckExtensions
 {
@@ -40,7 +42,9 @@ private static IHttpRequestMessagesCheck WithRequestUri(this IHttpRequestMessage
             condition = $"uri pattern '{pattern}'";
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasMatchingUri(pattern, ignoreCase), expectedNumberOfRequests, condition);
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -79,7 +83,9 @@ private static IHttpRequestMessagesCheck WithQueryString(this IHttpRequestMessag
             _ => $"querystring pattern '{pattern}'"
         };
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasQueryString(pattern), expectedNumberOfRequests, condition);
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -111,7 +117,9 @@ private static IHttpRequestMessagesCheck WithHttpMethod(this IHttpRequestMessage
             throw new ArgumentNullException(nameof(httpMethod));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasHttpMethod(httpMethod), expectedNumberOfRequests, $"HTTP Method '{httpMethod}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -143,7 +151,9 @@ private static IHttpRequestMessagesCheck WithHttpVersion(this IHttpRequestMessag
             throw new ArgumentNullException(nameof(httpVersion));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasHttpVersion(httpVersion), expectedNumberOfRequests, $"HTTP Version '{httpVersion}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -177,7 +187,9 @@ private static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMess
             throw new ArgumentNullException(nameof(headerName));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasRequestHeader(headerName), expectedNumberOfRequests, $"request header '{headerName}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -218,7 +230,9 @@ private static IHttpRequestMessagesCheck WithRequestHeader(this IHttpRequestMess
             throw new ArgumentNullException(nameof(headerValue));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasRequestHeader(headerName, headerValue), expectedNumberOfRequests, $"request header '{headerName}' and value '{headerValue}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -252,7 +266,9 @@ private static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMess
             throw new ArgumentNullException(nameof(headerName));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasContentHeader(headerName), expectedNumberOfRequests, $"content header '{headerName}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -293,7 +309,9 @@ private static IHttpRequestMessagesCheck WithContentHeader(this IHttpRequestMess
             throw new ArgumentNullException(nameof(headerValue));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasContentHeader(headerName, headerValue), expectedNumberOfRequests, $"content header '{headerName}' and value '{headerValue}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -325,7 +343,9 @@ private static IHttpRequestMessagesCheck WithHeader(this IHttpRequestMessagesChe
             throw new ArgumentNullException(nameof(headerName));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasRequestHeader(headerName) || x.HasContentHeader(headerName), expectedNumberOfRequests, $"header '{headerName}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -364,7 +384,9 @@ private static IHttpRequestMessagesCheck WithHeader(this IHttpRequestMessagesChe
             throw new ArgumentNullException(nameof(headerValue));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasRequestHeader(headerName, headerValue) || x.HasContentHeader(headerName, headerValue), expectedNumberOfRequests, $"header '{headerName}' and value '{headerValue}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -398,7 +420,9 @@ private static IHttpRequestMessagesCheck WithContent(this IHttpRequestMessagesCh
             throw new ArgumentNullException(nameof(pattern));
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasContent(pattern), expectedNumberOfRequests, $"content '{pattern}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -447,7 +471,10 @@ private static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessag
         }
 
         var jsonString = JsonSerializer.Serialize(jsonObject, jsonSerializerOptions ?? check.Options.JsonSerializerOptions);
+
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasContent(jsonString) && x.HasContentHeader("Content-Type", "application/json*"), expectedNumberOfRequests, $"json content '{jsonString}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     /// <summary>
@@ -484,6 +511,8 @@ private static IHttpRequestMessagesCheck WithFormUrlEncodedContent(this IHttpReq
         using var content = new FormUrlEncodedContent(nameValueCollection);
         var contentString = content.ReadAsStringAsync().Result;
 
+#pragma warning disable CS0618 // Type or member is obsolete
         return check.WithFilter(x => x.HasContent(contentString) && x.HasContentHeader("Content-Type", "application/x-www-form-urlencoded*"), expectedNumberOfRequests, $"form url encoded content '{contentString}'");
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 }