Accept W3C capabilitites from the browser and provide them as OSS ones (fixes #692)

Author: OndraM

lib/Remote/DesiredCapabilities.php

@@ -25,16 +25,36 @@
 
 class DesiredCapabilities implements WebDriverCapabilities
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     private $capabilities;
 
+    /** @var array */
+    private static $ossToW3c = [
+        WebDriverCapabilityType::PLATFORM => 'platformName',
+        WebDriverCapabilityType::VERSION => 'browserVersion',
+        WebDriverCapabilityType::ACCEPT_SSL_CERTS => 'acceptInsecureCerts',
+        ChromeOptions::CAPABILITY => ChromeOptions::CAPABILITY_W3C,
+    ];
+
     public function __construct(array $capabilities = [])
     {
         $this->capabilities = $capabilities;
     }
 
+    public static function createFromW3cCapabilities(array $capabilities = [])
+    {
+        $w3cToOss = array_flip(static::$ossToW3c);
+
+        foreach ($w3cToOss as $w3cCapability => $ossCapability) {
+            // Copy W3C capabilities to OSS ones
+            if (array_key_exists($w3cCapability, $capabilities)) {
+                $capabilities[$ossCapability] = $capabilities[$w3cCapability];
+            }
+        }
+
+        return new self($capabilities);
+    }
+
     /**
      * @return string The name of the browser.
      */
@@ -183,13 +203,6 @@ public function toArray()
      */
     public function toW3cCompatibleArray()
     {
-        $ossToW3c = [
-            WebDriverCapabilityType::PLATFORM => 'platformName',
-            WebDriverCapabilityType::VERSION => 'browserVersion',
-            WebDriverCapabilityType::ACCEPT_SSL_CERTS => 'acceptInsecureCerts',
-            ChromeOptions::CAPABILITY => ChromeOptions::CAPABILITY_W3C,
-        ];
-
         $allowedW3cCapabilities = [
             'browserName',
             'browserVersion',
@@ -212,12 +225,12 @@ public function toW3cCompatibleArray()
                 $w3cCapabilities[$capabilityKey] = $capabilityValue;
             }
 
-            // Convert capabilitites with changed name
-            if (array_key_exists($capabilityKey, $ossToW3c)) {
-                if ($capabilityKey === 'platform') {
-                    $w3cCapabilities[$ossToW3c[$capabilityKey]] = mb_strtolower($capabilityValue);
+            // Convert capabilities with changed name
+            if (array_key_exists($capabilityKey, static::$ossToW3c)) {
+                if ($capabilityKey === WebDriverCapabilityType::PLATFORM) {
+                    $w3cCapabilities[static::$ossToW3c[$capabilityKey]] = mb_strtolower($capabilityValue);
                 } else {
-                    $w3cCapabilities[$ossToW3c[$capabilityKey]] = $capabilityValue;
+                    $w3cCapabilities[static::$ossToW3c[$capabilityKey]] = $capabilityValue;
                 }
             }
 

lib/Remote/RemoteWebDriver.php

@@ -149,13 +149,17 @@ public static function create(
         $response = $executor->execute($command);
         $value = $response->getValue();
 
-        if (!$w3c_compliant = isset($value['capabilities'])) {
+        if (!$isW3cCompliant = isset($value['capabilities'])) {
             $executor->disableW3cCompliance();
         }
 
-        $returnedCapabilities = new DesiredCapabilities($w3c_compliant ? $value['capabilities'] : $value);
+        if ($isW3cCompliant) {
+            $returnedCapabilities = DesiredCapabilities::createFromW3cCapabilities($value['capabilities']);
+        } else {
+            $returnedCapabilities = new DesiredCapabilities($value);
+        }
 
-        $driver = new static($executor, $response->getSessionID(), $returnedCapabilities, $w3c_compliant);
+        $driver = new static($executor, $response->getSessionID(), $returnedCapabilities, $isW3cCompliant);
 
         return $driver;
     }

tests/functional/RemoteWebDriverCreateTest.php

@@ -50,9 +50,12 @@ public function testShouldStartBrowserAndCreateInstanceOfRemoteWebDriver()
         $returnedCapabilities = $this->driver->getCapabilities();
         $this->assertInstanceOf(WebDriverCapabilities::class, $returnedCapabilities);
         $this->assertSame($this->desiredCapabilities->getBrowserName(), $returnedCapabilities->getBrowserName());
+        $this->assertNotEmpty($returnedCapabilities->getPlatform());
+        $this->assertNotEmpty($returnedCapabilities);
+        $this->assertNotEmpty($returnedCapabilities->getVersion());
     }
 
-    public function testShouldAcceprCapabilitiesAsAnArray()
+    public function testShouldAcceptCapabilitiesAsAnArray()
     {
         // Method has a side-effect of converting whole content of desiredCapabilities to an array
         $this->desiredCapabilities->toArray();