fix: deserialization breaking for devicectl response (#2458)

Author: amanjeetsingh150

maestro-cli/src/main/java/maestro/cli/session/MaestroSessionManager.kt

@@ -368,7 +368,7 @@ object MaestroSessionManager {
 
         val deviceController = when (deviceType) {
             Device.DeviceType.REAL -> {
-                val device = util.LocalIOSDevice.listDeviceViaDeviceCtl(deviceId)
+                val device = util.LocalIOSDevice().listDeviceViaDeviceCtl(deviceId)
                 val deviceCtlDevice = DeviceControlIOSDevice(deviceId = device.identifier)
                 deviceCtlDevice
             }

maestro-client/src/main/java/maestro/device/DeviceService.kt

@@ -259,7 +259,7 @@ object DeviceService {
     }
 
     private fun listIOSConnectedDevices(): List<Device.Connected> {
-        val connectedIphoneList = util.LocalIOSDevice.listDeviceViaDeviceCtl()
+        val connectedIphoneList = util.LocalIOSDevice().listDeviceViaDeviceCtl()
 
         return connectedIphoneList.map {
             val description = "${it.deviceProperties.name} - ${it.deviceProperties.osVersionNumber} - ${it.identifier}"

maestro-ios-driver/build.gradle.kts

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

maestro-ios-driver/src/main/kotlin/util/IOSDevice.kt

@@ -7,38 +7,10 @@ enum class IOSDeviceType {
     SIMULATOR
 }
 
-@JsonIgnoreProperties(ignoreUnknown = true)
-data class XCDevice(
-    val modelCode: String,
-    val simulator: Boolean,
-    val modelName: String,
-    val identifier: String,
-    val platform: String,
-    val name: String,
-    val operatingSystemVersion: String,
-    val modelUTI: String,
-    val architecture: String,
-) {
-    companion object {
-        const val IPHONE_PLATFORM = "com.apple.platform.iphoneos"
-    }
-}
-
 @JsonIgnoreProperties(ignoreUnknown = true)
 data class DeviceCtlResponse(
-    val info: Info,
     val result: Result
 ) {
-    @JsonIgnoreProperties(ignoreUnknown = true)
-    data class Info(
-        val arguments: List<String>,
-        val commandType: String,
-        val environment: Map<String, String>,
-        val jsonVersion: Int,
-        val outcome: String,
-        val version: String
-    )
-
     @JsonIgnoreProperties(ignoreUnknown = true)
     data class Result(
         val devices: List<Device>
@@ -47,68 +19,18 @@ data class DeviceCtlResponse(
     @JsonIgnoreProperties(ignoreUnknown = true)
     data class Device(
         val identifier: String,
-        val capabilities: List<Capability>,
-        val connectionProperties: ConnectionProperties,
         val deviceProperties: DeviceProperties,
-        val hardwareProperties: HardwareProperties,
-        val tags: List<String>,
-        val visibilityClass: String
-    )
-
-    @JsonIgnoreProperties(ignoreUnknown = true)
-    data class Capability(
-        val featureIdentifier: String,
-        val name: String
-    )
-
-    @JsonIgnoreProperties(ignoreUnknown = true)
-    data class ConnectionProperties(
-        val authenticationType: String,
-        val isMobileDeviceOnly: Boolean,
-        val lastConnectionDate: String,
-        val pairingState: String,
-        val potentialHostnames: List<String>,
-        val transportType: String?,
-        val tunnelState: String,
-        val tunnelTransportProtocol: String?
+        val hardwareProperties: HardwareProperties
     )
 
     @JsonIgnoreProperties(ignoreUnknown = true)
     data class DeviceProperties(
-        val bootedFromSnapshot: Boolean?,
-        val bootedSnapshotName: String?,
-        val ddiServicesAvailable: Boolean,
-        val developerModeStatus: String,
-        val hasInternalOSBuild: Boolean,
         val name: String,
-        val osBuildUpdate: String,
         val osVersionNumber: String,
-        val rootFileSystemIsWritable: Boolean
     )
 
     @JsonIgnoreProperties(ignoreUnknown = true)
     data class HardwareProperties(
-        val cpuType: CpuType,
-        val deviceType: String,
-        val ecid: String,
-        val hardwareModel: String,
-        val internalStorageCapacity: String?,
-        val isProductionFused: Boolean,
-        val marketingName: String,
-        val platform: String,
-        val productType: String,
-        val reality: String,
-        val serialNumber: String,
-        val supportedCPUTypes: List<CpuType>?,
-        val supportedDeviceFamilies: List<Int>?,
-        val thinningProductType: String,
         val udid: String
     )
-
-    @JsonIgnoreProperties(ignoreUnknown = true)
-    data class CpuType(
-        val name: String,
-        val subType: Int,
-        val type: Int
-    )
 }

maestro-ios-driver/src/main/kotlin/util/LocalIOSDevice.kt

@@ -1,10 +1,26 @@
 package util
 
+import com.fasterxml.jackson.databind.DeserializationFeature
+import com.fasterxml.jackson.module.kotlin.KotlinFeature
+import com.fasterxml.jackson.module.kotlin.KotlinModule
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import com.fasterxml.jackson.module.kotlin.readValue
 import java.io.File
 
-object LocalIOSDevice {
+class DeviceCtlProcess {
+
+    fun devicectlDevicesOutput(): File {
+        val tempOutput = File.createTempFile("devicectl_response", ".json")
+        ProcessBuilder(listOf("xcrun", "devicectl", "--json-output", tempOutput.path, "list", "devices"))
+            .redirectError(ProcessBuilder.Redirect.PIPE).start().apply {
+                waitFor()
+            }
+
+        return tempOutput
+    }
+}
+
+class LocalIOSDevice(private val deviceCtlProcess: DeviceCtlProcess = DeviceCtlProcess()) {
 
     fun uninstall(deviceId: String, bundleIdentifier: String) {
         CommandLineUtils.runCommand(
@@ -31,7 +47,9 @@ object LocalIOSDevice {
             val bytes = tempOutput.readBytes()
             val response = String(bytes)
 
-            val deviceCtlResponse = jacksonObjectMapper().readValue<DeviceCtlResponse>(response)
+            val jacksonObjectMapper = jacksonObjectMapper()
+            jacksonObjectMapper.configure(DeserializationFeature.FAIL_ON_MISSING_CREATOR_PROPERTIES, false)
+            val deviceCtlResponse = jacksonObjectMapper.readValue<DeviceCtlResponse>(response)
             return deviceCtlResponse.result.devices.find {
                 it.hardwareProperties.udid == deviceId
             } ?: throw IllegalArgumentException("iOS device with identifier $deviceId not connected or available")
@@ -41,12 +59,8 @@ object LocalIOSDevice {
     }
 
     fun listDeviceViaDeviceCtl(): List<DeviceCtlResponse.Device> {
-        val tempOutput = File.createTempFile("devicectl_response", ".json")
+        val tempOutput = deviceCtlProcess.devicectlDevicesOutput()
         try {
-            ProcessBuilder(listOf("xcrun" , "devicectl", "--json-output", tempOutput.path, "list", "devices"))
-                .redirectError(ProcessBuilder.Redirect.PIPE).start().apply {
-                    waitFor()
-                }
             val bytes = tempOutput.readBytes()
             val response = String(bytes)