feat: support postgresql database servers

Author: carlalexander

composer.json

@@ -38,7 +38,7 @@
         "symfony/polyfill-php80": "^1.27",
         "symfony/process": "^5.4.46|^6.4.14|^7.0|^8.0",
         "symfony/yaml": "^5.4|^6.0|^7.0|^8.0",
-        "ymirapp/ymir-sdk-php": "^1.3.0"
+        "ymirapp/ymir-sdk-php": "^1.4.0"
     },
     "require-dev": {
         "fakerphp/faker": "^1.17",

src/ApiClient.php

@@ -143,9 +143,9 @@ public function createDatabase(Model\DatabaseServer $databaseServer, string $nam
     /**
      * Create a new database on the given network.
      */
-    public function createDatabaseServer(Model\Network $network, string $name, string $type, ?int $storage = 50, bool $public = false): Model\DatabaseServer
+    public function createDatabaseServer(Model\Network $network, string $engine, string $name, string $type, ?bool $public = null, ?int $storage = null): Model\DatabaseServer
     {
-        return Model\DatabaseServer::fromArray($this->client->createDatabaseServer($network->getId(), $name, $type, $storage, $public)->all());
+        return Model\DatabaseServer::fromArray($this->client->createDatabaseServer($network->getId(), $engine, $name, $type, $public, $storage)->all());
     }
 
     /**

src/Command/Database/AbstractDatabaseTunnelCommand.php

@@ -69,14 +69,16 @@ protected function getConnection(string $databaseQuestion, string $databaseServe
     /**
      * Open a SSH tunnel to a private database server.
      */
-    protected function openSshTunnel(DatabaseServer $databaseServer, int $localPort = 3305): Process
+    protected function openSshTunnel(DatabaseServer $databaseServer, ?int $localPort = null): Process
     {
+        $localPort = $localPort ?? $databaseServer->getDefaultLocalPort();
+
         if ('available' !== $databaseServer->getStatus() || empty($databaseServer->getEndpoint())) {
             throw new InvalidInputException(sprintf('The "%s" database server isn\'t available', $databaseServer->getName()));
         } elseif ($databaseServer->isPublic()) {
             throw new InvalidInputException(sprintf('The "%s" database server is publicly accessible and isn\'t on a private subnet', $databaseServer->getName()));
-        } elseif (3306 === $localPort) {
-            throw new InvalidInputException('Cannot use port 3306 as the local port for the SSH tunnel to the database server');
+        } elseif ($databaseServer->getDefaultPort() === $localPort) {
+            throw new InvalidInputException(sprintf('Cannot use port %s as the local port for the SSH tunnel to the database server', $databaseServer->getDefaultPort()));
         }
 
         $this->output->info(sprintf('Opening SSH tunnel to the "<comment>%s</comment>" database server...', $databaseServer->getName()));
@@ -87,6 +89,6 @@ protected function openSshTunnel(DatabaseServer $databaseServer, int $localPort
             throw new ResourceStateException(sprintf('The "%s" network doesn\'t have a bastion host to connect to, but you can add one to the network with the "%s" command', $databaseServer->getNetwork()->getName(), AddBastionHostCommand::NAME));
         }
 
-        return $this->sshExecutable->openTunnelToBastionHost($bastionHost, $localPort, $databaseServer->getEndpoint(), 3306);
+        return $this->sshExecutable->openTunnelToBastionHost($bastionHost, $localPort, $databaseServer->getEndpoint(), $databaseServer->getDefaultPort());
     }
 }

src/Command/Database/CreateDatabaseServerCommand.php

@@ -38,10 +38,11 @@ protected function configure()
             ->setName(self::NAME)
             ->setDescription('Create a new database server')
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the database server')
+            ->addOption('engine', null, InputOption::VALUE_REQUIRED, 'The database to create (mysql or postgresql)')
             ->addOption('network', null, InputOption::VALUE_REQUIRED, 'The ID or name of the network on which the database will be created')
             ->addOption('private', null, InputOption::VALUE_NONE, 'The created database server won\'t be publicly accessible')
             ->addOption('public', null, InputOption::VALUE_NONE, 'The created database server will be publicly accessible')
-            ->addOption('serverless', null, InputOption::VALUE_NONE, 'Create an Aurora serverless database cluster (overrides all other options)')
+            ->addOption('serverless', null, InputOption::VALUE_NONE, 'Create an Aurora serverless database cluster for the selected engine')
             ->addOption('storage', null, InputOption::VALUE_REQUIRED, 'The maximum amount of storage (in GB) allocated to the database server')
             ->addOption('type', null, InputOption::VALUE_REQUIRED, 'The database server type to create on the cloud provider');
     }
