[DRAFT] [ST-XXXX] Test Issue Severity #2794
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stmontgomery
added
workgroup: needs development
| * Authors: [Suzy Ratcliff](https://github.com/suzannaratcliff) | ||
| * Review Manager: TBD | ||
| * Status: **Pitched** | ||
| * Bug: [swiftlang/swift-testing#1075](https://github.com/swiftlang/swift-testing/pull/1075) |
There was a problem hiding this comment.
I think this line can be removed, because the same pull request is on the next line.
Suggested change
| * Bug: [swiftlang/swift-testing#1075](https://github.com/swiftlang/swift-testing/pull/1075) |
| Currently, when an issue arises during a test, the only possible outcome is to mark the test as failed. This presents a challenge for users who want a deeper insight into the events occurring within their tests. By introducing a dedicated mechanism to record issues that do not cause test failure, users can more effectively inspect and diagnose problems at runtime and review results afterward. This enhancement provides greater flexibility and clarity in test reporting, ultimately improving the debugging and analysis process. | ||
|
|
||
| ## Proposed solution | ||
| We propose introducing a new property on `Issue` in Swift Testing called `Severity`, that represents if an issue is a `warning` or an `error`. |
There was a problem hiding this comment.
(Lowercased.)
Suggested change
| We propose introducing a new property on `Issue` in Swift Testing called `Severity`, that represents if an issue is a `warning` or an `error`. | |
| We propose introducing a new property on `Issue` in Swift Testing called `severity`, that represents if an issue is a `warning` or an `error`. |
| The `Severity` enum: | ||
|
|
||
| ```swift | ||
| public enum Severity: Sendable { |
There was a problem hiding this comment.
Should the other conformances be included? Also, it wasn't obvious that Issue.Severity is a nested type.
Suggested change
| public enum Severity: Sendable { | |
| extension Issue { | |
| public enum Severity: Codable, Comparable, CustomStringConvertible, Sendable { |
| * Status: **Pitched** | ||
| * Bug: [swiftlang/swift-testing#1075](https://github.com/swiftlang/swift-testing/pull/1075) | ||
| * Implementation: [swiftlang/swift-testing#1075](https://github.com/swiftlang/swift-testing/pull/1075) | ||
|
|
There was a problem hiding this comment.
Can you fill out the "Review" header field starting with a link to the Pitch thread on the Forums
* Review: ([pitch](https://forums.swift.org/...))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the draft proposal for
IssueSeverityin Swift Testing.