Issue #187: Add support for uploading files to remote Selenium instance

.travis.yml

@@ -21,6 +21,11 @@ matrix:
       env: WEBDRIVER=phantomjs
     - php: 5.5
       env: WEBDRIVER=phantomjs PHANTOM_VERSION=2
+    - php: 7.0
+      env: WEBDRIVER=selenium-remote
+      sudo: required
+      services:
+        - docker
 
 before_script:
   - sh bin/run-"$WEBDRIVER".sh

bin/run-selenium-remote.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+set -e
+
+echo '    Downloading selenium'
+docker pull selenium/standalone-firefox:2.53.1
+echo '    Running selenium'
+docker run -d -p 4444:4444 --network=host selenium/standalone-firefox:2.53.1

src/Selenium2Driver.php

@@ -13,6 +13,7 @@
 use Behat\Mink\Exception\DriverException;
 use Behat\Mink\Selector\Xpath\Escaper;
 use WebDriver\Element;
+use WebDriver\Exception\InvalidRequest;
 use WebDriver\Exception\NoSuchElement;
 use WebDriver\Exception\UnknownError;
 use WebDriver\Exception;
@@ -794,7 +795,18 @@ public function attachFile($xpath, $path)
         $element = $this->findElement($xpath);
         $this->ensureInputType($element, $xpath, 'file', 'attach a file on');
 
-        $element->postValue(array('value' => array($path)));
+        // Upload the file to Selenium and use the remote path. This will
+        // ensure that Selenium always has access to the file, even if it runs
+        // as a remote instance.
+        try {
+          $remote_path = $this->uploadFile($path);
+        }
+        catch (InvalidRequest $e) {
+          // File could not be uploaded to remote instance. Use the local path.
+          $remote_path = $path;
+        }
+
+        $element->postValue(array('value' => array($remote_path)));
     }
 
     /**
@@ -1120,4 +1132,52 @@ private function trigger($xpath, $event, $options = '{}')
         $script = 'Syn.trigger("' . $event . '", ' . $options . ', {{ELEMENT}})';
         $this->withSyn()->executeJsOnXpath($xpath, $script);
     }
+
+    /**
+     * Uploads a file to the Selenium instance.
+     *
+     * Note that uploading files is not part of the official WebDriver
+     * specification, but it is supported by Selenium.
+     * @see https://github.com/SeleniumHQ/selenium/blob/master/py/selenium/webdriver/remote/webelement.py#L533
+     *
+     * @param string $path     The path to the file to upload.
+     *
+     * @return string          The remote path.
+     *
+     * @throws DriverException When the file is not found.
+     * @throws InvalidRequest  When the driver does not support file uploads.
+     */
+    public function uploadFile($path) {
+        if (!is_file($path)) {
+          throw new DriverException('Could not upload file, the file: ' . $path . '. was not found.');
+        }
+
+        // Selenium only accepts uploads that are compressed as a Zip archive.
+        $temp_filename = tempnam('', 'WebDriverZip');
+
+        $archive = new \ZipArchive();
+        $archive->open($temp_filename, \ZipArchive::CREATE);
+        $archive->addFile($path, basename($path));
+        $archive->close();
+
+        try {
+          $remote_path = $this->getWebDriverSession()->file(array('file' => base64_encode(file_get_contents($temp_filename))));
+        }
+        catch (InvalidRequest $e) {
+          // Catch the error so we can still clean up the temporary archive.
+        }
+
+        unlink($temp_filename);
+
+        // If the file upload failed, then probably Selenium was not used but
+        // another web driver such as PhantomJS.
+        // @todo Support other drivers when (if) they get remote file transfer
+        // capability.
+        if (empty($remote_path)) {
+          throw new InvalidRequest();
+        }
+
+        return $remote_path;
+    }
+
 }