CLI-1402: [push:db] Warn if view database connection details permissi…

…on is missing (#1810) * CLI-1402: Require view database connection details permission * Cleanup * add tests * stable sdk * add help test * kill mutant * allow pull:db
acquia · Oct 18, 2024 · 1dba2de · 1dba2de
1 parent 1ffc996
commit 1dba2de
Show file tree

Hide file tree

Showing 15 changed files with 230 additions and 168 deletions.
diff --git a/composer.json b/composer.json
@@ -47,7 +47,7 @@
         "symfony/yaml": "^6.3",
         "thecodingmachine/safe": "^2.4",
         "typhonius/acquia-logstream": "^0.0.13",
-        "typhonius/acquia-php-sdk-v2": "^3.1.1",
+        "typhonius/acquia-php-sdk-v2": "^3.3.2",
         "vlucas/phpdotenv": "^5.5",
         "zumba/amplitude-php": "^1.0.4"
     },

diff --git a/composer.lock b/composer.lock
diff --git a/src/Attribute/RequireDb.php → src/Attribute/RequireLocalDb.php b/src/Attribute/RequireDb.php → src/Attribute/RequireLocalDb.php
@@ -5,9 +5,9 @@
 namespace Acquia\Cli\Attribute;
 
 /**
- * Specify that a command requires authentication.
+ * Specify that a command requires local database.
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
-class RequireDb
+class RequireLocalDb
 {
 }
diff --git a/src/Attribute/RequireRemoteDb.php b/src/Attribute/RequireRemoteDb.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Acquia\Cli\Attribute;
+
+/**
+ * Specify that a command requires remote database.
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class RequireRemoteDb
+{
+}
diff --git a/src/Command/Archive/ArchiveExportCommand.php b/src/Command/Archive/ArchiveExportCommand.php
@@ -5,7 +5,7 @@
 namespace Acquia\Cli\Command\Archive;
 
 use Acquia\Cli\Attribute\RequireAuth;
-use Acquia\Cli\Attribute\RequireDb;
+use Acquia\Cli\Attribute\RequireLocalDb;
 use Acquia\Cli\Command\CommandBase;
 use Acquia\Cli\Exception\AcquiaCliException;
 use Acquia\Cli\Output\Checklist;
@@ -21,7 +21,7 @@
 use Symfony\Component\Filesystem\Path;
 
 #[RequireAuth]
-#[RequireDb]
+#[RequireLocalDb]
 #[AsCommand(name: 'archive:export', description: 'Export an archive of the Drupal application including code, files, and database')]
 final class ArchiveExportCommand extends CommandBase
 {

diff --git a/src/Command/CommandBase.php b/src/Command/CommandBase.php
@@ -7,7 +7,8 @@
 use Acquia\Cli\AcsfApi\AcsfClientService;
 use Acquia\Cli\ApiCredentialsInterface;
 use Acquia\Cli\Attribute\RequireAuth;
-use Acquia\Cli\Attribute\RequireDb;
+use Acquia\Cli\Attribute\RequireLocalDb;
+use Acquia\Cli\Attribute\RequireRemoteDb;
 use Acquia\Cli\CloudApi\ClientService;
 use Acquia\Cli\Command\Ssh\SshKeyCommandBase;
 use Acquia\Cli\DataStore\AcquiaCliDatastore;
@@ -119,10 +120,13 @@ public function __construct(
         if ((new \ReflectionClass(static::class))->getAttributes(RequireAuth::class)) {
             $this->appendHelp('This command requires authentication via the Cloud Platform API.');
         }
-        if ((new \ReflectionClass(static::class))->getAttributes(RequireDb::class)) {
+        if ((new \ReflectionClass(static::class))->getAttributes(RequireLocalDb::class)) {
             $this->appendHelp('This command requires an active database connection. Set the following environment variables prior to running this command: '
                 . 'ACLI_DB_HOST, ACLI_DB_NAME, ACLI_DB_USER, ACLI_DB_PASSWORD');
         }
+        if ((new \ReflectionClass(static::class))->getAttributes(RequireRemoteDb::class)) {
+            $this->appendHelp('This command requires the \'View database connection details\' permission.');
+        }
     }
 
     public function appendHelp(string $helpText): void

diff --git a/src/Command/Pull/PullCodeCommand.php b/src/Command/Pull/PullCodeCommand.php
@@ -5,7 +5,7 @@
 namespace Acquia\Cli\Command\Pull;
 
 use Acquia\Cli\Attribute\RequireAuth;
-use Acquia\Cli\Attribute\RequireDb;
+use Acquia\Cli\Attribute\RequireLocalDb;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -14,7 +14,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 #[RequireAuth]
-#[RequireDb]
+#[RequireLocalDb]
 #[AsCommand(name: 'pull:code', description: 'Copy code from a Cloud Platform environment')]
 final class PullCodeCommand extends PullCommandBase
 {

diff --git a/src/Command/Pull/PullCommand.php b/src/Command/Pull/PullCommand.php
@@ -5,7 +5,7 @@
 namespace Acquia\Cli\Command\Pull;
 
 use Acquia\Cli\Attribute\RequireAuth;
-use Acquia\Cli\Attribute\RequireDb;
+use Acquia\Cli\Attribute\RequireLocalDb;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -14,7 +14,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 #[RequireAuth]
-#[RequireDb]
+#[RequireLocalDb]
 #[AsCommand(name: 'pull:all', description: 'Copy code, database, and files from a Cloud Platform environment', aliases: [
     'refresh',
     'pull',

diff --git a/src/Command/Pull/PullCommandBase.php b/src/Command/Pull/PullCommandBase.php
@@ -131,6 +131,7 @@ protected function pullCode(InputInterface $input, OutputInterface $output, bool
     /**
      * @param bool $onDemand Force on-demand backup.
      * @param bool $noImport Skip import.
+     * @throws \Acquia\Cli\Exception\AcquiaCliException
      */
     protected function pullDatabase(InputInterface $input, OutputInterface $output, EnvironmentResponse $sourceEnvironment, bool $onDemand = false, bool $noImport = false, bool $multipleDbs = false): void
     {

diff --git a/src/Command/Pull/PullDatabaseCommand.php b/src/Command/Pull/PullDatabaseCommand.php
@@ -5,15 +5,16 @@
 namespace Acquia\Cli\Command\Pull;
 
 use Acquia\Cli\Attribute\RequireAuth;
-use Acquia\Cli\Attribute\RequireDb;
+use Acquia\Cli\Attribute\RequireLocalDb;
+use Acquia\Cli\Attribute\RequireRemoteDb;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 #[RequireAuth]
-#[RequireDb]
+#[RequireLocalDb]
 #[AsCommand(name: 'pull:database', description: 'Import database backup from a Cloud Platform environment', aliases: ['pull:db'])]
 final class PullDatabaseCommand extends PullCommandBase
 {
@@ -49,6 +50,9 @@ protected function configure(): void
             );
     }
 
