Merge pull request #63 from magento-commerce/imported-peterjaap-magento-cloud-patches-86

Author: BaDos

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

@@ -8,6 +8,7 @@
 namespace Magento\CloudPatches\Command\Process;
 
 use Magento\CloudPatches\Command\Process\Action\ReviewAppliedAction;
+use Magento\CloudPatches\Composer\MagentoVersion;
 use Magento\CloudPatches\Console\QuestionFactory;
 use Magento\CloudPatches\Patch\Data\AggregatedPatch;
 use Magento\CloudPatches\Patch\Data\AggregatedPatchInterface;
@@ -28,6 +29,8 @@ class ShowStatus implements ProcessInterface
 
     const FILTER_OPTION_ALL = 'All';
 
+    const FORMAT_JSON = 'json';
+
     /**
      * @var Aggregator
      */
@@ -43,6 +46,11 @@ class ShowStatus implements ProcessInterface
      */
     private $localPool;
 
+    /**
+     * @var MagentoVersion
+     */
+    private $magentoVersion;
+
     /**
      * @var StatusPool
      */
@@ -86,7 +94,8 @@ public function __construct(
         ReviewAppliedAction $reviewAppliedAction,
         Renderer $renderer,
         QuestionHelper $questionHelper,
-        QuestionFactory $questionFactory
+        QuestionFactory $questionFactory,
+        MagentoVersion $magentoVersion
     ) {
         $this->aggregator = $aggregator;
         $this->optionalPool = $optionalPool;
@@ -96,35 +105,44 @@ public function __construct(
         $this->renderer = $renderer;
         $this->questionHelper = $questionHelper;
         $this->questionFactory = $questionFactory;
+        $this->magentoVersion = $magentoVersion;
     }
 
     /**
      * @inheritDoc
      */
     public function run(InputInterface $input, OutputInterface $output)
     {
-        $this->printDetailsInfo($output);
-
-        $this->reviewAppliedAction->execute($input, $output, []);
-
+        $isJsonFormat = $input->getOption('format') === self::FORMAT_JSON;
         $patches = $this->aggregator->aggregate(
             array_merge($this->optionalPool->getList(), $this->localPool->getList())
         );
-        foreach ($patches as $patch) {
-            if ($patch->isDeprecated() && $this->isPatchVisible($patch)) {
-                $this->printDeprecatedWarning($output, $patch);
+
+        if (!$isJsonFormat) {
+            $this->printDetailsInfo($output);
+            $this->reviewAppliedAction->execute($input, $output, []);
+            foreach ($patches as $patch) {
+                if ($patch->isDeprecated() && $this->isPatchVisible($patch)) {
+                    $this->printDeprecatedWarning($output, $patch);
+                }
             }
         }
+
         $patches = $this->filterNotVisiblePatches($patches);
 
-        if (count($patches) > self::INTERACTIVE_FILTER_THRESHOLD) {
+        if (!$isJsonFormat && count($patches) > self::INTERACTIVE_FILTER_THRESHOLD) {
             $this->printPatchProviders($output, $patches);
             $patches = $this->filterByPatchProvider($input, $output, $patches);
             $this->printCategoriesInfo($output, $patches);
             $patches = $this->filterByPatchCategory($input, $output, $patches);
         }
 
-        $this->renderer->printTable($output, array_values($patches));
+        if ($isJsonFormat) {
+            $this->renderer->printJson($output, array_values($patches));
+        } else {
+            $this->renderer->printTable($output, array_values($patches));
+            $output->writeln('<info>' . $this->magentoVersion->get() . '</info>');
+        }
     }
 
     /**

src/Command/Status.php

@@ -9,9 +9,10 @@
 
 use Magento\CloudPatches\App\RuntimeException;
 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;
 
 /**
@@ -31,24 +32,16 @@ class Status extends AbstractCommand
      */
     private $logger;
 
-    /**
-     * @var MagentoVersion
-     */
-    private $magentoVersion;
-
     /**
      * @param ShowStatus $showStatus
      * @param LoggerInterface $logger
-     * @param MagentoVersion $magentoVersion
      */
     public function __construct(
         ShowStatus $showStatus,
-        LoggerInterface $logger,
-        MagentoVersion $magentoVersion
+        LoggerInterface $logger
     ) {
         $this->showStatus = $showStatus;
         $this->logger = $logger;
-        $this->magentoVersion = $magentoVersion;
 
         parent::__construct(self::NAME);
     }
@@ -59,7 +52,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 +65,6 @@ public function execute(InputInterface $input, OutputInterface $output)
     {
         try {
             $this->showStatus->run($input, $output);
-            $output->writeln('<info>' . $this->magentoVersion->get() . '</info>');
         } catch (RuntimeException $e) {
             $output->writeln('<error>' . $e->getMessage() . '</error>');
             $this->logger->error($e->getMessage());

src/Test/Unit/Command/Process/ShowStatusTest.php

@@ -10,6 +10,7 @@
 use Magento\CloudPatches\Command\Process\Action\ReviewAppliedAction;
 use Magento\CloudPatches\Command\Process\Renderer;
 use Magento\CloudPatches\Command\Process\ShowStatus;
+use Magento\CloudPatches\Composer\MagentoVersion;
 use Magento\CloudPatches\Console\QuestionFactory;
 use Magento\CloudPatches\Patch\Aggregator;
 use Magento\CloudPatches\Patch\Data\AggregatedPatch;
@@ -88,6 +89,8 @@ protected function setUp(): void
         $this->renderer = $this->createMock(Renderer::class);
         $this->questionHelper = $this->createMock(QuestionHelper::class);
         $this->questionFactory = $this->createMock(QuestionFactory::class);
+        /** @var MagentoVersion|MockObject $magentoVersion */
+        $magentoVersion = $this->createMock(MagentoVersion::class);
 
         $this->manager = new ShowStatus(
             $this->aggregator,
@@ -97,7 +100,8 @@ protected function setUp(): void
             $this->reviewAppliedAction,
             $this->renderer,
             $this->questionHelper,
-            $this->questionFactory
+            $this->questionFactory,
+            $magentoVersion
         );
     }
 
@@ -147,7 +151,7 @@ public function testShowStatus()
             ->willReturn([$patch1, $patch2, $patch3, $patch4, $patch5]);
 
         // Show warning message about patch deprecation
-        $outputMock->expects($this->exactly(3))
+        $outputMock->expects($this->exactly(4))
             ->method('writeln')
             ->withConsecutive(
                 [$this->anything()],

src/Test/Unit/Command/StatusTest.php

@@ -12,7 +12,6 @@
 use Magento\CloudPatches\Command\Apply;
 use Magento\CloudPatches\Command\Process\ShowStatus;
 use Magento\CloudPatches\Command\Status;
-use Magento\CloudPatches\Composer\MagentoVersion;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
@@ -46,13 +45,10 @@ protected function setUp(): void
     {
         $this->showStatus = $this->createMock(ShowStatus::class);
         $this->logger = $this->getMockForAbstractClass(LoggerInterface::class);
-        /** @var MagentoVersion|MockObject $magentoVersion */
-        $magentoVersion = $this->createMock(MagentoVersion::class);
 
         $this->command = new Status(
             $this->showStatus,
-            $this->logger,
-            $magentoVersion
+            $this->logger
         );
     }