feat: add disposal execution support in hook executors and related tests (#3928)

thomhurst · web-flow · commit 7d5e29311f7f · 2025-11-28T00:16:25.000Z
diff --git a/TUnit.Core/Executors/GenericAbstractExecutor.cs b/TUnit.Core/Executors/GenericAbstractExecutor.cs
@@ -57,6 +57,11 @@ public ValueTask ExecuteAfterTestHook(MethodMetadata hookMethodInfo, TestContext
         return ExecuteAsync(action);
     }
 
+    public ValueTask ExecuteDisposal(TestContext context, Func<ValueTask> action)
+    {
+        return ExecuteAsync(action);
+    }
+
     public ValueTask ExecuteTest(TestContext context, Func<ValueTask> action)
     {
         return ExecuteAsync(action);
diff --git a/TUnit.Core/Interfaces/IHookExecutor.cs b/TUnit.Core/Interfaces/IHookExecutor.cs
@@ -13,4 +13,11 @@ public interface IHookExecutor
     ValueTask ExecuteAfterAssemblyHook(MethodMetadata hookMethodInfo, AssemblyHookContext context, Func<ValueTask> action);
     ValueTask ExecuteAfterClassHook(MethodMetadata hookMethodInfo, ClassHookContext context, Func<ValueTask> action);
     ValueTask ExecuteAfterTestHook(MethodMetadata hookMethodInfo, TestContext context, Func<ValueTask> action);
+
+#if NETSTANDARD2_0
+    ValueTask ExecuteDisposal(TestContext context, Func<ValueTask> action);
+#else
+    ValueTask ExecuteDisposal(TestContext context, Func<ValueTask> action)
+        => action();
+#endif
 }
diff --git a/TUnit.Engine/Discovery/ReflectionHookDiscoveryService.cs b/TUnit.Engine/Discovery/ReflectionHookDiscoveryService.cs
@@ -1029,4 +1029,7 @@ public ValueTask ExecuteBeforeTestSessionHook(MethodMetadata testMethod, TestSes
 
     public ValueTask ExecuteAfterTestSessionHook(MethodMetadata testMethod, TestSessionContext context, Func<ValueTask> action)
         => action();
+
+    public ValueTask ExecuteDisposal(TestContext context, Func<ValueTask> action)
+        => action();
 }
diff --git a/TUnit.Engine/Services/TestExecution/TestCoordinator.cs b/TUnit.Engine/Services/TestExecution/TestCoordinator.cs
@@ -1,6 +1,7 @@
 using System.Linq;
 using TUnit.Core;
 using TUnit.Core.Exceptions;
+using TUnit.Core.Interfaces;
 using TUnit.Core.Logging;
 using TUnit.Core.Tracking;
 using TUnit.Engine.Helpers;
@@ -152,7 +153,8 @@ await TimeoutHelper.ExecuteWithTimeoutAsync(
 
                             try
                             {
-                                await TestExecutor.DisposeTestInstance(test).ConfigureAwait(false);
+                                var hookExecutor = test.Context.CustomHookExecutor;
+                                await TestExecutor.DisposeTestInstance(test, hookExecutor).ConfigureAwait(false);
                             }
                             catch (Exception disposeEx)
                             {
diff --git a/TUnit.Engine/TestExecutor.cs b/TUnit.Engine/TestExecutor.cs
@@ -247,12 +247,12 @@ public IContextProvider GetContextProvider()
         return _contextProvider;
     }
 
-    internal static async Task DisposeTestInstance(AbstractExecutableTest test)
+    internal static async Task DisposeTestInstance(AbstractExecutableTest test, IHookExecutor? hookExecutor = null)
     {
         // Dispose the test instance if it's disposable
         if (test.Context.Metadata.TestDetails.ClassInstance is not SkippedTestInstance)
         {
-            try
+            async ValueTask DisposeAsync()
             {
                 var instance = test.Context.Metadata.TestDetails.ClassInstance;
 
@@ -266,6 +266,18 @@ internal static async Task DisposeTestInstance(AbstractExecutableTest test)
                         break;
                 }
             }
+
+            try
+            {
+                if (hookExecutor != null)
+                {
+                    await hookExecutor.ExecuteDisposal(test.Context, DisposeAsync).ConfigureAwait(false);
+                }
+                else
+                {
+                    await DisposeAsync().ConfigureAwait(false);
+                }
+            }
             catch
             {
                 // Swallow disposal errors - they shouldn't fail the test
diff --git a/TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet10_0.verified.txt b/TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet10_0.verified.txt
@@ -749,6 +749,7 @@ namespace
         public . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action) { }
         public . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action) { }
         public . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action) { }
+        public . ExecuteDisposal(.TestContext context, <.> action) { }
         public . ExecuteTest(.TestContext context, <.> action) { }
     }
     public sealed class GenericMethodInfo
@@ -2269,6 +2270,7 @@ namespace .Interfaces
         . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action);
         . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action);
         . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action);
