Add Database Connection Helper Command

docs/database.md

@@ -0,0 +1,21 @@
+# Interacting with Database
+
+- You can log into MySQL and run any query in the default database (`wordpress`) by using:
+
+```sh
+composer server db
+```
+
+- Use `composer server info` to retrieve MySQL info, connection details and forwarded ports:
+
+```sh
+Root password:  wordpress
+
+Database:       wordpress
+User:           wordpress
+Password:       wordpress
+
+Version:        5.7.26-1debian9
+Ports:          0.0.0.0:32791
+```
+

inc/composer/class-command.php

@@ -18,7 +18,7 @@ protected function configure() {
 			->setName( 'server' )
 			->setDescription( 'Altis Local Server' )
 			->setDefinition( [
-				new InputArgument( 'subcommand', null, 'start, stop, restart, cli, exec. shell, status. logs.' ),
+				new InputArgument( 'subcommand', null, 'start, stop, restart, cli, exec, shell, status, db, logs.' ),
 				new InputArgument( 'options', InputArgument::IS_ARRAY ),
 			] )
 			->setAliases( [ 'local-server' ] )
@@ -42,6 +42,10 @@ protected function configure() {
 	exec -- <command>             eg: exec -- vendor/bin/phpcs
 Open a shell:
 	shell
+Database commands:
+	db                            Log into MySQL on the Database server
+	db spf                        Generates an SPF file for Sequel Pro
+	db info                       Prints out Database connection details
 View the logs
 	logs <service>                <service> can be php, nginx, db, s3, elasticsearch, xray
 EOT
@@ -68,6 +72,8 @@ protected function execute( InputInterface $input, OutputInterface $output ) {
 			return $this->exec( $input, $output, 'wp' );
 		} elseif ( $subcommand === 'exec' ) {
 			return $this->exec( $input, $output );
+		} elseif ( $subcommand === 'db' ) {
+			return $this->db( $input, $output );
 		} elseif ( $subcommand === 'status' ) {
 			return $this->status( $input, $output );
 		} elseif ( $subcommand === 'logs' ) {
@@ -332,6 +338,63 @@ protected function shell( InputInterface $input, OutputInterface $output ) {
 		return $return_val;
 	}
 
+	protected function db( InputInterface $input, OutputInterface $output ) {
+		$db = $input->getArgument( 'options' )[0] ?? '';
+		$columns = exec( 'tput cols' );
+		$lines = exec( 'tput lines' );
+
+		$base_command_prefix = sprintf(
+			'cd %s; VOLUME=%s COMPOSE_PROJECT_NAME=%s',
+			'vendor/altis/local-server/docker',
+			escapeshellarg( getcwd() ),
+			$this->get_project_subdomain()
+		);
+
+		$base_command = sprintf(
+			"$base_command_prefix docker-compose exec -e COLUMNS=%d -e LINES=%d db",
+			$columns,
+			$lines
+		);
+
+		switch ( $db ) {
+			case 'info':
+				// Env variables
+				$env_variables = explode( PHP_EOL, shell_exec( "$base_command printenv" ) );
+				$values = array_reduce( $env_variables, function( $values, $env_variable_text ) {
+					$env_variable = explode( '=', $env_variable_text );
+					$values[ $env_variable[0] ] = $env_variable[1] ?? '';
+					return $values;
+				}, [] );
+
+				// Ports
+
+				// Find the container ID with Docker Compose
+				$db_container_id = shell_exec( "$base_command_prefix docker-compose ps -q db" );
+
+				// Retrrieve the forwarded ports using Docker and the container ID
+				$ports = shell_exec( sprintf( "$base_command_prefix docker ps --format '{{.Ports}}' --filter id=%s", $db_container_id ) );
+				preg_match( '/.*,\s([\d.]+:[\d]+)->.*/', $ports, $ports_matches );
+
+				$db_info = <<<EOT
+<info>Root password</info>:  ${values['MYSQL_ROOT_PASSWORD']}
+
+<info>Database</info>:       ${values['MYSQL_PASSWORD']}
+<info>User</info>:           ${values['MYSQL_USER']}
+<info>Password</info>:       ${values['MYSQL_PASSWORD']}
+
+<comment>Version</comment>:        ${values['MYSQL_VERSION']}
+<comment>Ports</comment>:          ${ports_matches[1]}
+EOT;
+				echo $output->write( $db_info ) . PHP_EOL;
+				$return_val = 0;
+				break;
+			default:
+				passthru( "$base_command mysql --database=wordpress --user=root -pwordpress", $return_val );
+		}
+
+		return $return_val;
+	}
+
 	/**
 	 * Get the name of the project for the local subdomain
 	 *