Merge pull request #349 from tighten/tm/shell-cmd

Add a `takeout shell` command

Author: tonysm

README.md

@@ -169,6 +169,24 @@ takeout stop {container_id}
 takeout stop {container_id1} {container_id2}
 ```
 
+### Get a shell inside any Takeout container
+
+To get a shell inside any container that is started with Takeout, you may run:
+
+```bash
+takeout shell {service}
+```
+
+Here are some examples:
+
+```bash
+takeout shell mysql
+takeout shell neo4j
+takeout shell pgvector
+```
+
+This will open a shell inside the running container for the service you provide. Takeout will start either a `bash` or a `sh` process inside the container, depending on what the container supports.
+
 ## Running multiple versions of a dependency
 
 Another of Takeout's benefits is that it allows you to have multiple versions of a dependency installed and running at the same time. That means, for example, that you can run both MySQL 5.7 and 8.0 at the same time, on different ports.

app/Commands/ShellCommand.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Commands;
+
+use App\InitializesCommands;
+use App\Services;
+use Illuminate\Console\Command;
+
+class ShellCommand extends Command
+{
+    use InitializesCommands;
+
+    const MENU_TITLE = 'Get a shell inside a running Takeout container.';
+
+    protected $signature = 'shell {service}';
+    protected $description = 'Get a shell inside a running Takeout container.';
+
+    public function handle(Services $services): int
+    {
+        $this->initializecommand();
+
+        $service = $services->get($this->argument('service'));
+
+        resolve($service)->forwardShell();
+
+        return self::SUCCESS;
+    }
+}

app/Services/BaseService.php

@@ -7,6 +7,7 @@
 use App\Shell\Environment;
 use App\Shell\Shell;
 use App\WritesToConsole;
+use Exception;
 use Illuminate\Support\Str;
 use Throwable;
 
@@ -93,6 +94,28 @@ public function enable(bool $useDefaults = false, array $passthroughOptions = []
         }
     }
 
+    public function forwardShell(): void
+    {
+        if (! $this->docker->isDockerServiceRunning()) {
+            throw new Exception('Docker is not running.');
+        }
+
+        $service = $this->docker->takeoutContainers()->first(function ($container) {
+            return str_starts_with($container['names'], "TO--{$this->shortName()}--");
+        });
+
+        if (! $service) {
+            throw new Exception(sprintf('Service %s is not enabled.', $this->shortName()));
+        }
+
+        $this->docker->forwardShell($service['container_id'], $this->shellCommand());
+    }
+
+    protected function shellCommand(): string
+    {
+        return 'bash';
+    }
+
     public function organization(): string
     {
         return $this->organization;

app/Services/Beanstalkd.php

@@ -12,4 +12,9 @@ class Beanstalkd extends BaseService
 
     protected $dockerRunTemplate = '-p "${:port}":11300 \
         "${:organization}"/"${:image_name}":"${:tag}"';
+
+    protected function shellCommand(): string
+    {
+        return 'sh';
+    }
 }

app/Services/Buggregator.php

@@ -42,4 +42,9 @@ class Buggregator extends BaseService
         -p "${:monolog_port}":9913 \
         --network-alias "${:network_alias}" \
         "${:organization}"/"${:image_name}":"${:tag}"';
+
+    protected function shellCommand(): string
+    {
+        return 'sh';
+    }
 }

app/Services/CouchDB.php

@@ -14,10 +14,22 @@ class CouchDB extends BaseService
             'prompt' => 'What is the Docker volume name?',
             'default' => 'couchdb_data',
         ],
+        [
+            'shortname' => 'user',
+            'prompt' => 'What is the CouchDB User?',
+            'default' => 'couchdb',
+        ],
+        [
+            'shortname' => 'password',
+            'prompt' => 'What is the CouchDB Password?',
+            'default' => 'password',
+        ],
     ];
 
     protected $dockerRunTemplate = '-p "${:port}":5984 \
         -v "${:volume}":/opt/couchdb/data \
+        -e COUCHDB_USER="${:user}" \
+        -e COUCHDB_PASSWORD="${:password}" \
         "${:organization}"/"${:image_name}":"${:tag}"';
 
     protected static $displayName = 'CouchDB';

app/Services/EventStoreDB.php

@@ -25,7 +25,6 @@ class EventStoreDB extends BaseService
     protected $dockerRunTemplate = '-p "${:port}":1113 \
         -p "${:web_port}":2113 \
         -v "${:volume}":/var/lib/eventstore \
-        "${:organization}"/"${:image_name}":"${:tag}" \
-        --insecure --run-projections=All \
-        --enable-external-tcp --enable-atom-pub-over-http';
+        "${:organization}"/"${:image_name}":latest \
+        --insecure --run-projections=All';
 }

app/Services/MailDev.php

@@ -20,4 +20,9 @@ class MailDev extends BaseService
     protected $dockerRunTemplate = '-p "${:port}":1025 \
         -p "${:web_port}":1080 \
         "${:organization}"/"${:image_name}":"${:tag}"';
+
+    protected function shellCommand(): string
+    {
+        return 'sh';
+    }
 }

app/Services/MailHog.php

@@ -20,4 +20,9 @@ class MailHog extends BaseService
     protected $dockerRunTemplate = '-p "${:port}":1025 \
         -p "${:web_port}":8025 \
         "${:organization}"/"${:image_name}":"${:tag}"';
+
+    protected function shellCommand(): string
+    {
+        return 'sh';
+    }
 }

app/Services/Mailpit.php

@@ -20,4 +20,9 @@ class Mailpit extends BaseService
     protected $dockerRunTemplate = '-p "${:port}":1025 \
         -p "${:web_port}":8025 \
         "${:organization}"/"${:image_name}":"${:tag}"';
+
+    protected function shellCommand(): string
+    {
+        return 'sh';
+    }
 }

app/Services/MeiliSearch.php

@@ -20,4 +20,9 @@ class MeiliSearch extends BaseService
     protected $dockerRunTemplate = '-p "${:port}":7700 \
         -v "${:volume}":/data.ms \
         "${:organization}"/"${:image_name}":"${:tag}"';
+
+    protected function shellCommand(): string
+    {
+        return 'sh';
+    }
 }

app/Services/OpenSearch.php

@@ -23,7 +23,7 @@ class OpenSearch extends BaseService
         [
             'shortname' => 'disable_security',
             'prompt' => 'Disable security plugin (true or false)?',
-            'default' => 'false',
+            'default' => 'true',
         ],
     ];
 

app/Services/Soketi.php

@@ -41,4 +41,9 @@ public function __construct(Shell $shell, Environment $environment, Docker $dock
             return $prompt;
         }, $this->defaultPrompts);
     }
+
+    protected function shellCommand(): string
+    {
+        return 'sh';
+    }
 }

app/Services/Traefik.php

@@ -12,11 +12,8 @@ class Traefik extends BaseService
     protected static $category = Category::TOOLS;
 
     protected $imageName = 'traefik';
-
     protected $defaultTag = 'v2.10';
-
     protected $defaultPort = 8080;
-
     protected $prompts = [
         [
             'shortname' => 'config_dir',
@@ -64,6 +61,11 @@ public function __construct(Shell $shell, Environment $environment, Docker $dock
         }, $this->prompts);
     }
 
+    protected function shellCommand(): string
+    {
+        return 'sh';
+    }
+
     protected function prompts(): void
     {
         parent::prompts();

app/Shell/Docker.php

@@ -3,7 +3,6 @@
 namespace App\Shell;
 
 use App\Exceptions\DockerContainerMissingException;
-use App\Shell\Environment;
 use Exception;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
@@ -200,6 +199,19 @@ public function stopDockerService(): void
         }
     }
 
+    public function forwardShell(string $containerId, string $shellCommand): void
+    {
+        $command = $this->shell->buildProcess(sprintf(
+            'docker exec -it "%s" %s',
+            $containerId,
+            $shellCommand,
+        ));
+
+        $command->setTty(true);
+        $command->setTimeout(null);
+        $command->run();
+    }
+
     protected function runAndParseTable(string $command): Collection
     {
         return $this->formatter->rawTableOutputToCollection(

tests/Feature/DockerTagsTest.php

@@ -42,7 +42,7 @@ function it_sorts_the_versions_naturally()
         $tags = collect($dockerTags->getTags());
 
         $this->assertEquals('latest', $tags->shift());
-        $this->assertEquals('16.3', $tags->shift());
+        $this->assertEquals('17.0', $tags->shift());
     }
 
     /** @test */