@@ -61,8 +62,8 @@ protected function perform()
         $this->output->newLine();
 
         $this->output->horizontalTable(
-            ['Database Sever', new TableSeparator(), 'Username', 'Password', new TableSeparator(), 'Type', 'Public', 'Storage (in GB)'],
-            [[$databaseServer->getName(), new TableSeparator(), $databaseServer->getUsername(), $databaseServer->getPassword(), new TableSeparator(), $databaseServer->getType(), $this->output->formatBoolean($databaseServer->isPublic()), $databaseServer->getStorage() ?? 'N/A']]
+            ['Database Sever', new TableSeparator(), 'Username', 'Password', new TableSeparator(), 'Database', 'Type', 'Public', 'Storage (in GB)'],
+            [[$databaseServer->getName(), new TableSeparator(), $databaseServer->getUsername(), $databaseServer->getPassword(), new TableSeparator(), $databaseServer->getEngineLabel(), $databaseServer->getType(), $this->output->formatBoolean($databaseServer->isPublic()), $databaseServer->getStorage() ?? 'N/A']]
         );
 
         $this->output->infoWithDelayWarning('Database server created');

src/Command/Database/CreateDatabaseUserCommand.php

@@ -17,6 +17,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Ymir\Cli\Command\AbstractCommand;
 use Ymir\Cli\Exception\Resource\ProvisioningFailedException;
+use Ymir\Cli\Exception\UnsupportedDatabaseServerEngineException;
 use Ymir\Cli\Resource\Model\DatabaseServer;
 use Ymir\Cli\Resource\Model\DatabaseUser;
 
@@ -54,6 +55,8 @@ protected function perform()
             throw new ProvisioningFailedException('Failed to provision database user');
         }
 
+        $databaseServer = $databaseUser->getDatabaseServer();
+
         $this->output->horizontalTable(
             ['Username', 'Password'],
             [[$databaseUser->getName(), $databaseUser->getPassword()]]
@@ -63,11 +66,27 @@ protected function perform()
         $this->output->newLine();
         $this->output->info('Database user created successfully');
 
-        if (!$databaseUser->getDatabaseServer()->isPublic()) {
-            $this->output->newLine();
-            $this->output->important(sprintf('The "<comment>%s</comment>" database user needs to be manually created on the "<comment>%s</comment>" database server because it isn\'t publicly accessible. You can use the following queries to create it and grant it access to the server:', $databaseUser->getName(), $databaseUser->getDatabaseServer()->getName()));
-            $this->output->writeln(sprintf('CREATE USER %s@\'%%\' IDENTIFIED BY \'%s\'', $databaseUser->getName(), $databaseUser->getPassword()));
-            $this->output->writeln(sprintf('GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES ON *.* TO %s@\'%%\'', $databaseUser->getName()));
+        if ($databaseServer->isPublic()) {
+            return;
+        }
+
+        $this->output->newLine();
+        $this->output->important(sprintf('The "<comment>%s</comment>" database user needs to be manually created on the "<comment>%s</comment>" database server because it isn\'t publicly accessible. You can use the following queries to create it and grant it access to the server:', $databaseUser->getName(), $databaseServer->getName()));
+
+        switch ($databaseServer->getEngine()) {
+            case DatabaseServer::ENGINE_MYSQL:
+                $this->output->writeln(sprintf('CREATE USER %s@\'%%\' IDENTIFIED BY \'%s\'', $databaseUser->getName(), $databaseUser->getPassword()));
+                $this->output->writeln(sprintf('GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES ON *.* TO %s@\'%%\'', $databaseUser->getName()));
+
+                break;
+            case DatabaseServer::ENGINE_POSTGRESQL:
+                $this->output->writeln(sprintf('CREATE USER "%s" WITH PASSWORD \'%s\'', $databaseUser->getName(), $databaseUser->getPassword()));
+                $this->output->writeln(sprintf('GRANT "%s" TO CURRENT_USER', $databaseUser->getName()));
+                $this->output->writeln(sprintf('GRANT ALL PRIVILEGES ON DATABASE "<database>" TO "%s"', $databaseUser->getName()));
+
+                break;
+            default:
+                throw new UnsupportedDatabaseServerEngineException($databaseServer->getEngine());
         }
     }
 }

