MAGETWO-63382: CLI Improvements: Configuration management - Command config:show

oshmyheliuk · oshmyheliuk · commit c38893e8d3ac · 2017-01-27T18:11:09.000+02:00
diff --git a/app/code/Magento/Config/Console/Command/ConfigShow/ConfigSourceAggregated.php b/app/code/Magento/Config/Console/Command/ConfigShow/ConfigSourceAggregated.php
@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Config\Console\Command\ConfigShow;
+
+use Magento\Framework\App\Config\ConfigSourceInterface;
+
+/**
+ * Configuration object used for ConfigShowCommand
+ */
+class ConfigSourceAggregated implements ConfigSourceInterface
+{
+    /**
+     * @var ConfigSourceInterface[]
+     */
+    private $sources;
+
+    /**
+     * @param array $sources
+     */
+    public function __construct(array $sources = [])
+    {
+        $this->sources = $sources;
+    }
+
+    /**
+     * Retrieve aggregated configuration from all available sources.
+     *
+     * @param string $path
+     * @return array
+     */
+    public function get($path = '')
+    {
+        $this->sortSources();
+        $data = [];
+        foreach ($this->sources as $sourceConfig) {
+            /** @var ConfigSourceInterface $source */
+            $source = $sourceConfig['source'];
+            $data = array_replace_recursive($data, $source->get($path));
+        }
+        return $data;
+    }
+
+    /**
+     * Sort given sources
+     *
+     * @return void
+     */
+    private function sortSources()
+    {
+        uasort($this->sources, function ($firstItem, $secondItem) {
+            return $firstItem['sortOrder'] > $secondItem['sortOrder'];
+        });
+    }
+}
diff --git a/app/code/Magento/Config/Console/Command/ConfigShowCommand.php b/app/code/Magento/Config/Console/Command/ConfigShowCommand.php
@@ -5,7 +5,10 @@
  */
 namespace Magento\Config\Console\Command;
 
+use Magento\Framework\App\Config\ConfigSourceInterface;
+use Magento\Framework\App\Config\MetadataProcessor;
 use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\Config\ScopePathResolver;
 use Magento\Framework\Exception\LocalizedException;
 use Symfony\Component\Console\Command\Command;
 use Magento\Framework\App\Scope\ValidatorInterface;
@@ -34,21 +37,38 @@ class ConfigShowCommand extends Command
     private $scopeValidator;
 
     /**
-     * @var ScopeConfigInterface
+     * @var ConfigSourceInterface
      */
