Merge branch 'MAGETWO-37282' into PR-37282

dyushkin · dyushkin · commit 793d81aef813 · 2015-05-28T13:04:46.000+03:00
diff --git a/app/code/Magento/Payment/Model/Method/AbstractMethod.php b/app/code/Magento/Payment/Model/Method/AbstractMethod.php
@@ -208,7 +208,7 @@ abstract class AbstractMethod extends \Magento\Framework\Model\AbstractExtensibl
     protected $_scopeConfig;
 
     /**
-     * @var \Psr\Log\LoggerInterface
+     * @var Logger
      */
     protected $logger;
 
@@ -219,9 +219,11 @@ abstract class AbstractMethod extends \Magento\Framework\Model\AbstractExtensibl
      * @param \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory
      * @param \Magento\Payment\Helper\Data $paymentData
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
+     * @param Logger $logger
      * @param \Magento\Framework\Model\Resource\AbstractResource $resource
      * @param \Magento\Framework\Data\Collection\Db $resourceCollection
      * @param array $data
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         \Magento\Framework\Model\Context $context,
@@ -230,6 +232,7 @@ public function __construct(
         \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory,
         \Magento\Payment\Helper\Data $paymentData,
         \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
+        \Magento\Payment\Model\Method\Logger $logger,
         \Magento\Framework\Model\Resource\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\Db $resourceCollection = null,
         array $data = []
@@ -245,7 +248,7 @@ public function __construct(
         );
         $this->_paymentData = $paymentData;
         $this->_scopeConfig = $scopeConfig;
-        $this->logger = $context->getLogger();
+        $this->logger = $logger;
         $this->initializeData($data);
     }
 
@@ -880,14 +883,12 @@ public function getConfigPaymentAction()
     /**
      * Log debug data to file
      *
-     * @param mixed $debugData
+     * @param array $debugData
      * @return void
      */
     protected function _debug($debugData)
     {
-        if ($this->getDebugFlag()) {
-            $this->logger->debug(var_export($debugData, true));
-        }
+        $this->logger->debug($debugData, $this->getDebugReplacePrivateDataKeys(), $this->getDebugFlag());
     }
 
     /**
@@ -934,4 +935,14 @@ public function setExtensionAttributes(\Magento\Quote\Api\Data\PaymentMethodExte
     {
         return $this->_setExtensionAttributes($extensionAttributes);
     }
+
+    /**
+     * Return replace keys for debug data
+     *
+     * @return array
+     */
+    public function getDebugReplacePrivateDataKeys()
+    {
+        return (array) $this->_debugReplacePrivateDataKeys;
+    }
 }
diff --git a/app/code/Magento/Payment/Model/Method/Cc.php b/app/code/Magento/Payment/Model/Method/Cc.php
@@ -43,6 +43,7 @@ class Cc extends \Magento\Payment\Model\Method\AbstractMethod
      * @param \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory
      * @param \Magento\Payment\Helper\Data $paymentData
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
+     * @param Logger $logger
      * @param \Magento\Framework\Module\ModuleListInterface $moduleList
      * @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate
      * @param \Magento\Framework\Model\Resource\AbstractResource $resource
