253 lines
8.3 KiB
PHP
253 lines
8.3 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Drupal\FunctionalJavascriptTests;
|
|
|
|
use Drupal\Component\Utility\UrlHelper;
|
|
use Drupal\Tests\BrowserTestBase;
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
|
|
/**
|
|
* Runs a browser test using a driver that supports JavaScript.
|
|
*
|
|
* Module tests extending WebDriverTestBase must exist in the
|
|
* Drupal\Tests\your_module\FunctionalJavascript namespace and live in the
|
|
* modules/your_module/tests/src/FunctionalJavascript directory.
|
|
*
|
|
* Tests for core/lib/Drupal classes extending WebDriverTestBase must exist in
|
|
* the \Drupal\FunctionalJavascriptTests\Core namespace and live in the
|
|
* core/tests/Drupal/FunctionalJavascriptTests directory.
|
|
*
|
|
* Base class for testing browser interaction implemented in JavaScript.
|
|
*
|
|
* @ingroup testing
|
|
*/
|
|
abstract class WebDriverTestBase extends BrowserTestBase {
|
|
|
|
/**
|
|
* Determines if a test should fail on JavaScript console errors.
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $failOnJavascriptConsoleErrors = TRUE;
|
|
|
|
/**
|
|
* Disables CSS animations in tests for more reliable testing.
|
|
*
|
|
* CSS animations are disabled by installing the css_disable_transitions_test
|
|
* module. Set to FALSE to test CSS animations.
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $disableCssAnimations = TRUE;
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected $minkDefaultDriverClass = DrupalSelenium2Driver::class;
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function initMink() {
|
|
if (!is_a($this->minkDefaultDriverClass, DrupalSelenium2Driver::class, TRUE)) {
|
|
throw new \UnexpectedValueException(sprintf("%s has to be an instance of %s", $this->minkDefaultDriverClass, DrupalSelenium2Driver::class));
|
|
}
|
|
$this->minkDefaultDriverArgs = ['chrome', ['goog:chromeOptions' => ['w3c' => FALSE]], 'http://localhost:4444'];
|
|
|
|
try {
|
|
return parent::initMink();
|
|
}
|
|
catch (\Exception $e) {
|
|
// If it's not possible to get a mink connection ensure that mink's own
|
|
// destructor is called immediately, to avoid it being called in
|
|
// ::tearDown(), then rethrow the exception.
|
|
$this->mink = NULL;
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function installModulesFromClassProperty(ContainerInterface $container) {
|
|
self::$modules = [
|
|
'js_testing_ajax_request_test',
|
|
'js_testing_log_test',
|
|
];
|
|
if ($this->disableCssAnimations) {
|
|
self::$modules[] = 'css_disable_transitions_test';
|
|
}
|
|
parent::installModulesFromClassProperty($container);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function initFrontPage() {
|
|
parent::initFrontPage();
|
|
// Set a standard window size so that all javascript tests start with the
|
|
// same viewport.
|
|
$this->getSession()->resizeWindow(1024, 768);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function tearDown(): void {
|
|
if ($this->mink) {
|
|
// Wait for all requests to finish. It is possible that an AJAX request is
|
|
// still on-going.
|
|
$result = $this->getSession()->wait(5000, 'window.drupalActiveXhrCount === 0 || typeof window.drupalActiveXhrCount === "undefined"');
|
|
if (!$result) {
|
|
// If the wait is unsuccessful, there may still be an AJAX request in
|
|
// progress. If we tear down now, then this AJAX request may fail with
|
|
// missing database tables, because tear down will have removed them.
|
|
// Rather than allow it to fail, throw an explicit exception now
|
|
// explaining what the problem is.
|
|
throw new \RuntimeException('Unfinished AJAX requests while tearing down a test');
|
|
}
|
|
|
|
$warnings = $this->getSession()->evaluateScript("JSON.parse(sessionStorage.getItem('js_testing_log_test.warnings') || JSON.stringify([]))");
|
|
foreach ($warnings as $warning) {
|
|
if (str_starts_with($warning, '[Deprecation]')) {
|
|
// phpcs:ignore Drupal.Semantics.FunctionTriggerError
|
|
@trigger_error('Javascript Deprecation:' . substr($warning, 13), E_USER_DEPRECATED);
|
|
}
|
|
}
|
|
}
|
|
parent::tearDown();
|
|
}
|
|
|
|
/**
|
|
* Triggers a test failure if a JavaScript error was encountered.
|
|
*
|
|
* @throws \PHPUnit\Framework\AssertionFailedError
|
|
*
|
|
* @postCondition
|
|
*/
|
|
protected function failOnJavaScriptErrors(): void {
|
|
if ($this->failOnJavascriptConsoleErrors) {
|
|
$errors = $this->getSession()->evaluateScript("JSON.parse(sessionStorage.getItem('js_testing_log_test.errors') || JSON.stringify([]))");
|
|
if (!empty($errors)) {
|
|
$this->fail(implode("\n", $errors));
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function getMinkDriverArgs() {
|
|
if ($this->minkDefaultDriverClass === DrupalSelenium2Driver::class) {
|
|
$json = getenv('MINK_DRIVER_ARGS_WEBDRIVER') ?: parent::getMinkDriverArgs();
|
|
if (!($json === FALSE || $json === '')) {
|
|
$args = json_decode($json, TRUE);
|
|
if (isset($args[0]) && $args[0] === 'chrome' && !isset($args[1]['goog:chromeOptions']['w3c'])) {
|
|
// @todo https://www.drupal.org/project/drupal/issues/3421202
|
|
// Deprecate defaulting behavior and require w3c to be set.
|
|
$args[1]['goog:chromeOptions']['w3c'] = FALSE;
|
|
}
|
|
$json = json_encode($args);
|
|
}
|
|
return $json;
|
|
}
|
|
return parent::getMinkDriverArgs();
|
|
}
|
|
|
|
/**
|
|
* Waits for the given time or until the given JS condition becomes TRUE.
|
|
*
|
|
* @param string $condition
|
|
* JS condition to wait until it becomes TRUE.
|
|
* @param int $timeout
|
|
* (Optional) Timeout in milliseconds, defaults to 10000.
|
|
* @param string $message
|
|
* (optional) A message to display with the assertion. If left blank, a
|
|
* default message will be displayed.
|
|
*
|
|
* @throws \PHPUnit\Framework\AssertionFailedError
|
|
*
|
|
* @see \Behat\Mink\Driver\DriverInterface::evaluateScript()
|
|
*/
|
|
protected function assertJsCondition($condition, $timeout = 10000, $message = '') {
|
|
$message = $message ?: "JavaScript condition met:\n" . $condition;
|
|
$result = $this->getSession()->getDriver()->wait($timeout, $condition);
|
|
$this->assertTrue($result, $message);
|
|
}
|
|
|
|
/**
|
|
* Creates a screenshot.
|
|
*
|
|
* @param string $filename
|
|
* The file name of the resulting screenshot including a writable path. For
|
|
* example, /tmp/test_screenshot.jpg.
|
|
* @param bool $set_background_color
|
|
* (optional) By default this method will set the background color to white.
|
|
* Set to FALSE to override this behavior.
|
|
*
|
|
* @throws \Behat\Mink\Exception\UnsupportedDriverActionException
|
|
* When operation not supported by the driver.
|
|
* @throws \Behat\Mink\Exception\DriverException
|
|
* When the operation cannot be done.
|
|
*/
|
|
protected function createScreenshot($filename, $set_background_color = TRUE) {
|
|
$session = $this->getSession();
|
|
if ($set_background_color) {
|
|
$session->executeScript("document.body.style.backgroundColor = 'white';");
|
|
}
|
|
$image = $session->getScreenshot();
|
|
file_put_contents($filename, $image);
|
|
}
|
|
|
|
/**
|
|
* Returns WebAssert object.
|
|
*
|
|
* @param string $name
|
|
* (optional) Name of the session. Defaults to the active session.
|
|
*
|
|
* @return \Drupal\FunctionalJavascriptTests\WebDriverWebAssert
|
|
* A new web-assert option for asserting the presence of elements with.
|
|
*/
|
|
public function assertSession($name = NULL) {
|
|
return new WebDriverWebAssert($this->getSession($name), $this->baseUrl);
|
|
}
|
|
|
|
/**
|
|
* Gets the current Drupal javascript settings and parses into an array.
|
|
*
|
|
* Unlike BrowserTestBase::getDrupalSettings(), this implementation reads the
|
|
* current values of drupalSettings, capturing all changes made via javascript
|
|
* after the page was loaded.
|
|
*
|
|
* @return array
|
|
* The Drupal javascript settings array.
|
|
*
|
|
* @see \Drupal\Tests\BrowserTestBase::getDrupalSettings()
|
|
*/
|
|
protected function getDrupalSettings() {
|
|
$script = <<<EndOfScript
|
|
(function () {
|
|
if (typeof drupalSettings !== 'undefined') {
|
|
return drupalSettings;
|
|
}
|
|
})();
|
|
EndOfScript;
|
|
$settings = $this->getSession()->evaluateScript($script) ?: [];
|
|
if (isset($settings['ajaxPageState'])) {
|
|
$settings['ajaxPageState']['libraries'] = UrlHelper::uncompressQueryParameter($settings['ajaxPageState']['libraries']);
|
|
}
|
|
return $settings;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function getHtmlOutputHeaders() {
|
|
// The webdriver API does not support fetching headers.
|
|
return '';
|
|
}
|
|
|
|
}
|