[5.6] Re-add class name to '__allTests' for test discovery (#4234)

Motivation:

In #3992 the class
name was stripped from the static array of tests (i.e.
`__allTests_CLASSNAME` became `__allTests`). The class name ensured the
variable was uniquely named. Without it, in a test class which is
derived from another, it is not unique and results in compile-time
errors.

Modifications:

- Reintroduce the class name
- Add tests

Result:

Dervied test classes do not result in compilation errors on Linux.

(cherry picked from commit 27cd3df)

Author: glbrntt

Fixtures/Miscellaneous/TestDiscovery/Subclass/Package.swift

@@ -0,0 +1,10 @@
+// swift-tools-version:5.6
+import PackageDescription
+
+let package = Package(
+    name: "Subclass",
+    targets: [
+        .target(name: "Subclass"),
+        .testTarget(name: "SubclassTests", dependencies: ["Subclass"]),
+    ]
+)

Fixtures/Miscellaneous/TestDiscovery/Subclass/Sources/Subclass/Subclass.swift

@@ -0,0 +1,2 @@
+struct Subclass {
+}

Fixtures/Miscellaneous/TestDiscovery/Subclass/Tests/SubclassTests/SubclassTestsBase.swift

@@ -0,0 +1,7 @@
+import XCTest
+@testable import Subclass
+
+class SubclassTestsBase: XCTestCase {
+    func test1() {
+    }
+}

Fixtures/Miscellaneous/TestDiscovery/Subclass/Tests/SubclassTests/SubclassTestsDerived.swift

@@ -0,0 +1,7 @@
+import XCTest
+@testable import Subclass
+
+class SubclassTestsDerived: SubclassTestsBase {
+    override func test1() {
+    }
+}

Sources/Build/BuildOperationBuildSystemDelegateHandler.swift

@@ -74,7 +74,8 @@ final class TestDiscoveryCommand: CustomLLBuildCommand {
             stream <<< "\n"
             stream <<< "fileprivate extension " <<< className <<< " {" <<< "\n"
             stream <<< indent(4) <<< "@available(*, deprecated, message: \"Not actually deprecated. Marked as deprecated to allow inclusion of deprecated tests (which test deprecated functionality) without warnings\")" <<< "\n"
-            stream <<< indent(4) <<< "static let __allTests = [" <<< "\n"
+            // 'className' provides uniqueness for derived class.
+            stream <<< indent(4) <<< "static let __allTests__\(className) = [" <<< "\n"
             for method in testMethods {
                 stream <<< indent(8) <<< method.allTestsEntry <<< ",\n"
             }
@@ -90,7 +91,7 @@ final class TestDiscoveryCommand: CustomLLBuildCommand {
 
         for iterator in testsByClassNames {
             let className = iterator.key
-            stream <<< indent(8) <<< "testCase(\(className).__allTests),\n"
+            stream <<< indent(8) <<< "testCase(\(className).__allTests__\(className)),\n"
         }
 
         stream <<< """

Tests/FunctionalTests/TestDiscoveryTests.swift

@@ -127,4 +127,17 @@ class TestDiscoveryTests: XCTestCase {
         }
         #endif
     }
+
+    func testSubclassedTestClassTests() throws {
+        #if os(macOS)
+        try XCTSkipIf(true)
+        #endif
+        try fixture(name: "Miscellaneous/TestDiscovery/Subclass") { fixturePath in
+            let (stdout, _) = try executeSwiftTest(fixturePath)
+            // in "swift test" test output goes to stdout
+            XCTAssertMatch(stdout, .contains("SubclassTestsBase.test1"))
+            XCTAssertMatch(stdout, .contains("SubclassTestsDerived.test1"))
+            XCTAssertMatch(stdout, .contains("Executed 2 tests"))
+        }
+    }
 }