Skip to content

Commit

Permalink
Update doc for version 5.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bonigarcia committed Oct 27, 2023
1 parent 7ebeedd commit 8c2042b
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 20 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,18 @@
# Changelog

## [5.6.0] - 2023-10-27

### Added
- Enable CDP support in browsers in Docker using host as Docker network

### Fixed
- Use same number of exposed ports when using host as Docker network
- Unable to use chromeDownloadUrlPattern (#1141)

### Changed
- Avoid fallback to old chromedriver repo if CfT fails (#1137)


## [5.5.3] - 2023-09-01

### Fixed
Expand Down
46 changes: 26 additions & 20 deletions docs/index.html
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.5.3</span>
<span id="revdate">Version 5.6.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.5.3<span class="tag">&lt;/version&gt;</span>
<span class="tag">&lt;version&gt;</span>5.6.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.5.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.6.0</span><span class="delimiter">&quot;</span></span><span class="error">)</span>
}</code></pre>
</div>
</div>
Expand Down Expand Up @@ -1389,13 +1389,13 @@ <h3 id="webdriver-builder"><a class="anchor" href="#webdriver-builder"></a>3.3.
WebDriverManager.chromedriver().setup();

<span class="comment">// Start Selenium Grid in standalone mode</span>
Main.main(<span class="keyword">new</span> <span class="predefined-type">String</span><span class="type">[]</span> { <span class="string"><span class="delimiter">&quot;</span><span class="content">standalone</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">--port</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">4444</span><span class="delimiter">&quot;</span></span> });
Main.main(<span class="keyword">new</span> <span class="predefined-type">String</span><span class="type">[]</span> { <span class="string"><span class="delimiter">&quot;</span><span class="content">standalone</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">--port</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">4445</span><span class="delimiter">&quot;</span></span> });
}

<span class="annotation">@BeforeEach</span>
<span class="type">void</span> setupTest() {
driver = WebDriverManager.chromedriver()
.remoteAddress(<span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:4444/wd/hub</span><span class="delimiter">&quot;</span></span>).create();
.remoteAddress(<span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:4445/wd/hub</span><span class="delimiter">&quot;</span></span>).create();
}

<span class="annotation">@AfterEach</span>
Expand Down Expand Up @@ -2055,10 +2055,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.5.3/webdrivermanager-5.5.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.6.0/webdrivermanager-5.6.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.5.3-fat.jar &lt;args&gt;</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.6.0-fat.jar &lt;args&gt;</code></pre>
</div>
</div>
</li>
Expand All @@ -2074,7 +2074,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.5.3</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">docker run --rm -e ARGS=&quot;&lt;args&gt;&quot; bonigarcia/webdrivermanager:5.6.0</code></pre>
</div>
</div>
</li>
Expand Down Expand Up @@ -2112,7 +2112,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.5.3-fat.jar resolveDriverFor chrome</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.6.0-fat.jar resolveDriverFor chrome</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2136,7 +2136,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.5.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.6.0</code></pre>
</div>
</div>
<h4 id="option-2-browsers-in-docker" class="discrete">Option 2: Browsers in Docker</h4>
Expand All @@ -2152,7 +2152,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.5.3-fat.jar runInDocker chrome</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.6.0-fat.jar runInDocker chrome</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2176,7 +2176,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.5.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.6.0</code></pre>
</div>
</div>
<div class="admonitionblock warning">
Expand Down Expand Up @@ -2204,7 +2204,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.5.3-fat.jar server</code></pre>
<pre class="CodeRay highlight"><code data-lang="shell">java -jar webdrivermanager-5.6.0-fat.jar server</code></pre>
</div>
</div>
<div class="ulist">
Expand All @@ -2228,7 +2228,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.5.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.6.0</code></pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -2345,7 +2345,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.5.3/webdrivermanager-5.5.3-fat.jar">fat-JAR</a> using the JVM flag <code>-javaagent:/path/to/webdrivermanager-5.5.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.6.0/webdrivermanager-5.6.0-fat.jar">fat-JAR</a> using the JVM flag <code>-javaagent:/path/to/webdrivermanager-5.6.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 @@ -2389,7 +2389,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.5.3-fat.jar resolveDriverFor chrome
<pre class="CodeRay highlight"><code data-lang="shell">boni@ubuntu:~$ java -jar webdrivermanager-5.6.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 @@ -2514,7 +2514,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.5.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.6.0</code></pre>
</div>
</div>
<div class="admonitionblock note">
Expand Down Expand Up @@ -2739,6 +2739,12 @@ <h2 id="advanced-configuration"><a class="anchor" href="#advanced-configuration"
<td class="tableblock halign-left valign-top"><p class="tableblock">Avoid shutdown hook for drivers objected created with <code>create()</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>avoidExternalConnections()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.avoidExternalConnections=true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Avoid connections to external urls, useful when downloading webdrivers from an artifact storage in an intranet</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>browserVersionDetection</code> <code>Command(String)</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wdm.browserVersion</code> <code>DetectionCommand</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>""</code> (automatic discovery using the <a href="https://github.com/bonigarcia/webdrivermanager/blob/master/src/main/resources/commands.properties">commands database</a>)</p></td>
Expand Down Expand Up @@ -3067,7 +3073,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.5.3 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.6.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 @@ -3259,8 +3265,8 @@ <h2 id="about"><a class="anchor" href="#about"></a>12. About</h2>
</div>
<div id="footer">
<div id="footer-text">
Version 5.5.3<br>
Updated on 01-09-2023
Version 5.6.0<br>
Updated on 27-10-2023
</div>
</div>
</body>
Expand Down
Binary file modified docs/webdrivermanager.pdf
Binary file not shown.

0 comments on commit 8c2042b

Please sign in to comment.