Geb 8 (#15067)

* fix(deps): `geb` v. `7.0` -> `8.0.0`

* fix: adapt to changes in Geb 8

Adapt to changed driver creation logic in Geb 8.

* refactor(geb): simplifications

* docs(geb): improve comments and javadoc

* chore(geb): whitespace

* fix(geb): reset `webdriver.remote.server` after `RemoteWebDriver` init

Reinstate resetting the system property after driver construction.

* docs(geb): minor comment improvement

* fix(geb): prevent cross-thread leakage of `webdriver.remote.server`

Scope the `webdriver.remote.server` System property to the current thread
during `RemoteWebDriver` creation, then restore it. This avoids routing
later sessions to the wrong endpoint in parallel builds.

* fix(geb): allow testing with different browsers

This allows using different browsers in `GebConfig.groovy`
A `configuredBrowser` property has to be set that matches
the browser capabilities used to create the `RemoteWebDriver`
to start the correct container for the browser.

* chore(geb): formatting

* chore(geb): formatting

* refactor(geb): simplify system property override

* docs(geb): improve javadoc and code comments

* fix(geb): resolve trait method conflicts via explicit override

* refactor(geb): simplify

* chore(geb): formatting

* refactor(geb): simplify

* test(geb): update test label

* docs(geb): add `GebConfig` instructions to README

* fix(geb): make inner classes `static`

* feedback(geb): rename property to `containerBrowser`

* chore(geb): formatting

* fix(geb): add message for missing `containerBrowser`

Add a more helpful error message in the case where
a `containerBrowser` property is missing from `GebConfig.groovy`.

* test(geb): make tests more resilient in slow runners

* fix(feedback): skip `containerBrowser` validation

* refactor(geb): extract methods

* fix(geb): move `atCheckWaiting` to CI env variable

* fix(geb): feedback - remove container fallback

Throw exception when `driver` and `containerBrowser`
are mismatched in `GebConfig` instead of falling
back to chrome.

* fix(geb): system property setting of timeout values

* ci: update Geb `atCheckWaiting` system property

* chore(geb): formatting

* fix(geb): use correct `atCheckWaiting` system property

* fix(geb): feedback - use `BigDecimal` in `GrailsGebSettings`

* ci: feedback - set `atCheckWaiting` in build file

Author: matrei

.github/workflows/gradle.yml

@@ -178,6 +178,7 @@ jobs:
           --continue
           --rerun-tasks
           --stacktrace
+          -PgebAtCheckWaiting
           -PonlyFunctionalTests
           -PskipCodeStyle
           -PskipHibernate5Tests

DEVELOPMENT.md

@@ -31,6 +31,7 @@ These can be set on the command line like so:
 
 `./gradlew check -PskipCodeStyle`
 
+* `gebAtCheckWaiting` - enables Geb atCheckWaiting
 * `onlyCoreTests` - runs tests that do not include mongo, hibernate, or functional
 * `onlyFunctionalTests` - runs only grails-test-examples/* tests
 * `onlyHibernate5Tests` - runs only a hibernate5 related test

build.gradle

@@ -70,6 +70,7 @@ allprojects {
             url = 'https://repository.apache.org/content/groups/staging'
             content {
                 includeModuleByRegex('org[.]apache[.]grails[.]gradle', 'grails-publish')
+                includeModuleByRegex('org[.]apache[.]groovy[.]geb', 'geb-.*')
             }
             mavenContent {
                 releasesOnly()

dependencies.gradle

@@ -76,7 +76,7 @@ ext {
             'bootstrap-icons.version'     : '1.13.1',
             'bootstrap.version'           : '5.3.7',
             'commons-codec.version'       : '1.18.0',
-            'geb-spock.version'           : '7.0',
+            'geb-spock.version'           : '8.0.0',
             'groovy.version'              : '4.0.28',
             'h2.version'                  : '2.3.232',
             'jackson.version'             : '2.19.1',
@@ -106,7 +106,7 @@ ext {
             'bootstrap'                : "org.webjars.npm:bootstrap:${bomDependencyVersions['bootstrap.version']}",
             'bootstrap-icons'          : "org.webjars.npm:bootstrap-icons:${bomDependencyVersions['bootstrap-icons.version']}",
             'commons-codec'            : "commons-codec:commons-codec:${bomDependencyVersions['commons-codec.version']}",
-            'geb-spock'                : "org.gebish:geb-spock:${bomDependencyVersions['geb-spock.version']}",
+            'geb-spock'                : "org.apache.groovy.geb:geb-spock:${bomDependencyVersions['geb-spock.version']}",
             'h2'                       : "com.h2database:h2:${bomDependencyVersions['h2.version']}",
             'jquery'                   : "org.webjars.npm:jquery:${bomDependencyVersions['jquery.version']}",
             'liquibase-hibernate5'     : "org.liquibase:liquibase:${bomDependencyVersions['liquibase-hibernate5.version']}",

gradle/functional-test-config.gradle

@@ -113,6 +113,11 @@ tasks.withType(Test).configureEach { Test task ->
     if (System.getProperty('debug.tests')) {
         task.jvmArgs += debugArguments
     }
+
+    // Make Geb tests more resilient in slow CI environments
+    if (project.hasProperty('gebAtCheckWaiting')) {
+        systemProperty('grails.geb.atCheckWaiting.enabled', 'true')
+    }
 }
 
 tasks.named('groovydoc').configure {

grails-doc/build.gradle

@@ -53,7 +53,7 @@ dependencies {
     implementation 'org.testcontainers:testcontainers'
     implementation 'org.springframework:spring-core'
     implementation 'org.springframework.boot:spring-boot'
-    implementation 'org.gebish:geb-spock'
+    implementation 'org.apache.groovy.geb:geb-spock'
 }
 
 // this task needs to be here instead of the root since bom resolution only occurs when the java / groovy plugins are applied

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
@@ -161,6 +177,28 @@ To enable tracing, set the following system property:
 
 This allows you to opt in to tracing when an OpenTelemetry collector is available.
 
+#### GebConfig.groovy and using non-default browser settings
+Provide a `GebConfig.groovy` on the test runtime classpath (commonly `src/integration-test/resources`, but any location on the test classpath works) to customize the browser.
+
+To make this work, ensure:
+1. The `driver` property in your `GebConfig` is a `Closure` that returns a `RemoteWebDriver` instance.
+2. You set a custom `containerBrowser` property so that `ContainerGebSpec` can start a matching container (e.g. "chrome", "edge", "firefox"). For a list of supported browsers, see the [Testcontainers documentation](https://java.testcontainers.org/modules/webdriver_containers/#other-browsers).
+3. Your `build.gradle` includes the driver dependency for the chosen browser.
+
+Example `GebConfig.groovy`:
+```groovy
+driver = {
+  new RemoteWebDriver(new FireFoxOptions())
+}
+containerBrowser = 'firefox'
+```
+Example `build.gradle`:
+```groovy
+dependencies {
+  integrationTestImplementation 'org.seleniumhq.selenium:selenium-firefox-driver'
+}
+```
+
 ### GebSpec
 
 If you choose to extend `GebSpec`, you will need to have a [Selenium WebDriver](https://www.selenium.dev/documentation/webdriver/browsers/) installed that matches a browser you have installed on your system.

grails-geb/build.gradle

@@ -49,7 +49,7 @@ dependencies {
     testFixturesCompileOnly 'jakarta.servlet:jakarta.servlet-api'
     testFixturesCompileOnly 'org.slf4j:slf4j-simple' // Remove compilation warning about missing slf4j impl
 
-    testFixturesApi 'org.gebish:geb-spock'
+    testFixturesApi 'org.apache.groovy.geb:geb-spock'
     testFixturesApi project(':grails-testing-support-core')
     testFixturesApi project(':grails-datamapping-core')
     testFixturesApi "org.testcontainers:selenium"
@@ -59,7 +59,7 @@ dependencies {
     testFixturesImplementation "org.seleniumhq.selenium:selenium-support"
 
     // Added to be able to resolve the geb version from the BOM in the resolveVersions task
-    compileOnly 'org.gebish:geb-spock'
+    compileOnly 'org.apache.groovy.geb:geb-spock'
 }
 
 apply {

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

@@ -26,7 +26,8 @@ import org.openqa.selenium.remote.FileDetector
  * An extension of {@link org.openqa.selenium.remote.FileDetector}
  * that will get passed additional parameters from the webdriver container holder.
  * <p>
- * Implementations must provide a zero-argument constructor to ensure compatibility with {@link java.util.ServiceLoader}.
+ * Implementations must provide a zero-argument constructor to ensure compatibility
+ * with {@link java.util.ServiceLoader}.
  *
  * @see GebRecordingTestListener
  */

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

@@ -26,7 +26,7 @@ import java.lang.annotation.Target
 import org.testcontainers.containers.GenericContainer
 
 /**
- * Can be used to configure the protocol and hostname that the container's browser will use
+ * Can be used to configure the protocol and hostname that the container's browser will use.
  *
  * @author James Daugherty
  * @since 4.1
@@ -53,7 +53,8 @@ import org.testcontainers.containers.GenericContainer
     String hostName() default DEFAULT_HOSTNAME_FROM_CONTAINER
 
     /**
-     * Whether reporting should be enabled for this test. Add a `GebConfig.groovy` to customize the reporter configuration.
+     * Whether reporting should be enabled for this test.
+     * Add a `GebConfig.groovy` to customize the reporter configuration.
      */
     boolean reporting() default false
 
@@ -70,7 +71,7 @@ import org.testcontainers.containers.GenericContainer
 }
 
 /**
- * Inheritable version of {@link ContainerGebConfiguration}
+ * Inheritable version of {@link ContainerGebConfiguration}.
  *
  * @since 4.2
  */