Skip to content

Commit

Permalink
Update generated doc for version 5.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@bonigarcia
bonigarcia committed Feb 21, 2024
1 parent 13792fc commit df6debb
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 37 deletions.
56 changes: 19 additions & 37 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.6.4</span>
<span id="revdate">Version 5.7.0</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
Expand Down Expand Up @@ -1002,7 +1002,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.6.4<span class="tag">&lt;/version&gt;</span>
<span class="tag">&lt;version&gt;</span>5.7.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 @@ -1013,7 +1013,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.6.4</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.7.0</span><span class="delimiter">&quot;</span></span><span class="error">)</span>
}</code></pre>
</div>
</div>
Expand Down Expand Up @@ -1114,7 +1114,7 @@ <h4 id="resolution-algorithm"><a class="anchor" href="#resolution-algorithm"></a
<p>WebDriverManager tries to find the browser version. To this aim, WebDriverManager uses internally a knowledge database called <a href="https://github.com/bonigarcia/webdrivermanager/blob/master/src/main/resources/commands.properties">commands database</a>. This database is a collection of shell commands used to discover the version of a given browser in the different operating systems (e.g., <code>google-chrome --version</code> for Chrome in Linux).</p>
</li>
<li>
<p>Using the browser version, WebDriverManager tries to find the proper driver version. This process is different for each browser. In Chrome and Edge, their respective drivers (chromedriver and msedgedriver) maintainers also publish resources to identify the suitable driver version for a given major browser release. For instance, to find out the version of chromedriver required for Chrome 89, we need to read the following <a href="https://chromedriver.storage.googleapis.com/LATEST_RELEASE_89">file</a>. Unfortunately, this information is not available in other browsers (e.g., Firefox and Opera) or older versions of Chrome and Firefox. For this reason, WebDriverManager uses another knowledge database called <a href="https://github.com/bonigarcia/webdrivermanager/blob/master/src/main/resources/versions.properties">versions database</a>. This database maps the browser releases with the known compatible driver versions.</p>
<p>Using the browser version, WebDriverManager tries to find the proper driver version. This process is different for each browser. For chromedriver, the <a href="https://github.com/GoogleChromeLabs/chrome-for-testing">Chrome for Testing (CfT) endpoints</a> are used. For geckodriver, the <a href="https://raw.githubusercontent.com/SeleniumHQ/selenium/trunk/common/geckodriver/geckodriver-support.json">Firefox mapping maintained by the Selenium project</a> (which is based on the <a href="https://firefox-source-docs.mozilla.org/testing/geckodriver/Support.html">official geckodriver support</a>). For msedgedriver, the <a href="https://msedgedriver.azureedge.net/">Edge metadata</a> is used.</p>
</li>
<li>
<p>Once the driver version is discovered, WebDriverManager downloads this driver to a local cache (located at <code>~/.cache/selenium</code> by default). These drivers are reused in subsequent calls.</p>
Expand Down Expand Up @@ -2056,10 +2056,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.6.4/webdrivermanager-5.6.4-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.7.0/webdrivermanager-5.7.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.6.4-fat.jar &lt;args&gt;</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.7.0-fat.jar &lt;args&gt;</code></pre>
</div>
</div>
</li>
Expand All @@ -2075,7 +2075,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.6.4</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -e ARGS=&quot;&lt;args&gt;&quot; bonigarcia/webdrivermanager:5.7.0</code></pre>
</div>
</div>
</li>
Expand Down Expand Up @@ -2113,7 +2113,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.6.4-fat.jar resolveDriverFor chrome</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.7.0-fat.jar resolveDriverFor chrome</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2137,7 +2137,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.6.4</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.7.0</code></pre>
</div>
</div>
<h4 id="option-2-browsers-in-docker" class="discrete">Option 2: Browsers in Docker</h4>
Expand All @@ -2153,7 +2153,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.6.4-fat.jar runInDocker chrome</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.7.0-fat.jar runInDocker chrome</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2177,7 +2177,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.6.4</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.7.0</code></pre>
</div>
</div>
<div class="admonitionblock warning">
Expand Down Expand Up @@ -2205,7 +2205,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.6.4-fat.jar server</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.7.0-fat.jar server</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2229,7 +2229,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.6.4</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.7.0</code></pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -2346,7 +2346,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.6.4/webdrivermanager-5.6.4-fat.jar">fat-JAR</a> using the JVM flag <code>-javaagent:/path/to/webdrivermanager-5.6.4-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.7.0/webdrivermanager-5.7.0-fat.jar">fat-JAR</a> using the JVM flag <code>-javaagent:/path/to/webdrivermanager-5.7.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 @@ -2390,7 +2390,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.6.4-fat.jar resolveDriverFor chrome
<pre class="CodeRay highlight"><code data-lang="shell">boni@ubuntu:~$ java -jar webdrivermanager-5.7.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 @@ -2515,7 +2515,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.6.4</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.7.0</code></pre>
</div>
</div>
<div class="admonitionblock note">
Expand Down Expand Up @@ -2722,12 +2722,6 @@ <h2 id="advanced-configuration"><a class="anchor" href="#advanced-configuration"
<td class="tableblock halign-left valign-top"><p class="tableblock">Force to use the latest version available for a given driver</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>avoidReadReleaseFrom</code> <code>Repository()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.avoidReadReleaseFrom</code> <code>Repository=true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code> (discover driver relase using info from the repository, e.g., <a href="https://chromedriver.storage.googleapis.com/LATEST_RELEASE">chromedriver-latest</a> or <a href="https://msedgedriver.azureedge.net/LATEST_STABLE">msedgedriver-latest</a>)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Avoid using the repository info and use the <a href="https://github.com/bonigarcia/webdrivermanager/blob/master/src/main/resources/versions.properties">versions database</a> instead</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>avoidTmpFolder()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.avoidTmpFolder=true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code> (Each driver release (typically compressed) is copied in a temporal folder in the local machine, and then the driver is extracted and copied to the driver cache</p></td>
Expand Down Expand Up @@ -2758,24 +2752,12 @@ <h2 id="advanced-configuration"><a class="anchor" href="#advanced-configuration"
<td class="tableblock halign-left valign-top"><p class="tableblock">Regular expression used to extract the browser version from the shell</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>useLocalVersionsProperties</code> <code>First()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.versionsProperties</code> <code>OnlineFirst=true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code> (the online <a href="https://github.com/bonigarcia/webdrivermanager/blob/master/src/main/resources/versions.properties">versions database</a> is used in the <a href="#resolution-algorithm">resolution algorithm</a>)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use local copy of the versions database</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>useLocalCommandsProperties</code> <code>First()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.commandsProperties</code> <code>OnlineFirst=true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code> (the online <a href="https://github.com/bonigarcia/webdrivermanager/blob/master/src/main/resources/versions.properties">commands database</a> is used in the <a href="#resolution-algorithm">resolution algorithm</a>)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use local copy of the commands database</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>versionsPropertiesUrl(URL)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.versionsPropertiesUrl</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Raw version of the online <a href="https://github.com/bonigarcia/webdrivermanager/blob/master/src/main/resources/versions.properties">versions database</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Change versions database URL</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>commandsPropertiesUrl(URL)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.commandsPropertiesUrl</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Raw version of the online <a href="https://github.com/bonigarcia/webdrivermanager/blob/master/src/main/resources/commands.properties">commands database</a></p></td>
Expand Down Expand Up @@ -3086,7 +3068,7 @@ <h3 id="support-for-chromedriver-115"><a class="anchor" href="#support-for-chrom
</div>
</div>
<div class="paragraph">
<p>WebDriverManager 5.4+ implements the support for the CfT endpoints. Therefore, the solution to this problem is to bump WebDriverManager to the <strong>latest version</strong> (5.6.4 currently). Also, to ensure that the wrong version has not been cached in the <strong>resolution cache</strong>, you can refresh completely the cache folder (at least once) as follows:</p>
<p>WebDriverManager 5.4+ implements the support for the CfT endpoints. Therefore, the solution to this problem is to bump WebDriverManager to the <strong>latest version</strong> (5.7.0 currently). Also, to ensure that the wrong version has not been cached in the <strong>resolution cache</strong>, you can refresh completely the cache folder (at least once) as follows:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down Expand Up @@ -3278,8 +3260,8 @@ <h2 id="about"><a class="anchor" href="#about"></a>12. About</h2>
</div>
<div id="footer">
<div id="footer-text">
Version 5.6.4<br>
Updated on 19-02-2024
Version 5.7.0<br>
Updated on 21-02-2024
</div>
</div>
</body>
Expand Down
Binary file modified docs/webdrivermanager.pdf
View file
Binary file not shown.

0 comments on commit df6debb

Please sign in to comment.