-    private $appConfig;
+    private $configSource;
+
+    /**
+     * @var ScopePathResolver
+     */
+    private $pathResolver;
+
+    /**
+     * @var MetadataProcessor
+     */
+    private $metadataProcessor;
 
     /**
-     * @param ScopeConfigInterface $appConfig
      * @param ValidatorInterface $scopeValidator
+     * @param ConfigSourceInterface $configSource
+     * @param ScopePathResolver $pathResolver
+     * @param MetadataProcessor $metadataProcessor
+     * @internal param ScopeConfigInterface $appConfig
      */
     public function __construct(
-        ScopeConfigInterface $appConfig,
-        ValidatorInterface $scopeValidator
+        ValidatorInterface $scopeValidator,
+        ConfigSourceInterface $configSource,
+        ScopePathResolver $pathResolver,
+        MetadataProcessor $metadataProcessor
     ) {
         parent::__construct();
         $this->scopeValidator = $scopeValidator;
-        $this->appConfig = $appConfig;
+        $this->configSource = $configSource;
+        $this->pathResolver = $pathResolver;
+        $this->metadataProcessor = $metadataProcessor;
     }
 
     /**
@@ -92,11 +112,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $scope = $input->getOption(self::INPUT_OPTION_SCOPE);
         $scopeCode = $input->getOption(self::INPUT_OPTION_SCOPE_CODE);
-        $configPath = $input->getArgument(self::INPUT_ARGUMENT_PATH);
+        $inputPath = $input->getArgument(self::INPUT_ARGUMENT_PATH);
 
         try {
             $this->scopeValidator->isValid($scope, $scopeCode);
-            $configValue = $this->appConfig->getValue($configPath, $scope, $scopeCode);
+            $configPath = $this->pathResolver->resolve($inputPath, $scope, $scopeCode);
+            $configValue = $this->configSource->get($configPath);
         } catch (LocalizedException $e) {
             $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
             return Cli::RETURN_FAILURE;
@@ -105,12 +126,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
         if ($configValue === null) {
             $output->writeln(sprintf(
                 '<error>%s</error>',
-                __('Configuration for path: "%1" doesn\'t exist', $configPath)->render()
+                __('Configuration for path: "%1" doesn\'t exist', $inputPath)->render()
             ));
             return Cli::RETURN_FAILURE;
         }
 
-        $this->outputResult($output, $configValue, $configPath);
+        $this->outputResult($output, $configValue, $inputPath);
         return Cli::RETURN_SUCCESS;
     }
 
@@ -127,7 +148,8 @@ private function outputResult(OutputInterface $output, $configValue, $configPath
     {
         $margin = str_repeat(" ", max($level - 1, 0) * 2);
         if (is_string($configValue)) {
-            $output->writeln(sprintf("%s%s - %s", $margin, $configPath, $configValue));
+            $value = $this->metadataProcessor->processValue($configValue, $configPath);
+            $output->writeln(sprintf("%s%s - %s", $margin, $configPath, $value));
         } else if (is_array($configValue)) {
             if ($level > 0) {
                 $output->writeln(sprintf("%s%s:", $margin, $configPath ?: 'config'));
diff --git a/app/code/Magento/Config/Test/Unit/Console/Command/ConfigShowCommandTest.php b/app/code/Magento/Config/Test/Unit/Console/Command/ConfigShowCommandTest.php
@@ -6,12 +6,14 @@
 namespace Magento\Config\Test\Unit\Console\Command;
 
 use Magento\Config\Console\Command\ConfigShowCommand;
+use Magento\Framework\App\Config\ConfigSourceInterface;
 use Magento\Framework\Console\Cli;
 use Magento\Framework\Exception\LocalizedException;
 use PHPUnit_Framework_MockObject_MockObject as MockObject;
-use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Scope\ValidatorInterface;
 use Symfony\Component\Console\Tester\CommandTester;
+use Magento\Framework\App\Config\MetadataProcessor;
+use Magento\Framework\App\Config\ScopePathResolver;
 
 class ConfigShowCommandTest extends \PHPUnit_Framework_TestCase
 {
@@ -21,9 +23,19 @@ class ConfigShowCommandTest extends \PHPUnit_Framework_TestCase
     private $scopeValidatorMock;
 
     /**
-     * @var ScopeConfigInterface|MockObject
+     * @var ConfigSourceInterface|MockObject
      */
