Issue with MySecureShell: SSH command fails due to incompatible -l option

[smartfire-tech]

Description

When using Deployer with MySecureShell, the dep ssh command fails due to an unknown option -l. MySecureShell does not support the -l option used by Deployer to initiate a login shell, resulting in the following error message:

--- UNKNOW OPTION: -l ---

Build:
        MySecureShell is version 2.0 build on Jul 29 2019
Usage:
        /usr/bin/mysecureshell [verbose] [options]

Options:
        --configtest : test the config file and show errors
        --help       : show this screen
        --version    : show version of MySecureShell

Verbose:
        -v           : add a level at verbose mode
Connection to wordpress-xxx.cloudwaysapps.com closed.

Steps to reproduce

• Set up a host using Deployer with MySecureShell.
• Run the dep ssh command.
• The command fails with the error above.

Workaround

I was able to resolve the issue by manually setting the shell_path to /bin/bash in the deploy.php configuration file like so:

host('production')
    ->set('hostname', 'your-hostname')
    ->set('remote_user', 'your-user')
    ->set('identity_file', '~/.ssh/your-key')
    ->set('shell_path', '/bin/bash');  // This avoids using the -l option

Proposed solution

Deployer should allow more flexibility in the way it handles shell initialization. Instead of forcing the -l option in the SshCommand.php class, it could provide a better fallback for environments that do not support this option. Here are two potential solutions:

1. Add a method to set the shell path in a more intuitive way:

Introduce a method like setShellPath in the Host class to allow easy customization of the shell path:

public function setShellPath(string $path): self
{
    $this->config->set('shell_path', $path);
    return $this;
}

This method could be used directly in the deploy.php configuration:

host('production')
    ->setHostname('your-hostname')
    ->setRemoteUser('your-user')
    ->setIdentityFile('~/.ssh/your-key')
    ->setShellPath('/bin/bash');

2. Provide a fallback to detect incompatible environments:

Another alternative would be to detect incompatible environments (like MySecureShell) and automatically skip the -l option, falling back to a simpler shell invocation that doesn't rely on a login shell, or provide a configuration flag to disable the -l option for specific environments.

Environment:

Deployer version: 7.4.0
MySecureShell version: 2.0 (build on Jul 29 2019)
PHP version: 8.3.10
Server: Cloudways

[smartfire-tech]

#3942