Symfony dispatch

.travis.yml

@@ -23,6 +23,7 @@ sudo: false
 
 env:
   matrix:
+    - TEST_DIR=isolation
     - PHPUNIT_ARGS=--group=base
     - PHPUNIT_ARGS=--group=commands
     - PHPUNIT_ARGS=--exclude-group=base,commands
@@ -46,14 +47,18 @@ before_install:
   - echo 'mbstring.http_output = pass' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
 
 # Build a System-Under-Test.
-install: ${PWD}/unish.sut.php
+install:
+  - if [ -n "$TEST_DIR" ] ; then composer --working-dir=${PWD}/$TEST_DIR install ; fi
+  - if [ -z "$TEST_DIR" ] ; then ${PWD}/unish.sut.php ; fi
 
 before_script:
   - phpenv config-rm xdebug.ini
   - echo 'sendmail_path = /bin/true' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
   # - echo "sendmail_path='true'" >> `php --ini | grep "Loaded Configuration" | awk '{print $4}'`
 
-script: ${PWD}/unish.phpunit.php $PHPUNIT_ARGS
+script:
+  - if [ -n "$TEST_DIR" ] ; then cd $TEST_DIR && phpunit ; fi
+  - if [ -z "$TEST_DIR" ] ; then ${PWD}/unish.phpunit.php $PHPUNIT_ARGS ; fi
 
 # Background: https://github.com/drush-ops/drush/pull/1426
-after_success: ${PWD}/tests/testChildren.sh
+after_success: ${PWD}/tests/testChildren.sh

composer.json

@@ -28,11 +28,13 @@
     "psr/log": "~1.0",
     "psy/psysh": "~0.6",
     "league/container": "~2",
-    "consolidation/robo": "~1",
+    "consolidation/config": "dev-master",
+    "consolidation/robo": "^1.1.2",
     "symfony/config": "~2.2|^3",
     "chi-teck/drupal-code-generator": "^1.17.3",
-    "consolidation/annotated-command": "^2.4.13",
+    "consolidation/annotated-command": "dev-master as 2.7.0",
     "consolidation/output-formatters": "^3.1.11",
+    "grasmash/yaml-expander": "^1.1.1",
     "symfony/yaml": "~2.3|^3",
     "symfony/var-dumper": "~2.7|^3",
     "symfony/console": "~2.7|^3",
