Add support for .NET Framework (#165)

dnperfors · web-flow · commit 145016a52e0a · 2022-10-09T22:28:12.000+02:00
Run the tests on .NET Framework versions 4.6.2, 4.7 and 4.8. Other Framework versions are either no longer supported, or basically considered covered by the minor version.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -3,13 +3,13 @@
   "isRoot": true,
   "tools": {
     "dotnet-sonarscanner": {
-      "version": "5.5.3",
+      "version": "5.8.0",
       "commands": [
         "dotnet-sonarscanner"
       ]
     },
     "nbgv": {
-      "version": "3.5.104",
+      "version": "3.5.113",
       "commands": [
         "nbgv"
       ]
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -28,6 +28,8 @@ jobs:
         dotnet-version: |
           3.1.x
           6.0.x
+    - name: Dump .NET info
+      run: dotnet --info
     - name: Restore dotnet tools
       run: dotnet tool restore
     - name: Prepare sonarqube
@@ -60,8 +62,11 @@ jobs:
         name: coverage
         path: ./**/TestResults/**/coverage.opencover.xml
 
-  testFrameworkVersions:
-    runs-on: ubuntu-latest
+  testOnSupportedDotnetVersions:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout
       uses: actions/checkout@v2
@@ -71,8 +76,10 @@ jobs:
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: |
-          3.1.x
-          6.0.x
+          3.1
+          6.0
+    - name: Dump .NET info
+      run: dotnet --info
     - name: Restore dependencies
       run: dotnet restore
     - name: Build source code
@@ -87,10 +94,11 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v2
-    - name: Setup .NET 6.0
+    - name: Setup .NET versions
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '6.0'
+        dotnet-version: |
+          6.0
     - uses: actions/download-artifact@v2
       with:
         name: artifacts
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### 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.
+- Added support for .NET Framework 4.6.2, .NET Framework 4.7 and .NET Framework 4.8 by running the tests against these versions.
 
 ## [0.7] - 2022-09-22
 ### Changed
diff --git a/src/TestableHttpClient/HttpRequestMessagesCheckExtensions.cs b/src/TestableHttpClient/HttpRequestMessagesCheckExtensions.cs
@@ -370,6 +370,7 @@ private static IHttpRequestMessagesCheck WithHeader(this IHttpRequestMessagesChe
     /// <param name="check">The implementation that hold all the request messages.</param>
     /// <param name="pattern">The expected content, supports wildcards.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
     public static IHttpRequestMessagesCheck WithContent(this IHttpRequestMessagesCheck check, string pattern) => WithContent(check, pattern, null);
 
     /// <summary>
@@ -379,6 +380,7 @@ private static IHttpRequestMessagesCheck WithHeader(this IHttpRequestMessagesChe
     /// <param name="pattern">The expected content, supports wildcards.</param>
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
     public static IHttpRequestMessagesCheck WithContent(this IHttpRequestMessagesCheck check, string pattern, int expectedNumberOfRequests) => WithContent(check, pattern, (int?)expectedNumberOfRequests);
 
     private static IHttpRequestMessagesCheck WithContent(this IHttpRequestMessagesCheck check, string pattern, int? expectedNumberOfRequests)
@@ -402,6 +404,7 @@ private static IHttpRequestMessagesCheck WithContent(this IHttpRequestMessagesCh
     /// <param name="check">The implementation that hold all the request messages.</param>
     /// <param name="jsonObject">The object representation of the expected request content.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
     public static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject) => WithJsonContent(check, jsonObject, null);
 
     /// <summary>
@@ -411,6 +414,7 @@ private static IHttpRequestMessagesCheck WithContent(this IHttpRequestMessagesCh
     /// <param name="jsonObject">The object representation of the expected request content.</param>
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
     public static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject, int expectedNumberOfRequests) => WithJsonContent(check, jsonObject, (int?)expectedNumberOfRequests);
 
     private static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessagesCheck check, object? jsonObject, int? expectedNumberOfRequests)
@@ -430,6 +434,7 @@ private static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessag
     /// <param name="check">The implementation that hold all the request messages.</param>
     /// <param name="nameValueCollection">The collection of key/value pairs that should be url encoded.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
     public static IHttpRequestMessagesCheck WithFormUrlEncodedContent(this IHttpRequestMessagesCheck check, IEnumerable<KeyValuePair<string?, string?>> nameValueCollection) => WithFormUrlEncodedContent(check, nameValueCollection, null);
 
     /// <summary>
@@ -439,6 +444,7 @@ private static IHttpRequestMessagesCheck WithJsonContent(this IHttpRequestMessag
     /// <param name="nameValueCollection">The collection of key/value pairs that should be url encoded.</param>
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    /// <remarks>Note that on .NET Framework, the HttpClient might dispose the content after sending the request.</remarks>
     public static IHttpRequestMessagesCheck WithFormUrlEncodedContent(this IHttpRequestMessagesCheck check, IEnumerable<KeyValuePair<string?, string?>> nameValueCollection, int expectedNumberOfRequests) => WithFormUrlEncodedContent(check, nameValueCollection, (int?)expectedNumberOfRequests);
 
     private static IHttpRequestMessagesCheck WithFormUrlEncodedContent(this IHttpRequestMessagesCheck check, IEnumerable<KeyValuePair<string?, string?>> nameValueCollection, int? expectedNumberOfRequests)
diff --git a/src/TestableHttpClient/TestableHttpClient.csproj b/src/TestableHttpClient/TestableHttpClient.csproj
@@ -8,6 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
+    <PackageReference Include="System.Net.Http" Version="4.3.4" />
     <PackageReference Include="System.Text.Json" Version="4.6.0" />
   </ItemGroup>
 
diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets
@@ -1,5 +1,6 @@
 <Project>
   <ItemGroup>
+    <PackageReference Include="Microsoft.TestPlatform.ObjectModel" Version="17.3.2" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
diff --git a/test/TestableHttpClient.IntegrationTests/AssertingRequests.cs b/test/TestableHttpClient.IntegrationTests/AssertingRequests.cs
@@ -163,12 +163,17 @@ public async Task AssertingContent()
         using var content = new StringContent("my special content");
         _ = await client.PostAsync("https://httpbin.org/post", content);
 
+#if NETFRAMEWORK
+        // On .NET Framework the HttpClient disposes the content automatically. So we can't perform the same test.
+        testHandler.ShouldHaveMadeRequests();
+#else
         testHandler.ShouldHaveMadeRequests().WithContent("my special content");
         testHandler.ShouldHaveMadeRequests().WithContent("my*content");
         testHandler.ShouldHaveMadeRequests().WithContent("*");
 
         Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContent(""));
         Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContent("my"));
+#endif
     }
 
     [Fact]
@@ -180,7 +185,12 @@ public async Task AssertJsonContent()
         using var content = new StringContent("{}", Encoding.UTF8, "application/json");
         _ = await client.PostAsync("https://httpbin.org/post", content);
 
+#if NETFRAMEWORK
+        // On .NET Framework the HttpClient disposes the content automatically. So we can't perform the same test.
+        testHandler.ShouldHaveMadeRequests();
+#else
         testHandler.ShouldHaveMadeRequests().WithJsonContent(new { });
+#endif
     }
 
     [Fact]
diff --git a/test/TestableHttpClient.IntegrationTests/AssertingRequestsWithNFluent.cs b/test/TestableHttpClient.IntegrationTests/AssertingRequestsWithNFluent.cs
@@ -161,12 +161,17 @@ public async Task AssertingContent()
         using var content = new StringContent("my special content");
         _ = await client.PostAsync("https://httpbin.org/post", content);
 
+#if NETFRAMEWORK
+        // On .NET Framework the HttpClient disposes the content automatically. So we can't perform the same test.
+        Check.That(testHandler).HasMadeRequests();
+#else
         Check.That(testHandler).HasMadeRequests().WithContent("my special content");
         Check.That(testHandler).HasMadeRequests().WithContent("my*content");
         Check.That(testHandler).HasMadeRequests().WithContent("*");
 
         Check.ThatCode(() => Check.That(testHandler).HasMadeRequests().WithContent("")).IsAFailingCheck();
         Check.ThatCode(() => Check.That(testHandler).HasMadeRequests().WithContent("my")).IsAFailingCheck();
+#endif
     }
 
     [Fact]
