Skip to content

Polling confirmations (under Experimental spi) #1115

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

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

Polling confirmations (under Experimental spi) #1115

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7e0385c
Polling Confirmations
younata May 15, 2025
d2f979a
Include a failure reason to help the console figure out why a polling…
younata Sep 22, 2025
8c03a32
Polling confirmations: Handle extremely large polling iterations
younata Sep 23, 2025
aa35626
Polling Confirmations: Documentation and spelling mistakes
younata Sep 23, 2025
3ff21e5
Polling confirmations: Pass the license headers check
younata Sep 23, 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
31 changes: 31 additions & 0 deletions Sources/Testing/Issues/Issue.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@ public struct Issue: Sendable {
/// confirmed too few or too many times.
indirect case confirmationMiscounted(actual: Int, expected: any RangeExpression & Sendable)

/// An issue due to a polling confirmation having failed.
///
/// - Parameters:
/// - reason: The ``PollingFailureReason`` behind why the polling
/// confirmation failed.
///
/// This issue can occur when calling ``confirmation(_:until:within:pollingEvery:isolation:sourceLocation:_:)-455gr``
/// or
/// ``confirmation(_:until:within:pollingEvery:isolation:sourceLocation:_:)-5tnlk``
/// whenever the polling fails, as described in ``PollingStopCondition``.
@_spi(Experimental)
case pollingConfirmationFailed(reason: PollingFailureReason)

/// An issue due to an `Error` being thrown by a test function and caught by
/// the testing library.
///
Expand Down Expand Up @@ -295,6 +308,8 @@ extension Issue.Kind: CustomStringConvertible {
}
}
return "Confirmation was confirmed \(actual.counting("time")), but expected to be confirmed \(String(describingForTest: expected)) time(s)"
case .pollingConfirmationFailed:
return "Polling confirmation failed"
case let .errorCaught(error):
return "Caught error: \(error)"
case let .timeLimitExceeded(timeLimitComponents: timeLimitComponents):
Expand Down Expand Up @@ -434,6 +449,15 @@ extension Issue.Kind {
/// too few or too many times.
indirect case confirmationMiscounted(actual: Int, expected: Int)

/// An issue due to a polling confirmation having failed.
///
/// This issue can occur when calling ``confirmation(_:until:within:pollingEvery:isolation:sourceLocation:_:)-455gr``
/// or
/// ``confirmation(_:until:within:pollingEvery:isolation:sourceLocation:_:)-5tnlk``
/// whenever the polling fails, as described in ``PollingStopCondition``.
@_spi(Experimental)
case pollingConfirmationFailed

/// An issue due to an `Error` being thrown by a test function and caught by
/// the testing library.
///
Expand Down Expand Up @@ -477,6 +501,8 @@ extension Issue.Kind {
.expectationFailed(Expectation.Snapshot(snapshotting: expectation))
case .confirmationMiscounted:
.unconditional
case .pollingConfirmationFailed:
.pollingConfirmationFailed
case let .errorCaught(error), let .valueAttachmentFailed(error):
.errorCaught(ErrorSnapshot(snapshotting: error))
case let .timeLimitExceeded(timeLimitComponents: timeLimitComponents):
Expand All @@ -495,6 +521,7 @@ extension Issue.Kind {
case unconditional
case expectationFailed
case confirmationMiscounted
case pollingConfirmationFailed
case errorCaught
case timeLimitExceeded
case knownIssueNotRecorded
Expand Down Expand Up @@ -567,6 +594,8 @@ extension Issue.Kind {
forKey: .confirmationMiscounted)
try confirmationMiscountedContainer.encode(actual, forKey: .actual)
try confirmationMiscountedContainer.encode(expected, forKey: .expected)
case .pollingConfirmationFailed:
try container.encode(true, forKey: .pollingConfirmationFailed)
case let .errorCaught(error):
var errorCaughtContainer = container.nestedContainer(keyedBy: _CodingKeys._ErrorCaughtKeys.self, forKey: .errorCaught)
try errorCaughtContainer.encode(error, forKey: .error)
Expand Down Expand Up @@ -622,6 +651,8 @@ extension Issue.Kind.Snapshot: CustomStringConvertible {
}
case let .confirmationMiscounted(actual: actual, expected: expected):
"Confirmation was confirmed \(actual.counting("time")), but expected to be confirmed \(expected.counting("time"))"
case .pollingConfirmationFailed:
"Polling confirmation failed"
case let .errorCaught(error):
"Caught error: \(error)"
case let .timeLimitExceeded(timeLimitComponents: timeLimitComponents):
Expand Down
Loading
Loading