MAGETWO-59809: Scrub sensitive data during app:dump

magento · Nov 2, 2016 · f33dd60 · f33dd60
1 parent 0f97776
commit f33dd60
Show file tree

Hide file tree

Showing 9 changed files with 107 additions and 14 deletions.
diff --git a/app/code/Magento/Config/Model/Config/Export/Comment.php b/app/code/Magento/Config/Model/Config/Export/Comment.php
@@ -8,7 +8,6 @@
 use Magento\Config\App\Config\Source\DumpConfigSourceInterface;
 use Magento\Config\Model\Placeholder\PlaceholderFactory;
 use Magento\Config\Model\Placeholder\PlaceholderInterface;
-use Magento\Config\Model\Placeholder\Environment;
 use Magento\Framework\App\Config\CommentInterface;
 
 /**
@@ -35,7 +34,7 @@ public function __construct(
         PlaceholderFactory $placeholderFactory,
         DumpConfigSourceInterface $source
     ) {
-        $this->placeholder = $placeholderFactory->create(Environment::class);
+        $this->placeholder = $placeholderFactory->create(PlaceholderFactory::TYPE_ENVIRONMENT);
         $this->source = $source;
     }
 

diff --git a/app/code/Magento/Config/Model/Config/Processor/EnvironmentPlaceholder.php b/app/code/Magento/Config/Model/Config/Processor/EnvironmentPlaceholder.php
@@ -5,7 +5,6 @@
  */
 namespace Magento\Config\Model\Config\Processor;
 
-use Magento\Config\Model\Placeholder\Environment;
 use Magento\Config\Model\Placeholder\PlaceholderFactory;
 use Magento\Config\Model\Placeholder\PlaceholderInterface;
 use Magento\Framework\App\Config\Spi\PreProcessorInterface;