@@ -178,7 +183,12 @@ public async Task AssertJsonContent()
         using var content = new StringContent("{}", Encoding.UTF8, "application/json");
         _ = await client.PostAsync("https://httpbin.org/post", content);
 
+#if NETFRAMEWORK
+        // On .NET Framework the HttpClient disposes the content automatically. So we can't perform the same test.
+        Check.That(testHandler).HasMadeRequests();
+#else
         Check.That(testHandler).HasMadeRequests().WithJsonContent(new { });
+#endif
     }
 
     [Fact]
diff --git a/test/TestableHttpClient.IntegrationTests/CreatingClients.cs b/test/TestableHttpClient.IntegrationTests/CreatingClients.cs
@@ -10,7 +10,7 @@ public async Task CreateASimpleHttpClient()
 
         await client.GetAsync("https://httpbin.org/get");
 
-        testableHttpMessageHandler.ShouldHaveMadeRequests().WithHttpVersion(HttpVersion.Version11);
+        testableHttpMessageHandler.ShouldHaveMadeRequestsTo("https://httpbin.org/get");
     }
 
     [Fact]
diff --git a/test/TestableHttpClient.IntegrationTests/TestableHttpClient.IntegrationTests.csproj b/test/TestableHttpClient.IntegrationTests/TestableHttpClient.IntegrationTests.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net6.0</TargetFrameworks>
+    <TargetFrameworks>net462;net47;net48;netcoreapp3.1;net6.0</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
diff --git a/test/TestableHttpClient.IntegrationTests/TestingRetryMechanisms.cs b/test/TestableHttpClient.IntegrationTests/TestingRetryMechanisms.cs
@@ -1,4 +1,5 @@
-﻿using Microsoft.Extensions.Http;
+﻿#if NETCOREAPP || NET
+using Microsoft.Extensions.Http;
 
 using Polly;
 using Polly.Extensions.Http;
