Merge branch 'main' into jgrynspan/third-party-testing-library-discovery

grynspan · grynspan · commit 083767beeb17 · 2025-12-30T10:38:44.000-05:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/automerge.yml b/.github/workflows/automerge.yml
@@ -18,7 +18,7 @@ on:
 jobs:
   create_merge_pr:
     name: Create PR to merge main into release branch
-    uses: swiftlang/github-workflows/.github/workflows/create_automerge_pr.yml@main
+    uses: swiftlang/github-workflows/.github/workflows/create_automerge_pr.yml@0.0.3
     with:
       head_branch: main
       base_branch: release/6.3
diff --git a/.github/workflows/main_using_main.yml b/.github/workflows/main_using_main.yml
@@ -15,7 +15,7 @@ concurrency:
 jobs:
   tests:
     name: Test
-    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@0.0.2
     with:
       linux_swift_versions: '["nightly-main"]'
       linux_os_versions: '["amazonlinux2", "jammy"]'
diff --git a/.github/workflows/main_using_release.yml b/.github/workflows/main_using_release.yml
@@ -15,7 +15,7 @@ concurrency:
 jobs:
   tests:
     name: Test
-    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@0.0.2
     with:
       linux_swift_versions: '["nightly-6.2"]'
       linux_os_versions: '["amazonlinux2", "jammy"]'
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -14,11 +14,11 @@ concurrency:
 jobs:
   tests:
     name: Test
-    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@0.0.2
     with:
-      linux_swift_versions: '["nightly-main", "nightly-6.2"]'
+      linux_swift_versions: '["nightly-main", "nightly-6.3", "nightly-6.2"]'
       linux_os_versions: '["amazonlinux2", "jammy"]'
-      windows_swift_versions: '["nightly-main", "nightly-6.2"]'
+      windows_swift_versions: '["nightly-main", "nightly-6.3", "nightly-6.2"]'
       enable_macos_checks: true
       macos_exclude_xcode_versions: '[{"xcode_version": "16.2"}, {"xcode_version": "16.3"}, {"xcode_version": "16.4"}]'
       enable_ios_checks: true
@@ -27,7 +27,7 @@ jobs:
       enable_android_sdk_build: true
   soundness:
     name: Soundness
-    uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
+    uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.3
     with:
       license_header_check_project_name: "Swift"
       docs_check_enabled: false
