Handle cancellation

Author: Youssef1313

README.md

@@ -24,4 +24,3 @@ The general recommendation is to migrate from xunit 2 to xunit.v3 which already
 - `TestMethodIdentifierProperty` is missing the parameter types for parameterized tests.
 - MTP's `--treenode-filter` is not yet supported.
 - MTP's `--maximum-failed-tests` is not yet supported.
-- Cancellation isn't yet supported.

src/YTest.MTP.XUnit2/MTPFramework/XUnit2MTPTestFramework.cs

@@ -3,6 +3,7 @@
 using System.IO;
 using System.Linq;
 using System.Reflection;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Testing.Extensions.TrxReport.Abstractions;
 using Microsoft.Testing.Platform.CommandLine;
@@ -111,7 +112,7 @@ private async Task DiscoverTestsAsync(
 
         using var frontController = GetFrontController(assemblyPath, configuration);
 
-        var testCases = await DiscoverAsync(frontController, configuration);
+        var testCases = await DiscoverAsync(frontController, configuration, context.CancellationToken);
 
         foreach (ITestCase test in testCases)
         {
@@ -182,7 +183,7 @@ private async Task RunTestsAsync(
     {
         var configuration = GetConfiguration(assemblyPath);
         using var frontController = GetFrontController(assemblyPath, configuration);
-        var testCases = await DiscoverAsync(frontController, configuration);
+        var testCases = await DiscoverAsync(frontController, configuration, context.CancellationToken);
 
         var assemblyDisplayName = Path.GetFileNameWithoutExtension(assemblyPath);
         var executionSinkOptions = new ExecutionSinkOptions
@@ -200,9 +201,9 @@ private async Task RunTestsAsync(
         // TODO: SessionFileArtifact
     }
 
-    private static async Task<List<ITestCase>> DiscoverAsync(XunitFrontController frontController, TestAssemblyConfiguration configuration)
+    private static async Task<List<ITestCase>> DiscoverAsync(XunitFrontController frontController, TestAssemblyConfiguration configuration, CancellationToken cancellationToken)
     {
-        using var sink = new TestDiscoverySink();
+        using var sink = new TestDiscoverySink(() => cancellationToken.IsCancellationRequested);
         frontController.Find(includeSourceInformation: true, sink, TestFrameworkOptions.ForDiscovery(configuration));
         await Task.Factory.StartNew(sink.Finished.WaitOne, TaskCreationOptions.LongRunning);
         return sink.TestCases;

src/YTest.MTP.XUnit2/XUnitSinks/MTPExecutionSink.cs

@@ -38,43 +38,67 @@ private void OnTestCaseStarting(MessageHandlerArgs<ITestCaseStarting> args)
         var testNode = CreateTestNode(args.Message);
         testNode.Properties.Add(InProgressTestNodeStateProperty.CachedInstance);
         PublishTestUpdate(testNode);
+        StopIfCancellationIsRequested(args);
     }
 
     private void OnTestFailed(MessageHandlerArgs<ITestFailed> args)
-        => OnFailure(null, args.Message, args.Message);
+    {
+        OnFailure(null, args.Message, args.Message);
+        StopIfCancellationIsRequested(args);
+    }
 
     private void OnTestPassed(MessageHandlerArgs<ITestPassed> args)
     {
         var testNode = CreateTestNode(args.Message);
         testNode.Properties.Add(PassedTestNodeStateProperty.CachedInstance);
 
         PublishTestUpdate(testNode);
+        StopIfCancellationIsRequested(args);
     }
 
     private void OnTestSkipped(MessageHandlerArgs<ITestSkipped> args)
     {
         var testNode = CreateTestNode(args.Message);
         testNode.Properties.Add(new SkippedTestNodeStateProperty(args.Message.Reason));
         PublishTestUpdate(testNode);
+        StopIfCancellationIsRequested(args);
     }
 
     private void OnTestClassCleanupFailure(MessageHandlerArgs<ITestClassCleanupFailure> args)
-        => OnCleanupFailure($"Test Class Cleanup Failure ({args.Message.TestClass.Class.Name})", args.Message);
+    {
+        OnCleanupFailure($"Test Class Cleanup Failure ({args.Message.TestClass.Class.Name})", args.Message);
+        StopIfCancellationIsRequested(args);
+    }
 
     private void OnTestAssemblyCleanupFailure(MessageHandlerArgs<ITestAssemblyCleanupFailure> args)
-        => OnCleanupFailure($"Test Assembly Cleanup Failure ({args.Message.TestAssembly.Assembly.Name})", args.Message);
+    {
+        OnCleanupFailure($"Test Assembly Cleanup Failure ({args.Message.TestAssembly.Assembly.Name})", args.Message);
+        StopIfCancellationIsRequested(args);
+    }
 
     private void OnTestCaseCleanupFailure(MessageHandlerArgs<ITestCaseCleanupFailure> args)
-        => OnCleanupFailure($"Test Case Cleanup Failure ({args.Message.TestCase.DisplayName})", args.Message);
+    {
+        OnCleanupFailure($"Test Case Cleanup Failure ({args.Message.TestCase.DisplayName})", args.Message);
+        StopIfCancellationIsRequested(args);
+    }
 
     private void OnTestMethodCleanupFailure(MessageHandlerArgs<ITestMethodCleanupFailure> args)
-        => OnCleanupFailure($"Test Method Cleanup Failure ({args.Message.TestMethod.TestClass.Class.Name}.{args.Message.TestMethod.Method.Name})", args.Message);
+    {
+        OnCleanupFailure($"Test Method Cleanup Failure ({args.Message.TestMethod.TestClass.Class.Name}.{args.Message.TestMethod.Method.Name})", args.Message);
+        StopIfCancellationIsRequested(args);
+    }
 
     private void OnTestCollectionCleanupFailure(MessageHandlerArgs<ITestCollectionCleanupFailure> args)
-        => OnCleanupFailure($"Test Collection Cleanup Failure ({args.Message.TestCollection.DisplayName})", args.Message);
+    {
+        OnCleanupFailure($"Test Collection Cleanup Failure ({args.Message.TestCollection.DisplayName})", args.Message);
+        StopIfCancellationIsRequested(args);
+    }
 
     private void OnTestCleanupFailure(MessageHandlerArgs<ITestCleanupFailure> args)
-        => OnCleanupFailure($"Test Cleanup Failure ({args.Message.Test.DisplayName})", args.Message);
+    {
+        OnCleanupFailure($"Test Cleanup Failure ({args.Message.Test.DisplayName})", args.Message);
+        StopIfCancellationIsRequested(args);
+    }
 
     private void OnCleanupFailure<T>(string failureName, T message) where T : IFailureInformation, IExecutionMessage
     {
@@ -156,4 +180,12 @@ private TestNode CreateTestNode(ITestCaseMessage testMessage)
 
         return testNode;
     }
+
+    private void StopIfCancellationIsRequested(MessageHandlerArgs args)
+    {
+        if (_executeRequestContext.CancellationToken.IsCancellationRequested)
+        {
+            args.Stop();
+        }
+    }
 }