Headless mode for Web

mobile-dev-inc · Jan 10, 2025 · 083e3b6 · 083e3b6
1 parent 30f7363
commit 083e3b6
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 16 deletions.
diff --git a/maestro-cli/src/main/java/maestro/cli/command/TestCommand.kt b/maestro-cli/src/main/java/maestro/cli/command/TestCommand.kt
@@ -150,6 +150,12 @@ class TestCommand : Callable<Int> {
     )
     private var excludeTags: List<String> = emptyList()
 
+    @Option(
+        names = ["--headless"],
+        description = ["(Web only) Run the tests in headless mode"],
+    )
+    private var headless: Boolean = false
+
     @CommandLine.Spec
     lateinit var commandSpec: CommandLine.Model.CommandSpec
 
@@ -300,6 +306,7 @@ class TestCommand : Callable<Int> {
             driverHostPort = driverHostPort,
             deviceId = deviceId,
             platform = parent?.platform,
+            isHeadless = headless,
         ) { session ->
             val maestro = session.maestro
             val device = session.device

diff --git a/maestro-cli/src/main/java/maestro/cli/session/MaestroSessionManager.kt b/maestro-cli/src/main/java/maestro/cli/session/MaestroSessionManager.kt
@@ -57,6 +57,7 @@ object MaestroSessionManager {
         deviceId: String?,
         platform: String? = null,
         isStudio: Boolean = false,
+        isHeadless: Boolean = isStudio,
         block: (MaestroSession) -> T,
     ): T {
         val selectedDevice = selectDevice(
@@ -89,6 +90,7 @@ object MaestroSessionManager {
                 selectedDevice.platform
             ),
             isStudio = isStudio,
+            isHeadless = isHeadless,
             driverHostPort = driverHostPort,
         )
         Runtime.getRuntime().addShutdownHook(thread(start = false) {
@@ -146,6 +148,7 @@ object MaestroSessionManager {
         selectedDevice: SelectedDevice,
         connectToExistingSession: Boolean,
         isStudio: Boolean,
+        isHeadless: Boolean,
         driverHostPort: Int?,
     ): MaestroSession {
         return when {
@@ -163,7 +166,7 @@ object MaestroSessionManager {
                         driverHostPort,
                     )
 
-                    Platform.WEB -> pickWebDevice(isStudio)
+                    Platform.WEB -> pickWebDevice(isStudio, isHeadless)
                 },
                 device = selectedDevice.device,
             )
@@ -188,7 +191,7 @@ object MaestroSessionManager {
             )
 
             selectedDevice.platform == Platform.WEB -> MaestroSession(
-                maestro = pickWebDevice(isStudio),
+                maestro = pickWebDevice(isStudio, isHeadless),
                 device = null
             )
 
@@ -316,8 +319,8 @@ object MaestroSessionManager {
         )
     }
 
-    private fun pickWebDevice(isStudio: Boolean): Maestro {
-        return Maestro.web(isStudio)
+    private fun pickWebDevice(isStudio: Boolean, isHeadless: Boolean): Maestro {
+        return Maestro.web(isStudio, isHeadless)
     }
 
     private data class SelectedDevice(

diff --git a/maestro-client/src/main/java/maestro/Maestro.kt b/maestro-client/src/main/java/maestro/Maestro.kt
@@ -634,7 +634,10 @@ class Maestro(
             return Maestro(driver)
         }
 
-        fun web(isStudio: Boolean): Maestro {
+        fun web(
+            isStudio: Boolean,
+            isHeadless: Boolean,
+        ): Maestro {
             // Check that JRE is at least 11
             val version = System.getProperty("java.version")
             if (version.startsWith("1.")) {
@@ -646,7 +649,10 @@ class Maestro(
                 }
             }
 
-            val driver = WebDriver(isStudio)
+            val driver = WebDriver(
+                isStudio = isStudio,
+                isHeadless = isHeadless,
+            )
             driver.open()
             return Maestro(driver)
         }

diff --git a/maestro-client/src/main/java/maestro/drivers/WebDriver.kt b/maestro-client/src/main/java/maestro/drivers/WebDriver.kt
@@ -37,7 +37,8 @@ import java.util.*
 
 class WebDriver(
     val isStudio: Boolean,
-    private val seleniumFactory: SeleniumFactory = ChromeSeleniumFactory()
+    isHeadless: Boolean = isStudio,
+    private val seleniumFactory: SeleniumFactory = ChromeSeleniumFactory(isHeadless = isHeadless)
 ) : Driver {
 
     private var seleniumDriver: org.openqa.selenium.WebDriver? = null
@@ -60,7 +61,7 @@ class WebDriver(
     }
 
     override fun open() {
-        seleniumDriver = seleniumFactory.create(isStudio)
+        seleniumDriver = seleniumFactory.create()
 
         try {
             seleniumDriver

diff --git a/maestro-web/src/main/kotlin/maestro/web/selenium/ChromeSeleniumFactory.kt b/maestro-web/src/main/kotlin/maestro/web/selenium/ChromeSeleniumFactory.kt
@@ -8,11 +8,11 @@ import org.openqa.selenium.chromium.ChromiumDriverLogLevel
 import java.util.logging.Level
 import java.util.logging.Logger
 
-class ChromeSeleniumFactory : SeleniumFactory {
+class ChromeSeleniumFactory(
+    private val isHeadless: Boolean
+) : SeleniumFactory {
 
-    override fun create(
-        isStudio: Boolean
-    ): WebDriver {
+    override fun create(): WebDriver {
         System.setProperty("webdriver.chrome.silentOutput", "true")
         System.setProperty(ChromeDriverService.CHROME_DRIVER_SILENT_OUTPUT_PROPERTY, "true")
         Logger.getLogger("org.openqa.selenium").level = Level.OFF
@@ -28,7 +28,7 @@ class ChromeSeleniumFactory : SeleniumFactory {
                 addArguments("--remote-allow-origins=*")
                 addArguments("--disable-search-engine-choice-screen")
                 addArguments("--lang=en")
-                if (isStudio) {
+                if (isHeadless) {
                     addArguments("--headless=new")
                     addArguments("--window-size=1024,768")
                     setExperimentalOption("detach", true)

diff --git a/maestro-web/src/main/kotlin/maestro/web/selenium/SeleniumFactory.kt b/maestro-web/src/main/kotlin/maestro/web/selenium/SeleniumFactory.kt
@@ -4,8 +4,6 @@ import org.openqa.selenium.WebDriver
 
 interface SeleniumFactory {
 
-    fun create(
-        isStudio: Boolean = false
-    ): WebDriver
+    fun create(): WebDriver
 
 }