Merge pull request php-webdriver#383 from OndraM/feature/functional-tests

Rewrite functional tests and run them also in Firefox on Travis

Author: OndraM

.gitignore

@@ -2,6 +2,7 @@ composer.phar
 composer.lock
 vendor
 .php_cs.cache
+phpunit.xml
 
 # generic files to ignore
 *.lock

.travis.yml

@@ -5,13 +5,19 @@ php:
   - 5.6
   - 7
   - 7.1
-  - hhvm
 
 matrix:
   include:
+    # Add build to run tests against Firefox (other runs are agains HtmlUnit by default)
+    - php: 7
+      env: BROWSER_NAME="firefox"
     # Add PHP 7 build to check codestyle only in PHP 7 build
     - php: 7
       env: CHECK_CODESTYLE=1
+      before_script: ~
+      script:
+        - ./vendor/bin/php-cs-fixer fix --diff --dry-run
+        - ./vendor/bin/phpcs --standard=PSR2 ./lib/ ./tests/
 
 env:
   global:
@@ -20,23 +26,35 @@ env:
 cache:
   directories:
     - $HOME/.composer/cache
+    - jar
 
 before_install:
   - travis_retry composer self-update
 
 install:
-  - travis_retry composer install --no-interaction --prefer-source
+  - travis_retry composer install --no-interaction
 
 before_script:
-  - if [ -z "$CHECK_CODESTYLE" ]; then sh -e /etc/init.d/xvfb start; fi
-  - if [ -z "$CHECK_CODESTYLE" ]; then wget -q -t 3 http://selenium-release.storage.googleapis.com/2.45/selenium-server-standalone-2.45.0.jar; fi
-  - if [ -z "$CHECK_CODESTYLE" ]; then java -jar selenium-server-standalone-2.45.0.jar -log selenium.log; fi &
-  - if [ -z "$CHECK_CODESTYLE" ]; then until $(echo | nc localhost 4444); do sleep 1; echo waiting for selenium-server...; done; fi
+  - sh -e /etc/init.d/xvfb start
+  # TODO: upgrade to Selenium 3.0.2 (with latest HtmlUnit) once released, as HtmlUnit in 3.0.1 is broken
+  - if [ ! -f jar/selenium-server-standalone-2.53.1.jar ]; then wget -q -t 3 -P jar https://selenium-release.storage.googleapis.com/2.53/selenium-server-standalone-2.53.1.jar; fi
+  - if [ ! -f jar/htmlunit-driver-standalone-2.20.jar ]; then wget -q -t 3 -P jar https://github.com/SeleniumHQ/htmlunit-driver/releases/download/2.20/htmlunit-driver-standalone-2.20.jar; fi
+  # Temporarily run HtmlUnit from standalone jar file (it was not part of Selenium server standalone in version 2.53)
+  - java -cp "jar/selenium-server-standalone-2.53.1.jar:jar/htmlunit-driver-standalone-2.20.jar" org.openqa.grid.selenium.GridLauncher -log selenium.log &
+  # TODO: use this after upgrade to Selenium 3.0.2
+  #- /usr/lib/jvm/java-8-oracle/bin/java -Dwebdriver.firefox.marionette=false -jar jar/selenium-server-standalone-3.0.2.jar -log selenium.log &
+  - until $(echo | nc localhost 4444); do sleep 1; echo waiting for selenium-server...; done
+  - php -S localhost:8000 -t tests/functional/web/ &>>php-server.log &
 
 script:
-  - if [ -n "$CHECK_CODESTYLE" ]; then ./vendor/bin/php-cs-fixer fix --diff --dry-run; fi
-  - if [ -n "$CHECK_CODESTYLE" ]; then ./vendor/bin/phpcs --standard=PSR2 ./lib/ ./tests/; fi
-  - if [ -z "$CHECK_CODESTYLE" ]; then ./vendor/bin/phpunit; fi
+  - ./vendor/bin/phpunit
 
 after_script:
   - cat selenium.log
+  - cat php-server.log
+
+addons:
+  firefox: "latest-esr"
+  apt:
+    packages:
+      - oracle-java8-installer

CHANGELOG.md

@@ -2,6 +2,8 @@
 This project versioning adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
+- `Symfony\Process` is used to start local WebDriver processes (when browsers are run directly, without Selenium server) to workaround some PHP bugs and improve poratbility
+-  Clarified meaning of selenium server URL variable in methods of `RemoteWebDriver` class
 
 ## 1.2.0 - 2016-10-14
 - Added initial support of remote Microsoft Edge browser (but starting local EdgeDriver is still not supported)

lib/Remote/RemoteWebDriver.php

@@ -479,7 +479,7 @@ public function setCommandExecutor(WebDriverCommandExecutor $executor)
     }
 
     /**
-     * Set the command executor of this RemoteWebdriver
+     * Get the command executor of this RemoteWebdriver
      *
      * @return HttpCommandExecutor
      */
