This is useful when the server under test needs to be accessed with a certain hostname. */ String hostName() default DEFAULT_HOSTNAME_FROM_CONTAINER + + /** + * Whether reporting should be enabled for this test. Add a `GebConfig.groovy` to customize the reporter configuration. + */ + boolean reporting() default false } \ No newline at end of file diff --git a/src/testFixtures/groovy/grails/plugin/geb/ContainerGebRecordingExtension.groovy b/src/testFixtures/groovy/grails/plugin/geb/ContainerGebRecordingExtension.groovy deleted file mode 100644 index 931c694..0000000 --- a/src/testFixtures/groovy/grails/plugin/geb/ContainerGebRecordingExtension.groovy +++ /dev/null @@ -1,84 +0,0 @@ -/* - * 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. - */ -package grails.plugin.geb - -import grails.testing.mixin.integration.Integration -import groovy.transform.CompileStatic -import groovy.transform.TailRecursive -import groovy.util.logging.Slf4j -import org.spockframework.runtime.extension.IGlobalExtension -import org.spockframework.runtime.model.SpecInfo - -import java.time.LocalDateTime - -/** - * A Spock Extension that manages the Testcontainers lifecycle for a {@link grails.plugin.geb.ContainerGebSpec} - * - * @author James Daugherty - * @since 5.0 - */ -@Slf4j -@CompileStatic -class ContainerGebRecordingExtension implements IGlobalExtension { - - WebDriverContainerHolder holder - - @Override - void start() { - holder = new WebDriverContainerHolder(new RecordingSettings()) - addShutdownHook { - holder.stop() - } - } - - @Override - void stop() { - holder.stop() - } - - @Override - void visitSpec(SpecInfo spec) { - if (isContainerGebSpec(spec) && validateContainerGebSpec(spec)) { - ContainerGebTestListener listener = new ContainerGebTestListener(holder, spec, LocalDateTime.now()) - spec.addSetupInterceptor { - holder.reinitialize(it) - (it.sharedInstance as ContainerGebSpec).webDriverContainer = holder.currentContainer - } - - spec.addListener(listener) - } - } - - @TailRecursive - private boolean isContainerGebSpec(SpecInfo spec) { - if (spec != null) { - if (spec.filename.startsWith('ContainerGebSpec.')) { - return true - } - return isContainerGebSpec(spec.superSpec) - } - return false - } - - private static boolean validateContainerGebSpec(SpecInfo specInfo) { - if (!specInfo.annotations.find { it.annotationType() == Integration }) { - throw new IllegalArgumentException('ContainerGebSpec classes must be annotated with @Integration') - } - - return true - } -} - diff --git a/src/testFixtures/groovy/grails/plugin/geb/ContainerGebSpec.groovy b/src/testFixtures/groovy/grails/plugin/geb/ContainerGebSpec.groovy index 0b3e8a0..94647f6 100644 --- a/src/testFixtures/groovy/grails/plugin/geb/ContainerGebSpec.groovy +++ b/src/testFixtures/groovy/grails/plugin/geb/ContainerGebSpec.groovy @@ -15,8 +15,10 @@ */ package grails.plugin.geb +import geb.report.CompositeReporter +import geb.report.PageSourceReporter +import geb.report.Reporter import geb.test.GebTestManager -import geb.test.ManagedGebTest import geb.transform.DynamicallyDispatchesToBrowser import org.testcontainers.containers.BrowserWebDriverContainer import spock.lang.Shared @@ -41,24 +43,15 @@ import spock.lang.Specification * @author Søren Berg Glasius * @author Mattias Reichel * @author James Daugherty - * @since 5.0 + * @since 4.1 */ @DynamicallyDispatchesToBrowser -abstract class ContainerGebSpec extends Specification implements ManagedGebTest, ContainerAwareDownloadSupport { - - private static final String DEFAULT_HOSTNAME_FROM_HOST = 'localhost' - boolean reportingEnabled = false - - @Override - @Delegate(includes = ['getBrowser', 'report']) - GebTestManager getTestManager() { - return isReportingEnabled() ? - GebTestManagerProvider.getReportingInstance() : - GebTestManagerProvider.getInstance() - } +abstract class ContainerGebSpec extends Specification implements ContainerAwareDownloadSupport { @Shared - BrowserWebDriverContainer webDriverContainer + @Delegate(includes = ['getBrowser', 'report']) + @SuppressWarnings('unused') + static GebTestManager testManager /** * Get access to container running the web-driver, for convenience to execInContainer, copyFileToContainer etc. @@ -68,25 +61,13 @@ abstract class ContainerGebSpec extends Specification implements ManagedGebTest, * @see org.testcontainers.containers.ContainerState#copyFileFromContainer(java.lang.String, java.lang.String) * @see org.testcontainers.containers.ContainerState */ - BrowserWebDriverContainer getContainer() { - return webDriverContainer - } + @Shared + static BrowserWebDriverContainer container /** - * Returns the hostname that the server under test is available on from the host. - *
This is useful when using any of the {@code download*()} methods as they will connect from the host, - * and not from within the container. - *
Defaults to {@code localhost}. If the value returned by {@code webDriverContainer.getHost()} - * is different from the default, this method will return the same value same as {@code webDriverContainer.getHost()}. - * - * @return the hostname for accessing the server under test from the host + * The reporter that Geb should use when reporting is enabled. */ - @Override - String getHostNameFromHost() { - return hostNameChanged ? webDriverContainer.host : DEFAULT_HOSTNAME_FROM_HOST - } - - private boolean isHostNameChanged() { - return webDriverContainer.host != ContainerGebConfiguration.DEFAULT_HOSTNAME_FROM_CONTAINER + Reporter createReporter() { + new CompositeReporter(new PageSourceReporter()) } } \ No newline at end of file diff --git a/src/testFixtures/groovy/grails/plugin/geb/ContainerGebTestDescription.groovy b/src/testFixtures/groovy/grails/plugin/geb/ContainerGebTestDescription.groovy index d1a5cc7..ab72c14 100644 --- a/src/testFixtures/groovy/grails/plugin/geb/ContainerGebTestDescription.groovy +++ b/src/testFixtures/groovy/grails/plugin/geb/ContainerGebTestDescription.groovy @@ -19,15 +19,11 @@ import groovy.transform.CompileStatic import org.spockframework.runtime.model.IterationInfo import org.testcontainers.lifecycle.TestDescription -import java.time.LocalDateTime -import java.time.format.DateTimeFormatter - /** * Implements {@link org.testcontainers.lifecycle.TestDescription} to customize recording names. * - * @see org.testcontainers.lifecycle.TestDescription * @author James Daugherty - * @since 5.0 + * @since 4.1 */ @CompileStatic class ContainerGebTestDescription implements TestDescription { @@ -35,9 +31,9 @@ class ContainerGebTestDescription implements TestDescription { String testId String filesystemFriendlyName - ContainerGebTestDescription(IterationInfo testInfo, LocalDateTime runDate) { + ContainerGebTestDescription(IterationInfo testInfo) { testId = testInfo.displayName String safeName = testId.replaceAll('\\W+', '_') - filesystemFriendlyName = "${DateTimeFormatter.ofPattern('yyyyMMdd_HHmmss').format(runDate)}_${safeName}" + filesystemFriendlyName = safeName } } diff --git a/src/testFixtures/groovy/grails/plugin/geb/GebOnFailureReporter.groovy b/src/testFixtures/groovy/grails/plugin/geb/GebOnFailureReporter.groovy new file mode 100644 index 0000000..9a18947 --- /dev/null +++ b/src/testFixtures/groovy/grails/plugin/geb/GebOnFailureReporter.groovy @@ -0,0 +1,46 @@ +/* + * Copyright 2016 the 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 + * + * 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 grails.plugin.geb + +import groovy.transform.CompileStatic +import org.opentest4j.IncompleteExecutionException +import org.spockframework.runtime.extension.IMethodInterceptor +import org.spockframework.runtime.extension.IMethodInvocation + +/** + * This class is a direct clone of {@link geb.spock.OnFailureReporter OnFailureReporter}, except it works for the + * {@link grails.plugin.geb.ContainerGebSpec ContainerGebSpec}. + */ +@CompileStatic +class GebOnFailureReporter implements IMethodInterceptor { + void intercept(IMethodInvocation invocation) throws Throwable { + try { + invocation.proceed() + } catch (IncompleteExecutionException notACauseForReporting) { + throw notACauseForReporting + } catch (Throwable throwable) { + ContainerGebSpec spec = invocation.instance as ContainerGebSpec + if (spec.testManager.reportingEnabled) { + try { + spec.testManager.reportFailure() + } catch (ignored) { + //ignore + } + } + throw throwable + } + } +} diff --git a/src/testFixtures/groovy/grails/plugin/geb/ContainerGebTestListener.groovy b/src/testFixtures/groovy/grails/plugin/geb/GebRecordingTestListener.groovy similarity index 81% rename from src/testFixtures/groovy/grails/plugin/geb/ContainerGebTestListener.groovy rename to src/testFixtures/groovy/grails/plugin/geb/GebRecordingTestListener.groovy index 5da846a..a4bbf05 100644 --- a/src/testFixtures/groovy/grails/plugin/geb/ContainerGebTestListener.groovy +++ b/src/testFixtures/groovy/grails/plugin/geb/GebRecordingTestListener.groovy @@ -30,26 +30,22 @@ import java.time.LocalDateTime * @see org.testcontainers.containers.BrowserWebDriverContainer#afterTest * * @author James Daugherty - * @since 5.0 + * @since 4.1 */ @CompileStatic -class ContainerGebTestListener extends AbstractRunListener { +class GebRecordingTestListener extends AbstractRunListener { WebDriverContainerHolder containerHolder ErrorInfo errorInfo - SpecInfo spec - LocalDateTime runDate - ContainerGebTestListener(WebDriverContainerHolder containerHolder, SpecInfo spec, LocalDateTime runDate) { - this.spec = spec - this.runDate = runDate + GebRecordingTestListener(WebDriverContainerHolder containerHolder) { this.containerHolder = containerHolder } @Override void afterIteration(IterationInfo iteration) { containerHolder.currentContainer.afterTest( - new ContainerGebTestDescription(iteration, runDate), + new ContainerGebTestDescription(iteration), Optional.ofNullable(errorInfo?.exception) ) errorInfo = null diff --git a/src/testFixtures/groovy/grails/plugin/geb/GebTestManagerProvider.groovy b/src/testFixtures/groovy/grails/plugin/geb/GebTestManagerProvider.groovy deleted file mode 100644 index 454daa1..0000000 --- a/src/testFixtures/groovy/grails/plugin/geb/GebTestManagerProvider.groovy +++ /dev/null @@ -1,71 +0,0 @@ -/* - * 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. - */ -package grails.plugin.geb - -import geb.spock.SpockGebTestManagerBuilder -import geb.test.GebTestManager -import groovy.transform.CompileStatic - -/** - * A provider class for managing instances of {@link GebTestManager}. - * This class uses the Initialization-on-Demand Holder Idiom to ensure thread-safe, - * lazy initialization of {@link GebTestManager} instances for use in Geb tests. - * - *
The class provides two static instances:
- *This class cannot be instantiated, as it is designed to be used as a - * utility provider.
- * - * @see GebTestManager - * @see SpockGebTestManagerBuilder - * - * @author Mattias Reichel - * @author Søren Berg Glasius - * @since 5.0 - */ -@CompileStatic -class GebTestManagerProvider { - - /** - * A lazily and thread-safe-initialized instance of {@link GebTestManager}. - * Built using {@link SpockGebTestManagerBuilder}. - */ - @Lazy - static volatile GebTestManager instance = { - new SpockGebTestManagerBuilder().build() - }() - - /** - * A lazily and thread-safe-initialized instance of {@link GebTestManager} - * with reporting enabled. Built using {@link SpockGebTestManagerBuilder}. - */ - @Lazy - static volatile GebTestManager reportingInstance = { - new SpockGebTestManagerBuilder() - .withReportingEnabled(true) - .build() - }() - - /** - * Private constructor to prevent instantiation of this utility class. - */ - private GebTestManagerProvider() {} - -} \ No newline at end of file diff --git a/src/testFixtures/groovy/grails/plugin/geb/GrailsContainerGebExtension.groovy b/src/testFixtures/groovy/grails/plugin/geb/GrailsContainerGebExtension.groovy new file mode 100644 index 0000000..3a60fe1 --- /dev/null +++ b/src/testFixtures/groovy/grails/plugin/geb/GrailsContainerGebExtension.groovy @@ -0,0 +1,146 @@ +/* + * 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. + */ +package grails.plugin.geb + +import grails.testing.mixin.integration.Integration +import groovy.transform.CompileStatic +import groovy.transform.TailRecursive +import groovy.util.logging.Slf4j +import org.spockframework.runtime.extension.IGlobalExtension +import org.spockframework.runtime.model.MethodInfo +import org.spockframework.runtime.model.SpecInfo +import org.spockframework.runtime.model.parallel.ExclusiveResource +import org.spockframework.runtime.model.parallel.ResourceAccessMode + +import java.time.LocalDateTime + +/** + * A Spock Extension that manages the Testcontainers lifecycle for a {@link grails.plugin.geb.ContainerGebSpec} + * + * ContainerGebSpec cannot be a {@link geb.test.ManagedGebTest ManagedGebTest} because it would cause the test manager
+ * to be initialized out of sequence of the container management. Instead, we initialize the same interceptors
+ * as the {@link geb.spock.GebExtension GebExtension} does.
+ *
+ * @author James Daugherty
+ * @since 4.1
+ */
+@Slf4j
+@CompileStatic
+class GrailsContainerGebExtension implements IGlobalExtension {
+
+ ExclusiveResource exclusiveResource
+ WebDriverContainerHolder holder
+
+ @Override
+ void start() {
+ exclusiveResource = new ExclusiveResource(
+ ContainerGebSpec.name,
+ ResourceAccessMode.READ_WRITE
+ )
+ holder = new WebDriverContainerHolder(
+ new GrailsGebSettings(LocalDateTime.now())
+ )
+ addShutdownHook {
+ holder.stop()
+ }
+ }
+
+ @Override
+ void stop() {
+ holder.stop()
+ }
+
+ @Override
+ void visitSpec(SpecInfo spec) {
+ if (isContainerGebSpec(spec) && validateContainerGebSpec(spec)) {
+ // Do not allow parallel execution since there's only 1 set of containers in testcontainers
+ spec.addExclusiveResource(exclusiveResource)
+
+ // Always initialize the container requirements first so the GebTestManager can properly configure the browser
+ spec.addSharedInitializerInterceptor { invocation ->
+ holder.reinitialize(invocation)
+
+ ContainerGebSpec gebSpec = invocation.sharedInstance as ContainerGebSpec
+ gebSpec.container = holder.currentContainer
+ gebSpec.testManager = holder.testManager
+ gebSpec.downloadSupport = new LocalhostDownloadSupport(
+ holder.currentBrowser,
+ holder.hostNameFromHost
+ )
+
+ // code below here is from the geb.spock.GebExtension since there can only be 1 shared initializer per extension
+ holder.testManager.beforeTestClass(invocation.spec.reflection)
+ invocation.proceed()
+ }
+
+ spec.addSetupInterceptor {
+ // Grails will be initialized by this point, so setup the browser url correctly
+ holder.setupBrowserUrl(it)
+ }
+
+ spec.addInterceptor { invocation ->
+ try {
+ invocation.proceed()
+ } finally {
+ holder.testManager.afterTestClass()
+ }
+ }
+
+ spec.allFeatures*.addIterationInterceptor { invocation ->
+ holder.testManager.beforeTest(invocation.instance.getClass(), invocation.iteration.displayName)
+ try {
+ invocation.proceed()
+ } finally {
+ holder.testManager.afterTest()
+ }
+ }
+
+ addGebExtensionOnFailureReporter(spec)
+
+ GebRecordingTestListener recordingListener = new GebRecordingTestListener(
+ holder
+ )
+ spec.addListener(recordingListener)
+ }
+ }
+
+ @TailRecursive
+ private boolean isContainerGebSpec(SpecInfo spec) {
+ if (spec != null) {
+ if (spec.filename.startsWith("${ContainerGebSpec.simpleName}." as String)) {
+ return true
+ }
+ return isContainerGebSpec(spec.superSpec)
+ }
+ return false
+ }
+
+ private static boolean validateContainerGebSpec(SpecInfo specInfo) {
+ if (!specInfo.annotations.find { it.annotationType() == Integration }) {
+ throw new IllegalArgumentException('ContainerGebSpec classes must be annotated with @Integration')
+ }
+
+ return true
+ }
+
+ private static void addGebExtensionOnFailureReporter(SpecInfo spec) {
+ List This is useful when using any of the {@code download*()} methods as they will connect from the host,
+ * and not from within the container.
+ * Defaults to {@code localhost}. If the value returned by {@code webDriverContainer.getHost()}
+ * is different from the default, this method will return the same value same as {@code webDriverContainer.getHost()}.
+ *
+ * @return the hostname for accessing the server under test from the host
+ */
+ String getHostNameFromHost() {
+ return hostNameChanged ? currentContainer.host : DEFAULT_HOSTNAME_FROM_HOST
+ }
+
+ private boolean isHostNameChanged() {
+ return currentContainer.host != ContainerGebConfiguration.DEFAULT_HOSTNAME_FROM_CONTAINER
+ }
+
@CompileStatic
@EqualsAndHashCode
private static class WebDriverContainerConfiguration {
String protocol
String hostName
- int port
+ boolean reporting
- WebDriverContainerConfiguration(int port, SpecInfo spec) {
+ WebDriverContainerConfiguration(SpecInfo spec) {
ContainerGebConfiguration configuration = spec.annotations.find {
it.annotationType() == ContainerGebConfiguration
} as ContainerGebConfiguration
protocol = configuration?.protocol() ?: ContainerGebConfiguration.DEFAULT_PROTOCOL
hostName = configuration?.hostName() ?: ContainerGebConfiguration.DEFAULT_HOSTNAME_FROM_CONTAINER
- this.port = port
+ reporting = configuration?.reporting() ?: false
}
}
}
diff --git a/src/testFixtures/resources/META-INF/services/org.spockframework.runtime.extension.IGlobalExtension b/src/testFixtures/resources/META-INF/services/org.spockframework.runtime.extension.IGlobalExtension
index 893fab6..cd6ea72 100644
--- a/src/testFixtures/resources/META-INF/services/org.spockframework.runtime.extension.IGlobalExtension
+++ b/src/testFixtures/resources/META-INF/services/org.spockframework.runtime.extension.IGlobalExtension
@@ -1 +1 @@
-grails.plugin.geb.ContainerGebRecordingExtension
\ No newline at end of file
+grails.plugin.geb.GrailsContainerGebExtension
\ No newline at end of file