fix(geb): system property setting of timeout values

Author: matrei

grails-geb/README.md

@@ -135,18 +135,34 @@ the `container` from within your `ContainerGebSpec` to, for example, call `.copy
 An Example of this can be seen in [ContainerSupport#createFileInputSource utility method](./src/testFixtures/groovy/grails/plugin/geb/support/ContainerSupport.groovy).
 
 #### Timeouts
-
+The following system properties exist to configure timeouts:
+ 
+* `grails.geb.atCheckWaiting.enabled`
+  * purpose: if `at` checks should wait for the page to be in the expected state (uses configured waiting timeout values)
+  * type: boolean
+  * defaults to `false`
+* `grails.geb.timeouts.retryInterval`
+  * purpose: how often to retry waiting operations
+  * type: Number
+  * defaults to `0.1` seconds
+* `grails.geb.timeouts.waiting`
+  * purpose: amount of time to wait for waiting operations
+  * type: Number
+  * defaults to `5.0` seconds
 * `grails.geb.timeouts.implicitlyWait`
   * purpose: amount of time the driver should wait when searching for an element if it is not immediately present.
+  * type: int
   * defaults to `0` seconds, which means that if an element is not found, it will immediately return an error.
   * Warning: Do not mix implicit and explicit waits. Doing so can cause unpredictable wait times.
     Consult the [Geb](https://groovy.apache.org/geb/manual/current/#implicit-assertions-waiting) 
     and/or [Selenium](https://www.selenium.dev/documentation/webdriver/waits/) documentation for details.
 * `grails.geb.timeouts.pageLoad`
   * purpose: amount of time to wait for a page load to complete before throwing an error.
+  * type: int
   * defaults to `300` seconds
 * `grails.geb.timeouts.script`
   * purpose: amount of time to wait for an asynchronous script to finish execution before throwing an error.
+  * type: int
   * defaults to `30` seconds
 
 #### Observability and Tracing

grails-geb/src/testFixtures/groovy/grails/plugin/geb/GrailsGebSettings.groovy

@@ -25,6 +25,8 @@ import groovy.transform.CompileStatic
 import groovy.transform.Memoized
 import groovy.util.logging.Slf4j
 
+import geb.waiting.Wait
+
 import static org.testcontainers.containers.BrowserWebDriverContainer.VncRecordingMode
 import static org.testcontainers.containers.VncRecordingContainer.VncRecordingFormat
 
@@ -46,7 +48,7 @@ class GrailsGebSettings {
     public static int DEFAULT_TIMEOUT_PAGE_LOAD = 300
     public static int DEFAULT_TIMEOUT_SCRIPT = 30
 
-    String tracingEnabled
+    boolean tracingEnabled
     String recordingDirectoryName
     String reportingDirectoryName
     boolean restartRecordingContainerPerTest
@@ -56,10 +58,13 @@ class GrailsGebSettings {
     int implicitlyWait
     int pageLoadTimeout
     int scriptTimeout
+
     boolean atCheckWaiting
+    Number timeout
+    Number retryInterval
 
     GrailsGebSettings(LocalDateTime startTime) {
-        tracingEnabled = System.getProperty('grails.geb.tracing.enabled', 'false')
+        tracingEnabled = getBooleanProperty('grails.geb.tracing.enabled', false)
         recordingDirectoryName = System.getProperty('grails.geb.recording.directory', 'build/gebContainer/recordings')
         reportingDirectoryName = System.getProperty('grails.geb.reporting.directory', 'build/gebContainer/reports')
         recordingMode = VncRecordingMode.valueOf(
@@ -76,6 +81,8 @@ class GrailsGebSettings {
         pageLoadTimeout = getIntProperty('grails.geb.timeouts.pageLoad', DEFAULT_TIMEOUT_PAGE_LOAD)
         scriptTimeout = getIntProperty('grails.geb.timeouts.script', DEFAULT_TIMEOUT_SCRIPT)
         atCheckWaiting = getBooleanProperty('grails.geb.atCheckWaiting', DEFAULT_AT_CHECK_WAITING)
+        timeout = getNumberProperty('grails.geb.timeouts.timeout', Wait.DEFAULT_TIMEOUT)
+        retryInterval = getNumberProperty('grails.geb.timeouts.retryInterval', Wait.DEFAULT_RETRY_INTERVAL)
         this.startTime = startTime
     }
 
@@ -87,6 +94,27 @@ class GrailsGebSettings {
         Integer.getInteger(propertyName, defaultValue) ?: defaultValue
     }
 
+    private static Number getNumberProperty(String propertyName, Number defaultValue) {
+        def propValue = System.getProperty(propertyName)
+        if (propValue) {
+            try {
+                if (propValue.contains('.')) {
+                    return Double.parseDouble(propValue)
+                } else {
+                    return Integer.parseInt(propValue)
+                }
+            } catch (NumberFormatException ignored) {
+                log.warn(
+                        "Could not parse property [{}] with value [{}] as a Number. Using default value [{}] instead.",
+                        propertyName,
+                        propValue,
+                        defaultValue
+                )
+            }
+        }
+        return defaultValue
+    }
+
     boolean isRecordingEnabled() {
         recordingMode != VncRecordingMode.SKIP
     }

grails-geb/src/testFixtures/groovy/grails/plugin/geb/WebDriverContainerHolder.groovy

@@ -30,9 +30,11 @@ import org.codehaus.groovy.runtime.InvokerHelper
 
 import com.github.dockerjava.api.model.ContainerNetwork
 import geb.Browser
+import geb.Configuration
 import geb.ConfigurationLoader
 import geb.spock.SpockGebTestManagerBuilder
 import geb.test.GebTestManager
+import geb.waiting.Wait
 import org.openqa.selenium.SessionNotCreatedException
 import org.openqa.selenium.chrome.ChromeOptions
 import org.openqa.selenium.remote.RemoteWebDriver
@@ -150,7 +152,7 @@ class WebDriverContainerHolder {
         )
 
         container.with {
-            withEnv('SE_ENABLE_TRACING', settings.tracingEnabled)
+            withEnv('SE_ENABLE_TRACING', settings.tracingEnabled.toString())
             withAccessToHost(true)
             withImagePullPolicy(PullPolicy.ageBased(Duration.of(1, ChronoUnit.DAYS)))
         }
@@ -252,9 +254,12 @@ class WebDriverContainerHolder {
             browser.driver.manage().timeouts().pageLoadTimeout(Duration.ofSeconds(settings.pageLoadTimeout))
         if (settings.scriptTimeout != DEFAULT_TIMEOUT_SCRIPT)
             browser.driver.manage().timeouts().scriptTimeout(Duration.ofSeconds(settings.scriptTimeout))
-        if (settings.atCheckWaiting != DEFAULT_AT_CHECK_WAITING) {
+        if (settings.atCheckWaiting != DEFAULT_AT_CHECK_WAITING)
             browser.config.atCheckWaiting = settings.atCheckWaiting
-        }
+        if (settings.timeout != Wait.DEFAULT_TIMEOUT)
+            (browser.config.rawConfig.waiting as ConfigObject).timeout = settings.timeout
+        if (settings.retryInterval != Wait.DEFAULT_RETRY_INTERVAL)
+            (browser.config.rawConfig.waiting as ConfigObject).retryInterval = settings.retryInterval
     }
 
     private static void startContainer(BrowserWebDriverContainer container, DockerImageName dockerImageName, String customBrowser) {