Improve testability of the startup (runtime / preflight) code (#3809)

Author: greg-1-anderson

.circleci/config.yml

@@ -10,7 +10,35 @@ defaults: &defaults
 
 version: 2
 jobs:
-  build:
+  # Code style test:
+  #   FAIL if code does not conform to PSR-2 conventions
+  #   PASS otherwise
+  code_style:
+    <<: *defaults
+    docker:
+      - image: wodby/php:7.1
+    steps:
+      - checkout
+      - run: cp .docker/zz-php.ini /usr/local/etc/php/conf.d/
+      - run: composer install
+      - run: composer cs
+
+  # Mergable test:
+  #   FAIL if merging test branch with master produces conflicts
+  #   PASS if the test branch is out of date, but mergable without conflicts
+  check_mergable:
+    <<: *defaults
+    docker:
+      - image: wodby/php:7.1
+    steps:
+      - checkout
+      - run: git config --global user.email "[email protected]"
+      - run: git config --global user.name "Drush Merge Test Bot"
+      - run: git merge -q -m 'Merge check' origin/master
+
+  # PHP 7.1 test:
+  #   Checks the most common configuration.
+  test_71:
     <<: *defaults
     docker:
       - image: wodby/php:7.1
@@ -23,9 +51,12 @@ jobs:
       - run: cp .docker/zz-php.ini /usr/local/etc/php/conf.d/
       - run: composer install
       - run: $HOME/drush/.circleci/patch.sh
+      - run: composer lint
       - run: composer functional
 
-  build_highest:
+  # PHP 7.2 test with HIGHEST dependencies:
+  #   Determines whether a newer version of a dependency has broken Drush.
+  test_72_highest:
     <<: *defaults
     docker:
       - image: wodby/php:7.2
@@ -39,10 +70,16 @@ jobs:
       - run: composer remove --dev webflo/drupal-core-strict --no-update
       - run: composer require --dev drupal/core:8.7.x-dev --no-update
       - run: composer config platform.php 7.2
-      - run: composer install
+      - run: composer update
+      - run: composer lint
       - run: composer functional
 
-  build_56:
+  # PHP 5.6 test with LOWEST dependencies:
+  #   Determines whether any code introduced in this branch uses language
+  #   features not available in PHP 5.6, or whether there are any API calls
+  #   to dependency features not available in the lowest version listed
+  #   for a dependency in our composer.json file.
+  test_56_lowest:
     <<: *defaults
     docker:
       - image: wodby/php:5.6
@@ -53,14 +90,41 @@ jobs:
     steps:
       - checkout
       - run: cp .docker/zz-php.ini /usr/local/etc/php/conf.d/
-      - run: .scenarios.lock/install php5
+      - run: .scenarios.lock/install php5 lowest
       - run: $HOME/drush/.circleci/patch.sh
+      - run: composer lint
       - run: composer functional
 
 workflows:
   version: 2
-  build_test:
+  # Drush test jobs:
+  #   - If the mergable test fails, then skip all of the other tests
+  #     (except code style)
+  #   - If code style check fails, then run only the LOWEST test and skip
+  #     all of the others.
+  #   - If both the code style and mergable checks pass, then run the
+  #     standard and LOWEST tests.
+  drush:
     jobs:
-      - build
-      - build_highest
-      - build_56
+      - code_style
+      - check_mergable
+      - test_71:
+          requires:
+            - check_mergable
+            - code_style
+      - test_56_lowest:
+          requires:
+            - check_mergable
+  # Drush scheduled jobs:
+  #   - Run the HIGHEST tests daily at the stroke of midnight UTC
+  scheduled:
+    triggers:
+       - schedule:
+           cron: "0 0 * * *"
+           filters:
+             branches:
+               only:
+                 - master
+    jobs:
+      - test_72_highest
+

.docker/zz-php.ini

@@ -1,4 +1,5 @@
 [PHP]
 variables_order = GPCS
 error_reporting = E_ALL & ~E_DEPRECATED
-date.timezone = "UTC"
+date.timezone = "UTC"
+sendmail_path = "true"

.scenarios.lock/php5/composer.json

@@ -64,7 +64,7 @@
         "consolidation/output-formatters": "^3.3.1",
         "consolidation/robo": "^1.1.5",
         "consolidation/site-alias": "^1.1.6|^2",
-        "consolidation/site-process": "^0.1.13",
+        "consolidation/site-process": "^0.1.18",
         "grasmash/yaml-expander": "^1.1.1",
         "league/container": "~2",
         "psr/log": "~1.0",
@@ -125,18 +125,17 @@
         ],
         "test": [
             "@lint",
-            "@unit",
-            "@integration",
-            "@functional",
+            "@phpunit",
             "@cs"
         ],
         "api": "PATH=$HOME/bin:$PATH sami.phar --ansi update sami-config.php",
         "sami-install": "mkdir -p $HOME/bin && curl --output $HOME/bin/sami.phar http://get.sensiolabs.org/sami.phar && chmod +x $HOME/bin/sami.phar",
         "sut": "./drush --uri=dev",
         "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=${UNISH_DB_URL:-mysql://root:password@mariadb}/unish_dev -v",
