Merge remote-tracking branch 'falcons/MAGETWO-65208' into MAGETWO-65701

Author: Bohdan Korablov

app/code/Magento/Deploy/Console/Command/App/ConfigImport/Importer.php

@@ -7,12 +7,13 @@
 
 use Magento\Framework\App\DeploymentConfig\ImporterInterface;
 use Magento\Framework\App\DeploymentConfig;
-use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\RuntimeException;
 use Psr\Log\LoggerInterface as Logger;
 use Magento\Deploy\Model\DeploymentConfig\Validator;
 use Magento\Deploy\Model\DeploymentConfig\ImporterPool;
 use Magento\Deploy\Model\DeploymentConfig\Hash;
 use Symfony\Component\Console\Output\OutputInterface;
+use Magento\Deploy\Model\DeploymentConfig\ImporterFactory;
 
 /**
  * Runs importing of config data from deployment configuration files.
@@ -47,6 +48,13 @@ class Importer
      */
     private $configHash;
 
+    /**
+     * Factory for creation of importer instance.
+     *
+     * @var ImporterFactory
+     */
+    private $importerFactory;
+
     /**
      * Logger.
      *
@@ -57,19 +65,22 @@ class Importer
     /**
      * @param Validator $configValidator the manager of deployment configuration hash
      * @param ImporterPool $configImporterPool the pool of all deployment configuration importers
+     * @param ImporterFactory $importerFactory the factory for creation of importer instance
      * @param DeploymentConfig $deploymentConfig the application deployment configuration
      * @param Hash $configHash the hash updater of config data
      * @param Logger $logger the logger
      */
     public function __construct(
         Validator $configValidator,
         ImporterPool $configImporterPool,
+        ImporterFactory $importerFactory,
         DeploymentConfig $deploymentConfig,
         Hash $configHash,
         Logger $logger
     ) {
         $this->configValidator = $configValidator;
         $this->configImporterPool = $configImporterPool;
+        $this->importerFactory = $importerFactory;
         $this->deploymentConfig = $deploymentConfig;
         $this->configHash = $configHash;
         $this->logger = $logger;
@@ -80,32 +91,35 @@ public function __construct(
      *
      * @param OutputInterface $output the CLI output
      * @return void
-     * @throws LocalizedException
+     * @throws RuntimeException is thrown when import has failed
      */
     public function import(OutputInterface $output)
     {
-        $output->writeln('<info>Start import:</info>');
-
         try {
             $importers = $this->configImporterPool->getImporters();
-
             if (!$importers || $this->configValidator->isValid()) {
-                $output->writeln('<info>Nothing to import</info>');
+                $output->writeln('<info>Nothing to import.</info>');
+                return;
             } else {
-                /**
-                 * @var string $namespace
-                 * @var ImporterInterface $importer
-                 */
-                foreach ($importers as $namespace => $importer) {
-                    $messages = $importer->import($this->deploymentConfig->getConfigData($namespace));
+                $output->writeln('<info>Start import:</info>');
+            }
+
+            /**
+             * @var string $section
+             * @var string $importerClassName
+             */
+            foreach ($importers as $section => $importerClassName) {
+                if (!$this->configValidator->isValid($section)) {
+                    /** @var ImporterInterface $importer */
+                    $importer = $this->importerFactory->create($importerClassName);
+                    $messages = $importer->import((array)$this->deploymentConfig->getConfigData($section));
                     $output->writeln($messages);
+                    $this->configHash->regenerate($section);
                 }
-
-                $this->configHash->regenerate();
             }
-        } catch (LocalizedException $exception) {
+        } catch (\Exception $exception) {
             $this->logger->error($exception);
-            throw new LocalizedException(__('Import is failed'), $exception);
+            throw new RuntimeException(__('Import is failed: %1', $exception->getMessage()), $exception);
         }
     }
 }

app/code/Magento/Deploy/Console/Command/App/ConfigImportCommand.php

@@ -5,7 +5,7 @@
  */
 namespace Magento\Deploy\Console\Command\App;
 
-use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\RuntimeException;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -27,12 +27,14 @@ class ConfigImportCommand extends Command
     const COMMAND_NAME = 'app:config:import';
 
     /**
+     * Configuration importer.
+     *
      * @var Importer
      */
     private $importer;
 
     /**
-     * @param Importer $importer
+     * @param Importer $importer the configuration importer
      */
     public function __construct(Importer $importer)
     {
@@ -60,7 +62,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         try {
             $this->importer->import($output);
-        } catch (LocalizedException $e) {
+        } catch (RuntimeException $e) {
             $output->writeln('<error>' . $e->getMessage() . '</error>');
 
             return Cli::RETURN_FAILURE;

app/code/Magento/Deploy/Model/DeploymentConfig/DataCollector.php

@@ -15,7 +15,7 @@
  * <type name="Magento\Deploy\Model\DeploymentConfig\ImporterPool">
  *     <arguments>
  *          <argument name="importers" xsi:type="array">
- *               <item name="scopes" xsi:type="string">Magento\Store\Model\StoreImporter</item>
+ *               <item name="scopes" xsi:type="string">Magento\SomeModule\Model\SomeImporter</item>
  *          </argument>
  *     </arguments>
  * </type>
@@ -30,12 +30,11 @@
  *  ]
  * ```
  *
- * In here we define section "scopes" and its importer Magento\Store\Model\StoreImporter.
+ * In here we define section "scopes" and its importer Magento\SomeModule\Model\SomeImporter.
  * The data of this section will be collected then will be used in importing process from the shared configuration
  * files to appropriate application sources.
  *
  * @see \Magento\Deploy\Console\Command\App\ConfigImport\Importer::import()
- * @see \Magento\Deploy\Model\DeploymentConfig\Hash::regenerate()
  */
 class DataCollector
 {
@@ -65,6 +64,7 @@ public function __construct(ImporterPool $configImporterPool, DeploymentConfig $
 
     /**
      * Retrieves configuration data of specific section from deployment configuration files.
+     * Or retrieves configuration data of specific sections by its name.
      *
      * E.g.
      * ```php
@@ -75,19 +75,30 @@ public function __construct(ImporterPool $configImporterPool, DeploymentConfig $
      *      ...
      *  ]
      * ```
+     *
+     * This method retrieves the same structure for the specific section with only its data.
+     * ```php
+     *  [
+     *      'scopes' => [...]
+     *  ]
+     *
      * In this example key of the array is the section name, value of the array is configuration data of the section.
      *
+     * @param string $sectionName the section name for retrieving its configuration data
      * @return array
      */
-    public function getConfig()
+    public function getConfig($sectionName = null)
     {
         $result = [];
 
-        foreach ($this->configImporterPool->getSections() as $section) {
-            $data = $this->deploymentConfig->getConfigData($section);
-            if ($data) {
-                $result[$section] = $data;
-            }
+        if ($sectionName) {
+            $sections = [$sectionName];
+        } else {
+            $sections = $this->configImporterPool->getSections();
+        }
+
+        foreach ($sections as $section) {
+            $result[$section] = $this->deploymentConfig->getConfigData($section);
         }
 
         return $result;

app/code/Magento/Deploy/Model/DeploymentConfig/Hash.php

@@ -5,11 +5,10 @@
  */
 namespace Magento\Deploy\Model\DeploymentConfig;
 
-use Magento\Framework\Config\File\ConfigFilePool;
-use Magento\Framework\App\DeploymentConfig\Writer;
-use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\Exception\LocalizedException;
-use Magento\Framework\Exception\FileSystemException;
+use Magento\Framework\Flag\FlagResource;
+use Magento\Framework\Flag;
+use Magento\Framework\FlagFactory;
 
 /**
  * Saves and Retrieves deployment configuration hash.
@@ -27,77 +26,106 @@ class Hash
     const CONFIG_KEY = 'config_hash';
 
     /**
-     * Application deployment configuration.
+     * Hash generator.
      *
-     * @var DeploymentConfig
+     * @var Hash\Generator
      */
-    private $deploymentConfig;
+    private $configHashGenerator;
 
     /**
-     * Deployment configuration writer to files.
+     * Config data collector.
      *
-     * @var Writer
+     * @var DataCollector
      */
-    private $writer;
+    private $dataConfigCollector;
 
     /**
-     * Hash generator.
+     * Flag Resource model.
      *
-     * @var Hash\Generator
+     * @var FlagResource
      */
-    private $configHashGenerator;
+    private $flagResource;
 
     /**
-     * Config data collector.
+     * Factory class for \Magento\Framework\Flag
      *
-     * @var DataCollector
+     * @var FlagFactory
      */
-    private $dataConfigCollector;
+    private $flagFactory;
 
     /**
-     * @param DeploymentConfig $deploymentConfig the application deployment configuration
-     * @param Writer $writer the configuration writer that writes to files
      * @param Hash\Generator $configHashGenerator the hash generator
      * @param DataCollector $dataConfigCollector the config data collector
+     * @param FlagResource $flagResource
+     * @param FlagFactory $flagFactory
      */
     public function __construct(
-        DeploymentConfig $deploymentConfig,
-        Writer $writer,
         Hash\Generator $configHashGenerator,
-        DataCollector $dataConfigCollector
+        DataCollector $dataConfigCollector,
+        FlagResource $flagResource,
+        FlagFactory $flagFactory
     ) {
-        $this->deploymentConfig = $deploymentConfig;
-        $this->writer = $writer;
         $this->configHashGenerator = $configHashGenerator;
         $this->dataConfigCollector = $dataConfigCollector;
+        $this->flagResource = $flagResource;
+        $this->flagFactory = $flagFactory;
     }
 
     /**
      * Updates hash in the storage.
      *
-     * The hash is generated based on data from configuration files
+     * If the specific section name is set, then hash will be updated only for this section,
+     * in another case hash will be updated for all sections which defined in di.xml
+     * The hash is generated based on data from configuration files.
      *
+     * @param string $sectionName the specific section name
      * @return void
      * @throws LocalizedException is thrown when hash was not saved
      */
-    public function regenerate()
+    public function regenerate($sectionName = null)
     {
         try {
-            $config = $this->dataConfigCollector->getConfig();
-            $hash = $this->configHashGenerator->generate($config);
-            $this->writer->saveConfig([ConfigFilePool::APP_ENV => [self::CONFIG_KEY => $hash]]);
-        } catch (FileSystemException $exception) {
-            throw new LocalizedException(__('Hash has not been saved'), $exception);
+            $hashes = $this->get();
+            $configs = $this->dataConfigCollector->getConfig($sectionName);
+
+            foreach ($configs as $section => $config) {
+                $hashes[$section] = $this->configHashGenerator->generate($config);
+            }
+
+            /** @var Flag $flag */
+            $flag = $this->getFlagObject();
+            $flag->setFlagData($hashes);
+            $this->flagResource->save($flag);
+        } catch (\Exception $exception) {
+            throw new LocalizedException(__('Hash has not been saved.'), $exception);
         }
     }
 
     /**
-     * Retrieves saved hash from storage.
+     * Retrieves saved hashes from storage.
      *
-     * @return string|null
+     * @return array
      */
     public function get()
     {
-        return $this->deploymentConfig->getConfigData(self::CONFIG_KEY);
+        /** @var Flag $flag */
+        $flag = $this->getFlagObject();
+        return (array) ($flag->getFlagData() ?: []);
+    }
+
+    /**
+     * Returns flag object.
+     *
+     * We use it for saving hashes of sections in the DB.
+     *
+     * @return Flag
+     */
+    private function getFlagObject()
+    {
+        /** @var Flag $flag */
+        $flag = $this->flagFactory
+            ->create(['data' => ['flag_code' => self::CONFIG_KEY]]);
+        $this->flagResource->load($flag, self::CONFIG_KEY, 'flag_code');
+        return $flag;
     }
 }