Add setOrientation command

maestro-client/src/main/java/maestro/DeviceOrientation.kt

@@ -0,0 +1,31 @@
+package maestro
+
+enum class DeviceOrientation {
+    PORTRAIT,
+    LANDSCAPE_LEFT,
+    LANDSCAPE_RIGHT,
+    UPSIDE_DOWN;
+
+    // Return the camelCase representation of the enum name, for example "landscapeLeft"
+    val camelCaseName: String
+        get() = name.split("_")
+            .mapIndexed { index, part ->
+                if (index == 0) part.lowercase()
+                else part.lowercase().capitalize()
+            }
+            .joinToString("")
+
+    companion object {
+        // Support lookup of enum value by name, ignoring underscores and case. This allow inputs like
+        // "LANDSCAPE_LEFT" or "landscapeLeft" to both be matched to the LANDSCAPE_LEFT enum value.
+        fun getByName(name: String): DeviceOrientation? {
+            return values().find { 
+                comparableName(it.name) == comparableName(name)
+            }
+        }
+
+        private fun comparableName(name: String): String {
+            return name.lowercase().replace("_", "")
+        }
+    }
+}

maestro-client/src/main/java/maestro/Driver.kt

@@ -79,6 +79,8 @@ interface Driver {
 
     fun setLocation(latitude: Double, longitude: Double)
 
+    fun setOrientation(orientation: DeviceOrientation)
+
     fun eraseText(charactersToErase: Int)
 
     fun setProxy(host: String, port: Int)

maestro-client/src/main/java/maestro/Maestro.kt

@@ -567,6 +567,16 @@ class Maestro(
         driver.setLocation(latitude.toDouble(), longitude.toDouble())
     }
 
+    fun setOrientation(orientation: DeviceOrientation, waitForAppToSettle: Boolean = true) {
+        LOGGER.info("Setting orientation: $orientation")
+
+        driver.setOrientation(orientation)
+
+        if (waitForAppToSettle) {
+            waitForAppToSettle()
+        }
+    }
+
     fun eraseText(charactersToErase: Int) {
         LOGGER.info("Erasing $charactersToErase characters")
 

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

@@ -601,6 +601,18 @@ class AndroidDriver(
         }
     }
 
+    override fun setOrientation(orientation: DeviceOrientation) {
+        // Disable accelerometer based rotation before overriding orientation
+        dadb.shell("settings put system accelerometer_rotation 0")
+
+        when(orientation) {
+            DeviceOrientation.PORTRAIT -> dadb.shell("settings put system user_rotation 0")
+            DeviceOrientation.LANDSCAPE_LEFT -> dadb.shell("settings put system user_rotation 1")
+            DeviceOrientation.UPSIDE_DOWN -> dadb.shell("settings put system user_rotation 2")
+            DeviceOrientation.LANDSCAPE_RIGHT -> dadb.shell("settings put system user_rotation 3")
+        }
+    }
+
     override fun eraseText(charactersToErase: Int) {
         runDeviceCall {
             blockingStubWithTimeout.eraseAllText(

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

@@ -382,6 +382,12 @@ class IOSDriver(
         iosDevice.setLocation(latitude, longitude).expect {}
     }
 
+    override fun setOrientation(orientation: DeviceOrientation) {
+        runDeviceCall {
+            iosDevice.setOrientation(orientation.camelCaseName)
+        }
+    }
+
     override fun eraseText(charactersToErase: Int) {
         runDeviceCall { iosDevice.eraseText(charactersToErase) }
     }

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

@@ -2,6 +2,7 @@ package maestro.drivers
 
 import maestro.Capability
 import maestro.DeviceInfo
+import maestro.DeviceOrientation
 import maestro.Driver
 import maestro.KeyCode
 import maestro.Maestro
@@ -343,6 +344,10 @@ class WebDriver(val isStudio: Boolean) : Driver {
         TODO("Not yet implemented")
     }
 
+    override fun setOrientation(orientation: DeviceOrientation) {
+        // no-op for web
+    }
+
     override fun eraseText(charactersToErase: Int) {
         val driver = ensureOpen()
 

maestro-ios-driver/src/main/kotlin/xcuitest/XCTestDriverClient.kt

@@ -161,6 +161,10 @@ class XCTestDriverClient(
         ))
     }
 
+    fun setOrientation(orientation: String) {
+        executeJsonRequest("setOrientation", SetOrientationRequest(orientation))
+    }
+
     fun pressKey(name: String) {
         executeJsonRequest("pressKey", PressKeyRequest(name))
     }

maestro-ios-driver/src/main/kotlin/xcuitest/api/SetOrientationRequest.kt

@@ -0,0 +1,3 @@
+package xcuitest.api
+
+data class SetOrientationRequest(val orientation: String)

maestro-ios-xctest-runner/maestro-driver-ios.xcodeproj/project.pbxproj

@@ -28,6 +28,8 @@
 		52F0B1B32B3C26DF00C6471A /* KeyboardHandlerRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 52F0B1B22B3C26DF00C6471A /* KeyboardHandlerRequest.swift */; };
 		52F0B1B52B3C27F700C6471A /* KeyboardHandlerResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 52F0B1B42B3C27F700C6471A /* KeyboardHandlerResponse.swift */; };
 		52F33A942AE6823100692902 /* StatusResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 52F33A932AE6823100692902 /* StatusResponse.swift */; };
