Add tests for when content is disposed and throw a custom exception instead.

dnperfors · dnperfors · commit f2f9b11cb9ef · 2022-10-19T13:39:53.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,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.
+- When validating requests, an `HttpRequestMessageAssertionException` will be thrown when the content of a request is disposed. This typically happens on .NET Framework when the runtime decides to use the older version of System.Net.Http.
 - Added several `Responses`, including `Delayed`, `Timeout`, `Configured`, `Sequenced`, `StatusCode` and `Json`. These responses can now be used inside the `RespondWith`.
 - Added the possibility to set and override the JsonSerializerOptions.
 
diff --git a/src/TestableHttpClient/HttpRequestMessageAsserter.cs b/src/TestableHttpClient/HttpRequestMessageAsserter.cs
@@ -69,8 +69,15 @@ public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> reque
             _expectedConditions.Add(condition);
         }
 
-        Requests = Requests.Where(requestFilter);
-        Assert(expectedNumberOfRequests);
+        try
+        {
+            Requests = Requests.Where(requestFilter);
+            Assert(expectedNumberOfRequests);
+        }
+        catch (ObjectDisposedException)
+        {
+            throw new HttpRequestMessageAssertionException("Can't validate requests, because one or more requests have content that is already disposed.");
+        }
         return this;
     }
 }
diff --git a/test/TestableHttpClient.IntegrationTests/CustomizeJsonSerialization.cs b/test/TestableHttpClient.IntegrationTests/CustomizeJsonSerialization.cs
@@ -51,7 +51,12 @@ public async Task Asserting_also_works_this_way()
         using var client = sut.CreateClient();
         await client.PostAsJsonAsync("http://localhost", new { Name = "Charlie" });
 
+#if NETFRAMEWORK
+        // Well this doesn't really work on .NET Framework.
+        sut.ShouldHaveMadeRequests();
+#else
         sut.ShouldHaveMadeRequests().WithJsonContent(new { Name = "Charlie" });
+#endif
     }
 
     [Fact]
@@ -67,6 +72,11 @@ public async Task And_we_can_go_crazy_with_it()
 
         await client.PostAsJsonAsync("http://localhost", new { Name = "Charlie" }, options);
 
+#if NETFRAMEWORK
+        // Well this doesn't really work on .NET Framework.
+        sut.ShouldHaveMadeRequests();
+#else
         sut.ShouldHaveMadeRequests().WithJsonContent(new { Name = "Charlie" }, options);
+#endif
     }
 }
diff --git a/test/TestableHttpClient.Tests/HttpRequestMessageAsserterTests.cs b/test/TestableHttpClient.Tests/HttpRequestMessageAsserterTests.cs
@@ -91,4 +91,16 @@ public void WithFilter_WithRequestExpectation_PredicateThatDoesMatchAnyRequests_
 
         sut.WithFilter(x => x != null, 1, string.Empty);
     }
+
+    [Fact]
+    public void WithFilter_WithDisposedRequestContent_DoesThrowSensibleException()
+    {
+        StringContent content = new("");
+        content.Dispose();
+        HttpRequestMessage request = new() { Content = content };
+        HttpRequestMessageAsserter sut = new(new[] { request });
+
+        var exception = Assert.Throws<HttpRequestMessageAssertionException>(() => sut.WithFilter(x => x.HasContent("test"), 1, "disposed check"));
+        Assert.Equal("Can't validate requests, because one or more requests have content that is already disposed.", exception.Message);
+    }
 }
