Merge branch 'AC-2258-add-test-coverage-for-installer-fix' into AC-2425-update-elasticsearch-7.17

andrewbess · andrewbess · commit 803705669375 · 2022-03-17T13:51:26.000+01:00
diff --git a/setup/src/Magento/Setup/Model/Installer.php b/setup/src/Magento/Setup/Model/Installer.php
@@ -30,6 +30,7 @@
 use Magento\Framework\Model\ResourceModel\Db\Context;
 use Magento\Framework\Module\ModuleList\Loader as ModuleLoader;
 use Magento\Framework\Module\ModuleListInterface;
+use Magento\Framework\Module\ModuleResource;
 use Magento\Framework\Mview\TriggerCleaner;
 use Magento\Framework\Setup\Declaration\Schema\DryRunLogger;
 use Magento\Framework\Setup\FilePermissions;
@@ -68,35 +69,32 @@
  */
 class Installer
 {
-    /**#@+
+    /**
      * Parameters for enabling/disabling modules
      */
-    const ENABLE_MODULES = 'enable-modules';
-    const DISABLE_MODULES = 'disable-modules';
-    /**#@- */
+    public const ENABLE_MODULES = 'enable-modules';
+    public const DISABLE_MODULES = 'disable-modules';
 
-    /**#@+
+    /**
      * Formatting for progress log
      */
-    const PROGRESS_LOG_RENDER = '[Progress: %d / %d]';
-    const PROGRESS_LOG_REGEX = '/\[Progress: (\d+) \/ (\d+)\]/s';
-    /**#@- */
+    public const PROGRESS_LOG_RENDER = '[Progress: %d / %d]';
+    public const PROGRESS_LOG_REGEX = '/\[Progress: (\d+) \/ (\d+)\]/s';
 
-    /**#@+
+    /**
      * Instance types for schema and data handler
      */
-    const SCHEMA_INSTALL = \Magento\Framework\Setup\InstallSchemaInterface::class;
-    const SCHEMA_UPGRADE = \Magento\Framework\Setup\UpgradeSchemaInterface::class;
-    const DATA_INSTALL = \Magento\Framework\Setup\InstallDataInterface::class;
-    const DATA_UPGRADE = \Magento\Framework\Setup\UpgradeDataInterface::class;
-    /**#@- */
+    public const SCHEMA_INSTALL = \Magento\Framework\Setup\InstallSchemaInterface::class;
+    public const SCHEMA_UPGRADE = \Magento\Framework\Setup\UpgradeSchemaInterface::class;
+    public const DATA_INSTALL = \Magento\Framework\Setup\InstallDataInterface::class;
+    public const DATA_UPGRADE = \Magento\Framework\Setup\UpgradeDataInterface::class;
 
-    const INFO_MESSAGE = 'message';
+    public const INFO_MESSAGE = 'message';
 
     /**
      * The lowest supported MySQL verion
      */
-    const MYSQL_VERSION_REQUIRED = '5.6.0';
+    public const MYSQL_VERSION_REQUIRED = '5.6.0';
 
     /**
      * File permissions checker
@@ -106,22 +104,16 @@ class Installer
     private $filePermissions;
 
     /**
-     * Deployment configuration repository
-     *
      * @var Writer
      */
     private $deploymentConfigWriter;
 
     /**
-     * Deployment configuration reader
-     *
      * @var Reader
      */
     private $deploymentConfigReader;
 
     /**
-     * Module list
-     *
      * @var ModuleListInterface
      */
     private $moduleList;
@@ -134,8 +126,6 @@ class Installer
     private $moduleLoader;
 
     /**
-     * Admin account factory
-     *
      * @var AdminAccountFactory
      */
     private $adminAccountFactory;
@@ -232,8 +222,6 @@ class Installer
     protected $sampleDataState;
 
     /**
-     * Component Registrar
-     *
      * @var ComponentRegistrar
      */
     private $componentRegistrar;
@@ -1029,7 +1017,7 @@ private function handleDBSchemaData($setup, $type, array $request)
             // phpcs:ignore Magento2.Exceptions.DirectThrow
             throw  new Exception("Unsupported operation type $type is requested");
         }
-        $resource = new \Magento\Framework\Module\ModuleResource($this->context);
+        $resource = $this->getModuleResource();
         $verType = $type . '-version';
         $installType = $type . '-install';
         $upgradeType = $type . '-upgrade';
@@ -1063,7 +1051,7 @@ private function handleDBSchemaData($setup, $type, array $request)
             $configVer = $this->moduleList->getOne($moduleName)['setup_version'];
             $currentVersion = $moduleContextList[$moduleName]->getVersion();
             // Schema/Data is installed