+		5B8E0ABC2CD562D000E9D439 /* SetOrientationHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5B8E0ABB2CD562D000E9D439 /* SetOrientationHandler.swift */; };
+		5B8E0ABE2CD562F200E9D439 /* SetOrientationRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5B8E0ABD2CD562F200E9D439 /* SetOrientationRequest.swift */; };
 		610D58F92A45B5DA00B4BBEB /* ViewHierarchyHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = 610D58F82A45B5DA00B4BBEB /* ViewHierarchyHandler.swift */; };
 		610D58FB2A49E3CA00B4BBEB /* AXClientSwizzler.swift in Sources */ = {isa = PBXBuildFile; fileRef = 610D58FA2A49E3CA00B4BBEB /* AXClientSwizzler.swift */; };
 		6124329C2A4B368100F5F619 /* ViewHierarchyRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6124329B2A4B368100F5F619 /* ViewHierarchyRequest.swift */; };
@@ -98,6 +100,8 @@
 		52F0B1B22B3C26DF00C6471A /* KeyboardHandlerRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = KeyboardHandlerRequest.swift; sourceTree = "<group>"; };
 		52F0B1B42B3C27F700C6471A /* KeyboardHandlerResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = KeyboardHandlerResponse.swift; sourceTree = "<group>"; };
 		52F33A932AE6823100692902 /* StatusResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatusResponse.swift; sourceTree = "<group>"; };
+		5B8E0ABB2CD562D000E9D439 /* SetOrientationHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SetOrientationHandler.swift; sourceTree = "<group>"; };
+		5B8E0ABD2CD562F200E9D439 /* SetOrientationRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SetOrientationRequest.swift; sourceTree = "<group>"; };
 		610D58F82A45B5DA00B4BBEB /* ViewHierarchyHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewHierarchyHandler.swift; sourceTree = "<group>"; };
 		610D58FA2A49E3CA00B4BBEB /* AXClientSwizzler.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AXClientSwizzler.swift; sourceTree = "<group>"; };
 		6124329B2A4B368100F5F619 /* ViewHierarchyRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewHierarchyRequest.swift; sourceTree = "<group>"; };
@@ -226,6 +230,7 @@
 				32097964297092A800340282 /* InputTextRequest.swift */,
 				32ECCB252980449200A1A0A0 /* TouchRequest.swift */,
 				61C0AFE429C7AAB3005D1FC5 /* PressKeyRequest.swift */,
+				5B8E0ABD2CD562F200E9D439 /* SetOrientationRequest.swift */,
 				61C0AFE829C86378005D1FC5 /* PressButtonRequest.swift */,
 				61C0AFEE29C8961F005D1FC5 /* EraseTextRequest.swift */,
 				61C0AFF229C8C040005D1FC5 /* DeviceInfoResponse.swift */,
@@ -268,6 +273,7 @@
 				61C0AFEA29C863BB005D1FC5 /* PressButtonHandler.swift */,
 				61C0AFEC29C88926005D1FC5 /* EraseTextHandler.swift */,
 				61C0AFF029C8C01F005D1FC5 /* DeviceInfoHandler.swift */,
+				5B8E0ABB2CD562D000E9D439 /* SetOrientationHandler.swift */,
 				945DD44C29D6F73B004D8ECF /* SetPermissionsHandler.swift */,
 				52047F772A7A638E00BF982D /* StatusHandler.swift */,
 				52F0B1B02B3C25BC00C6471A /* KeyboardRouteHandler.swift */,
@@ -429,10 +435,12 @@
 				52F33A942AE6823100692902 /* StatusResponse.swift in Sources */,
 				610D58FB2A49E3CA00B4BBEB /* AXClientSwizzler.swift in Sources */,
 				F328D3E62A2A98E7000546D3 /* StringExtensions.swift in Sources */,
