Add --format=json option to status command

Author: peterjaap

src/Command/Process/Action/ReviewAppliedAction.php

@@ -73,7 +73,7 @@ function ($patch) {
             $appliedOptionalPatches
         );
         $totalNumber = count(array_unique(array_merge($ids, $patchFilter)));
-        if ($totalNumber >= self::UPGRADE_THRESHOLD) {
+        if ($totalNumber >= self::UPGRADE_THRESHOLD && $input->getOption('format') !== 'json') {
             $message = 'Warning for those on a previous minor line! Magento recommends installing a limited'.
                 ' number of quality patches to ensure a smooth upgrade to the latest line. Please begin planning'.
                 ' an upgrade to the latest release line.';

src/Command/Process/Renderer.php

@@ -105,6 +105,30 @@ public function printTable(OutputInterface $output, array $patchList)
         $table->render();
     }
 
+    /**
+     * Renders patches list as JSON.
+     *
+     * @param OutputInterface $output
+     * @param AggregatedPatchInterface[] $patchList
+     * @return void
+     */
+    public function printJson(OutputInterface $output, array $patchList)
+    {
+        $rows = [];
+        foreach ($patchList as $patch) {
+            $rows[] = $this->createJsonRow($patch);
+        }
+
+        usort($rows, function ($a, $b) {
+            if ($a[self::STATUS] === $b[self::STATUS]) {
+                return strcmp($a[self::ORIGIN], $b[self::ORIGIN]);
+            }
+            return strcmp($a[self::STATUS], $b[self::STATUS]);
+        });
+
+        $output->writeln(json_encode($rows, JSON_PRETTY_PRINT));
+    }
+
     /**
      * Print patch info.
      *
@@ -209,6 +233,17 @@ function ($item) {
         ];
     }
 
+    /**
+     * Creates JSON row.
+     *
+     * @param AggregatedPatchInterface $patch
+     * @return array
+     */
+    private function createJsonRow(AggregatedPatchInterface $patch): array
+    {
+        return array_map('strip_tags', $this->createRow($patch));
+    }
+
     /**
      * Adds table separator.
      *

src/Command/Process/ShowStatus.php

@@ -7,6 +7,7 @@
 
 namespace Magento\CloudPatches\Command\Process;
 
+use Laminas\View\Renderer\JsonRenderer;
 use Magento\CloudPatches\Command\Process\Action\ReviewAppliedAction;
 use Magento\CloudPatches\Console\QuestionFactory;
 use Magento\CloudPatches\Patch\Data\AggregatedPatch;
@@ -18,6 +19,7 @@
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
 
 /**
  * Show information about available patches and their statuses.
@@ -103,15 +105,18 @@ public function __construct(
      */
     public function run(InputInterface $input, OutputInterface $output)
     {
-        $this->printDetailsInfo($output);
+        if ($input->getOption('format') !== 'json') {
+            $this->printDetailsInfo($output);
+        }
 
         $this->reviewAppliedAction->execute($input, $output, []);
 
         $patches = $this->aggregator->aggregate(
             array_merge($this->optionalPool->getList(), $this->localPool->getList())
         );
+
         foreach ($patches as $patch) {
-            if ($patch->isDeprecated() && $this->isPatchVisible($patch)) {
+            if ($patch->isDeprecated() && $this->isPatchVisible($patch) && $input->getOption('format') !== 'json') {
                 $this->printDeprecatedWarning($output, $patch);
             }
         }
@@ -124,7 +129,11 @@ public function run(InputInterface $input, OutputInterface $output)
             $patches = $this->filterByPatchCategory($input, $output, $patches);
         }
 
-        $this->renderer->printTable($output, array_values($patches));
+        if ($input->getOption('format') === 'json') {
+            $this->renderer->printJson($output, array_values($patches));
+        } else {
+            $this->renderer->printTable($output, array_values($patches));
+        }
     }
 
     /**

src/Command/Status.php

@@ -11,7 +11,9 @@
 use Magento\CloudPatches\Command\Process\ShowStatus;
 use Magento\CloudPatches\Composer\MagentoVersion;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
@@ -59,7 +61,8 @@ public function __construct(
     protected function configure()
     {
         $this->setName(self::NAME)
-            ->setDescription('Shows the list of available patches and their statuses');
+            ->setDescription('Shows the list of available patches and their statuses')
+            ->addOption('format', 'f', InputOption::VALUE_OPTIONAL, 'Output format', 'table');
 
         parent::configure();
     }
@@ -71,7 +74,9 @@ public function execute(InputInterface $input, OutputInterface $output)
     {
         try {
             $this->showStatus->run($input, $output);
-            $output->writeln('<info>' . $this->magentoVersion->get() . '</info>');
+            if ($input->getOption('format') !== 'json') {
+                $output->writeln('<info>' . $this->magentoVersion->get() . '</info>');
+            }
         } catch (RuntimeException $e) {
             $output->writeln('<error>' . $e->getMessage() . '</error>');
             $this->logger->error($e->getMessage());