Deprecate backend.inc in favor of a new site-process library (#3758)

Also bringing in #3759 which was merged into this PR.

Author: weitzman

.circleci/config.yml

@@ -59,4 +59,3 @@ workflows:
       - build
       - build_highest
       - build_56
-

.travis.yml

@@ -20,15 +20,11 @@ sudo: false
 matrix:
   include:
     - php: 7.2
-      env: 'SCENARIO=isolation DEPENDENCIES=highest'
+      env: 'DEPENDENCIES=highest'
     - php: 7.2
-      env: 'SCENARIO=isolation'
     - php: 7.0.11
-      env: 'SCENARIO=isolation'
     - php: 5.6
-      env: 'SCENARIO=isolation-phpunit4 DEPENDENCIES=lowest'
-    - php: 5.6
-      env: 'SCENARIO=isolation-phpunit4 DEPENDENCIES=lowest'
+      env: 'DEPENDENCIES=lowest'
 
 env:
   global:
@@ -62,5 +58,3 @@ after_success:
   - git config --global user.email $GITHUB_USER_EMAIL
   - git config --global user.name "Drush Documentation Bot"
   - cd $TRAVIS_BUILD_DIR && build/scripts/publish-api-docs.sh
-  # Background: https://github.com/drush-ops/drush/pull/1426
-  #- ${PWD}/tests/testChildren.sh

composer.json

@@ -39,7 +39,8 @@
     "consolidation/filter-via-dot-access-data": "^0.4",
     "consolidation/output-formatters": "^3.3.1",
     "consolidation/robo": "^1.1.5",
-    "consolidation/site-alias": "^1.1.5",
+    "consolidation/site-alias": "^1.1.6|^2",
+    "consolidation/site-process": "^0.1.13",
     "grasmash/yaml-expander": "^1.1.1",
     "league/container": "~2",
     "psr/log": "~1.0",
@@ -70,13 +71,12 @@
   "autoload": {
     "psr-4": {
       "Drush\\":            "src/",
-      "Drush\\Internal\\":  "internal-copy/",
-      "Unish\\":            "tests/"
+      "Drush\\Internal\\":  "src/internal-forks"
     }
   },
   "autoload-dev": {
     "psr-4": {
-      "Drush\\": "isolation/src/"
+      "Unish\\": "tests/unish"
     },
     "files": ["tests/load.environment.php"]
   },
@@ -107,12 +107,11 @@
     "sami-install": "mkdir -p $HOME/bin && curl --output $HOME/bin/sami.phar http://get.sensiolabs.org/sami.phar && chmod +x $HOME/bin/sami.phar",
     "scenario": "scenarios/install",
     "sut": "./drush --uri=dev",
-    "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=mysql://root:password@mariadb/unish_dev -v",
-    "unit": "phpunit --colors=always",
-    "functional": "phpunit --colors=always --configuration tests",
+    "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/unit",
+    "functional": "phpunit --colors=always --configuration tests/functional",
     "post-update-cmd": [
-        "create-scenario isolation --autoload-dir isolation --autoload-dir internal-copy --keep '\\(psr/log\\|consolidation/config\\|site-alias\\|var-dumper\\|symfony/finder\\|drupal-finder\\|path-util\\|vlucas/phpdotenv\\|xhprof\\)' 'phpunit/phpunit:^5.5.4'",
-        "create-scenario isolation-phpunit4 --base isolation --autoload-dir isolation --autoload-dir internal-copy 'phpunit/phpunit:^4.8.36'"
+        "create-scenario phpunit4 --autoload-dir internal-copy 'phpunit/phpunit:^4.8.36'"
     ]
   },
   "extra": {

examples/Commands/SyncViaHttpCommands.php

@@ -60,23 +60,28 @@ protected function downloadFile($url, $user = false, $password = false, $destina
     {
         static $use_wget;
         if ($use_wget === null) {
-            $use_wget = drush_shell_exec('which wget');
+            $use_wget = drush_which('wget');
         }
 
         $destination_tmp = drush_tempnam('download_file');
         if ($use_wget) {
+            $args = ['wget', '-q', '--timeout=30'];
             if ($user && $password) {
-                drush_shell_exec("wget -q --timeout=30 --user=%s --password=%s -O %s %s", $user, $password, $destination_tmp, $url);
+                $args = array_merge($args, ["--user=$user", "--password=$password", '-O', $destination_tmp, $url]);
             } else {
-                drush_shell_exec("wget -q --timeout=30 -O %s %s", $destination_tmp, $url);
+                $args = array_merge($args, ['-O', $destination_tmp, $url]);
             }
         } else {
+            $args = ['curl', '-s', '-L', '--connect-timeout 30'];
             if ($user && $password) {
-                drush_shell_exec("curl -s -L --connect-timeout 30 --user %s:%s -o %s %s", $user, $password, $destination_tmp, $url);
+                $args = array_merge($args, ['--user', "$user:$password", '-o', $destination_tmp, $url]);
             } else {
-                drush_shell_exec("curl -s -L --connect-timeout 30 -o %s %s", $destination_tmp, $url);
+                $args = array_merge($args, ['-o', $destination_tmp, $url]);
             }
         }
+        $process = Drush::process($args);
+        $process->mustRun();
+
         if (!Drush::simulate()) {
             if (!drush_file_not_empty($destination_tmp) && $file = @file_get_contents($url)) {
                 @file_put_contents($destination_tmp, $file);

examples/helloworld.script

@@ -18,7 +18,7 @@ $this->output()->writeln(print_r($extra, true));
 // there is a bootstrapped site.
 //
 $self = Drush::aliasManager()->getSelf();;
-if (empty($self->root())) {
+if (!$self->hasRoot()) {
   $this->output()->writeln('No bootstrapped site.');
 }
 else {

includes/backend.inc

@@ -622,7 +622,7 @@ function _drush_backend_adjust_options($site_record, $command, $command_options,
  * Execute a new local or remote command in a new process.
  *
  * @deprecated as of Drush 9.4.0 and will be removed in Drush 10. Instead, use
- *   drush_invoke_process().
+ *   Drush::drush().
  *
  * @param invocations
  *   An array of command records to execute. Each record should contain:

includes/batch.inc

@@ -24,6 +24,7 @@
  * implementations.
  */
 
+use Drush\Drush;
 use Drush\Log\LogLevel;
 
 /**
@@ -89,6 +90,9 @@ function drush_backend_batch_process($command = 'batch-process', $args = [], $op
  *
  * @param int $id
  *   The batch ID of the batch being processed.
+ *
+ * @return bool|array
+ *   A results array.
  */
 function drush_batch_command($id) {
   include_once(DRUSH_DRUPAL_CORE . '/includes/batch.inc');
@@ -104,6 +108,9 @@ function drush_batch_command($id) {
  * @param command
  *    The command to call to process the batch.
  *
+ * @return array
+ *   A return array. The callers only care about the finished marker and an #abort on an operation.
+ *
  */
 function _drush_backend_batch_process($command = 'batch-process', $args, $options) {
   $result = NULL;
@@ -141,8 +148,11 @@ function _drush_backend_batch_process($command = 'batch-process', $args, $option
     $finished = FALSE;
 
     while (!$finished) {
-      $result = drush_invoke_process('@self', $command, $args);
-      $finished = drush_get_error() || !$result || (isset($result['context']['drush_batch_process_finished']) && $result['context']['drush_batch_process_finished'] == TRUE);
+      $process = Drush::drush(Drush::aliasManager()->getSelf(), $command, $args);
+      // Suppress printing stdout since we return a JSON array to the caller there.
+      $process->run($process->showRealtime()->hideStdout());
+      $result = $process->getOutputAsJson();
+      $finished = drush_get_error() || !$process->isSuccessful() || (isset($result['drush_batch_process_finished']) && $result['drush_batch_process_finished'] === TRUE);
     }
   }
 
@@ -158,6 +168,9 @@ function _drush_backend_batch_process($command = 'batch-process', $args, $option
  *
  * @param id
  *   The batch id of the batch being processed.
+ *
+ * @return bool|array
+ *   A results array.
  */
 function _drush_batch_command($id) {
   $batch =& batch_get();
@@ -234,7 +247,7 @@ function _drush_batch_worker() {
       \Drush\Drush::config()->set('runtime.php.halt-on-error', FALSE);
       $message = call_user_func_array($function, array_merge($args, [&$batch_context]));
       if (!empty($message)) {
-        drush_print(strip_tags($message), 2);
+        Drush::logger()->notice($message);
       }
       \Drush\Drush::config()->set('runtime.php.halt-on-error', $halt_on_error);
 
@@ -302,6 +315,8 @@ function _drush_batch_worker() {
  * End the batch processing:
  * Call the 'finished' callbacks to allow custom handling of results,
  * and resolve page redirection.
+ *
+ * @return array
  */
 function _drush_batch_finished() {
   $results = [];
@@ -319,7 +334,7 @@ function _drush_batch_finished() {
         $queue = _batch_queue($batch_set);
         $operations = $queue->getAllItems();
         $elapsed = $batch_set['elapsed'] / 1000;
-        $elapsed = drush_drupal_major_version() >=8 ? \Drupal::service('date.formatter')->formatInterval($elapsed) : format_interval($elapsed);
+        $elapsed = \Drupal::service('date.formatter')->formatInterval($elapsed);
         call_user_func_array($batch_set['finished'], [$batch_set['success'], $batch_set['results'], $operations, $elapsed]);
         $results[$id] = $batch_set['results'];
       }
@@ -346,6 +361,7 @@ function _drush_batch_finished() {
   $_batch = $batch;
   $batch = NULL;
   drush_set_option('drush_batch_process_finished', TRUE);
+  $results['drush_batch_process_finished'] = TRUE;
 
   return $results;
 }

includes/command.inc

@@ -64,7 +64,9 @@ use Symfony\Component\Console\Output\ConsoleOutput;
  *   @see drush_backend_get_result()
  *
  * Do not change the signature of this function!  drush_invoke_process
- * is one of the key Drush APIs.  See http://drupal.org/node/1152908
+ * was one of the key Drush APIs.  See http://drupal.org/node/1152908
+ *
+ * @deprecated See Drush::drush().
  */
 function drush_invoke_process($site_alias_record, $command_name, $commandline_args = [], $commandline_options = [], $backend_options = TRUE) {
   if ($site_alias_record instanceof AliasRecord) {

includes/context.inc

@@ -528,4 +528,4 @@ function drush_unset_option($option, $context = NULL) {
       drush_unset_option($option, $context);
     }
   }
-}
+}

includes/drupal.inc

@@ -30,8 +30,12 @@ function drush_drupal_version($drupal_root = NULL) {
   return $version;
 }
 
+/**
+ * @deprecated @see Drush::drush()
+ */
 function drush_drupal_cache_clear_all() {
-  drush_invoke_process('@self', 'cache-rebuild');
+    $process = Drush::drush(Drush::aliasManager()->getSelf(), 'cache-rebuild');
+    $process->mustrun();
 }
 
 /**