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.

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

Add ConditionTrait.evaluate() #909

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add ConditionTrait.evaluate() #909

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e0e3a82
Add ConditionTrait.evaluate()
Uncommon Jan 11, 2025
2922f02
Change to tuple for return value
Uncommon Jan 14, 2025
6c84190
Change name and add comments
Uncommon Jan 14, 2025
1a08ed3
Draft proposal
Uncommon Jan 14, 2025
783595a
Add forum thread link
Uncommon Jan 16, 2025
b495022
Update proposal with specific code samples
Uncommon Jan 16, 2025
d39d509
Add tests for ConditionTrait.evaluate()
Uncommon Jan 17, 2025
22fece1
Use #_sourceLocation macro instead of __here
Uncommon Jan 17, 2025
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
27 changes: 9 additions & 18 deletions Sources/Testing/Traits/ConditionTrait.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,8 @@
/// - ``Trait/disabled(if:_:sourceLocation:)``
/// - ``Trait/disabled(_:sourceLocation:_:)``
public struct ConditionTrait: TestTrait, SuiteTrait {
/// An enumeration identifying the result of evaluating the condition.
public enum Evaluation: Sendable {
/// The condition succeeded.
case success
/// The condition failed, potentially returning a `Comment`.
case failure(Comment?)
}
/// The result of evaluating the condition.
public typealias Evaluation = (Bool, comment: Comment?)

/// An enumeration describing the kinds of conditions that can be represented
/// by an instance of this type.
Expand All @@ -38,7 +33,7 @@ public struct ConditionTrait: TestTrait, SuiteTrait {
/// `false` and a comment is also returned, it is used in place of the
/// value of the associated trait's ``ConditionTrait/comment`` property.
/// If this function returns `true`, the returned comment is ignored.
case conditional(_ body: @Sendable () async throws -> (Bool, comment: Comment?))
case conditional(_ body: @Sendable () async throws -> Evaluation)

/// Create an instance of this type associated with a trait that is
/// conditional on the result of calling a function.
Expand All @@ -49,7 +44,7 @@ public struct ConditionTrait: TestTrait, SuiteTrait {
///
/// - Returns: An instance of this type.
static func conditional(_ body: @escaping @Sendable () async throws -> Bool) -> Self {
conditional { () -> (Bool, comment: Comment?) in
conditional { () -> Evaluation in
return (try await body(), nil)
}
}
Expand Down Expand Up @@ -89,24 +84,20 @@ public struct ConditionTrait: TestTrait, SuiteTrait {
public var sourceLocation: SourceLocation

/// Returns the result of evaluating the condition.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Returns the result of evaluating the condition.
/// Evaluate this instance's underlying condition.
///
/// - Returns: The result of evaluating this instance's underlying condition.
///

You may also want to include a discussion paragraph after - Returns: if there is additional information for the reader to consume. In particular, it may be worth noting that the result of this function is not cached.

@_spi(Experimental)
public func evaluate() async throws -> Evaluation {
switch kind {
case let .conditional(condition):
switch try await condition() {
case (true, _):
.success
case (false, let comment):
.failure(comment)
}
try await condition()
case let .unconditional(unconditionalValue):
unconditionalValue ? .success : .failure(nil)
(unconditionalValue, nil)
}
}

public func prepare(for test: Test) async throws {
let result = try await evaluate()
let (isEnabled, commentOverride) = try await evaluate()

if case let .failure(commentOverride) = result {
if !isEnabled {
// We don't need to consider including a backtrace here because it will
// primarily contain frames in the testing library, not user code. If an
// error was thrown by a condition evaluated above, the caller _should_
Expand Down