-            if ($currentVersion !== '') {
+            if ($configVer !== null && $currentVersion !== '') {
                 $status = version_compare($configVer, $currentVersion);
                 if ($status == \Magento\Framework\Setup\ModuleDataSetupInterface::VERSION_COMPARE_GREATER) {
                     $upgrader = $this->getSchemaDataHandler($moduleName, $upgradeType);
@@ -1133,6 +1121,16 @@ private function handleDBSchemaData($setup, $type, array $request)
         }
     }
 
+    /**
+     * Get a module Resource object
+     *
+     * @return ModuleResource
+     */
+    public function getModuleResource(): ModuleResource
+    {
+        return new ModuleResource($this->context);
+    }
+
     /**
      * Assert DbConfigExists
      *
@@ -1663,7 +1661,7 @@ private function getSchemaDataHandler($moduleName, $type)
     /**
      * Generates list of ModuleContext
      *
-     * @param \Magento\Framework\Module\ModuleResource $resource
+     * @param ModuleResource $resource
      * @param string $type
      * @return ModuleContext[]
      * @throws Exception
diff --git a/setup/src/Magento/Setup/Test/Unit/Model/InstallerTest.php b/setup/src/Magento/Setup/Test/Unit/Model/InstallerTest.php
@@ -29,6 +29,7 @@
     use Magento\Framework\Model\ResourceModel\Db\Context;
     use Magento\Framework\Module\ModuleList\Loader;
     use Magento\Framework\Module\ModuleListInterface;
+    use Magento\Framework\Module\ModuleResource;
     use Magento\Framework\ObjectManagerInterface;
     use Magento\Framework\Registry;
     use Magento\Framework\Setup\FilePermissions;
@@ -77,7 +78,7 @@ class InstallerTest extends TestCase
         ];
 
         /**
-         * @var Installer
+         * @var Installer|MockObject
          */
         private $object;
 
@@ -230,9 +231,6 @@ protected function setUp(): void
             $this->config = $this->createMock(DeploymentConfig::class);
 
             $this->moduleList = $this->getMockForAbstractClass(ModuleListInterface::class);
-            $this->moduleList->expects($this->any())->method('getOne')->willReturn(
-                ['setup_version' => '2.0.0']
-            );
             $this->moduleList->expects($this->any())->method('getNames')->willReturn(
                 ['Foo_One', 'Bar_Two']
             );
@@ -282,29 +280,35 @@ private function createObject($connectionFactory = false, $objectManagerProvider
                 $objectManagerProvider->expects($this->any())->method('get')->willReturn($this->objectManager);
             }
 
-            return new Installer(
-                $this->filePermissions,
-                $this->configWriter,
-                $this->configReader,
-                $this->config,
-                $this->moduleList,
-                $this->moduleLoader,
-                $this->adminFactory,
-                $this->logger,
-                $connectionFactory,
-                $this->maintenanceMode,
-                $this->filesystem,
-                $objectManagerProvider,
-                $this->contextMock,
-                $this->configModel,
-                $this->cleanupFiles,
-                $this->dbValidator,
-                $this->setupFactory,
-                $this->dataSetupFactory,
-                $this->sampleDataState,
-                $this->componentRegistrar,
-                $this->phpReadinessCheck
-            );
+            $installer = $this->getMockBuilder(Installer::class)
+                ->enableOriginalConstructor()
+                ->onlyMethods(['getModuleResource'])
+                ->setConstructorArgs([
+                    'filePermissions' => $this->filePermissions,
+                    'deploymentConfigWriter' => $this->configWriter,
+                    'deploymentConfigReader' => $this->configReader,
+                    'deploymentConfig' => $this->config,
+                    'moduleList' => $this->moduleList,
+                    'moduleLoader' => $this->moduleLoader,
+                    'adminAccountFactory' => $this->adminFactory,
+                    'log' => $this->logger,
+                    'connectionFactory' => $connectionFactory,
+                    'maintenanceMode' => $this->maintenanceMode,
+                    'filesystem' => $this->filesystem,
+                    'objectManagerProvider' => $objectManagerProvider,
+                    'context' => $this->contextMock,
+                    'setupConfigModel' => $this->configModel,
+                    'cleanupFiles' => $this->cleanupFiles,
+                    'dbValidator' => $this->dbValidator,
+                    'setupFactory' => $this->setupFactory,
+                    'dataSetupFactory' => $this->dataSetupFactory,
+                    'sampleDataState' => $this->sampleDataState,
+                    'componentRegistrar' => $this->componentRegistrar,
+                    'phpReadinessCheck' => $this->phpReadinessCheck,
+                ])
+                ->getMock();
+
+            return $installer;
         }
 
         /**
@@ -315,6 +319,14 @@ private function createObject($connectionFactory = false, $objectManagerProvider
          */
         public function testInstall(array $request, array $logMessages)
         {
+            $this->moduleList->method('getOne')
+                ->willReturnMap(
+                    [
+                        ['Foo_One', ['setup_version' => '2.0.0']],
+                        ['Bar_Two', ['setup_version' => null]]
+                    ]
+                );
+
             $this->config->expects($this->atLeastOnce())
                 ->method('get')
                 ->willReturnMap(
@@ -344,6 +356,16 @@ public function testInstall(array $request, array $logMessages)
             $resource = $this->createMock(ResourceConnection::class);
             $this->contextMock->expects($this->any())->method('getResources')->willReturn($resource);
             $resource->expects($this->any())->method('getConnection')->willReturn($connection);
+
+            $moduleResource = $this->getMockBuilder(ModuleResource::class)
+                ->enableOriginalConstructor()
+                ->onlyMethods(['getDbVersion', 'getDataVersion'])
+                ->setConstructorArgs(['context' => $this->contextMock])
+                ->getMock();
+            $moduleResource->method('getDbVersion')->willReturnOnConsecutiveCalls(false, '2.1.0');
+            $moduleResource->method('getDataVersion')->willReturn(false);
+            $this->object->method('getModuleResource')->willReturn($moduleResource);
+
             $dataSetup = $this->createMock(DataSetup::class);
             $dataSetup->expects($this->any())->method('getConnection')->willReturn($connection);
             $cacheManager = $this->createMock(Manager::class);
@@ -581,6 +603,7 @@ public function testInstallWithInvalidRemoteStorageConfiguration(bool $isDeploym
                         ['modules/Magento_User', null, '1']
                     ]
                 );
+            $this->moduleList->method('getOne')->willReturn(['setup_version' => '2.0.0']);
             $allModules = ['Foo_One' => [], 'Bar_Two' => []];
 
             $this->declarationInstallerMock->expects(static::once())->method('installSchema');
@@ -603,6 +626,7 @@ public function testInstallWithInvalidRemoteStorageConfiguration(bool $isDeploym
             $resource->expects(static::any())->method('getConnection')->willReturn($connection);
 
             $this->contextMock->expects(static::exactly(2))->method('getResources')->willReturn($resource);
+            $this->setModuleResource();
 
             $dataSetup = $this->createMock(DataSetup::class);
             $dataSetup->expects(static::never())->method('getConnection');
@@ -752,6 +776,7 @@ public function testInstallWithUnresolvableRemoteStorageValidator()
                     ]
                 );
             $allModules = ['Foo_One' => [], 'Bar_Two' => []];
