Add docker compose, php, shell, mysql, and redis commands.

Author: hadefication

composer.json

@@ -21,7 +21,8 @@
         "league/flysystem": "^3.0",
         "symfony/console": "^6.2",
         "symfony/finder": "^6.2",
-        "symfony/process": "^6.2"
+        "symfony/process": "^6.2",
+        "vlucas/phpdotenv": "^5.5"
     },
     "require-dev": {
         "mockery/mockery": "^1.5.1",

devstack

@@ -13,6 +13,7 @@ use Webteractive\Devstack\Commands\InitStack;
 use Webteractive\Devstack\RegisterDockerComposeCommands;
 use Webteractive\Devstack\Commands\DownloadRuntimes;
 use Webteractive\Devstack\Commands\MySql;
+use Webteractive\Devstack\Commands\Redis;
 use Webteractive\Devstack\Commands\RunComposerCommands;
 use Webteractive\Devstack\Commands\RunLaravelArtisanCommand;
 use Webteractive\Devstack\Commands\RunPHPCommand;
@@ -28,6 +29,7 @@ $app->add(new RunPHPCommand);
 $app->add(new RunComposerCommands);
 $app->add(new Shell);
 $app->add(new MySql);
+$app->add(new Redis);
 
 RegisterDockerComposeCommands::register($app);
 

src/Commands/Base.php

@@ -2,6 +2,7 @@
 
 namespace Webteractive\Devstack\Commands;
 
+use Dotenv\Dotenv;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -27,7 +28,7 @@ abstract class Base extends Command
     protected OutputInterface $output;
 
     public function __construct()
-    {
+    {   
         if (isset($this->signature)) {
             $this->setup();
         } else {
@@ -129,6 +130,11 @@ public function line($message = '')
         return $this;
     }
 
+    public function lineBreak()
+    {
+        return $this->line('');
+    }
+
     public function info($message = '')
     {
         $this->output->writeln(empty($message) ? '' : "<info>{$message}</info>");

src/Commands/MySql.php

@@ -2,28 +2,81 @@
 
 namespace Webteractive\Devstack\Commands;
 
+use Dotenv\Dotenv;
+use Webteractive\Devstack\Env;
 use Webteractive\Devstack\Process;
+use Webteractive\Devstack\WithEnv;
 use Webteractive\Devstack\WithSignalHandlers;
+use Webteractive\Devstack\WithStorage;
 
 class MySql extends Base
 {
-    use WithSignalHandlers;
+    use WithSignalHandlers,
+        WithEnv;
 
     protected $signature = 'mysql
-                            {--p|password=password : The password to use.}
-                            {--u|user=user : The user to use.}
-                            {--db|database= : The database to use.}';
+                            {--p|password= : The password to use.}
+                            {--u|user= : The user to use.}
+                            {--db|database= : The database to use.}
+                            {--env= : The path to the .env file. Default\'s to the current working directory.}';
     protected $description = 'Start a MySQL CLI session within the <comment>mysql</comment> container.';
 
     public function handle(): int
     {
-        $password = $this->output->
+        $defaults = [
+            'password' => 'password',
+            'user' => 'user',
+            'database' => null,
+        ];
+        $envPath = $this->input->getOption('env') ?? getcwd();
+        if (file_exists($envPath . '/.env')) {
+            $env = new Env($envPath);
+            $defaults['password'] = $env->get('DB_PASSWORD');
+            $defaults['user'] = $env->get('DB_USERNAME');
+            $defaults['database'] = $env->get('DB_DATABASE');
+            $this->lineBreak();
+            $this->line('Found an <comment>.env</comment> file in your current working directory, values will now be used as defaults.');
+            $this->lineBreak();
+        } else {
+            $this->lineBreak();
+            $this->line('Unable to find an <comment>.env</comment> file in your current working directory, now using the defaults.');
+            $this->line('If these were changed in your <comment>docker-compose.yml</comment> file, please supply it as a command');
+            $this->line('flag or add an <comment>.env</comment> file and add it there.');
+            
+            $this->lineBreak();
+            $this->line('If you want to use the .env route, create a .env file and add the variables below including the values:');
+            $this->line('DB_USERNAME=');
+            $this->line('DB_PASSWORD=');
+            $this->line('DB_DATABASE=');
+            $this->lineBreak();
+            $this->line('If your .env is located somewhere else, you may use the <comment>--env=/path/to/your/.env</comment> flag.');
+            $this->line('For example, <comment>devstack mysql --env=/path/to/your/.env/directory</comment>.');
+            $this->lineBreak();
+            $this->line('Finally for the command flag, just do <comment>devstack mysql --user=the_user --password=the_password --database=the_db</comment>.');
+            $this->line('For more details on the <comment>devsack mysql</comment> command flags, run <comment>devstack help mysql</comment>.');
+            $this->lineBreak();
+        }
+
+
+        $password = $this->input->getOption('password') ?? $defaults['password'];
+        $user = $this->input->getOption('user') ?? $defaults['user'];
+        $database = $this->input->getOption('database') ?? $defaults['database'];
+
+        $bashCommand = [];
+        $bashCommand[] = "MYSQL_PWD={$password}";
+        $bashCommand[] = "mysql -u {$user}";
+        if ($database) {
+            $bashCommand[] = $database;
+        }
 
         $this->handleTerminationSignals(
-            $process = Process::prepareFromShell('docker compose exec -it mysql bash -c "MYSQL_PWD=password mysql -u user;"')
+            $process = Process::prepareFromShell('docker compose exec -it mysql bash -c "' . join(' ', $bashCommand) . '"')
         );
 
-        $process->setTty(true)->run();
+        $process->setTty(true)
+            ->setTimeout(60 * 60 * 2)
+            ->setIdleTimeout(60 * 60 * 8)
+            ->run();
 
         return static::SUCCESS;
     }

src/Commands/Redis.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Webteractive\Devstack\Commands;
+
+use Webteractive\Devstack\Process;
+use Webteractive\Devstack\WithSignalHandlers;
+
+class Redis extends Base
+{
+    use WithSignalHandlers;
+
+    protected $signature = 'redis';
+    protected $description = 'Start a Redis CLI session within the <comment>redis</comment> container.';
+
+    public function handle(): int
+    {
+
+        $this->handleTerminationSignals(
+            $process = Process::prepareFromShell('docker compose exec -it redis redis-cli')
+        );
+
+        $process->setTty(true)
+            ->setTimeout(60 * 60 * 2)
+            ->setIdleTimeout(60 * 60 * 8)
+            ->run();
+
+        return static::SUCCESS;
+    }
+}

src/Commands/RunPhpCommand.php

@@ -5,7 +5,7 @@
 use Webteractive\Devstack\Process;
 use Webteractive\Devstack\WithSignalHandlers;
 
-class RunPHPCommand extends Base
+class RunPhpCommand extends Base
 {
     use WithSignalHandlers;
 

src/Commands/Shell.php

@@ -29,7 +29,10 @@ public function handle(): int
             $process = Process::prepare(array_merge($command, ['app', 'bash']))
         );
 
-        $process->setTty(true)->run();
+        $process->setTty(true)
+            ->setTimeout(60 * 60 * 2)
+            ->setIdleTimeout(60 * 60 * 8)
+            ->run();
 
         return static::SUCCESS;
     }

src/Env.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Webteractive\Devstack;
+
+use Dotenv\Dotenv;
+use Illuminate\Support\Arr;
+
+class Env
+{
+    protected $dotenv;
+
+    public function __construct($path)
+    {   
+        $this->dotenv = Dotenv::createImmutable($path)->safeLoad();
+    }
+
+    public function get($key, $default = null)
+    {
+        return Arr::get($this->dotenv, $key, $default);
+    }
+}