Bug 1414221 - Update README.de for moz:webdriverClick capability. r=ato,automatedtester
authorHenrik Skupin <mail@hskupin.info>
Fri, 03 Nov 2017 11:25:21 +0100
changeset 443376 fa3745bff6ac5363c8a391062d929aed3ae31fc9
parent 443375 e1215f43a62a7dc4ef525efd017e263a1ee70712
child 443377 6f1e32b85be2e46a8167c3d9945df58e461e8adb
push id1618
push userCallek@gmail.com
push dateThu, 11 Jan 2018 17:45:48 +0000
treeherdermozilla-release@882ca853e05a [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersato, automatedtester
bugs1414221
milestone58.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1414221 - Update README.de for moz:webdriverClick capability. r=ato,automatedtester While the usage of this capability was optional before, it will be of help starting with Firefox 58. With this version the webdriver conformant click will be enabled by default. As fallback the legacy click should still be able to get selected, and as such the capability has to be set. DONTBUILD MozReview-Commit-ID: 1iU8FPK353N
testing/geckodriver/README.md
--- a/testing/geckodriver/README.md
+++ b/testing/geckodriver/README.md
@@ -194,20 +194,24 @@ geckodriver supports a number of [capabi
    when <code>proxyType</code> is set to <code>manual</code>.
  </tr>
 </table>
 
 
 Firefox capabilities
 ====================
 
-geckodriver also supports a capability named `moz:firefoxOptions`
-which takes Firefox-specific options.
-This must be a dictionary
-and may contain any of the following fields:
+geckodriver also supports capabilities with the `moz:` prefix, which can
+be used to define Firefox-specific capabilities.
+
+moz:firefoxOptions
+------------------
+
+A dictionary used to define options which control how Firefox gets started
+and run. It may contain any of the following fields:
 
 <table>
  <thead>
   <tr>
    <th>Name
    <th>Type
    <th>Description
   </tr>
@@ -271,16 +275,35 @@ and may contain any of the following fie
  <tr id=capability-prefs>
   <td><code>prefs</code>
   <td><a href=#prefs-object><code>prefs</code></a>&nbsp;object
   <td>Map of preference name to preference value, which can be a
    string, a boolean or an integer.
  </tr>
 </table>
 
+moz:webdriverClick
+------------------
+
+A boolean value to indicate which kind of interactability checks to run
+when performing a click on elements. For Firefoxen prior to version 58.0 some
+legacy code as imported from an older version of [FirefoxDriver] was in use.
+
+With Firefox 58 the interactability checks as required by the [WebDriver]
+specification are enabled by default. This means geckodriver will additionally
+check if an element is obscured by another when clicking.
+
+Because of this change in behaviour, we are aware that some extra errors could
+be returned. In most cases the test in question might have to be updated
+so it's conform with the new checks. But if the problem is located in
+geckodriver, then please raise an issue in the [issue tracker].
+
+To temporarily disable the WebDriver conformant checks use `false` as value
+for this capability.
+
 
 `log` object
 ------------
 
 <table>
  <thead>
   <tr>
    <th>Name
@@ -554,16 +577,17 @@ alongside _firefox-bin_.
 [Rust]: https://www.rust-lang.org/
 [Mozilla]: https://www.mozilla.org/en-US/
 [webdriver crate]: https://github.com/mozilla/webdriver-rust
 [commands]: https://docs.rs/webdriver/0.25.0/webdriver/command/index.html
 [responses]: https://docs.rs/webdriver/0.25.0/webdriver/response/index.html
 [errors]: https://docs.rs/webdriver/0.25.0/webdriver/error/enum.ErrorStatus.html
 [Marionette protocol]: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/Protocol
 [WebDriver]: https://w3c.github.io/webdriver/webdriver-spec.html
+[FirefoxDriver]: https://github.com/SeleniumHQ/selenium/wiki/FirefoxDriver
 [Marionette]: http://searchfox.org/mozilla-central/source/testing/marionette/README
 [Firefox CI]: https://treeherder.mozilla.org/
 [mozconfig]: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Configuring_Build_Options
 
 
 Contact
 =======