Fix #1910. Add support for site aliases that point into a Docker container (#3835)

* Add support for site aliases that point into a Docker container

* Update Composer for site-process and site-alias

* Some infra for sql:sync under Docker transport

* Update docs for new namespacing

* Fix typo in docs.

* React to slight change in AliasRecord::isRemote().

* Back out the sql:sync experiment.

* Update composer/scenario files for consolidation releases

Author: weitzman

.scenarios.lock/php5/composer.json

@@ -63,8 +63,8 @@
         "consolidation/filter-via-dot-access-data": "^0.4",
         "consolidation/output-formatters": "^3.3.1",
         "consolidation/robo": "^1.3.4",
-        "consolidation/site-alias": "^1.1.6|^2",
-        "consolidation/site-process": "^0.1.18",
+        "consolidation/site-alias": "^2.1.1",
+        "consolidation/site-process": "^0.1.19",
         "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": "^0.4",
     "consolidation/output-formatters": "^3.3.1",
     "consolidation/robo": "^1.3.4",
-    "consolidation/site-alias": "^1.1.6|^2",
-    "consolidation/site-process": "^0.1.18",
+    "consolidation/site-alias": "^2.1.1",
+    "consolidation/site-process": "^0.1.19",
     "grasmash/yaml-expander": "^1.1.1",
     "league/container": "~2",
     "psr/log": "~1.0",

composer.json

@@ -121,7 +121,7 @@
 
 # Environment variables:
 #
-# It is no longer possible to set environment variables from within an alias.
+# SSH environments may no longer possible set environment variables from within an alias.
 # This is a planned feature.
 
 # Additional Site Alias Options
@@ -130,6 +130,10 @@
 # local or remote Drupal installations; however, an alias
 # is really nothing more than a collection of options.
 #
+# - 'docker': When specified, Drush executes via docker-compose exec rather than ssh
+#    - 'service': the name of the container to run on.
+#    - 'exec':
+#      - 'options': Options for the exec subcommand.
 # - 'os': The operating system of the remote server.  Valid values
 #   are 'Windows' and 'Linux'. Be sure to set this value for all remote
 #   aliases because the default value is PHP_OS if 'remote-host'
@@ -223,6 +227,12 @@
 #
 # @code
 # # File: mysite.site.yml
+# local:
+# This environment is an example of the DockerCompose transport.
+#   docker:
+#     service: drupal
+#     exec:
+#       options: --user USER
 # stage:
 #   uri: http://stage.example.com
 #   root: /path/to/remote/drupal/root

composer.lock

@@ -209,7 +209,7 @@ protected function bootstrapAndFind($name)
             // Is the unknown command destined for a remote site?
             if ($this->aliasManager) {
                 $selfAlias = $this->aliasManager->getSelf();
-                if ($selfAlias->isRemote()) {
+                if (!$selfAlias->isLocal()) {
                     $command = new RemoteCommandProxy($name, $this->redispatchHook);
                     $command->setApplication($this);
                     return $command;

examples/example.site.yml

@@ -37,7 +37,7 @@ public function browse($path = '', array $options = ['browser' => self::REQ, 're
         $aliasRecord = $this->siteAliasManager()->getSelf();
         // Redispatch if called against a remote-host so a browser is started on the
         // the *local* machine.
-        if ($aliasRecord->isRemote()) {
+        if (!$aliasRecord->isLocal()) {
             $process = Drush::drush($aliasRecord, 'browse', [$path], Drush::redispatchOptions());
             $process->mustRun();
             $link = $process->getOutput();

src/Application.php

@@ -39,7 +39,7 @@ public function login($path = '', $options = ['name' => '1', 'browser' => true,
         // Redispatch if called against a remote-host so a browser is started on the
         // the *local* machine.
         $aliasRecord = $this->siteAliasManager()->getSelf();
-        if ($aliasRecord->isRemote()) {
+        if (!$aliasRecord->isLocal()) {
             $process = Drush::drush($aliasRecord, 'user-login', [$path], Drush::redispatchOptions());
             $process->mustRun();
             $link = $process->getOutput();

src/Commands/core/BrowseCommands.php

@@ -109,7 +109,7 @@ public function validate(CommandData $commandData)
 
     public function databaseName(AliasRecord $record)
     {
-        if ($record->isRemote() && Drush::simulate()) {
+        if (!$record->isLocal() && Drush::simulate()) {
             return 'simulated_db';
         }
 

src/Commands/core/LoginCommands.php

@@ -306,7 +306,7 @@ public static function drush(AliasRecord $siteAlias, $command, $args = [], $opti
      */
     public static function drushSiteProcess(AliasRecord $siteAlias, $args = [], $options = [], $options_double_dash = [])
     {
-        $defaultDrushScript = $siteAlias->isRemote() ? 'drush' : static::drushScript();
+        $defaultDrushScript = !$siteAlias->isLocal() ? 'drush' : static::drushScript();
 
         // Fill in the root and URI from the site alias, if the caller
         // did not already provide them in $options.