MC-5465: Refactoring module operations to use abstract class

pdohogne-magento · pdohogne-magento · commit 438434856141 · 2019-05-21T11:45:03.000-05:00
diff --git a/docs/class_descriptions.md b/docs/class_descriptions.md
@@ -109,9 +109,16 @@ Classes in this namespace deal with installing the plugin inside the project's `
   
 When the Web Setup Wizard runs an upgrade operation, it first tries to validate the upgrade by copying the `composer.json` file into the `var` directory and attempting a dry-run upgrade. However, because it only copies the `composer.json` file and not any of the other code in the installation (including the plugin's root installation in `vendor`), the plugin will not function for this dry run. In order to enable the plugin, it needs to already be present in `var/vendor`, where the Wizard's `composer require` for the validation will find it.
 
+#### [**AbstractModuleOperation**](../src/Magento/ComposerRootUpdatePlugin/Setup/AbstractModuleOperation.php)
+
+This abstract class allows extending Magento module operation classes to trigger [WebSetupWizardPluginInstaller::doVarInstall()](#websetupwizardplugininstaller).
+
+ - **`doVarInstall()`**
+   - Helper method for extending classes to setup and call `WebSetupWizardPluginInstaller::doVarInstall()`
+
 #### **[InstallData](../src/Magento/ComposerRootUpdatePlugin/Setup/InstallData.php)/[RecurringData](../src/Magento/ComposerRootUpdatePlugin/Setup/RecurringData.php)/[UpgradeData](../src/Magento/ComposerRootUpdatePlugin/Setup/UpgradeData.php)**
 
-These are Magento module setup classes to trigger [WebSetupWizardPluginInstaller::doVarInstall()](#websetupwizardplugininstaller) on `bin/magento setup` commands. Specifically, this is necessary when the `bin/magento setup:uninstall` and `bin/magento setup:install` commands are run, which would otherwise remove the plugin from the `var` directory without triggering the Composer package events that would normally install the plugin there.
+These are Magento module setup classes to trigger `AbstractModuleOperation::doVarInstall()` on `bin/magento setup` commands. Specifically, this is necessary when the `bin/magento setup:uninstall` and `bin/magento setup:install` commands are run, which would otherwise remove the plugin from the `var` directory without triggering the Composer package events that would normally install the plugin there.
      
 #### [**WebSetupWizardPluginInstaller**](../src/Magento/ComposerRootUpdatePlugin/Setup/WebSetupWizardPluginInstaller.php)
 
diff --git a/docs/process_flows.md b/docs/process_flows.md
@@ -73,7 +73,7 @@ There are four paths through the plugin code that cover two main pieces of funct
 1. The `"autoload"->"files": "registration.php"` value in the plugin's [composer.json](../src/Magento/ComposerRootUpdatePlugin/composer.json) file causes [registration.php](../src/Magento/ComposerRootUpdatePlugin/registration.php) to be loaded by Magento
 2. `registration.php` registers the plugin as the `Magento_ComposerRootUpdatePlugin` module so it can tie into the `bin/magento setup` module operations
 3. Magento searches registered modules for any `Setup\InstallData`, `Setup\RecurringData`, or `Setup\UpgradeData` classes
-4. Magento calls [InstallData::install()](class_descriptions.md#installdatarecurringdataupgradedata), [RecurringData::install()](class_descriptions.md#installdatarecurringdataupgradedata), or [UpgradeData::upgrade()](class_descriptions.md#installdatarecurringdataupgradedata) as appropriate (which one depends on the specific `bin/magento setup` command and installed Magento version), which then calls [WebSetupWizardPluginInstaller::doVarInstall()](class_descriptions.md#websetupwizardplugininstaller)
+4. Magento calls [InstallData::install()](class_descriptions.md#installdatarecurringdataupgradedata), [RecurringData::install()](class_descriptions.md#installdatarecurringdataupgradedata), or [UpgradeData::upgrade()](class_descriptions.md#installdatarecurringdataupgradedata) as appropriate (which one depends on the specific `bin/magento setup` command and installed Magento version), which then calls [WebSetupWizardPluginInstaller::doVarInstall()](class_descriptions.md#websetupwizardplugininstaller) through [AbstractModuleOperation::doVarInstall()](class_descriptions.md#abstractmoduleoperation)
 5. `WebSetupWizardPluginInstaller::doVarInstall()` finds the `magento/composer-root-update-plugin` version in the `composer.lock` file in the root Magento directory and calls `WebSetupWizardPluginInstaller::updateSetupWizardPlugin()`
 6. `WebSetupWizardPluginInstaller::updateSetupWizardPlugin()` checks the `<Magento>/var/vendor` directory for the `magento/composer-root-update-plugin` version installed there (if any) to see if it matches the version in the root `composer.lock` file
 7. If the version does not match or `magento/composer-root-update-plugin` is absent in `<Magento>/var/vendor`, `WebSetupWizardPluginInstaller::updateSetupWizardPlugin()` installs the root project's `magento/composer-root-update-plugin` version in a temporary directory, then replaces `<Magento>/var/vendor` with the `vendor` directory from the temporary installation
diff --git a/src/Magento/ComposerRootUpdatePlugin/ComposerReimplementation/ExtendableRequireCommand.php b/src/Magento/ComposerRootUpdatePlugin/ComposerReimplementation/ExtendableRequireCommand.php
@@ -35,12 +35,12 @@ abstract class ExtendableRequireCommand extends RequireCommand
     protected $jsonFile;
 
     /**
-     * @var boolean $mageNewlyCreated
+     * @var bool $mageNewlyCreated
      */
     protected $mageNewlyCreated;
 
     /**
-     * @var boolean|string $mageComposerBackup
+     * @var bool|string $mageComposerBackup
      */
     protected $mageComposerBackup;
 
diff --git a/src/Magento/ComposerRootUpdatePlugin/Plugin/Commands/MageRootRequireCommand.php b/src/Magento/ComposerRootUpdatePlugin/Plugin/Commands/MageRootRequireCommand.php
@@ -234,7 +234,7 @@ public function execute(InputInterface $input, OutputInterface $output)
      * @param InputInterface $input
      * @param string $targetEdition
      * @param string $targetConstraint
-     * @return boolean Returns true if updates were necessary and prepared successfully
+     * @return bool Returns true if updates were necessary and prepared successfully
      */
     protected function runUpdate($updater, $input, $targetEdition, $targetConstraint)
     {
diff --git a/src/Magento/ComposerRootUpdatePlugin/Plugin/PluginDefinition.php b/src/Magento/ComposerRootUpdatePlugin/Plugin/PluginDefinition.php
@@ -13,7 +13,7 @@
 use Composer\IO\IOInterface;
 use Composer\Plugin\Capability\CommandProvider as CommandProviderCapability;
 use Composer\Plugin\Capable;
-use Composer\Plugin\PluginInterface;;
+use Composer\Plugin\PluginInterface;
 use Magento\ComposerRootUpdatePlugin\Setup\WebSetupWizardPluginInstaller;
 use Magento\ComposerRootUpdatePlugin\Utils\Console;
 
diff --git a/src/Magento/ComposerRootUpdatePlugin/Setup/AbstractModuleOperation.php b/src/Magento/ComposerRootUpdatePlugin/Setup/AbstractModuleOperation.php
@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\ComposerRootUpdatePlugin\Setup;
+
+use Composer\IO\ConsoleIO;
+use Magento\ComposerRootUpdatePlugin\Utils\Console;
+use Magento\Framework\Setup\ModuleContextInterface;
+use Magento\Framework\Setup\ModuleDataSetupInterface;
+use Symfony\Component\Console\Helper\DebugFormatterHelper;
+use Symfony\Component\Console\Helper\FormatterHelper;
+use Symfony\Component\Console\Helper\HelperSet;
+use Symfony\Component\Console\Helper\ProcessHelper;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\ConsoleOutput;
+use Symfony\Component\Console\Output\OutputInterface;
+
+abstract class AbstractModuleOperation
+{
+    public function doVarInstall(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
+    {
+        $io = new ConsoleIO(new ArrayInput([]),
+            new ConsoleOutput(OutputInterface::VERBOSITY_DEBUG),
+            new HelperSet([
+                new FormatterHelper(),
+                new DebugFormatterHelper(),
+                new ProcessHelper(),
+                new QuestionHelper()
+            ])
+        );
+        $setupWizardInstaller = new WebSetupWizardPluginInstaller(new Console($io));
+        $setupWizardInstaller->doVarInstall();
+    }
+}
diff --git a/src/Magento/ComposerRootUpdatePlugin/Setup/InstallData.php b/src/Magento/ComposerRootUpdatePlugin/Setup/InstallData.php
@@ -6,24 +6,14 @@
 
 namespace Magento\ComposerRootUpdatePlugin\Setup;
 
-use Composer\IO\ConsoleIO;
-use Magento\ComposerRootUpdatePlugin\Utils\Console;
 use Magento\Framework\Setup\InstallDataInterface;
 use Magento\Framework\Setup\ModuleContextInterface;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
-use Symfony\Component\Console\Helper\DebugFormatterHelper;
-use Symfony\Component\Console\Helper\FormatterHelper;
-use Symfony\Component\Console\Helper\HelperSet;
-use Symfony\Component\Console\Helper\ProcessHelper;
-use Symfony\Component\Console\Helper\QuestionHelper;
-use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Output\ConsoleOutput;
-use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * Magento module hook to attach plugin installation functionality to `magento setup` operations
  */
-class InstallData implements InstallDataInterface
+class InstallData extends AbstractModuleOperation implements InstallDataInterface
 {
     /**
      * Passthrough Magento setup command to check the plugin installation in the var directory
@@ -34,16 +24,6 @@ class InstallData implements InstallDataInterface
      */
     public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
     {
-        $io = new ConsoleIO(new ArrayInput([]),
-            new ConsoleOutput(OutputInterface::VERBOSITY_DEBUG),
-            new HelperSet([
-                new FormatterHelper(),
-                new DebugFormatterHelper(),
-                new ProcessHelper(),
-                new QuestionHelper()
-            ])
-        );
-        $setupWizardInstaller = new WebSetupWizardPluginInstaller(new Console($io));
-        $setupWizardInstaller->doVarInstall();
+        $this->doVarInstall($setup, $context);
     }
 }
diff --git a/src/Magento/ComposerRootUpdatePlugin/Setup/RecurringData.php b/src/Magento/ComposerRootUpdatePlugin/Setup/RecurringData.php
@@ -6,24 +6,14 @@
 
 namespace Magento\ComposerRootUpdatePlugin\Setup;
 
-use Composer\IO\ConsoleIO;
-use Magento\ComposerRootUpdatePlugin\Utils\Console;
 use Magento\Framework\Setup\InstallDataInterface;
 use Magento\Framework\Setup\ModuleContextInterface;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
-use Symfony\Component\Console\Helper\DebugFormatterHelper;
-use Symfony\Component\Console\Helper\FormatterHelper;
-use Symfony\Component\Console\Helper\HelperSet;
-use Symfony\Component\Console\Helper\ProcessHelper;
-use Symfony\Component\Console\Helper\QuestionHelper;
-use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Output\ConsoleOutput;
-use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * Magento module hook to attach plugin installation functionality to `magento setup` operations
  */
-class RecurringData implements InstallDataInterface
+class RecurringData extends AbstractModuleOperation implements InstallDataInterface
 {
     /**
      * Passthrough Magento setup command to check the plugin installation in the var directory
@@ -34,16 +24,6 @@ class RecurringData implements InstallDataInterface
      */
     public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
     {
-        $io = new ConsoleIO(new ArrayInput([]),
-            new ConsoleOutput(OutputInterface::VERBOSITY_DEBUG),
-            new HelperSet([
-                new FormatterHelper(),
-                new DebugFormatterHelper(),
-                new ProcessHelper(),
-                new QuestionHelper()
-            ])
-        );
-        $setupWizardInstaller = new WebSetupWizardPluginInstaller(new Console($io));
-        $setupWizardInstaller->doVarInstall();
+        $this->doVarInstall($setup, $context);
     }
 }
diff --git a/src/Magento/ComposerRootUpdatePlugin/Setup/UpgradeData.php b/src/Magento/ComposerRootUpdatePlugin/Setup/UpgradeData.php
@@ -6,24 +6,14 @@
 
 namespace Magento\ComposerRootUpdatePlugin\Setup;
 
-use Composer\IO\ConsoleIO;
-use Magento\ComposerRootUpdatePlugin\Utils\Console;
 use Magento\Framework\Setup\ModuleContextInterface;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Magento\Framework\Setup\UpgradeDataInterface;
-use Symfony\Component\Console\Helper\DebugFormatterHelper;
-use Symfony\Component\Console\Helper\FormatterHelper;
-use Symfony\Component\Console\Helper\HelperSet;
-use Symfony\Component\Console\Helper\ProcessHelper;
-use Symfony\Component\Console\Helper\QuestionHelper;
-use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Output\ConsoleOutput;
-use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * Magento module hook to attach plugin installation functionality to `magento setup` operations
  */
-class UpgradeData implements UpgradeDataInterface
+class UpgradeData extends AbstractModuleOperation implements UpgradeDataInterface
 {
     /**
      * Passthrough Magento setup command to check the plugin installation in the var directory
@@ -34,16 +24,6 @@ class UpgradeData implements UpgradeDataInterface
      */
     public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
     {
-        $io = new ConsoleIO(new ArrayInput([]),
-            new ConsoleOutput(OutputInterface::VERBOSITY_DEBUG),
-            new HelperSet([
-                new FormatterHelper(),
-                new DebugFormatterHelper(),
-                new ProcessHelper(),
-                new QuestionHelper()
-            ])
-        );
-        $setupWizardInstaller = new WebSetupWizardPluginInstaller(new Console($io));
-        $setupWizardInstaller->doVarInstall();
+        $this->doVarInstall($setup, $context);
     }
 }
diff --git a/src/Magento/ComposerRootUpdatePlugin/Setup/WebSetupWizardPluginInstaller.php b/src/Magento/ComposerRootUpdatePlugin/Setup/WebSetupWizardPluginInstaller.php
@@ -123,7 +123,7 @@ public function doVarInstall()
      * @param Composer $composer
      * @param string $filePath
      * @param string $pluginVersion
-     * @return boolean
+     * @return bool
      * @throws Exception
      */
     public function updateSetupWizardPlugin($composer, $filePath, $pluginVersion)
diff --git a/src/Magento/ComposerRootUpdatePlugin/Updater/DeltaResolver.php b/src/Magento/ComposerRootUpdatePlugin/Updater/DeltaResolver.php
@@ -30,7 +30,7 @@ class DeltaResolver
     protected $console;
     
     /**
-     * @var boolean $overrideUserValues
+     * @var bool $overrideUserValues
      */
     protected $overrideUserValues;
 
@@ -63,7 +63,7 @@ class DeltaResolver
      * DeltaResolver constructor.
      *
      * @param Console $console
-     * @param boolean $overrideUserValues
+     * @param bool $overrideUserValues
      * @param RootPackageRetriever $retriever
      * @return void
      */
diff --git a/src/Magento/ComposerRootUpdatePlugin/Updater/MagentoRootUpdater.php b/src/Magento/ComposerRootUpdatePlugin/Updater/MagentoRootUpdater.php
@@ -50,11 +50,11 @@ public function __construct($console, $composer)
      * Look ahead to the target Magento version and execute any changes to the root composer.json file in-memory
      *
      * @param RootPackageRetriever $retriever
-     * @param boolean $overrideOption
-     * @param boolean $ignorePlatformReqs
+     * @param bool $overrideOption
+     * @param bool $ignorePlatformReqs
      * @param string $phpVersion
      * @param string $stability
-     * @return boolean Returns true if updates were necessary and prepared successfully
+     * @return bool Returns true if updates were necessary and prepared successfully
      */
     public function runUpdate(
         $retriever,
diff --git a/src/Magento/ComposerRootUpdatePlugin/Updater/RootPackageRetriever.php b/src/Magento/ComposerRootUpdatePlugin/Updater/RootPackageRetriever.php
@@ -47,7 +47,7 @@ class RootPackageRetriever
     protected $originalRootPackage;
 
     /**
-     * @var boolean $fetchedOriginal
+     * @var bool $fetchedOriginal
      */
     protected $fetchedOriginal;
 
@@ -57,7 +57,7 @@ class RootPackageRetriever
     protected $targetRootPackage;
 
     /**
-     * @var boolean $fetchedTarget
+     * @var bool $fetchedTarget
      */
     protected $fetchedTarget;
 
@@ -135,8 +135,8 @@ public function __construct(
     /**
      * Get the project package that should be used as the basis for Magento root comparisons
      *
-     * @param boolean $overrideOption
-     * @return PackageInterface|boolean
+     * @param bool $overrideOption
+     * @return PackageInterface|bool
      */
     public function getOriginalRootPackage($overrideOption)
     {
@@ -231,10 +231,10 @@ public function getUserRootPackage()
      *
      * @param string $edition
      * @param string $constraint
-     * @param boolean $ignorePlatformReqs
+     * @param bool $ignorePlatformReqs
      * @param string $phpVersion
      * @param string $preferredStability
-     * @return PackageInterface|boolean Best root package candidate or false if no valid packages found
+     * @return PackageInterface|bool Best root package candidate or false if no valid packages found
      */
     protected function fetchMageRootFromRepo(
         $edition,
diff --git a/src/Magento/ComposerRootUpdatePlugin/Utils/Console.php b/src/Magento/ComposerRootUpdatePlugin/Utils/Console.php
@@ -42,15 +42,15 @@ class Console
     protected $verboseLabel;
 
     /**
-     * @var boolean $interactive
+     * @var bool $interactive
      */
     protected $interactive;
 
     /**
      * Console constructor.
      *
      * @param IOInterface $io
-     * @param boolean $interactive
+     * @param bool $interactive
      * @param string $verboseLabel
      * @return void
      */
@@ -78,7 +78,7 @@ public function getIO()
     /**
      * Whether or not ask() should interactively ask the question or just return the default value
      *
-     * @param boolean $interactive
+     * @param bool $interactive
      * @return void
      */
     public function setInteractive($interactive)
@@ -92,8 +92,8 @@ public function setInteractive($interactive)
      * If the console is not interactive, instead do not ask and just return the default
      *
      * @param string $question
-     * @param boolean $default
-     * @return boolean
+     * @param bool $default
+     * @return bool
      */
     public function ask($question, $default = false)
     {
diff --git a/src/Magento/ComposerRootUpdatePlugin/Utils/PackageUtils.php b/src/Magento/ComposerRootUpdatePlugin/Utils/PackageUtils.php
@@ -57,7 +57,7 @@ static public function getMagentoProductEdition($packageName)
      *
      * @param Composer $composer
      * @param string $packageMatcher
-     * @return Link|boolean
+     * @return Link|bool
      */
     static public function findRequire($composer, $packageMatcher)
     {
@@ -84,7 +84,7 @@ static public function findRequire($composer, $packageMatcher)
      * Is the given constraint strict or does it allow multiple versions
      *
      * @param string $constraint
-     * @return boolean
+     * @return bool
      */
     static public function isConstraintStrict($constraint)
     {
diff --git a/tests/Unit/Magento/ComposerRootUpdatePlugin/TestHelpers/TestApplication.php b/tests/Unit/Magento/ComposerRootUpdatePlugin/TestHelpers/TestApplication.php
@@ -15,7 +15,7 @@
 class TestApplication extends \Composer\Console\Application
 {
     /**
-     * @var boolean
+     * @var bool
      */
     private $shouldRun = false;
 
@@ -38,7 +38,7 @@ public function setComposer(Composer $composer)
     /**
      * Set whether or not doRunCommand should actually be run or not
      *
-     * @param boolean $shouldRun
+     * @param bool $shouldRun
      * @return void
      */
     public function setShouldRun($shouldRun)

Original file line number	Diff line number	Diff line change
`@@ -234,7 +234,7 @@ public function execute(InputInterface $input, OutputInterface $output)`
`234`	`234`	`* @param InputInterface $input`
`235`	`235`	`* @param string $targetEdition`
`236`	`236`	`* @param string $targetConstraint`
`237`		`- * @return boolean Returns true if updates were necessary and prepared successfully`
	`237`	`+ * @return bool Returns true if updates were necessary and prepared successfully`
`238`	`238`	`*/`
`239`	`239`	`protected function runUpdate($updater, $input, $targetEdition, $targetConstraint)`
`240`	`240`	`{`