Wait for grid before connecting and pin docker images to selenium 4

bjuric · bjuric · commit e49e9bfcacfb · 2025-01-18T16:41:25.000+11:00
diff --git a/.sbtopts b/.sbtopts
@@ -2,4 +2,3 @@
 -J-Dsbt.sourcemode=true
 -J-Djansi.passthrough=true
 -J-Xshare:off
--J-Denv.TZ=Australia/Melbourne
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,11 @@
+4.2.3
+=====
+18 January 2025
+- Wait for grid service to be ready before connecting with remote web driver
+- Pin docker images to Selenium 4
+- Update Gwen core from v4.2.1 to v[4.2.2](https://github.com/gwen-interpreter/gwen/releases/tag/v4.2.2)
+  - Set env.TZ setting to default timezone if not already set
+
 4.2.2
 =====
 18 January 2025
diff --git a/build.sbt b/build.sbt
@@ -1,8 +1,8 @@
 enablePlugins(GitVersioning)
 
 // gwen core & web versions
-val gwenVersion = "4.2.1"
-val gwenWebVersion = "4.2.2"
+val gwenVersion = "4.2.2"
+val gwenWebVersion = "4.2.3"
 
 git.baseVersion := gwenWebVersion
 git.useGitDescribe := true
diff --git a/project-create.sh b/project-create.sh
@@ -0,0 +1,9 @@
+#!/bin/sh
+
+sbt universal:stage
+cd target
+rm -rf project
+mkdir project
+cd project
+yarn add -D @gweninterpreter/gwen-web || true
+../universal/stage/bin/gwen init --docker --jenkins
diff --git a/project-test.sh b/project-test.sh
@@ -1,19 +1,11 @@
 #!/bin/sh
 
-sbt universal:stage
-cd target
-rm -rf project
-mkdir project
-cd project
-yarn add -D @gweninterpreter/gwen-web
-../universal/stage/bin/gwen init --docker --jenkins
+./project-create.sh
+cd target/project
 ../universal/stage/bin/gwen -p samples --parallel -b
 ../universal/stage/bin/gwen --profile samples --dry-run --batch
 ../universal/stage/bin/gwen gwen/features/samples --parallel --dry-run
 GWEN_PROFILE=samples ../universal/stage/bin/gwen -bn
 cd ..
-if [ $# -eq 0 ]
-  then
-    rm -rf project
-fi
+rm -rf project
 cd ..
diff --git a/src/main/resources/gwen.conf b/src/main/resources/gwen.conf
@@ -114,9 +114,12 @@ gwen {
     }
     maximize = false
     remote {
+      # url = ""
       localFileDetector = auto    # auto|true|false
       sessionRetries = auto       # auto|true|false
-      # url = ""
+      connectTimeout {
+        seconds = 30
+      }
     }
     sendKeys {
       clearFirst = false
diff --git a/src/main/resources/init/conf/browsers/grid-arm.toml b/src/main/resources/init/conf/browsers/grid-arm.toml
@@ -2,8 +2,8 @@
 # Configs have a mapping between the Docker image to use and the capabilities that need to be matched to
 # start a container with the given image.
 configs = [
-   "selenium/standalone-chromium:latest", '{"browserName": "chrome"}',
-   "selenium/standalone-firefox:latest", '{"browserName": "firefox"}'
+   "selenium/standalone-chromium:4", '{"browserName": "chrome"}',
+   "selenium/standalone-firefox:4", '{"browserName": "firefox"}'
 ]
 
 host-config-keys = ["Dns", "DnsOptions", "DnsSearch", "ExtraHosts", "Binds", "Mounts"]
diff --git a/src/main/resources/init/conf/browsers/grid.conf b/src/main/resources/init/conf/browsers/grid.conf
@@ -22,6 +22,11 @@ gwen {
     }
     remote {
       url = "http://${env.SELENIUM_HUB}:4444/wd/hub"
+      localFileDetector = auto    # auto|true|false
+      sessionRetries = auto       # auto|true|false
+      connectTimeout {
+        seconds = 30
+      }
     }
   }
 }
diff --git a/src/main/resources/init/conf/browsers/grid.toml b/src/main/resources/init/conf/browsers/grid.toml
@@ -2,9 +2,9 @@
 # Configs have a mapping between the Docker image to use and the capabilities that need to be matched to
 # start a container with the given image.
 configs = [
-    "selenium/standalone-chrome:latest", '{"browserName": "chrome"}',
-    "selenium/standalone-edge:latest", '{"browserName": "edge"}',
-    "selenium/standalone-firefox:latest", '{"browserName": "firefox"}'
+    "selenium/standalone-chrome:4", '{"browserName": "chrome"}',
+    "selenium/standalone-edge:4", '{"browserName": "edge"}',
+    "selenium/standalone-firefox:4", '{"browserName": "firefox"}'
 ]
 
 host-config-keys = ["Dns", "DnsOptions", "DnsSearch", "ExtraHosts", "Binds", "Mounts"]
diff --git a/src/main/resources/init/docker-compose-arm.yml b/src/main/resources/init/docker-compose-arm.yml
@@ -1,7 +1,7 @@
 services:
 
   node-docker:
-    image: selenium/node-docker:latest
+    image: selenium/node-docker:4
     volumes:
       - $PWD/${gwen.initDir}${slash}output/.assets:/opt/selenium/assets
       - $PWD/${gwen.initDir}${slash}output/downloads:/home/seluser/Downloads
@@ -19,7 +19,7 @@ services:
     shm_size: 2gb
 
   selenium-hub:
-    image: selenium/hub:latest
+    image: selenium/hub:4
     container_name: selenium-hub
     ports:
       - "4442:4442"
@@ -48,7 +48,7 @@ services:
     volumes:
       - "$PWD:/project"
     working_dir: /project
-    command: bash -c "./${gwen.initDir}${slash}wait4grid.sh && yarn install && yarn gwen -b -c ${gwen.initDir}${slash}conf/browsers/grid.conf ${gwen.initDir}${slash}features"
+    command: bash -c "yarn install && yarn gwen -b -c ${gwen.initDir}${slash}conf/browsers/grid.conf ${gwen.initDir}${slash}features"
 
   gwen-dry-run:
     build:
diff --git a/src/main/resources/init/docker-compose.yml b/src/main/resources/init/docker-compose.yml
@@ -1,7 +1,7 @@
 services:
 
   node-docker:
-    image: selenium/node-docker:latest
+    image: selenium/node-docker:4
     volumes:
       - $PWD/${gwen.initDir}${slash}output/.assets:/opt/selenium/assets
       - $PWD/${gwen.initDir}${slash}output/downloads:/home/seluser/Downloads
@@ -19,7 +19,7 @@ services:
     shm_size: 2gb
 
   selenium-hub:
-    image: selenium/hub:latest
+    image: selenium/hub:4
     container_name: selenium-hub
     ports:
       - "4442:4442"
@@ -48,7 +48,7 @@ services:
     volumes:
       - "$PWD:/project"
     working_dir: /project
-    command: bash -c "./${gwen.initDir}${slash}wait4grid.sh && yarn install && yarn gwen -b -c ${gwen.initDir}${slash}conf/browsers/grid.conf ${gwen.initDir}${slash}features"
+    command: bash -c "yarn install && yarn gwen -b -c ${gwen.initDir}${slash}conf/browsers/grid.conf ${gwen.initDir}${slash}features"
 
   gwen-dry-run:
     build:
diff --git a/src/main/resources/init/gwen.conf b/src/main/resources/init/gwen.conf
@@ -305,10 +305,6 @@ gwen {
       }
     }
     maximize = false
