Skip to content
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.

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

feat: Add the ability to disable test failures on report issue #146

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
72 changes: 38 additions & 34 deletions Sources/IssueReporting/ReportIssue.swift
Original file line number Diff line number Diff line change
Expand Up @@ -60,23 +60,25 @@ public func reportIssue(
}
return
}

switch context {
case .swiftTesting:
_recordIssue(
message: message(),
fileID: "\(IssueContext.current?.fileID ?? fileID)",
filePath: "\(IssueContext.current?.filePath ?? filePath)",
line: Int(IssueContext.current?.line ?? line),
column: Int(IssueContext.current?.column ?? column)
)
case .xcTest:
_XCTFail(
message().withAppHostWarningIfNeeded() ?? "",
file: IssueContext.current?.filePath ?? filePath,
line: IssueContext.current?.line ?? line
)
@unknown default: break

if TestContext.emitsFailureOnReportIssue {
switch context {
case .swiftTesting:
_recordIssue(
message: message(),
fileID: "\(IssueContext.current?.fileID ?? fileID)",
filePath: "\(IssueContext.current?.filePath ?? filePath)",
line: Int(IssueContext.current?.line ?? line),
column: Int(IssueContext.current?.column ?? column)
)
case .xcTest:
_XCTFail(
message().withAppHostWarningIfNeeded() ?? "",
file: IssueContext.current?.filePath ?? filePath,
line: IssueContext.current?.line ?? line
)
@unknown default: break
}
}
}

Expand Down Expand Up @@ -130,22 +132,24 @@ public func reportIssue(
return
}

switch context {
case .swiftTesting:
_recordError(
error: error,
message: message(),
fileID: "\(IssueContext.current?.fileID ?? fileID)",
filePath: "\(IssueContext.current?.filePath ?? filePath)",
line: Int(IssueContext.current?.line ?? line),
column: Int(IssueContext.current?.column ?? column)
)
case .xcTest:
_XCTFail(
"Caught error: \(error)\(message().map { ": \($0)" } ?? "")".withAppHostWarningIfNeeded(),
file: IssueContext.current?.filePath ?? filePath,
line: IssueContext.current?.line ?? line
)
@unknown default: break
if TestContext.emitsFailureOnReportIssue {
switch context {
case .swiftTesting:
_recordError(
error: error,
message: message(),
fileID: "\(IssueContext.current?.fileID ?? fileID)",
filePath: "\(IssueContext.current?.filePath ?? filePath)",
line: Int(IssueContext.current?.line ?? line),
column: Int(IssueContext.current?.column ?? column)
)
case .xcTest:
_XCTFail(
"Caught error: \(error)\(message().map { ": \($0)" } ?? "")".withAppHostWarningIfNeeded(),
file: IssueContext.current?.filePath ?? filePath,
line: IssueContext.current?.line ?? line
)
@unknown default: break
}
}
}
35 changes: 35 additions & 0 deletions Sources/IssueReporting/TestContext.swift
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,38 @@ extension TestContext.Testing {
self.init(test: Test(id: Test.ID(rawValue: id)))
}
}

extension TestContext {
/// Indicates whether or not test failures should be emitted by default when an issue is reported.
public static var emitsFailureOnReportIssue: Bool {
get { _emitsFailureOnReportIssue.withLock { $0 } }
set { _emitsFailureOnReportIssue.withLock { $0 = newValue } }
}

@TaskLocal fileprivate static var _emitsFailureOnReportIssue = LockIsolated<Bool>(true)
}

public func withEmitsFailureOnReportIssue<R>(
_ value: Bool,
operation: () throws -> R
) rethrows -> R {
try TestContext.$_emitsFailureOnReportIssue.withValue(LockIsolated(value), operation: operation)
}

#if compiler(>=6)
public func withEmitsFailureOnReportIssue<R>(
_ value: Bool,
isolation: isolated (any Actor)? = #isolation,
operation: () async throws -> R
) async rethrows -> R {
try await TestContext.$_emitsFailureOnReportIssue.withValue(LockIsolated(value), operation: operation)
}
#else
@_unsafeInheritExecutor
public func withEmitsFailureOnReportIssue<R>(
_ value: Bool,
operation: () async throws -> R
) async rethrows -> R {
try await TestContext.$_emitsFailureOnReportIssue.withValue(LockIsolated(value), operation: operation)
}
#endif
6 changes: 6 additions & 0 deletions Tests/IssueReportingTests/SwiftTestingTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@
issue.description == "Caught error: Failure(): Something went wrong"
}
}

@Test func reportIssue_EmitFailureDisabled() {
withEmitsFailureOnReportIssue(false) {
reportIssue()
}
}

@Test func withExpectedIssue_reportIssue() {
withExpectedIssue {
Expand Down
6 changes: 6 additions & 0 deletions Tests/IssueReportingTests/XCTestTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ final class XCTestTests: XCTestCase {
$0.compactDescription == "failed - Something went wrong"
}
}

func testReportIssue_EmitFailureDisabled() {
withEmitsFailureOnReportIssue(false) {
reportIssue()
}
}

func testWithExpectedIssue() {
withExpectedIssue {
Expand Down