Add an 'ssh.tty' option to site aliased. (#3648)

* Add an 'ssh.tty' option to site aliased.

Usually Drush decides whether or not to create a tty for remote ssh commands based on whether the current Drush command is running in interactive mode or not. When in interactive mode, a tty is created; otherwise, no tty is created.

Sometimes, a remote server will not grant the ssh user the permission to create a tty. In this instance, it is possible to force Drush to never create a tty via this new option.

* Allow ssh.tty to override interactive mode regardless of whether interactive is true or false.

Author: greg-1-anderson

examples/example.site.yml

@@ -135,11 +135,14 @@
 #   if you set a 'remote-host' value, and your remote OS is Windows, if you
 #   do not set the 'OS' value, it will default to 'Linux' and could cause
 #   unintended consequences, particularly when running 'drush sql-sync'.
-# - 'ssh': If the target requires special options, such as a non-
-#   standard port, alternative identity file, or alternative
-#   authentication method, the `option` entry under the `ssh` item may
-#   contain a string of extra options that are used with the ssh command,
-#   e.g. "-p 100"
+# - 'ssh': Contains settings used to control how ssh commands are generated
+#   when running remote commands.
+#   - 'options': Contains additional commandline options for the ssh command
+#   itself, e.g. "-p 100"
+#   - 'tty': Usually, Drush will decide whether or not to create a tty (via
+#   the ssh '--t' option) based on whether the local Drush command is running
+#   interactively or not. To force Drush to always or never create a tty,
+#   set the 'ssh.tty' option to 'true' or 'false', respectively.
 # - 'paths': An array of aliases for common rsync targets.
 #   Relative aliases are always taken from the Drupal root.
 #   - 'files': Path to 'files' directory.  This will be looked up if not

src/Runtime/RedispatchHook.php

@@ -94,8 +94,8 @@ public function redispatch(InputInterface $input)
             'additional-global-options' => [],
             'interactive' => true,
         ];
+        $backend_options['#tty'] = $this->getConfig()->get('ssh.tty', $input->isInteractive());
         if ($input->isInteractive()) {
-            $backend_options['#tty'] = true;
             $backend_options['interactive'] = true;
         }