Skip to content

Commit 29bd432

Browse files
committed
Update docs for release 6.3.0
1 parent fa0a3d9 commit 29bd432

File tree

6 files changed

+64
-19
lines changed

6 files changed

+64
-19
lines changed

docs/css/PublicaPlay-Regular.woff

43.9 KB
Binary file not shown.

docs/css/styles.css

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ p a > code:hover { color: #444444; }
301301
#header:after, #content:after, #footnotes:after, #footer:after { clear: both; }
302302

303303
#header { margin-bottom: 2.5em; }
304-
#header > h1 { color: #616366; font-weight: normal; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; padding-top: 10px; background: url('./img/seljup.png') no-repeat left 8.25em top 0em;}
304+
#header > h1 { color: #616366; font-family:'Publica Play Regular'; font-weight: normal; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; padding-top: 10px; background: url('./img/seljup.png') no-repeat left 8.25em top 0em;}
305305
#header span { color: #616366; }
306306
#header #revnumber { text-transform: capitalize; }
307307
#header br { display: none; }
@@ -651,4 +651,11 @@ table.tableblock.grid-all { -webkit-border-radius: 0; border-radius: 0; -webkit-
651651

652652
#footer { background-image: url('./img/footer-bg.jpg'); padding: 25px 0; }
653653

654-
#footer-text { color: #fff; text-shadow: 1px 1px 1px #333; font-size: 80%; text-align: center; }
654+
#footer-text { color: #fff; text-shadow: 1px 1px 1px #333; font-size: 80%; text-align: center; }
655+
656+
@font-face {
657+
font-family: 'Publica Play Regular';
658+
font-style: normal;
659+
font-weight: normal;
660+
src: url('./css/PublicaPlay-Regular.woff') format('woff');
661+
}
90.8 KB
Loading
123 KB
Loading

docs/index.html

Lines changed: 55 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@
311311
#header:after, #content:after, #footnotes:after, #footer:after { clear: both; }
312312

313313
#header { margin-bottom: 2.5em; }
314-
#header > h1 { color: #616366; font-weight: normal; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; padding-top: 10px; background: url('./img/seljup.png') no-repeat left 8.25em top 0em;}
314+
#header > h1 { color: #616366; font-family:'Publica Play Regular'; font-weight: normal; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; padding-top: 10px; background: url('./img/seljup.png') no-repeat left 8.25em top 0em;}
315315
#header span { color: #616366; }
316316
#header #revnumber { text-transform: capitalize; }
317317
#header br { display: none; }
@@ -662,6 +662,13 @@
662662
#footer { background-image: url('./img/footer-bg.jpg'); padding: 25px 0; }
663663

664664
#footer-text { color: #fff; text-shadow: 1px 1px 1px #333; font-size: 80%; text-align: center; }
665+
666+
@font-face {
667+
font-family: 'Publica Play Regular';
668+
font-style: normal;
669+
font-weight: normal;
670+
src: url('./css/PublicaPlay-Regular.woff') format('woff');
671+
}
665672
</style>
666673
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
667674
<style>
@@ -776,7 +783,7 @@
776783
<h1>Selenium-Jupiter</h1>
777784
<div class="details">
778785
<span id="author" class="author">Boni García</span><br>
779-
<span id="revdate">Version 6.2.0</span>
786+
<span id="revdate">Version 6.3.0</span>
780787
</div>
781788
<div id="toc" class="toc2">
782789
<div id="toctitle">Table of Contents</div>
@@ -815,6 +822,7 @@ <h1>Selenium-Jupiter</h1>
815822
<li><a href="#single-session">3.10. Single session</a></li>
816823
<li><a href="#screenshots">3.11. Screenshots</a></li>
817824
<li><a href="#integration-with-jenkins">3.12. Integration with Jenkins</a></li>
825+
<li><a href="#reporting">3.13. Reporting</a></li>
818826
</ul>
819827
</li>
820828
<li><a href="#examples">4. Examples</a></li>
@@ -935,7 +943,7 @@ <h2 id="setup"><a class="anchor" href="#setup"></a>2. Setup</h2>
935943
<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;dependency&gt;</span>
936944
<span class="tag">&lt;groupId&gt;</span>io.github.bonigarcia<span class="tag">&lt;/groupId&gt;</span>
937945
<span class="tag">&lt;artifactId&gt;</span>selenium-jupiter<span class="tag">&lt;/artifactId&gt;</span>
938-
<span class="tag">&lt;version&gt;</span>6.2.0<span class="tag">&lt;/version&gt;</span>
946+
<span class="tag">&lt;version&gt;</span>6.3.0<span class="tag">&lt;/version&gt;</span>
939947
<span class="tag">&lt;scope&gt;</span>test<span class="tag">&lt;/scope&gt;</span>
940948
<span class="tag">&lt;/dependency&gt;</span></code></pre>
941949
</div>
@@ -946,7 +954,7 @@ <h2 id="setup"><a class="anchor" href="#setup"></a>2. Setup</h2>
946954
<div class="listingblock">
947955
<div class="content">
948956
<pre class="CodeRay highlight"><code data-lang="json"><span class="error">d</span><span class="error">e</span><span class="error">p</span><span class="error">e</span><span class="error">n</span><span class="error">d</span><span class="error">e</span><span class="error">n</span><span class="error">c</span><span class="error">i</span><span class="error">e</span><span class="error">s</span> {
949-
<span class="error">t</span><span class="error">e</span><span class="error">s</span><span class="error">t</span><span class="error">I</span><span class="error">m</span><span class="error">p</span><span class="error">l</span><span class="error">e</span><span class="error">m</span><span class="error">e</span><span class="error">n</span><span class="error">t</span><span class="error">a</span><span class="error">t</span><span class="error">i</span><span class="error">o</span><span class="error">n</span><span class="error">(</span><span class="string"><span class="delimiter">&quot;</span><span class="content">io.github.bonigarcia:selenium-jupiter:6.2.0</span><span class="delimiter">&quot;</span></span><span class="error">)</span>
957+
<span class="error">t</span><span class="error">e</span><span class="error">s</span><span class="error">t</span><span class="error">I</span><span class="error">m</span><span class="error">p</span><span class="error">l</span><span class="error">e</span><span class="error">m</span><span class="error">e</span><span class="error">n</span><span class="error">t</span><span class="error">a</span><span class="error">t</span><span class="error">i</span><span class="error">o</span><span class="error">n</span><span class="error">(</span><span class="string"><span class="delimiter">&quot;</span><span class="content">io.github.bonigarcia:selenium-jupiter:6.3.0</span><span class="delimiter">&quot;</span></span><span class="error">)</span>
950958
}</code></pre>
951959
</div>
952960
</div>
@@ -1720,11 +1728,7 @@ <h3 id="template-tests"><a class="anchor" href="#template-tests"></a>3.6. Templa
17201728
[
17211729
{
17221730
<span class="key"><span class="delimiter">&quot;</span><span class="content">type</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">chrome-in-docker</span><span class="delimiter">&quot;</span></span>,
1723-
<span class="key"><span class="delimiter">&quot;</span><span class="content">version</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">dev</span><span class="delimiter">&quot;</span></span>,
1724-
<span class="key"><span class="delimiter">&quot;</span><span class="content">arguments</span><span class="delimiter">&quot;</span></span>: [
1725-
<span class="string"><span class="delimiter">&quot;</span><span class="content">--disable-gpu</span><span class="delimiter">&quot;</span></span>,
1726-
<span class="string"><span class="delimiter">&quot;</span><span class="content">--no-sandbox</span><span class="delimiter">&quot;</span></span>
1727-
]
1731+
<span class="key"><span class="delimiter">&quot;</span><span class="content">version</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">dev</span><span class="delimiter">&quot;</span></span>
17281732
}
17291733
]
17301734
]
@@ -1966,10 +1970,14 @@ <h4 id="video-recording-2"><a class="anchor" href="#video-recording-2"></a>3.7.3
19661970

19671971
seleniumJupiter.stopRecording();
19681972

1973+
<span class="comment">// Get recording as path</span>
19691974
Path recordingPath = seleniumJupiter.getRecordingPath();
19701975
assertThat(recordingPath).exists();
1971-
19721976
log.debug(<span class="string"><span class="delimiter">&quot;</span><span class="content">Recording available at {}</span><span class="delimiter">&quot;</span></span>, recordingPath);
1977+
1978+
<span class="comment">// Get recording as base64</span>
1979+
<span class="predefined-type">String</span> recordingBase64 = seleniumJupiter.getRecordingBase64();
1980+
assertThat(recordingBase64).isNotEmpty();
19731981
}
19741982