+    /**
+     * @throws \Acquia\Cli\Exception\AcquiaCliException
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $noScripts = $input->hasOption('no-scripts') && $input->getOption('no-scripts');

diff --git a/src/Command/Push/PushDatabaseCommand.php b/src/Command/Push/PushDatabaseCommand.php
@@ -5,7 +5,8 @@
 namespace Acquia\Cli\Command\Push;
 
 use Acquia\Cli\Attribute\RequireAuth;
-use Acquia\Cli\Attribute\RequireDb;
+use Acquia\Cli\Attribute\RequireLocalDb;
+use Acquia\Cli\Attribute\RequireRemoteDb;
 use Acquia\Cli\Exception\AcquiaCliException;
 use Acquia\Cli\Output\Checklist;
 use AcquiaCloudApi\Response\DatabaseResponse;
@@ -16,7 +17,8 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 #[RequireAuth]
-#[RequireDb]
+#[RequireLocalDb]
+#[RequireRemoteDb]
 #[AsCommand(name: 'push:database', description: 'Push a database from your local environment to a Cloud Platform environment', aliases: ['push:db'])]
 final class PushDatabaseCommand extends PushCommandBase
 {
@@ -27,13 +29,19 @@ protected function configure(): void
             ->acceptSite();
     }
 
+    /**
+     * @throws \Acquia\Cli\Exception\AcquiaCliException
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $destinationEnvironment = $this->determineEnvironment($input, $output);
         $acquiaCloudClient = $this->cloudApiClientService->getClient();
         $databases = $this->determineCloudDatabases($acquiaCloudClient, $destinationEnvironment, $input->getArgument('site'));
         // We only support pushing a single database.
         $database = $databases[0];
+        if ($database->user_name === null) {
+            throw new AcquiaCliException('Database connection details missing');
+        }
         $answer = $this->io->confirm("Overwrite the <bg=cyan;options=bold>$database->name</> database on <bg=cyan;options=bold>$destinationEnvironment->name</> with a copy of the database from the current machine?");
         if (!$answer) {
             return Command::SUCCESS;

diff --git a/src/EventListener/ExceptionListener.php b/src/EventListener/ExceptionListener.php
@@ -75,6 +75,9 @@ public function onConsoleError(ConsoleErrorEvent $event): void
                     $this->helpMessages[] = 'Check for MySQL warnings above or in the server log (/var/log/mysql/error.log)';
                     $this->helpMessages[] = 'Frequently, `MySQL server has gone away` messages are caused by max_allowed_packet being exceeded.';
                     break;
+                case 'Database connection details missing':
+                    $this->helpMessages[] = 'Check that you have the \'View database connection details\' permission';
+                    break;
             }
         }
 

diff --git a/tests/phpunit/src/Commands/Pull/PullCommandTestBase.php b/tests/phpunit/src/Commands/Pull/PullCommandTestBase.php
@@ -354,7 +354,7 @@ protected function mockListSites(SshHelper|ObjectProphecy $sshHelper): void
     public function mockGetBackup(mixed $environment): void
     {
         $databases = $this->mockRequest('getEnvironmentsDatabases', $environment->id);
-        $tamper = function ($backups): void {
+        $tamper = static function ($backups): void {
             $backups[0]->completedAt = $backups[0]->completed_at;
         };
         $backups = new BackupsResponse(

diff --git a/tests/phpunit/src/Commands/Push/PushDatabaseCommandTest.php b/tests/phpunit/src/Commands/Push/PushDatabaseCommandTest.php
@@ -6,6 +6,7 @@
 
 use Acquia\Cli\Command\CommandBase;
 use Acquia\Cli\Command\Push\PushDatabaseCommand;
+use Acquia\Cli\Exception\AcquiaCliException;
 use Acquia\Cli\Helpers\LocalMachineHelper;
 use Acquia\Cli\Helpers\SshHelper;
 use Acquia\Cli\Tests\CommandTestBase;
@@ -108,6 +109,30 @@ public function testPushDatabase(int $verbosity, bool $printOutput, bool $pv): v
         $this->assertStringContainsString('Overwrite the jxr136 database on dev with a copy of the database from the current machine?', $output);
     }
 
+    public function testPushDbHelp(): void
+    {
+        $help = $this->command->getHelp();
+        $this->assertStringContainsString('This command requires authentication via the Cloud Platform API.', $help);
+        $this->assertStringContainsString('This command requires an active database connection. Set the following environment variables prior to running this command: ACLI_DB_HOST, ACLI_DB_NAME, ACLI_DB_USER, ACLI_DB_PASSWORD', $help);
+        $this->assertStringContainsString('This command requires the \'View database connection details\' permission.', $help);
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function testPushDatabaseWithMissingPermission(): void
+    {
+        $environment = $this->mockGetEnvironment();
+        $tamper = static function ($databases): void {
+            $databases[0]->user_name = null;
+        };
+        $this->mockRequest('getEnvironmentsDatabases', $environment->id, null, null, $tamper);
+
+        $this->expectException(AcquiaCliException::class);
+        $this->expectExceptionMessage('Database connection details missing');
+        $this->executeCommand([], self::inputChooseEnvironment());
+    }
+
     protected function mockUploadDatabaseDump(
         ObjectProphecy $localMachineHelper,
         ObjectProphecy $process,

diff --git a/tests/phpunit/src/Misc/ExceptionListenerTest.php b/tests/phpunit/src/Misc/ExceptionListenerTest.php
@@ -109,6 +109,10 @@ public function providerTestHelp(): array
                     'Frequently, `MySQL server has gone away` messages are caused by max_allowed_packet being exceeded.',
                 ],
             ],
+            [
+                new AcquiaCliException('Database connection details missing'),
+                'Check that you have the \'View database connection details\' permission',
+            ],
             [
                 new ApiErrorException((object) [
                     'error' => '',