Skip to content

Check availability before calling _mangledTypeName(_:). #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 11, 2023
Merged

Check availability before calling _mangledTypeName(_:). #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9a9ec4
Check availability before calling `_mangledTypeName(_:)`.
grynspan Oct 11, 2023
013f471
Disable unit tests that won't work without the SPI
grynspan Oct 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ extension Array where Element == PackageDescription.SwiftSetting {
"-Xfrontend", "-define-availability", "-Xfrontend", "_distantFuture:macOS 99.0, iOS 99.0, watchOS 99.0, tvOS 99.0",
"-Xfrontend", "-define-availability", "-Xfrontend", "_regexAPI:macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0",
"-Xfrontend", "-define-availability", "-Xfrontend", "_swiftVersionAPI:macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0",
"-Xfrontend", "-define-availability", "-Xfrontend", "_mangledTypeNameAPI:macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0",
]),
.enableUpcomingFeature("ExistentialAny"),
.define("SWT_TARGET_OS_APPLE", .when(platforms: [.macOS, .iOS, .macCatalyst, .watchOS, .tvOS, .visionOS])),
Expand Down
4 changes: 2 additions & 2 deletions Sources/Testing/SourceAttribution/CustomTestStringConvertible.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ extension String {
self.init(describing: value)
} else if let value = value as? any CustomDebugStringConvertible {
self.init(reflecting: value)
} else if let value = value as? any RawRepresentable, isImportedFromC(valueType) {
} else if #available(_mangledTypeNameAPI, *), let value = value as? any RawRepresentable, isImportedFromC(valueType) {
// Present raw-representable C types, which we assume to be imported
// enumerations, in a consistent fashion. The case names of C enumerations
// are not statically visible, so instead present the enumeration type's
// name along with the raw value of `value`.
self = "\(valueType)(rawValue: \(String(describingForTest: value.rawValue)))"
} else if isSwiftEnumeration(valueType) {
} else if #available(_mangledTypeNameAPI, *), isSwiftEnumeration(valueType) {
// Add a leading period to enumeration cases to more closely match their
// source representation. SEE: _adHocPrint_unlocked() in the stdlib.
self = ".\(value)"
Expand Down
2 changes: 2 additions & 0 deletions Sources/Testing/Support/Additions/TypeAdditions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ func nameComponents(of type: Any.Type) -> [String] {
///
/// Per the [Swift mangling ABI](https://github.com/apple/swift/blob/main/docs/ABI/Mangling.rst),
/// enumeration types are mangled as `"O"`.
@available(_mangledTypeNameAPI, *)
func isSwiftEnumeration(_ type: Any.Type) -> Bool {
guard let mangledTypeName = _mangledTypeName(type), let lastCharacter = mangledTypeName.last else {
return false
Expand All @@ -49,6 +50,7 @@ func isSwiftEnumeration(_ type: Any.Type) -> Bool {
/// module. That module has a standardized mangling of `"So"`. The presence of
/// those characters at the start of a type's mangled name indicates that it is
/// an imported type.
@available(_mangledTypeNameAPI, *)
func isImportedFromC(_ type: Any.Type) -> Bool {
guard let mangledTypeName = _mangledTypeName(type), mangledTypeName.count > 2 else {
return false
Expand Down
12 changes: 10 additions & 2 deletions Tests/TestingTests/IssueTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1139,7 +1139,11 @@ final class IssueTests: XCTestCase {
await fulfillment(of: [expectationFailed], timeout: 0.0)
}

func testEnumDescription() async {
func testEnumDescription() async throws {
guard #available(_mangledTypeNameAPI, *) else {
throw XCTSkip("Unavailable")
}

enum E: CaseIterable {
case a
case b
Expand Down Expand Up @@ -1198,7 +1202,11 @@ final class IssueTests: XCTestCase {
await fulfillment(of: [expectationFailed], timeout: 0.0)
}

func testCEnumDescription() async {
func testCEnumDescription() async throws {
guard #available(_mangledTypeNameAPI, *) else {
throw XCTSkip("Unavailable")
}

let expectationFailed = expectation(description: "Expectation failed")

var configuration = Configuration()
Expand Down