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

Author: Bohdan Korablov

app/code/Magento/Config/App/Config/Source/EnvironmentConfigSource.php

@@ -12,7 +12,7 @@
 use Magento\Framework\Stdlib\ArrayManager;
 
 /**
- * Class for retrieving configuration from environment variables.
+ * Class for retrieving configurations from environment variables.
  */
 class EnvironmentConfigSource implements ConfigSourceInterface
 {

app/code/Magento/Config/Console/Command/ConfigShow/ValueProcessor.php

@@ -14,7 +14,9 @@
 use Magento\Framework\App\Area;
 
 /**
- * Class processes value using backend model.
+ * Class processes values using backend model.
+ *
+ * Backend model is gotten from field via its path (e.g. scope_id/group_id/field_id).
  */
 class ValueProcessor
 {
@@ -57,11 +59,11 @@ public function __construct(
     /**
      * Processes value using backend model.
      *
-     * @param string $scope The scope of configuration
+     * @param string $scope The scope of configuration. E.g. 'default', 'website' or 'store'
      * @param string $scopeCode The scope code of configuration
      * @param string $value The value to process
-     * @param string $path The configuration path for getting backend model
-     * @return string
+     * @param string $path The configuration path for getting backend model. E.g. scope_id/group_id/field_id
+     * @return string processed value result
      */
     public function process($scope, $scopeCode, $value, $path)
     {

app/code/Magento/Config/Console/Command/ConfigShowCommand.php

@@ -19,7 +19,7 @@
 use Magento\Config\Console\Command\ConfigShow\ValueProcessor;
 
 /**
- * Command provides possibility to show system configuration.
+ * Command provides possibility to show saved system configuration.
  */
 class ConfigShowCommand extends Command
 {
@@ -74,7 +74,7 @@ class ConfigShowCommand extends Command
     private $scopeCode;
 
     /**
-     * The path of configuration.
+     * The configuration path.
      *
      * @var string
      */
@@ -108,67 +108,86 @@ protected function configure()
         $this->addArgument(
             self::INPUT_ARGUMENT_PATH,
             InputArgument::OPTIONAL,
-            'Configuration path for example group/section/field_name'
+            'Configuration path, for example section_id/group_id/field_id'
         );
         $this->addOption(
             self::INPUT_OPTION_SCOPE,
             null,
             InputOption::VALUE_OPTIONAL,
-            'Scope for configuration, if not set use \'default\'',
+            'Scope for configuration, if not specified, then \'default\' scope will be used',
             ScopeConfigInterface::SCOPE_TYPE_DEFAULT
         );
         $this->addOption(
             self::INPUT_OPTION_SCOPE_CODE,
             null,
             InputOption::VALUE_OPTIONAL,
-            'Scope code for configuration, empty string by default',
+            'Scope code (required only if scope is not `default`)',
             ''
         );
         $this->setName('config:show')
-            ->setDescription('Shows configuration value for given path');
+            ->setDescription(
+                'Shows configuration value for given path. If path is not specified, all saved values will be shown'
+            );
         parent::configure();
     }
 
     /**
      * Displays configuration value for given configuration path.
      *
-     * Shows error message if configuration for given path doesn't exists
+     * Shows error message if configuration for given path doesn't exist
      * or scope/scope-code doesn't pass validation.
      *
      * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $this->scope = $input->getOption(self::INPUT_OPTION_SCOPE);
-        $this->scopeCode = $input->getOption(self::INPUT_OPTION_SCOPE_CODE);
-        $this->inputPath = $input->getArgument(self::INPUT_ARGUMENT_PATH);
-
         try {
+            $this->scope = $input->getOption(self::INPUT_OPTION_SCOPE);
+            $this->scopeCode = $input->getOption(self::INPUT_OPTION_SCOPE_CODE);
+            $this->inputPath = $input->getArgument(self::INPUT_ARGUMENT_PATH);
+
             $this->scopeValidator->isValid($this->scope, $this->scopeCode);
             $configPath = $this->pathResolver->resolve($this->inputPath, $this->scope, $this->scopeCode);
             $configValue = $this->configSource->get($configPath);
-        } catch (LocalizedException $e) {
-            $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
-            return Cli::RETURN_FAILURE;
-        }
 
-        if (empty($configValue)) {
-            $output->writeln(sprintf(
-                '<error>%s</error>',
-                __('Configuration for path: "%1" doesn\'t exist', $this->inputPath)->render()
-            ));
+            if (empty($configValue)) {
+                $output->writeln(sprintf(
+                    '<error>%s</error>',
+                    __('Configuration for path: "%1" doesn\'t exist', $this->inputPath)->render()
+                ));
+                return Cli::RETURN_FAILURE;
+            }
+
+            $this->outputResult($output, $configValue, $this->inputPath);
+            return Cli::RETURN_SUCCESS;
+        } catch (\Exception $e) {
+            $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
             return Cli::RETURN_FAILURE;
         }
-
-        $this->outputResult($output, $configValue, $this->inputPath);
-        return Cli::RETURN_SUCCESS;
     }
 
     /**
      * Outputs single configuration value or list of values if array given.
      *
      * @param OutputInterface $output an OutputInterface instance
-     * @param mixed $configValue single value or array of values
+     * @param mixed $configValue can be string when $configPath is a path for concreate field.
+     * In other cases $configValue should be an array
+     * ```php
+     * [
+     *      'section' =>
+     *      [
+     *          'group1' =>
+     *          [
+     *              'field1' => 'value1',
+     *              'field2' => 'value2'
+     *          ],
+     *          'group2' =>
+     *          [
+     *              'field1' => 'value3'
+     *          ]
+     *      ]
+     * ]
+     * ```
      * @param string $configPath base configuration path
      * @return void
      */

app/code/Magento/Config/Test/Unit/App/Config/Source/EnvironmentConfigSourceTest.php

@@ -29,8 +29,6 @@ class EnvironmentConfigSourceTest extends \PHPUnit_Framework_TestCase
 
     protected function setUp()
     {
-        $_ENV['CONFIG__UNIT__TEST__VALUE'] = 'test_value';
-
         $this->arrayManagerMock = $this->getMockBuilder(ArrayManager::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -49,12 +47,18 @@ protected function setUp()
         $this->source = new EnvironmentConfigSource($this->arrayManagerMock, $placeholderFactoryMock);
     }
 
-    public function testGet()
+    /**
+     * @param string $path
+     * @param array|string $expectedResult
+     * @dataProvider getDataProvider
+     */
+    public function testGet($path, $expectedResult)
     {
         $placeholder = 'CONFIG__UNIT__TEST__VALUE';
-        $value = 'test_value';
-        $path = 'unit/test/value';
-        $expectedArray = ['unit' => ['test' => ['value' => $value]]];
+        $configValue = 'test_value';
+        $configPath = 'unit/test/value';
+        $expectedArray = ['unit' => ['test' => ['value' => $configValue]]];
+        $_ENV[$placeholder] = $configValue;
 
         $this->placeholderMock->expects($this->any())
             ->method('isApplicable')
@@ -64,12 +68,41 @@ public function testGet()
         $this->placeholderMock->expects($this->once())
             ->method('restore')
             ->with($placeholder)
-            ->willReturn($path);
+            ->willReturn($configPath);
         $this->arrayManagerMock->expects($this->once())
             ->method('set')
-            ->with($path, [], $value)
+            ->with($configPath, [], $configValue)
             ->willReturn($expectedArray);
 
+        $this->assertEquals($expectedResult, $this->source->get($path));
+    }
+
+    /**
+     * @return array
+     */
+    public function getDataProvider()
+    {
+        return [
+            ['', ['unit' => ['test' => ['value' => 'test_value']]]],
+            ['unit', ['test' => ['value' => 'test_value']]],
+            ['unit/test', ['value' => 'test_value']],
+            ['unit/test/value', 'test_value'],
+            ['wrong/path', []],
+        ];
+    }
+
+    public function testGetWithoutEnvCongigurationVariables()
+    {
+        $expectedArray = [];
+
+        $this->placeholderMock->expects($this->any())
+            ->method('isApplicable')
+            ->willReturn(false);
+        $this->placeholderMock->expects($this->never())
+            ->method('restore');
+        $this->arrayManagerMock->expects($this->never())
+            ->method('set');
+
         $this->assertSame($expectedArray, $this->source->get());
     }