Add tapWhenReady

Author: Tunous

README.md

@@ -7,6 +7,7 @@ Utilities for easier interaction with XCUITest methods.
 - `XCUIElement` extensions:
     - Checking existence of elements:
         - `assertExists()`
+        - `assertExists(waitForAppToIdle: true)`
         - `assertNotExists()`
     - Checking interactivity of elements:
         - `assertIsHittable()`
@@ -22,9 +23,9 @@ Utilities for easier interaction with XCUITest methods.
     - Checking traits of elements:
         - `assertIsSelected()`
         - `assertIsNotSelected()`
-    - Waiting for interactivity:
+    - Performing actions:
+        - `tapWhenReady()`
         - `waitForInteractivity()`
-        - `assertExists(waitForAppToIdle: true)`
 - `XCUIApplication` extensions:
     - Accessing other apps:
         - `XCUIApplication.safari`
@@ -51,7 +52,7 @@ func testOpenClosePremiumScreen() throws {
     try launch(configuration: .init(premiumUnlocked: false)) // TODO: Add tip about helper launch configurations
 
     app.buttons[.toggleBottomSheetButton].tap()
-    app.buttons["Unlock Premium"].waitForInteractivity().tap()
+    app.buttons["Unlock Premium"].tapWhenReady()
     assertPremiumScreenIsVisible()
     app.buttons[.unlockFeaturesButton].assertIsEnabled().assertContainsText("Lifetime access")
     app.buttons["Restore Purchase"].assertIsEnabled()

Sources/XCAppTest/XCUIElement+App.swift

@@ -306,7 +306,7 @@ extension XCUIElement {
         return self
     }
 
-    // MARK: - Waiting for interactivity
+    // MARK: - Performing actions
 
     /// Waits for the element to exist, be hittable and enabled.
     ///
@@ -325,4 +325,22 @@ extension XCUIElement {
         assertIsInteractive(message(), file: file, line: line)
         return self
     }
+
+    /// Waits for the element to exist and become interactive, then taps on it.
+    ///
+    /// - Parameters:
+    ///   - message: An optional description of a failure.
+    ///   - file: The file where the failure occurs. The default is the filename of the test case where you call this function.
+    ///   - line: The line number where the failure occurs. The default is the line number where you call this function.
+    /// - Returns: Unmodified UI element.
+    @discardableResult
+    public func tapWhenReady(
+        _ message: @autoclosure () -> String? = nil,
+        file: StaticString = #file,
+        line: UInt = #line
+    ) -> Self {
+        waitForInteractivity(message(), file: file, line: line)
+        tap()
+        return self
+    }
 }