MC-36033: Split ece-patches and magento-patches application

- fixes after CR

Author: viktym

composer.json

@@ -15,8 +15,10 @@
         "symfony/process": "^2.1||^4.1",
         "symfony/proxy-manager-bridge": "^3.3||^4.3",
         "symfony/yaml": "^3.3||^4.0",
-        "monolog/monolog": "^1.16",
-        "magento/quality-patches": "^1.0.0"
+        "monolog/monolog": "^1.16"
+    },
+    "suggest": {
+        "magento/quality-patches": "Need to retrieve Magento quality patches"
     },
     "require-dev": {
         "codeception/codeception": "^2.5.3",

config/services.xml

@@ -9,7 +9,6 @@
         <service id="Psr\Log\LoggerInterface" alias="Magento\CloudPatches\App\Logger" />
         <service id="Magento\CloudPatches\App\Container" autowire="false"/>
         <service id="Magento\CloudPatches\Filesystem\DirectoryList" autowire="false"/>
-        <service id="Magento\QualityPatches\Info"/>
         <service id="Symfony\Component\Console\Helper\QuestionHelper"/>
         <service id="Composer\Composer"/>
         <service id="Magento\CloudPatches\App\GenericException" autowire="false"/>
@@ -37,7 +36,7 @@
         <service id="Magento\CloudPatches\Command\Process\ShowStatus">
             <argument key="$statusPool" type="service" id="statusPool"/>
         </service>
-        <service id="Magento\CloudPatches\Command\Process\RevertEce">
+        <service id="Magento\CloudPatches\Command\Process\Ece\Revert">
             <argument key="$statusPool" type="service" id="statusPool"/>
         </service>
         <service id="Magento\CloudPatches\Command\Process\Action\ApplyOptionalAction">
@@ -73,7 +72,7 @@
         <service id="Magento\CloudPatches\Command\Process\ApplyOptional">
             <argument key="$actionPool" type="service" id="ApplyOptionalActionPool"/>
         </service>
-        <service id="Magento\CloudPatches\Command\Process\ApplyOptionalEce">
+        <service id="Magento\CloudPatches\Command\Process\Ece\ApplyOptional">
             <argument key="$actionPool" type="service" id="ApplyOptionalActionPool"/>
         </service>
         <service id="Magento\CloudPatches\Patch\PatchBuilder" shared="false"/>

src/ApplicationEce.php

@@ -40,8 +40,8 @@ public function __construct(ContainerInterface $container)
     protected function getDefaultCommands()
     {
         return array_merge(parent::getDefaultCommands(), [
-            $this->container->get(Command\ApplyEce::class),
-            $this->container->get(Command\RevertEce::class),
+            $this->container->get(Command\Ece\Apply::class),
+            $this->container->get(Command\Ece\Revert::class),
             $this->container->get(Command\Status::class)
         ]);
     }

src/Command/Apply.php

@@ -28,7 +28,7 @@ class Apply extends AbstractCommand
     /**
      * List of patches to apply.
      */
-    const ARG_LIST_OF_PATCHES = 'list_of_patches';
+    const ARG_LIST_OF_PATCHES = 'list-of-patches';
 
     /**
      * @var ApplyOptional

src/Command/ApplyEce.php renamed to src/Command/Ece/Apply.php

@@ -5,11 +5,12 @@
  */
 declare(strict_types=1);
 
-namespace Magento\CloudPatches\Command;
+namespace Magento\CloudPatches\Command\Ece;
 
 use Magento\CloudPatches\App\RuntimeException;
+use Magento\CloudPatches\Command\AbstractCommand;
 use Magento\CloudPatches\Command\Process\ApplyLocal;
-use Magento\CloudPatches\Command\Process\ApplyOptionalEce;
+use Magento\CloudPatches\Command\Process\Ece\ApplyOptional;
 use Magento\CloudPatches\Command\Process\ApplyRequired;
 use Magento\CloudPatches\Composer\MagentoVersion;
 use Psr\Log\LoggerInterface;
@@ -19,17 +20,17 @@
 /**
  * Patch apply command (Cloud).
  */
-class ApplyEce extends AbstractCommand
+class Apply extends AbstractCommand
 {
     /**
      * Command name.
      */
     const NAME = 'apply';
 
     /**
-     * @var ApplyOptionalEce
+     * @var ApplyOptional
      */
-    private $applyOptionalEce;
+    private $applyOptional;
 
     /**
      * @var ApplyRequired
@@ -53,20 +54,20 @@ class ApplyEce extends AbstractCommand
 
     /**
      * @param ApplyRequired $applyRequired
-     * @param ApplyOptionalEce $applyOptionalEce
+     * @param ApplyOptional $applyOptional
      * @param ApplyLocal $applyLocal
      * @param LoggerInterface $logger
      * @param MagentoVersion $magentoVersion
      */
     public function __construct(
         ApplyRequired $applyRequired,
-        ApplyOptionalEce $applyOptionalEce,
+        ApplyOptional $applyOptional,
         ApplyLocal $applyLocal,
         LoggerInterface $logger,
         MagentoVersion $magentoVersion
     ) {
         $this->applyRequired = $applyRequired;
-        $this->applyOptionalEce = $applyOptionalEce;
+        $this->applyOptional = $applyOptional;
         $this->applyLocal = $applyLocal;
         $this->logger = $logger;
         $this->magentoVersion = $magentoVersion;
@@ -94,7 +95,7 @@ public function execute(InputInterface $input, OutputInterface $output)
 
         try {
             $this->applyRequired->run($input, $output);
-            $this->applyOptionalEce->run($input, $output);
+            $this->applyOptional->run($input, $output);
             $this->applyLocal->run($input, $output);
         } catch (RuntimeException $e) {
             $output->writeln('<error>' . $e->getMessage() . '</error>');

src/Command/RevertEce.php renamed to src/Command/Ece/Revert.php

@@ -5,10 +5,11 @@
  */
 declare(strict_types=1);
 
-namespace Magento\CloudPatches\Command;
+namespace Magento\CloudPatches\Command\Ece;
 
 use Magento\CloudPatches\App\RuntimeException;
-use Magento\CloudPatches\Command\Process\RevertEce as RevertEceProcess;
+use Magento\CloudPatches\Command\AbstractCommand;
+use Magento\CloudPatches\Command\Process\Ece\Revert as RevertProcess;
 use Magento\CloudPatches\Composer\MagentoVersion;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Input\InputInterface;
@@ -17,17 +18,17 @@
 /**
  * Patch revert command (Cloud).
  */
-class RevertEce extends AbstractCommand
+class Revert extends AbstractCommand
 {
     /**
      * Command name.
      */
     const NAME = 'revert';
 
     /**
-     * @var RevertEceProcess
+     * @var RevertProcess
      */
-    private $revertEce;
+    private $revert;
 
     /**
      * @var LoggerInterface
@@ -40,16 +41,16 @@ class RevertEce extends AbstractCommand
     private $magentoVersion;
 
     /**
-     * @param RevertEceProcess $revertEce
+     * @param RevertProcess $revert
      * @param LoggerInterface $logger
      * @param MagentoVersion $magentoVersion
      */
     public function __construct(
-        RevertEceProcess $revertEce,
+        RevertProcess $revert,
         LoggerInterface $logger,
         MagentoVersion $magentoVersion
     ) {
-        $this->revertEce = $revertEce;
+        $this->revert = $revert;
         $this->logger = $logger;
         $this->magentoVersion = $magentoVersion;
 
@@ -75,7 +76,7 @@ public function execute(InputInterface $input, OutputInterface $output)
         $this->logger->notice($this->magentoVersion->get());
 
         try {
-            $this->revertEce->run($input, $output);
+            $this->revert->run($input, $output);
         } catch (RuntimeException $e) {
             $output->writeln('<error>' . $e->getMessage() . '</error>');
             $this->logger->error($e->getMessage());

src/Command/Process/ApplyLocal.php

@@ -89,7 +89,7 @@ public function run(InputInterface $input, OutputInterface $output)
                 $this->printInfo($output, $message);
                 array_push($appliedPatches, $patch);
             } catch (ApplierException $exception) {
-                $this->printInfo($output, 'Error: patch conflict happened');
+                $this->printError($output, 'Error: patch conflict happened');
                 $messages = $this->rollbackProcessor->process($appliedPatches);
                 $output->writeln($messages);
                 $errorMessage = sprintf(
@@ -116,4 +116,16 @@ private function printInfo(OutputInterface $output, string $message)
         $output->writeln('<info>' . $message . '</info>');
         $this->logger->info($message);
     }
+
+    /**
+     * Prints and logs error message.
+     *
+     * @param OutputInterface $output
+     * @param string $message
+     */
+    private function printError(OutputInterface $output, string $message)
+    {
+        $output->writeln('<error>' . $message . '</error>');
+        $this->logger->error($message);
+    }
 }

src/Command/Process/ApplyOptionalEce.php renamed to src/Command/Process/Ece/ApplyOptional.php

@@ -5,9 +5,10 @@
  */
 declare(strict_types=1);
 
-namespace Magento\CloudPatches\Command\Process;
+namespace Magento\CloudPatches\Command\Process\Ece;
 
 use Magento\CloudPatches\Command\Process\Action\ActionPool;
+use Magento\CloudPatches\Command\Process\ProcessInterface;
 use Magento\CloudPatches\Environment\Config;
 use Magento\CloudPatches\Patch\FilterFactory;
 use Psr\Log\LoggerInterface;
@@ -17,7 +18,7 @@
 /**
  * Applies optional patches (Cloud).
  */
-class ApplyOptionalEce implements ProcessInterface
+class ApplyOptional implements ProcessInterface
 {
     /**
      * @var FilterFactory

src/Command/Process/RevertEce.php renamed to src/Command/Process/Ece/Revert.php

@@ -5,10 +5,12 @@
  */
 declare(strict_types=1);
 
-namespace Magento\CloudPatches\Command\Process;
+namespace Magento\CloudPatches\Command\Process\Ece;
 
 use Magento\CloudPatches\App\RuntimeException;
 use Magento\CloudPatches\Command\Process\Action\RevertAction;
+use Magento\CloudPatches\Command\Process\ProcessInterface;
+use Magento\CloudPatches\Command\Process\Renderer;
 use Magento\CloudPatches\Patch\Applier;
 use Magento\CloudPatches\Patch\ApplierException;
 use Magento\CloudPatches\Patch\Pool\LocalPool;
@@ -20,7 +22,7 @@
 /**
  * Reverts all patches (Cloud).
  */
-class RevertEce implements ProcessInterface
+class Revert implements ProcessInterface
 {
     /**
      * @var RevertAction
@@ -53,7 +55,7 @@ class RevertEce implements ProcessInterface
     private $statusPool;
 
     /**
-     * @param Action\RevertAction $revertAction
+     * @param RevertAction $revertAction
      * @param LoggerInterface $logger
      * @param Applier $applier
      * @param LocalPool $localPool

src/Command/Revert.php

@@ -29,7 +29,7 @@ class Revert extends AbstractCommand
     /**
      * List of patches to revert.
      */
-    const ARG_LIST_OF_PATCHES = 'list_of_patches';
+    const ARG_LIST_OF_PATCHES = 'list-of-patches';
 
     /**
      * Revert all patches.

src/Composer/QualityPackage.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudPatches\Composer;
+
+/**
+ * Provides info from magento/quality-patches package.
+ */
+class QualityPackage
+{
+    /**
+     * @var string|null
+     */
+    private $patchesDirectory;
+
+    /**
+     * @var string|null
+     */
+    private $patchesConfig;
+
+    /**
+     * QualityPackage constructor
+     */
+    public function __construct()
+    {
+        if (class_exists(\Magento\QualityPatches\Info::class)) {
+            $info = new \Magento\QualityPatches\Info();
+            $this->patchesDirectory = $info->getPatchesDirectory();
+            $this->patchesConfig = $info->getPatchesConfig();
+        }
+    }
+
+    /**
+     * Returns path to patches directory.
+     *
+     * @return string|null
+     */
+    public function getPatchesDirectory()
+    {
+        return $this->patchesDirectory;
+    }
+
+    /**
+     * Returns path to patches configuration file.
+     *
+     * @return string|null
+     */
+    public function getPatchesConfig()
+    {
+        return $this->patchesConfig;
+    }
+}

src/Patch/Collector/QualityCollector.php

@@ -7,13 +7,13 @@
 
 namespace Magento\CloudPatches\Patch\Collector;
 
+use Magento\CloudPatches\Composer\QualityPackage;
 use Magento\CloudPatches\Patch\Data\PatchInterface;
 use Magento\CloudPatches\Composer\Package;
 use Magento\CloudPatches\Patch\PatchBuilder;
 use Magento\CloudPatches\Patch\PatchIntegrityException;
 use Magento\CloudPatches\Patch\SourceProvider;
 use Magento\CloudPatches\Patch\SourceProviderException;
-use Magento\QualityPatches\Info as QualityPatchesInfo;
 
 /**
  * Collects patches.
@@ -59,9 +59,9 @@ class QualityCollector
     private $package;
 
     /**
-     * @var QualityPatchesInfo
+     * @var QualityPackage
      */
-    private $qualityPatchesInfo;
+    private $qualityPackage;
 
     /**
      * @var array|null
@@ -76,18 +76,18 @@ class QualityCollector
     /**
      * @param SourceProvider $sourceProvider
      * @param Package $package
-     * @param QualityPatchesInfo $qualityPatchesInfo
+     * @param QualityPackage $qualityPackage
      * @param PatchBuilder $patchBuilder
      */
     public function __construct(
         SourceProvider $sourceProvider,
         Package $package,
-        QualityPatchesInfo $qualityPatchesInfo,
+        QualityPackage $qualityPackage,
         PatchBuilder $patchBuilder
     ) {
         $this->sourceProvider = $sourceProvider;
         $this->package = $package;
-        $this->qualityPatchesInfo = $qualityPatchesInfo;
+        $this->qualityPackage = $qualityPackage;
         $this->patchBuilder = $patchBuilder;
     }
 
@@ -204,7 +204,7 @@ private function createPatch(
         bool $patchDeprecated
     ): PatchInterface {
         try {
-            $patchPath = $this->qualityPatchesInfo->getPatchesDirectory() . '/' . $patchFile;
+            $patchPath = $this->qualityPackage->getPatchesDirectory() . '/' . $patchFile;
             $this->patchBuilder->setId($patchId);
             $this->patchBuilder->setTitle($patchTitle);
             $this->patchBuilder->setFilename($patchFile);