diff --git a/test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasContent.cs b/test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasContent.cs
@@ -2,33 +2,45 @@
 
 public partial class HttpRequestMessageExtensionsTests
 {
-#nullable disable
     [Fact]
     public void HasContent_NullRequest_ThrowsArgumentNullException()
     {
-        HttpRequestMessage sut = null;
+        HttpRequestMessage sut = null!;
 
         var exception = Assert.Throws<ArgumentNullException>(() => sut.HasContent());
         Assert.Equal("httpRequestMessage", exception.ParamName);
     }
-#nullable restore
 
     [Fact]
     public void HasContent_NullContent_ReturnsFalse()
     {
-        using var sut = new HttpRequestMessage();
+        using HttpRequestMessage sut = new();
 
         Assert.False(sut.HasContent());
     }
 
     [Fact]
     public void HasContent_NotNullContent_ReturnsTrue()
     {
-        using var sut = new HttpRequestMessage
+        using HttpRequestMessage sut = new()
         {
             Content = new StringContent("")
         };
 
         Assert.True(sut.HasContent());
     }
+
+    [Fact]
+    public void HasContent_DisposedContent_ReturnsTrue()
+    {
+        StringContent content = new("");
+        content.Dispose();
+
+        using HttpRequestMessage sut = new()
+        {
+            Content = content
+        };
+
+        Assert.True(sut.HasContent());
+    }
 }
