feat: Add IAsyncDiposable for TestContext

Author: linkdotnet

MIGRATION.md

@@ -49,3 +49,7 @@ To make the API more consistent, `RenderComponent` and `SetParametersAndRender`
 
 ## Removal of `ComponentParameter` and method using them
 Using `ComponentParameter` and factory methods to create them is not recommend in V1 and have now been removed in V2. Instead, use the strongly typed builder pattern that enables you to pass parameters to components you render.
+
+## `TestContext` implements `IDisposable` and `IAsyncDisposable`
+The `TestContext` now implements `IDisposable` and `IAsyncDisposable`. In version 1.x, `TestContext` only implemented `IDisposable` and cleaned up asynchronous objects in the synchronous `Dispose` method. This is no longer the case, and asynchronous objects are now cleaned up in the `DisposeAsync` method.
+If you register services into the container that implement `IAsyncDisposable` make sure that the test framework calls the right method.

src/bunit/TestContext.cs

@@ -7,7 +7,7 @@ namespace Bunit;
 /// <summary>
 /// A test context is a factory that makes it possible to create components under tests.
 /// </summary>
-public partial class TestContext : IDisposable
+public partial class TestContext : IDisposable, IAsyncDisposable
 {
 	private bool disposed;
 	private BunitRenderer? bunitRenderer;
@@ -70,17 +70,46 @@ public void Dispose()
 		GC.SuppressFinalize(this);
 	}
 
+	/// <inheritdoc/>
+	public async ValueTask DisposeAsync()
+	{
+		await DisposeAsyncCore();
+
+		Dispose(disposing: false);
+		GC.SuppressFinalize(this);
+	}
+
+	/// <summary>
+	/// Disposes of the test context resources that are asynchronous, in particular it disposes the <see cref="Services"/>
+	/// service provider.s
+	/// </summary>
+	protected virtual async ValueTask DisposeAsyncCore()
+	{
+		if (disposed)
+			return;
+
+		disposed = true;
+
+		// Ensure the renderer is disposed before all others,
+		// otherwise a render cycle may be ongoing and try to access
+		// the service provider to perform operations.
+		if (bunitRenderer is not null)
+		{
+			await bunitRenderer.DisposeAsync();
+		}
+
+		await Services.DisposeAsync();
+	}
+
 	/// <summary>
 	/// Disposes of the test context resources, in particular it disposes the <see cref="Services"/>
-	/// service provider. Any async services registered with the service provider will disposed first,
-	/// but their disposal will not be awaited..
+	/// service provider.
 	/// </summary>
 	/// <remarks>
 	/// The disposing parameter should be false when called from a finalizer, and true when called from the
 	/// <see cref="Dispose()"/> method. In other words, it is true when deterministically called and false when non-deterministically called.
 	/// </remarks>
 	/// <param name="disposing">Set to true if called from <see cref="Dispose()"/>, false if called from a finalizer.f.</param>
-	[SuppressMessage("Reliability", "CA2012:Use ValueTasks correctly", Justification = "Explicitly ignoring DisposeAsync to avoid breaking changes to API surface.")]
 	protected virtual void Dispose(bool disposing)
 	{
 		if (disposed || !disposing)
@@ -91,18 +120,7 @@ protected virtual void Dispose(bool disposing)
 		// Ensure the renderer is disposed before all others,
 		// otherwise a render cycle may be ongoing and try to access
 		// the service provider to perform operations.
-		if (bunitRenderer is IDisposable renderer)
-		{
-			renderer.Dispose();
-		}
-
-		// Ignore the async task as GetAwaiter().GetResult() can cause deadlock
-		// and implementing IAsyncDisposable in TestContext will be a breaking change.
-		//
-		// NOTE: This has to be called before Services.Dispose().
-		// If there are IAsyncDisposable services registered, calling Dispose first
-		// causes the service provider to throw an exception.
-		_ = Services.DisposeAsync();
+		bunitRenderer?.Dispose();
 
 		// The service provider should dispose of any
 		// disposable object it has created, when it is disposed.

tests/bunit.tests/TestContextTest.cs

@@ -207,10 +207,10 @@ public void Test203()
 	}
 
 	[Fact(DisplayName = "Can correctly resolve and dispose of scoped disposable service")]
-	public void Net5Test001()
+	public async Task Net5Test001()
 	{
 		AsyncDisposableService asyncDisposable;
-		using (var sut = new TestContext())
+		await using (var sut = new TestContext())
 		{
 			sut.Services.AddScoped<AsyncDisposableService>();
 			asyncDisposable = sut.Services.GetService<AsyncDisposableService>();
@@ -219,10 +219,10 @@ public void Net5Test001()
 	}
 
 	[Fact(DisplayName = "Can correctly resolve and dispose of transient disposable service")]
-	public void Net5Test002()
+	public async Task Net5Test002()
 	{
 		AsyncDisposableService asyncDisposable;
-		using (var sut = new TestContext())
+		await using (var sut = new TestContext())
 		{
 			sut.Services.AddTransient<AsyncDisposableService>();
 			asyncDisposable = sut.Services.GetService<AsyncDisposableService>();
@@ -231,10 +231,10 @@ public void Net5Test002()
 	}
 
 	[Fact(DisplayName = "Can correctly resolve and dispose of singleton disposable service")]
-	public void Net5Test003()
+	public async Task Net5Test003()
 	{
 		AsyncDisposableService asyncDisposable;
-		using (var sut = new TestContext())
+		await using (var sut = new TestContext())
 		{
 			sut.Services.AddSingleton<AsyncDisposableService>();
 			asyncDisposable = sut.Services.GetService<AsyncDisposableService>();