+        . ExecuteDisposal(.TestContext context, <.> action);
     }
     public interface IHookRegisteredEventReceiver : .
     {
diff --git a/TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet8_0.verified.txt b/TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet8_0.verified.txt
@@ -749,6 +749,7 @@ namespace
         public . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action) { }
         public . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action) { }
         public . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action) { }
+        public . ExecuteDisposal(.TestContext context, <.> action) { }
         public . ExecuteTest(.TestContext context, <.> action) { }
     }
     public sealed class GenericMethodInfo
@@ -2269,6 +2270,7 @@ namespace .Interfaces
         . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action);
         . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action);
         . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action);
+        . ExecuteDisposal(.TestContext context, <.> action);
     }
     public interface IHookRegisteredEventReceiver : .
     {
diff --git a/TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet9_0.verified.txt b/TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet9_0.verified.txt
@@ -749,6 +749,7 @@ namespace
         public . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action) { }
         public . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action) { }
         public . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action) { }
+        public . ExecuteDisposal(.TestContext context, <.> action) { }
         public . ExecuteTest(.TestContext context, <.> action) { }
     }
     public sealed class GenericMethodInfo
@@ -2269,6 +2270,7 @@ namespace .Interfaces
         . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action);
         . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action);
         . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action);
+        . ExecuteDisposal(.TestContext context, <.> action);
     }
     public interface IHookRegisteredEventReceiver : .
     {
diff --git a/TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.Net4_7.verified.txt b/TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.Net4_7.verified.txt
@@ -726,6 +726,7 @@ namespace
         public . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action) { }
         public . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action) { }
         public . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action) { }
+        public . ExecuteDisposal(.TestContext context, <.> action) { }
         public . ExecuteTest(.TestContext context, <.> action) { }
     }
     public sealed class GenericMethodInfo
@@ -2201,6 +2202,7 @@ namespace .Interfaces
         . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action);
         . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action);
         . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action);
+        . ExecuteDisposal(.TestContext context, <.> action);
     }
     public interface IHookRegisteredEventReceiver : .
     {
diff --git a/TUnit.TestProject/SetHookExecutorTests.cs b/TUnit.TestProject/SetHookExecutorTests.cs
@@ -117,3 +117,36 @@ public async Task Test_StaticHooksExecuteInCustomExecutor()
         await Assert.That(Thread.CurrentThread.Name).IsEqualTo("CrossPlatformTestExecutor");
     }
 }
