Skip to content

Add support for docker-compose run to the ssh option #5637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schlessera merged 7 commits into from
Oct 12, 2022
Merged

Add support for docker-compose run to the ssh option #5637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
205bde2
Introduce a `docker-compose-run` scheme for the ssh flag.
johnbillion May 5, 2022
596055c
Tests for ssh config parsing.
johnbillion May 5, 2022
31b8232
Docs.
johnbillion May 5, 2022
10de3a2
Merge branch 'master' into docker-run
johnbillion Jul 9, 2022
6a00a41
Coding standards.
johnbillion Jul 9, 2022
d3e5cc6
Merge branch 'master' into docker-run
johnbillion Aug 16, 2022
a648099
Coding standards.
johnbillion Aug 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions php/WP_CLI/Runner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ private function run_command_and_exit( $help_exit_warning = '' ) {

/**
* Perform a command against a remote server over SSH (or a container using
* scheme of "docker" or "docker-compose").
* scheme of "docker", "docker-compose", or "docker-compose-run").
*
* @param string $connection_string Passed connection string.
* @return void
Expand Down Expand Up @@ -512,7 +512,12 @@ private function run_ssh_command( $connection_string ) {
}
}

$wp_command = $pre_cmd . $env_vars . $wp_binary . ' ' . implode( ' ', array_map( 'escapeshellarg', $wp_args ) );
$wp_command = $pre_cmd . $env_vars . $wp_binary . ' ' . implode( ' ', array_map( 'escapeshellarg', $wp_args ) );

if ( isset( $bits['scheme'] ) && 'docker-compose-run' === $bits['scheme'] ) {
$wp_command = implode( ' ', $wp_args );
}

$escaped_command = $this->generate_ssh_command( $bits, $wp_command );

passthru( $escaped_command, $exit_code );
Expand Down Expand Up @@ -568,6 +573,18 @@ private function generate_ssh_command( $bits, $wp_command ) {
);
}

if ( 'docker-compose-run' === $bits['scheme'] ) {
$command = 'docker-compose run %s%s%s %s';

$escaped_command = sprintf(
$command,
$bits['user'] ? '--user ' . escapeshellarg( $bits['user'] ) . ' ' : '',
$is_tty ? '' : '-T ',
escapeshellarg( $bits['host'] ),
$wp_command
);
}

// Vagrant ssh-config.
if ( 'vagrant' === $bits['scheme'] ) {
$cache = WP_CLI::get_cache();
Expand Down
2 changes: 1 addition & 1 deletion php/config-spec.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
'ssh' => [
'runtime' => '=[<scheme>:][<user>@]<host|container>[:<port>][<path>]',
'file' => '[<scheme>:][<user>@]<host|container>[:<port>][<path>]',
'desc' => 'Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant").',
'desc' => 'Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant").',
],

'http' => [
Expand Down
2 changes: 1 addition & 1 deletion php/utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1059,7 +1059,7 @@ function get_temp_dir() {
* @return mixed
*/
function parse_ssh_url( $url, $component = -1 ) {
preg_match( '#^((docker|docker\-compose|ssh|vagrant):)?(([^@:]+)@)?([^:/~]+)(:([\d]*))?((/|~)(.+))?$#', $url, $matches );
preg_match( '#^((docker|docker\-compose|docker\-compose\-run|ssh|vagrant):)?(([^@:]+)@)?([^:/~]+)(:([\d]*))?((/|~)(.+))?$#', $url, $matches );
$bits = [];
foreach ( [
2 => 'scheme',
Expand Down
15 changes: 15 additions & 0 deletions tests/test-utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,21 @@ public function testParseSSHUrl() {
$this->assertEquals( null, Utils\parse_ssh_url( $testcase, PHP_URL_PORT ) );
$this->assertEquals( '~/path/to/dir', Utils\parse_ssh_url( $testcase, PHP_URL_PATH ) );

// container scheme with user, host, and path
$testcase = 'docker-compose-run:bar@wordpress:~/path/to/dir';
$expected = [
'scheme' => 'docker-compose-run',
'user' => 'bar',
'host' => 'wordpress',
'path' => '~/path/to/dir',
];
$this->assertEquals( $expected, Utils\parse_ssh_url( $testcase ) );
$this->assertEquals( 'docker-compose-run', Utils\parse_ssh_url( $testcase, PHP_URL_SCHEME ) );
$this->assertEquals( 'bar', Utils\parse_ssh_url( $testcase, PHP_URL_USER ) );
$this->assertEquals( 'wordpress', Utils\parse_ssh_url( $testcase, PHP_URL_HOST ) );
$this->assertEquals( null, Utils\parse_ssh_url( $testcase, PHP_URL_PORT ) );
$this->assertEquals( '~/path/to/dir', Utils\parse_ssh_url( $testcase, PHP_URL_PATH ) );

// vagrant scheme
$testcase = 'vagrant:default';
$expected = [
Expand Down