Merge pull request #1170 from stmontgomery/main-6.2-merge

Merge 'main' branch to 'release/6.2'

Author: stmontgomery

Documentation/Porting.md

@@ -67,6 +67,9 @@ platform-specific attention.
 > conflicting requirements (for example, attempting to enable support for pipes
 > without also enabling support for file I/O.) You should be able to resolve
 > these issues by updating `Package.swift` and/or `CompilerSettings.cmake`.
+>
+> Don't forget to add your platform to the `BuildSettingCondition/whenApple(_:)`
+> function in `Package.swift`.
 
 Most platform dependencies can be resolved through the use of platform-specific
 API. For example, Swift Testing uses the C11 standard [`timespec`](https://en.cppreference.com/w/c/chrono/timespec)

Package.swift

@@ -27,7 +27,7 @@ let buildingForDevelopment = (git?.currentTag == nil)
 /// to change in the future.
 ///
 /// - Bug: There is currently no way for us to tell if we are being asked to
-/// 	build for an Embedded Swift target at the package manifest level.
+///   build for an Embedded Swift target at the package manifest level.
 ///   ([swift-syntax-#8431](https://github.com/swiftlang/swift-package-manager/issues/8431))
 let buildingForEmbedded: Bool = {
   guard let envvar = Context.environment["SWT_EMBEDDED"] else {
@@ -208,7 +208,7 @@ let package = Package(
       // The Foundation module only has Library Evolution enabled on Apple
       // platforms, and since this target's module publicly imports Foundation,
       // it can only enable Library Evolution itself on those platforms.
-      swiftSettings: .packageSettings + .enableLibraryEvolution(applePlatformsOnly: true)
+      swiftSettings: .packageSettings + .enableLibraryEvolution(.whenApple())
     ),
 
     // Utility targets: These are utilities intended for use when developing
@@ -244,11 +244,11 @@ extension BuildSettingCondition {
   /// Swift.
   ///
   /// - Parameters:
-  /// 	- nonEmbeddedCondition: The value to return if the target is not
-  ///   	Embedded Swift. If `nil`, the build condition evaluates to `false`.
+  ///   - nonEmbeddedCondition: The value to return if the target is not
+  ///     Embedded Swift. If `nil`, the build condition evaluates to `false`.
   ///
   /// - Returns: A build setting condition that evaluates to `true` for Embedded
-  /// 	Swift or is equal to `nonEmbeddedCondition` for non-Embedded Swift.
+  ///   Swift or is equal to `nonEmbeddedCondition` for non-Embedded Swift.
   static func whenEmbedded(or nonEmbeddedCondition: @autoclosure () -> Self? = nil) -> Self? {
     if !buildingForEmbedded {
       if let nonEmbeddedCondition = nonEmbeddedCondition() {
@@ -263,6 +263,21 @@ extension BuildSettingCondition {
       nil
     }
   }
+
+  /// A build setting condition representing all Apple or non-Apple platforms.
+  ///
+  /// - Parameters:
+  ///   - isApple: Whether or not the result represents Apple platforms.
+  ///
+  /// - Returns: A build setting condition that evaluates to `isApple` for Apple
+  ///   platforms.
+  static func whenApple(_ isApple: Bool = true) -> Self {
+    if isApple {
+      .when(platforms: [.macOS, .iOS, .macCatalyst, .watchOS, .tvOS, .visionOS])
+    } else {
+      .when(platforms: [.linux, .custom("freebsd"), .openbsd, .windows, .wasi, .android])
+    }
+  }
 }
 
 extension Array where Element == PackageDescription.SwiftSetting {
@@ -312,13 +327,14 @@ extension Array where Element == PackageDescription.SwiftSetting {
       // executable rather than a library.
       .define("SWT_NO_LIBRARY_MACRO_PLUGINS"),
 
-      .define("SWT_TARGET_OS_APPLE", .when(platforms: [.macOS, .iOS, .macCatalyst, .watchOS, .tvOS, .visionOS])),
+      .define("SWT_TARGET_OS_APPLE", .whenApple()),
 
       .define("SWT_NO_EXIT_TESTS", .whenEmbedded(or: .when(platforms: [.iOS, .watchOS, .tvOS, .visionOS, .wasi, .android]))),
       .define("SWT_NO_PROCESS_SPAWNING", .whenEmbedded(or: .when(platforms: [.iOS, .watchOS, .tvOS, .visionOS, .wasi, .android]))),
-      .define("SWT_NO_SNAPSHOT_TYPES", .whenEmbedded(or: .when(platforms: [.linux, .custom("freebsd"), .openbsd, .windows, .wasi, .android]))),
+      .define("SWT_NO_SNAPSHOT_TYPES", .whenEmbedded(or: .whenApple(false))),
       .define("SWT_NO_DYNAMIC_LINKING", .whenEmbedded(or: .when(platforms: [.wasi]))),
       .define("SWT_NO_PIPES", .whenEmbedded(or: .when(platforms: [.wasi]))),
+      .define("SWT_NO_FOUNDATION_FILE_COORDINATION", .whenEmbedded(or: .whenApple(false))),
 
       .define("SWT_NO_LEGACY_TEST_DISCOVERY", .whenEmbedded()),
       .define("SWT_NO_LIBDISPATCH", .whenEmbedded()),
@@ -354,20 +370,16 @@ extension Array where Element == PackageDescription.SwiftSetting {
     ]
   }
 
-  /// Create a Swift setting which enables Library Evolution, optionally
-  /// constraining it to only Apple platforms.
+  /// Create a Swift setting which enables Library Evolution.
   ///
   /// - Parameters:
-  ///   - applePlatformsOnly: Whether to constrain this setting to only Apple
-  ///     platforms.
-  static func enableLibraryEvolution(applePlatformsOnly: Bool = false) -> Self {
+  ///   - condition: A build setting condition to apply to this setting.
+  ///
+  /// - Returns: A Swift setting that enables Library Evolution.
+  static func enableLibraryEvolution(_ condition: BuildSettingCondition? = nil) -> Self {
     var result = [PackageDescription.SwiftSetting]()
 
     if buildingForDevelopment {
-      var condition: BuildSettingCondition?
-      if applePlatformsOnly {
-        condition = .when(platforms: [.macOS, .iOS, .macCatalyst, .watchOS, .tvOS, .visionOS])
-      }
       result.append(.unsafeFlags(["-enable-library-evolution"], condition))
     }
 
@@ -410,9 +422,10 @@ extension Array where Element == PackageDescription.CXXSetting {
     result += [
       .define("SWT_NO_EXIT_TESTS", .whenEmbedded(or: .when(platforms: [.iOS, .watchOS, .tvOS, .visionOS, .wasi, .android]))),
       .define("SWT_NO_PROCESS_SPAWNING", .whenEmbedded(or: .when(platforms: [.iOS, .watchOS, .tvOS, .visionOS, .wasi, .android]))),
-      .define("SWT_NO_SNAPSHOT_TYPES", .whenEmbedded(or: .when(platforms: [.linux, .custom("freebsd"), .openbsd, .windows, .wasi, .android]))),
+      .define("SWT_NO_SNAPSHOT_TYPES", .whenEmbedded(or: .whenApple(false))),
       .define("SWT_NO_DYNAMIC_LINKING", .whenEmbedded(or: .when(platforms: [.wasi]))),
       .define("SWT_NO_PIPES", .whenEmbedded(or: .when(platforms: [.wasi]))),
+      .define("SWT_NO_FOUNDATION_FILE_COORDINATION", .whenEmbedded(or: .whenApple(false))),
 
       .define("SWT_NO_LEGACY_TEST_DISCOVERY", .whenEmbedded()),
       .define("SWT_NO_LIBDISPATCH", .whenEmbedded()),

Sources/Overlays/_Testing_Foundation/Attachments/Attachable+Encodable+NSSecureCoding.swift

@@ -20,6 +20,7 @@ public import Foundation
 
 /// @Metadata {
 ///   @Available(Swift, introduced: 6.2)
+///   @Available(Xcode, introduced: 26.0)
 /// }
 extension Attachable where Self: Encodable & NSSecureCoding {
   @_documentation(visibility: private)

Sources/Overlays/_Testing_Foundation/Attachments/Attachable+Encodable.swift

@@ -56,6 +56,7 @@ func withUnsafeBytes<E, R>(encoding attachableValue: borrowing E, for attachment
 
 /// @Metadata {
 ///   @Available(Swift, introduced: 6.2)
+///   @Available(Xcode, introduced: 26.0)
 /// }
 extension Attachable where Self: Encodable {
   /// Encode this value into a buffer using either [`PropertyListEncoder`](https://developer.apple.com/documentation/foundation/propertylistencoder)
@@ -92,6 +93,7 @@ extension Attachable where Self: Encodable {
   ///
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   public func withUnsafeBytes<R>(for attachment: borrowing Attachment<Self>, _ body: (UnsafeRawBufferPointer) throws -> R) throws -> R {
     try _Testing_Foundation.withUnsafeBytes(encoding: self, for: attachment, body)

Sources/Overlays/_Testing_Foundation/Attachments/Attachable+NSSecureCoding.swift

@@ -18,6 +18,7 @@ public import Foundation
 
 /// @Metadata {
 ///   @Available(Swift, introduced: 6.2)
+///   @Available(Xcode, introduced: 26.0)
 /// }
 extension Attachable where Self: NSSecureCoding {
   /// Encode this object using [`NSKeyedArchiver`](https://developer.apple.com/documentation/foundation/nskeyedarchiver)
@@ -52,6 +53,7 @@ extension Attachable where Self: NSSecureCoding {
   ///
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   public func withUnsafeBytes<R>(for attachment: borrowing Attachment<Self>, _ body: (UnsafeRawBufferPointer) throws -> R) throws -> R {
     let format = try EncodingFormat(for: attachment)

Sources/Overlays/_Testing_Foundation/Attachments/Attachment+URL.swift

@@ -53,6 +53,7 @@ extension Attachment where AttachableValue == _AttachableURLWrapper {
   ///
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   public init(
     contentsOf url: URL,
@@ -70,7 +71,7 @@ extension Attachment where AttachableValue == _AttachableURLWrapper {
     let url = url.resolvingSymlinksInPath()
     let isDirectory = try url.resourceValues(forKeys: [.isDirectoryKey]).isDirectory!
 
-#if SWT_TARGET_OS_APPLE
+#if SWT_TARGET_OS_APPLE && !SWT_NO_FOUNDATION_FILE_COORDINATION
     let data: Data = try await withCheckedThrowingContinuation { continuation in
       let fileCoordinator = NSFileCoordinator()
       let fileAccessIntent = NSFileAccessIntent.readingIntent(with: url, options: [.forUploading])
@@ -165,25 +166,31 @@ private func _compressContentsOfDirectory(at directoryURL: URL) async throws ->
   // knows how to write PKZIP archives, while Windows inherited FreeBSD's tar
   // tool in Windows 10 Build 17063 (per https://techcommunity.microsoft.com/blog/containers/tar-and-curl-come-to-windows/382409).
   //
-  // On Linux (which does not have FreeBSD's version of tar(1)), we can use
-  // zip(1) instead.
+  // On Linux and OpenBSD (which do not have FreeBSD's version of tar(1)), we
+  // can use zip(1) instead. This tool compresses paths relative to the current
+  // working directory, and posix_spawn_file_actions_addchdir_np() is not always
+  // available for us to call (not present on OpenBSD, requires glibc ≥ 2.28 on
+  // Linux), so we'll spawn a shell that calls cd before calling zip(1).
   //
   // OpenBSD's tar(1) does not support writing PKZIP archives, and /usr/bin/zip
   // tool is an optional install, so we check if it's present before trying to
   // execute it.
+#if os(Linux) || os(OpenBSD)
+  let archiverPath = "/bin/sh"
 #if os(Linux)
-  let archiverPath = "/usr/bin/zip"
-#elseif SWT_TARGET_OS_APPLE || os(FreeBSD)
-  let archiverPath = "/usr/bin/tar"
-#elseif os(OpenBSD)
-  let archiverPath = "/usr/local/bin/zip"
+  let trueArchiverPath = "/usr/bin/zip"
+#else
+  let trueArchiverPath = "/usr/local/bin/zip"
   var isDirectory = false
-  if !FileManager.default.fileExists(atPath: archiverPath, isDirectory: &isDirectory) || isDirectory {
+  if !FileManager.default.fileExists(atPath: trueArchiverPath, isDirectory: &isDirectory) || isDirectory {
     throw CocoaError(.fileNoSuchFile, userInfo: [
       NSLocalizedDescriptionKey: "The 'zip' package is not installed.",
-      NSFilePathErrorKey: archiverPath
+      NSFilePathErrorKey: trueArchiverPath
     ])
   }
+#endif
+#elseif SWT_TARGET_OS_APPLE || os(FreeBSD)
+  let archiverPath = "/usr/bin/tar"
 #elseif os(Windows)
   guard let archiverPath = _archiverPath else {
     throw CocoaError(.fileWriteUnknown, userInfo: [
@@ -196,20 +203,15 @@ private func _compressContentsOfDirectory(at directoryURL: URL) async throws ->
   throw CocoaError(.featureUnsupported, userInfo: [NSLocalizedDescriptionKey: "This platform does not support attaching directories to tests."])
 #endif
 
-  try await withCheckedThrowingContinuation { continuation in
-    let process = Process()
-
-    process.executableURL = URL(fileURLWithPath: archiverPath, isDirectory: false)
-
-    let sourcePath = directoryURL.fileSystemPath
-    let destinationPath = temporaryURL.fileSystemPath
+  let sourcePath = directoryURL.fileSystemPath
+  let destinationPath = temporaryURL.fileSystemPath
+  let arguments = {
 #if os(Linux) || os(OpenBSD)
     // The zip command constructs relative paths from the current working
     // directory rather than from command-line arguments.
-    process.arguments = [destinationPath, "--recurse-paths", "."]
-    process.currentDirectoryURL = directoryURL
+    ["-c", #"cd "$0" && "$1" "$2" --recurse-paths ."#, sourcePath, trueArchiverPath, destinationPath]
 #elseif SWT_TARGET_OS_APPLE || os(FreeBSD)
-    process.arguments = ["--create", "--auto-compress", "--directory", sourcePath, "--file", destinationPath, "."]
+    ["--create", "--auto-compress", "--directory", sourcePath, "--file", destinationPath, "."]
 #elseif os(Windows)
     // The Windows version of bsdtar can handle relative paths for other archive
     // formats, but produces empty archives when inferring the zip format with
@@ -218,30 +220,15 @@ private func _compressContentsOfDirectory(at directoryURL: URL) async throws ->
     // An alternative may be to use PowerShell's Compress-Archive command,
     // however that comes with a security risk as we'd be responsible for two
     // levels of command-line argument escaping.
-    process.arguments = ["--create", "--auto-compress", "--file", destinationPath, sourcePath]
+    ["--create", "--auto-compress", "--file", destinationPath, sourcePath]
 #endif
+  }()
 
-    process.standardOutput = nil
-    process.standardError = nil
-
-    process.terminationHandler = { process in
-      let terminationReason = process.terminationReason
-      let terminationStatus = process.terminationStatus
-      if terminationReason == .exit && terminationStatus == EXIT_SUCCESS {
-        continuation.resume()
-      } else {
-        let error = CocoaError(.fileWriteUnknown, userInfo: [
-          NSLocalizedDescriptionKey: "The directory at '\(sourcePath)' could not be compressed (\(terminationStatus)).",
-        ])
-        continuation.resume(throwing: error)
-      }
-    }
-
-    do {
-      try process.run()
-    } catch {
-      continuation.resume(throwing: error)
-    }
+  let exitStatus = try await spawnExecutableAtPathAndWait(archiverPath, arguments: arguments)
+  guard case .exitCode(EXIT_SUCCESS) = exitStatus else {
+    throw CocoaError(.fileWriteUnknown, userInfo: [
+      NSLocalizedDescriptionKey: "The directory at '\(sourcePath)' could not be compressed (\(exitStatus)).",
+    ])
   }
 
   return try Data(contentsOf: temporaryURL, options: [.mappedIfSafe])

Sources/Overlays/_Testing_Foundation/Attachments/Data+Attachable.swift

@@ -14,10 +14,12 @@ public import Foundation
 
 /// @Metadata {
 ///   @Available(Swift, introduced: 6.2)
+///   @Available(Xcode, introduced: 26.0)
 /// }
 extension Data: Attachable {
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   public func withUnsafeBytes<R>(for attachment: borrowing Attachment<Self>, _ body: (UnsafeRawBufferPointer) throws -> R) throws -> R {
     try withUnsafeBytes(body)

Sources/Testing/Attachments/Attachable.swift

@@ -29,6 +29,7 @@
 ///
 /// @Metadata {
 ///   @Available(Swift, introduced: 6.2)
+///   @Available(Xcode, introduced: 26.0)
 /// }
 public protocol Attachable: ~Copyable {
   /// An estimate of the number of bytes of memory needed to store this value as
@@ -48,6 +49,7 @@ public protocol Attachable: ~Copyable {
   ///
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   var estimatedAttachmentByteCount: Int? { get }
 
@@ -74,6 +76,7 @@ public protocol Attachable: ~Copyable {
   ///
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   borrowing func withUnsafeBytes<R>(for attachment: borrowing Attachment<Self>, _ body: (UnsafeRawBufferPointer) throws -> R) throws -> R
 
@@ -94,6 +97,7 @@ public protocol Attachable: ~Copyable {
   ///
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   borrowing func preferredName(for attachment: borrowing Attachment<Self>, basedOn suggestedName: String) -> String
 }

Sources/Testing/Attachments/AttachableWrapper.swift

@@ -24,19 +24,22 @@
 ///
 /// @Metadata {
 ///   @Available(Swift, introduced: 6.2)
+///   @Available(Xcode, introduced: 26.0)
 /// }
 public protocol AttachableWrapper<Wrapped>: Attachable, ~Copyable {
   /// The type of the underlying value represented by this type.
   ///
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   associatedtype Wrapped
 
   /// The underlying value represented by this instance.
   ///
   /// @Metadata {
   ///   @Available(Swift, introduced: 6.2)
+  ///   @Available(Xcode, introduced: 26.0)
   /// }
   var wrappedValue: Wrapped { get }
 }