CLI-1365: Warn when logs need to be created (#1832)

* CLI-1365: Warn when logs need to be created * kill mutant * coverage * kill typeerror catch
acquia · Nov 19, 2024 · 10027cb · 10027cb
1 parent 7298135
commit 10027cb
Show file tree

Hide file tree

Showing 10 changed files with 162 additions and 116 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.14",
-        "typhonius/acquia-php-sdk-v2": "^3.3.2",
+        "typhonius/acquia-php-sdk-v2": "^3.4.0",
         "vlucas/phpdotenv": "^5.5",
         "zumba/amplitude-php": "^1.0.4"
     },

diff --git a/composer.lock b/composer.lock
diff --git a/src/Command/Api/ApiBaseCommand.php b/src/Command/Api/ApiBaseCommand.php
@@ -97,6 +97,7 @@ protected function interact(InputInterface $input, OutputInterface $output): voi
     /**
      * @throws \Acquia\Cli\Exception\AcquiaCliException
      * @throws \JsonException
+     * @throws \AcquiaCloudApi\Exception\ApiErrorException
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
@@ -122,8 +123,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $response = $acquiaCloudClient->request($this->method, $path);
             $exitCode = 0;
         } catch (ApiErrorException $exception) {
-            // Ignore PhpStorm warning here.
-            // @see https://youtrack.jetbrains.com/issue/WI-77190/Exception-is-never-thrown-when-thrown-from-submethod
+            if ($input->isInteractive()) {
+                throw $exception;
+            }
             $response = $exception->getResponseBody();
             $exitCode = 1;
         }

diff --git a/src/EventListener/ExceptionListener.php b/src/EventListener/ExceptionListener.php
@@ -10,6 +10,7 @@
 use Symfony\Component\Console\Event\ConsoleErrorEvent;
 use Symfony\Component\Console\Exception\CommandNotFoundException;
 use Symfony\Component\Console\Exception\RuntimeException;
+use TypeError;
 
 /**
  * Make exceptions warm and cuddly.
@@ -82,6 +83,9 @@ public function onConsoleError(ConsoleErrorEvent $event): void
         }
 
         if ($error instanceof ApiErrorException) {
+            if (($command = $event->getCommand()) && $error->getResponseBody()->error === 'not_found' && $command->getName() === 'api:environments:log-download') {
+                $this->helpMessages[] = "You must create logs (api:environments:log-create) prior to downloading them";
+            }
             switch ($errorMessage) {
                 case "There are no available Cloud IDEs for this application.\n":
                     $this->helpMessages[] = "Delete an existing IDE via <bg=$this->messagesBgColor;fg=$this->messagesFgColor;options=bold>acli ide:delete</> or contact your Account Manager or Acquia Sales to purchase additional IDEs.";
@@ -96,10 +100,6 @@ public function onConsoleError(ConsoleErrorEvent $event): void
             }
         }
 
-        if ($error instanceof \TypeError && str_contains($error->getMessage(), 'AcquiaCloudApi\Response')) {
-            $newErrorMessage = 'Cloud Platform API returned an unexpected data type. This could be due to missing permissions or a problem with your Cloud Platform application.';
-        }
-
         if (!empty($this->helpMessages)) {
             $this->helpMessages[0] = '<options=bold>How to fix it:</> ' . $this->helpMessages[0];
         }

diff --git a/tests/phpunit/src/CommandTestBase.php b/tests/phpunit/src/CommandTestBase.php
@@ -81,7 +81,7 @@ protected function setCommand(CommandBase $command): void
      *   An array of strings representing each input passed to the command input
      *   stream.
      */
-    protected function executeCommand(array $args = [], array $inputs = [], int $verbosity = Output::VERBOSITY_VERY_VERBOSE): void
+    protected function executeCommand(array $args = [], array $inputs = [], int $verbosity = OutputInterface::VERBOSITY_VERY_VERBOSE, ?bool $interactive = true): void
     {
         $cwd = $this->projectDir;
         $tester = $this->getCommandTester();
@@ -96,7 +96,7 @@ protected function executeCommand(array $args = [], array $inputs = [], int $ver
         }
 
         try {
-            $tester->execute($args, ['verbosity' => $verbosity]);
+            $tester->execute($args, ['verbosity' => $verbosity, 'interactive' => $interactive]);
         } catch (Exception $e) {
             if (getenv('ACLI_PRINT_COMMAND_OUTPUT')) {
                 print $this->getDisplay();

diff --git a/tests/phpunit/src/Commands/Api/ApiCommandTest.php b/tests/phpunit/src/Commands/Api/ApiCommandTest.php
@@ -11,6 +11,7 @@
 use Acquia\Cli\Tests\CommandTestBase;
 use AcquiaCloudApi\Exception\ApiErrorException;
 use Symfony\Component\Console\Exception\MissingInputException;
+use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Filesystem\Path;
 use Symfony\Component\Yaml\Yaml;
 
@@ -75,6 +76,30 @@ public function testArgumentsInteraction(): void
         $this->assertStringContainsString('Select a value for logType', $output);
     }
 
+    /**
+     * @throws \AcquiaCloudApi\Exception\ApiErrorException
+     * @throws \JsonException
+     * @throws \Exception
+     */
+    public function testInteractiveException(): void
+    {
+        $this->command = $this->getApiCommandByName('api:environments:log-download');
+        $this->clientProphecy->addOption('headers', ['Accept' => 'application/hal+json, version=2'])
+            ->shouldBeCalled();
+        $mockBody = self::getMockResponseFromSpec($this->command->getPath(), $this->command->getMethod(), '404');
+        $this->clientProphecy->request('get', '/environments/289576-53785bca-1946-4adc-a022-e50d24686c20/logs/apache-access')
+            ->willThrow(new ApiErrorException($mockBody->{'Not found'}->value))
+            ->shouldBeCalled();
+        $this->expectException(ApiErrorException::class);
+        $this->executeCommand([], [
+            '289576-53785bca-1946-4adc-a022-e50d24686c20',
+            'apache-access',
+        ]);
+    }
+
+    /**
+     * @throws \Exception
+     */
     public function testArgumentsInteractionValidation(): void
     {
         $this->command = $this->getApiCommandByName('api:environments:variable-update');
@@ -105,6 +130,10 @@ public function testArgumentsInteractionValidationFormat(): void
 
     /**
      * Tests invalid UUID.
+     *
+     * @throws \JsonException
+     * @throws \AcquiaCloudApi\Exception\ApiErrorException
+     * @throws \Exception
      */
     public function testApiCommandErrorResponse(): void
     {
@@ -117,7 +146,7 @@ public function testApiCommandErrorResponse(): void
             ->willThrow(new ApiErrorException($mockBody))
             ->shouldBeCalled();
 
-        // ApiCommandBase::convertApplicationAliastoUuid() will try to convert the invalid string to a uuid:
+        // ApiCommandBase::convertApplicationAliasToUuid() will try to convert the invalid string to a UUID:
         $this->clientProphecy->addQuery('filter', 'hosting=@*:' . $invalidUuid);
         $this->clientProphecy->request('get', '/applications')->willReturn([]);
 
@@ -128,7 +157,7 @@ public function testApiCommandErrorResponse(): void
             '0',
             // Would you like to link the Cloud application Sample application to this repository?
             'n',
-        ]);
+        ], \Symfony\Component\Console\Output\OutputInterface::VERBOSITY_VERY_VERBOSE, false);
 
         // Assert.
         $output = $this->getDisplay();

