Address PR comments

* Move all the new XCTestCase files into a directory so they're more easily discovered and maintained
* Actor -> Class to preserve existing clients
* Remove erroneous thrown error from new async test to resolve a test failure

Author: Sean Olszewski

Sources/XCTest/Public/Factory_Methods.swift renamed to Sources/XCTest/Public/XCTestCase/Factory_Methods.swift

@@ -0,0 +1,45 @@
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See http://swift.org/LICENSE.txt for license information
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//
+//  XCTestCase.ClosureType.swift
+//  Extension on XCTestCase which encapsulates ClosureType
+//
+
+///  XCTestCase.TeardownBlocksState
+///  A class which encapsulates teardown blocks which are registered via the `addTearDownBlock(_block:)` method.
+///  Supports async and sync throwing methods
+
+extension XCTestCase {
+    class TeardownBlocksState {
+        
+        enum BlockType {
+            case sync(() throws -> Void)
+            case async(() async throws -> Void)
+        }
+        
+        private var wasFinalized = false
+        private var blocks: [BlockType] = []
+
+        func append(_ block: @escaping () throws -> Void) {
+            precondition(wasFinalized == false, "API violation -- attempting to add a teardown block after teardown blocks have been dequeued")
+            self.blocks.append(.sync(block))
+        }
+        
+        func append(_ block: @escaping () async throws -> Void) {
+            precondition(wasFinalized == false, "API violation -- attempting to add a teardown block after teardown blocks have been dequeued")
+            self.blocks.append(.async(block))
+        }
+
+        func finalize() -> [BlockType] {
+            precondition(wasFinalized == false, "API violation -- attempting to run teardown blocks after they've already run")
+            wasFinalized = true
+            return self.blocks
+        }
+    }
+}

Sources/XCTest/Public/XCTestCase+Performance.swift renamed to Sources/XCTest/Public/XCTestCase/XCTestCase+Performance.swift

