Reimplement waitForElementAndTap... as a typed XCUIElement method
#22322
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| import XCTest | ||
|
|
||
| public extension XCUIElement { | ||
|
|
||
| /// Abstraction do describe possible "states" an `XCUIElement` can be in. | ||
| /// | ||
| /// The goal of this `enum` is to make checking against the possible states a safe operation thanks to the compiler enforcing all and only the states represented by the `enum` `case`s are handled. | ||
| enum State { | ||
| case exists | ||
| case dismissed | ||
| case selected | ||
| } | ||
|
|
||
| /// Attempt to tap `self` until the given `XCUIElement` is in the given `State` or the `maxRetries` number of retries has been reached. | ||
| /// | ||
| /// Useful to make tests robusts against UI changes that may have some lag. | ||
| func tapUntil( | ||
| element: XCUIElement, | ||
| matches state: State, | ||
| failureMessage: String, | ||
| maxRetries: Int = 10, | ||
| retryInterval: TimeInterval = 1 | ||
| ) { | ||
| tapUntil( | ||
| Condition(element: element, state: state), | ||
| retriedCount: 0, | ||
| failureMessage: failureMessage, | ||
| maxRetries: maxRetries, | ||
| retryInterval: retryInterval | ||
| ) | ||
| } | ||
|
|
||
| /// Attempt to tap `self` until its "state" matches `Condition.State` or the `maxRetries` number of retries has been reached. | ||
| /// | ||
| /// Useful to make tests robusts against UI changes that may have some lag. | ||
| func tapUntil( | ||
| _ state: State, | ||
| failureMessage: String, | ||
| maxRetries: Int = 10, | ||
| retryInterval: TimeInterval = 1 | ||
| ) { | ||
| tapUntil( | ||
| Condition(element: self, state: state), | ||
| retriedCount: 0, | ||
| failureMessage: failureMessage, | ||
| maxRetries: maxRetries, | ||
| retryInterval: retryInterval | ||
| ) | ||
| } | ||
|
|
||
| /// Describe the expectation for a given `XCUIElement` to be in a certain `Condition.State`. | ||
| /// | ||
| /// Example: `Condition(element: myButton, state: .selected)`. | ||
| struct Condition { | ||
|
|
||
| let element: XCUIElement | ||
| let state: XCUIElement.State | ||
|
|
||
| fileprivate func isMet() -> Bool { | ||
| switch state { | ||
| case .exists: return element.exists | ||
| case .dismissed: return element.isHittable == false | ||
| case .selected: return element.isSelected | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private func tapUntil( | ||
| _ condition: Condition, | ||
| retriedCount: Int, | ||
| failureMessage: String, | ||
| maxRetries: Int, | ||
| retryInterval: TimeInterval | ||
| ) { | ||
| guard retriedCount < maxRetries else { | ||
| return XCTFail("\(failureMessage) after \(retriedCount) tries.") | ||
| } | ||
|
|
||
| tap() | ||
|
|
||
| guard condition.isMet() else { | ||
| sleep(UInt32(retryInterval)) | ||
|
|
||
| return tapUntil( | ||
|
Contributor
There was a problem hiding this comment. Nice alternative to a conventional loop. I'd never come up with it. =D |
||
| condition, | ||
| retriedCount: retriedCount + 1, | ||
| failureMessage: failureMessage, | ||
| maxRetries: maxRetries, | ||
| retryInterval: retryInterval | ||
| ) | ||
| } | ||
| } | ||
| } | ||
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Notice how thanks to the enum we no longer need to handle the case where the input is invalid: