Report test results to saucelabs API to show the results on their dashboard

Author: OndraM

Diff for: composer.json

@@ -30,7 +30,7 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "Facebook\\WebDriver\\": "tests/unit"
+      "Facebook\\WebDriver\\": ["tests/unit", "tests/functional"]
     },
     "classmap": ["tests/functional/"]
   }

Diff for: phpunit.xml.dist

@@ -29,4 +29,9 @@
             <directory suffix=".php">./lib</directory>
         </whitelist>
     </filter>
+
+    <listeners>
+        <listener class="Facebook\WebDriver\ReportSauceLabsStatusListener"/>
+    </listeners>
+
 </phpunit>

Diff for: tests/functional/ReportSauceLabsStatusListener.php

@@ -0,0 +1,88 @@
+<?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;
+
+use Facebook\WebDriver\Remote\RemoteWebDriver;
+
+class ReportSauceLabsStatusListener extends \PHPUnit_Framework_BaseTestListener
+{
+    public function endTest(\PHPUnit_Framework_Test $test, $time)
+    {
+        if (!$test instanceof WebDriverTestCase || !$test->driver instanceof RemoteWebDriver) {
+            return;
+        }
+
+        /** @var WebDriverTestCase $test */
+        if (!$test->isSauceLabsBuild()) {
+            return;
+        }
+
+        $testStatus = $test->getStatus();
+
+        if ($this->testWasSkippedOrIncomplete($testStatus)) {
+            return;
+        }
+
+        $endpointUrl = sprintf(
+            'https://saucelabs.com/rest/v1/%s/jobs/%s',
+            getenv('SAUCE_USERNAME'),
+            $test->driver->getSessionID()
+        );
+
+        $data = [
+            'passed' => ($testStatus === \PHPUnit_Runner_BaseTestRunner::STATUS_PASSED),
+            'custom-data' => ['message' => $test->getStatusMessage()],
+        ];
+
+        $this->submitToSauceLabs($endpointUrl, $data);
+    }
+
+    /**
+     * @param int $testStatus
+     * @return bool
+     */
+    private function testWasSkippedOrIncomplete($testStatus)
+    {
+        if ($testStatus === \PHPUnit_Runner_BaseTestRunner::STATUS_SKIPPED
+            || $testStatus === \PHPUnit_Runner_BaseTestRunner::STATUS_INCOMPLETE) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $url
+     * @param array $data
+     */
+    private function submitToSauceLabs($url, array $data)
+    {
+        $curl = curl_init($url);
+        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
+        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($curl, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
+        curl_setopt($curl, CURLOPT_USERPWD, getenv('SAUCE_USERNAME') . ':' . getenv('SAUCE_ACCESS_KEY'));
+        curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
+
+        curl_exec($curl);
+
+        if (curl_errno($curl)) {
+            throw new \Exception(sprintf('Error publishing test results to SauceLabs: %s', curl_error($curl)));
+        }
+
+        curl_close($curl);
+    }
+}

Diff for: tests/functional/WebDriverTestCase.php

@@ -25,20 +25,20 @@
  */
 class WebDriverTestCase extends \PHPUnit_Framework_TestCase
 {
+    /** @var RemoteWebDriver $driver */
+    public $driver;
     /** @var bool Indicate whether WebDriver should be created on setUp */
     protected $createWebDriver = true;
     /** @var string */
     protected $serverUrl = 'http://localhost:4444/wd/hub';
-    /** @var RemoteWebDriver $driver */
-    protected $driver;
     /** @var DesiredCapabilities */
     protected $desiredCapabilities;
 
     protected function setUp()
     {
         $this->desiredCapabilities = new DesiredCapabilities();
 
-        if (getenv('SAUCELABS')) {
+        if ($this->isSauceLabsBuild()) {
             $this->setUpSauceLabs();
         } else {
             if (getenv('BROWSER_NAME')) {
@@ -66,6 +66,14 @@ protected function tearDown()
         }
     }
 
+    /**
+     * @return bool
+     */
+    public function isSauceLabsBuild()
+    {
+        return getenv('SAUCELABS') ? true : false;
+    }
+
     /**
      * Get the URL of given test HTML on running webserver.
      *
@@ -101,7 +109,7 @@ protected function setUpSauceLabs()
      */
     protected function skipOnSauceLabs($message = 'Not supported by SauceLabs')
     {
-        if (getenv('SAUCELABS')) {
+        if ($this->isSauceLabsBuild()) {
             $this->markTestSkipped($message);
         }
     }