@@ -57,6 +58,7 @@ public function __construct(
         \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory,
         \Magento\Payment\Helper\Data $paymentData,
         \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
+        \Magento\Payment\Model\Method\Logger $logger,
         \Magento\Framework\Module\ModuleListInterface $moduleList,
         \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,
         \Magento\Framework\Model\Resource\AbstractResource $resource = null,
@@ -70,6 +72,7 @@ public function __construct(
             $customAttributeFactory,
             $paymentData,
             $scopeConfig,
+            $logger,
             $resource,
             $resourceCollection,
             $data
diff --git a/app/code/Magento/Payment/Model/Method/Free.php b/app/code/Magento/Payment/Model/Method/Free.php
@@ -50,6 +50,7 @@ class Free extends \Magento\Payment\Model\Method\AbstractMethod
      * @param \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory
      * @param \Magento\Payment\Helper\Data $paymentData
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
+     * @param Logger $logger
      * @param PriceCurrencyInterface $priceCurrency
      * @param \Magento\Framework\Model\Resource\AbstractResource $resource
      * @param \Magento\Framework\Data\Collection\Db $resourceCollection
@@ -63,6 +64,7 @@ public function __construct(
         \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory,
         \Magento\Payment\Helper\Data $paymentData,
         \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
+        \Magento\Payment\Model\Method\Logger $logger,
         PriceCurrencyInterface $priceCurrency,
         \Magento\Framework\Model\Resource\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\Db $resourceCollection = null,
@@ -75,6 +77,7 @@ public function __construct(
             $customAttributeFactory,
             $paymentData,
             $scopeConfig,
+            $logger,
             $resource,
             $resourceCollection,
             $data
diff --git a/app/code/Magento/Payment/Model/Method/Logger.php b/app/code/Magento/Payment/Model/Method/Logger.php
@@ -14,6 +14,7 @@
  */
 class Logger
 {
+    const DEBUG_KEYS_MASK = '****';
     /**
      * @var LoggerInterface
      */
@@ -30,15 +31,40 @@ public function __construct(LoggerInterface $logger)
     /**
      * Logs payment related information used for debug
      *
-     * @param mixed $logData
-     * @param ConfigInterface $config
-     *
+     * @param array $debugData
+     * @param array $debugReplaceKeys
+     * @param bool $debugFlag
      * @return void
      */
-    public function debug($logData, ConfigInterface $config)
+    public function debug(array $debugData, array $debugReplaceKeys, $debugFlag)
     {
-        if ($config->getConfigValue('debug')) {
-            $this->logger->debug(var_export($logData, true));
+        if ($debugFlag == true && !empty($debugData) && !empty($debugReplaceKeys)) {
+                $debugData = $this->filterDebugData(
+                    $debugData,
+                    $debugReplaceKeys
+                );
+            $this->logger->debug(var_export($debugData, true));
+        }
+    }
+
+    /**
+     * Recursive filter data by private conventions
+     *
+     * @param array $debugData
+     * @param array $debugReplacePrivateDataKeys
+     * @return array
+     */
+    protected function filterDebugData(array $debugData, array $debugReplacePrivateDataKeys)
+    {
+        $debugReplacePrivateDataKeys = array_map('strtolower', $debugReplacePrivateDataKeys);
+
+        foreach (array_keys($debugData) as $key) {
+            if (in_array(strtolower($key), $debugReplacePrivateDataKeys)) {
+                $debugData[$key] = self::DEBUG_KEYS_MASK;
+            } elseif (is_array($debugData[$key])) {
+                $debugData[$key] = $this->filterDebugData($debugData[$key], $debugReplacePrivateDataKeys);
+            }
         }
+        return $debugData;
     }
 }
diff --git a/app/code/Magento/Payment/Test/Unit/Model/Method/AbstractMethodTest.php b/app/code/Magento/Payment/Test/Unit/Model/Method/AbstractMethodTest.php
@@ -35,6 +35,11 @@ class AbstractMethodTest extends \PHPUnit_Framework_TestCase
      */
     protected $quoteMock;
 
+    /**
+     * @var \Psr\Log\LoggerInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $loggerMock;
+
     protected function setUp()
     {
         $this->scopeConfigMock = $this->getMockBuilder('Magento\Framework\App\Config\ScopeConfigInterface')
@@ -50,22 +55,35 @@ protected function setUp()
             ->disableOriginalConstructor()
             ->setMethods(['getEventDispatcher'])
             ->getMock();
-
         $contextMock->expects($this->once())
             ->method('getEventDispatcher')
             ->willReturn($this->eventManagerMock);
+        $this->loggerMock = $this->getMockBuilder('\Magento\Payment\Model\Method\Logger')
+            ->setConstructorArgs([$this->getMockForAbstractClass('Psr\Log\LoggerInterface')])
+            ->setMethods(['debug'])
+            ->getMock();
 
         $helper = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
-
         $this->payment = $helper->getObject(
             'Magento\Payment\Test\Unit\Model\Method\AbstractMethod\Stub',
             [
                 'scopeConfig' => $this->scopeConfigMock,
-                'context' => $contextMock
+                'context' => $contextMock,
+                'logger' => $this->loggerMock
             ]
         );
     }
 
+    public function testDebugData()
+    {
+        $debugData = ['masked' => '123'];
+        $this->loggerMock->expects($this->once())
+            ->method('debug')
+            ->with($this->equalTo($debugData));
+
+        $this->payment->debugData($debugData);
+    }
+
     /**
      * @param bool $result
      *
diff --git a/app/code/Magento/Payment/Test/Unit/Model/Method/FreeTest.php b/app/code/Magento/Payment/Test/Unit/Model/Method/FreeTest.php
@@ -39,13 +39,18 @@ protected function setUp()
         );
         $customAttributeFactory = $this->getMock('\Magento\Framework\Api\AttributeValueFactory', [], [], '', false);
 
+        $loggerMock = $this->getMockBuilder('\Magento\Payment\Model\Method\Logger')
+            ->setConstructorArgs([$this->getMockForAbstractClass('Psr\Log\LoggerInterface')])
+            ->getMock();
+
         $this->methodFree = new \Magento\Payment\Model\Method\Free(
             $context,
             $registry,
             $extensionAttributesFactory,
             $customAttributeFactory,
             $paymentData,
             $this->scopeConfig,
+            $loggerMock,
             $this->currencyPrice
         );
     }
diff --git a/app/code/Magento/Payment/Test/Unit/Model/Method/LoggerTest.php b/app/code/Magento/Payment/Test/Unit/Model/Method/LoggerTest.php
@@ -18,39 +18,48 @@ class LoggerTest extends \PHPUnit_Framework_TestCase
     /** @var LoggerInterface | \PHPUnit_Framework_MockObject_MockObject */
     private $loggerMock;
 
-    /** @var ConfigInterface | \PHPUnit_Framework_MockObject_MockObject */
-    private $configMock;
-
     protected function setUp()
     {
         $this->loggerMock = $this->getMockForAbstractClass('Psr\Log\LoggerInterface');
-        $this->configMock = $this->getMockForAbstractClass('Magento\Payment\Model\Method\ConfigInterface');
-
         $this->logger = new Logger($this->loggerMock);
     }
 
     public function testDebugOn()
     {
-        $this->configMock->expects($this->once())
-            ->method('getConfigValue')
-            ->with('debug')
-            ->willReturn(true);
+        $debugData =
+            [
+                'request' => ['masked' => '123', 'unmasked' => '123']
+            ];
+        $expectedDebugData =
+            [
+                'request' => ['masked' => Logger::DEBUG_KEYS_MASK, 'unmasked' => '123']
+            ];
+        $debugReplaceKeys =
+            [
+                'masked'
+            ];
+
         $this->loggerMock->expects($this->once())
             ->method('debug')
-            ->with("'test_value'");
+            ->with(var_export($expectedDebugData, true));
 
-        $this->logger->debug('test_value', $this->configMock);
+        $this->logger->debug($debugData, $debugReplaceKeys, true);
     }
 
     public function testDebugOff()
     {
-        $this->configMock->expects($this->once())
-            ->method('getConfigValue')
-            ->with('debug')
-            ->willReturn(false);
+        $debugData =
+            [
+                'request' => ['masked' => '123', 'unmasked' => '123']
+            ];
+        $debugReplaceKeys =
+            [
+                'masked'
+            ];
+
         $this->loggerMock->expects($this->never())
             ->method('debug');
 
-        $this->logger->debug('', $this->configMock);
+        $this->logger->debug($debugData, $debugReplaceKeys, false);
     }
 }