diff --git a/tests/phpunit/src/Commands/Remote/DrushCommandTest.php b/tests/phpunit/src/Commands/Remote/DrushCommandTest.php
@@ -27,13 +27,11 @@ public static function providerTestRemoteDrushCommand(): array
         return [
             [
                 [
-                    '-vvv' => '',
                     'drush_command' => 'status --fields=db-status',
                 ],
             ],
             [
                 [
-                    '-vvv' => '',
                     'drush_command' => 'status --fields=db-status',
                 ],
             ],
@@ -42,7 +40,6 @@ public static function providerTestRemoteDrushCommand(): array
 
     /**
      * @dataProvider providerTestRemoteDrushCommand
-     * @group serial
      */
     public function testRemoteDrushCommand(array $args): void
     {

diff --git a/tests/phpunit/src/Misc/ExceptionListenerTest.php b/tests/phpunit/src/Misc/ExceptionListenerTest.php
@@ -42,6 +42,7 @@ public function testHelp(Throwable $error, string|array $helpText): void
         $applicationProphecy->setHelpMessages($messages)->shouldBeCalled();
         $commandProphecy->getApplication()
             ->willReturn($applicationProphecy->reveal());
+        $commandProphecy->getName()->willReturn('api:environments:log-download');
         $consoleErrorEvent = new ConsoleErrorEvent($this->input, $this->output, $error, $commandProphecy->reveal());
         $exceptionListener->onConsoleError($consoleErrorEvent);
         $this->prophet->checkPredictions();
@@ -137,6 +138,16 @@ public static function providerTestHelp(): array
                 ]),
                 'You can learn more about Cloud Platform API at https://docs.acquia.com/cloud-platform/develop/api/',
             ],
+            [
+                new ApiErrorException((object) [
+                    'error' => 'not_found',
+                    'message' => 'fdsa',
+                ]),
+                [
+                    'You must create logs (api:environments:log-create) prior to downloading them',
+                    'You can learn more about Cloud Platform API at https://docs.acquia.com/cloud-platform/develop/api/',
+                ],
+            ],
         ];
     }
 }
diff --git a/tests/phpunit/src/Misc/LocalMachineHelperTest.php b/tests/phpunit/src/Misc/LocalMachineHelperTest.php
@@ -40,7 +40,6 @@ public function testExecuteFromCmd(bool $interactive, bool|null $isTty, bool|nul
     {
         $localMachineHelper = $this->localMachineHelper;
         $localMachineHelper->setIsTty($isTty);
-        $this->input->setInteractive($interactive);
         $process = $localMachineHelper->executeFromCmd('echo "hello world"', null, null, $printOutput);
         $this->assertTrue($process->isSuccessful());
         assert(is_a($this->output, BufferedOutput::class));

diff --git a/tests/phpunit/src/TestBase.php b/tests/phpunit/src/TestBase.php
@@ -312,6 +312,7 @@ public static function getMockResponseFromSpec(mixed $path, mixed $method, mixed
 
     /**
      * @return array<mixed>
+     * @throws \Psr\Cache\InvalidArgumentException
      */
     protected function getPathMethodCodeFromSpec(string $operationId): array
     {
@@ -473,6 +474,9 @@ protected function createMockAcliConfigFile(mixed $cloudAppUuid = null): void
      *
      * Auto-completion and return type inferencing is provided by
      * .phpstorm.meta.php.
+     *
+     * @throws \JsonException
+     * @throws \Exception
      */
     protected function mockRequest(string $operationId, string|array|null $params = null, ?array $body = null, ?string $exampleResponse = null, Closure $tamper = null): object|array
     {