@@ -54,3 +55,4 @@ public async Task SimulateTimeoutDoesNotRetry()
         testableHttpMessageHandler.ShouldHaveMadeRequestsTo("https://httpbin.com/get", 1);
     }
 }
+#endif
diff --git a/test/TestableHttpClient.IntegrationTests/UsingIHttpClientFactory.cs b/test/TestableHttpClient.IntegrationTests/UsingIHttpClientFactory.cs
@@ -1,4 +1,5 @@
-﻿using Microsoft.AspNetCore.Builder;
+﻿#if NETCOREAPP || NET
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.TestHost;
@@ -115,3 +116,4 @@ public static void Configure(IApplicationBuilder app)
         }
     }
 }
+#endif
diff --git a/test/TestableHttpClient.NFluent.Tests/TestableHttpClient.NFluent.Tests.csproj b/test/TestableHttpClient.NFluent.Tests/TestableHttpClient.NFluent.Tests.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net6.0</TargetFrameworks>
+    <TargetFrameworks>net462;net47;net48;netcoreapp3.1;net6.0</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasHttpMethod.cs b/test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasHttpMethod.cs
@@ -66,7 +66,7 @@ public void HasHttpMethod_WithHttpMethod_IncorrectHttpMethod_ReturnsFalse()
     {
         using var sut = new HttpRequestMessage { Method = HttpMethod.Get };
 
-        Assert.False(sut.HasHttpMethod(HttpMethod.Patch));
+        Assert.False(sut.HasHttpMethod(HttpMethod.Put));
     }
 
     [Fact]
diff --git a/test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasHttpVersion.cs b/test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasHttpVersion.cs
@@ -8,7 +8,7 @@ public void HasHttpVersion_WithVersion_NullRequest_ThrowsArgumentNullException()
     {
         HttpRequestMessage sut = null;
 
-        var exception = Assert.Throws<ArgumentNullException>(() => sut.HasHttpVersion(HttpVersion.Version20));
+        var exception = Assert.Throws<ArgumentNullException>(() => sut.HasHttpVersion(HttpVersion.Version11));
         Assert.Equal("httpRequestMessage", exception.ParamName);
     }
 