+				5B8E0ABC2CD562D000E9D439 /* SetOrientationHandler.swift in Sources */,
 				61C0AFEF29C8961F005D1FC5 /* EraseTextRequest.swift in Sources */,
 				61A79B9729DF0B8A00C38882 /* SwipeRouteHandlerV2.swift in Sources */,
 				52F0B1B52B3C27F700C6471A /* KeyboardHandlerResponse.swift in Sources */,
 				52047F782A7A638E00BF982D /* StatusHandler.swift in Sources */,
+				5B8E0ABE2CD562F200E9D439 /* SetOrientationRequest.swift in Sources */,
 				945DD44B29D6F5D8004D8ECF /* SetPermissionsRequest.swift in Sources */,
 				613E87DF299BE78400FF8551 /* KeyModifierFlags.swift in Sources */,
 				94A90DDE298AE72A006EB769 /* XCUIElement+Extensions.swift in Sources */,

maestro-ios-xctest-runner/maestro-driver-iosUITests/Routes/Handlers/SetOrientationHandler.swift

@@ -0,0 +1,21 @@
+import Foundation
+import FlyingFox
+import os
+import XCTest
+
+@MainActor
+struct SetOrientationHandler: HTTPHandler {
+    private let logger = Logger(
+        subsystem: Bundle.main.bundleIdentifier!,
+        category: String(describing: Self.self)
+    )
+
+    func handleRequest(_ request: HTTPRequest) async throws -> HTTPResponse {
+        guard let requestBody = try? JSONDecoder().decode(SetOrientationRequest.self, from: request.body) else {
+            return AppError(type: .precondition, message: "incorrect request body provided for set orientation").httpResponse
+        }
+
+        XCUIDevice.shared.orientation = requestBody.orientation.uiDeviceOrientation
+        return HTTPResponse(statusCode: .ok)
+    }
+}

maestro-ios-xctest-runner/maestro-driver-iosUITests/Routes/Models/SetOrientationRequest.swift

@@ -0,0 +1,26 @@
+import Foundation
+import UIKit
+
+struct SetOrientationRequest: Codable {
+    let orientation: Orientation
+
+    enum Orientation: String, Codable {
+        case portrait
+        case landscapeLeft
+        case landscapeRight
+        case upsideDown
+
+        var uiDeviceOrientation: UIDeviceOrientation {
+            switch self {
+            case .portrait:
+                return .portrait
+            case .landscapeLeft:
+                return .landscapeLeft
+            case .landscapeRight:
+                return .landscapeRight
+            case .upsideDown:
+                return .portraitUpsideDown
+            }
+        }
+    }
+}

maestro-ios-xctest-runner/maestro-driver-iosUITests/Routes/RouteHandlerFactory.swift

