Remove legacy test content discovery.

This PR removes the legacy test content discovery mechanism that is based on
finding protocol conformances in the type metadata section emitted by the Swift
compiler.

Author: grynspan

Documentation/Porting.md

@@ -145,10 +145,6 @@ to load that information:
 +  let resourceName: Str255 = switch kind {
 +  case .testContent:
 +    "__swift5_tests"
-+#if !SWT_NO_LEGACY_TEST_DISCOVERY
-+  case .typeMetadata:
-+    "__swift5_types"
-+#endif
 +  }
 +
 +  let oldRefNum = CurResFile()
@@ -211,9 +207,8 @@ start with `"SWT_"`).
 If your platform does not support dynamic linking and loading, you will need to
 use static linkage instead. Define the `"SWT_NO_DYNAMIC_LINKING"` compiler
 conditional for your platform in both `Package.swift` and
-`CompilerSettings.cmake`, then define the symbols `_testContentSectionBegin`,
-`_testContentSectionEnd`, `_typeMetadataSectionBegin`, and
-`_typeMetadataSectionEnd` in `SectionBounds.swift`.
+`CompilerSettings.cmake`, then define the symbols `_testContentSectionBegin` and
+`_testContentSectionEnd` in `SectionBounds.swift`:
 
 ```diff
 --- a/Sources/_TestDiscovery/SectionBounds.swift
@@ -222,18 +217,10 @@ conditional for your platform in both `Package.swift` and
 +#elseif os(Classic)
 +@_silgen_name(raw: "...") private nonisolated(unsafe) var _testContentSectionBegin: CChar
 +@_silgen_name(raw: "...") private nonisolated(unsafe) var _testContentSectionEnd: CChar
-+#if !SWT_NO_LEGACY_TEST_DISCOVERY
-+@_silgen_name(raw: "...") private nonisolated(unsafe) var _typeMetadataSectionBegin: CChar
-+@_silgen_name(raw: "...") private nonisolated(unsafe) var _typeMetadataSectionEnd: CChar
-+#endif
  #else
  #warning("Platform-specific implementation missing: Runtime test discovery unavailable (static)")
  private nonisolated(unsafe) var _testContentSectionBegin: Void
  private nonisolated(unsafe) var _testContentSectionEnd: Void
- #if !SWT_NO_LEGACY_TEST_DISCOVERY
- private nonisolated(unsafe) var _typeMetadataSectionBegin: Void
- private nonisolated(unsafe) var _typeMetadataSectionEnd: Void
- #endif
  // ...
 ```
 

Sources/Testing/CMakeLists.txt

@@ -88,7 +88,6 @@ add_library(Testing
   Test.ID.swift
   Test.swift
   Test+Discovery.swift
-  Test+Discovery+Legacy.swift
   Test+Macro.swift
   Traits/Bug.swift
   Traits/Comment.swift

Sources/Testing/ExitTests/ExitTest.swift

@@ -296,15 +296,6 @@ extension ExitTest {
       }
     }
 
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-    // Call the legacy lookup function that discovers tests embedded in types.
-    for record in Self.allTypeMetadataBasedTestContentRecords() {
-      if let exitTest = record.load(withHint: id) {
-        return exitTest
-      }
-    }
-#endif
-
     return nil
   }
 }

Sources/Testing/Test+Discovery+Legacy.swift

