-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Major updates to
ContainerGebSpec feature
- Use Gradle testFixtures feature to make test dependencies available to downstream projects without leaking them to the wrong scopes - Refactor `ContainerGebSpec` in co-operation with sbglasius to add more features and make it work without Docker Desktop.
- Loading branch information
Showing
3 changed files
with
135 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
109 changes: 109 additions & 0 deletions
109
src/testFixtures/groovy/grails/plugin/geb/ContainerGebSpec.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| package grails.plugin.geb | ||
| /* | ||
| * Copyright 2024 original author or authors | ||
| * | ||
| * 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 | ||
| * | ||
| * https://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. | ||
| */ | ||
|
|
||
|
|
||
| import geb.spock.GebSpec | ||
| import groovy.transform.PackageScope | ||
| import org.openqa.selenium.chrome.ChromeOptions | ||
| import org.openqa.selenium.remote.RemoteWebDriver | ||
| import org.testcontainers.Testcontainers | ||
| import org.testcontainers.containers.BrowserWebDriverContainer | ||
| import org.testcontainers.containers.PortForwardingContainer | ||
| import spock.lang.Shared | ||
|
|
||
| import java.time.Duration | ||
|
|
||
| /** | ||
| * A {@link geb.spock.GebSpec GebSpec} that leverages Testcontainers to run the browser inside a container. | ||
| * | ||
| * <p>Prerequisites: | ||
| * <ul> | ||
| * <li> | ||
| * The test class must be annotated with {@link grails.testing.mixin.integration.Integration @Integration}. | ||
| * </li> | ||
| * <li> | ||
| * A <a href="https://java.testcontainers.org/supported_docker_environment/">compatible container runtime</a> | ||
| * (e.g., Docker) must be available for Testcontainers to utilize. | ||
| * </li> | ||
| * </ul> | ||
| * | ||
| * @author Søren Berg Glasius | ||
| * @author Mattias Reichel | ||
| * @since 5.0.0 | ||
| */ | ||
| class ContainerGebSpec extends GebSpec { | ||
|
|
||
| private static final String DEFAULT_PROTOCOL = 'http' | ||
| private static final String DEFAULT_HOSTNAME = 'host.testcontainers.internal' | ||
|
|
||
| @Shared | ||
| BrowserWebDriverContainer webDriverContainer | ||
|
|
||
| @PackageScope | ||
| void initialize() { | ||
| if (!webDriverContainer) { | ||
| if (!hasProperty('serverPort')) { | ||
| throw new IllegalStateException('Test class must be annotated with @Integration for serverPort to be injected') | ||
| } | ||
| webDriverContainer = new BrowserWebDriverContainer() | ||
| webDriverContainer.tap { | ||
| addExposedPort(serverPort) | ||
| withAccessToHost(true) | ||
| start() | ||
| } | ||
| Testcontainers.exposeHostPorts(serverPort) | ||
| if (hostName != DEFAULT_HOSTNAME) { | ||
| webDriverContainer.execInContainer('/bin/sh', '-c', "echo '$hostIp\t$hostName' | sudo tee -a /etc/hosts") | ||
| } | ||
| browser.driver = new RemoteWebDriver(webDriverContainer.seleniumAddress, new ChromeOptions()) | ||
| browser.driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(30)) | ||
| } | ||
| } | ||
|
|
||
| void setup() { | ||
| initialize() | ||
| baseUrl = "$protocol://$hostName:$serverPort" | ||
| } | ||
|
|
||
| def cleanupSpec() { | ||
| webDriverContainer.stop() | ||
| } | ||
|
|
||
| /** | ||
| * Returns the protocol that the browser will use to access the server under test. | ||
| * <p>Defaults to {@code http}. | ||
| * | ||
| * @return the protocol for accessing the server under test | ||
| */ | ||
| String getProtocol() { | ||
| return DEFAULT_PROTOCOL | ||
| } | ||
|
|
||
| /** | ||
| * Returns the hostname that the browser will use to access the server under test. | ||
| * <p>Defaults to {@code host.testcontainers.internal}. | ||
| * | ||
| * @return the hostname for accessing the server under test | ||
| */ | ||
| String getHostName() { | ||
| return DEFAULT_HOSTNAME | ||
| } | ||
|
|
||
| private static String getHostIp() { | ||
| PortForwardingContainer.INSTANCE.network.get().ipAddress | ||
| } | ||
| } |