Add AppleTV support

CONTRIBUTING.md

@@ -58,9 +58,9 @@ They are placed in `maestro-android/build/outputs/apk`, and are copied over to `
 
 Maestro requires 3 artifacts to run on iOS:
 
-- `maestro-driver-ios` - the host app for the test runner. Does nothing and is not installed.
-- `maestro-driver-iosUITests-Runner.app` - the test runner app. Starts an HTTP server inside an infinite XCTest. 
-- `maestro-driver-ios-config.xctestrun` - the configuration file required to run the test runner app.
+- `maestro-driver` - the host app for the test runner. Does nothing and is not installed.
+- `maestro-driverUITests-Runner.app` - the test runner app. Starts an HTTP server inside an infinite XCTest. 
+- `maestro-driver-config.xctestrun` - the configuration file required to run the test runner app.
 
 These artifacts are built by the `build-maestro-ios-runner.sh` script. It places them in `maestro-ios-driver/src/main/resources`.
 

maestro-client/src/main/java/maestro/drivers/IOSDriver.kt

@@ -130,25 +130,7 @@ class IOSDriver(
 
     override fun pressKey(code: KeyCode) {
         metrics.measured("operation", mapOf("command" to "pressKey")) {
-            val keyCodeNameMap = mapOf(
-                KeyCode.BACKSPACE to "delete",
-                KeyCode.ENTER to "return",
-            )
-
-            val buttonNameMap = mapOf(
-                KeyCode.HOME to "home",
-                KeyCode.LOCK to "lock",
-            )
-
-            runDeviceCall("pressKey") {
-                keyCodeNameMap[code]?.let { name ->
-                    iosDevice.pressKey(name)
-                }
-
-                buttonNameMap[code]?.let { name ->
-                    iosDevice.pressButton(name)
-                }
-            }
+            iosDevice.pressButton(code.description)
         }
     }
 

maestro-ios-driver/build.gradle.kts

@@ -15,6 +15,7 @@ dependencies {
     implementation(project(":maestro-utils"))
 
     api(libs.square.okhttp)
+    api(libs.google.gson)
     api(libs.square.okhttp.logs)
     api(libs.jackson.module.kotlin)
     api(libs.jarchivelib)

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

@@ -13,6 +13,7 @@ import okio.source
 import org.apache.commons.io.FileUtils
 import org.rauschig.jarchivelib.ArchiverFactory
 import org.slf4j.LoggerFactory
+import util.LocalSimulatorUtils
 import util.XCRunnerCLIUtils
 import xcuitest.XCTestClient
 import java.io.File
@@ -176,25 +177,41 @@ class LocalXCTestInstaller(
         return checkSuccessful
     }
 
+    private fun isTV(deviceId: String): Boolean {
+        val list = LocalSimulatorUtils.list()
+        for (entry in list.devices.entries) {
+            for (device in entry.value) {
+                if (device.udid != deviceId) continue
+                if (device.deviceTypeIdentifier == null) continue
+                logger.trace("Device is an AppleTV")
+                return device.deviceTypeIdentifier.contains("Apple-TV")
+            }
+        }
+
+        return false
+    }
+
     private fun startXCTestRunner() {
         if (isChannelAlive()) {
             logger.info("UI Test runner already running, returning")
             return
         }
 
+        val isTV = isTV(deviceId)
+
         logger.info("[Start] Writing xctest run file")
         val tempDir = File(tempDir).apply { mkdir() }
-        val xctestRunFile = File("$tempDir/maestro-driver-ios-config.xctestrun")
-        writeFileToDestination(XCTEST_RUN_PATH, xctestRunFile)
+        val xctestRunFile = File("${tempDir}/maestro-driver-config.xctestrun")
+        writeFileToDestination(XCTEST_RUN_PATH, xctestRunFile, isTV)
         logger.info("[Done] Writing xctest run file")
 
-        logger.info("[Start] Writing maestro-driver-iosUITests-Runner app")
-        extractZipToApp("maestro-driver-iosUITests-Runner", UI_TEST_RUNNER_PATH)
-        logger.info("[Done] Writing maestro-driver-iosUITests-Runner app")
+        logger.info("[Start] Writing maestro-driverUITests-Runner app")
+        extractZipToApp("maestro-driverUITests-Runner", UI_TEST_RUNNER_PATH, isTV)
+        logger.info("[Done] Writing maestro-driverUITests-Runner app")
 
-        logger.info("[Start] Writing maestro-driver-ios app")
-        extractZipToApp("maestro-driver-ios", UI_TEST_HOST_PATH)
-        logger.info("[Done] Writing maestro-driver-ios app")
+        logger.info("[Start] Writing maestro-driver app")
+        extractZipToApp("maestro-driver", UI_TEST_HOST_PATH, isTV)
+        logger.info("[Done] Writing maestro-driver app")
 
         logger.info("[Start] Running XcUITest with `xcodebuild test-without-building`")
         xcTestProcess = XCRunnerCLIUtils.runXcTestWithoutBuild(
@@ -218,30 +235,36 @@ class LocalXCTestInstaller(
         logger.info("[Done] Cleaning up the ui test runner files")
     }
 
-    private fun extractZipToApp(appFileName: String, srcAppPath: String) {
-        val appFile = File("$tempDir/Debug-iphonesimulator").apply { mkdir() }
+    private fun extractZipToApp(appFileName: String, srcAppPath: String, isTV: Boolean) {
+        val appFile = when(isTV) {
+            true -> File("$tempDir/Debug-appletvsimulator").apply { mkdir() }
+            false -> File("$tempDir/Debug-iphonesimulator").apply { mkdir() }
+        }
         val appZip = File("$tempDir/$appFileName.zip")
 
-        writeFileToDestination(srcAppPath, appZip)
+        writeFileToDestination(srcAppPath, appZip, isTV)
         ArchiverFactory.createArchiver(appZip).apply {
             extract(appZip, appFile)
         }
     }
 
-    private fun writeFileToDestination(srcPath: String, destFile: File) {
-        LocalXCTestInstaller::class.java.getResourceAsStream(srcPath)?.let {
+    private fun writeFileToDestination(srcPath: String, destFile: File, isTV: Boolean) {
+        val prefix = when (isTV) {
+            true -> "/tvos/"
+            false -> "/ios/"
+        }
+        LocalXCTestInstaller::class.java.getResourceAsStream(prefix + srcPath)?.let {
             val bufferedSink = destFile.sink().buffer()
             bufferedSink.writeAll(it.source())
             bufferedSink.flush()
         }
     }
 
     companion object {
-        private const val UI_TEST_RUNNER_PATH = "/maestro-driver-iosUITests-Runner.zip"
-        private const val XCTEST_RUN_PATH = "/maestro-driver-ios-config.xctestrun"
-        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"
+        private const val UI_TEST_RUNNER_PATH = "maestro-driverUITests-Runner.zip"
+        private const val XCTEST_RUN_PATH = "maestro-driver-config.xctestrun"
+        private const val UI_TEST_HOST_PATH = "maestro-driver.zip"
+        private const val UI_TEST_RUNNER_APP_BUNDLE_ID = "dev.mobile.maestro-driverUITests.xctrunner"
 
         private const val SERVER_LAUNCH_TIMEOUT_MS = 120000L
         private const val MAESTRO_DRIVER_STARTUP_TIMEOUT = "MAESTRO_DRIVER_STARTUP_TIMEOUT"