src/Command/Database/DatabaseServerTunnelCommand.php

@@ -36,7 +36,7 @@ protected function configure()
             ->setName(self::NAME)
             ->setDescription('Create a SSH tunnel to a database server')
             ->addArgument('server', InputArgument::OPTIONAL, 'The ID or name of the database server to create a SSH tunnel to')
-            ->addOption('port', null, InputOption::VALUE_REQUIRED, 'The local port to use to connect to the database server', '3305');
+            ->addOption('port', null, InputOption::VALUE_REQUIRED, 'The local port to use to connect to the database server');
     }
 
     /**
@@ -45,7 +45,7 @@ protected function configure()
     protected function perform()
     {
         $databaseServer = $this->resolve(DatabaseServer::class, 'Which database server would you like to connect to?');
-        $localPort = (int) $this->input->getNumericOption('port');
+        $localPort = $this->input->getNumericOption('port') ?? $databaseServer->getDefaultLocalPort();
 
         if (empty($localPort)) {
             throw new InvalidInputException('You must provide a valid "port" option');

src/Command/Database/DeleteDatabaseUserCommand.php

@@ -16,6 +16,7 @@
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
 use Ymir\Cli\Command\AbstractCommand;
+use Ymir\Cli\Exception\UnsupportedDatabaseServerEngineException;
 use Ymir\Cli\Resource\Model\DatabaseServer;
 use Ymir\Cli\Resource\Model\DatabaseUser;
 
@@ -56,10 +57,24 @@ protected function perform()
 
         $this->output->info('Database user deleted');
 
-        if (!$databaseServer->isPublic()) {
-            $this->output->newLine();
-            $this->output->important('The database user needs to be manually deleted on the database server because it isn\'t publicly accessible. You can use the following query to delete it:');
-            $this->output->writeln(sprintf('DROP USER IF EXISTS %s@\'%%\'', $databaseUser->getName()));
+        if ($databaseServer->isPublic()) {
+            return;
+        }
+
+        $this->output->newLine();
+        $this->output->important('The database user needs to be manually deleted on the database server because it isn\'t publicly accessible. You can use the following query to delete it:');
+
+        switch ($databaseServer->getEngine()) {
+            case DatabaseServer::ENGINE_MYSQL:
+                $this->output->writeln(sprintf('DROP USER IF EXISTS %s@\'%%\'', $databaseUser->getName()));
+
+                break;
+            case DatabaseServer::ENGINE_POSTGRESQL:
+                $this->output->writeln(sprintf('DROP USER IF EXISTS "%s"', $databaseUser->getName()));
+
+                break;
+            default:
+                throw new UnsupportedDatabaseServerEngineException($databaseServer->getEngine());
         }
     }
 }

src/Command/Database/ExportDatabaseCommand.php

@@ -18,12 +18,17 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Filesystem\Filesystem;
 use Ymir\Cli\ApiClient;
+use Ymir\Cli\Database\Connection;
 use Ymir\Cli\Database\Mysqldump;
+use Ymir\Cli\Exception\Executable\ExecutableNotDetectedException;
 use Ymir\Cli\Exception\InvalidInputException;
 use Ymir\Cli\Exception\SystemException;
+use Ymir\Cli\Exception\UnsupportedDatabaseServerEngineException;
+use Ymir\Cli\Executable\PgDumpExecutable;
 use Ymir\Cli\Executable\SshExecutable;
 use Ymir\Cli\ExecutionContextFactory;
 use Ymir\Cli\Process\Process;
+use Ymir\Cli\Resource\Model\DatabaseServer;
 
 class ExportDatabaseCommand extends AbstractDatabaseTunnelCommand
 {
@@ -41,14 +46,22 @@ class ExportDatabaseCommand extends AbstractDatabaseTunnelCommand
      */
     private $filesystem;
 
