Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grails/geb
Geb Functional Testing for Grails® framework
https://github.com/grails/geb
geb grails grails-plugins selenium webdriver
Last synced: about 2 months ago
JSON representation
Geb Functional Testing for Grails® framework
- Host: GitHub
- URL: https://github.com/grails/geb
- Owner: grails
- License: apache-2.0
- Created: 2014-12-11T00:35:11.000Z (about 10 years ago)
- Default Branch: 5.0.x
- Last Pushed: 2024-11-07T07:23:45.000Z (about 2 months ago)
- Last Synced: 2024-11-10T17:22:11.420Z (about 2 months ago)
- Topics: geb, grails, grails-plugins, selenium, webdriver
- Language: Groovy
- Homepage:
- Size: 511 KB
- Stars: 8
- Watchers: 13
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Grails Geb Plugin
[](https://central.sonatype.com/artifact/org.grails.plugins/geb)
[](https://github.com/grails/geb/actions/workflows/gradle.yml)
## Geb Functional Testing for the Grails® framework
This plugin integrates [Geb](https://www.gebish.org) with [Grails](https://www.grails.org) to make it easy to write functional tests for your Grails applications.
## Examples
If you are looking for examples on how to write Geb tests, check:
[Geb/Grails example project](https://github.com/grails-samples/geb-example-grails) or [Grails functional test suite](https://github.com/grails/grails-functional-tests) where Geb tests are used extensively.
For further reference please see the [Geb documentation](https://www.gebish.org).
## Usage
To use the plugin, add the following dependencies to your `build.gradle` file:
```groovy
dependencies {
// This is only needed to if you want to use the
// create-functional-test command (see below)
implementation 'org.grails.plugins:geb'
// This is needed to compile and run the tests
integrationTestImplementation testFixtures('org.grails.plugins:geb')
}
```
To get started, you can use the `create-functional-test` command to generate a new functional test using Geb:
```console
./grailsw create-functional-test com.example.MyFunctionalSpec
```
This will create a new Geb test named `MyFunctionalSpec` in the `src/integration-test/groovy/com/example` directory.
There are two ways to use this plugin. Either extend your test classes with the `ContainerGebSpec` class or with the `GebSpec` class.
### ContainerGebSpec (recommended)
By extending your test classes with `ContainerGebSpec`, your tests will automatically use a containerized browser using [Testcontainers](https://java.testcontainers.org/).
This requires a [compatible container runtime](https://java.testcontainers.org/supported_docker_environment/) to be installed, such as:
- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
- [OrbStack](https://orbstack.dev/) - macOS only
- [Rancher Desktop](https://rancherdesktop.io/)
- [podman desktop](https://podman-desktop.io/)
- [Colima](https://github.com/abiosoft/colima) - macOS and Linux
If you choose to use the `ContainerGebSpec` class, as long as you have a compatible container runtime installed, you don't need to do anything else.
Just run `./gradlew integrationTest` and a container will be started and configured to start a browser that can access your application under test.
### 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.
This plugin comes with the `selenium-chrome-driver` java bindings pre-installed, but you can also add additional browser bindings.
To set up additional bindings, you need to add them to your `build.gradle` for example:
```groovy
dependencies {
integrationTestImplementation 'org.seleniumhq.selenium:selenium-firefox-driver'
integrationTestImplementation 'org.seleniumhq.selenium:selenium-edge-driver'
}
```
You also need to add a `GebConfig.groovy` file in the `src/integration-test/resources/` directory. For example:
```groovy
/*
This is the Geb configuration file.
See: http://www.gebish.org/manual/current/#configuration
*/
/* ... */
import org.openqa.selenium.edge.EdgeDriver
import org.openqa.selenium.firefox.FirefoxDriver
environments {
/* ... */
edge {
driver = { new EdgeDriver() }
}
firefox {
driver = { new FirefoxDriver() }
}
}
```
And pass on the `geb.env` system property if running your tests via Gradle:
```groovy
// build.gradle
tasks.withType(Test) {
useJUnitPlatform()
systemProperty 'geb.env', System.getProperty('geb.env')
}
```
Now you can run your tests with the browsers installed on your system by specifying the Geb environment you have set up in your `GebConfig.groovy` file. For example:
```console
./gradlew integrationTest -Dgeb.env=edge
```