Fixes #3883: Use SiteAliasWithConfig class (#3957)

Author: greg-1-anderson

.scenarios.lock/php5/composer.json

@@ -63,8 +63,8 @@
         "consolidation/filter-via-dot-access-data": "^1",
         "consolidation/output-formatters": "^3.3.1",
         "consolidation/robo": "^1.4.6",
-        "consolidation/site-alias": "^2.1.1",
-        "consolidation/site-process": "^2.0.0-beta3",
+        "consolidation/site-alias": "^3.0.0-alpha1",
+        "consolidation/site-process": "^2.0.0-beta4",
         "grasmash/yaml-expander": "^1.1.1",
         "league/container": "~2",
         "psr/log": "~1.0",

.scenarios.lock/php5/composer.lock

@@ -39,8 +39,8 @@
     "consolidation/filter-via-dot-access-data": "^1",
     "consolidation/output-formatters": "^3.3.1",
     "consolidation/robo": "^1.4.6",
-    "consolidation/site-alias": "^2.1.1",
-    "consolidation/site-process": "^2.0.0-beta3",
+    "consolidation/site-alias": "^3.0.0-alpha1",
+    "consolidation/site-process": "^2.0.0-beta4",
     "grasmash/yaml-expander": "^1.1.1",
     "league/container": "~2",
     "psr/log": "~1.0",

composer.json

