Add support for host aliases

tiknil · May 24, 2023 · 810e173 · 810e173
1 parent 6294854
commit 810e173
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 2 deletions.
diff --git a/composer.json b/composer.json
@@ -4,7 +4,7 @@
     "keywords": [ "laravel", "docker", "cli" ],
     "type": "library",
     "license": "MIT",
-    "version": "0.1.1",
+    "version": "0.2.0",
     "bin": [
         "bin/skipper"
     ],

diff --git a/src/Commands/ProjectCmds/EditCmd.php b/src/Commands/ProjectCmds/EditCmd.php
@@ -32,6 +32,8 @@ protected function handle(): int
             return Command::SUCCESS;
         }
 
+        $hostAlias = $this->validateHostAliases();
+
         $composeFile = $this->validateComposeFile();
         if (empty($composeFile)) {
             return Command::SUCCESS;
@@ -45,6 +47,7 @@ protected function handle(): int
             path: $this->project->path,
             name: $name,
             host: $host,
+            hostAlias: $hostAlias,
             composeFile: $composeFile,
             envFile: $envFile,
             httpContainer: $httpContainer,
@@ -143,6 +146,31 @@ private function validateHost(): string|null
         return $host;
     }
 
+    private function validateHostAliases(): array
+    {
+        $hostAliases = $this->io->ask('Host aliases (do not include http/https). Separate each host with a space', implode(' ', $this->project->hostAlias));
+
+        $hostAliases = explode(' ', trim($hostAliases));
+
+        foreach ($hostAliases as $hostAlias) {
+            if (str_starts_with($hostAlias, 'http')) {
+                $this->io->error([
+                    'Alias should not contain protocol http',
+                    $hostAlias,
+                ]);
+
+                return [];
+            }
+        }
+
+        if (!empty($hostAliases)) {
+            $this->io->writeln('<comment>Be sure not to use as alias a host already in use by a different project</comment>');
+            $this->io->writeln('<comment>You need to manually add the aliases to the host file using command <info>skipper host [alias]</info></comment>');
+        }
+
+        return $hostAliases;
+    }
+
     private function validateComposeFile(): string|null
     {
         $composeFile = $this->io->ask('Relative path to the docker-compose file', $this->project->composeFile);

diff --git a/src/Config/Project.php b/src/Config/Project.php
@@ -11,6 +11,7 @@ public function __construct(
         public string $path,
         public string $name,
         public string $host,
+        public array $hostAlias = [],
         public string $composeFile = 'docker/docker-compose.yml',
         public string $envFile = 'docker/.env',
         public string $httpContainer = 'nginx',
@@ -24,6 +25,7 @@ public static function from(array $data): self
             path: $data['path'],
             name: $data['name'],
             host: $data['host'],
+            hostAlias: $data['hostAlias'] ?? [],
             composeFile: $data['composeFile'] ?? 'docker/docker-compose.yml',
             envFile: $data['envFile'] ?? 'docker/.env',
             httpContainer: $data['httpContainer'] ?? 'nginx',
@@ -97,6 +99,7 @@ public function definitionList(): array
         return [
             ['name' => $this->name],
             ['host' => $this->host],
+            ['hostAlias' => implode(', ', $this->hostAlias)],
             ['path' => $this->path],
             ['composeFile' => $this->composeFile],
             ['envFile' => $this->envFile ?: ''],
@@ -125,6 +128,7 @@ public function toArray(): array
             'path' => $this->path,
             'name' => $this->name,
             'host' => $this->host,
+            'hostAlias' => $this->hostAlias,
             'composeFile' => $this->composeFile,
             'envFile' => $this->envFile,
             'httpContainer' => $this->httpContainer,

diff --git a/src/Config/Proxy.php b/src/Config/Proxy.php
@@ -40,6 +40,7 @@ public function writeCaddyfile(Config $config): void
 EOD;
 
         foreach ($config->projects as $project) {
+
             $fileContent .= <<<EOD
 
 {$project->host}:443 {
@@ -50,6 +51,18 @@ public function writeCaddyfile(Config $config): void
 }
 
 EOD;
+            foreach ($project->hostAlias as $alias) {
+                $fileContent .= <<<EOD
+
+{$alias}:443 {
+  encode gzip
+  reverse_proxy {$project->name}-{$project->httpContainer}-1:80 {
+       header_up X-Real-IP {remote_host}
+  }
+}
+
+EOD;
+            }
         }
 
         file_put_contents($this->caddyfilePath(), $fileContent);

diff --git a/src/Utils/HostFile.php b/src/Utils/HostFile.php
@@ -154,7 +154,7 @@ private function findHostLine(array $lines): int|null
 
     private function writeFile(array $lines): int
     {
-        $this->io->writeln('We need <info>sudo</info> permissions to create a backup copy of your hosts file and to remove the host');
+        $this->io->writeln('We need <info>sudo</info> permissions to create a backup copy of your hosts file');
         $this->io->writeln('🔐 You may be prompted for your password');
 
         if (Execute::onShell(['sudo', 'cp', '/etc/hosts', '/etc/hosts.bkp'], false) !== Command::SUCCESS) {