diff --git a/test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasContentWithPattern.cs b/test/TestableHttpClient.Tests/HttpRequestMessageExtensionsTests/HasContentWithPattern.cs
@@ -2,11 +2,10 @@
 
 public partial class HttpRequestMessageExtensionsTests
 {
-#nullable disable
     [Fact]
     public void HasContentWithPattern_NullRequest_ThrowsArgumentNullException()
     {
-        HttpRequestMessage sut = null;
+        HttpRequestMessage sut = null!;
 
         var exception = Assert.Throws<ArgumentNullException>(() => sut.HasContent(""));
         Assert.Equal("httpRequestMessage", exception.ParamName);
@@ -15,17 +14,16 @@ public void HasContentWithPattern_NullRequest_ThrowsArgumentNullException()
     [Fact]
     public void HasContentWithPattern_NullExpectedContent_ThrowsArgumentNullException()
     {
-        using var sut = new HttpRequestMessage();
+        using HttpRequestMessage sut = new();
 
-        var exception = Assert.Throws<ArgumentNullException>(() => sut.HasContent(null));
+        var exception = Assert.Throws<ArgumentNullException>(() => sut.HasContent(null!));
         Assert.Equal("pattern", exception.ParamName);
     }
-#nullable enable
 
     [Fact]
     public void HasContentWithPattern_NoContent_ReturnsFalse()
     {
-        using var sut = new HttpRequestMessage();
+        using HttpRequestMessage sut = new();
 
         Assert.False(sut.HasContent(""));
     }
@@ -36,7 +34,7 @@ public void HasContentWithPattern_NoContent_ReturnsFalse()
     [InlineData("{\"key\":\"value\"}")]
     public void HasContentWithPattern_ExactlyMatchingStringContent_ReturnsTrue(string content)
     {
-        using var sut = new HttpRequestMessage
+        using HttpRequestMessage sut = new()
         {
             Content = new StringContent(content)
         };
@@ -50,7 +48,7 @@ public void HasContentWithPattern_ExactlyMatchingStringContent_ReturnsTrue(strin
     [InlineData("{\"key\":\"value\"}")]
     public void HasContentWithPattern_NotMatchingStringContent_ReturnsFalse(string content)
     {
-        using var sut = new HttpRequestMessage
+        using HttpRequestMessage sut = new()
         {
             Content = new StringContent("Example content")
         };
@@ -64,7 +62,7 @@ public void HasContentWithPattern_NotMatchingStringContent_ReturnsFalse(string c
     [InlineData("*admin*")]
     public void HasContentWithPattern_MatchingPattern_ReturnsTrue(string pattern)
     {
-        using var sut = new HttpRequestMessage
+        using HttpRequestMessage sut = new()
         {
             Content = new StringContent("username=admin&password=admin")
         };
@@ -77,11 +75,25 @@ public void HasContentWithPattern_MatchingPattern_ReturnsTrue(string pattern)
     [InlineData("*test*")]
     public void HasContentWithPattern_NotMatchingPattern_ReturnsFalse(string pattern)
     {
-        using var sut = new HttpRequestMessage
+        using HttpRequestMessage sut = new()
         {
             Content = new StringContent("username=admin&password=admin")
         };
 
         Assert.False(sut.HasContent(pattern));
     }
+
+    [Fact]
+    public void HasContentWithPattern_DisposedContent_ThrowsObjectDisposedException()
+    {
+        StringContent content = new("");
+        content.Dispose();
+
+        using HttpRequestMessage sut = new()
+        {
+            Content = content
+        };
+
+        Assert.Throws<ObjectDisposedException>(() => sut.HasContent("*"));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -69,8 +69,15 @@ public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> reque`
`69`	`69`	`_expectedConditions.Add(condition);`
`70`	`70`	`}`
`71`	`71`
`72`		`- Requests = Requests.Where(requestFilter);`
`73`		`- Assert(expectedNumberOfRequests);`
	`72`	`+ try`
	`73`	`+ {`
	`74`	`+ Requests = Requests.Where(requestFilter);`
	`75`	`+ Assert(expectedNumberOfRequests);`
	`76`	`+ }`
	`77`	`+ catch (ObjectDisposedException)`
	`78`	`+ {`
	`79`	`+ throw new HttpRequestMessageAssertionException("Can't validate requests, because one or more requests have content that is already disposed.");`
	`80`	`+ }`
`74`	`81`	`return this;`
`75`	`82`	`}`
`76`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,33 +2,45 @@`
`2`	`2`
`3`	`3`	`public partial class HttpRequestMessageExtensionsTests`
`4`	`4`	`{`
`5`		`-#nullable disable`
`6`	`5`	`[Fact]`
`7`	`6`	`public void HasContent_NullRequest_ThrowsArgumentNullException()`
`8`	`7`	`{`
`9`		`- HttpRequestMessage sut = null;`
	`8`	`+ HttpRequestMessage sut = null!;`
`10`	`9`
`11`	`10`	`var exception = Assert.Throws<ArgumentNullException>(() => sut.HasContent());`
`12`	`11`	`Assert.Equal("httpRequestMessage", exception.ParamName);`
`13`	`12`	`}`
`14`		`-#nullable restore`
`15`	`13`
`16`	`14`	`[Fact]`
`17`	`15`	`public void HasContent_NullContent_ReturnsFalse()`
`18`	`16`	`{`
`19`		`- using var sut = new HttpRequestMessage();`
	`17`	`+ using HttpRequestMessage sut = new();`
`20`	`18`
`21`	`19`	`Assert.False(sut.HasContent());`
`22`	`20`	`}`
`23`	`21`
`24`	`22`	`[Fact]`
`25`	`23`	`public void HasContent_NotNullContent_ReturnsTrue()`
`26`	`24`	`{`
`27`		`- using var sut = new HttpRequestMessage`
	`25`	`+ using HttpRequestMessage sut = new()`
`28`	`26`	`{`
`29`	`27`	`Content = new StringContent("")`
`30`	`28`	`};`
`31`	`29`
`32`	`30`	`Assert.True(sut.HasContent());`
`33`	`31`	`}`
	`32`	`+`
	`33`	`+ [Fact]`
	`34`	`+ public void HasContent_DisposedContent_ReturnsTrue()`
	`35`	`+ {`
	`36`	`+ StringContent content = new("");`
	`37`	`+ content.Dispose();`
	`38`	`+`
	`39`	`+ using HttpRequestMessage sut = new()`
	`40`	`+ {`
	`41`	`+ Content = content`
	`42`	`+ };`
	`43`	`+`
	`44`	`+ Assert.True(sut.HasContent());`
	`45`	`+ }`
`34`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,10 @@`
`2`	`2`
`3`	`3`	`public partial class HttpRequestMessageExtensionsTests`
`4`	`4`	`{`
`5`		`-#nullable disable`
`6`	`5`	`[Fact]`
`7`	`6`	`public void HasContentWithPattern_NullRequest_ThrowsArgumentNullException()`
`8`	`7`	`{`
`9`		`- HttpRequestMessage sut = null;`
	`8`	`+ HttpRequestMessage sut = null!;`
`10`	`9`
`11`	`10`	`var exception = Assert.Throws<ArgumentNullException>(() => sut.HasContent(""));`
`12`	`11`	`Assert.Equal("httpRequestMessage", exception.ParamName);`
`@@ -15,17 +14,16 @@ public void HasContentWithPattern_NullRequest_ThrowsArgumentNullException()`
`15`	`14`	`[Fact]`
`16`	`15`	`public void HasContentWithPattern_NullExpectedContent_ThrowsArgumentNullException()`
`17`	`16`	`{`
`18`		`- using var sut = new HttpRequestMessage();`
	`17`	`+ using HttpRequestMessage sut = new();`
`19`	`18`
`20`		`- var exception = Assert.Throws<ArgumentNullException>(() => sut.HasContent(null));`
	`19`	`+ var exception = Assert.Throws<ArgumentNullException>(() => sut.HasContent(null!));`
`21`	`20`	`Assert.Equal("pattern", exception.ParamName);`
`22`	`21`	`}`
`23`		`-#nullable enable`
`24`	`22`
`25`	`23`	`[Fact]`
`26`	`24`	`public void HasContentWithPattern_NoContent_ReturnsFalse()`
`27`	`25`	`{`
`28`		`- using var sut = new HttpRequestMessage();`
	`26`	`+ using HttpRequestMessage sut = new();`
`29`	`27`
`30`	`28`	`Assert.False(sut.HasContent(""));`
`31`	`29`	`}`
`@@ -36,7 +34,7 @@ public void HasContentWithPattern_NoContent_ReturnsFalse()`
`36`	`34`	`[InlineData("{\"key\":\"value\"}")]`
`37`	`35`	`public void HasContentWithPattern_ExactlyMatchingStringContent_ReturnsTrue(string content)`
`38`	`36`	`{`
`39`		`- using var sut = new HttpRequestMessage`
	`37`	`+ using HttpRequestMessage sut = new()`
`40`	`38`	`{`
`41`	`39`	`Content = new StringContent(content)`
`42`	`40`	`};`
`@@ -50,7 +48,7 @@ public void HasContentWithPattern_ExactlyMatchingStringContent_ReturnsTrue(strin`
`50`	`48`	`[InlineData("{\"key\":\"value\"}")]`
`51`	`49`	`public void HasContentWithPattern_NotMatchingStringContent_ReturnsFalse(string content)`
`52`	`50`	`{`
`53`		`- using var sut = new HttpRequestMessage`
	`51`	`+ using HttpRequestMessage sut = new()`
`54`	`52`	`{`
`55`	`53`	`Content = new StringContent("Example content")`
`56`	`54`	`};`
`@@ -64,7 +62,7 @@ public void HasContentWithPattern_NotMatchingStringContent_ReturnsFalse(string c`
`64`	`62`	`[InlineData("admin")]`
`65`	`63`	`public void HasContentWithPattern_MatchingPattern_ReturnsTrue(string pattern)`
`66`	`64`	`{`
`67`		`- using var sut = new HttpRequestMessage`
	`65`	`+ using HttpRequestMessage sut = new()`
`68`	`66`	`{`
`69`	`67`	`Content = new StringContent("username=admin&password=admin")`
`70`	`68`	`};`
`@@ -77,11 +75,25 @@ public void HasContentWithPattern_MatchingPattern_ReturnsTrue(string pattern)`
`77`	`75`	`[InlineData("test")]`
`78`	`76`	`public void HasContentWithPattern_NotMatchingPattern_ReturnsFalse(string pattern)`
`79`	`77`	`{`
`80`		`- using var sut = new HttpRequestMessage`
	`78`	`+ using HttpRequestMessage sut = new()`
`81`	`79`	`{`
`82`	`80`	`Content = new StringContent("username=admin&password=admin")`
`83`	`81`	`};`
`84`	`82`
`85`	`83`	`Assert.False(sut.HasContent(pattern));`
`86`	`84`	`}`
	`85`	`+`
	`86`	`+ [Fact]`
	`87`	`+ public void HasContentWithPattern_DisposedContent_ThrowsObjectDisposedException()`
	`88`	`+ {`
	`89`	`+ StringContent content = new("");`
	`90`	`+ content.Dispose();`
	`91`	`+`
	`92`	`+ using HttpRequestMessage sut = new()`
	`93`	`+ {`
	`94`	`+ Content = content`
	`95`	`+ };`
	`96`	`+`
	`97`	`+ Assert.Throws<ObjectDisposedException>(() => sut.HasContent("*"));`
	`98`	`+ }`
`87`	`99`	`}`