+    /**
+     * The pg_dump executable.
+     *
+     * @var PgDumpExecutable
+     */
+    private $pgDumpExecutable;
+
     /**
      * Constructor.
      */
-    public function __construct(ApiClient $apiClient, ExecutionContextFactory $contextFactory, Filesystem $filesystem, SshExecutable $sshExecutable)
+    public function __construct(ApiClient $apiClient, ExecutionContextFactory $contextFactory, Filesystem $filesystem, PgDumpExecutable $pgDumpExecutable, SshExecutable $sshExecutable)
     {
         parent::__construct($apiClient, $contextFactory, $sshExecutable);
 
         $this->filesystem = $filesystem;
+        $this->pgDumpExecutable = $pgDumpExecutable;
     }
 
     /**
@@ -93,7 +106,9 @@ protected function perform()
         $this->output->infoWithDelayWarning(sprintf('Exporting "<comment>%s</comment>" database', $connection->getDatabase()));
 
         try {
-            Mysqldump::fromConnection($connection, ['compress' => $compression])->start($filename);
+            $this->exportDatabase($connection, $filename, $compression);
+        } catch (ExecutableNotDetectedException|UnsupportedDatabaseServerEngineException $exception) {
+            throw $exception;
         } catch (\Throwable $exception) {
             throw new SystemException(sprintf('Failed to export database: %s', $exception->getMessage()));
         } finally {
@@ -104,4 +119,25 @@ protected function perform()
 
         $this->output->infoWithValue('Database exported successfully to', $filename);
     }
+
+    /**
+     * Export the database for the given connection.
+     */
+    private function exportDatabase(Connection $connection, string $filename, string $compression): void
+    {
+        $engine = $connection->getDatabaseServer()->getEngine();
+
+        switch ($engine) {
+            case DatabaseServer::ENGINE_MYSQL:
+                Mysqldump::fromConnection($connection, ['compress' => $compression])->start($filename);
+
+                break;
+            case DatabaseServer::ENGINE_POSTGRESQL:
+                $this->pgDumpExecutable->dump($connection, $filename, $compression);
+
+                break;
+            default:
+                throw new UnsupportedDatabaseServerEngineException($engine);
+        }
+    }
 }

src/Command/Database/GetDatabaseServerInfoCommand.php

@@ -46,7 +46,7 @@ protected function perform()
         $databaseServer = $this->resolve(DatabaseServer::class, 'Which database server would you like to get information about?');
 
         $this->output->horizontalTable(
-            ['Id', 'Name', 'Status', 'Locked', 'Public', new TableSeparator(), 'Provider', 'Network', 'Region', 'Type', 'Storage', 'Endpoint'],
+            ['Id', 'Name', 'Status', 'Locked', 'Public', new TableSeparator(), 'Provider', 'Network', 'Region', 'Database', 'Type', 'Storage', 'Endpoint'],
             [[
                 $databaseServer->getId(),
                 $databaseServer->getName(),
@@ -57,6 +57,7 @@ protected function perform()
                 $databaseServer->getNetwork()->getProvider()->getName(),
                 $databaseServer->getNetwork()->getName(),
                 $databaseServer->getRegion(),
+                $databaseServer->getEngineLabel(),
                 $databaseServer->getType(),
                 $databaseServer->getStorage() ? $databaseServer->getStorage().'GB' : 'N/A',
                 $databaseServer->getEndpoint() ?? 'pending',