+            $this->moduleList->method('getOne')->willReturn(['setup_version' => '2.0.0']);
 
             $this->declarationInstallerMock->expects(static::once())->method('installSchema');
             $this->moduleLoader->expects(static::any())->method('load')->willReturn($allModules);
@@ -771,6 +796,8 @@ public function testInstallWithUnresolvableRemoteStorageValidator()
             $resource = $this->createMock(ResourceConnection::class);
             $this->contextMock->expects(static::any())->method('getResources')->willReturn($resource);
             $resource->expects(static::any())->method('getConnection')->willReturn($connection);
+            $this->setModuleResource();
+
             $dataSetup = $this->createMock(DataSetup::class);
             $dataSetup->expects(static::any())->method('getConnection')->willReturn($connection);
             $cacheManager = $this->createMock(Manager::class);
@@ -939,6 +966,7 @@ public function testInstallWithInvalidRemoteStorageConfigurationWithEarlyExcepti
                     ]
                 );
             $allModules = ['Foo_One' => [], 'Bar_Two' => []];
+            $this->moduleList->method('getOne')->willReturn(['setup_version' => '2.0.0']);
 
             $this->declarationInstallerMock
                 ->expects(static::once())
@@ -1054,6 +1082,8 @@ public function installWithInvalidRemoteStorageConfigurationWithEarlyExceptionDa
          */
         public function testInstallDataFixtures(bool $keepCache, array $expectedToEnableCacheTypes): void
         {
+            $this->moduleList->method('getOne')->willReturn(['setup_version' => '2.0.0']);
+
             $cacheManagerMock = $this->createMock(Manager::class);
             //simulate disabled layout cache type
             $cacheManagerMock->expects($this->atLeastOnce())
@@ -1108,6 +1138,7 @@ public function testInstallDataFixtures(bool $keepCache, array $expectedToEnable
             $this->contextMock->expects($this->once())
                 ->method('getResources')
                 ->willReturn($resource);
+            $this->setModuleResource();
 
             $dataSetup = $this->createMock(DataSetup::class);
             $dataSetup->expects($this->once())
@@ -1367,6 +1398,17 @@ private function prepareForUpdateModulesTests()
 
             return $newObject;
         }
+
+        /**
+         * Sets a new ModuleResource object to the installer
+         *
+         * @return void
+         */
+        private function setModuleResource(): void
+        {
+            $moduleResource = new ModuleResource($this->contextMock);
+            $this->object->method('getModuleResource')->willReturn($moduleResource);
+        }
     }
 }
 
