DrupalSelenium2Driver.php

Same filename and directory in other branches
  1. 9 core/tests/Drupal/FunctionalJavascriptTests/DrupalSelenium2Driver.php
  2. 10 core/tests/Drupal/FunctionalJavascriptTests/DrupalSelenium2Driver.php
  3. 11.x core/tests/Drupal/FunctionalJavascriptTests/DrupalSelenium2Driver.php

Namespace

Drupal\FunctionalJavascriptTests

File

core/tests/Drupal/FunctionalJavascriptTests/DrupalSelenium2Driver.php

View source
<?php

namespace Drupal\FunctionalJavascriptTests;

use Behat\Mink\Driver\Selenium2Driver;
use Behat\Mink\Exception\DriverException;
use WebDriver\Exception\UnknownError;
use WebDriver\ServiceFactory;

/**
 * Provides a driver for Selenium testing.
 */
class DrupalSelenium2Driver extends Selenium2Driver {
    
    /**
     * {@inheritdoc}
     */
    public function __construct($browserName = 'firefox', $desiredCapabilities = NULL, $wdHost = 'http://localhost:4444/wd/hub') {
        parent::__construct($browserName, $desiredCapabilities, $wdHost);
        ServiceFactory::getInstance()->setServiceClass('service.curl', WebDriverCurlService::class);
    }
    
    /**
     * {@inheritdoc}
     */
    public function setCookie($name, $value = NULL) {
        if ($value === NULL) {
            $this->getWebDriverSession()
                ->deleteCookie($name);
            return;
        }
        $cookieArray = [
            'name' => $name,
            'value' => urlencode($value),
            'secure' => FALSE,
            // Unlike \Behat\Mink\Driver\Selenium2Driver::setCookie we set a domain
            // and an expire date, as otherwise cookies leak from one test site into
            // another.
'domain' => parse_url($this->getWebDriverSession()
                ->url(), PHP_URL_HOST),
            'expires' => time() + 80000,
        ];
        $this->getWebDriverSession()
            ->setCookie($cookieArray);
    }
    
    /**
     * Uploads a file to the Selenium instance and returns the remote path.
     *
     * \Behat\Mink\Driver\Selenium2Driver::uploadFile() is a private method so
     * that can't be used inside a test, but we need the remote path that is
     * generated when uploading to make sure the file reference exists on the
     * container running selenium.
     *
     * @param string $path
     *   The path to the file to upload.
     *
     * @return string
     *   The remote path.
     *
     * @throws \Behat\Mink\Exception\DriverException
     *   When PHP is compiled without zip support, or the file doesn't exist.
     * @throws \WebDriver\Exception\UnknownError
     *   When an unknown error occurred during file upload.
     * @throws \Exception
     *   When a known error occurred during file upload.
     */
    public function uploadFileAndGetRemoteFilePath($path) {
        if (!is_file($path)) {
            throw new DriverException('File does not exist locally and cannot be uploaded to the remote instance.');
        }
        if (!class_exists('ZipArchive')) {
            throw new DriverException('Could not compress file, PHP is compiled without zip support.');
        }
        // Selenium only accepts uploads that are compressed as a Zip archive.
        $tempFilename = tempnam('', 'WebDriverZip');
        $archive = new \ZipArchive();
        $result = $archive->open($tempFilename, \ZipArchive::CREATE);
        if (!$result) {
            throw new DriverException('Zip archive could not be created. Error ' . $result);
        }
        $result = $archive->addFile($path, basename($path));
        if (!$result) {
            throw new DriverException('File could not be added to zip archive.');
        }
        $result = $archive->close();
        if (!$result) {
            throw new DriverException('Zip archive could not be closed.');
        }
        try {
            $remotePath = $this->getWebDriverSession()
                ->file([
                'file' => base64_encode(file_get_contents($tempFilename)),
            ]);
            // If no path is returned the file upload failed silently.
            if (empty($remotePath)) {
                throw new UnknownError();
            }
        } catch (\Exception $e) {
            throw $e;
        } finally {
            unlink($tempFilename);
        }
        return $remotePath;
    }

}

Classes

Title Deprecated Summary
DrupalSelenium2Driver Provides a driver for Selenium testing.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.