Merge pull request #490 from OndraM/feature/chromedriver-tests

Add tests for ChromeDriverService and ChromeDriver

Author: OndraM

.travis.yml

@@ -29,7 +29,13 @@ matrix:
 
     # Build with lowest possible dependencies
     - php: 7.1
-      env: dependencies="--prefer-lowest"
+      env: DEPENDENCIES="--prefer-lowest"
+
+    # Chrome on Travis build with lowest possible dependencies
+    - php: 7.1
+      env: BROWSER_NAME="chrome" CHROME_HEADLESS="1" DEPENDENCIES="--prefer-lowest"
+      addons:
+        chrome: beta
 
     # Saucelabs builds
     - php: 7.1
@@ -77,11 +83,11 @@ before_install:
   - travis_retry composer self-update
 
 install:
-  - travis_retry composer update --no-interaction $dependencies
+  - travis_retry composer update --no-interaction $DEPENDENCIES
 
 before_script:
   - if [ "$BROWSER_NAME" = "chrome" ]; then mkdir chromedriver; wget -q -t 3 https://chromedriver.storage.googleapis.com/$CHROMEDRIVER_VERSION/chromedriver_linux64.zip; unzip chromedriver_linux64 -d chromedriver; fi
-  - if [ "$BROWSER_NAME" = "chrome" ]; then export CHROMEDRIVER_PATH=./chromedriver/chromedriver; fi
+  - if [ "$BROWSER_NAME" = "chrome" ]; then export CHROMEDRIVER_PATH=$PWD/chromedriver/chromedriver; fi
   - sh -e /etc/init.d/xvfb start
   - if [ ! -f jar/selenium-server-standalone-3.4.0.jar ]; then wget -q -t 3 -P jar https://selenium-release.storage.googleapis.com/3.4/selenium-server-standalone-3.4.0.jar; fi
   - java -Dwebdriver.firefox.marionette=false -Dwebdriver.chrome.driver="$CHROMEDRIVER_PATH" -jar jar/selenium-server-standalone-3.4.0.jar -log ./logs/selenium.log &

composer.json

@@ -18,10 +18,12 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^5.4",
+    "sebastian/environment": "^1.3.4 || ^2.0 || ^3.0",
     "friendsofphp/php-cs-fixer": "^2.0",
     "squizlabs/php_codesniffer": "^2.6",
     "php-mock/php-mock-phpunit": "^1.1",
-    "satooshi/php-coveralls": "^1.0",
+    "php-coveralls/php-coveralls": "^1.0.2",
+    "guzzle/guzzle": "^3.4.1",
     "symfony/var-dumper": "^3.3"
   },
   "autoload": {

tests/functional/Chrome/ChromeDriverServiceTest.php

@@ -0,0 +1,82 @@
+<?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\Chrome;
+
+/**
+ * @group exclude-saucelabs
+ * @covers Facebook\WebDriver\Chrome\ChromeDriverService
+ * @covers Facebook\WebDriver\Remote\Service\DriverService
+ */
+class ChromeDriverServiceTest extends \PHPUnit_Framework_TestCase
+{
+    protected function setUp()
+    {
+        if (!getenv('BROWSER_NAME') === 'chrome' || getenv('SAUCELABS') || !getenv('CHROMEDRIVER_PATH')) {
+            $this->markTestSkipped('ChromeDriverServiceTest is run only when running against local chrome');
+        }
+    }
+
+    public function testShouldStartAndStopServiceCreatedUsingShortcutConstructor()
+    {
+        // The createDefaultService() method expect path to the executable to be present in the environment variable
+        putenv(ChromeDriverService::CHROME_DRIVER_EXE_PROPERTY . '=' . getenv('CHROMEDRIVER_PATH'));
+
+        $driverService = ChromeDriverService::createDefaultService();
+
+        $this->assertSame('http://localhost:9515', $driverService->getURL());
+
+        $this->assertInstanceOf(ChromeDriverService::class, $driverService->start());
+        $this->assertTrue($driverService->isRunning());
+
+        $this->assertInstanceOf(ChromeDriverService::class, $driverService->start());
+
+        $this->assertInstanceOf(ChromeDriverService::class, $driverService->stop());
+        $this->assertFalse($driverService->isRunning());
+
+        $this->assertInstanceOf(ChromeDriverService::class, $driverService->stop());
+    }
+
+    public function testShouldStartAndStopServiceCreatedUsingDefaultConstructor()
+    {
+        $driverService = new ChromeDriverService(getenv('CHROMEDRIVER_PATH'), 9515, ['--port=9515']);
+
+        $this->assertSame('http://localhost:9515', $driverService->getURL());
+
+        $driverService->start();
+        $this->assertTrue($driverService->isRunning());
+
+        $driverService->stop();
+        $this->assertFalse($driverService->isRunning());
+    }
+
+    public function testShouldThrowExceptionIfExecutableCannotBeFound()
+    {
+        putenv(ChromeDriverService::CHROME_DRIVER_EXE_PROPERTY . '=/not/existing');
+
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('\'/not/existing\' is not a file.');
+        ChromeDriverService::createDefaultService();
+    }
+
+    public function testShouldThrowExceptionIfExecutableIsNotExecutable()
+    {
+        putenv(ChromeDriverService::CHROME_DRIVER_EXE_PROPERTY . '=' . __FILE__);
+
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('is not executable');
+        ChromeDriverService::createDefaultService();
+    }
+}

tests/functional/Chrome/ChromeDriverTest.php

@@ -0,0 +1,60 @@
+<?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\Chrome;
+
+use Facebook\WebDriver\Remote\RemoteWebDriver;
+use Facebook\WebDriver\Remote\Service\DriverCommandExecutor;
+
+/**
+ * @group exclude-saucelabs
+ * @covers Facebook\WebDriver\Chrome\ChromeDriver
+ */
+class ChromeDriverTest extends \PHPUnit_Framework_TestCase
+{
+    /** @var ChromeDriver */
+    protected $driver;
+
+    protected function setUp()
+    {
+        if (!getenv('BROWSER_NAME') === 'chrome' || getenv('SAUCELABS') || !getenv('CHROMEDRIVER_PATH')) {
+            $this->markTestSkipped('ChromeDriverServiceTest is run only when running against local chrome');
+        }
+    }
+
+    protected function tearDown()
+    {
+        if ($this->driver instanceof RemoteWebDriver && $this->driver->getCommandExecutor() !== null) {
+            $this->driver->quit();
+        }
+    }
+
+    public function testShouldStartChromeDriver()
+    {
+        // The createDefaultService() method expect path to the executable to be present in the environment variable
+        putenv(ChromeDriverService::CHROME_DRIVER_EXE_PROPERTY . '=' . getenv('CHROMEDRIVER_PATH'));
+
+        $this->driver = ChromeDriver::start();
+
+        $this->assertInstanceOf(ChromeDriver::class, $this->driver);
+        $this->assertInstanceOf(DriverCommandExecutor::class, $this->driver->getCommandExecutor());
+
+        $this->driver->get('http://localhost:8000/');
+
+        $this->assertSame('http://localhost:8000/', $this->driver->getCurrentURL());
+
+        $this->driver->quit();
+    }
+}