Process status response to RemoteStatus value object

Author: OndraM

CHANGELOG.md

@@ -5,6 +5,7 @@ This project versioning adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 - Experimental W3C WebDriver protocol support. The protocol will be used automatically when remote end (like Geckodriver, newer Chromedriver etc.) supports it.
+- `getStatus()` method of RemoteWebDriver to get information about remote-end readiness to create new sessions.
 
 ### Changed
 - Revert no longer needed workaround for Chromedriver bug [2943](https://bugs.chromium.org/p/chromedriver/issues/detail?id=2943).

lib/Remote/RemoteStatus.php

@@ -0,0 +1,93 @@
+<?php
+// Copyright 2004-present 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.
+
+namespace Facebook\WebDriver\Remote;
+
+/**
+ * Represents status of remote end
+ *
+ * @see https://www.w3.org/TR/webdriver/#status
+ */
+class RemoteStatus
+{
+    /** @var bool */
+    protected $isReady;
+    /** @var string */
+    protected $message;
+    /** @var array */
+    protected $meta = [];
+
+    /**
+     * @param bool $isReady
+     * @param string $message
+     */
+    protected function __construct($isReady, $message, array $meta = [])
+    {
+        $this->isReady = (bool) $isReady;
+        $this->message = (string) $message;
+
+        $this->setMeta($meta);
+    }
+
+    /**
+     * @param array $responseBody
+     * @return RemoteStatus
+     */
+    public static function createFromResponse(array $responseBody)
+    {
+        $object = new static($responseBody['ready'], $responseBody['message'], $responseBody);
+
+        return $object;
+    }
+
+    /**
+     * The remote end's readiness state.
+     * False if an attempt to create a session at the current time would fail.
+     * However, the value true does not guarantee that a New Session command will succeed.
+     *
+     * @return bool
+     */
+    public function isReady()
+    {
+        return $this->isReady;
+    }
+
+    /**
+     * An implementation-defined string explaining the remote end's readiness state.
+     *
+     * @return string
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
+
+    /**
+     * Arbitrary meta information specific to remote-end implementation.
+     *
+     * @return array
+     */
+    public function getMeta()
+    {
+        return $this->meta;
+    }
+
+    protected function setMeta(array $meta)
+    {
+        unset($meta['ready'], $meta['message']);
+
+        $this->meta = $meta;
+    }
+}

lib/Remote/RemoteWebDriver.php

@@ -380,6 +380,16 @@ public function takeScreenshot($save_as = null)
         return $screenshot;
     }
 
+    /**
+     * Status returns information about whether a remote end is in a state in which it can create new sessions.
+     */
+    public function getStatus()
+    {
+        $response = $this->execute(DriverCommand::STATUS);
+
+        return RemoteStatus::createFromResponse($response);
+    }
+
     /**
      * Construct a new WebDriverWait by the current WebDriver instance.
      * Sample usage:

tests/functional/RemoteWebDriverTest.php

@@ -271,4 +271,20 @@ public function testShouldSaveScreenshotToFile()
 
         unlink($screenshotPath);
     }
+
+    /**
+     * @covers ::getStatus
+     * @covers \Facebook\WebDriver\Remote\RemoteStatus
+     * @group exclude-saucelabs
+     * Status endpoint is not supported on Sauce Labs
+     */
+    public function testShouldGetRemoteEndStatus()
+    {
+        $status = $this->driver->getStatus();
+
+        $this->assertInternalType('boolean', $status->isReady());
+        $this->assertNotEmpty($status->getMessage());
+
+        $this->assertInternalType('array', $status->getMeta());
+    }
 }