@@ -55,7 +55,11 @@ open class XCTestCase: XCTest {
     /// The set of expectations made upon this test case.
     private var _allExpectations = [XCTestExpectation]()
 
-    private var setupEncounteredError = true
+    private let teardownBlocks = TeardownBlocksState()
+    
+    // This time interval is set to a very large value due to their being no real native timeout functionality within corelibs-xctest.
+    // With the introduction of async/await support, the framework now relies on XCTestExpectations internally to coordinate the addition async portions of setup and tear down.
+    // This time interval is the timeout corelibs-xctest uses with XCTestExpectations.
     private static let asyncTestTimeout: TimeInterval = 60 * 60 * 24 * 30
 
     internal var expectations: [XCTestExpectation] {
@@ -127,13 +131,11 @@ open class XCTestCase: XCTest {
     /// Invoking a test performs its setUp, invocation, and tearDown. In
     /// general this should not be called directly.
     open func invokeTest() {
+        performSetup()
         if skip == nil {
-            performSetup()
-            if !setupEncounteredError {
-                performTest()
-            }
-            performTeardown()
+            performTest()
         }
+        performTeardown()
 
         if let skip = skip {
             testRun?.recordSkip(description: skip.summary, sourceLocation: skip.sourceLocation)
@@ -162,7 +164,6 @@ open class XCTestCase: XCTest {
                 try await setUp()
             } catch {
                 recordError(error)
-                self.setupEncounteredError = true
             }
         }
         _ = XCTWaiter.wait(for: [asyncSetUpExpectation], timeout: Self.asyncTestTimeout)
@@ -171,7 +172,6 @@ open class XCTestCase: XCTest {
             try setUpWithError()
         } catch {
             recordError(error)
-            self.setupEncounteredError = true
         }
 
         setUp()
@@ -200,10 +200,15 @@ open class XCTestCase: XCTest {
     }
 
     func performTeardown() {
-        @Sendable func runTeardownBlocks(errorHandler: (Error) -> Void) async {
-            for block in await teardownBlocks.finalize().reversed() {
+        @Sendable func runTeardownBlocks(errorHandler: @escaping (Error) -> Void) async {
+            for block in teardownBlocks.finalize().reversed() {
                 do {
-                    try await block()
+                    switch block {
+                    case .sync(let teardownBlock):
+                        try teardownBlock()
+                    case .async(let teardownBlock):
+                        try await teardownBlock()
+                    }
                 } catch {
                     errorHandler(error)
                 }
@@ -290,37 +295,19 @@ open class XCTestCase: XCTest {
     /// class.
     open class func tearDown() {}
 
-    private actor TeardownBlocksState {
-        
-        private var wasFinalized = false
-        private var blocks: [() async throws -> Void] = []
-
-        func append(_ block: @escaping () async throws -> Void) {
-            precondition(wasFinalized == false, "API violation -- attempting to add a teardown block after teardown blocks have been dequeued")
-            self.blocks.append(block)
-        }
-
-        func finalize() -> [() async throws -> Void] {
-            precondition(wasFinalized == false, "API violation -- attempting to run teardown blocks after they've already run")
-            wasFinalized = true
-            return self.blocks
-        }
-    }
-
-    private let teardownBlocks = TeardownBlocksState()
-
-    /// Registers a block of teardown code to be run after the current test
+    /// Registers a block of teardown code to be sychronously ran after the current test
     /// method ends.
     open func addTeardownBlock(_ block: @escaping () -> Void) {
-        Task {
-            await teardownBlocks.append(block)
+        XCTWaiter.subsystemQueue.sync {
+            teardownBlocks.append(block)
         }
     }
 
-    // TODO: Doc comment
+    /// Registers a block of teardown code to be asychronously ran after the current test
+    /// method ends. The thread this block is executed on is decided by the Swift runtime.
     open func addTeardownBlock(_ block: @escaping () async throws -> Void) {
-        Task {
-            await teardownBlocks.append(block)
+        XCTWaiter.subsystemQueue.sync {
+            teardownBlocks.append(block)
         }
     }
 

Sources/XCTest/Public/XCTestCase.ClosureType.swift renamed to Sources/XCTest/Public/XCTestCase/XCTestCase.ClosureType.swift

@@ -53,12 +53,9 @@ class AsyncAwaitTests: XCTestCase {
         ]
     }()
 
-    override func setUp() async throws {
-    }
+    override func setUp() async throws {}
 
-    override func tearDown() async throws {
-        throw TestActor.Errors.example
-    }
+    override func tearDown() async throws {}
 
     // CHECK: Test Case 'AsyncAwaitTests.test_explicitFailures_withinAsyncTests_areReported' started at \d+-\d+-\d+ \d+:\d+:\d+\.\d+
     // CHECK: .*[/\\]Asynchronous[/\\]Use[/\\]main.swift:[[@LINE+3]]: error: AsyncAwaitTests.test_explicitFailures_withinAsyncTests_areReported : XCTAssertTrue failed -

Sources/XCTest/Public/XCTestCase.Entry.swift renamed to Sources/XCTest/Public/XCTestCase/XCTestCase.Entry.swift

@@ -15,6 +15,7 @@
 		17D5B680211216EF00D93239 /* SourceLocation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17D5B67F211216EF00D93239 /* SourceLocation.swift */; };
 		A516286D26C1D8C80015BA86 /* Factory_Methods.swift in Sources */ = {isa = PBXBuildFile; fileRef = A516286C26C1D8C80015BA86 /* Factory_Methods.swift */; };
 		A52317E926CC227F002DDA48 /* XCTestCase.Entry.swift in Sources */ = {isa = PBXBuildFile; fileRef = A52317E826CC227F002DDA48 /* XCTestCase.Entry.swift */; };
+		A52317EB26CC52CA002DDA48 /* XCTestCase.TearDownBlocksState.swift in Sources */ = {isa = PBXBuildFile; fileRef = A52317EA26CC52C9002DDA48 /* XCTestCase.TearDownBlocksState.swift */; };
 		A5C3F89626BC9A96004A70C8 /* XCTestCase.ClosureType.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5C3F89526BC9A96004A70C8 /* XCTestCase.ClosureType.swift */; };
 		AE2FE0FB1CFE86DB003EF0D7 /* XCAbstractTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE2FE0EA1CFE86DB003EF0D7 /* XCAbstractTest.swift */; };
 		AE2FE0FE1CFE86DB003EF0D7 /* XCTAssert.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE2FE0ED1CFE86DB003EF0D7 /* XCTAssert.swift */; };
@@ -63,6 +64,7 @@
 		5B5D86DB1BBC74AD00234F36 /* SwiftXCTest.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SwiftXCTest.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		A516286C26C1D8C80015BA86 /* Factory_Methods.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Factory_Methods.swift; sourceTree = "<group>"; };
 		A52317E826CC227F002DDA48 /* XCTestCase.Entry.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = XCTestCase.Entry.swift; sourceTree = "<group>"; };
+		A52317EA26CC52C9002DDA48 /* XCTestCase.TearDownBlocksState.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = XCTestCase.TearDownBlocksState.swift; sourceTree = "<group>"; };
 		A5C3F89526BC9A96004A70C8 /* XCTestCase.ClosureType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = XCTestCase.ClosureType.swift; sourceTree = "<group>"; };
 		AE2FE0EA1CFE86DB003EF0D7 /* XCAbstractTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = XCAbstractTest.swift; sourceTree = "<group>"; };
 		AE2FE0ED1CFE86DB003EF0D7 /* XCTAssert.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = XCTAssert.swift; sourceTree = "<group>"; };
@@ -130,6 +132,19 @@
 			name = Products;
 			sourceTree = "<group>";
 		};
+		A52317EC26CC53D3002DDA48 /* XCTestCase */ = {
+			isa = PBXGroup;
+			children = (
+				A516286C26C1D8C80015BA86 /* Factory_Methods.swift */,
+				AE2FE0EE1CFE86DB003EF0D7 /* XCTestCase.swift */,
+				A52317E826CC227F002DDA48 /* XCTestCase.Entry.swift */,
+				A52317EA26CC52C9002DDA48 /* XCTestCase.TearDownBlocksState.swift */,
+				A5C3F89526BC9A96004A70C8 /* XCTestCase.ClosureType.swift */,
+				AE2FE0F01CFE86DB003EF0D7 /* XCTestCase+Performance.swift */,
+			);
+			path = XCTestCase;
+			sourceTree = "<group>";
+		};
 		AE2FE0E81CFE86A5003EF0D7 /* Private */ = {
 			isa = PBXGroup;
 			children = (
@@ -156,9 +171,7 @@
 				AE2FE0EA1CFE86DB003EF0D7 /* XCAbstractTest.swift */,
 				AE2FE0ED1CFE86DB003EF0D7 /* XCTAssert.swift */,
 				1748FE3623AFD2D80014DB87 /* XCTSkip.swift */,
-				AE2FE0EE1CFE86DB003EF0D7 /* XCTestCase.swift */,
-				A5C3F89526BC9A96004A70C8 /* XCTestCase.ClosureType.swift */,
-				AE2FE0F01CFE86DB003EF0D7 /* XCTestCase+Performance.swift */,
+				A52317EC26CC53D3002DDA48 /* XCTestCase */,
 				AE2FE0F11CFE86DB003EF0D7 /* XCTestCaseRun.swift */,
 				AE2FE0F21CFE86DB003EF0D7 /* XCTestErrors.swift */,
 				AE2FE0F41CFE86DB003EF0D7 /* XCTestMain.swift */,
@@ -167,8 +180,6 @@
 				AE2FE0F71CFE86DB003EF0D7 /* XCTestRun.swift */,
 				AE2FE0F81CFE86DB003EF0D7 /* XCTestSuite.swift */,
 				AE2FE0F91CFE86DB003EF0D7 /* XCTestSuiteRun.swift */,
-				A516286C26C1D8C80015BA86 /* Factory_Methods.swift */,
-				A52317E826CC227F002DDA48 /* XCTestCase.Entry.swift */,
 			);
 			path = Public;
 			sourceTree = "<group>";
@@ -347,6 +358,7 @@
 				AE2FE1011CFE86DB003EF0D7 /* XCTestCase+Performance.swift in Sources */,
 				DA9D441B1D920A3500108768 /* XCTestCase+Asynchronous.swift in Sources */,
 				AE2FE1181CFE86E6003EF0D7 /* PrintObserver.swift in Sources */,
+				A52317EB26CC52CA002DDA48 /* XCTestCase.TearDownBlocksState.swift in Sources */,
 				17B6C3EB210D5A3900A11ECC /* XCTWaiter.swift in Sources */,
 				17B6C3EF210F990100A11ECC /* XCTWaiter+Validation.swift in Sources */,
 				AE2FE1021CFE86DB003EF0D7 /* XCTestCaseRun.swift in Sources */,