diff --git a/Sources/Overlays/_Testing_Foundation/Attachments/Attachment+URL.swift b/Sources/Overlays/_Testing_Foundation/Attachments/Attachment+URL.swift
@@ -47,7 +47,7 @@ extension Attachment where AttachableValue == _AttachableURLWrapper {
   ///
   /// When you call this initializer and pass it the URL of a file, it reads or
   /// maps the contents of that file into memory. When you call this initializer
-  /// and pass it the URL of a directory, it creates a temporary zip file of the
+  /// and pass it the URL of a directory, it creates a temporary ZIP file of the
   /// directory before reading or mapping it into memory. These operations may
   /// take some time, so this initializer suspends the calling task until they
   /// are complete.
diff --git a/Sources/Testing/ABI/ABI.Record.swift b/Sources/Testing/ABI/ABI.Record.swift
@@ -85,15 +85,26 @@ extension ABI.Record: Codable {
   init(from decoder: any Decoder) throws {
     let container = try decoder.container(keyedBy: CodingKeys.self)
 
-    let versionNumber = try container.decode(VersionNumber.self, forKey: .version)
-    if versionNumber != V.versionNumber {
+    func validateVersionNumber(_ versionNumber: VersionNumber) throws {
+      if versionNumber == V.versionNumber {
+        return
+      }
+#if !hasFeature(Embedded)
+      // Allow for alternate version numbers if they correspond to the expected
+      // record version (e.g. "1.2.3" might map to `v1_2_0` without a problem.)
+      if ABI.version(forVersionNumber: versionNumber) == V.self {
+        return
+      }
+#endif
       throw DecodingError.dataCorrupted(
         DecodingError.Context(
           codingPath: decoder.codingPath + CollectionOfOne(CodingKeys.version as any CodingKey),
           debugDescription: "Unexpected record version \(versionNumber) (expected \(V.versionNumber))."
         )
       )
     }
+    let versionNumber = try container.decode(VersionNumber.self, forKey: .version)
+    try validateVersionNumber(versionNumber)
 
     switch try container.decode(String.self, forKey: .kind) {
     case "_library":
diff --git a/Sources/Testing/ABI/ABI.swift b/Sources/Testing/ABI/ABI.swift
@@ -43,7 +43,7 @@ extension ABI {
   }
 
   /// The current supported ABI version (ignoring any experimental versions.)
-  typealias CurrentVersion = v0
+  typealias CurrentVersion = v6_3
 
   /// The highest defined and supported ABI version (including any experimental
   /// versions.)
@@ -55,10 +55,18 @@ extension ABI {
   /// - Parameters:
   ///   - versionNumber: The ABI version number for which a concrete type is
   ///     needed.
+  ///   - swiftCompilerVersion: The version number of the Swift compiler. This
+  ///     is used when `versionNumber` is greater than the highest known version
+  ///     to determine whether a version type can be returned. The default value
+  ///     is the version of the Swift compiler which was used to build the
+  ///     testing library.
   ///
   /// - Returns: A type conforming to ``ABI/Version`` that represents the given
   ///   ABI version, or `nil` if no such type exists.
-  static func version(forVersionNumber versionNumber: VersionNumber = ABI.CurrentVersion.versionNumber) -> (any Version.Type)? {
+  static func version(
+    forVersionNumber versionNumber: VersionNumber,
+    givenSwiftCompilerVersion swiftCompilerVersion: @autoclosure () -> VersionNumber = swiftCompilerVersion
+  ) -> (any Version.Type)? {
     // Special-case the experimental ABI version number (which is intentionally
     // higher than any Swift release's version number).
     if versionNumber == ExperimentalVersion.versionNumber {
@@ -77,7 +85,7 @@ extension ABI {
       // Note also that building an old version of Swift Testing with a newer
       // compiler may produce incorrect results here. We don't generally support
       // that configuration though.
-      if versionNumber > swiftCompilerVersion {
+      if versionNumber > swiftCompilerVersion() {
         return nil
       }
     }
diff --git a/Sources/Testing/Issues/KnownIssue.swift b/Sources/Testing/Issues/KnownIssue.swift
@@ -77,6 +77,13 @@ struct KnownIssueScope: Sendable {
 ///   - sourceLocation: The source location to which the issue should be
 ///     attributed.
 private func _matchError(_ error: any Error, in scope: KnownIssueScope, comment: Comment?, sourceLocation: SourceLocation) throws {
+  // ExpectationFailedError is thrown by expectation checking functions to
+  // indicate a condition evaluated to `false`. Those functions record their
+  // own issue, so we don't need to create a new issue and attempt to match it.
+  if error is ExpectationFailedError {
+    return
+  }
+
   let sourceContext = SourceContext(backtrace: Backtrace(forFirstThrowOf: error), sourceLocation: sourceLocation)
   var issue = Issue(kind: .errorCaught(error), comments: [], sourceContext: sourceContext)
   if let context = scope.matcher(issue) {
diff --git a/Sources/Testing/Running/Runner.swift b/Sources/Testing/Running/Runner.swift
@@ -77,7 +77,7 @@ extension Runner {
   /// type at runtime, it may be better-suited for ``Configuration`` instead.
   private struct _Context: Sendable {
     /// A serializer used to reduce parallelism among test cases.
-    var testCaseSerializer: Serializer?
+    var testCaseSerializer: Serializer<Void>?
   }
 
   /// Apply the custom scope for any test scope providers of the traits
diff --git a/Sources/Testing/Support/Serializer.swift b/Sources/Testing/Support/Serializer.swift
@@ -42,8 +42,13 @@ var defaultParallelizationWidth: Int {
 /// items do not start running; they must wait until the suspended work item
 /// either returns or throws an error.
 ///
+/// The generic type parameter `T` is unused. It avoids warnings when multiple
+/// copies of the testing library are loaded into a runner process on platforms
+/// which use the Objective-C runtime, due to non-generic actor types being
+/// implemented as classes there.
+///
 /// This type is not part of the public interface of the testing library.
-final actor Serializer {
+final actor Serializer<T> {
   /// The maximum number of work items that may run concurrently.
   nonisolated let maximumWidth: Int
 
diff --git a/Sources/Testing/Testing.docc/Attachments.md b/Sources/Testing/Testing.docc/Attachments.md
@@ -76,6 +76,29 @@ extension SalesReport: Encodable, Attachable {}
   your test target imports the [Foundation](https://developer.apple.com/documentation/foundation)
   module.
 
+### Attach files and directories
+
+If you have a file you want to save as an attachment, you can attach it using
+its file URL. The testing library needs to read or map the file before attaching it
+to your test, and those operations can fail, so you need to explicitly create an
+instance of ``Attachment`` before you record it.
+
+```swift
+import Foundation
+
+@Test func `sales report adds up`() async throws {
+  let salesReport = await generateSalesReport()
+  try salesReport.validate()
+  let salesReportURL = try salesReport.save()
+  let attachment = try await Attachment(contentsOf: salesReportURL)
+  Attachment.record(attachment)
+}
+```
+
+You can also attach a directory to a test using its file URL. When you attach a
+directory to a test, the testing library creates a ZIP file containing the
+directory's contents, then attaches that ZIP file in place of the directory.
+
 ### Attach images
 
 You can attach instances of the following system-provided image types to a test:
diff --git a/Tests/TestingTests/KnownIssueTests.swift b/Tests/TestingTests/KnownIssueTests.swift
@@ -574,6 +574,26 @@ final class KnownIssueTests: XCTestCase {
     await fulfillment(of: [issueRecorded, knownIssueNotRecorded], timeout: 0.0)
   }
 
+  func testKnownIssueWithRequiredExpectationFailure() async {
+    let issueRecorded = expectation(description: "Issue recorded")
+
+    var configuration = Configuration()
+    configuration.eventHandler = { event, _ in
+      guard case .issueRecorded = event.kind else {
+        return
+      }
+      issueRecorded.fulfill()
+    }
+
+    await Test {
+      withKnownIssue {
+        try #require(Bool(false))
+      }
+    }.run(configuration: configuration)
+
+    await fulfillment(of: [issueRecorded], timeout: 0.0)
+  }
+
   func testAsyncKnownIssueThatDoesNotAlwaysOccur() async {
     struct MyError: Error {}
 
diff --git a/Tests/TestingTests/SwiftPMTests.swift b/Tests/TestingTests/SwiftPMTests.swift
@@ -302,10 +302,11 @@ struct SwiftPMTests {
 
   @Test("New-but-not-experimental ABI version")
   func newButNotExperimentalABIVersion() async throws {
-    var versionNumber = ABI.CurrentVersion.versionNumber
-    versionNumber.patchComponent += 1
-    let version = try #require(ABI.version(forVersionNumber: versionNumber))
-    #expect(version.versionNumber == ABI.v0.versionNumber)
+    let currentVersionNumber = ABI.CurrentVersion.versionNumber
+    var newerVersionNumber = currentVersionNumber
+    newerVersionNumber.patchComponent += 1
+    let version = try #require(ABI.version(forVersionNumber: newerVersionNumber, givenSwiftCompilerVersion: newerVersionNumber))
+    #expect(version.versionNumber == currentVersionNumber)
   }
 
   @Test("Unsupported ABI version")

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ extension Runner {`
`77`	`77`	/// type at runtime, it may be better-suited for ``Configuration`` instead.
`78`	`78`	`private struct _Context: Sendable {`
`79`	`79`	`/// A serializer used to reduce parallelism among test cases.`
`80`		`- var testCaseSerializer: Serializer?`
	`80`	`+ var testCaseSerializer: Serializer<Void>?`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`/// Apply the custom scope for any test scope providers of the traits`