Skip to content

Commit 63ce158

Browse files
matreimatrei
committed
Deploying to documentation branch - 10:08:03
1 parent 436f1b2 commit 63ce158

39 files changed

Lines changed: 571 additions & 473 deletions

‎snapshot/api/grails/plugin/geb/ContainerFileDetector.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ <h2 title="[Groovy] Interface ContainerFileDetector" class="title">[Groovy] Inte
111111
<p> An extension of org.openqa.selenium.remote.FileDetector
112112
that will get passed additional parameters from the webdriver container holder.
113113
<p>
114-
Implementations must provide a zero-argument constructor to ensure compatibility with java.util.ServiceLoader. <DL><DT><B>See Also:</B></DT><DD><a href='../../../grails/plugin/geb/GebRecordingTestListener.html' title='GebRecordingTestListener'>GebRecordingTestListener</a></DD></DL></p>
114+
Implementations must provide a zero-argument constructor to ensure compatibility
115+
with java.util.ServiceLoader. <DL><DT><B>See Also:</B></DT><DD><a href='../../../grails/plugin/geb/GebRecordingTestListener.html' title='GebRecordingTestListener'>GebRecordingTestListener</a></DD></DL></p>
115116

116117
</li>
117118
</ul>

‎snapshot/api/grails/plugin/geb/ContainerGebConfiguration.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h2 title="[Groovy] Annotation Type ContainerGebConfiguration" class="title">[Gr
110110
@java.lang.annotation.Retention(value: RetentionPolicy.RUNTIME)
111111
@interface ContainerGebConfiguration</pre>
112112

113-
<p> Can be used to configure the protocol and hostname that the container's browser will use <DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
113+
<p> Can be used to configure the protocol and hostname that the container's browser will use. <DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
114114

115115
</li>
116116
</ul>
@@ -204,7 +204,8 @@ <h3>Methods Summary</h3>
204204
<tr class="rowColor">
205205
<td class="colFirst"><code></code></td>
206206
<td class="colLast"><code>abstract&nbsp;boolean</code></td>
207-
<td class="colLast"><code><strong><a href="#reporting()">reporting</a></strong>()</code><br>Whether reporting should be enabled for this test. </td>
207+
<td class="colLast"><code><strong><a href="#reporting()">reporting</a></strong>()</code><br>Whether reporting should be enabled for this test.
208+
</td>
208209
</tr>
209210

210211
</table>
@@ -324,7 +325,8 @@ <h4>abstract&nbsp;java.lang.String <strong>protocol</strong>()</h4>
324325
<ul class="blockListLast">
325326
<li class="blockList">
326327
<h4>abstract&nbsp;boolean <strong>reporting</strong>()</h4>
327-
<p> Whether reporting should be enabled for this test. Add a `GebConfig.groovy` to customize the reporter configuration.</p>
328+
<p> Whether reporting should be enabled for this test.
329+
Add a `GebConfig.groovy` to customize the reporter configuration.</p>
328330
</li>
329331
</ul>
330332

‎snapshot/api/grails/plugin/geb/ContainerGebSpec.html‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,14 @@ <h2 title="[Groovy] Class ContainerGebSpec" class="title">[Groovy] Class Contain
111111
extends <a href='../../../spock.lang.Specification.html'>Specification</a>
112112
implements <a href='../../../grails/plugin/geb/support/delegate/BrowserDelegate.html'>BrowserDelegate</a>, <a href='../../../grails/plugin/geb/support/ContainerSupport.html'>ContainerSupport</a>, <a href='../../../grails/plugin/geb/support/delegate/DownloadSupportDelegate.html'>DownloadSupportDelegate</a>, <a href='../../../grails/plugin/geb/support/delegate/DriverDelegate.html'>DriverDelegate</a>, <a href='../../../grails/plugin/geb/support/delegate/PageDelegate.html'>PageDelegate</a>, <a href='../../../grails/plugin/geb/support/ReportingSupport.html'>ReportingSupport</a></pre>
113113

114-
<p> A geb.spock.GebSpec that leverages Testcontainers to run the browser inside a container.
114+
<p> A geb.spock.GebSpec that leverages Testcontainers
115+
to run the browser inside a container.
115116

116117
<p>Prerequisites:
117118
<ul>
118119
<li>
119-
The test class must be annotated with <a href='../../../grails/testing/mixin/integration/Integration.html' title='@Integration'>@Integration</a>.
120+
The test class must be annotated with
121+
<a href='../../../grails/testing/mixin/integration/Integration.html' title='@Integration'>@Integration</a>.
120122
</li>
121123
<li>
122124
A <a href="https://java.testcontainers.org/supported_docker_environment/">compatible container runtime</a>
@@ -206,6 +208,12 @@ <h3>Methods Summary</h3>
206208
</tr>
207209

208210
<tr class="altColor">
211+
<td class="colFirst"><code></code></td>
212+
<td class="colLast"><code><a href='../../../geb.Page.html'>Page</a></code></td>
213+
<td class="colLast"><code><strong><a href="#getPage()">getPage</a></strong>()</code><br></td>
214+
</tr>
215+
216+
<tr class="rowColor">
209217
<td class="colFirst"><code></code></td>
210218
<td class="colLast"><code>static&nbsp;void</code></td>
211219
<td class="colLast"><code><strong><a href="#setTestManager(geb.test.GebTestManager)">setTestManager</a></strong>(<a href='../../../geb.test.GebTestManager.html'>GebTestManager</a> testManager)</code><br></td>
@@ -279,6 +287,14 @@ <h4><strong>ContainerGebSpec</strong>()</h4>
279287
</a>
280288
<h3>Method Detail</h3>
281289

290+
<a name="getPage()"><!-- --></a>
291+
<ul class="blockListLast">
292+
<li class="blockList">
293+
<h4>@java.lang.Override<br><a href='../../../geb.Page.html'>Page</a> <strong>getPage</strong>()</h4>
294+
<p></p>
295+
</li>
296+
</ul>
297+
282298
<a name="setTestManager(geb.test.GebTestManager)"><!-- --></a>
283299
<ul class="blockListLast">
284300
<li class="blockList">

‎snapshot/api/grails/plugin/geb/ContainerGebTestDescription.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ <h2 title="[Groovy] Class ContainerGebTestDescription" class="title">[Groovy] Cl
111111
extends java.lang.Object
112112
implements <a href='../../../org.testcontainers.lifecycle.TestDescription.html'>TestDescription</a></pre>
113113

114-
<p> Implements org.testcontainers.lifecycle.TestDescription to customize recording names. <DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
114+
<p> Implements org.testcontainers.lifecycle.TestDescription
115+
to customize recording names. <DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
115116

116117
</li>
117118
</ul>

‎snapshot/api/grails/plugin/geb/GebOnFailureReporter.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h2 title="[Groovy] Class GebOnFailureReporter" class="title">[Groovy] Class Geb
111111
extends java.lang.Object
112112
implements <a href='../../../org.spockframework.runtime.extension.IMethodInterceptor.html'>IMethodInterceptor</a></pre>
113113

114-
<p> This class is a direct clone of geb.spock.OnFailureReporter, except it works for the
114+
<p> Adapts geb.spock.OnFailureReporter for use with
115115
<a href='../../../grails/plugin/geb/ContainerGebSpec.html' title='ContainerGebSpec'>ContainerGebSpec</a>.</p>
116116

117117
</li>

‎snapshot/api/grails/plugin/geb/GebRecordingTestListener.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,9 @@ <h2 title="[Groovy] Class GebRecordingTestListener" class="title">[Groovy] Class
106106
class GebRecordingTestListener
107107
extends <a href='../../../org.spockframework.runtime.AbstractRunListener.html'>AbstractRunListener</a></pre>
108108

109-
<p> A test listener that reports the test result to org.testcontainers.containers.BrowserWebDriverContainer so
110-
that recordings may be saved. <DL><DT><B>See Also:</B></DT><DD>org.testcontainers.containers.BrowserWebDriverContainer#afterTest</DD></DL><DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
109+
<p> A test listener that reports the test result to
110+
org.testcontainers.containers.BrowserWebDriverContainer
111+
so that recordings may be saved. <DL><DT><B>See Also:</B></DT><DD>org.testcontainers.containers.BrowserWebDriverContainer#afterTest</DD></DL><DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
111112

112113
</li>
113114
</ul>

‎snapshot/api/grails/plugin/geb/GrailsContainerGebExtension.html‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,14 @@ <h2 title="[Groovy] Class GrailsContainerGebExtension" class="title">[Groovy] Cl
111111
extends java.lang.Object
112112
implements <a href='../../../org.spockframework.runtime.extension.IGlobalExtension.html'>IGlobalExtension</a></pre>
113113

114-
<p> A Spock Extension that manages the Testcontainers lifecycle for a <a href='../../../grails/plugin/geb/ContainerGebSpec.html' title='ContainerGebSpec'>ContainerGebSpec</a>
114+
<p> A Spock Extension that manages the Testcontainers
115+
lifecycle for a <a href='../../../grails/plugin/geb/ContainerGebSpec.html' title='ContainerGebSpec'>ContainerGebSpec</a>.
115116

116-
<p> ContainerGebSpec cannot be a geb.test.ManagedGebTest because it would cause the test manager
117-
to be initialized out of sequence of the container management. Instead, we initialize the same interceptors
118-
as the geb.spock.GebExtension does. <DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
117+
<p>
118+
<a href='../../../grails/plugin/geb/ContainerGebSpec.html' title='ContainerGebSpec'>ContainerGebSpec</a> cannot be a
119+
geb.test.ManagedGebTest because it would cause the test
120+
manager to be initialized out of sequence of the container management.
121+
Instead, we initialize the same interceptors as the geb.spock.GebExtension does. <DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
119122

120123
</li>
121124
</ul>

‎snapshot/api/grails/plugin/geb/GrailsGebSettings.html‎

Lines changed: 65 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ <h2 title="[Groovy] Class GrailsGebSettings" class="title">[Groovy] Class Grails
106106
class GrailsGebSettings
107107
extends java.lang.Object</pre>
108108

109-
<p> Handles parsing various recording configuration used by <a href='../../../grails/plugin/geb/GrailsContainerGebExtension.html' title='GrailsContainerGebExtension'>GrailsContainerGebExtension</a> <DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
109+
<p> Handles parsing various recording configuration
110+
used by <a href='../../../grails/plugin/geb/GrailsContainerGebExtension.html' title='GrailsContainerGebExtension'>GrailsContainerGebExtension</a>. <DL><DT><B>Authors:</B></DT><DD>James Daugherty</DD></DL><DL><DT><B>Since:</B></DT><DD>4.1</DD></DL></p>
110111

111112
</li>
112113
</ul>
@@ -135,18 +136,24 @@ <h3>Field Summary</h3>
135136
</tr>
136137

137138
<tr class="altColor">
139+
<td class="colFirst"><code><strong>static&nbsp;boolean</strong></code>&nbsp;</td>
140+
<td class="colLast"><code><a href="#DEFAULT_AT_CHECK_WAITING">DEFAULT_AT_CHECK_WAITING</a></code></td>
141+
<td class="colLast"></td>
142+
</tr>
143+
144+
<tr class="rowColor">
138145
<td class="colFirst"><code><strong>static&nbsp;int</strong></code>&nbsp;</td>
139146
<td class="colLast"><code><a href="#DEFAULT_TIMEOUT_IMPLICITLY_WAIT">DEFAULT_TIMEOUT_IMPLICITLY_WAIT</a></code></td>
140147
<td class="colLast"></td>
141148
</tr>
142149

143-
<tr class="rowColor">
150+
<tr class="altColor">
144151
<td class="colFirst"><code><strong>static&nbsp;int</strong></code>&nbsp;</td>
145152
<td class="colLast"><code><a href="#DEFAULT_TIMEOUT_PAGE_LOAD">DEFAULT_TIMEOUT_PAGE_LOAD</a></code></td>
146153
<td class="colLast"></td>
147154
</tr>
148155

149-
<tr class="altColor">
156+
<tr class="rowColor">
150157
<td class="colFirst"><code><strong>static&nbsp;int</strong></code>&nbsp;</td>
151158
<td class="colLast"><code><a href="#DEFAULT_TIMEOUT_SCRIPT">DEFAULT_TIMEOUT_SCRIPT</a></code></td>
152159
<td class="colLast"></td>
@@ -173,40 +180,50 @@ <h3>Properties Summary</h3>
173180
</tr>
174181

175182
<tr class="altColor">
183+
<td class="colFirst"><code><strong>boolean</strong></code>&nbsp;</td>
184+
<td class="colLast"><code><a href="#atCheckWaiting">atCheckWaiting</a></code><br></td>
185+
</tr>
186+
187+
<tr class="rowColor">
176188
<td class="colFirst"><code><strong>int</strong></code>&nbsp;</td>
177189
<td class="colLast"><code><a href="#implicitlyWait">implicitlyWait</a></code><br></td>
178190
</tr>
179191

180-
<tr class="rowColor">
192+
<tr class="altColor">
181193
<td class="colFirst"><code><strong>int</strong></code>&nbsp;</td>
182194
<td class="colLast"><code><a href="#pageLoadTimeout">pageLoadTimeout</a></code><br></td>
183195
</tr>
184196

185-
<tr class="altColor">
197+
<tr class="rowColor">
186198
<td class="colFirst"><code><strong>java.lang.String</strong></code>&nbsp;</td>
187199
<td class="colLast"><code><a href="#recordingDirectoryName">recordingDirectoryName</a></code><br></td>
188200
</tr>
189201

190-
<tr class="rowColor">
202+
<tr class="altColor">
191203
<td class="colFirst"><code><strong><a href='../../../VncRecordingFormat.html'>VncRecordingFormat</a></strong></code>&nbsp;</td>
192204
<td class="colLast"><code><a href="#recordingFormat">recordingFormat</a></code><br></td>
193205
</tr>
194206

195-
<tr class="altColor">
207+
<tr class="rowColor">
196208
<td class="colFirst"><code><strong><a href='../../../VncRecordingMode.html'>VncRecordingMode</a></strong></code>&nbsp;</td>
197209
<td class="colLast"><code><a href="#recordingMode">recordingMode</a></code><br></td>
198210
</tr>
199211

200-
<tr class="rowColor">
212+
<tr class="altColor">
201213
<td class="colFirst"><code><strong>java.lang.String</strong></code>&nbsp;</td>
202214
<td class="colLast"><code><a href="#reportingDirectoryName">reportingDirectoryName</a></code><br></td>
203215
</tr>
204216

205-
<tr class="altColor">
217+
<tr class="rowColor">
206218
<td class="colFirst"><code><strong>boolean</strong></code>&nbsp;</td>
207219
<td class="colLast"><code><a href="#restartRecordingContainerPerTest">restartRecordingContainerPerTest</a></code><br></td>
208220
</tr>
209221

222+
<tr class="altColor">
223+
<td class="colFirst"><code><strong>java.lang.Number</strong></code>&nbsp;</td>
224+
<td class="colLast"><code><a href="#retryInterval">retryInterval</a></code><br></td>
225+
</tr>
226+
210227
<tr class="rowColor">
211228
<td class="colFirst"><code><strong>int</strong></code>&nbsp;</td>
212229
<td class="colLast"><code><a href="#scriptTimeout">scriptTimeout</a></code><br></td>
@@ -218,7 +235,12 @@ <h3>Properties Summary</h3>
218235
</tr>
219236

220237
<tr class="rowColor">
221-
<td class="colFirst"><code><strong>java.lang.String</strong></code>&nbsp;</td>
238+
<td class="colFirst"><code><strong>java.lang.Number</strong></code>&nbsp;</td>
239+
<td class="colLast"><code><a href="#timeout">timeout</a></code><br></td>
240+
</tr>
241+
242+
<tr class="altColor">
243+
<td class="colFirst"><code><strong>boolean</strong></code>&nbsp;</td>
222244
<td class="colLast"><code><a href="#tracingEnabled">tracingEnabled</a></code><br></td>
223245
</tr>
224246

@@ -329,6 +351,14 @@ <h3>Inherited Methods Summary</h3>
329351
</a>
330352
<h3>Field Detail</h3>
331353

354+
<a name="DEFAULT_AT_CHECK_WAITING"><!-- --></a>
355+
<ul class="blockListLast">
356+
<li class="blockList">
357+
<h4>public&nbsp;static&nbsp;boolean <strong>DEFAULT_AT_CHECK_WAITING</strong></h4>
358+
<p></p>
359+
</li>
360+
</ul>
361+
332362
<a name="DEFAULT_TIMEOUT_IMPLICITLY_WAIT"><!-- --></a>
333363
<ul class="blockListLast">
334364
<li class="blockList">
@@ -365,6 +395,14 @@ <h4>public&nbsp;static&nbsp;int <strong>DEFAULT_TIMEOUT_SCRIPT</strong></h4>
365395
</a>
366396
<h3>Property Detail</h3>
367397

398+
<a name="atCheckWaiting"><!-- --></a>
399+
<ul class="blockListLast">
400+
<li class="blockList">
401+
<h4>boolean <strong>atCheckWaiting</strong></h4>
402+
<p></p>
403+
</li>
404+
</ul>
405+
368406
<a name="implicitlyWait"><!-- --></a>
369407
<ul class="blockListLast">
370408
<li class="blockList">
@@ -421,6 +459,14 @@ <h4>boolean <strong>restartRecordingContainerPerTest</strong></h4>
421459
</li>
422460
</ul>
423461

462+
<a name="retryInterval"><!-- --></a>
463+
<ul class="blockListLast">
464+
<li class="blockList">
465+
<h4>java.lang.Number <strong>retryInterval</strong></h4>
466+
<p></p>
467+
</li>
468+
</ul>
469+
424470
<a name="scriptTimeout"><!-- --></a>
425471
<ul class="blockListLast">
426472
<li class="blockList">
@@ -437,10 +483,18 @@ <h4>java.time.LocalDateTime <strong>startTime</strong></h4>
437483
</li>
438484
</ul>
439485

486+
<a name="timeout"><!-- --></a>
487+
<ul class="blockListLast">
488+
<li class="blockList">
489+
<h4>java.lang.Number <strong>timeout</strong></h4>
490+
<p></p>
491+
</li>
492+
</ul>
493+
440494
<a name="tracingEnabled"><!-- --></a>
441495
<ul class="blockListLast">
442496
<li class="blockList">
443-
<h4>java.lang.String <strong>tracingEnabled</strong></h4>
497+
<h4>boolean <strong>tracingEnabled</strong></h4>
444498
<p></p>
445499
</li>
446500
</ul>

0 commit comments

Comments
 (0)