-    private $appConfigMock;
+    private $configSourceMock;
+
+    /**
+     * @var MetadataProcessor|MockObject
+     */
+    private $metadataProcessorMock;
+
+    /**
+     * @var ScopePathResolver|MockObject
+     */
+    private $pathResolverMock;
 
     /**
      * @var ConfigShowCommand
@@ -32,27 +44,48 @@ class ConfigShowCommandTest extends \PHPUnit_Framework_TestCase
 
     protected function setUp()
     {
-        $this->appConfigMock = $this->getMockBuilder(ScopeConfigInterface::class)
-            ->getMockForAbstractClass();
+        $this->metadataProcessorMock = $this->getMockBuilder(MetadataProcessor::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->pathResolverMock = $this->getMockBuilder(ScopePathResolver::class)
+            ->disableOriginalConstructor()
+            ->getMock();
         $this->scopeValidatorMock = $this->getMockBuilder(ValidatorInterface::class)
             ->getMockForAbstractClass();
+        $this->configSourceMock = $this->getMockBuilder(ConfigSourceInterface::class)
+            ->getMockForAbstractClass();
 
         $this->command = new ConfigShowCommand(
-            $this->appConfigMock,
-            $this->scopeValidatorMock
+            $this->scopeValidatorMock,
+            $this->configSourceMock,
+            $this->pathResolverMock,
+            $this->metadataProcessorMock
         );
     }
 
     public function testExecute()
     {
         $configPath = 'some/config/path';
+        $resolvedConfigPath = 'someScope/someScopeCode/some/config/path';
         $scope = 'someScope';
         $scopeCode = 'someScopeCode';
 
-        $this->appConfigMock->expects($this->once())
-            ->method('getValue')
+        $this->scopeValidatorMock->expects($this->once())
+            ->method('isValid')
+            ->with($scope, $scopeCode)
+            ->willReturn(true);
+        $this->pathResolverMock->expects($this->once())
+            ->method('resolve')
             ->with($configPath, $scope, $scopeCode)
+            ->willReturn($resolvedConfigPath);
+        $this->configSourceMock->expects($this->once())
+            ->method('get')
+            ->with($resolvedConfigPath)
             ->willReturn('someValue');
+        $this->metadataProcessorMock->expects($this->once())
+            ->method('processValue')
+            ->with('someValue')
+            ->willReturn('someProcessedValue');
 
         $tester = $this->getConfigShowCommandTester($configPath, $scope, $scopeCode);
 
@@ -61,7 +94,7 @@ public function testExecute()
             $tester->getStatusCode()
         );
         $this->assertContains(
-            'someValue',
+            'someProcessedValue',
             $tester->getDisplay()
         );
     }
diff --git a/app/code/Magento/Config/etc/di.xml b/app/code/Magento/Config/etc/di.xml
@@ -190,6 +190,25 @@
             <argument name="placeholder" xsi:type="object">Magento\Config\Model\Placeholder\Environment</argument>
         </arguments>
     </type>
+    <virtualType name="configShowSourceAggregated" type="Magento\Config\Console\Command\ConfigShow\ConfigSourceAggregated">
+        <arguments>
+            <argument name="sources" xsi:type="array">
+                <item name="dynamic" xsi:type="array">
+                    <item name="source" xsi:type="object">Magento\Config\App\Config\Source\RuntimeConfigSource</item>
+                    <item name="sortOrder" xsi:type="string">100</item>
+                </item>
+                <item name="initial" xsi:type="array">
+                    <item name="source" xsi:type="object">systemConfigInitialDataProvider</item>
+                    <item name="sortOrder" xsi:type="string">1000</item>
+                </item>
+            </argument>
+        </arguments>
+    </virtualType>
+    <type name="Magento\Config\Console\Command\ConfigShowCommand">
+        <arguments>
+            <argument name="configSource" xsi:type="object">configShowSourceAggregated</argument>
+        </arguments>
+    </type>
     <type name="Magento\Framework\Console\CommandListInterface">
         <arguments>
             <argument name="commands" xsi:type="array">
diff --git a/lib/internal/Magento/Framework/App/Config/MetadataProcessor.php b/lib/internal/Magento/Framework/App/Config/MetadataProcessor.php
@@ -88,4 +88,49 @@ public function process(array $data)
         }
         return $data;
     }
+
+    /**
+     * Processes value into correct form.
+     * Example: decrypt a value.
+     *
+     * @param string|int $value The value to process
+     * @param string $path The path of the value
+     * @return string The processed value
+     */
+    public function processValue($value, $path)
+    {
+        if (isset($this->_metadata[$path])) {
+            /** @var \Magento\Framework\App\Config\Data\ProcessorInterface $processor */
+            $processor = $this->_processorFactory->get($this->_metadata[$path]['backendModel']);
+
+            return $processor->processValue($value);
+        }
+
+        return $value;
+    }
+
+    /**
+     * Prepares value for saving.
+     * Example: encrypt a value.
+     *
+     * @param string|int $value The value to prepare
+     * @param string $path The path of the value
+     * @return string The prepared value
+     */
+    public function prepareValue($value, $path)
+    {
+        if (isset($this->_metadata[$path])) {
+            /** @var \Magento\Framework\App\Config\Data\ProcessorInterface $processor */
+            $processor = $this->_processorFactory->get($this->_metadata[$path]['backendModel']);
+
+            if ($processor instanceof \Magento\Framework\App\Config\Value) {
+                $processor->setValue($value);
+                $processor->beforeSave();
+
+                return $processor->getValue();
+            }
+        }
+
+        return $value;
+    }
 }
diff --git a/lib/internal/Magento/Framework/App/Config/ScopePathResolver.php b/lib/internal/Magento/Framework/App/Config/ScopePathResolver.php