@@ -24,7 +24,11 @@ public void HasHttpVersion_WithString_NullRequest_ThrowsArgumentNullException()
     [Fact]
     public void HasHttpVersion_WithVersion_NullVersion_ThrowsArgumentNullException()
     {
+#if NETFRAMEWORK
+        using var sut = new HttpRequestMessage { Version = new Version(0, 0) };
+#else
         using var sut = new HttpRequestMessage { Version = HttpVersion.Unknown };
+#endif
 
         var exception = Assert.Throws<ArgumentNullException>(() => sut.HasHttpVersion((Version)null));
         Assert.Equal("httpVersion", exception.ParamName);
@@ -35,7 +39,11 @@ public void HasHttpVersion_WithVersion_NullVersion_ThrowsArgumentNullException()
     [InlineData("")]
     public void HasHttpVersion_WithString_NullVersion_ThrowsArgumentNullException(string httpVersion)
     {
+#if NETFRAMEWORK
+        using var sut = new HttpRequestMessage { Version = new Version(0, 0) };
+#else
         using var sut = new HttpRequestMessage { Version = HttpVersion.Unknown };
+#endif
 
         var exception = Assert.Throws<ArgumentNullException>(() => sut.HasHttpVersion(httpVersion));
         Assert.Equal("httpVersion", exception.ParamName);
@@ -63,7 +71,7 @@ public void HasHttpVersion_WithVersion_IncorrectVersion_ReturnsFalse()
     {
         using var sut = new HttpRequestMessage { Version = HttpVersion.Version11 };
 
-        Assert.False(sut.HasHttpVersion(HttpVersion.Version20));
+        Assert.False(sut.HasHttpVersion(HttpVersion.Version10));
     }
 
     [Fact]
diff --git a/test/TestableHttpClient.Tests/HttpResponseMessageBuilderTests.cs b/test/TestableHttpClient.Tests/HttpResponseMessageBuilderTests.cs
@@ -22,9 +22,9 @@ public void WithHttpVersion_CreatesHttpResponseMessageWithCorrectVersion()
     {
         var sut = new HttpResponseMessageBuilder();
 
-        var result = sut.WithHttpVersion(HttpVersion.Version20).Build();
+        var result = sut.WithHttpVersion(HttpVersion.Version11).Build();
 
-        Assert.Equal(HttpVersion.Version20, result.Version);
+        Assert.Equal(HttpVersion.Version11, result.Version);
     }
 
     [Fact]
diff --git a/test/TestableHttpClient.Tests/HttpResponseMessageExtensionsTests/HasHttpVersion.cs b/test/TestableHttpClient.Tests/HttpResponseMessageExtensionsTests/HasHttpVersion.cs
@@ -8,14 +8,18 @@ public void HasHttpVersion_WithVersion_NullResponse_ThrowsArgumentNullException(
     {
         HttpResponseMessage sut = null;
 
-        var exception = Assert.Throws<ArgumentNullException>(() => sut.HasHttpVersion(HttpVersion.Version20));
+        var exception = Assert.Throws<ArgumentNullException>(() => sut.HasHttpVersion(HttpVersion.Version11));
         Assert.Equal("httpResponseMessage", exception.ParamName);
     }
 
     [Fact]
     public void HasHttpVersion_WithVersion_NullVersion_ThrowsArgumentNullException()
     {
+#if NETFRAMEWORK
+        using var sut = new HttpResponseMessage { Version = new Version(0, 0) };
+#else
         using var sut = new HttpResponseMessage { Version = HttpVersion.Unknown };
+#endif
 
         var exception = Assert.Throws<ArgumentNullException>(() => sut.HasHttpVersion(null));
         Assert.Equal("httpVersion", exception.ParamName);
@@ -35,6 +39,6 @@ public void HasHttpVersion_WithVersion_IncorrectVersion_ReturnsFalse()
     {
         using var sut = new HttpResponseMessage { Version = HttpVersion.Version11 };
 
-        Assert.False(sut.HasHttpVersion(HttpVersion.Version20));
+        Assert.False(sut.HasHttpVersion(HttpVersion.Version10));
     }
 }
diff --git a/test/TestableHttpClient.Tests/TestableHttpClient.Tests.csproj b/test/TestableHttpClient.Tests/TestableHttpClient.Tests.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net6.0</TargetFrameworks>
+    <TargetFrameworks>net462;net47;net48;netcoreapp3.1;net6.0</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/test/TestableHttpClient.Tests/TestableHttpMessageHandlerExtensionsTests/CreateClient.cs b/test/TestableHttpClient.Tests/TestableHttpMessageHandlerExtensionsTests/CreateClient.cs
@@ -36,10 +36,11 @@ public void CreateClient_NullDelegateHandler_ThrowsArgumentNullException()
 
     private static HttpMessageHandler? GetPrivateHandler(HttpClient client)
     {
-        var handlerField = client.GetType().BaseType?.GetField("_handler", BindingFlags.Instance | BindingFlags.NonPublic);
+        var privateFields = client.GetType().BaseType?.GetFields(BindingFlags.Instance | BindingFlags.NonPublic) ?? Enumerable.Empty<FieldInfo>();
+        var handlerField = privateFields.FirstOrDefault(x => x.FieldType == typeof(HttpMessageHandler));
         if (handlerField == null)
         {
-            Assert.True(false, "Can't find the private _handler field on HttpClient.");
+            Assert.True(false, "Can't find the private HttpMessageHandler field on HttpClient.");
             return null;
         }
         return handlerField.GetValue(client) as HttpMessageHandler;

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public async Task CreateASimpleHttpClient()`
`10`	`10`
`11`	`11`	`await client.GetAsync("https://httpbin.org/get");`
`12`	`12`
`13`		`- testableHttpMessageHandler.ShouldHaveMadeRequests().WithHttpVersion(HttpVersion.Version11);`
	`13`	`+ testableHttpMessageHandler.ShouldHaveMadeRequestsTo("https://httpbin.org/get");`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`[Fact]`