-        "unit": "phpunit --colors=always --configuration tests --testsuite unit",
-        "integration": "phpunit --colors=always --configuration tests --testsuite integration",
-        "functional": "phpunit --colors=always --configuration tests --testsuite functional"
+        "phpunit": "php -d sendmail_path='true' vendor/bin/phpunit --colors=always --configuration tests",
+        "unit": "composer phpunit -- --testsuite unit",
+        "integration": "composer phpunit -- --testsuite integration",
+        "functional": "composer phpunit -- --testsuite functional"
     },
     "extra": {
         "installer-paths": {

.scenarios.lock/php5/composer.lock

@@ -50,7 +50,7 @@ before_script:
 
 script:
   - composer unit
-#  - composer integration
+  - composer integration
 
 after_success:
   # Publish updated API documentation on every push to the master branch

.travis.yml

@@ -40,7 +40,7 @@
     "consolidation/output-formatters": "^3.3.1",
     "consolidation/robo": "^1.1.5",
     "consolidation/site-alias": "^1.1.6|^2",
-    "consolidation/site-process": "^0.1.13",
+    "consolidation/site-process": "^0.1.18",
     "grasmash/yaml-expander": "^1.1.1",
     "league/container": "~2",
     "psr/log": "~1.0",
@@ -98,18 +98,17 @@
     ],
     "test": [
       "@lint",
-      "@unit",
-      "@integration",
-      "@functional",
+      "@phpunit",
       "@cs"
     ],
     "api": "PATH=$HOME/bin:$PATH sami.phar --ansi update sami-config.php",
     "sami-install": "mkdir -p $HOME/bin && curl --output $HOME/bin/sami.phar http://get.sensiolabs.org/sami.phar && chmod +x $HOME/bin/sami.phar",
     "sut": "./drush --uri=dev",
     "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=${UNISH_DB_URL:-mysql://root:password@mariadb}/unish_dev -v",
-    "unit": "phpunit --colors=always --configuration tests --testsuite unit",
-    "integration": "phpunit --colors=always --configuration tests --testsuite integration",
-    "functional": "phpunit --colors=always --configuration tests --testsuite functional"
+    "phpunit": "php -d sendmail_path='true' vendor/bin/phpunit --colors=always --configuration tests",
+    "unit": "composer phpunit -- --testsuite unit",
+    "integration": "composer phpunit -- --testsuite integration",
+    "functional": "composer phpunit -- --testsuite functional"
   },
   "extra": {
     "installer-paths": {

composer.json

@@ -4,6 +4,7 @@
 use Drush\Config\Environment;
 use Drush\Preflight\Preflight;
 use Drush\Runtime\Runtime;
+use Drush\Runtime\DependencyInjection;
 use Webmozart\PathUtil\Path;
 
 /**
@@ -62,7 +63,9 @@
 
 // Preflight and run
 $preflight = new Preflight($environment);
-$runtime = new Runtime($preflight);
+$di = new DependencyInjection();
+$di->desiredHandlers(['errorHandler', 'shutdownHandler']);
+$runtime = new Runtime($preflight, $di);
 $status_code = $runtime->run($_SERVER['argv']);
 
 exit($status_code);

composer.lock

@@ -14,47 +14,6 @@ use Drush\Drush;
 use Drush\Log\LogLevel;
 use Webmozart\PathUtil\Path;
 
-/**
- * Log PHP errors to the Drush log. This is in effect until Drupal's error
- * handler takes over.
- */
-function drush_error_handler($errno, $message, $filename, $line) {
-  // E_DEPRECATED was added in PHP 5.3. Drupal 6 will not fix all the
-  // deprecated errors, but suppresses them. So we suppress them as well.
-  if (defined('E_DEPRECATED')) {
-    $errno = $errno & ~E_DEPRECATED;
-  }
-
-  // "error_reporting" is usually set in php.ini, but may be changed by
-  // drush_errors_on() and drush_errors_off().
-  if ($errno & error_reporting()) {
-    // By default we log notices.
-    $type = Drush::config()->get('runtime.php.notices', LogLevel::INFO);
-    $halt_on_error = Drush::config()->get('runtime.php.halt-on-error', (drush_drupal_major_version() != 6));
-
-    // Bitmask value that constitutes an error needing to be logged.
-    $error = E_ERROR | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR | E_RECOVERABLE_ERROR;
-    if ($errno & $error) {
-      $type = 'error';
-    }
-
-    // Bitmask value that constitutes a warning being logged.
-    $warning = E_WARNING | E_CORE_WARNING | E_COMPILE_WARNING | E_USER_WARNING;
-    if ($errno & $warning) {
-      $type = LogLevel::WARNING;
-    }
-
-    Drush::logger()->log($type, $message . ' ' . basename($filename) . ':' . $line);
-
-    if ($errno == E_RECOVERABLE_ERROR && $halt_on_error) {
-      Drush::logger()->error(dt('E_RECOVERABLE_ERROR encountered; aborting. To ignore recoverable errors, run again with --no-halt-on-error'));
-      exit(DRUSH_APPLICATION_ERROR);
-    }
-
-    return TRUE;
-  }
-}
-
 /**
  * Converts a Windows path (dir1\dir2\dir3) into a Unix path (dir1/dir2/dir3).
  * Also converts a cygwin "drive emulation" path (/cygdrive/c/dir1) into a

drush.php

@@ -18,33 +18,6 @@ function drush_main() {
   require dirname(__DIR__) . '/drush.php';
 }
 
-/**
- * If the command is being executed with the --backend option, the script
- * will return a json string containing the options and log information
- * used by the script.
- *
- * The command will exit with '0' if it was successfully executed, and the
- * result of drush_get_error() if it wasn't.
- */
-function drush_shutdown() {
-  // Avoid doing anything if our container has not been initialized yet.
-  if (!Drush::hasContainer()) {
-    return;
-  }
-
-  if (!Drush::config()->get(Runtime::DRUSH_RUNTIME_COMPLETED_NAMESPACE)) {
-      Drush::logger()->warning('Drush command terminated abnormally. Check for an exit() in your Drupal site.');
-  }
-
-  if (Drush::backend()) {
-    drush_backend_output();
-  }
-
-  // This way drush_return_status() will always be the last shutdown function (unless other shutdown functions register shutdown functions...)
-  // and won't prevent other registered shutdown functions (IE from numerous cron methods) from running by calling exit() before they get a chance.
-  register_shutdown_function('drush_return_status');
-}
-
 /**
  * Shutdown function to save code coverage data.
  */
@@ -80,10 +53,3 @@ function drush_coverage_shutdown() {
     file_put_contents($file_name, serialize($data));
   }
 }
-
-/**
- * @deprecated. This function will be removed in Drush 10. Throw an exception to indicate an error.
- */
-function drush_return_status() {
-  exit(Runtime::exitCode());
-}