Fix ##1371. Move drush_program_exists() to ExecTrait (#3801)

weitzman · web-flow · commit ba58c00ee59e · 2018-11-25T20:45:50.000-05:00
* Move drush_program_exists() to ExecTrait

Use it in sql:* and config:export

* CS.

* Use string version of command - it avoids an inexplicable test fail.
diff --git a/includes/filesystem.inc b/includes/filesystem.inc
@@ -212,6 +212,9 @@ function drush_mkdir($path) {
  * Determine if program exists on user's PATH.
  *
  * @return bool|null
+ *
+ * @deprecated
+ *   See \Drush\Exec\ExecTrait::programExists.
  */
 function drush_program_exists($program) {
   if (drush_has_bash()) {
@@ -220,7 +223,7 @@ function drush_program_exists($program) {
     // Remove environment variables (eg. PGPASSFILE=) before testing program.
     $program = preg_replace('#^([A-Z0-9]+=.+? )+#', '', $program);
 
-    // Dont't use drush_op_system() since we don't want output during tests.
+    // Don't use drush_op_system() since we don't want output during tests.
     system("command -v $program > $bucket 2>&1", $result_code);
     return $result_code === 0 ? TRUE : FALSE;
   }
diff --git a/src/Commands/sql/SqlCommands.php b/src/Commands/sql/SqlCommands.php
@@ -1,18 +1,21 @@
 <?php
 namespace Drush\Commands\sql;
 
+use Consolidation\AnnotatedCommand\CommandData;
 use Drupal\Core\Database\Database;
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Drush\Exceptions\UserAbortException;
+use Drush\Exec\ExecTrait;
 use Drush\Sql\SqlBase;
 use Consolidation\OutputFormatters\StructuredData\PropertyList;
 
 class SqlCommands extends DrushCommands
 {
+    use ExecTrait;
 
     /**
-     * Print database connection details using print_r().
+     * Print database connection details.
      *
      * @command sql:conf
      * @aliases sql-conf
@@ -229,4 +232,32 @@ public function dump($options = ['result-file' => self::REQ, 'create-db' => fals
         }
         return new PropertyList(['path' => $return]);
     }
+
+    /**
+     * Assert that `mysql` or similar are on the user's PATH.
+     *
+     * @hook validate
+     * @param CommandData $commandData
+     * @return bool
+     * @throws \Exception
+     */
+    public function validate(CommandData $commandData)
+    {
+        if (in_array($commandData->annotationData()->get('command'), ['sql:connect', 'sql:conf'])) {
+            // These commands don't require a program.
+            return;
+        }
+
+        $sql = SqlBase::create($commandData->options());
+        $program = $sql->command();
+
+        // Remove environment variables (eg. PGPASSFILE=) before testing program.
+        // @todo Remove once postgres is passing env variables via Process.
+        $program = preg_replace('#^([A-Z0-9]+=.+? )+#', '', $program);
+
+        if (!$this->programExists($program)) {
+            $this->logger->warning(dt('The shell command \'!command\' is required but cannot be found. Please install it and retry.', ['!command' => $program]));
+            return false;
+        }
+    }
 }
diff --git a/src/Drupal/Commands/config/ConfigCommands.php b/src/Drupal/Commands/config/ConfigCommands.php
@@ -11,6 +11,7 @@
 use Drupal\Core\Config\StorageInterface;
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
+use Drush\Exec\ExecTrait;
 use Drush\Utils\FsUtils;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\InputInterface;
@@ -21,6 +22,7 @@
 
 class ConfigCommands extends DrushCommands
 {
+    use ExecTrait;
 
     /**
      * @var ConfigFactoryInterface
@@ -507,12 +509,13 @@ public static function getDiff(StorageInterface $destination_storage, StorageInt
         $temp_source_storage = new FileStorage($temp_source_dir);
         self::copyConfig($source_storage, $temp_source_storage);
 
-        $prefix = 'diff';
-        if (drush_program_exists('git') && $output->isDecorated()) {
-            $prefix = 'git diff --color=always';
+        $prefix = ['diff'];
+        if (self::programExists('git') && $output->isDecorated()) {
+            $prefix = ['git', 'diff', '--color=always'];
         }
-        $args = [$prefix, '-u', $temp_destination_dir, $temp_source_dir];
+        $args = array_merge($prefix, ['-u', $temp_destination_dir, $temp_source_dir]);
         $process = Drush::process($args);
-        return drush_shell_exec_output();
+        $process->run();
+        return $process->getOutput();
     }
 }
diff --git a/src/Drupal/Commands/config/ConfigImportCommands.php b/src/Drupal/Commands/config/ConfigImportCommands.php
@@ -17,6 +17,7 @@
 use Drupal\Core\Lock\LockBackendInterface;
 use Drupal\Core\StringTranslation\TranslationInterface;
 use Drush\Commands\DrushCommands;
+use Drush\Exceptions\UserAbortException;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Webmozart\PathUtil\Path;
 
@@ -201,12 +202,13 @@ public function import($label = null, $options = ['preview' => 'list', 'source'
         } else {
             $output = ConfigCommands::getDiff($active_storage, $source_storage, $this->output());
 
-            $this->output()->writeln(implode("\n", $output));
+            $this->output()->writeln($output);
         }
 
-        if ($this->io()->confirm(dt('Import the listed configuration changes?'))) {
-            return drush_op([$this, 'doImport'], $storage_comparer);
+        if (!$this->io()->confirm(dt('Import the listed configuration changes?'))) {
+            throw new UserAbortException();
         }
+        return drush_op([$this, 'doImport'], $storage_comparer);
     }
 
     // Copied from submitForm() at /core/modules/config/src/Form/ConfigSync.php
diff --git a/src/Exec/ExecTrait.php b/src/Exec/ExecTrait.php
@@ -62,7 +62,7 @@ public function startBrowser($uri = null, $sleep = false, $port = false, $browse
             }
 
             if ($browser) {
-                drush_log(dt('Opening browser !browser at !uri', ['!browser' => $browser, '!uri' => $uri]), LogLevel::INFO);
+                $this->logger()->info(dt('Opening browser !browser at !uri', ['!browser' => $browser, '!uri' => $uri]));
                 $args = [];
                 if (!Drush::simulate()) {
                     if ($sleep) {
@@ -78,4 +78,17 @@ public function startBrowser($uri = null, $sleep = false, $port = false, $browse
         }
         return false;
     }
+
+    /*
+     * Determine if program exists on user's PATH.
+     *
+     * @return bool
+     *   True if program exists on PATH.
+     */
+    public static function programExists($program)
+    {
+        $process = Drush::process("command -v $program");
+        $process->run();
+        return $process->isSuccessful();
+    }
 }
