Bug 1369827 - Update geckodriver docs for proxy port changes. draft
authorHenrik Skupin <mail@hskupin.info>
Fri, 18 Aug 2017 14:55:07 +0200
changeset 655953 9d7efda3174fe1fc831155abd70871b752735600
parent 655952 eebb247b1e36ca0c673ec0c73a7700c28d35ecdd
child 728961 4ad1278ef7d348e10b3398263e4831598865a028
push id77013
push userbmo:hskupin@gmail.com
push dateWed, 30 Aug 2017 15:59:42 +0000
bugs1369827
milestone57.0a1
Bug 1369827 - Update geckodriver docs for proxy port changes. MozReview-Commit-ID: 4yBC9AAHU5X
testing/geckodriver/CHANGES.md
testing/geckodriver/README.md
--- a/testing/geckodriver/CHANGES.md
+++ b/testing/geckodriver/CHANGES.md
@@ -11,19 +11,22 @@ All notable changes to this program is d
 
 [`FullscreenWindow`]: https://docs.rs/webdriver/0.29.0/webdriver/command/enum.WebDriverCommand.html#variant.FullscreenWindow
 [`GetWindowRect`]: https://docs.rs/webdriver/0.29.0/webdriver/command/enum.WebDriverCommand.html#variant.GetWindowRect
 [`MaximizeWindow`]: https://docs.rs/webdriver/0.29.0/webdriver/command/enum.WebDriverCommand.html#variant.MaximizeWindow
 [`MinimizeWindow`]: https://docs.rs/webdriver/0.29.0/webdriver/command/enum.WebDriverCommand.html#variant.MinimizeWindow
 [`SetWindowRect`]: https://docs.rs/webdriver/0.29.0/webdriver/command/enum.WebDriverCommand.html#variant.SetWindowRect
 
 ### Changed
+- Removed deprecated `socksProxyVersion` in favor of `socksVersion`.
+- Removed `ftpProxyPort`, `httpProxyPort`, `sslProxyPort`, and `socksProxyPort` because _ports_ have to be set for `ftpProxy`, `httpProxy`, `sslProxy`, and `socksProxy` using ":<PORT>".
 - To make sure no browser process is left behind when the [`New Session` command](https://docs.rs/webdriver/0.27.0/webdriver/command/enum.WebDriverCommand.html#variant.NewSession) fails, the process is closed immediately now.
 - The `proxyType` `noproxy` has been replaced with `direct` in accordance with recent WebDriver specification changes
 - `/moz/addon/install` command accepts an `addon` parameter, in lieu of `path`, containing an addon as a Base64 string
+- [webdriver crate](https://crates.io/crates/webdriver) upgraded to version 0.30.0
 - [mozrunner crate](https://crates.io/crates/mozrunner) upgraded to version 0.4.2
 
 ## 0.18.0 (2017-07-10)
 
 ### Changed
 - [`RectResponse`](https://docs.rs/webdriver/0.27.0/webdriver/response/struct.RectResponse.html) permits returning floats for `width` and `height` fields
 - New type [`CookieResponse`](https://docs.rs/webdriver/0.27.0/webdriver/response/struct.CookieResponse.html) for the [`GetNamedCookie` command](https://docs.rs/webdriver/0.27.0/webdriver/command/enum.WebDriverCommand.html#variant.GetNamedCookie) returns a single cookie, as opposed to an array of a single cookie
 - To pick up a prepared profile from the filesystem, it is now possible to pass `["-profile", "/path/to/profile"]` in the `args` array on `moz:firefoxOptions`
--- a/testing/geckodriver/README.md
+++ b/testing/geckodriver/README.md
@@ -132,84 +132,50 @@ geckodriver supports a number of
   <td>Defines the URL for a proxy auto-config file.
    This property should only be set
    when <code>proxyType</code> is <code>pac</code>.
  </tr>
 
  <tr>
   <td><code>ftpProxy</code>
   <td>string
-  <td>Defines the proxy hostname for FTP traffic.
-   Should only be set then the <code>proxyType</code>
+  <td>Defines the proxy hostname with an optional port for FTP traffic.
+   This property should only be set when <code>proxyType</code>
    is set to <code>manual</code>.
  </tr>
 
  <tr>
-  <td><code>ftpProxyPort</code>
-  <td>number
-  <td>Defines the proxy port for FTP traffic.
-   This property should only be set
-   when <code>proxyType</code> is <code>manual</code>.
- </tr>
-
- <tr>
   <td><code>httpProxy</code>
   <td>string
-  <td>Defines the hostname for HTTP traffic.
-   This property should only be set
-   when <code>proxyType</code> is <code>manual</code>.
- </tr>
-
- <tr>
-  <td><code>httpProxyPort</code>
-  <td>number
-  <td>Defines the proxy port for HTTP traffic.
-   This property should only be set
-   when <code>proxyType</code> is <code>manual</code>.
+  <td>Defines the proxy hostname with an optional port for HTTP traffic.
+   This property should only be set when <code>proxyType</code>
+   is set to <code>manual</code>.
  </tr>
 
  <tr>
   <td><code>sslProxy</code>
   <td>string
-  <td>Defines the proxy hostname
-   for encrypted TLS traffic.
-   This property should only be set
-   when <code>proxyType</code> is <code>manual</code>.
- </tr>
-
- <tr>
-  <td><code>sslProxyPort</code>
-  <td>number
-  <td>Defines the proxy port for SSL traffic.
-   This property should only be set
-   when <code>proxyType</code> is <code>manual</code>.
+  <td>Defines the proxy hostname with an optional port for encrypted TLS traffic.
+   This property should only be set when <code>proxyType</code>
+   is set to <code>manual</code>.
  </tr>
 
  <tr>
   <td><code>socksProxy</code>
   <td>string
-  <td>Defines the proxy hostname for a SOCKS proxy.
-   This property should only be set
-   when <code>proxyType</code> is <code>manual</code>.
- </tr>
-
- <tr>
-  <td><code>socksProxyPort</code>
-  <td>number
-  <td>Defines the proxy port for a SOCKS proxy.
-   This property should only be set
-   when <code>proxyType</code> is <code>manual</code>.
+  <td>Defines the hostname with on optional port for a SOCKS proxy.
+   This property should only be set when <code>proxyType</code>
+   is set to <code>manual</code>.
  </tr>
 
  <tr>
   <td><code>socksVersion</code>
   <td>number
-  <td>Defines the SOCKS proxy version.
-   This property should only be set
-   when <code>proxyType</code> is <code>manual</code>.
+  <td>Defines the SOCKS proxy version. This property has only to be set
+   when <code>proxyType</code> is set to <code>manual</code>.
  </tr>
 
  <tr>
   <td><code>socksUsername</code>
   <td>string
   <td>Defines the username used
    when authenticating with a SOCKS proxy.
    This property should only be set