Coding style changes

Author: robocoder

lib/WebDriver/AbstractWebDriver.php

@@ -139,11 +139,13 @@ protected function curl($requestMethod, $command, $parameters = null, $extraOpti
         }
 
         $value = null;
+
         if (array_key_exists('value', $result)) {
             $value = $result['value'];
         }
 
         $message = null;
+
         if (is_array($value) && array_key_exists('message', $value)) {
             $message = $value['message'];
         }
@@ -195,6 +197,7 @@ public function __call($name, $arguments)
         }
 
         $methods = $this->methods();
+
         if (!in_array($requestMethod, (array) $methods[$webdriverCommand])) {
             throw WebDriverException::factory(
                 WebDriverException::INVALID_REQUEST,

lib/WebDriver/Exception/CurlExec.php

@@ -18,6 +18,7 @@
  *
  * @author Justin Bishop <[email protected]>
  * @author Anthon Pang <[email protected]>
+ * @author Gaetano Giunta <[email protected]>
  */
 
 namespace WebDriver\Exception;
@@ -31,4 +32,28 @@
  */
 final class CurlExec extends BaseException
 {
+    /**
+     * @var array
+     */
+    private $curlInfo = array();
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($message = null, $code = 0, \Exception $previous = null, $curlInfo = array())
+    {
+        parent::__construct($message, $code, $previous);
+
+        $this->curlInfo = $curlInfo;
+    }
+
+    /**
+     * Get curl info
+     *
+     * @return array
+     */
+    public function getCurlInfo()
+    {
+        return $this->curlInfo;
+    }
 }

lib/WebDriver/SauceLabs/SauceRest.php

@@ -62,7 +62,7 @@ public function __construct($userId, $accessKey)
      *
      * @return mixed
      *
-     * @throws \WebDriver\Service\CurlServiceException
+     * @throws \WebDriver\Exception\CurlExec
      *
      * @see http://saucelabs.com/docs/saucerest
      */

lib/WebDriver/Service/CurlService.php

@@ -23,6 +23,8 @@
 
 namespace WebDriver\Service;
 
+use WebDriver\Exception as WebDriverException;
+
 /**
  * WebDriver\Service\CurlService class
  *
@@ -87,24 +89,28 @@ public function execute($requestMethod, $url, $parameters = null, $extraOptions
         curl_setopt($curl, CURLOPT_HTTPHEADER, $customHeaders);
 
         $rawResult = trim(curl_exec($curl));
+
         $info = curl_getinfo($curl);
-        // enrich the info a bit
         $info['request_method'] = $requestMethod;
 
-        // NB: this only gets triggered when CURLOPT_FAILONERROR has been set in extraOptions.
+        // This only gets triggered when CURLOPT_FAILONERROR has been set in extraOptions.
         // In that case, $rawResult is always empty.
         if (CURLE_GOT_NOTHING !== ($errno = curl_errno($curl)) && $error = curl_error($curl)) {
-
             curl_close($curl);
 
-            $message = sprintf(
-                "Curl error thrown for http %s to %s%s\n\n%s",
-                $requestMethod,
-                $url,
-                $parameters && is_array($parameters) ? ' with params: ' . json_encode($parameters) : '',
-                $error
+            throw WebDriverException::factory(
+                WebDriverException::CURL_EXEC,
+                sprintf(
+                    "Curl error thrown for http %s to %s%s\n\n%s",
+                    $requestMethod,
+                    $url,
+                    $parameters && is_array($parameters) ? ' with params: ' . json_encode($parameters) : '',
+                    $error
+                ),
+                $errno,
+                null,
+                $info
             );
-            throw new CurlServiceException($message, $errno, null, $info);
         }
 
         curl_close($curl);

lib/WebDriver/Service/CurlServiceException.php

@@ -39,7 +39,7 @@ interface CurlServiceInterface
      *
      * @return array
      *
-     * @throws \WebDriver\Service\CurlServiceException only if http error and CURLOPT_FAILONERROR has been set in extraOptions
+     * @throws \WebDriver\Exception\CurlExec only if http error and CURLOPT_FAILONERROR has been set in extraOptions
      */
     public function execute($requestMethod, $url, $parameters = null, $extraOptions = array());
 }

lib/WebDriver/Service/CurlServiceInterface.php

@@ -27,6 +27,8 @@
  * Test WebDriver\WebDriver class
  *
  * @package WebDriver
+ *
+ * @group Functional
  */
 class WebDriverTest extends \PHPUnit_Framework_TestCase
 {
@@ -43,9 +45,11 @@ protected function setUp()
         if ($url = getenv('ROOT_URL')) {
             $this->testDocumentRootUrl = $url;
         }
+
         if ($url = getenv('SELENIUM_URL')) {
             $this->testSeleniumRootUrl = $url;
         }
+
         $this->driver  = new WebDriver($this->getTestSeleniumRootUrl());
         $this->session = null;
     }
@@ -63,6 +67,7 @@ protected function tearDown()
     /**
      * Returns the full url to the test site (corresponding to the root dir of the library).
      * You can set this via env var ROOT_URL
+     *
      * @return string
      */
     protected function getTestDocumentRootUrl()
@@ -72,6 +77,7 @@ protected function getTestDocumentRootUrl()
 
     /**
      * Returns the full url to the Selenium server used for functional tests
+     *
      * @return string
      *
      * @todo make this configurable via env var
@@ -81,19 +87,27 @@ protected function getTestSeleniumRootUrl()
         return $this->testSeleniumRootUrl;
     }
 
+    /**
+     * Is Selenium down?
+     *
+     * @param \Exception $exception
+     *
+     * @return boolean
+     */
     protected function isSeleniumDown($exception)
     {
         return preg_match('/Failed to connect to .* Connection refused/', $exception->getMessage()) != false
-            || strpos($exception->getMessage(), 'couldn\'t connect to host') !== false;
+            || strpos($exception->getMessage(), 'couldn\'t connect to host') !== false
+            || strpos($exception->getMessage(), 'Unable to connect to host') !== false;
     }
 
     /**
-     * @group Functional
+     * Test driver sessions
      */
     public function testSessions()
     {
         try {
-        $this->assertCount(0, $this->driver->sessions());
+            $this->assertCount(0, $this->driver->sessions());
 
             $this->session = $this->driver->session();
         } catch (\Exception $e) {
@@ -109,7 +123,7 @@ public function testSessions()
     }
 
     /**
-     * @group Functional
+     * Test driver status
      */
     public function testStatus()
     {
@@ -131,7 +145,6 @@ public function testStatus()
 
     /**
      * Checks that an error connecting to Selenium gives back the expected exception
-     * @group Functional
      */
     public function testSeleniumError()
     {
@@ -151,13 +164,9 @@ public function testSeleniumError()
 
     /**
      * Checks that a successful command to Selenium which returns an http error response gives back the expected exception
-     * @group Functional
      */
     public function testSeleniumErrorResponse()
     {
-        $this->markTestSkipped('this test is currently broken'); // see https://github.com/instaclick/php-webdriver/issues/77
-        return;
-
         try {
             $status = $this->driver->status();
         } catch (\Exception $e) {
@@ -171,6 +180,7 @@ public function testSeleniumErrorResponse()
         try {
             $this->session = $this->driver->session();
             $this->session->open($this->getTestDocumentRootUrl().'/test/Assets/index.html');
+
             $element = $this->session->element('id', 'a-quite-unlikely-html-element-id');
 
             $this->fail('Exception not thrown while looking for missing element in page');
@@ -181,7 +191,6 @@ public function testSeleniumErrorResponse()
 
     /**
      * Checks that a successful command to Selenium which returns 'nothing' according to spec does not raise an error
-     * @group Functional
      */
     public function testSeleniumNoResponse()
     {
@@ -198,6 +207,7 @@ public function testSeleniumNoResponse()
         $this->session = $this->driver->session();
         $timeouts = $this->session->timeouts();
         $out = $timeouts->async_script(array('type' => 'implicit', 'ms' => 1000));
+
         $this->assertEquals(null, $out);
     }
 }