@@ -61,47 +61,15 @@ extension Test {
       // defective test records.)
       var result = Set<Self>()
 
-      // Figure out which discovery mechanism to use. By default, we'll use both
-      // the legacy and new mechanisms, but we can set an environment variable
-      // to explicitly select one or the other. When we remove legacy support,
-      // we can also remove this enumeration and environment variable check.
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-      let (useNewMode, useLegacyMode) = switch Environment.flag(named: "SWT_USE_LEGACY_TEST_DISCOVERY") {
-      case .none:
-        (true, true)
-      case .some(true):
-        (false, true)
-      case .some(false):
-        (true, false)
-      }
-#else
-      let useNewMode = true
-#endif
-
       // Walk all test content and gather generator functions, then call them in
       // a task group and collate their results.
-      if useNewMode {
-        let generators = Generator.allTestContentRecords().lazy.compactMap { $0.load() }
-        await withTaskGroup(of: Self.self) { taskGroup in
-          for generator in generators {
-            taskGroup.addTask { await generator.rawValue() }
-          }
-          result = await taskGroup.reduce(into: result) { $0.insert($1) }
-        }
-      }
-
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-      // Perform legacy test discovery if needed.
-      if useLegacyMode && result.isEmpty {
-        let generators = Generator.allTypeMetadataBasedTestContentRecords().lazy.compactMap { $0.load() }
-        await withTaskGroup(of: Self.self) { taskGroup in
-          for generator in generators {
-            taskGroup.addTask { await generator.rawValue() }
-          }
-          result = await taskGroup.reduce(into: result) { $0.insert($1) }
+      let generators = Generator.allTestContentRecords().lazy.compactMap { $0.load() }
+      await withTaskGroup(of: Self.self) { taskGroup in
+        for generator in generators {
+          taskGroup.addTask { await generator.rawValue() }
         }
+        result = await taskGroup.reduce(into: result) { $0.insert($1) }
       }
-#endif
 
       return result
     }

Sources/Testing/Test+Discovery.swift

@@ -11,8 +11,8 @@
 public import SwiftSyntax
 public import SwiftSyntaxMacros
 
-#if !hasFeature(SymbolLinkageMarkers) && SWT_NO_LEGACY_TEST_DISCOVERY
-#error("Platform-specific misconfiguration: either SymbolLinkageMarkers or legacy test discovery is required to expand #expect(exitsWith:)")
+#if !hasFeature(SymbolLinkageMarkers)
+#error("Platform-specific misconfiguration: SymbolLinkageMarkers is required to expand #expect(exitsWith:)")
 #endif
 
 /// A protocol containing the common implementation for the expansions of the
@@ -456,37 +456,14 @@ extension ExitTestConditionMacro {
 
     // Create a local type that can be discovered at runtime and which contains
     // the exit test body.
-    let className = context.makeUniqueName("__🟡$")
+    let className = context.makeUniqueName("")
     let testContentRecordDecl = makeTestContentRecordDecl(
       named: .identifier("testContentRecord"),
       in: TypeSyntax(IdentifierTypeSyntax(name: className)),
       ofKind: .exitTest,
       accessingWith: .identifier("accessor")
     )
 
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-    decls.append(
-      """
-      final class \(className): Testing.__TestContentRecordContainer {
-        private nonisolated static let accessor: Testing.__TestContentRecordAccessor = { outValue, type, hint in
-          Testing.ExitTest.__store(
-            \(exitTestIDExpr),
-            \(bodyThunkName),
-            into: outValue,
-            asTypeAt: type,
-            withHintAt: hint
-          )
-        }
-
-        \(testContentRecordDecl)
-
-        override nonisolated class var __testContentRecord: Testing.__TestContentRecord {
-          testContentRecord
-        }
-      }
-      """
-    )
-#else
     decls.append(
       """
       final class \(className) {
@@ -504,7 +481,6 @@ extension ExitTestConditionMacro {
       }
       """
     )
-#endif
 
     arguments[trailingClosureIndex].expression = ExprSyntax(
       ClosureExprSyntax {

Sources/TestingMacros/ConditionMacro.swift

@@ -11,8 +11,8 @@
 public import SwiftSyntax
 public import SwiftSyntaxMacros
 
-#if !hasFeature(SymbolLinkageMarkers) && SWT_NO_LEGACY_TEST_DISCOVERY
-#error("Platform-specific misconfiguration: either SymbolLinkageMarkers or legacy test discovery is required to expand @Suite")
+#if !hasFeature(SymbolLinkageMarkers)
+#error("Platform-specific misconfiguration: SymbolLinkageMarkers is required to expand @Suite")
 #endif
 
 /// A type describing the expansion of the `@Suite` attribute macro.
@@ -164,21 +164,6 @@ public struct SuiteDeclarationMacro: MemberMacro, PeerMacro, Sendable {
       )
     )
 
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-    // Emit a type that contains a reference to the test content record.
-    let className = context.makeUniqueName("__🟡$")
-    result.append(
-      """
-      @available(*, deprecated, message: "This type is an implementation detail of the testing library. Do not use it directly.")
-      final class \(className): Testing.__TestContentRecordContainer {
-        override nonisolated class var __testContentRecord: Testing.__TestContentRecord {
-          \(testContentRecordName)
-        }
-      }
-      """
-    )
-#endif
-
     return result
   }
 }

Sources/TestingMacros/SuiteDeclarationMacro.swift

@@ -11,8 +11,8 @@
 public import SwiftSyntax
 public import SwiftSyntaxMacros
 
-#if !hasFeature(SymbolLinkageMarkers) && SWT_NO_LEGACY_TEST_DISCOVERY
-#error("Platform-specific misconfiguration: either SymbolLinkageMarkers or legacy test discovery is required to expand @Test")
+#if !hasFeature(SymbolLinkageMarkers)
+#error("Platform-specific misconfiguration: SymbolLinkageMarkers is required to expand @Test")
 #endif
 
 /// A type describing the expansion of the `@Test` attribute macro.
@@ -489,21 +489,6 @@ public struct TestDeclarationMacro: PeerMacro, Sendable {
       )
     )
 
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-    // Emit a type that contains a reference to the test content record.
-    let className = context.makeUniqueName(thunking: functionDecl, withPrefix: "__🟡$")
-    result.append(
-      """
-      @available(*, deprecated, message: "This type is an implementation detail of the testing library. Do not use it directly.")
-      final class \(className): Testing.__TestContentRecordContainer {
-        override nonisolated class var __testContentRecord: Testing.__TestContentRecord {
-          \(testContentRecordName)
-        }
-      }
-      """
-    )
-#endif
-
     return result
   }
 }