+
+/// <summary>
+/// Tests demonstrating SetHookExecutor affects disposal execution - Issue #3918
+/// </summary>
+[EngineTest(ExpectedResult.Pass)]
+[SetBothExecutors] // This attribute sets both executors
+public class DisposalWithHookExecutorTests : IAsyncDisposable
+{
+    private static bool _disposalExecutedInCustomExecutor;
+
+    [Test]
+    public async Task Test_ExecutesInCustomExecutor()
+    {
+        // Test should execute in custom executor
+        await Assert.That(Thread.CurrentThread.Name).IsEqualTo("CrossPlatformTestExecutor");
+        await Assert.That(CrossPlatformTestExecutor.IsRunningInTestExecutor.Value).IsTrue();
+    }
+
+    public ValueTask DisposeAsync()
+    {
+        // Verify disposal runs in the custom executor
+        _disposalExecutedInCustomExecutor =
+            Thread.CurrentThread.Name == "CrossPlatformTestExecutor" &&
+            CrossPlatformTestExecutor.IsRunningInTestExecutor.Value;
+        return default;
+    }
+
+    [After(Class)]
+    public static async Task VerifyDisposalRanInCustomExecutor(ClassHookContext context)
+    {
+        await Assert.That(_disposalExecutedInCustomExecutor).IsTrue();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,11 @@ public ValueTask ExecuteAfterTestHook(MethodMetadata hookMethodInfo, TestContext`
`57`	`57`	`return ExecuteAsync(action);`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ public ValueTask ExecuteDisposal(TestContext context, Func<ValueTask> action)`
	`61`	`+ {`
	`62`	`+ return ExecuteAsync(action);`
	`63`	`+ }`
	`64`	`+`
`60`	`65`	`public ValueTask ExecuteTest(TestContext context, Func<ValueTask> action)`
`61`	`66`	`{`
`62`	`67`	`return ExecuteAsync(action);`
Original file line number	Diff line number	Diff line change
`@@ -1029,4 +1029,7 @@ public ValueTask ExecuteBeforeTestSessionHook(MethodMetadata testMethod, TestSes`
`1029`	`1029`
`1030`	`1030`	`public ValueTask ExecuteAfterTestSessionHook(MethodMetadata testMethod, TestSessionContext context, Func<ValueTask> action)`
`1031`	`1031`	`=> action();`
	`1032`	`+`
	`1033`	`+ public ValueTask ExecuteDisposal(TestContext context, Func<ValueTask> action)`
	`1034`	`+ => action();`
`1032`	`1035`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using System.Linq;`
`2`	`2`	`using TUnit.Core;`
`3`	`3`	`using TUnit.Core.Exceptions;`
	`4`	`+using TUnit.Core.Interfaces;`
`4`	`5`	`using TUnit.Core.Logging;`
`5`	`6`	`using TUnit.Core.Tracking;`
`6`	`7`	`using TUnit.Engine.Helpers;`
`@@ -152,7 +153,8 @@ await TimeoutHelper.ExecuteWithTimeoutAsync(`
`152`	`153`
`153`	`154`	`try`
`154`	`155`	`{`
`155`		`- await TestExecutor.DisposeTestInstance(test).ConfigureAwait(false);`
	`156`	`+ var hookExecutor = test.Context.CustomHookExecutor;`
	`157`	`+ await TestExecutor.DisposeTestInstance(test, hookExecutor).ConfigureAwait(false);`
`156`	`158`	`}`
`157`	`159`	`catch (Exception disposeEx)`
`158`	`160`	`{`
Original file line number	Diff line number	Diff line change
`@@ -247,12 +247,12 @@ public IContextProvider GetContextProvider()`
`247`	`247`	`return _contextProvider;`
`248`	`248`	`}`
`249`	`249`
`250`		`- internal static async Task DisposeTestInstance(AbstractExecutableTest test)`
	`250`	`+ internal static async Task DisposeTestInstance(AbstractExecutableTest test, IHookExecutor? hookExecutor = null)`
`251`	`251`	`{`
`252`	`252`	`// Dispose the test instance if it's disposable`
`253`	`253`	`if (test.Context.Metadata.TestDetails.ClassInstance is not SkippedTestInstance)`
`254`	`254`	`{`
`255`		`- try`
	`255`	`+ async ValueTask DisposeAsync()`
`256`	`256`	`{`
`257`	`257`	`var instance = test.Context.Metadata.TestDetails.ClassInstance;`
`258`	`258`
`@@ -266,6 +266,18 @@ internal static async Task DisposeTestInstance(AbstractExecutableTest test)`
`266`	`266`	`break;`
`267`	`267`	`}`
`268`	`268`	`}`
	`269`	`+`
	`270`	`+ try`
	`271`	`+ {`
	`272`	`+ if (hookExecutor != null)`
	`273`	`+ {`
	`274`	`+ await hookExecutor.ExecuteDisposal(test.Context, DisposeAsync).ConfigureAwait(false);`
	`275`	`+ }`
	`276`	`+ else`
	`277`	`+ {`
	`278`	`+ await DisposeAsync().ConfigureAwait(false);`
	`279`	`+ }`
	`280`	`+ }`
`269`	`281`	`catch`
`270`	`282`	`{`
`271`	`283`	`// Swallow disposal errors - they shouldn't fail the test`
Original file line number	Diff line number	Diff line change
`@@ -749,6 +749,7 @@ namespace`
`749`	`749`	`public . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action) { }`
`750`	`750`	`public . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action) { }`
`751`	`751`	`public . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action) { }`
	`752`	`+ public . ExecuteDisposal(.TestContext context, <.> action) { }`
`752`	`753`	`public . ExecuteTest(.TestContext context, <.> action) { }`
`753`	`754`	`}`
`754`	`755`	`public sealed class GenericMethodInfo`
`@@ -2269,6 +2270,7 @@ namespace .Interfaces`
`2269`	`2270`	`. ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action);`
`2270`	`2271`	`. ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action);`
`2271`	`2272`	`. ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action);`
	`2273`	`+ . ExecuteDisposal(.TestContext context, <.> action);`
`2272`	`2274`	`}`
`2273`	`2275`	`public interface IHookRegisteredEventReceiver : .`
`2274`	`2276`	`{`
Original file line number	Diff line number	Diff line change
`@@ -726,6 +726,7 @@ namespace`
`726`	`726`	`public . ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action) { }`
`727`	`727`	`public . ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action) { }`
`728`	`728`	`public . ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action) { }`
	`729`	`+ public . ExecuteDisposal(.TestContext context, <.> action) { }`
`729`	`730`	`public . ExecuteTest(.TestContext context, <.> action) { }`
`730`	`731`	`}`
`731`	`732`	`public sealed class GenericMethodInfo`
`@@ -2201,6 +2202,7 @@ namespace .Interfaces`
`2201`	`2202`	`. ExecuteBeforeTestDiscoveryHook(.MethodMetadata hookMethodInfo, .BeforeTestDiscoveryContext context, <.> action);`
`2202`	`2203`	`. ExecuteBeforeTestHook(.MethodMetadata hookMethodInfo, .TestContext context, <.> action);`
`2203`	`2204`	`. ExecuteBeforeTestSessionHook(.MethodMetadata hookMethodInfo, .TestSessionContext context, <.> action);`
	`2205`	`+ . ExecuteDisposal(.TestContext context, <.> action);`
`2204`	`2206`	`}`
`2205`	`2207`	`public interface IHookRegisteredEventReceiver : .`
`2206`	`2208`	`{`