Skip to content

Replace #fileID, #filePath, #line, and #column with a single macro. #304

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 4 commits into from
Jun 13, 2024
Merged

Replace #fileID, #filePath, #line, and #column with a single macro. #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
95fa0b5
Replace `#fileID`, `#filePath`, `#line`, and `#column` with a single …
grynspan Mar 19, 2024
f0e7c52
Update Sources/Testing/SourceAttribution/SourceLocation+Macro.swift
grynspan Jun 13, 2024
d2c5c35
Delete accidentally-added old documentation file
grynspan Jun 13, 2024
4dcf271
Update all references to the macro
grynspan Jun 13, 2024
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
28 changes: 14 additions & 14 deletions Sources/Testing/Expectations/Expectation+Macro.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
@freestanding(expression) public macro expect(
_ condition: Bool,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation()
sourceLocation: SourceLocation = #_sourceLocation
) = #externalMacro(module: "TestingMacros", type: "ExpectMacro")

/// Check that an expectation has passed after a condition has been evaluated
Expand All @@ -44,7 +44,7 @@
@freestanding(expression) public macro require(
_ condition: Bool,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation()
sourceLocation: SourceLocation = #_sourceLocation
) = #externalMacro(module: "TestingMacros", type: "RequireMacro")

// MARK: - Optional checking
Expand All @@ -68,7 +68,7 @@
@freestanding(expression) public macro require<T>(
_ optionalValue: T?,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation()
sourceLocation: SourceLocation = #_sourceLocation
) -> T = #externalMacro(module: "TestingMacros", type: "RequireMacro")

/// Unwrap an optional boolean value or, if it is `nil`, fail and throw an
Expand Down Expand Up @@ -98,7 +98,7 @@
public macro require(
_ optionalValue: Bool?,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation()
sourceLocation: SourceLocation = #_sourceLocation
) -> Bool = #externalMacro(module: "TestingMacros", type: "AmbiguousRequireMacro")

