Merge pull request #1700 from mrrobot47/global/compose-exec

Add helper function for skip-tty support

Author: mrrobot47

php/class-ee-docker.php

@@ -183,7 +183,7 @@ public static function disconnect_site_network_from( $site_name, $from_container
 	 * @return bool success.
 	 */
 	public static function docker_compose_up( $dir, $services = [] ) {
-		$fs                = new Filesystem();
+
 		$chdir_return_code = chdir( $dir );
 		if ( $chdir_return_code ) {
 			if ( empty( $services ) ) {
@@ -198,6 +198,51 @@ public static function docker_compose_up( $dir, $services = [] ) {
 		return false;
 	}
 
+	/**
+	 * Function to exec and run commands into the containers.
+	 *
+	 * @param string $command        Command to exec.
+	 * @param string $service        Service to exec command into.
+	 * @param string $shell          Shell in which exec command will be executed.
+	 * @param string $user           User to execute command into.
+	 * @param String $dir            Path to docker-compose.yml.
+	 * @param bool   $shell_wrapper  If shell wrapper should be enabled or not.
+	 * @param bool   $exit_on_error  To exit or not on error.
+	 * @param array  $exec_obfuscate Data to be obfuscated from log.
+	 * @param bool   $echo_stdout    Output stdout of exec if true.
+	 * @param bool   $echo_stderr    Output stderr of exec if true.
+	 *
+	 * @return bool success.
+	 */
+	public static function docker_compose_exec( $command = '', $service = '', $shell = 'sh', $user = '', $dir = '', $shell_wrapper = false, $exit_on_error = false, $exec_obfuscate = [], $echo_stdout = false, $echo_stderr = false ) {
+
+		if ( ! empty( $dir ) ) {
+			$chdir_return_code = chdir( $dir );
+		} else {
+			$chdir_return_code = true;
+		}
+
+		$skip_tty = \EE::get_runner()->config['skip-tty'];
+		$tty      = empty( $skip_tty ) ? '' : '-T';
+
+		if ( $chdir_return_code ) {
+
+			$user_string = '';
+			if ( $user ) {
+				$user_string = empty( $user ) ? '' : "--user='$user'";
+			}
+
+			if ( $shell_wrapper ) {
+				return EE::exec( \EE_DOCKER::docker_compose_with_custom() . " exec $tty $user_string $service $shell -c \"$command\"", $echo_stdout, $echo_stderr, $exec_obfuscate, $exit_on_error );
+			} else {
+				return EE::exec( \EE_DOCKER::docker_compose_with_custom() . " exec $tty $user_string $service $command", $echo_stdout, $echo_stderr, $exec_obfuscate, $exit_on_error );
+			}
+
+		}
+
+		return false;
+	}
+
 	/**
 	 * Function to check if a network exists
 	 *

php/config-spec.php

@@ -52,6 +52,13 @@
 		'desc' => 'Whether to add sysctl config in docker-compose.',
 	),
 
+	'skip-tty' => array(
+		'runtime' => '=<true/false>',
+		'file' => '<bool>',
+		'default' => false,
+		'desc' => 'Skip tty allocation for remote command execution.',
+	),
+
 	'ee_installer_version' => array(
 		'file' => '<path>',
 		'default' => null,