feat(android): add support android:mock_location (#989)

* feat(android): add support android:mock_location * feat(android): android:mock_location is only for application package --------- Co-authored-by: eugene_matsyuk <[email protected]>
MarathonLabs · Dec 14, 2024 · 39fb827 · 39fb827
1 parent eb63e88
commit 39fb827
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 1 deletion.
diff --git a/configuration/src/main/kotlin/com/malinskiy/marathon/config/vendor/VendorConfiguration.kt b/configuration/src/main/kotlin/com/malinskiy/marathon/config/vendor/VendorConfiguration.kt
@@ -38,6 +38,7 @@ const val DEFAULT_APPLICATION_PM_CLEAR = false
 const val DEFAULT_TEST_APPLICATION_PM_CLEAR = false
 const val DEFAULT_INSTALL_OPTIONS = ""
 const val DEFAULT_WAIT_FOR_DEVICES_TIMEOUT = 30000L
+const val DEFAULT_MOCK_LOCATION = false
 
 @JsonTypeInfo(
     use = JsonTypeInfo.Id.NAME,
@@ -77,6 +78,7 @@ sealed class VendorConfiguration {
         @JsonProperty("adbServers") val adbServers: List<AdbEndpoint> = listOf(AdbEndpoint()),
         @JsonProperty("disableWindowAnimation") val disableWindowAnimation: Boolean = DEFAULT_DISABLE_WINDOW_ANIMATION,
         @JsonProperty("profilingConfiguration") val profilingConfiguration: ProfilingConfiguration = ProfilingConfiguration(),
+        @JsonProperty("mockLocation") val mockLocation: Boolean = DEFAULT_MOCK_LOCATION
     ) : VendorConfiguration() {
         fun safeAndroidSdk(): File = androidSdk ?: throw ConfigurationException("No android SDK path specified")
 
@@ -125,6 +127,8 @@ sealed class VendorConfiguration {
         var testAccessConfiguration: TestAccessConfiguration = TestAccessConfiguration()
         var adbServers: List<AdbEndpoint> = listOf(AdbEndpoint())
         var disableWindowAnimation: Boolean = DEFAULT_DISABLE_WINDOW_ANIMATION
+        var profilingConfiguration: ProfilingConfiguration = ProfilingConfiguration()
+        var mockLocation: Boolean = DEFAULT_MOCK_LOCATION
 
         fun build() = AndroidConfiguration(
             androidSdk,
@@ -149,7 +153,9 @@ sealed class VendorConfiguration {
             testParserConfiguration,
             testAccessConfiguration,
             adbServers,
-            disableWindowAnimation
+            disableWindowAnimation,
+            profilingConfiguration,
+            mockLocation,
         )
     }
 

diff --git a/docs/runner/android/configure.md b/docs/runner/android/configure.md
@@ -1089,6 +1089,21 @@ marathon {
 </TabItem>
 </Tabs>
 
+### Location mock access
+Some tests require mocking device location. Marathon can setup access for application package if you enable this option as following:
+
+<Tabs>
+<TabItem value="YAML" label="Marathonfile">
+
+```yaml
+vendorConfiguration:
+  type: "Android"
+  mockLocation: true
+```
+
+</TabItem>
+</Tabs>
+
 [1]: https://developer.android.com/studio/
 
 [2]: https://developer.android.com/studio/command-line/adb#issuingcommands

diff --git a/vendor/vendor-android/src/main/kotlin/com/malinskiy/marathon/android/AndroidAppInstaller.kt b/vendor/vendor-android/src/main/kotlin/com/malinskiy/marathon/android/AndroidAppInstaller.kt
@@ -41,6 +41,7 @@ class AndroidAppInstaller(configuration: Configuration) {
                 }
             }
             reinstall(device, applicationInfo.applicationPackage, applicationApk, bundle.splitApks ?: emptyList())
+            appops(device, applicationInfo.applicationPackage)
         }
 
         bundle.extraApplications?.let { extraApplications ->
@@ -56,6 +57,23 @@ class AndroidAppInstaller(configuration: Configuration) {
         logger.debug { "Prepare installation finished for ${device.serialNumber}" }
     }
 
+    private suspend fun appops(device: AndroidDevice, applicationPackage: String) {
+        if (androidConfiguration.mockLocation) {
+            if (device.apiLevel < 23) {
+                logger.warn { "Can't setup mock location: device ${device.serialNumber} doesn't support appops" }
+                return
+            }
+
+            val appopsMessage = device.criticalExecuteShellCommand("appops set $applicationPackage android:mock_location allow")
+            appopsMessage.let {
+                if (it.exitCode != 0) {
+                    val (output, _) = device.criticalExecuteShellCommand("appops query-op android:mock_location allow")
+                    logger.error { "Can't set android:mock_location on $applicationPackage. List of apps currently using android:mock_location:$output" }
+                }
+            }
+        }
+    }
+
     /**
      * @throws DeviceSetupException if unable to reinstall (even with retries)
      */