Break immediately when cancelling a multiple test run (#1589)

When using "Run Test Multiple Times" or "Run Until Failure" cancelling
the run would prevent subsequent test runs from occuring, but the logs
would still print out "Beginning Test Iteration #x" for each remaining
test iteration.

Exit out of the loop that is running the tests multiple times once
cancellation has been requested. Also clean up the cancellation error
message in the logs to be formatted not as an error but just a message.

Author: plemarquand

src/TestExplorer/TestRunner.ts

@@ -374,6 +374,7 @@ export class TestRunner {
     private testArgs: TestRunArguments;
     private xcTestOutputParser: IXCTestOutputParser;
     private swiftTestOutputParser: SwiftTestingOutputParser;
+    private static CANCELLATION_ERROR = "Test run cancelled";
 
     /**
      * Constructor for TestRunner
@@ -718,8 +719,10 @@ export class TestRunner {
                     break;
             }
         } catch (error) {
-            // Test failures result in error code 1
-            if (error !== 1) {
+            if (error === TestRunner.CANCELLATION_ERROR) {
+                this.testRun.appendOutput(`\r\n${error}`);
+            } else if (error !== 1) {
+                // Test failures result in error code 1
                 this.testRun.appendOutput(`\r\nError: ${getErrorDescription(error)}`);
             } else {
                 // swift-testing tests don't have their run started until the .swift-testing binary has
@@ -793,7 +796,7 @@ export class TestRunner {
             // If the test run is iterrupted by a cancellation request from VS Code, ensure the task is terminated.
             const cancellationDisposable = this.testRun.token.onCancellationRequested(() => {
                 task.execution.terminate("SIGINT");
-                reject("Test run cancelled");
+                reject(TestRunner.CANCELLATION_ERROR);
             });
 
             task.execution.onDidClose(code => {

src/commands/testMultipleTimes.ts

@@ -75,7 +75,10 @@ export async function runTestMultipleTimes(
 
         runStates.push(runState);
 
-        if (untilFailure && (runState.failed.length > 0 || runState.errored.length > 0)) {
+        if (
+            runner.testRun.isCancellationRequested ||
+            (untilFailure && (runState.failed.length > 0 || runState.errored.length > 0))
+        ) {
             break;
         }
     }