[ViewVC] Diff of: cvs/AnyEvent-WebDriver/README

Comparing AnyEvent-WebDriver/README (file contents):
Revision 1.7 by root, Tue Sep 4 01:21:21 2018 UTC vs.
Revision 1.8 by root, Fri Sep 20 20:15:58 2019 UTC

 NAME
     AnyEvent::WebDriver - control browsers using the W3C WebDriver protocol
 SYNOPSIS
-       # start geckodriver or any other w3c-compatible webdriver via the shell
+       # start geckodriver(chromedriver or any other webdriver via the shell
-       $ geckdriver -b myfirefox/firefox --log trace --port 4444
+       $ geckodriver -b myfirefox/firefox --log trace --port 4444
+       # chromedriver --port=4444
        # then use it
        use AnyEvent::WebDriver;
        # create a new webdriver object
           ->type ("some text")
           ->key ("{Enter}")
           ->perform;
 DESCRIPTION
-    WARNING: BEFORE VERSION 1.0, API CHANGES ARE LIKELY.
-    This module aims to implement the W3C WebDriver specification which is
+    This module aims to implement the W3C WebDriver
+    <https://www.w3.org/TR/webdriver1/> specification which is the
-    the standardised equivalent to the Selenium WebDriver API., which in
+    standardised equivalent to the Selenium WebDriver API, which in turn
-    turn aims at remotely controlling web browsers such as Firefox or
+    aims at remotely controlling web browsers such as Firefox or Chromium.
-    Chromium.
-    At the time of this writing, it was so brand new that I could only get
-    "geckodriver" (for Firefox) to work, but that is expected to be fixed
-    very soon indeed.
     One of the design goals of this module was to stay very close to the
     language and words used in the WebDriver specification itself, so to
     make most of this module, or, in fact, to make any reasonable use of
     this module, you would need to refer to the W3C WebDriver
     recommendation, which can be found here
     <https://www.w3.org/TR/webdriver1/>:
        https://www.w3.org/TR/webdriver1/
+    Mozilla's "geckodriver" has had webdriver for a long time, while
+    "chromedriver" only has basic and mostly undocumented webdriver support
+    since release 77.
+    In debian GNU/Linux, you can install the "firefoxdriver" or
+    "chromium-driver" packages to get the firefox/chromium webdrivers,
+    respectively.
   CONVENTIONS
     Unless otherwise stated, all delays and time differences in this module
     are represented as an integer number of milliseconds.
   WEBDRIVER OBJECTS
     new AnyEvent::WebDriver key => value...
         Create a new WebDriver object. Example for a remote WebDriver
         connection (the only type supported at the moment):
-           my $wd = new AnyEvent::WebDriver host => "localhost", port => 4444;
+           my $wd = new AnyEvent::WebDriver endpoint => "http://localhost:4444";
         Supported keys are:
         endpoint => $string
             For remote connections, the endpoint to connect to (defaults to
             for all requests, which assumes you have a reasonably stable
             connection (such as to "localhost" :) and that the WebDriver has
             a persistent timeout much higher than what AnyEvent::HTTP uses.
             You can force connections to be closed for non-idempotent
-            requests by setting this to "undef".
+            requests (the safe default of AnyEvent::HTTP) by setting this to
+            "undef".
     $al = $wd->actions
         Creates an action list associated with this WebDriver. See ACTION
         LISTS, below, for full details.
         there for later use), while the capabilities are stored in
         "$wd->{capabilities}".
   SIMPLIFIED API
     This section documents the simplified API, which is really just a very
-    thin wrapper around the WebDriver protocol commands. They all block
+    thin wrapper around the WebDriver protocol commands. They all block the
-    (using AnyEvent condvars) the caller until the result is available, so
+    caller until the result is available (using AnyEvent condvars), so must
-    must not be called from an event loop callback - see "EVENT BASED API"
+    not be called from an event loop callback - see "EVENT BASED API" for an
-    for an alternative.
+    alternative.
     The method names are pretty much taken directly from the W3C WebDriver
     specification, e.g. the request documented in the "Get All Cookies"
     section is implemented via the "get_all_cookies" method.
         On success, "$wd->{sid}" is set to the session ID, and
         "$wd->{capabilities}" is set to the returned capabilities.
         Simple example of creating a WebDriver object and a new session:
-           my $wd = new AnyEvent::Selenium endpoint => "http://localhost:4545";
+           my $wd = new AnyEvent::WebDriver endpoint => "http://localhost:4444";
            $wd->new_session ({});
         Real-world example with capability negotiation:
            $wd->new_session ({
                  firstMatch => [
                     {
                        browserName => "firefox",
                        "moz:firefoxOptions" => {
                           binary => "firefox/firefox",
-                          args => ["-devtools"],
+                          args => ["-devtools", "-headless"],
                           prefs => {
                              "dom.webnotifications.enabled" => \0,
                              "dom.push.enabled" => \0,
                              "dom.disable_beforeunload" => \1,
                              "browser.link.open_newwindow" => 3,
                              "dom.disable_open_during_load" => \1,
                           },
                        },
                     },
                     {
+                       browserName => "chrome",
+                       "goog:chromeOptions" => {
+                          binary => "/bin/chromium",
+                          args => ["--no-sandbox", "--headless"],
+                          prefs => {
+                             # ...
+                          },
+                       },
+                    },
+                    {
                        # generic fallback
                     },
                  ],
               },
         Firefox-specific capability documentation can be found on MDN
         <https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities
         >, Chrome-specific capability documentation might be found here
         <http://chromedriver.chromium.org/capabilities>, but the latest
-        release at the time of this writing has effectively no WebDriver
+        release at the time of this writing (chromedriver 77) has
-        support at all, and canary releases are not freely downloadable.
+        essentially no webdriver documentation about chrome capabilities.
         If you have URLs for Safari/IE/Edge etc. capabilities, feel free to
         tell me about them.
     $wd->delete_session
    SCREEN CAPTURE
     $wd->take_screenshot
         Create a screenshot, returning it as a PNG image in a "data:" URL.
     $wd->take_element_screenshot ($element)
-        Accept a simple dialog, if present.
+        Similar to "take_screenshot", but only takes a screenshot of the
+        bounding box of a single element.
   ACTION LISTS
     Action lists can be quite complicated. Or at least it took a while for
     me to twist my head around them. Basically, an action list consists of a
     number of sources representing devices (such as a finger, a mouse, a pen
        $elems = $wd->post (elements => { using => "css selector", value => "img" });
 HISTORY
     This module was unintentionally created (it started inside some quickly
     hacked-together script) simply because I couldn't get the existing
-    "Selenium::Remote::Driver" module to work, ever, despite multiple
+    "Selenium::Remote::Driver" module to work reliably, ever, despite
-    attempts over the years and trying to report multiple bugs, which have
+    multiple attempts over the years and trying to report multiple bugs,
-    been completely ignored. It's also not event-based, so, yeah...
+    which have been completely ignored. It's also not event-based, so,
+    yeah...
 AUTHOR
        Marc Lehmann <schmorp@schmorp.de>
        http://anyevent.schmorp.de

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent-WebDriver/README (file contents): Revision 1.7 by root, Tue Sep 4 01:21:21 2018 UTC vs. Revision 1.8 by root, Fri Sep 20 20:15:58 2019 UTC

Diff Legend

Comparing AnyEvent-WebDriver/README (file contents):
Revision 1.7 by root, Tue Sep 4 01:21:21 2018 UTC vs.
Revision 1.8 by root, Fri Sep 20 20:15:58 2019 UTC