Merge pull request #340 from magento-extensibility/MAGETWO-47952-functional-test-admin-session

[Extensibility] Bug fix and functional test

Author: He, Joan(johe)

app/code/Magento/Config/Controller/Adminhtml/System/AbstractConfig.php

@@ -72,8 +72,9 @@ protected function _isAllowed()
      */
     protected function _saveState($configState = [])
     {
-        $adminUser = $this->_auth->getUser();
         if (is_array($configState)) {
+            $configState = $this->sanitizeConfigState($configState);
+            $adminUser = $this->_auth->getUser();
             $extra = $adminUser->getExtra();
             if (!is_array($extra)) {
                 $extra = [];
@@ -88,4 +89,25 @@ protected function _saveState($configState = [])
         }
         return true;
     }
+
+    /**
+     * Sanitize config state data
+     *
+     * @param array $configState
+     * @return array
+     * @SuppressWarnings(PHPMD.UnusedLocalVariable)
+     */
+    protected function sanitizeConfigState($configState)
+    {
+        $sectionList = $this->_configStructure->getSectionList();
+        $sanitizedConfigState = $configState;
+        foreach ($configState as $sectionId => $value) {
+            if (array_key_exists($sectionId, $sectionList)) {
+                $sanitizedConfigState[$sectionId] = (bool)$sanitizedConfigState[$sectionId] ? '1' : '0';
+            } else {
+                unset($sanitizedConfigState[$sectionId]);
+            }
+        }
+        return $sanitizedConfigState;
+    }
 }

app/code/Magento/Config/Model/Config/Structure.php

@@ -51,6 +51,13 @@ class Structure implements \Magento\Config\Model\Config\Structure\SearchInterfac
      */
     protected $_elements;
 
+    /**
+     * List of config sections
+     *
+     * @var array
+     */
+    protected $sectionList;
+
     /**
      * @param \Magento\Config\Model\Config\Structure\Data $structureData
      * @param \Magento\Config\Model\Config\Structure\Element\Iterator\Tab $tabIterator
@@ -87,6 +94,26 @@ public function getTabs()
         return $this->_tabIterator;
     }
 
+    /**
+     * Retrieve config section list
+     *
+     * @return array
+     * @SuppressWarnings(PHPMD.UnusedLocalVariable)
+     */
+    public function getSectionList()
+    {
+        if (empty($this->sectionList)) {
+            foreach ($this->_data['sections'] as $sectionId => $section) {
+                if (array_key_exists('children', $section) && is_array($section['children'])) {
+                    foreach ($section['children'] as $childId => $child) {
+                        $this->sectionList[$sectionId . '_' . $childId] = true;
+                    }
+                }
+            }
+        }
+        return $this->sectionList;
+    }
+
     /**
      * Find element by path
      *

app/code/Magento/Config/Test/Unit/Controller/Adminhtml/System/Config/SaveTest.php

@@ -124,6 +124,12 @@ protected function setUp()
         $this->_cacheMock = $this->getMock('Magento\Framework\App\Cache\Type\Layout', [], [], '', false);
 
         $configStructureMock->expects($this->any())->method('getElement')->willReturn($this->_sectionMock);
+        $configStructureMock->expects($this->any())->method('getSectionList')->willReturn(
+            [
+                'some_key_0' => '0',
+                'some_key_1' => '1'
+            ]
+        );
 
         $helperMock->expects($this->any())->method('getUrl')->willReturnArgument(0);
 
@@ -219,21 +225,29 @@ public function testIndexActionWithAllowedSection()
     public function testIndexActionSaveState()
     {
         $this->_sectionCheckerMock->expects($this->any())->method('isSectionAllowed')->will($this->returnValue(false));
-        $data = ['some_key' => 'some_value'];
+        $inputData = [
+            'some_key'   => 'some_value',
+            'some_key_0' => '0',
+            'some_key_1' => 'some_value_1',
+        ];
+        $extraData = [
+            'some_key_0' => '0',
+            'some_key_1' => '1',
+        ];
 
         $userMock = $this->getMock('Magento\User\Model\User', [], [], '', false, false);
-        $userMock->expects($this->once())->method('saveExtra')->with(['configState' => $data]);
+        $userMock->expects($this->once())->method('saveExtra')->with(['configState' => $extraData]);
         $this->_authMock->expects($this->once())->method('getUser')->will($this->returnValue($userMock));
-
         $this->_requestMock->expects(
             $this->any()
         )->method(
             'getPost'
         )->with(
             'config_state'
         )->will(
-            $this->returnValue($data)
+            $this->returnValue($inputData)
         );
+
         $this->assertEquals($this->resultRedirect, $this->_controller->execute());
     }
 

app/code/Magento/Config/Test/Unit/Model/Config/StructureTest.php

@@ -128,6 +128,55 @@ public function testGetTabsBuildsSectionTree()
         $this->assertEquals($this->_tabIteratorMock, $model->getTabs());
     }
 
+    public function testGetSectionList()
+    {
+        $this->_structureDataMock = $this->getMock(
+            'Magento\Config\Model\Config\Structure\Data',
+            [],
+            [],
+            '',
+            false
+        );
+        $this->_structureDataMock->expects(
+            $this->any()
+        )->method(
+            'get'
+        )->will(
+            $this->returnValue(
+                [
+                    'sections' => [
+                        'section1' => [
+                            'children' => [
+                                'child_id_1' => 'child_data',
+                                'child_id_2' => 'child_data',
+                                'child_id_3' => 'child_data'
+                            ]
+                        ],
+                        'section2' => [
+                            'children' => [
+                                'child_id_1' => 'child_data'
+                            ]
+                        ],
+                    ]
+                ]
+            )
+        );
+        $expected = [
+            'section1_child_id_1' => true,
+            'section1_child_id_2' => true,
+            'section1_child_id_3' => true,
+            'section2_child_id_1' => true
+        ];
+        $model = new \Magento\Config\Model\Config\Structure(
+            $this->_structureDataMock,
+            $this->_tabIteratorMock,
+            $this->_flyweightFactory,
+            $this->_scopeDefinerMock
+        );
+
+        $this->assertEquals($expected, $model->getSectionList());
+    }
+
     /**
      * @param string $path
      * @param string $expectedType

app/code/Magento/Paypal/Model/Api/Nvp.php

@@ -1226,7 +1226,7 @@ public function call($methodName, array $request)
         $http->close();
 
         if (!$this->_validateResponse($methodName, $response)) {
-            $this->_logger->critical(new \Exception(__("PayPal response hasn't required fields.")));
+            $this->_logger->critical(new \Exception(__('PayPal response hasn\'t required fields.')));
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('Something went wrong while processing your order.')
             );

app/code/Magento/Paypal/Model/Payflow/Request.php

@@ -53,7 +53,7 @@ public function __call($method, $args)
                 return isset($this->_data[$key]);
         }
         throw new \Magento\Framework\Exception\LocalizedException(
-            __("Invalid method %1::%2(%3)", get_class($this), $method, print_r($args, 1))
+            __("Invalid method %1::%2", get_class($this), $method)
         );
     }
 }