Skip to content

Commit

Permalink
Update generate doc for version 5.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@bonigarcia
bonigarcia committed Jun 21, 2023
1 parent 7416e90 commit 958fe4e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 18 deletions.
48 changes: 30 additions & 18 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,7 @@
<h1>WebDriverManager</h1>
<div class="details">
<span id="author" class="author">Boni García</span><br>
<span id="revdate">Version 5.3.3</span>
<span id="revdate">Version 5.4.0</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
Expand Down Expand Up @@ -971,7 +971,7 @@ <h2 id="setup"><a class="anchor" href="#setup"></a>2. Setup</h2>
<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;dependency&gt;</span>
<span class="tag">&lt;groupId&gt;</span>io.github.bonigarcia<span class="tag">&lt;/groupId&gt;</span>
<span class="tag">&lt;artifactId&gt;</span>webdrivermanager<span class="tag">&lt;/artifactId&gt;</span>
<span class="tag">&lt;version&gt;</span>5.3.3<span class="tag">&lt;/version&gt;</span>
<span class="tag">&lt;version&gt;</span>5.4.0<span class="tag">&lt;/version&gt;</span>
<span class="tag">&lt;scope&gt;</span>test<span class="tag">&lt;/scope&gt;</span>
<span class="tag">&lt;/dependency&gt;</span></code></pre>
</div>
Expand All @@ -982,7 +982,7 @@ <h2 id="setup"><a class="anchor" href="#setup"></a>2. Setup</h2>
<div class="listingblock">
<div class="content">
<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> {
<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:webdrivermanager:5.3.3</span><span class="delimiter">&quot;</span></span><span class="error">)</span>
<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:webdrivermanager:5.4.0</span><span class="delimiter">&quot;</span></span><span class="error">)</span>
}</code></pre>
</div>
</div>
Expand Down Expand Up @@ -2024,10 +2024,10 @@ <h3 id="webdrivermanager-cli"><a class="anchor" href="#webdrivermanager-cli"></a
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Using the WebDriverManager <em>fat-JAR</em> (i.e., WebDriverManager with all its dependencies in a single executable JAR file). This JAR file is generated from the source using the Maven command <code>mvn compile assembly:single</code>, and it is released on GitHub with every new version of WebDriverManager. You can download the latest of this fat-JAR from <a href="https://github.com/bonigarcia/webdrivermanager/releases/download/webdrivermanager-5.3.3/webdrivermanager-5.3.3-fat.jar">here</a>. Once you get this file, you need to use the following command in the shell (where <code>&lt;args&gt;</code> are the accepted arguments, explained below):</p>
<p>Using the WebDriverManager <em>fat-JAR</em> (i.e., WebDriverManager with all its dependencies in a single executable JAR file). This JAR file is generated from the source using the Maven command <code>mvn compile assembly:single</code>, and it is released on GitHub with every new version of WebDriverManager. You can download the latest of this fat-JAR from <a href="https://github.com/bonigarcia/webdrivermanager/releases/download/webdrivermanager-5.4.0/webdrivermanager-5.4.0-fat.jar">here</a>. Once you get this file, you need to use the following command in the shell (where <code>&lt;args&gt;</code> are the accepted arguments, explained below):</p>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.3.3-fat.jar &lt;args&gt;</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.4.0-fat.jar &lt;args&gt;</code></pre>
</div>
</div>
</li>
Expand All @@ -2043,7 +2043,7 @@ <h3 id="webdrivermanager-cli"><a class="anchor" href="#webdrivermanager-cli"></a
<p>Using the WebDriverManager Docker container. Each new release of WebDriverManager is pushed to <a href="https://hub.docker.com/r/bonigarcia/webdrivermanager">Docker Hub</a> as a container based on <a href="https://hub.docker.com/_/openjdk">OpenJDK</a> plus the WebDriverManager fat-JAR. The default command to run the WebDriverManager Docker container is described below.</p>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -e ARGS=&quot;&lt;args&gt;&quot; bonigarcia/webdrivermanager:5.3.3</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -e ARGS=&quot;&lt;args&gt;&quot; bonigarcia/webdrivermanager:5.4.0</code></pre>
</div>
</div>
</li>
Expand Down Expand Up @@ -2081,7 +2081,7 @@ <h4 id="option-1-driver-resolver" class="discrete">Option 1: Driver Resolver</h4
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.3.3-fat.jar resolveDriverFor chrome</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.4.0-fat.jar resolveDriverFor chrome</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2105,7 +2105,7 @@ <h4 id="option-1-driver-resolver" class="discrete">Option 1: Driver Resolver</h4
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -v ${PWD}:/wdm -e ARGS=&quot;resolveDriverFor chrome&quot; bonigarcia/webdrivermanager:5.3.3</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -v ${PWD}:/wdm -e ARGS=&quot;resolveDriverFor chrome&quot; bonigarcia/webdrivermanager:5.4.0</code></pre>
</div>
</div>
<h4 id="option-2-browsers-in-docker" class="discrete">Option 2: Browsers in Docker</h4>
Expand All @@ -2121,7 +2121,7 @@ <h4 id="option-2-browsers-in-docker" class="discrete">Option 2: Browsers in Dock
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.3.3-fat.jar runInDocker chrome</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.4.0-fat.jar runInDocker chrome</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2145,7 +2145,7 @@ <h4 id="option-2-browsers-in-docker" class="discrete">Option 2: Browsers in Dock
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -e ARGS=&quot;runInDocker chrome&quot; bonigarcia/webdrivermanager:5.3.3</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -e ARGS=&quot;runInDocker chrome&quot; bonigarcia/webdrivermanager:5.4.0</code></pre>
</div>
</div>
<div class="admonitionblock warning">
Expand Down Expand Up @@ -2173,7 +2173,7 @@ <h4 id="option-3-server" class="discrete">Option 3: Server</h4>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.3.3-fat.jar server</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.4.0-fat.jar server</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2197,7 +2197,7 @@ <h4 id="option-3-server" class="discrete">Option 3: Server</h4>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -p 4444:4444 -v /var/run/docker.sock:/var/run/docker.sock bonigarcia/webdrivermanager:5.3.3</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -p 4444:4444 -v /var/run/docker.sock:/var/run/docker.sock bonigarcia/webdrivermanager:5.4.0</code></pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -2314,7 +2314,7 @@ <h3 id="webdrivermanager-agent"><a class="anchor" href="#webdrivermanager-agent"
</div>
</div>
<div class="paragraph">
<p>To configure the WebDriverManager Agent, we need to specify the path of the WebDriverManager <a href="https://github.com/bonigarcia/webdrivermanager/releases/download/webdrivermanager-5.3.3/webdrivermanager-5.3.3-fat.jar">fat-JAR</a> using the JVM flag <code>-javaagent:/path/to/webdrivermanager-5.3.3-fat.jar</code>. Alternatively, it can be done using Maven (see a complete project example <a href="https://github.com/bonigarcia/wdm-agent-example/">here</a>).</p>
<p>To configure the WebDriverManager Agent, we need to specify the path of the WebDriverManager <a href="https://github.com/bonigarcia/webdrivermanager/releases/download/webdrivermanager-5.4.0/webdrivermanager-5.4.0-fat.jar">fat-JAR</a> using the JVM flag <code>-javaagent:/path/to/webdrivermanager-5.4.0-fat.jar</code>. Alternatively, it can be done using Maven (see a complete project example <a href="https://github.com/bonigarcia/wdm-agent-example/">here</a>).</p>
</div>
</div>
<div class="sect2">
Expand Down Expand Up @@ -2358,7 +2358,7 @@ <h3 id="selenium-grid"><a class="anchor" href="#selenium-grid"></a>4.5. Selenium
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">boni@ubuntu:~$ java -jar webdrivermanager-5.3.3-fat.jar resolveDriverFor chrome
<pre class="CodeRay highlight"><code data-lang="shell">boni@ubuntu:~$ java -jar webdrivermanager-5.4.0-fat.jar resolveDriverFor chrome
[INFO] Using WebDriverManager to resolve chrome
[DEBUG] Detecting chrome version using online commands.properties
[DEBUG] Running command on the shell: [google-chrome, --version]
Expand Down Expand Up @@ -2483,7 +2483,7 @@ <h2 id="advanced-configuration"><a class="anchor" href="#advanced-configuration"
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -v ${PWD}:/wdm -e ARGS=&quot;resolveDriverFor chrome&quot; -e WDM_CHROMEVERSION=84 bonigarcia/webdrivermanager:5.3.3</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -v ${PWD}:/wdm -e ARGS=&quot;resolveDriverFor chrome&quot; -e WDM_CHROMEVERSION=84 bonigarcia/webdrivermanager:5.4.0</code></pre>
</div>
</div>
<div class="admonitionblock note">
Expand Down Expand Up @@ -2767,6 +2767,12 @@ <h2 id="advanced-configuration"><a class="anchor" href="#advanced-configuration"
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3600</code> (i.e., 1 hour)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">TTL value in seconds in which the browser versions are valid in the resolution cache (also used for dockerized browsers).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>disableTracing()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.tracing=false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code> (<code>RemoteWebDriver</code> tracing enabled by default)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Disable OpenTelemetry tracing for <code>RemoteWebDriver</code></p></td>
</tr>
</tbody>
</table>
<table id="docker_config" class="tableblock frame-all grid-all stretch">
Expand Down Expand Up @@ -3052,6 +3058,12 @@ <h2 id="further-documentation"><a class="anchor" href="#further-documentation"><
<div class="ulist">
<ul>
<li>
<p>García, Boni, et al. "<a href="https://www.sciencedirect.com/science/article/pii/S0164121223001188">Enhancing Web Applications Observability through Instrumented Automated Browsers</a>." <em>Journal of Systems and Software</em> (2023): 111723.</p>
</li>
<li>
<p>Leotta, M., et al. "<a href="https://ieeexplore.ieee.org/document/10132210">Challenges of End-to-End Testing with Selenium WebDriver and How to Face Them: A Survey</a>". In the 16th <em>IEEE Conference on Software Testing, Verification and Validation</em> (ICST), 2023, Dublin, Ireland. April 2023.</p>
</li>
<li>
<p>Leotta, M., et al. "<a href="https://link.springer.com/chapter/10.1007/978-3-031-14179-9_3">An Empirical Study to Quantify the SetUp and Maintenance Benefits of Adopting WebDriverManager</a>." <em>15th International Conference on the Quality of Information and Communications Technology</em> (QUATIC) 2022, Talavera de la Reina, Spain. September 2022.</p>
</li>
<li>
Expand Down Expand Up @@ -3083,15 +3095,15 @@ <h2 id="further-documentation"><a class="anchor" href="#further-documentation"><
<h2 id="about"><a class="anchor" href="#about"></a>11. About</h2>
<div class="sectionbody">
<div class="paragraph">
<p>WebDriverManager (Copyright © 2015-2022) is an open-source project created and maintained by <a href="https://bonigarcia.dev/">Boni García</a> (<a href="https://twitter.com/boni_gg">@boni_gg</a>), licensed under the terms of <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 License</a>. This documentation (also available in <a href="webdrivermanager.pdf">PDF</a>) is released under the terms of <a href="https://creativecommons.org/licenses/by-nc-sa/2.0/">CC BY-NC-SA 2.0</a>.</p>
<p>WebDriverManager (Copyright © 2015-2023) is an open-source project created and maintained by <a href="https://bonigarcia.dev/">Boni García</a> (<a href="https://twitter.com/boni_gg">@boni_gg</a>), licensed under the terms of <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 License</a>. This documentation (also available in <a href="webdrivermanager.pdf">PDF</a>) is released under the terms of <a href="https://creativecommons.org/licenses/by-nc-sa/2.0/">CC BY-NC-SA 2.0</a>.</p>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Version 5.3.3<br>
Updated on 11-05-2023
Version 5.4.0<br>
Updated on 21-06-2023
</div>
</div>
</body>
Expand Down
Binary file modified docs/webdrivermanager.pdf
View file
Binary file not shown.

0 comments on commit 958fe4e

Please sign in to comment.