@@ -26,6 +26,8 @@ class RouteHandlerFactory {
             return EraseTextHandler()
         case .deviceInfo:
             return DeviceInfoHandler()
+        case .setOrientation:
+            return SetOrientationHandler()
         case .setPermissions:
             return SetPermissionsHandler()
         case .viewHierarchy:

maestro-ios-xctest-runner/maestro-driver-iosUITests/Routes/XCTestHTTPServer.swift

@@ -13,6 +13,7 @@ enum Route: String, CaseIterable {
     case pressButton
     case eraseText
     case deviceInfo
+    case setOrientation
     case setPermissions
     case viewHierarchy
     case status

maestro-ios/src/main/java/ios/IOSDevice.kt

@@ -131,6 +131,13 @@ interface IOSDevice : AutoCloseable {
      */
     fun setLocation(latitude: Double, longitude: Double): Result<Unit, Throwable>
 
+    /**
+     * Sets the device's orientation.
+     *
+     * @param link - link to open
+     */
+    fun setOrientation(orientation: String)
+
     /**
      * @return true if the connection to the device (not device itself) is shut down
      */

maestro-ios/src/main/java/ios/LocalIOSDevice.kt

@@ -130,6 +130,10 @@ class LocalIOSDevice(
         return simctlIOSDevice.setLocation(latitude, longitude)
     }
 
+    override fun setOrientation(orientation: String) {
+        return xcTestDevice.setOrientation(orientation)
+    }
+
     override fun isShutdown(): Boolean {
         return xcTestDevice.isShutdown()
     }

maestro-ios/src/main/java/ios/simctl/SimctlIOSDevice.kt

@@ -152,6 +152,10 @@ class SimctlIOSDevice(
         }
     }
 
+    override fun setOrientation(orientation: String) {
+        TODO("Not yet implemented")
+    }
+
     override fun isShutdown(): Boolean {
         TODO("Not yet implemented")
     }

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

@@ -176,6 +176,10 @@ class XCTestIOSDevice(
         error("Not supported")
     }
 
+    override fun setOrientation(orientation: String) {
+        execute { client.setOrientation(orientation) }
+    }
+
     override fun isShutdown(): Boolean {
         return !client.isChannelAlive()
     }

maestro-orchestra-models/src/main/java/maestro/orchestra/Commands.kt

@@ -19,6 +19,7 @@
 
 package maestro.orchestra
 
+import maestro.DeviceOrientation
 import maestro.KeyCode
 import maestro.Point
 import maestro.ScrollDirection
@@ -758,6 +759,21 @@ data class SetLocationCommand(
     }
 }
 
+data class SetOrientationCommand(
+    val orientation: DeviceOrientation,
+    override val label: String? = null,
+    override val optional: Boolean = false,
+) : Command {
+
+    override fun description(): String {
+        return label ?: "Set orientation ${orientation}"
+    }
+
+    override fun evaluateScripts(jsEngine: JsEngine): SetOrientationCommand {
+        return this
+    }
+}
+
 data class RepeatCommand(
     val times: String? = null,
     val condition: Condition? = null,

maestro-orchestra-models/src/main/java/maestro/orchestra/MaestroCommand.kt

@@ -53,6 +53,7 @@ data class MaestroCommand(
     val clearKeychainCommand: ClearKeychainCommand? = null,
     val runFlowCommand: RunFlowCommand? = null,
     val setLocationCommand: SetLocationCommand? = null,
+    var setOrientationCommand: SetOrientationCommand? = null,
     val repeatCommand: RepeatCommand? = null,
     val copyTextCommand: CopyTextFromCommand? = null,
     val pasteTextCommand: PasteTextCommand? = null,
@@ -95,6 +96,7 @@ data class MaestroCommand(
         clearKeychainCommand = command as? ClearKeychainCommand,
         runFlowCommand = command as? RunFlowCommand,
         setLocationCommand = command as? SetLocationCommand,
+        setOrientationCommand = command as? SetOrientationCommand,
         repeatCommand = command as? RepeatCommand,
         copyTextCommand = command as? CopyTextFromCommand,
         pasteTextCommand = command as? PasteTextCommand,
@@ -137,6 +139,7 @@ data class MaestroCommand(
         clearKeychainCommand != null -> clearKeychainCommand
         runFlowCommand != null -> runFlowCommand
         setLocationCommand != null -> setLocationCommand
+        setOrientationCommand != null -> setOrientationCommand
         repeatCommand != null -> repeatCommand
         copyTextCommand != null -> copyTextCommand
         pasteTextCommand != null -> pasteTextCommand

maestro-orchestra/src/main/java/maestro/orchestra/Orchestra.kt

@@ -283,6 +283,7 @@ class Orchestra(
             is ClearKeychainCommand -> clearKeychainCommand()
             is RunFlowCommand -> runFlowCommand(command, config)
             is SetLocationCommand -> setLocationCommand(command)
+            is SetOrientationCommand -> setOrientationCommand(command)
             is RepeatCommand -> repeatCommand(command, maestroCommand, config)
             is DefineVariablesCommand -> defineVariablesCommand(command)
             is RunScriptCommand -> runScriptCommand(command)
@@ -449,6 +450,12 @@ class Orchestra(
         return true
     }
 
+    private fun setOrientationCommand(command: SetOrientationCommand): Boolean {
+        maestro.setOrientation(command.orientation)
+
+        return true
+    }
+
     private fun clearAppStateCommand(command: ClearStateCommand): Boolean {
         maestro.clearAppState(command.appId)
         // Android's clear command also resets permissions

maestro-orchestra/src/main/java/maestro/orchestra/yaml/YamlFluentCommand.kt

@@ -20,6 +20,7 @@
 package maestro.orchestra.yaml
 
 import com.fasterxml.jackson.annotation.JsonCreator
+import maestro.DeviceOrientation
 import maestro.KeyCode
 import maestro.Point
 import maestro.TapRepeat
@@ -67,6 +68,7 @@ data class YamlFluentCommand(
     val clearState: YamlClearState? = null,
     val runFlow: YamlRunFlow? = null,
     val setLocation: YamlSetLocation? = null,
+    val setOrientation: YamlSetOrientation? = null,
     val repeat: YamlRepeatCommand? = null,
     val copyTextFrom: YamlElementSelectorUnion? = null,
     val runScript: YamlRunScript? = null,
@@ -206,6 +208,15 @@ data class YamlFluentCommand(
                     )
                 )
             )
+            setOrientation != null -> listOf(
+                MaestroCommand(
+                    SetOrientationCommand(
+                        orientation = DeviceOrientation.getByName(setOrientation.orientation) ?: throw SyntaxError("Unknown orientation: $setOrientation"),
+                        label = setOrientation.label,
+                        optional = setOrientation.optional,
+                    )
+                )
+            )
             repeat != null -> listOf(
                 repeatCommand(repeat, flowPath, appId)
             )