MC-40626: 'magento-patches status' command shows deprecated patch (#18)

Author: viktym

src/Command/Process/ShowStatus.php

@@ -7,7 +7,6 @@
 
 namespace Magento\CloudPatches\Command\Process;
 
-use Magento\CloudPatches\App\RuntimeException;
 use Magento\CloudPatches\Command\Process\Action\ReviewAppliedAction;
 use Magento\CloudPatches\Patch\Data\AggregatedPatchInterface;
 use Magento\CloudPatches\Patch\Pool\LocalPool;
@@ -89,18 +88,18 @@ public function run(InputInterface $input, OutputInterface $output)
             array_merge($this->optionalPool->getList(), $this->localPool->getList())
         );
         foreach ($patches as $patch) {
-            if ($patch->isDeprecated() && $this->statusPool->isApplied($patch->getId())) {
+            if ($patch->isDeprecated() && $this->isPatchVisible($patch)) {
                 $this->printDeprecatedWarning($output, $patch);
             }
         }
 
         $patches = array_filter(
             $patches,
             function ($patch) {
-                return !$patch->isDeprecated() || $this->statusPool->isApplied($patch->getId());
+                return !$patch->isDeprecated() || $this->isPatchVisible($patch);
             }
         );
-        $this->renderer->printTable($output, $patches);
+        $this->renderer->printTable($output, array_values($patches));
     }
 
     /**
@@ -138,4 +137,17 @@ private function printDeprecatedWarning(OutputInterface $output, AggregatedPatch
         );
         $output->writeln($message);
     }
+
+    /**
+     * Defines if the patch should be visible in the status table.
+     *
+     * @param AggregatedPatchInterface $patch
+     * @return bool
+     */
+    private function isPatchVisible(AggregatedPatchInterface $patch): bool
+    {
+        return $patch->getReplacedWith() ?
+            $this->statusPool->isApplied($patch->getId()) && !$this->statusPool->isApplied($patch->getReplacedWith()) :
+            $this->statusPool->isApplied($patch->getId());
+    }
 }

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

@@ -11,6 +11,7 @@
 use Magento\CloudPatches\Command\Process\Renderer;
 use Magento\CloudPatches\Command\Process\ShowStatus;
 use Magento\CloudPatches\Patch\Aggregator;
+use Magento\CloudPatches\Patch\Data\AggregatedPatch;
 use Magento\CloudPatches\Patch\Data\AggregatedPatchInterface;
 use Magento\CloudPatches\Patch\Data\PatchInterface;
 use Magento\CloudPatches\Patch\Pool\LocalPool;
@@ -89,17 +90,25 @@ protected function setUp()
      * Patch 1 - deprecated, applied - show warning message, show patch in the table;
      * Patch 2 - not deprecated, not applied - no warning message, show patch in the table;
      * Patch 3 - deprecated, not applied - no warning message, don't show patch in the table;
+     * Patch 4 - deprecated, applied and replaced with applied patch4-v2 - don't show patch in the table;
+     * Patch 5 - deprecated, applied and replaced with not applied patch5-v2 - show patch in the table;
      */
     public function testShowStatus()
     {
         $patch1 = $this->createPatch('patch1', true);
         $patch2 = $this->createPatch('patch2', false);
         $patch3 = $this->createPatch('patch3', true);
+        $patch4 = $this->createPatch('patch4', true, 'patch4-v2');
+        $patch5 = $this->createPatch('patch5', true, 'patch5-v2');
         $this->statusPool->method('isApplied')
             ->willReturnMap([
                 ['patch1', true],
                 ['patch2', false],
                 ['patch3', false],
+                ['patch4', true],
+                ['patch4-v2', true],
+                ['patch5', true],
+                ['patch5-v2', false],
             ]);
 
         /** @var InputInterface|MockObject $inputMock */
@@ -118,10 +127,10 @@ public function testShowStatus()
 
         $this->aggregator->expects($this->once())
             ->method('aggregate')
-            ->willReturn([$patch1, $patch2, $patch3]);
+            ->willReturn([$patch1, $patch2, $patch3, $patch4, $patch5]);
 
         // Show warning message about patch deprecation
-        $outputMock->expects($this->exactly(2))
+        $outputMock->expects($this->exactly(3))
             ->method('writeln')
             ->withConsecutive(
                 [$this->anything()],
@@ -131,7 +140,7 @@ public function testShowStatus()
         // Show patches in the table
         $this->renderer->expects($this->once())
             ->method('printTable')
-            ->withConsecutive([$outputMock, [$patch1, $patch2]]);
+            ->withConsecutive([$outputMock, [$patch1, $patch2, $patch5]]);
 
         $this->manager->run($inputMock, $outputMock);
     }
@@ -141,14 +150,18 @@ public function testShowStatus()
      *
      * @param string $id
      * @param bool $isDeprecated
-     *
+     * @param string $replacedWith
      * @return AggregatedPatchInterface|MockObject
      */
-    private function createPatch(string $id, bool $isDeprecated)
+    private function createPatch(string $id, bool $isDeprecated, string $replacedWith = '')
     {
-        $patch = $this->getMockForAbstractClass(AggregatedPatchInterface::class);
+        $patch = $this->createMock(AggregatedPatch::class);
         $patch->method('getId')->willReturn($id);
         $patch->method('isDeprecated')->willReturn($isDeprecated);
+        $patch->method('getReplacedWith')->willReturn($replacedWith);
+
+        // To make mock object unique for assertions and array operations.
+        $patch->id = microtime();
 
         return $patch;
     }