@@ -512,7 +512,7 @@ public function getSessionID()
     }
 
     /**
-     * Get all selenium sessions.
+     * Returns a list of the currently active sessions.
      *
      * @param string $selenium_server_url The url of the remote Selenium WebDriver server
      * @param int $timeout_in_ms

tests/functional/BaseTest.php

@@ -17,33 +17,47 @@
 
 use Facebook\WebDriver\Remote\LocalFileDetector;
 
-/**
- * An example test case for php-webdriver.
- *
- * Try running it by
- *   '../vendor/phpunit/phpunit/phpunit.php ExampleTestCase.php'
- */
 class FileUploadTest extends WebDriverTestCase
 {
-    public function testFileUploading()
+    public function testShouldUploadAFile()
     {
-        $this->driver->get($this->getTestPath('upload.html'));
-        $file_input = $this->driver->findElement(WebDriverBy::id('upload'));
-        $file_input->setFileDetector(new LocalFileDetector())
-            ->sendKeys(__DIR__ . '/files/FileUploadTestCaseFile.txt');
-        self::assertNotEquals($this->getFilePath(), $file_input->getAttribute('value'));
+        $this->driver->get($this->getTestPageUrl('upload.html'));
+
+        $fileElement = $this->driver->findElement(WebDriverBy::name('upload'));
+
+        $fileElement->setFileDetector(new LocalFileDetector())
+            ->sendKeys($this->getTestFilePath());
+
+        $fileElement->submit();
+
+        $this->driver->wait()->until(
+            WebDriverExpectedCondition::titleIs('File upload endpoint')
+        );
+
+        $uploadedFilesList = $this->driver->findElements(WebDriverBy::cssSelector('ul.uploaded-files li'));
+        $this->assertCount(1, $uploadedFilesList);
+
+        $uploadedFileName = $this->driver->findElement(WebDriverBy::cssSelector('ul.uploaded-files li span.file-name'))
+            ->getText();
+        $uploadedFileSize = $this->driver->findElement(WebDriverBy::cssSelector('ul.uploaded-files li span.file-size'))
+            ->getText();
+
+        $this->assertSame('FileUploadTestFile.txt', $uploadedFileName);
+        $this->assertSame('10', $uploadedFileSize);
     }
 
-    public function testUselessFileDetectorSendKeys()
+    public function xtestUselessFileDetectorSendKeys()
     {
         $this->driver->get($this->getTestPath('upload.html'));
+
         $file_input = $this->driver->findElement(WebDriverBy::id('upload'));
-        $file_input->sendKeys($this->getFilePath());
-        self::assertEquals($this->getFilePath(), $file_input->getAttribute('value'));
+        $file_input->sendKeys($this->getTestFilePath());
+
+        $this->assertEquals($this->getTestFilePath(), $file_input->getAttribute('value'));
     }
 
-    private function getFilePath()
+    private function getTestFilePath()
     {
-        return __DIR__ . '/files/FileUploadTestCaseFile.txt';
+        return __DIR__ . '/Fixtures/FileUploadTestFile.txt';
     }
 }

tests/functional/FileUploadTest.php

@@ -0,0 +1,63 @@
+<?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\Exception\NoSuchElementException;
+use Facebook\WebDriver\Remote\RemoteWebElement;
+
+/**
+ * Tests for findElement() and findElements() method of RemoteWebDriver.
+ */
+class RemoteWebDriverFindElementTest extends WebDriverTestCase
+{
+    public function testShouldThrowExceptionOfElementCannotBeFound()
+    {
+        $this->driver->get($this->getTestPath('index.html'));
+
+        $this->setExpectedException(NoSuchElementException::class, 'Unable to locate element');
+        $this->driver->findElement(WebDriverBy::id('not_existing'));
+    }
+
+    public function testShouldFindElementIfExistsOnAPage()
+    {
+        $this->driver->get($this->getTestPath('index.html'));
+
+        $element = $this->driver->findElement(WebDriverBy::id('id_test'));
+
+        $this->assertInstanceOf(RemoteWebElement::class, $element);
+    }
+
+    public function testShouldReturnEmptyArrayIfElementsCannotBeFound()
+    {
+        $this->driver->get($this->getTestPath('index.html'));
+
+        $elements = $this->driver->findElements(WebDriverBy::cssSelector('not_existing'));
+
+        $this->assertInternalType('array', $elements);
+        $this->assertCount(0, $elements);
+    }
+
+    public function testShouldFindMultipleElements()
+    {
+        $this->driver->get($this->getTestPath('index.html'));
+
+        $elements = $this->driver->findElements(WebDriverBy::cssSelector('ul > li'));
+
+        $this->assertInternalType('array', $elements);
+        $this->assertCount(3, $elements);
+        $this->assertContainsOnlyInstancesOf(RemoteWebElement::class, $elements);
+    }
+}