// MARK: - Matching errors by type
Expand Down Expand Up @@ -136,7 +136,7 @@ public macro require(
@freestanding(expression) public macro expect<E, R>(
throws errorType: E.Type,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: () async throws -> R
) = #externalMacro(module: "TestingMacros", type: "ExpectMacro") where E: Error

Expand Down Expand Up @@ -175,7 +175,7 @@ public macro require(
@freestanding(expression) public macro expect<R>(
throws _: Never.Type,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: () async throws -> R
) = #externalMacro(module: "TestingMacros", type: "ExpectMacro")

Expand Down Expand Up @@ -217,7 +217,7 @@ public macro require(
@freestanding(expression) public macro require<E, R>(
throws errorType: E.Type,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: () async throws -> R
) = #externalMacro(module: "TestingMacros", type: "RequireMacro") where E: Error

Expand All @@ -236,7 +236,7 @@ public macro require(
@freestanding(expression) public macro require<R>(
throws _: Never.Type,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: () async throws -> R
) = #externalMacro(module: "TestingMacros", type: "RequireMacro")

Expand Down Expand Up @@ -272,7 +272,7 @@ public macro require(
@freestanding(expression) public macro expect<E, R>(
throws error: E,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: () async throws -> R
) = #externalMacro(module: "TestingMacros", type: "ExpectMacro") where E: Error & Equatable

Expand Down Expand Up @@ -309,7 +309,7 @@ public macro require(
@freestanding(expression) public macro require<E, R>(
throws error: E,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: () async throws -> R
) = #externalMacro(module: "TestingMacros", type: "RequireMacro") where E: Error & Equatable

Expand Down Expand Up @@ -352,7 +352,7 @@ public macro require(
/// ``expect(throws:_:sourceLocation:performing:)-5lzjz`` instead.
@freestanding(expression) public macro expect<R>(
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: () async throws -> R,
throws errorMatcher: (any Error) async throws -> Bool
) = #externalMacro(module: "TestingMacros", type: "ExpectMacro")
Expand Down Expand Up @@ -400,7 +400,7 @@ public macro require(
/// this macro. The test will then fail if an error is thrown.
@freestanding(expression) public macro require<R>(
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: () async throws -> R,
throws errorMatcher: (any Error) async throws -> Bool
) = #externalMacro(module: "TestingMacros", type: "RequireMacro")
Expand Down Expand Up @@ -474,7 +474,7 @@ public macro require(
@freestanding(expression) public macro expect(
exitsWith expectedExitCondition: ExitCondition,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: @convention(thin) () async throws -> Void
) = #externalMacro(module: "TestingMacros", type: "ExitTestExpectMacro")

Expand Down Expand Up @@ -549,6 +549,6 @@ public macro require(
@freestanding(expression) public macro require(
exitsWith expectedExitCondition: ExitCondition,
_ comment: @autoclosure () -> Comment? = nil,
sourceLocation: SourceLocation = SourceLocation(),
sourceLocation: SourceLocation = #_sourceLocation,
performing expression: @convention(thin) () async -> Void
) = #externalMacro(module: "TestingMacros", type: "ExitTestRequireMacro")
9 changes: 4 additions & 5 deletions Sources/Testing/Issues/Confirmation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ extension Confirmation {
/// `body` is invoked. The default value of this argument is `1`, indicating
/// that the event should occur exactly once. Pass `0` if the event should
/// _never_ occur when `body` is invoked.
/// - sourceLocation: The source location to which any recorded issues should
/// be attributed.
/// - body: The function to invoke.
///
/// - Returns: Whatever is returned by `body`.
Expand Down Expand Up @@ -92,10 +94,7 @@ extension Confirmation {
public func confirmation<R>(
_ comment: Comment? = nil,
expectedCount: Int = 1,
fileID: String = #fileID,
filePath: String = #filePath,
line: Int = #line,
column: Int = #column,
sourceLocation: SourceLocation = #_sourceLocation,
_ body: (Confirmation) async throws -> R
) async rethrows -> R {
let confirmation = Confirmation()
Expand All @@ -106,7 +105,7 @@ public func confirmation<R>(
.confirmationMiscounted(actual: actualCount, expected: expectedCount),
comments: Array(comment),
backtrace: .current(),
sourceLocation: SourceLocation(fileID: fileID, filePath: filePath, line: line, column: column)
sourceLocation: sourceLocation
)
}
}
Expand Down
16 changes: 6 additions & 10 deletions Sources/Testing/Issues/Issue+Recording.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ extension Issue {
///
/// - Parameters:
/// - comment: A comment describing the expectation.
/// - sourceLocation: The source location to which the issue should be
/// attributed.
///
/// - Returns: The issue that was recorded.
///
Expand All @@ -107,12 +109,8 @@ extension Issue {
/// or ``require(_:_:sourceLocation:)-5l63q`` macros.)
@discardableResult public static func record(
_ comment: Comment? = nil,
fileID: String = #fileID,
filePath: String = #filePath,
line: Int = #line,
column: Int = #column
sourceLocation: SourceLocation = #_sourceLocation
) -> Self {
let sourceLocation = SourceLocation(fileID: fileID, filePath: filePath, line: line, column: column)
let sourceContext = SourceContext(backtrace: .current(), sourceLocation: sourceLocation)
let issue = Issue(kind: .unconditional, comments: Array(comment), sourceContext: sourceContext)
return issue.record()
Expand All @@ -127,6 +125,8 @@ extension Issue {
/// - Parameters:
/// - error: The error that caused the issue.
/// - comment: A comment describing the expectation.
/// - sourceLocation: The source location to which the issue should be
/// attributed.
///
/// - Returns: The issue that was recorded.
///
Expand All @@ -137,12 +137,8 @@ extension Issue {
@discardableResult public static func record(
_ error: any Error,
_ comment: Comment? = nil,
fileID: String = #fileID,
filePath: String = #filePath,
line: Int = #line,
column: Int = #column
sourceLocation: SourceLocation = #_sourceLocation
) -> Self {
let sourceLocation = SourceLocation(fileID: fileID, filePath: filePath, line: line, column: column)
let backtrace = Backtrace(forFirstThrowOf: error) ?? Backtrace.current()
let sourceContext = SourceContext(backtrace: backtrace, sourceLocation: sourceLocation)
let issue = Issue(kind: .errorCaught(error), comments: Array(comment), sourceContext: sourceContext)
Expand Down
16 changes: 8 additions & 8 deletions Sources/Testing/Issues/Issue.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public struct Issue: Sendable {
/// Kinds of issues which may be recorded.
public enum Kind: Sendable {
/// An issue which occurred unconditionally, for example by using
/// ``Issue/record(_:fileID:filePath:line:column:)``.
/// ``Issue/record(_:sourceLocation:)``.
case unconditional

/// An issue due to a failed expectation, such as those produced by
Expand All @@ -33,9 +33,9 @@ public struct Issue: Sendable {
/// ``Confirmation/confirm(count:)`` should have been called.
///
/// This issue can occur when calling
/// ``confirmation(_:expectedCount:fileID:filePath:line:column:_:)`` when
/// the confirmation passed to these functions' `body` closures is confirmed
/// too few or too many times.
/// ``confirmation(_:expectedCount:sourceLocation:_:)`` when the
/// confirmation passed to these functions' `body` closures is confirmed too
/// few or too many times.
indirect case confirmationMiscounted(actual: Int, expected: Int)

/// An issue due to an `Error` being thrown by a test function and caught by
Expand Down Expand Up @@ -235,7 +235,7 @@ extension Issue.Kind {
@_spi(ForToolsIntegrationOnly)
public enum Snapshot: Sendable, Codable {
/// An issue which occurred unconditionally, for example by using
/// ``Issue/record(_:fileID:filePath:line:column:)``.
/// ``Issue/record(_:sourceLocation:)``.
case unconditional

/// An issue due to a failed expectation, such as those produced by
Expand All @@ -255,9 +255,9 @@ extension Issue.Kind {
/// ``Confirmation/confirm(count:)`` should have been called.
///
/// This issue can occur when calling
/// ``confirmation(_:expectedCount:fileID:filePath:line:column:_:)`` when
/// the confirmation passed to these functions' `body` closures is confirmed
/// too few or too many times.
/// ``confirmation(_:expectedCount:sourceLocation:_:)`` when the
/// confirmation passed to these functions' `body` closures is confirmed too
/// few or too many times.
indirect case confirmationMiscounted(actual: Int, expected: Int)

/// An issue due to an `Error` being thrown by a test function and caught by
Expand Down
Loading