From 639a4eb38fd1b9f7d3e4f4e7bee6d1968029810b Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Wed, 3 Jun 2020 14:28:55 -0400 Subject: [PATCH 1/5] Back to dev. --- config/VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/VERSION b/config/VERSION index 873ca0fa6..7c8fee07e 100644 --- a/config/VERSION +++ b/config/VERSION @@ -1 +1 @@ -v2.7.0 +v2.7.0-dev From fef8e73950b8222057b1d960c8a2042ba4825bb2 Mon Sep 17 00:00:00 2001 From: Adam Date: Thu, 18 Jun 2020 13:53:42 -0400 Subject: [PATCH 2/5] Add support for Drupal Test Traits' Selenium2 driver (#92) --- src/Task/TestFramework/PhpUnitTask.php | 193 +++++++++++-------------- 1 file changed, 88 insertions(+), 105 deletions(-) diff --git a/src/Task/TestFramework/PhpUnitTask.php b/src/Task/TestFramework/PhpUnitTask.php index 7117c57eb..9c75b416b 100644 --- a/src/Task/TestFramework/PhpUnitTask.php +++ b/src/Task/TestFramework/PhpUnitTask.php @@ -14,6 +14,20 @@ class PhpUnitTask extends TestFrameworkBase { use SutSettingsTrait; + /** + * The DOM document for the PHPUnit configuration file. + * + * @var \DOMDocument + */ + private $doc; + + /** + * The XPath helper for the DOM document. + * + * @var \DOMXPath + */ + private $xpath; + /** * {@inheritdoc} */ @@ -44,16 +58,17 @@ public function execute(): void { */ private function ensurePhpUnitConfig() { $path = $this->fixture->getPath('docroot/core/phpunit.xml'); - $doc = new \DOMDocument(); - $doc->load($path); - $xpath = new \DOMXPath($doc); + $this->doc = new \DOMDocument($path); + $this->doc->load($path); + $this->xpath = new \DOMXPath($this->doc); $this->ensureSimpleTestDirectory(); - $this->setSimpletestSettings($path, $doc, $xpath); - $this->setTestSuite($path, $doc, $xpath); - $this->enableDrupalTestTraits($path, $doc, $xpath); - $this->disableSymfonyDeprecationsHelper($path, $doc, $xpath); - $this->setMinkDriverArguments($path, $doc, $xpath); + $this->setSimpletestSettings(); + $this->setTestSuite(); + $this->enableDrupalTestTraits(); + $this->disableSymfonyDeprecationsHelper(); + $this->setMinkDriverArguments(); + $this->writeConfiguration($path); } /** @@ -65,123 +80,117 @@ private function ensureSimpleTestDirectory(): void { /** * Sets Simpletest settings. - * - * @param string $path - * The path. - * @param \DOMDocument $doc - * The DOM document. - * @param \DOMXPath $xpath - * The XPath object. */ - private function setSimpletestSettings(string $path, \DOMDocument $doc, \DOMXPath $xpath): void { - $xpath->query('//phpunit/php/env[@name="SIMPLETEST_BASE_URL"]') + private function setSimpletestSettings(): void { + $this->xpath->query('//phpunit/php/env[@name="SIMPLETEST_BASE_URL"]') ->item(0) ->setAttribute('value', sprintf('http://%s', Fixture::WEB_ADDRESS)); - $xpath->query('//phpunit/php/env[@name="SIMPLETEST_DB"]') + $this->xpath->query('//phpunit/php/env[@name="SIMPLETEST_DB"]') ->item(0) ->setAttribute('value', 'sqlite://localhost/sites/default/files/.ht.sqlite'); - $doc->save($path); } /** * Sets TestSuite config in phpunit.xml. - * - * @param string $path - * The path. - * @param \DOMDocument $doc - * The DOM document. - * @param \DOMXPath $xpath - * The XPath object. */ - private function setTestSuite(string $path, \DOMDocument $doc, \DOMXPath $xpath): void { - $directory = $doc->createElement('directory', $this->getPath()); - $exclude = $doc->createElement('exclude', "{$this->getPath()}/vendor"); - $testsuite = $doc->createElement('testsuite'); + private function setTestSuite(): void { + $directory = $this->doc->createElement('directory', $this->getPath()); + $exclude = $this->doc->createElement('exclude', "{$this->getPath()}/vendor"); + $testsuite = $this->doc->createElement('testsuite'); $testsuite->setAttribute('name', 'orca'); $testsuite->appendChild($directory); $testsuite->appendChild($exclude); - $xpath->query('//phpunit/testsuites') + $this->xpath->query('//phpunit/testsuites') ->item(0) ->appendChild($testsuite); - $doc->save($path); } /** * Sets PHPUnit environment variables so that Drupal Test Traits can work. - * - * @param string $path - * The path. - * @param \DOMDocument $doc - * The DOM document. - * @param \DOMXPath $xpath - * The XPath object. */ - private function enableDrupalTestTraits(string $path, \DOMDocument $doc, \DOMXPath $xpath): void { + private function enableDrupalTestTraits(): void { // The bootstrap script is located in ORCA's vendor directory, not the // fixture's, since ORCA controls the available test frameworks and // infrastructure. - $xpath->query('//phpunit') + $this->xpath->query('//phpunit') ->item(0) ->setAttribute('bootstrap', "{$this->projectDir}/vendor/weitzman/drupal-test-traits/src/bootstrap.php"); - if (!$xpath->query('//phpunit/php/env[@name="DTT_BASE_URL"]')->length) { - $element = $doc->createElement('env'); - $element->setAttribute('name', 'DTT_BASE_URL'); - $element->setAttribute('value', sprintf('http://%s', Fixture::WEB_ADDRESS)); - $xpath->query('//phpunit/php') - ->item(0) - ->appendChild($element); - } - - $doc->save($path); + $this->setEnvironmentVariable('DTT_BASE_URL', sprintf('http://%s', Fixture::WEB_ADDRESS)); + $this->setEnvironmentVariable('DTT_MINK_DRIVER_ARGS', $this->getMinkWebDriverArguments()); } /** * Disables the Symfony Deprecations Helper. + */ + private function disableSymfonyDeprecationsHelper(): void { + $this->setEnvironmentVariable('SYMFONY_DEPRECATIONS_HELPER', 'disabled'); + } + + /** + * Sets an environment variable in the PHPUnit configuration. * - * @param string $path - * The path. - * @param \DOMDocument $doc - * The DOM document. - * @param \DOMXPath $xpath - * The XPath object. + * @param string $name + * The name of the variable to set. + * @param string $value + * The value of the variable to set. */ - private function disableSymfonyDeprecationsHelper(string $path, \DOMDocument $doc, \DOMXPath $xpath): void { - $result = $xpath->query('//phpunit/php/env[@name="SYMFONY_DEPRECATIONS_HELPER"]'); - // Before Drupal 8.6, the tag in question was present and merely needed the - // value changed. + private function setEnvironmentVariable(string $name, string $value): void { + $result = $this->xpath->query(sprintf('//phpunit/php/env[@name="%s"]', $name)); + if ($result->length) { $element = $result->item(0); - $element->setAttribute('value', 'disabled'); - $doc->save($path); + $element->setAttribute('value', $value); } - // Since Drupal 8.6, the tag in question has been commented out and must be - // re-created rather than modified directly. else { - $element = $doc->createElement('env'); - $element->setAttribute('name', 'SYMFONY_DEPRECATIONS_HELPER'); - $element->setAttribute('value', 'disabled'); - $xpath->query('//phpunit/php') + $element = $this->doc->createElement('env'); + $element->setAttribute('name', $name); + $element->setAttribute('value', $value); + $this->xpath->query('//phpunit/php') ->item(0) ->appendChild($element); - $doc->save($path); } } /** * Sets the mink driver arguments. - * - * @param string $path - * The path. - * @param \DOMDocument $doc - * The DOM document. - * @param \DOMXPath $xpath - * The XPath object. */ - private function setMinkDriverArguments(string $path, \DOMDocument $doc, \DOMXPath $xpath): void { + private function setMinkDriverArguments(): void { // Create an element containing a JSON array which will control how // the Mink driver interacts with Chromedriver. - $mink_arguments = json_encode([ + $this->setEnvironmentVariable('MINK_DRIVER_ARGS_WEBDRIVER', $this->getMinkWebDriverArguments()); + } + + /** + * Writes the PHPUnit configuration to disk. + * + * When dumping the XML document tree, PHP will encode all double quotes in + * the JSON string to ", since the XML attribute value is itself + * enclosed in double quotes. There's no way to change this behavior, so we + * must do a string replacement in order to wrap the Mink driver arguments + * in single quotes. + * + * @param string $path + * The path at which to write the configuration. + * + * @see https://stackoverflow.com/questions/5473520/php-dom-and-single-quotes#5473718 + */ + private function writeConfiguration(string $path): void { + $mink_arguments = $this->getMinkWebDriverArguments(); + $search = sprintf('value="%s"', htmlentities($mink_arguments)); + $replace = sprintf("value='%s'", $mink_arguments); + $xml = str_replace($search, $replace, $this->doc->saveXML()); + file_put_contents($path, $xml); + } + + /** + * Returns JSON-encoded arguments for the Mink WebDriver driver. + * + * @return string + * The arguments for the WebDriver Mink driver, encoded as JSON. + */ + private function getMinkWebDriverArguments(): string { + return json_encode([ 'chrome', [ 'chrome' => [ @@ -197,32 +206,6 @@ private function setMinkDriverArguments(string $path, \DOMDocument $doc, \DOMXPa ], 'http://localhost:4444', ], JSON_UNESCAPED_SLASHES); - - $name_attribute = 'MINK_DRIVER_ARGS_WEBDRIVER'; - $expression = "//phpunit/php/env[@name='{$name_attribute}']"; - - if (!$xpath->query($expression)->length) { - $element = $doc->createElement('env'); - $element->setAttribute('name', $name_attribute); - $xpath->query('//phpunit/php') - ->item(0) - ->appendChild($element); - } - - $xpath->query($expression) - ->item(0) - ->setAttribute('value', $mink_arguments); - - // When dumping the XML document tree, PHP will encode all double quotes in - // the JSON string to ", since the XML attribute value is itself - // enclosed in double quotes. There's no way to change this behavior, so - // we must do a string replacement in order to wrap the Mink driver - // arguments in single quotes. - // @see https://stackoverflow.com/questions/5473520/php-dom-and-single-quotes#5473718 - $search = sprintf('value="%s"', htmlentities($mink_arguments)); - $replace = sprintf("value='%s'", $mink_arguments); - $xml = str_replace($search, $replace, $doc->saveXML()); - file_put_contents($path, $xml); } /** From 9a1bf9f042826aacd3a278e6d1a845fe37e5a9f2 Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Fri, 19 Jun 2020 11:44:48 -0400 Subject: [PATCH 3/5] Added phpinfo output to before_install build phase. --- bin/travis/before_install.sh | 3 +++ 1 file changed, 3 insertions(+) diff --git a/bin/travis/before_install.sh b/bin/travis/before_install.sh index bc0922a44..098dc42f1 100755 --- a/bin/travis/before_install.sh +++ b/bin/travis/before_install.sh @@ -38,6 +38,9 @@ phpenv config-rm xdebug.ini # Install the PECL YAML parser for strict YAML parsing. yes | pecl install yaml +# Display PHP information. +php -i + # Install Composer optimizations for faster builds. composer global require \ hirak/prestissimo \ From ac65462c0374f924557f9c0075e1b4be46ba743d Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Wed, 24 Jun 2020 12:15:21 -0400 Subject: [PATCH 4/5] Added Drupal Spec Tool to D9 jobs. --- config/packages.yml | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/config/packages.yml b/config/packages.yml index c06ce3524..072574c42 100644 --- a/config/packages.yml +++ b/config/packages.yml @@ -115,16 +115,13 @@ drupal/cog: acquia/drupal-spec-tool: type: behat-extension - # The Drupal Spec Tool depends on drupal/drupal-driver, which was not - # compatible with Drupal 9 at the time of this writing. - # @see https://github.com/jhedstrom/DrupalDriver/issues/225 core_matrix: + '>=9.0.0': + version: 4.x + version_dev: 4.x-dev '^8.7.0': version: 3.x version_dev: 3.x-dev - '*': - version: ~ - version_dev: ~ drupal/lightning_api: core_matrix: From 8b9cb1c6d484227988c9ffae88dbc16334f8c357 Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Wed, 24 Jun 2020 15:01:37 -0400 Subject: [PATCH 5/5] Bumped version number. --- config/VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/VERSION b/config/VERSION index 7c8fee07e..b77e3cc58 100644 --- a/config/VERSION +++ b/config/VERSION @@ -1 +1 @@ -v2.7.0-dev +v2.8.0