Sources/TestingMacros/TestDeclarationMacro.swift

@@ -26,11 +26,6 @@ struct SectionBounds: Sendable {
   enum Kind: Equatable, Hashable, CaseIterable {
     /// The test content metadata section.
     case testContent
-
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-    /// The type metadata section.
-    case typeMetadata
-#endif
   }
 
   /// All section bounds of the given kind found in the current process.
@@ -62,10 +57,6 @@ extension SectionBounds.Kind {
     switch self {
     case .testContent:
       ("__DATA_CONST", "__swift5_tests")
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-    case .typeMetadata:
-      ("__TEXT", "__swift5_types")
-#endif
     }
   }
 }
@@ -190,10 +181,6 @@ private func _sectionBounds(_ kind: SectionBounds.Kind) -> some Sequence<Section
       let range = switch context.pointee.kind {
       case .testContent:
         sections.swift5_tests
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-      case .typeMetadata:
-        sections.swift5_type_metadata
-#endif
       }
       let start = UnsafeRawPointer(bitPattern: range.start)
       let size = Int(clamping: range.length)
@@ -282,10 +269,6 @@ private func _sectionBounds(_ kind: SectionBounds.Kind) -> some Sequence<Section
   let sectionName = switch kind {
   case .testContent:
     ".sw5test"
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-  case .typeMetadata:
-    ".sw5tymd"
-#endif
   }
   return HMODULE.all.lazy.compactMap { _findSection(named: sectionName, in: $0) }
 }
@@ -315,25 +298,13 @@ private func _sectionBounds(_ kind: SectionBounds.Kind) -> some Sequence<Section
 #if SWT_TARGET_OS_APPLE
 @_silgen_name(raw: "section$start$__DATA_CONST$__swift5_tests") private nonisolated(unsafe) var _testContentSectionBegin: CChar
 @_silgen_name(raw: "section$end$__DATA_CONST$__swift5_tests") private nonisolated(unsafe) var _testContentSectionEnd: CChar
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-@_silgen_name(raw: "section$start$__TEXT$__swift5_types") private nonisolated(unsafe) var _typeMetadataSectionBegin: CChar
-@_silgen_name(raw: "section$end$__TEXT$__swift5_types") private nonisolated(unsafe) var _typeMetadataSectionEnd: CChar
-#endif
 #elseif os(WASI)
 @_silgen_name(raw: "__start_swift5_tests") private nonisolated(unsafe) var _testContentSectionBegin: CChar
 @_silgen_name(raw: "__stop_swift5_tests") private nonisolated(unsafe) var _testContentSectionEnd: CChar
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-@_silgen_name(raw: "__start_swift5_type_metadata") private nonisolated(unsafe) var _typeMetadataSectionBegin: CChar
-@_silgen_name(raw: "__stop_swift5_type_metadata") private nonisolated(unsafe) var _typeMetadataSectionEnd: CChar
-#endif
 #else
 #warning("Platform-specific implementation missing: Runtime test discovery unavailable (static)")
 private nonisolated(unsafe) var _testContentSectionBegin: Void
 private nonisolated(unsafe) var _testContentSectionEnd: Void
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-private nonisolated(unsafe) var _typeMetadataSectionBegin: Void
-private nonisolated(unsafe) var _typeMetadataSectionEnd: Void
-#endif
 
 extension UnsafeRawBufferPointer {
   /// Construct an empty buffer.
@@ -360,16 +331,12 @@ extension UnsafeRawBufferPointer {
 /// - Parameters:
 ///   - kind: Which kind of metadata section to return.
 ///
-/// - Returns: A structure describing the bounds of the type metadata section
-///   contained in the same image as the testing library itself.
+/// - Returns: A structure describing the bounds of the given section contained
+///   in the same image as the testing library itself.
 private func _sectionBounds(_ kind: SectionBounds.Kind) -> some Sequence<SectionBounds> {
   let buffer = switch kind {
   case .testContent:
     UnsafeRawBufferPointer(sectionBegin: &_testContentSectionBegin, sectionEnd: &_testContentSectionEnd)
-#if !SWT_NO_LEGACY_TEST_DISCOVERY
-  case .typeMetadata:
-    UnsafeRawBufferPointer(sectionBegin: &_typeMetadataSectionBegin, sectionEnd: &_typeMetadataSectionEnd)
-#endif
   }
   let sb = SectionBounds(imageAddress: nil, buffer: buffer)
   return CollectionOfOne(sb)