-    remote {
-      localFileDetector = auto    # auto|true|false
-      sessionRetries = auto       # auto|true|false
-    }
     sendKeys {
       clearFirst = false
       clickFirst = false
diff --git a/src/main/resources/init/wait4grid.sh b/src/main/resources/init/wait4grid.sh
diff --git a/src/main/scala/gwen/web/eval/Grid.scala b/src/main/scala/gwen/web/eval/Grid.scala
@@ -18,9 +18,16 @@ package gwen.web.eval
 import gwen.core.Settings
 import gwen.core.GwenSettings
 
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.typesafe.scalalogging.LazyLogging
+
+import scala.io.Source
+import scala.util.Try
+
 import java.io.File
+import java.util.HashMap
 
-enum Grid:
+enum Grid extends LazyLogging:
   case selenium, selenoid
   private def enableVideoKeys: List[String] = {
     if (this == selenium) List(
@@ -42,6 +49,38 @@ enum Grid:
       new File(GwenSettings.`gwen.video.dir`, s"$sessionId.mp4")
     }
   }
+  def waitFor(): Unit = {
+    if (this == selenium) {
+      val remoteUrl = WebSettings.`gwen.web.remote.url`.get
+      val statusUrl = s"$remoteUrl/status"
+      val mapper = new ObjectMapper()
+      val isReady = () => {
+        Try(
+          mapper
+            .readValue(Source.fromURL(statusUrl).mkString, classOf[HashMap[String, Object]])
+            .get("value").asInstanceOf[HashMap[String, Object]]
+            .get("ready").asInstanceOf[Boolean]
+        ).getOrElse(false)
+      }
+      var ready = isReady()
+      val timeoutSecs = WebSettings.`gwen.web.remote.connectTimeout.seconds`
+      var waitSecs = timeoutSecs
+      if (!ready) {
+        logger.info(s"Remote url is $remoteUrl")
+        print(s"Waiting for Grid")
+        while(!ready && waitSecs > 0) {
+          if (!ready) {
+            waitSecs = waitSecs - 1
+            Thread.sleep(1000)
+            print(".")
+          }
+          ready = isReady()
+        }
+      }
+      if (waitSecs < timeoutSecs) println(s"${timeoutSecs - waitSecs}s")
+      if (ready) println(s"Grid is UP\n") else WebErrors.gridWaitTimeout(timeoutSecs)
+    }
+  }
 
 object Grid {
   def impl: Option[Grid] = sys.env.get("SELENIUM_HUB") map { hub =>
diff --git a/src/main/scala/gwen/web/eval/WebEngine.scala b/src/main/scala/gwen/web/eval/WebEngine.scala
@@ -56,6 +56,7 @@ class WebEngine extends EvalEngine[WebContext] {
   override def init(options: GwenOptions, envState: EnvState): WebContext = {
     WebSettings.check()
     Grid.impl.foreach { grid =>
+      grid.waitFor()
       val disableVideo = sys.env.get("GWEN_VIDEO").map(v => v.trim != "true").getOrElse(false)
       val selenoidParallel = grid == Grid.selenoid && options.parallel
       if (disableVideo || ((selenoidParallel || !options.batch) && grid.videoEnabled)) {
diff --git a/src/main/scala/gwen/web/eval/WebErrors.scala b/src/main/scala/gwen/web/eval/WebErrors.scala
@@ -44,6 +44,7 @@ object WebErrors {
     def invalidSelectorTypeError(selectorType: String) = throw new InvalidSelectorTypeException(selectorType)
     def multipleBrowserSettingsError(settingsFiles: List[File]) = throw new MultipleBrowserSettingsException(settingsFiles)
     def illegalSessionNameError(name: String, msg: Option[String]) = throw new IllegalSessionNameException(name, msg)
+    def gridWaitTimeout(secs: Long) = throw new GridWaitTimeout(secs)
 
     /** Thrown when a locator binding error is detected . */
     class LocatorBindingException(msg: String) extends GwenException(msg)
@@ -94,4 +95,8 @@ object WebErrors {
     class IllegalSessionNameException(name: String, msg: Option[String])
       extends GwenException(s"Illegal (reserved) browser session name: $name${msg.map(m => s". $m").getOrElse("")}")
 
+    /** Thrown when waiting for a remote Grid times out. */
+    class GridWaitTimeout(secs: Long)
+      extends GwenException(s"Timed out after ${secs}s waiting for Grid")
+
 }
diff --git a/src/main/scala/gwen/web/eval/WebSettings.scala b/src/main/scala/gwen/web/eval/WebSettings.scala
@@ -71,6 +71,7 @@ object WebSettings extends LazyLogging {
     `gwen.web.maximize`
     `gwen.web.remote.localFileDetector`
     `gwen.web.remote.url`
+    `gwen.web.remote.connectTimeout.seconds`
     `gwen.web.sendKeys.clearFirst`
     `gwen.web.sendKeys.clickFirst`
     `gwen.web.suppress.images`
@@ -501,4 +502,11 @@ object WebSettings extends LazyLogging {
     (auto && `gwen.web.remote.url`.nonEmpty) || (!auto && Settings.getBoolean("gwen.web.remote.sessionRetries"))
   }
 
+  /**
+   * The maximum time to wait for a remote server connection.
+   */
+  def `gwen.web.remote.connectTimeout.seconds`: Long = {
+    Settings.getLong("gwen.web.remote.connectTimeout.seconds")
+  }
+
 }
diff --git a/src/main/scala/gwen/web/eval/driver/DriverManager.scala b/src/main/scala/gwen/web/eval/driver/DriverManager.scala
@@ -19,6 +19,7 @@ package gwen.web.eval.driver
 import gwen.core._
 import gwen.core.state.SensitiveData
 
+import gwen.web.eval.Grid
 import gwen.web.eval.WebBrowser
 import gwen.web.eval.WebSettings
 import gwen.web.eval.WebErrors
diff --git a/src/main/scala/gwen/web/init/WebProjectInitialiser.scala b/src/main/scala/gwen/web/init/WebProjectInitialiser.scala
@@ -25,7 +25,6 @@ import scala.sys.process.stringToProcess
 import scala.sys.process.stringSeqToProcess
 
 import scala.util.chaining._
-import scala.util.Try
 
 import java.io.File
 import java.nio.file.Files
@@ -142,8 +141,6 @@ trait WebProjectInitialiser extends ProjectInitialiser {
     if (options.initOptions.contains(InitOption.docker)) {
       FileIO.copyClasspathTextResourceToFile("/init/docker_env", dir, Some(".env"), allowReplace = force)
       FileIO.copyClasspathTextResourceToFile("/init/Dockerfile", dir, allowReplace = force)
-      FileIO.copyClasspathTextResourceToFile("/init/wait4grid.sh", dir, allowReplace = force)
-      Try(Seq("/bin/sh", "-c", s"chmod u+x ./$dir/wait4grid.sh").!)
       copyClasspathResourceAndInject("/init/docker-compose.yml", dir, flat, allowReplace = force)
       copyClasspathResourceAndInject("/init/docker-compose-arm.yml", dir, flat, allowReplace = force)
       new File(confDir, "browsers") tap { dir =>
@@ -161,7 +158,6 @@ trait WebProjectInitialiser extends ProjectInitialiser {
             |$filler├── docker-compose.yml       # Se Grid docker compose file
             |$filler├── docker-compose-arm.yml   # Se Grid docker compose file for ARMs
             |$filler├── Dockerfile               # Docker file for Gwen
-            |$filler├── wait4grid.sh             # Se Grid wait script
             |$filler└── /conf
             |$filler    └── /browsers            # Browser settings
             |$filler        ├── grid.conf        # Se Grid remote driver settings
diff --git a/src/test/scala/gwen/web/eval/SamplesProjectTest.scala b/src/test/scala/gwen/web/eval/SamplesProjectTest.scala
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2025 Brady Wood, Branko Juric
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package gwen.web.eval
+
+import gwen.web._
+
+import org.scalatest.matchers.should.Matchers
+
+import scala.sys.process.stringToProcess
+import scala.sys.process.stringSeqToProcess
+
+class SamplesProjectTest extends BaseTest with Matchers {
+  "Newly initialised project" should "should run" in {
+    Seq("/bin/sh", "-c", "./project-test.sh").! should be (0)
+  }
+
+}
diff --git a/src/test/scala/gwen/web/eval/WebSettingsTest.scala b/src/test/scala/gwen/web/eval/WebSettingsTest.scala

Original file line number	Diff line number	Diff line change
`@@ -114,9 +114,12 @@ gwen {`
`114`	`114`	`}`
`115`	`115`	`maximize = false`
`116`	`116`	`remote {`
	`117`	`+ # url = ""`
`117`	`118`	`localFileDetector = auto # auto\|true\|false`
`118`	`119`	`sessionRetries = auto # auto\|true\|false`
`119`		`- # url = ""`
	`120`	`+ connectTimeout {`
	`121`	`+ seconds = 30`
	`122`	`+ }`
`120`	`123`	`}`
`121`	`124`	`sendKeys {`
`122`	`125`	`clearFirst = false`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,11 @@ gwen {`
`22`	`22`	`}`
`23`	`23`	`remote {`
`24`	`24`	`url = "http://${env.SELENIUM_HUB}:4444/wd/hub"`
	`25`	`+ localFileDetector = auto # auto\|true\|false`
	`26`	`+ sessionRetries = auto # auto\|true\|false`
	`27`	`+ connectTimeout {`
	`28`	`+ seconds = 30`
	`29`	`+ }`
`25`	`30`	`}`
`26`	`31`	`}`
`27`	`32`	`}`