Skip to content

Commit bf0b102

Browse files
grynspangrynspan
committed
[WIP] CoreTransferable attachments
1 parent 1f2893c commit bf0b102

9 files changed

Lines changed: 264 additions & 1 deletion

File tree

‎Package.swift‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@ let package = Package(
162162
"_Testing_AppKit",
163163
"_Testing_CoreGraphics",
164164
"_Testing_CoreImage",
165+
"_Testing_CoreTransferable",
165166
"_Testing_Foundation",
166167
"_Testing_UIKit",
167168
"_Testing_WinSDK",
@@ -264,6 +265,15 @@ let package = Package(
264265
exclude: ["CMakeLists.txt"],
265266
swiftSettings: .packageSettings + .enableLibraryEvolution() + .moduleABIName("_Testing_CoreImage")
266267
),
268+
.target(
269+
name: "_Testing_CoreTransferable",
270+
dependencies: [
271+
"Testing",
272+
],
273+
path: "Sources/Overlays/_Testing_CoreTransferable",
274+
exclude: ["CMakeLists.txt"],
275+
swiftSettings: .packageSettings + .enableLibraryEvolution() + .moduleABIName("_Testing_CoreTransferable")
276+
),
267277
.target(
268278
name: "_Testing_Foundation",
269279
dependencies: [
@@ -428,6 +438,7 @@ extension Array where Element == PackageDescription.SwiftSetting {
428438
.enableExperimentalFeature("AvailabilityMacro=_regexAPI:macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0"),
429439
.enableExperimentalFeature("AvailabilityMacro=_swiftVersionAPI:macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0"),
430440
.enableExperimentalFeature("AvailabilityMacro=_typedThrowsAPI:macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0"),
441+
.enableExperimentalFeature("AvailabilityMacro=_transferableAPI:macOS 15.2, iOS 18.2, watchOS 11.2, tvOS 18.2, visionOS 2.2"),
431442
.enableExperimentalFeature("AvailabilityMacro=_castingWithNonCopyableGenerics:macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0"),
432443

433444
.enableExperimentalFeature("AvailabilityMacro=_distantFuture:macOS 99.0, iOS 99.0, watchOS 99.0, tvOS 99.0, visionOS 99.0"),

‎Sources/Overlays/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
add_subdirectory(_Testing_AppKit)
1010
add_subdirectory(_Testing_CoreGraphics)
1111
add_subdirectory(_Testing_CoreImage)
12+
add_subdirectory(_Testing_CoreTransferable)
1213
add_subdirectory(_Testing_Foundation)
1314
add_subdirectory(_Testing_UIKit)
1415
add_subdirectory(_Testing_WinSDK)

‎Sources/Overlays/_Testing_CoreTransferable/Attachments/Attachment+Transferable.swift‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
//
2+
// This source file is part of the Swift.org open source project
3+
//
4+
// Copyright (c) 2026 Apple Inc. and the Swift project authors
5+
// Licensed under Apache License v2.0 with Runtime Library Exception
6+
//
7+
// See https://swift.org/LICENSE.txt for license information
8+
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
9+
//
10+
11+
#if canImport(CoreTransferable)
12+
public import Testing
13+
public import CoreTransferable
14+
15+
public import UniformTypeIdentifiers
16+
17+
@_spi(Experimental)
18+
@available(_transferableAPI, *)
19+
extension Attachment {
20+
/// Initialize an instance of this type that encloses the given transferable
21+
/// value.
22+
///
23+
/// - Parameters:
24+
/// - transferableValue: The value that will be attached to the output of
25+
/// the test run.
26+
/// - contentType: The content type with which to export `transferableValue`.
27+
/// If this argument is `nil`, the testing library calls [`exportedContentTypes(_:)`](https://developer.apple.com/documentation/coretransferable/transferable/exportedcontenttypes(_:))
28+
/// on `transferableValue` and uses the first type the function returns
29+
/// that conforms to [`UTType.data`](https://developer.apple.com/documentation/uniformtypeidentifiers/uttype-swift.struct/data).
30+
/// - preferredName: The preferred name of the attachment to use when saving
31+
/// it. If `nil`, the testing library attempts to generate a reasonable
32+
/// filename for the attached value.
33+
/// - sourceLocation: The source location of the call to this initializer.
34+
/// This value is used when recording issues associated with the
35+
/// attachment.
36+
///
37+
/// - Throws: Any error that occurs while exporting `transferableValue`.
38+
///
39+
/// Use this initializer to create an instance of ``Attachment`` from a value
40+
/// that conforms to the [`Transferable`](https://developer.apple.com/documentation/coretransferable/transferable)
41+
/// protocol.
42+
///
43+
/// ```swift
44+
/// let menu = FoodTruck.menu
45+
/// let attachment = try await Attachment(exporting: menu, as: .pdf)
46+
/// Attachment.record(attachment)
47+
/// ```
48+
///
49+
/// When you call this initializer and pass it a transferable value, it
50+
/// calls [`exported(as:)`](https://developer.apple.com/documentation/coretransferable/transferable/exported(as:))
51+
/// on that value. This operation may take some time, so this initializer
52+
/// suspends the calling task until it is complete.
53+
public init<T>(
54+
exporting transferableValue: T,
55+
as contentType: UTType? = nil,
56+
named preferredName: String? = nil,
57+
sourceLocation: SourceLocation = #_sourceLocation
58+
) async throws where T: Transferable, AttachableValue == _AttachableTransferableWrapper<T> {
59+
let transferableWrapper = try await _AttachableTransferableWrapper(exporting: transferableValue, as: contentType)
60+
self.init(transferableWrapper, named: preferredName, sourceLocation: sourceLocation)
61+
}
62+
}
63+
64+
// MARK: -
65+
66+
/// A type describing errors that can occur when attaching a transferable value.
67+
enum TransferableAttachmentError: Error {
68+
/// The developer did not pass a content type and the value did not list any
69+
/// that conform to `UTType.data`.
70+
case suitableContentTypeNotFound
71+
}
72+
73+
extension TransferableAttachmentError: CustomStringConvertible {
74+
var description: String {
75+
switch self {
76+
case .suitableContentTypeNotFound:
77+
"The value does not list any exported content types that conform to 'UTType.data'."
78+
}
79+
}
80+
}
81+
#endif

‎Sources/Overlays/_Testing_CoreTransferable/Attachments/_AttachableTransferableWrapper.swift‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
//
2+
// This source file is part of the Swift.org open source project
3+
//
4+
// Copyright (c) 2026 Apple Inc. and the Swift project authors
5+
// Licensed under Apache License v2.0 with Runtime Library Exception
6+
//
7+
// See https://swift.org/LICENSE.txt for license information
8+
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
9+
//
10+
11+
#if canImport(CoreTransferable)
12+
public import Testing
13+
public import CoreTransferable
14+
15+
private import Foundation
16+
import UniformTypeIdentifiers
17+
18+
/// A wrapper type representing transferable values that can be attached
19+
/// indirectly.
20+
///
21+
/// You do not need to use this type directly. Instead, initialize an instance
22+
/// of ``Attachment`` using an instance of a type conforming to the [`Transferable`](https://developer.apple.com/documentation/coretransferable/transferable)
23+
/// protocol.
24+
@_spi(Experimental)
25+
@available(_transferableAPI, *)
26+
public struct _AttachableTransferableWrapper<T>: Sendable where T: Transferable {
27+
/// The transferable value.
28+
private var _transferableValue: T
29+
30+
/// The content type used to export the transferable value.
31+
private var _contentType: UTType
32+
33+
/// The exported form of the transferable value.
34+
private var _bytes: Data
35+
36+
init(exporting transferableValue: T, as contentType: UTType?) async throws {
37+
let contentType = contentType ?? transferableValue.exportedContentTypes()
38+
.first { $0.conforms(to: .data) }
39+
guard let contentType else {
40+
throw TransferableAttachmentError.suitableContentTypeNotFound
41+
}
42+
43+
_transferableValue = transferableValue
44+
_contentType = contentType
45+
_bytes = try await transferableValue.exported(as: contentType)
46+
}
47+
}
48+
49+
// MARK: -
50+
51+
@_spi(Experimental)
52+
@available(_transferableAPI, *)
53+
extension _AttachableTransferableWrapper: AttachableWrapper {
54+
public var wrappedValue: T {
55+
_transferableValue
56+
}
57+
58+
public func withUnsafeBytes<R>(for attachment: borrowing Attachment<Self>, _ body: (UnsafeRawBufferPointer) throws -> R) throws -> R {
59+
try _bytes.withUnsafeBytes(body)
60+
}
61+
62+
public borrowing func preferredName(for attachment: borrowing Attachment<Self>, basedOn suggestedName: String) -> String {
63+
let baseName = _transferableValue.suggestedFilename ?? suggestedName
64+
return (baseName as NSString).appendingPathExtension(for: _contentType)
65+
}
66+
}
67+
#endif

‎Sources/Overlays/_Testing_CoreTransferable/CMakeLists.txt‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2026 Apple Inc. and the Swift project authors
4+
# Licensed under Apache License v2.0 with Runtime Library Exception
5+
#
6+
# See https://swift.org/LICENSE.txt for license information
7+
# See https://swift.org/CONTRIBUTORS.txt for Swift project authors
8+
9+
if (CMAKE_SYSTEM_NAME STREQUAL "Darwin")
10+
include(ModuleABIName)
11+
add_library(_Testing_CoreTransferable
12+
Attachments/_AttachableTransferableWrapper.swift
13+
Attachments/Attachment+Transferable.swift
14+
ReexportTesting.swift)
15+
16+
target_link_libraries(_Testing_CoreTransferable PUBLIC
17+
Testing
18+
_Testing_CoreGraphics)
19+
20+
target_compile_options(_Testing_CoreTransferable PRIVATE
21+
-enable-library-evolution
22+
-emit-module-interface -emit-module-interface-path $<TARGET_PROPERTY:_Testing_CoreTransferable,Swift_MODULE_DIRECTORY>/_Testing_CoreTransferable.swiftinterface)
23+
24+
_swift_testing_install_target(_Testing_CoreTransferable)
25+
endif()

‎Sources/Overlays/_Testing_CoreTransferable/ReexportTesting.swift‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
//
2+
// This source file is part of the Swift.org open source project
3+
//
4+
// Copyright (c) 2026 Apple Inc. and the Swift project authors
5+
// Licensed under Apache License v2.0 with Runtime Library Exception
6+
//
7+
// See https://swift.org/LICENSE.txt for license information
8+
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
9+
//
10+
11+
@_exported @_spi(Experimental) @_spi(ForToolsIntegrationOnly) public import Testing

‎Sources/Testing/Testing.swiftcrossimport/CoreTransferable.swiftoverlay‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version: 1
2+
modules:
3+
- name: _Testing_CoreTransferable

‎Tests/TestingTests/AttachmentTests.swift‎

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ import CoreGraphics
2626
import CoreImage
2727
import _Testing_CoreImage
2828
#endif
29+
#if canImport(CoreTransferable) && canImport(_Testing_CoreTransferable)
30+
import CoreTransferable
31+
@_spi(Experimental) import _Testing_CoreTransferable
32+
#endif
2933
#if canImport(UIKit) && canImport(_Testing_UIKit)
3034
import UIKit
3135
import _Testing_UIKit
@@ -233,7 +237,7 @@ struct AttachmentTests {
233237

234238
#expect((attachment.attachableValue as Any) is AnyAttachable.Wrapped)
235239
#expect(attachment.sourceLocation.fileID == #fileID)
236-
valueAttached()
240+
valueAttached()
237241
}
238242

239243
await Test {
@@ -452,6 +456,45 @@ struct AttachmentTests {
452456
}
453457
}
454458
#endif
459+
460+
#if canImport(CoreTransferable) && canImport(_Testing_CoreTransferable)
461+
@available(_transferableAPI, *)
462+
@Test("Attach Transferable-conformant value")
463+
func transferable() async throws {
464+
let value = MyTransferable()
465+
let attachment = try await Attachment(exporting: value, as: .plainText)
466+
#expect(value == attachment.attachableValue)
467+
try attachment.withUnsafeBytes { bytes in
468+
#expect(Array(bytes) == Array(MyTransferable.stringValue.utf8))
469+
}
470+
}
471+
472+
@available(_transferableAPI, *)
473+
@Test("Attach Transferable-conformant value with a nonsensical type")
474+
func transferableWithNonsensicalType() async throws {
475+
let value = MyTransferable()
476+
await #expect(throws: (any Error).self) {
477+
_ = try await Attachment(exporting: value, as: .gif)
478+
}
479+
}
480+
481+
@available(_transferableAPI, *)
482+
@Test("Preferred name of Transferable-conformant value")
483+
func transferablePreferredName() async throws {
484+
let value = MyTransferable()
485+
let attachment = try await Attachment(exporting: value)
486+
#expect(attachment.preferredName == "untitled.txt")
487+
}
488+
489+
@available(_transferableAPI, *)
490+
@Test("Attach Transferable-conformant value with no available type")
491+
func transferableWithNoAvailableType() async throws {
492+
let value = MyBadTransferable()
493+
await #expect(throws: (any Error).self) {
494+
_ = try await Attachment(exporting: value)
495+
}
496+
}
497+
#endif
455498
}
456499

457500
extension AttachmentTests {
@@ -976,6 +1019,26 @@ struct MySendableAttachableWithDefaultByteCount: Attachable, Sendable {
9761019
}
9771020
}
9781021

1022+
#if canImport(CoreTransferable) && canImport(_Testing_CoreTransferable)
1023+
struct MyTransferable: Transferable, Equatable {
1024+
static let stringValue = "This isn't even my exported form!"
1025+
1026+
static var transferRepresentation: some TransferRepresentation {
1027+
DataRepresentation(exportedContentType: .plainText) { instance in
1028+
Data(Self.stringValue.utf8)
1029+
}
1030+
}
1031+
}
1032+
1033+
struct MyBadTransferable: Transferable, Equatable {
1034+
static var transferRepresentation: some TransferRepresentation {
1035+
DataRepresentation(exportedContentType: .directory) { _ in
1036+
throw MyError()
1037+
}
1038+
}
1039+
}
1040+
#endif
1041+
9791042
#if canImport(Foundation) && canImport(_Testing_Foundation)
9801043
struct MyCodableAttachable: Codable, Attachable, Sendable {
9811044
var string: String

‎cmake/modules/shared/AvailabilityDefinitions.cmake‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,6 @@ add_compile_options(
1717
"SHELL:$<$<COMPILE_LANGUAGE:Swift>:-Xfrontend -define-availability -Xfrontend \"_regexAPI:macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0\">"
1818
"SHELL:$<$<COMPILE_LANGUAGE:Swift>:-Xfrontend -define-availability -Xfrontend \"_swiftVersionAPI:macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0\">"
1919
"SHELL:$<$<COMPILE_LANGUAGE:Swift>:-Xfrontend -define-availability -Xfrontend \"_typedThrowsAPI:macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0\">"
20+
"SHELL:$<$<COMPILE_LANGUAGE:Swift>:-Xfrontend -define-availability -Xfrontend \"_transferableAPI:macOS 15.2, iOS 18.2, watchOS 11.2, tvOS 18.2, visionOS 2.2\">"
2021
"SHELL:$<$<COMPILE_LANGUAGE:Swift>:-Xfrontend -define-availability -Xfrontend \"_castingWithNonCopyableGenerics:macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0\">"
2122
"SHELL:$<$<COMPILE_LANGUAGE:Swift>:-Xfrontend -define-availability -Xfrontend \"_distantFuture:macOS 99.0, iOS 99.0, watchOS 99.0, tvOS 99.0, visionOS 99.0\">")

0 commit comments

Comments
 (0)