Add SetPermissions command (mobile-dev-inc#2775)

Fishbowler · web-flow · commit 8c24ce06c9c8 · 2025-12-08T13:45:30.000Z
* Add setPermissions command

* Improve Android permissions call and catch block
diff --git a/maestro-client/src/main/java/maestro/Errors.kt b/maestro-client/src/main/java/maestro/Errors.kt
@@ -25,6 +25,8 @@ sealed class MaestroException(override val message: String, cause: Throwable? =
 
     class UnableToClearState(message: String, cause: Throwable? = null) : MaestroException(message, cause)
 
+    class UnableToSetPermissions(message: String, cause: Throwable? = null) : MaestroException(message, cause)
+
     class AppCrash(message: String, cause: Throwable? = null): MaestroException(message, cause)
 
     class DriverTimeout(message: String, val debugMessage: String? = null, cause: Throwable? = null): MaestroException(message, cause)
diff --git a/maestro-client/src/main/java/maestro/drivers/AndroidDriver.kt b/maestro-client/src/main/java/maestro/drivers/AndroidDriver.kt
@@ -926,9 +926,11 @@ class AndroidDriver(
 
     private fun setPermissionInternal(appId: String, permission: String, permissionValue: String) {
         try {
-            dadb.shell("pm $permissionValue $appId $permission")
+            shell("pm $permissionValue $appId $permission")
         } catch (exception: Exception) {
-            /* no-op */
+            // We don't need to be loud about this. IOExceptions were caught in shell. Remaining issues are likely due
+            // to "all" containing permissions that the app doesn't support.
+            logger.debug("Failed to set permission $permission for app $appId: ${exception.message}")
         }
     }
 
diff --git a/maestro-orchestra-models/src/main/java/maestro/orchestra/Commands.kt b/maestro-orchestra-models/src/main/java/maestro/orchestra/Commands.kt
@@ -520,6 +520,24 @@ data class LaunchAppCommand(
     }
 }
 
+data class SetPermissionsCommand(
+    val appId: String,
+    var permissions: Map<String, String>,
+    override val label: String? = null,
+    override val optional: Boolean = false,
+) : Command {
+
+    override val originalDescription: String
+        get() = "Set permissions"
+
+    override fun evaluateScripts(jsEngine: JsEngine): SetPermissionsCommand {
+        return copy(
+            appId = appId.evaluateScripts(jsEngine),
+            label = label?.evaluateScripts(jsEngine)
+        )
+    }
+}
+
 data class ApplyConfigurationCommand(
     val config: MaestroConfig,
     override val label: String? = null,
diff --git a/maestro-orchestra-models/src/main/java/maestro/orchestra/MaestroCommand.kt b/maestro-orchestra-models/src/main/java/maestro/orchestra/MaestroCommand.kt
@@ -42,6 +42,7 @@ data class MaestroCommand(
     val inputTextCommand: InputTextCommand? = null,
     val inputRandomTextCommand: InputRandomCommand? = null,
     val launchAppCommand: LaunchAppCommand? = null,
+    val setPermissionsCommand: SetPermissionsCommand? = null,
     val applyConfigurationCommand: ApplyConfigurationCommand? = null,
     val openLinkCommand: OpenLinkCommand? = null,
     val pressKeyCommand: PressKeyCommand? = null,
@@ -87,6 +88,7 @@ data class MaestroCommand(
         inputTextCommand = command as? InputTextCommand,
         inputRandomTextCommand = command as? InputRandomCommand,
         launchAppCommand = command as? LaunchAppCommand,
+        setPermissionsCommand = command as? SetPermissionsCommand,
         applyConfigurationCommand = command as? ApplyConfigurationCommand,
         openLinkCommand = command as? OpenLinkCommand,
         pressKeyCommand = command as? PressKeyCommand,
@@ -132,6 +134,7 @@ data class MaestroCommand(
         inputTextCommand != null -> inputTextCommand
         inputRandomTextCommand != null -> inputRandomTextCommand
         launchAppCommand != null -> launchAppCommand
+        setPermissionsCommand != null -> setPermissionsCommand
         applyConfigurationCommand != null -> applyConfigurationCommand
         openLinkCommand != null -> openLinkCommand
         pressKeyCommand != null -> pressKeyCommand
diff --git a/maestro-orchestra/src/main/java/maestro/orchestra/Orchestra.kt b/maestro-orchestra/src/main/java/maestro/orchestra/Orchestra.kt
@@ -344,6 +344,7 @@ class Orchestra(
             is InputTextCommand -> inputTextCommand(command)
             is InputRandomCommand -> inputTextRandomCommand(command)
             is LaunchAppCommand -> launchAppCommand(command)
+            is SetPermissionsCommand -> setPermissionsCommand(command)
             is OpenLinkCommand -> openLinkCommand(command, config)
             is PressKeyCommand -> pressKeyCommand(command)
             is EraseTextCommand -> eraseTextCommand(command)
@@ -993,14 +994,18 @@ class Orchestra(
             if (command.clearState == true) {
                 maestro.clearAppState(command.appId)
             }
+        } catch (e: Exception) {
+            logger.error("Failed to clear state", e)
+            throw MaestroException.UnableToClearState("Unable to clear state for app ${command.appId}: ${e.message}", e)
+        }
 
+        try {
             // For testing convenience, default to allow all on app launch
             val permissions = command.permissions ?: mapOf("all" to "allow")
             maestro.setPermissions(command.appId, permissions)
-
         } catch (e: Exception) {
-            logger.error("Failed to clear state", e)
-            throw MaestroException.UnableToClearState("Unable to clear state for app ${command.appId}", cause = e)
+            logger.error("Failed to set permissions", e)
+            throw MaestroException.UnableToSetPermissions("Unable to set permissions for app ${command.appId}: ${e.message}", e)
         }
 
         try {
@@ -1017,6 +1022,16 @@ class Orchestra(
         return true
     }
 
+    private fun setPermissionsCommand(command: SetPermissionsCommand): Boolean {
+        try {
+            maestro.setPermissions(command.appId, command.permissions)
+        } catch (e: Exception) {
+            throw MaestroException.UnableToSetPermissions("Unable to set permissions for app ${command.appId}: ${e.message}", e)
+        }
+
+        return true
+    }
+
     private fun clearKeychainCommand(): Boolean {
         maestro.clearKeychain()
 
diff --git a/maestro-orchestra/src/main/java/maestro/orchestra/yaml/YamlFluentCommand.kt b/maestro-orchestra/src/main/java/maestro/orchestra/yaml/YamlFluentCommand.kt
@@ -60,6 +60,7 @@ import maestro.orchestra.ScrollUntilVisibleCommand
 import maestro.orchestra.SetAirplaneModeCommand
 import maestro.orchestra.SetLocationCommand
 import maestro.orchestra.SetOrientationCommand
+import maestro.orchestra.SetPermissionsCommand
 import maestro.orchestra.StartRecordingCommand
 import maestro.orchestra.StopAppCommand
 import maestro.orchestra.StopRecordingCommand
@@ -109,6 +110,7 @@ data class YamlFluentCommand(
     val inputRandomCountryName: YamlInputRandomCountryName? = null,
     val inputRandomColorName: YamlInputRandomColorName? = null,
     val launchApp: YamlLaunchApp? = null,
+    val setPermissions: YamlSetPermissions? = null,
     val swipe: YamlSwipe? = null,
     val openLink: YamlOpenLink? = null,
     val openBrowser: String? = null,
@@ -151,6 +153,7 @@ data class YamlFluentCommand(
     private fun _toCommands(flowPath: Path, appId: String): List<MaestroCommand> {
         return when {
             launchApp != null -> listOf(launchApp(launchApp, appId))
+            setPermissions != null -> listOf(setPermissions(command = setPermissions, appId))
             tapOn != null -> listOf(tapCommand(tapOn))
             longPressOn != null -> listOf(tapCommand(longPressOn, longPress = true))
             assertVisible != null -> listOf(
@@ -706,6 +709,17 @@ data class YamlFluentCommand(
         )
     }
 
+    private fun setPermissions(command: YamlSetPermissions, appId: String): MaestroCommand {
+        return MaestroCommand(
+            SetPermissionsCommand(
+                appId = command.appId ?: appId,
+                permissions = command.permissions,
+                label = command.label,
+                optional = command.optional,
+            )
+        )
+    }
+
     private fun tapCommand(
         tapOn: YamlElementSelectorUnion,
         longPress: Boolean = false,
diff --git a/maestro-orchestra/src/main/java/maestro/orchestra/yaml/YamlSetPermissions.kt b/maestro-orchestra/src/main/java/maestro/orchestra/yaml/YamlSetPermissions.kt
@@ -0,0 +1,11 @@
+package maestro.orchestra.yaml
+
+import com.fasterxml.jackson.annotation.JsonAlias
+
+data class YamlSetPermissions(
+    @JsonAlias("url")
+    val appId: String?,
+    val permissions: Map<String, String>,
+    val label: String? = null,
+    val optional: Boolean = false,
+)
diff --git a/maestro-orchestra/src/test/java/maestro/orchestra/MaestroCommandSerializationTest.kt b/maestro-orchestra/src/test/java/maestro/orchestra/MaestroCommandSerializationTest.kt
@@ -350,6 +350,37 @@ internal class MaestroCommandSerializationTest {
             .isEqualTo(command)
     }
 
+    @Test
+    fun `serialize SetPermissionsCommand`() {
+        // given
+        val command = MaestroCommand(
+            SetPermissionsCommand("com.twitter.android", permissions = mapOf("all" to "deny", "notifications" to "unset"))
+        )
+
+        // when
+        val serializedCommandJson = command.toJson()
+        val deserializedCommand = objectMapper.readValue(serializedCommandJson, MaestroCommand::class.java)
+
+        // then
+        @Language("json")
+        val expectedJson = """
+            {
+              "setPermissionsCommand" : {
+                "appId" : "com.twitter.android",
+                "permissions" : {
+                  "all" : "deny",
+                  "notifications" : "unset"
+                },
+                "optional" : false
+              }
+            }
+          """.trimIndent()
+        assertThat(serializedCommandJson)
+            .isEqualTo(expectedJson)
+        assertThat(deserializedCommand)
+            .isEqualTo(command)
+    }
+
     @Test
     fun `serialize ApplyConfigurationCommand`() {
         // given
diff --git a/maestro-orchestra/src/test/java/maestro/orchestra/yaml/YamlCommandReaderTest.kt b/maestro-orchestra/src/test/java/maestro/orchestra/yaml/YamlCommandReaderTest.kt
@@ -42,6 +42,7 @@ import maestro.orchestra.ScrollCommand
 import maestro.orchestra.ScrollUntilVisibleCommand
 import maestro.orchestra.SetAirplaneModeCommand
 import maestro.orchestra.SetLocationCommand
+import maestro.orchestra.SetPermissionsCommand
 import maestro.orchestra.StartRecordingCommand
 import maestro.orchestra.StopAppCommand
 import maestro.orchestra.StopRecordingCommand
@@ -760,6 +761,21 @@ internal class YamlCommandReaderTest {
         assertThat(tapCommand.originalDescription).isEqualTo("Double tap on \"Submit\" at 50%, 90%")
     }
 
+    @Test
+    fun setPermissions(
+        @YamlFile("030_setPermissions.yaml") commands: List<Command>
+    ) {
+        assertThat(commands).containsExactly(
+            ApplyConfigurationCommand(MaestroConfig(
+                appId = "com.example.app",
+            )),
+            SetPermissionsCommand(
+                appId = "com.example.app",
+                permissions = mapOf("all" to "deny", "notifications" to "unset")
+            ),
+        )
+    }
+
 
     private fun commands(vararg commands: Command): List<MaestroCommand> =
         commands.map(::MaestroCommand).toList()
diff --git a/maestro-orchestra/src/test/resources/YamlCommandReaderTest/030_setPermissions.yaml b/maestro-orchestra/src/test/resources/YamlCommandReaderTest/030_setPermissions.yaml
@@ -0,0 +1,6 @@
+appId: com.example.app
+---
+- setPermissions:
+    permissions:
+      all: deny
+      notifications: unset
diff --git a/maestro-test/src/test/kotlin/maestro/test/IntegrationTest.kt b/maestro-test/src/test/kotlin/maestro/test/IntegrationTest.kt
@@ -4015,6 +4015,27 @@ class IntegrationTest {
         // No test failure - if we reach this point, the test passed successfully
     }
 
+    @Test
+    fun `Case 131 - Set Permissions on an installed app`() {
+        // Given
+        val commands = readCommands("131_setPermissions")
+
+        val driver = driver {
+        }
+        driver.addInstalledApp("com.example.app")
+
+        // When
+        Maestro(driver).use {
+            runBlocking {
+                orchestra(it).runFlow(commands)
+            }
+        }
+
+        // Then
+        // No test failure
+        driver.assertHasEvent(Event.SetPermissions(appId = "com.example.app", permissions = mapOf("all" to "deny", "notifications" to "unset")))
+    }
+
     private fun orchestra(
         maestro: Maestro,
     ) = Orchestra(
diff --git a/maestro-test/src/test/resources/131_setPermissions.yaml b/maestro-test/src/test/resources/131_setPermissions.yaml
@@ -0,0 +1,6 @@
+appId: com.example.app
+---
+- setPermissions:
+    permissions:
+      all: deny
+      notifications: unset

Original file line number	Diff line number	Diff line change
`@@ -926,9 +926,11 @@ class AndroidDriver(`
`926`	`926`
`927`	`927`	`private fun setPermissionInternal(appId: String, permission: String, permissionValue: String) {`
`928`	`928`	`try {`
`929`		`- dadb.shell("pm $permissionValue $appId $permission")`
	`929`	`+ shell("pm $permissionValue $appId $permission")`
`930`	`930`	`} catch (exception: Exception) {`
`931`		`- /* no-op */`
	`931`	`+ // We don't need to be loud about this. IOExceptions were caught in shell. Remaining issues are likely due`
	`932`	`+ // to "all" containing permissions that the app doesn't support.`
	`933`	`+ logger.debug("Failed to set permission $permission for app $appId: ${exception.message}")`
`932`	`934`	`}`
`933`	`935`	`}`
`934`	`936`