WIP

gradle/libs.versions.toml

@@ -35,6 +35,7 @@ jarchivelib = "1.2.0"
 junit = "5.10.2"
 kotlin = "1.8.22"
 kotlinResult = "1.1.18"
+kotlinRetry = "1.0.9"
 ktor = "2.3.6"
 mockk = "1.12.0"
 mozillaRhino = "1.7.14"
@@ -52,6 +53,7 @@ clikt = "4.2.2"
 
 [libraries]
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
+kotlinx-coroutines-core-jvm = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm", version.ref = "coroutines" }
 kotlinx-html = { module = "org.jetbrains.kotlinx:kotlinx-html", version.ref = "kotlinx-html" }
 androidx-espresso-core = { module = "androidx.test.espresso:espresso-core", version.ref = "androidxEspresso" }
 androidx-test-junit = { module = "androidx.test.ext:junit", version.ref = "androidxTestJunit" }
@@ -88,7 +90,8 @@ jarchivelib = { module = "org.rauschig:jarchivelib", version.ref = "jarchivelib"
 junit-jupiter-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit" }
 junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit" }
 junit-jupiter-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit" }
-kotlin-result = { module = "com.michael-bull.kotlin-result:kotlin-result", version.ref = "kotlinResult" }
+kotlin-retry = { module = "com.michael-bull.kotlin-result:kotlin-result", version.ref = "kotlinResult" }
+kotlin-result = { module = "com.michael-bull.kotlin-retry:kotlin-retry", version.ref = "kotlinRetry" }
 clikt = { module = "com.github.ajalt.clikt:clikt", version.ref = "clikt" }
 ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" }
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }

maestro-ios-driver/build.gradle.kts

@@ -13,6 +13,9 @@ mavenPublishing {
 
 dependencies {
     implementation(project(":maestro-utils"))
+    implementation(libs.kotlinx.coroutines.core.jvm)
+    implementation(libs.kotlinx.coroutines.core)
+    implementation(libs.commons.io)
 
     api(libs.square.okhttp)
     api(libs.square.okhttp.logs)
@@ -25,7 +28,6 @@ dependencies {
     testImplementation(libs.junit.jupiter.api)
     testRuntimeOnly(libs.junit.jupiter.engine)
     testImplementation(libs.google.truth)
-    implementation(libs.commons.io)
 }
 
 java {

maestro-ios-driver/src/main/kotlin/xcuitest/installer/LocalXCTestInstaller.kt

@@ -1,12 +1,18 @@
 package xcuitest.installer
 
+import com.github.michaelbull.retry.policy.binaryExponentialBackoff
+import com.github.michaelbull.retry.policy.limitAttempts
+import com.github.michaelbull.retry.policy.plus
+import com.github.michaelbull.retry.policy.retryIf
 import maestro.utils.MaestroTimer
 import okhttp3.HttpUrl
 import okhttp3.OkHttpClient
 import okhttp3.Request
 import okio.buffer
+import com.github.michaelbull.retry.retry
 import okio.sink
 import okio.source
+import kotlinx.coroutines.runBlocking
 import org.apache.commons.io.FileUtils
 import org.rauschig.jarchivelib.ArchiverFactory
 import org.slf4j.LoggerFactory
@@ -33,6 +39,9 @@ class LocalXCTestInstaller(
      */
     private val useXcodeTestRunner = !System.getenv("USE_XCODE_TEST_RUNNER").isNullOrEmpty()
     private val tempDir = "${System.getenv("TMPDIR")}/$deviceId"
+    private val retryException = retryIf<Throwable> {
+        reason is RetryDriverInstallationAction
+    }
 
     private var xcTestProcess: Process? = null
 
@@ -90,24 +99,29 @@ class LocalXCTestInstaller(
 
         uninstall()
 
-        repeat(3) { i ->
-            logger.info("[Start] Install XCUITest runner on $deviceId")
-            startXCTestRunner()
-            logger.info("[Done] Install XCUITest runner on $deviceId")
-
-            logger.info("[Start] Ensure XCUITest runner is running on $deviceId")
-            if (ensureOpen()) {
-                logger.info("[Done] Ensure XCUITest runner is running on $deviceId")
-                return XCTestClient(host, defaultPort)
-            } else {
-                uninstall()
-                logger.info("[Failed] Ensure XCUITest runner is running on $deviceId")
-                logger.info("[Retry] Retrying setup() ${i}th time")
+        val result = runBlocking {
+            retry(limitAttempts(5) +  retryException + binaryExponentialBackoff(base = 50L, max = 5000L)) {
+                logger.info("[Start] Install XCUITest runner on $deviceId")
+                startXCTestRunner()
+                logger.info("[Done] Install XCUITest runner on $deviceId")
+
+                val isDriverAlive = isChannelAlive()
+
+                if (!isDriverAlive) {
+                    FileUtils.cleanDirectory(File(tempDir))
+                    uninstall()
+                    logger.info("Retrying installation of driver")
+                    throw RetryDriverInstallationAction("iOS driver not ready")
+                }
+
+                return@retry XCTestClient(host, defaultPort)
             }
         }
-        return null
+
+        return result
     }
 
+
     override fun isChannelAlive(): Boolean {
         val appAlive = XCRunnerCLIUtils.isAppAlive(UI_TEST_RUNNER_APP_BUNDLE_ID, deviceId)
         return appAlive && xcTestDriverStatusCheck()
@@ -133,19 +147,22 @@ class LocalXCTestInstaller(
                 .port(defaultPort)
         }
 
-        val url = xctestAPIBuilder("status")
-            .build()
-
-        val request = Request.Builder()
+        val url by lazy {
+            xctestAPIBuilder("status")
+                .build()
+        }
+        val request by lazy { Request.Builder()
             .get()
             .url(url)
             .build()
+        }
 
-        val okHttpClient = OkHttpClient.Builder()
-            .connectTimeout(40, TimeUnit.SECONDS)
-            .readTimeout(100, TimeUnit.SECONDS)
-            .build()
-
+        val okHttpClient by lazy {
+            OkHttpClient.Builder()
+                .connectTimeout(40, TimeUnit.SECONDS)
+                .readTimeout(100, TimeUnit.SECONDS)
+                .build()
+        }
         val checkSuccessful = try {
             okHttpClient.newCall(request).execute().use {
                 logger.info("[Done] Perform XCUITest driver status check on $deviceId")
@@ -231,4 +248,6 @@ class LocalXCTestInstaller(
         private const val UI_TEST_HOST_PATH = "/maestro-driver-ios.zip"
         private const val UI_TEST_RUNNER_APP_BUNDLE_ID = "dev.mobile.maestro-driver-iosUITests.xctrunner"
     }
+
+    class RetryDriverInstallationAction(message: String, cause: Throwable? = null): Exception(message, cause)
 }

maestro-ios/src/main/java/ios/xctest/XCTestIOSDevice.kt

@@ -1,6 +1,5 @@
 package ios.xctest
 
-import com.github.michaelbull.result.Result
 import hierarchy.ViewHierarchy
 import ios.IOSDevice
 import ios.IOSDeviceErrors