19751983
}</code></pre>
@@ -2089,10 +2097,10 @@ <h3 id="chrome-devtools"><a class="anchor" href="#chrome-devtools"></a>3.9. Chro
20892097
<span class="keyword">import</span> <span class="include">org.openqa.selenium.By</span>;
20902098
<span class="keyword">import</span> <span class="include">org.openqa.selenium.chrome.ChromeDriver</span>;
20912099
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.DevTools</span>;
2092-
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.v136.dom.model.Rect</span>;
2093-
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.v136.page.Page</span>;
2094-
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.v136.page.Page.GetLayoutMetricsResponse</span>;
2095-
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.v136.page.model.Viewport</span>;
2100+
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.v139.dom.model.Rect</span>;
2101+
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.v139.page.Page</span>;
2102+
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.v139.page.Page.GetLayoutMetricsResponse</span>;
2103+
<span class="keyword">import</span> <span class="include">org.openqa.selenium.devtools.v139.page.model.Viewport</span>;
20962104
<span class="keyword">import</span> <span class="include">org.openqa.selenium.support.ui.ExpectedConditions</span>;
20972105
<span class="keyword">import</span> <span class="include">org.openqa.selenium.support.ui.WebDriverWait</span>;
20982106

@@ -2313,6 +2321,30 @@ <h3 id="integration-with-jenkins"><a class="anchor" href="#integration-with-jenk
23132321
<div class="title">Figure 4. Example of test execution through Jenkins with attachments</div>
23142322
</div>
23152323
</div>
2324+
<div class="sect2">
2325+
<h3 id="reporting"><a class="anchor" href="#reporting"></a>3.13. Reporting</h3>
2326+
<div class="paragraph">
2327+
<p>As of version 6.3.0, Selenium-Jupiter provides built-in reporting capabilities through <a href="https://extentreports.com/">ExtentReports</a>. This feature is enabled out of the box. All the tests executed with Selenium-Jupiter in the same suite will be reported (passed, skipped, failed) in a single HTML report per test suite execution. In addition, all the video recordings, both using <code>@DockerBrowser</code> and <code>@Watch</code>, will be gathered by Selenium-Jupiter and added to the resulting report (internally, the videos are encoded as Base64 in the HTML report), for example:</p>
2328+
</div>
2329+
<div class="imageblock thumb">
2330+
<div class="content">
2331+
<img src="img/selenium-jupiter-report-example-1.png" alt="selenium jupiter report example 1">
2332+
</div>
2333+
<div class="title">Figure 5. Test report with embedded recording</div>
2334+
</div>
2335+
<div class="paragraph">
2336+
<p>Finally, when a test fails, Selenium-Jupiter will gather two troubleshooting resources from the browser. First, it will try to take a screenshot of the browser (if it is still available). Second, it will try to gather the browser console logs, if possible. The screenshot(s) and the log(s) are automatically added for failed tests, for example:</p>
2337+
</div>
2338+
<div class="imageblock thumb">
2339+
<div class="content">
2340+
<img src="img/selenium-jupiter-report-example-2.png" alt="selenium jupiter report example 2">
2341+
</div>
2342+
<div class="title">Figure 6. Test report with gathered screenshots and browser console logs</div>
2343+
</div>
2344+
<div class="paragraph">
2345+
<p>You can find a complete HTML report example in this <a href="reports/selenium-jupiter-20250902-150317.html">link</a>.</p>
2346+
</div>
2347+
</div>
23162348
</div>
23172349
</div>
23182350
<div class="sect1">
@@ -2392,7 +2424,13 @@ <h2 id="advanced-configuration"><a class="anchor" href="#advanced-configuration"
23922424
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>setOutputFolder(String)</code> <code>useSurefireOutputFolder()</code></p></td>
23932425
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sel.jup.output.folder</code></p></td>
23942426
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>.</code></p></td>
2395-
<td class="tableblock halign-left valign-top"><p class="tableblock">Output folder for recordings and screenshots. This key accepts the special value <code>surefire-reports</code> for the <a href="#integration-with-jenkins">integration with Jenkins</a>. In case of the special value <code>surefire-reports</code> there will <strong>always</strong> be a separate output folder per class (see below, <code>setOutputFolderPerClass(boolean)</code>).</p></td>
2427+
<td class="tableblock halign-left valign-top"><p class="tableblock">Output folder for recordings, screenshots, and reports. This key accepts the special value <code>surefire-reports</code> for the <a href="#integration-with-jenkins">integration with Jenkins</a>. In case of the special value <code>surefire-reports</code> there will <strong>always</strong> be a separate output folder per class (see below, <code>setOutputFolderPerClass(boolean)</code>).</p></td>
2428+
</tr>
2429+
<tr>
2430+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>setReportFileName(String)</code></p></td>
2431+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sel.jup.report.file.name</code></p></td>
2432+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>selenium-jupiter-{date}.html</code></p></td>
2433+
<td class="tableblock halign-left valign-top"><p class="tableblock">File name for the HTML report created in each test suite execution. If the <code>{date}</code> placeholder is used in this name, the system timestamp is added. By default, this file is created in the current folder (see previous configuration key).</p></td>
23962434
</tr>
23972435
<tr>
23982436
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>setOutputFolderPerClass(boolean)</code></p></td>
@@ -2614,8 +2652,8 @@ <h2 id="about"><a class="anchor" href="#about"></a>10. About</h2>
26142652
</div>
26152653
<div id="footer">
26162654
<div id="footer-text">
2617-
Version 6.2.0<br>
2618-
Updated on 18-07-2025
2655+
Version 6.3.0<br>
2656+
Updated on 02-09-2025
26192657
</div>
26202658
</div>
26212659
</body>

docs/selenium-jupiter.pdf

206 KB
Binary file not shown.

0 commit comments

Comments
 (0)