@@ -57,12 +59,14 @@
     }
   },
   "scripts": {
-    "cs": "phpcs --standard=PSR2 -n src",
-    "cbf": "phpcbf --standard=PSR2 -n src",
+    "cs": "phpcs -n src",
+    "cbf": "phpcbf -n src",
     "lint": [
       "find includes -name '*.inc' -print0 | xargs -0 -n1 php -l",
       "find src -name '*.php' -print0 | xargs -0 -n1 php -l"
-    ]
+    ],
+    "isolation": "cd isolation && phpunit --colors=always",
+    "post-update-cmd": "cd isolation && composer update"
   },
   "extra": {
     "branch-alias": {

docs/commands.md

@@ -14,7 +14,7 @@ Global Drush Commands
 
 Commandfiles that don't ship inside Drupal modules are called 'global' commandfiles. See the examples/Commands folder for examples. In general, its better to use modules to carry your Drush commands. If you still prefer using a global commandfiles, please note:
 
-1. The file's namespace should be \Drush.
+1. The file's namespace should be \Drush\Commands\[dir-name].
 1. The filename must end in Commands.php (e.g. FooCommands.php)
 1. The enclosing directory must be named Commands
 1. The directory above Commands must be one of: 
@@ -23,9 +23,7 @@ Commandfiles that don't ship inside Drupal modules are called 'global' commandfi
     1.  The ".drush" folder in the user's HOME folder.
     1.  ../drush, /drush and /sites/all/drush relative to the current Drupal installation.
 
-Avoiding the loading of certain Commandfiles
+Avoiding the loading of certain Commandfiles (Note: not functional right now).
 =================
-
-- Folders and files containing other versions of Drush in their names will be \*skipped\* (e.g. devel.drush7.inc or drush7/devel.drush.inc). Names containing the current version of Drush (e.g. devel.drush9.inc) will be loaded.
 - The --ignored-modules global option stops loading of commandfiles from specified modules.
 

docs/generators.md

@@ -12,4 +12,4 @@ See [Woot module](https://github.com/drush-ops/drush/blob/master/tests/resources
 
   1. Write a class similar to [ExampleGenerator](https://github.com/drush-ops/drush/tree/master/tests/resources/modules/d8/woot/src/Generators/). Implement your custom logic in the interact() method. Typically this class is placed in the src/Generators directory.
   1. Add your class to your module's drush.services.yml file ([example](https://github.com/drush-ops/drush/blob/master/tests/resources/modules/d8/woot/drush.services.yml)). Use the tag `drush.generator` instead of `drush.command`.
-  1. Perform a `drush cache-rebuild` to compile your drush.services.yml changes into the Drupal container. 
+  1. Perform a `drush cache-rebuild` to compile your drush.services.yml changes into the Drupal container. 

docs/index.md

@@ -28,4 +28,4 @@ pursuing one of the support options below.
 
 * Post support requests to [Drupal Answers](http://drupal.stackexchange.com/questions/tagged/drush).
 * Bug reports and feature requests should be reported in the [GitHub Drush Issue Queue](https://github.com/drush-ops/drush/issues).
-* Use pull requests (PRs) to contribute to Drush.
+* Use pull requests (PRs) to contribute to Drush.

drush.php

@@ -1,10 +1,64 @@
 <?php
+
+use Drush\Config\Environment;
+use Drush\Preflight\Preflight;
+use Webmozart\PathUtil\Path;
+
 /**
- * @file
- * Drush is a PHP script implementing a command line shell for Drupal.
+ * This script runs Drush.
+ *
+ * Responsibilities of this script:
+ *   - Locate and include the Composer autoload file for Drush.
+ *   - Set up the environment (record user home directory, cwd, etc.).
+ *   - Call the Preflight object to do all necessary setup and execution.
+ *   - Exit with status code returned
+ *
+ * It is our goal to put all $_SERVER access and other constructs that are
+ * difficult to test in this script to reduce the burden on the unit tests.
+ * This script will only be tested via the functional tests.
  *
- * @requires PHP CLI 5.6.0, or newer.
+ * The Drush bootstrap goes through the following steps:
+ *   - (ArgsPreprocessor) Preprocess the commandline arguments, considering only:
+ *     - The named alias `@sitealias` (removed from arguments if present)
+ *     - The --root option (read and retained)
+ *     - The --config option (read and retained)
+ *     - The --alias-path option (read and retained)
+ *   - Load the Drush configuration and alias files from the standard
+ *     global locations (including --config and --alias-path)
+ *   - Determine the local Drupal site targeted, if any
+ *   - Include the Composer autoload for Drupal (if different)
+ *   - Extend configuration and alias files to include files in target Drupal site.
+ *   - Create the Robo DI container and Symfony Application et. al.
+ *   - Run the Symfony Application
+ *     - Predispatch: call a remote Drush command if applicable
+ *     - Bootstrap Drupal via @bootstrap command hook
+ *     - Run commands and command hooks via annotated commands library
+ *     - Catch 'command not found' exception, bootstrap Drupal and run again
+ *   - Return status code
  */
 
-require __DIR__ . '/includes/preflight.inc';
-exit(drush_main());
+// We use PWD if available because getcwd() resolves symlinks, which
+// could take us outside of the Drupal root, making it impossible to find.
+$cwd = empty($_SERVER['PWD']) ? getcwd() : $_SERVER['PWD'];
+
+// Set up autoloader
+$loader = false;
+if (file_exists($autoloadFile = __DIR__ . '/vendor/autoload.php')
+    || file_exists($autoloadFile = __DIR__ . '/../autoload.php')
+    || file_exists($autoloadFile = __DIR__ . '/../../autoload.php')
+) {
+    $loader = include_once($autoloadFile);
+} else {
+    throw new \Exception("Could not locate autoload.php. cwd is $cwd; __DIR__ is " . __DIR__);
+}
+
+// Set up environment
+$environment = new Environment(Path::getHomeDirectory(), $cwd, $autoloadFile);
+$environment->setLoader($loader);
+$environment->applyEnvironment();
+
+// Preflight and run
+$preflight = new Preflight($environment);
+$status_code = $preflight->run($_SERVER['argv']);
+
+exit($status_code);

drush.yml

@@ -0,0 +1,3 @@
+drush:
+  php:
+    minimum-version: 5.6.0

examples/Commands/PolicyCommands.php

@@ -40,7 +40,7 @@ public function rsyncValidate(CommandData $commandData) {
    */
   public function validateUpdateDb(CommandData $commandData) {
     if (!$commandData->input()->getOption('secret') == 'mysecret') {
-      throw new \Exception(dt('UpoateDb command requires a secret token per site policy.'));
+      throw new \Exception(dt('UpdateDb command requires a secret token per site policy.'));
     }
   }
 

examples/Commands/SandwichCommands.php

@@ -36,7 +36,7 @@ public function makeSandwich($filling, $options = ['spreads' => NULL]) {
     $msg = dt('Okay. Enjoy this !filling sandwich!str_spreads.',
       array('!filling' => $filling, '!str_spreads' => $str_spreads)
     );
-    drush_print("\n" . $msg . "\n");
+    $this->output()->writeln("\n" . $msg . "\n");
     $this->printFile(__DIR__ . '/sandwich-nocolor.txt');
   }
 

examples/Commands/SyncViaHttpCommands.php

@@ -74,7 +74,7 @@ protected function downloadFile($url, $user = FALSE, $password = FALSE, $destina
         drush_shell_exec("curl -s -L --connect-timeout 30 -o %s %s", $destination_tmp, $url);
       }
     }
-    if (!drush_get_context('DRUSH_SIMULATE')) {
+    if (!\Drush\Drush::simulate()) {
       if (!drush_file_not_empty($destination_tmp) && $file = @file_get_contents($url)) {
         @file_put_contents($destination_tmp, $file);
       }

examples/Commands/XkcdCommands.php

@@ -1,12 +1,16 @@
 <?php
 namespace Drush\Commands;
 
+use Drush\Exec\ExecTrait;
+
 /**
  * Run these commands using the --include option - e.g. `drush --include=/path/to/drush/examples xkcd`
  */
 
 class XkcdCommands extends DrushCommands {
 
+  use ExecTrait;
+
   /**
    * Retrieve and display xkcd cartoons.
    *
@@ -24,25 +28,25 @@ class XkcdCommands extends DrushCommands {
    *   Retrieve and display a random cartoon in Firefox.
    * @aliases @xkcd
    */
-  public function fetch($search = NULL, $options = ['image-viewer' => 'open', 'google-custom-search-api-key' => NULL]) {
+  public function fetch($search = NULL, $options = ['image-viewer' => 'open', 'google-custom-search-api-key' => 'AIzaSyDpE01VDNNT73s6CEeJRdSg5jukoG244ek']) {
     if (empty($search)) {
-      drush_start_browser('http://xkcd.com');
+      $this->startBrowser('http://xkcd.com');
     }
     elseif (is_numeric($search)) {
-      drush_start_browser('http://xkcd.com/' . $search);
+      $this->startBrowser('http://xkcd.com/' . $search);
     }
     elseif ($search == 'random') {
       $xkcd_response = @json_decode(file_get_contents('http://xkcd.com/info.0.json'));
       if (!empty($xkcd_response->num)) {
-        drush_start_browser('http://xkcd.com/' . rand(1, $xkcd_response->num));
+        $this->startBrowser('http://xkcd.com/' . rand(1, $xkcd_response->num));
       }
     }
     else {
       // This uses an API key with a limited number of searches per.
-      $search_response = @json_decode(file_get_contents('https://www.googleapis.com/customsearch/v1?key=' . drush_get_option('google-custom-search-api-key', 'AIzaSyDpE01VDNNT73s6CEeJRdSg5jukoG244ek') . '&cx=012652707207066138651:zudjtuwe28q&q=' . $search));
+      $search_response = @json_decode(file_get_contents('https://www.googleapis.com/customsearch/v1?key=' . $options['google-custom-search-api-key'] . '&cx=012652707207066138651:zudjtuwe28q&q=' . $search));
       if (!empty($search_response->items)) {
         foreach ($search_response->items as $item) {
-          drush_start_browser($item->link);
+          $this->startBrowser($item->link);
         }
       }
       else {

examples/helloworld.script

@@ -1,48 +1,25 @@
-#!/usr/bin/env drush
+<?php
 
 //
 // This example demonstrates how to write a drush
-// "shebang" script.  These scripts start with the
-// line "#!/usr/bin/env drush" or "#!/full/path/to/drush".
+// script.  These scripts are run with the php-script command.
 //
-drush_print("Hello world!");
-drush_print();
-drush_print("The arguments to this command were:");
+$this->output()->writeln("Hello world!");
+$this->output()->writeln("The extra options/arguments to this command were:");
+$this->output()->writeln(print_r($extra, true));
 
-//
-// If called with --everything, use drush_get_arguments
-// to print the commandline arguments.  Note that this
-// call will include 'php-script' (the drush command)
-// and the path to this script.
-//
-if ($options['everything'])) {
-  drush_print("  " . implode("\n  ", drush_get_arguments()));
-}
-//
-// If --everything is not included, then use
-// drush_shift to pull off the arguments one at
-// a time.  drush_shift only returns the user
-// commandline arguments, and does not include
-// the drush command or the path to this script.
-//
-else {
-  while ($arg = drush_shift()) {
-    drush_print('  ' . $arg);
-  }
-}
 
-drush_print();
 
 //
 // We can check which site was bootstrapped via
 // the '@self' alias, which is defined only if
 // there is a bootstrapped site.
 //
 $self_record = drush_sitealias_get_record('@self');
-if (empty($self_record)) {
-  drush_print('No bootstrapped site.');
+if (empty($self_record['root'])) {
+  $this->output()->writeln('No bootstrapped site.');
 }
 else {
-  drush_print('The following site is bootstrapped:');
-  _drush_sitealias_print_record($self_record);
+  $this->output()->writeln('The following site is bootstrapped:');
+  $this->output()->writeln(print_r($self_record, true));
 }

includes/annotationcommand_adapter.inc

@@ -213,8 +213,12 @@ function annotationcommand_adapter_process_command() {
 
   $args = annotationcommand_adapter_process_args($userArgs, $command['consolidation-arg-defaults']);
 
-  // TODO: Need to determine if $input is interactive, and ensure that $input->isInteractive() returns the correct result.
+  // Determine if $input is interactive, and ensure that $input->isInteractive() returns the correct result.
   $input = new DrushInputAdapter($args, annotationcommand_adapter_get_options($command), $command['command']);
+  $yes = drush_get_context('DRUSH_AFFIRMATIVE');
+  $no = drush_get_context('DRUSH_NEGATIVE');
+  $interactive = (!$yes && !$no);
+  $input->setInteractive($interactive);
   $output = new ConsoleOutput();
   $annotationData = $command['annotations'];
   $commandData = new CommandData(