Update to WebDriver: W3C Editor's Draft 17 June 2021

Author: robocoder

README.md

@@ -3,9 +3,9 @@ WebDriver for Selenium 2
 This WebDriver client implementation is based on Facebook's [php-webdriver](https://github.com/facebook/php-webdriver/) project by Justin Bishop.
 
 Distinguishing features:
-* Up-to-date with [WebDriver: W3C Living Document 31 December 2019](https://w3c.github.io/webdriver/)
+* Up-to-date with [WebDriver: W3C Editor's Draft 17 June 2021](https://w3c.github.io/webdriver/)
 * Up-to-date with [Selenium 2 JSON Wire Protocol](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol) (including WebDriver commands yet to be documented).
-* In the *master* branch, class names and file organization follow PSR-0 conventions for php 5.3+ namespaces.
+* In the *master* branch, class names and file organization follow PSR-0 conventions for namespaces.
 * Coding style follows PSR-1, PSR-2, and Symfony2 conventions.
 * Auto-generate API documentation via [phpDocumentor 2.x](http://phpdoc.org/).
 

lib/WebDriver/Element.php

@@ -48,6 +48,8 @@
  * @method array rect() Get Element Rect
  * @method array active() Get Active Element
  * @method array screenshot() Take Element Screenshot
+ * @method array computedrole() Get Computed Role
+ * @method array computedlabel() Get Computed Label
  */
 final class Element extends Container
 {
@@ -70,6 +72,8 @@ protected function methods()
             'rect' => array('GET'),
             'active' => array('GET'),
             'screenshot' => array('GET'),
+            'computedrole' => array('GET'),
+            'computedlabel' => array('GET'),
 
             // Legacy JSON Wire Protocol
             'submit' => array('POST'),
@@ -126,6 +130,20 @@ public function getID()
         return $this->id;
     }
 
+    /**
+     * Get element shadow root: /session/:sessionId/element/:elementId/shadow
+     *
+     * shadow root method chaining, e.g.,
+     * - $element->method()
+     *
+     * @return \WebDriver\Shadow
+     *
+     */
+    public function shadow()
+    {
+        return new Shadow($this->url . '/shadow', $this->w3c);
+    }
+
     /**
      * {@inheritdoc}
      */

lib/WebDriver/Exception.php

@@ -125,6 +125,7 @@ abstract class Exception extends \Exception
         self::UNKNOWN_LOCATOR_STRATEGY => array('UnknownLocatorStrategy', 'This locator strategy is not supported.'),
 
         //  @link https://w3c.github.io/webdriver/#errors
+        'detached shadow root' => array('DetachedShadowRoot', 'A command failed because the referenced shadow root is no longer attached to the DOM.'),
         'element click intercepted' => array('ElementClickIntercepted', 'The Element Click command could not be completed because the element receiving the events is obscuring the element that was requested clicked.'),
         'element not interactable' => array('ElementNotInteractable', 'A command could not be completed because the element is not pointer- or keyboard interactable.'),
         'insecure certificate' => array('InsecureCertificate', 'Navigation caused the user agent to hit a certificate warning, which is usually the result of an expired or invalid TLS certificate.'),
@@ -139,6 +140,7 @@ abstract class Exception extends \Exception
         'no such cookie' => array('NoSuchCookie', 'No cookie matching the given path name was found amongst the associated cookies of the current browsing context\'s active document.'),
         'no such element' => array('NoSuchElement', 'An element could not be located on the page using the given search parameters.'),
         'no such frame' => array('NoSuchFrame', 'A command to switch to a frame could not be satisfied because the frame could not be found.'),
+        'no such shadow root' => array('NoSuchShadowRoot', 'The element does not have a shadow root.'),
         'no such window' => array('NoSuchWindow', 'A command to switch to a window could not be satisfied because the window could not be found.'),
         'script timeout' => array('ScriptTimeout', 'A script did not complete before its timeout expired.'),
         'script timeout error' => array('ScriptTimeout', 'A script did not complete before its timeout expired.'),

lib/WebDriver/Exception/DetachedShadowRoot.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Copyright 2004-2021 Facebook. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package WebDriver
+ *
+ * @author Justin Bishop <[email protected]>
+ * @author Anthon Pang <[email protected]>
+ */
+
+namespace WebDriver\Exception;
+
+use WebDriver\Exception as BaseException;
+
+/**
+ * WebDriver\Exception\DetachedShadowRoot class
+ *
+ * @package WebDriver
+ */
+final class DetachedShadowRoot extends BaseException
+{
+}

lib/WebDriver/Exception/NoSuchShadowRoot.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Copyright 2004-2021 Facebook. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package WebDriver
+ *
+ * @author Justin Bishop <[email protected]>
+ * @author Anthon Pang <[email protected]>
+ */
+
+namespace WebDriver\Exception;
+
+use WebDriver\Exception as BaseException;
+
+/**
+ * WebDriver\Exception\NoSuchShadowRoot class
+ *
+ * @package WebDriver
+ */
+final class NoSuchShadowRoot extends BaseException
+{
+}

lib/WebDriver/Session.php

@@ -61,6 +61,7 @@
  * @method void postBrowser_connection($jsonState) Set browser online.
  * @method array postActions() Perform Actions
  * @method array deleteActions() Release Actions
+ * @method array print() Print Page
  */
 final class Session extends Container
 {
@@ -84,6 +85,7 @@ protected function methods()
             'source' => array('GET'),
             'title' => array('GET'),
             'actions' => array('POST', 'DELETE'),
+            'print' => array('POST'),
 
             // specific to Java SeleniumServer
             'file' => array('POST'),

lib/WebDriver/Shadow.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Copyright 2021-2021 Anthon Pang. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @package WebDriver
+ *
+ * @author Anthon Pang <[email protected]>
+ */
+
+namespace WebDriver;
+
+/**
+ * WebDriver\Shadow class
+ *
+ * @package WebDriver
+ */
+final class Shadow extends Container
+{
+    const SHADOW_ROOT_ID = 'shadow-6066-11e4-a52e-4f735466cecf';
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function methods()
+    {
+        return array();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getElementPath($elementId)
+    {
+        return sprintf('%s/element/%s', $this->url, $elementId);
+    }
+}