@@ -220,9 +220,8 @@ function drush_which($command) {
  *
  */
 function drush_shell_proc_build(AliasRecord $site, $command = '', $cd = NULL, $interactive = FALSE) {
-  // Build up the command. TODO: We maybe refactor this soon.
   $hostname = $site->remoteHostWithUser();
-  $ssh_options = $site->getConfig(Drush::config(), 'ssh.options', "-o PasswordAuthentication=no");
+  $ssh_options = drush_get_site_alias_config($site, 'ssh.options', "-o PasswordAuthentication=no");
   $os = drush_os($site);
   if ($site->get('tty') || $interactive) {
     $ssh_options .= ' -t';
@@ -287,7 +286,17 @@ function drush_os($site_record = NULL) {
     return legacy_drush_os($site_record);
   }
   // n.b. $options['remote-os'] has become 'ssh.os' in drush.yml
-  return $site_record->getConfig(Drush::config(), 'ssh.os', 'Linux');
+  return drush_get_site_alias_config($site_record, 'ssh.os', 'Linux');
+}
+
+function drush_get_site_alias_config($site_record, $key, $default)
+{
+  $config = Drush::config();
+  $configRuntime = $config->getContext(ConfigOverlay::PROCESS_CONTEXT);
+
+  $siteAliasWithConfig = new SiteAliasWithConfig($configRuntime, $site_record, $config);
+
+  return $siteAliasWithConfig->get($key, $default);
 }
 
 function legacy_drush_os($site_record = NULL) {

composer.lock

@@ -6,7 +6,7 @@
  */
 namespace Drush;
 
-use Consolidation\SiteAlias\AliasRecord;
+use Consolidation\SiteAlias\AliasRecordInterface;
 use Consolidation\SiteAlias\SiteAliasManager;
 use Consolidation\SiteProcess\ProcessBase;
 use Consolidation\SiteProcess\SiteProcess;
@@ -335,14 +335,14 @@ public static function output()
      * Clients that are using Drush::drush(), and need a reference to the alias
      * manager may use Drush::aliasManager().
      *
-     * @param AliasRecord $siteAlias
+     * @param AliasRecordInterface $siteAlias
      * @param string $command
      * @param array $args
      * @param array $options
      * @param array $options_double_dash
      * @return SiteProcess
      */
-    public static function drush(AliasRecord $siteAlias, $command, $args = [], $options = [], $options_double_dash = [])
+    public static function drush(AliasRecordInterface $siteAlias, $command, $args = [], $options = [], $options_double_dash = [])
     {
         $processManager = self::service('process.manager');
         return $processManager->drush($siteAlias, $command, $args, $options, $options_double_dash);
@@ -354,13 +354,13 @@ public static function drush(AliasRecord $siteAlias, $command, $args = [], $opti
      * Use Drush::drush() instead of this method when calling Drush.
      * Tip: Consider using injected process manager instead of this method. @see \Drush\Drush::drush().
      *
-     * @param AliasRecord $siteAlias
+     * @param AliasRecordInterface $siteAlias
      * @param array $args
      * @param array $options
      * @param array $options_double_dash
      * @return ProcessBase
      */
-    public static function siteProcess(AliasRecord $siteAlias, $args = [], $options = [], $options_double_dash = [])
+    public static function siteProcess(AliasRecordInterface $siteAlias, $args = [], $options = [], $options_double_dash = [])
     {
         $processManager = self::service('process.manager');
         return $processManager->siteProcess($siteAlias, $args, $options, $options_double_dash);

includes/exec.inc

@@ -13,6 +13,8 @@
 use League\Container\ContainerInterface;
 use Consolidation\SiteAlias\SiteAliasManager;
 use Drush\Command\DrushCommandInfoAlterer;
+use Consolidation\Config\Util\ConfigOverlay;
+use Drush\Config\DrushConfig;
 
 /**
  * Prepare our Dependency Injection Container
@@ -52,7 +54,7 @@ public function initContainer(
         \Robo\Robo::configureContainer($container, $application, $config, $input, $output);
         $container->add('container', $container);
 
-        $this->addDrushServices($container, $loader, $drupalFinder, $aliasManager);
+        $this->addDrushServices($container, $loader, $drupalFinder, $aliasManager, $config);
 
         // Store the container in the \Drush object
         Drush::setContainer($container);
@@ -77,7 +79,7 @@ public function installHandlers($container)
         }
     }
 
-    protected function addDrushServices(ContainerInterface $container, ClassLoader $loader, DrupalFinder $drupalFinder, SiteAliasManager $aliasManager)
+    protected function addDrushServices(ContainerInterface $container, ClassLoader $loader, DrupalFinder $drupalFinder, SiteAliasManager $aliasManager, DrushConfig $config)
     {
         // Override Robo's logger with our own
         $container->share('logger', 'Drush\Log\Logger')
@@ -87,6 +89,10 @@ protected function addDrushServices(ContainerInterface $container, ClassLoader $
         $container->share('loader', $loader);
         $container->share('site.alias.manager', $aliasManager);
 
+        // Fetch the runtime config, where -D et. al. are stored, and
+        // add a reference to it to the container.
+        $container->share('config.runtime', $config->getContext(ConfigOverlay::PROCESS_CONTEXT));
+
         // Override Robo's formatter manager with our own
         // @todo not sure that we'll use this. Maybe remove it.
         $container->share('formatterManager', \Drush\Formatters\DrushFormatterManager::class)
@@ -107,6 +113,7 @@ protected function addDrushServices(ContainerInterface $container, ClassLoader $
         $container->share('docker-compose.transport', \Consolidation\SiteProcess\Factory\DockerComposeTransportFactory::class);
         $container->share('process.manager', 'Drush\SiteAlias\ProcessManager')
             ->withMethodCall('setConfig', ['config'])
+            ->withMethodCall('setConfigRuntime', ['config.runtime'])
             ->withMethodCall('add', ['ssh.transport'])
             ->withMethodCall('add', ['docker-compose.transport']);
         $container->share('redispatch.hook', 'Drush\Runtime\RedispatchHook')

src/Drush.php

@@ -5,7 +5,7 @@
 
 use Consolidation\SiteProcess\Util\Escape;
 use Psr\Log\LoggerInterface;
-use Consolidation\SiteAlias\AliasRecord;
+use Consolidation\SiteAlias\AliasRecordInterface;
 use Consolidation\SiteProcess\Factory\TransportFactoryInterface;
 use Symfony\Component\Process\Process;
 use Drush\Drush;
@@ -22,14 +22,14 @@ class ProcessManager extends ConsolidationProcessManager
     /**
      * Run a Drush command on a site alias (or @self).
      *
-     * @param AliasRecord $siteAlias
+     * @param AliasRecordInterface $siteAlias
      * @param string $command
      * @param array $args
      * @param array $options
      * @param array $options_double_dash
      * @return SiteProcess
      */
-    public function drush(AliasRecord $siteAlias, $command, $args = [], $options = [], $options_double_dash = [])
+    public function drush(AliasRecordInterface $siteAlias, $command, $args = [], $options = [], $options_double_dash = [])
     {
         array_unshift($args, $command);
         return $this->drushSiteProcess($siteAlias, $args, $options, $options_double_dash);
@@ -40,13 +40,13 @@ public function drush(AliasRecord $siteAlias, $command, $args = [], $options = [
      * drushSiteProcess exists specifically for use by the RedispatchHook,
      * which does not have specific knowledge about which argument is the command.
      *
-     * @param AliasRecord $siteAlias
+     * @param AliasRecordInterface $siteAlias
      * @param array $args
      * @param array $options
      * @param array $options_double_dash
      * @return ProcessBase
      */
-    public function drushSiteProcess(AliasRecord $siteAlias, $args = [], $options = [], $options_double_dash = [])
+    public function drushSiteProcess(AliasRecordInterface $siteAlias, $args = [], $options = [], $options_double_dash = [])
     {
         // Fill in the root and URI from the site alias, if the caller
         // did not already provide them in $options.
@@ -66,7 +66,7 @@ public function drushSiteProcess(AliasRecord $siteAlias, $args = [], $options =
     /**
      * Determine the path to Drush to use
      */
-    public function drushScript(AliasRecord $siteAlias)
+    public function drushScript(AliasRecordInterface $siteAlias)
     {
         $defaultDrushScript = 'drush';
 
@@ -101,7 +101,7 @@ public function drushScript(AliasRecord $siteAlias)
      * Use Drush::drush() or ProcessManager::drush() instead of this method
      * when calling Drush.
      */
-    public function siteProcess(AliasRecord $siteAlias, $args = [], $options = [], $optionsPassedAsArgs = [])
+    public function siteProcess(AliasRecordInterface $siteAlias, $args = [], $options = [], $optionsPassedAsArgs = [])
     {
         $process = parent::siteProcess($siteAlias, $args, $options, $optionsPassedAsArgs);
         return $this->configureProcess($process);