@@ -38,7 +37,7 @@ public function __construct(
     ) {
         $this->placeholderFactory = $placeholderFactory;
         $this->arrayManager = $arrayManager;
-        $this->placeholder = $placeholderFactory->create(Environment::class);
+        $this->placeholder = $placeholderFactory->create(PlaceholderFactory::TYPE_ENVIRONMENT);
     }
 
     /**

diff --git a/app/code/Magento/Config/Model/Config/Reader/Source/Deployed/SettingChecker.php b/app/code/Magento/Config/Model/Config/Reader/Source/Deployed/SettingChecker.php
@@ -10,7 +10,6 @@
 use Magento\Framework\App\DeploymentConfig;
 use Magento\Config\Model\Placeholder\PlaceholderInterface;
 use Magento\Config\Model\Placeholder\PlaceholderFactory;
-use Magento\Config\Model\Placeholder\Environment;
 use Magento\Framework\App\Config\ScopeCodeResolver;
 
 /**
@@ -50,7 +49,7 @@ public function __construct(
     ) {
         $this->config = $config;
         $this->scopeCodeResolver = $scopeCodeResolver;
-        $this->placeholder = $placeholderFactory->create(Environment::class);
+        $this->placeholder = $placeholderFactory->create(PlaceholderFactory::TYPE_ENVIRONMENT);
     }
 
     /**

diff --git a/app/code/Magento/Config/Model/Placeholder/PlaceholderFactory.php b/app/code/Magento/Config/Model/Placeholder/PlaceholderFactory.php
@@ -5,35 +5,53 @@
  */
 namespace Magento\Config\Model\Placeholder;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\ObjectManagerInterface;
 
 class PlaceholderFactory
 {
+    /**
+     * @const string Environment type
+     */
+    const TYPE_ENVIRONMENT = 'environment';
+
     /**
      * @var ObjectManagerInterface
      */
     private $objectManager;
 
+    /**
+     * @var array
+     */
+    private $types;
+
     /**
      * @param ObjectManagerInterface $objectManager
+     * @param array $types
      */
-    public function __construct(ObjectManagerInterface $objectManager)
+    public function __construct(ObjectManagerInterface $objectManager, array $types = [])
     {
         $this->objectManager = $objectManager;
+        $this->types = $types;
     }
 
     /**
      * Create placeholder
      *
      * @param string $type
      * @return PlaceholderInterface
+     * @throws LocalizedException
      */
     public function create($type)
     {
-        $object = $this->objectManager->create($type);
+        if (!isset($this->types[$type])) {
+            throw new LocalizedException(__('There is no defined type ' . $type));
+        }
+
+        $object = $this->objectManager->create($this->types[$type]);
 
         if (!$object instanceof PlaceholderInterface) {
-            throw new \LogicException('Object is not instance of ' . PlaceholderInterface::class);
+            throw new LocalizedException(__('Object is not instance of ' . PlaceholderInterface::class));
         }
 
         return $object;

diff --git a/app/code/Magento/Config/Test/Unit/Model/Config/Export/CommentTest.php b/app/code/Magento/Config/Test/Unit/Model/Config/Export/CommentTest.php
@@ -42,6 +42,7 @@ protected function setUp()
             ->getMock();
         $placeholderFactoryMock->expects($this->once())
             ->method('create')
+            ->with(PlaceholderFactory::TYPE_ENVIRONMENT)
             ->willReturn($this->placeholderMock);
 
         $this->configSourceMock = $this->getMockBuilder(DumpConfigSourceInterface::class)

diff --git a/app/code/Magento/Config/Test/Unit/Model/Config/Processor/EnvironmentPlaceholderTest.php b/app/code/Magento/Config/Test/Unit/Model/Config/Processor/EnvironmentPlaceholderTest.php
@@ -6,7 +6,6 @@
 namespace Magento\Config\Test\Unit\Model\Config\Processor;
 
 use Magento\Config\Model\Config\Processor\EnvironmentPlaceholder;
-use Magento\Config\Model\Placeholder\Environment;
 use Magento\Config\Model\Placeholder\PlaceholderFactory;
 use Magento\Config\Model\Placeholder\PlaceholderInterface;
 use Magento\Framework\Stdlib\ArrayManager;
@@ -53,6 +52,7 @@ protected function setUp()
 
         $this->placeholderFactoryMock->expects($this->any())
             ->method('create')
+            ->with(PlaceholderFactory::TYPE_ENVIRONMENT)
             ->willReturn($this->placeholderMock);
 
         $this->model = new EnvironmentPlaceholder(

diff --git a/app/code/Magento/Config/Test/Unit/Model/Config/Reader/Source/Deployed/SettingCheckerTest.php b/app/code/Magento/Config/Test/Unit/Model/Config/Reader/Source/Deployed/SettingCheckerTest.php
@@ -11,7 +11,6 @@
 use Magento\Framework\App\DeploymentConfig;
 use Magento\Config\Model\Placeholder\PlaceholderInterface;
 use Magento\Config\Model\Placeholder\PlaceholderFactory;
-use Magento\Config\Model\Placeholder\Environment;
 
 /**
  * Test class for checking settings that defined in config file
@@ -60,7 +59,7 @@ public function setUp()
 
         $placeholderFactoryMock->expects($this->once())
             ->method('create')
-            ->with(Environment::class)
+            ->with(PlaceholderFactory::TYPE_ENVIRONMENT)
             ->willReturn($this->placeholderMock);
 
         $this->checker = new SettingChecker($this->configMock, $placeholderFactoryMock, $this->scopeCodeResolverMock);

diff --git a/app/code/Magento/Config/Test/Unit/Model/Placeholder/PlaceholderFactoryTest.php b/app/code/Magento/Config/Test/Unit/Model/Placeholder/PlaceholderFactoryTest.php
@@ -0,0 +1,76 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Config\Test\Unit\Model\Placeholder;
+
+use Magento\Config\Model\Placeholder\Environment;
+use Magento\Config\Model\Placeholder\PlaceholderFactory;
+use Magento\Framework\ObjectManagerInterface;
+
+class PlaceholderFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var PlaceholderFactory
+     */
+    private $model;
+
+    /**
+     * @var ObjectManagerInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $objectManagerMock;
+
+    /**
+     * @var Environment|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $environmentMock;
+
+    protected function setUp()
+    {
+        $this->objectManagerMock = $this->getMockBuilder(ObjectManagerInterface::class)
+            ->getMockForAbstractClass();
+        $this->environmentMock = $this->getMockBuilder(Environment::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->model = new PlaceholderFactory(
+            $this->objectManagerMock,
+            [
+                PlaceholderFactory::TYPE_ENVIRONMENT => Environment::class,
+                'wrongClass' => \stdClass::class,
+            ]
+        );
+    }
+
+    public function testCreate()
+    {
+        $this->objectManagerMock->expects($this->once())
+            ->method('create')
+            ->with(Environment::class)
+            ->willReturn($this->environmentMock);
+
+        $this->assertInstanceOf(
+            Environment::class,
+            $this->model->create(PlaceholderFactory::TYPE_ENVIRONMENT)
+        );
+    }
+
+    /**
+     * @expectedException \Magento\Framework\Exception\LocalizedException
+     * @expectedExceptionMessage There is no defined type dummyClass
+     */
+    public function testCreateNonExisted()
+    {
+        $this->model->create('dummyClass');
+    }
+
+    /**
+     * @expectedException \Magento\Framework\Exception\LocalizedException
+     * @expectedExceptionMessage Object is not instance of Magento\Config\Model\Placeholder\PlaceholderInterface
+     */
+    public function testCreateWrongImplementation()
+    {
+        $this->model->create('wrongClass');
+    }
+}
diff --git a/app/code/Magento/Config/etc/di.xml b/app/code/Magento/Config/etc/di.xml
@@ -176,9 +176,11 @@
             <argument name="source" xsi:type="object">appDumpSystemSource</argument>
         </arguments>
     </type>
-    <type name="Magento\Config\Model\Config\Structure">
+    <type name="Magento\Config\Model\Placeholder\PlaceholderFactory">
         <arguments>
-            <argument name="tabIterator" xsi:type="object">Magento\Config\Model\Config\Structure\Element\Iterator\Tab\Proxy</argument>
+            <argument name="types" xsi:type="array">
+                <item name="environment" xsi:type="string">Magento\Config\Model\Placeholder\Environment</item>
+            </argument>
         </arguments>
     </type>
 </config>