ENGCOM-5967: Magento_CurrencySymbol module. Replace replace deprecated message functions #24754

magento-engcom-team · magento-engcom-team · commit 2de860cb25bd · 2019-09-30T10:11:21.000-05:00
- Merge Pull Request #24754 from atwixfirster/magento2:module-currency-symbol-replace-deprecated-message-func - Merged commits: 1. 684e8fb 2. f05dd7f
diff --git a/app/code/Magento/CurrencySymbol/Controller/Adminhtml/System/Currency/FetchRates.php b/app/code/Magento/CurrencySymbol/Controller/Adminhtml/System/Currency/FetchRates.php
@@ -1,6 +1,5 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -13,6 +12,9 @@
 use Magento\Framework\Controller\ResultFactory;
 use Magento\CurrencySymbol\Controller\Adminhtml\System\Currency as CurrencyAction;
 
+/**
+ * Class FetchRates
+ */
 class FetchRates extends CurrencyAction implements HttpGetActionInterface, HttpPostActionInterface
 {
     /**
@@ -41,20 +43,20 @@ public function execute()
             }
             $rates = $importModel->fetchRates();
             $errors = $importModel->getMessages();
-            if (sizeof($errors) > 0) {
+            if (count($errors) > 0) {
                 foreach ($errors as $error) {
-                    $this->messageManager->addWarning($error);
+                    $this->messageManager->addWarningMessage($error);
                 }
-                $this->messageManager->addWarning(
+                $this->messageManager->addWarningMessage(
                     __('Click "Save" to apply the rates we found.')
                 );
             } else {
-                $this->messageManager->addSuccess(__('Click "Save" to apply the rates we found.'));
+                $this->messageManager->addSuccessMessage(__('Click "Save" to apply the rates we found.'));
             }
 
             $backendSession->setRates($rates);
         } catch (\Exception $e) {
-            $this->messageManager->addError($e->getMessage());
+            $this->messageManager->addErrorMessage($e->getMessage());
         }
 
         /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
diff --git a/app/code/Magento/CurrencySymbol/Controller/Adminhtml/System/Currency/SaveRates.php b/app/code/Magento/CurrencySymbol/Controller/Adminhtml/System/Currency/SaveRates.php
@@ -1,6 +1,5 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -9,6 +8,9 @@
 
 use Magento\Framework\App\Action\HttpPostActionInterface as HttpPostActionInterface;
 
+/**
+ * Class SaveRates
+ */
 class SaveRates extends \Magento\CurrencySymbol\Controller\Adminhtml\System\Currency implements HttpPostActionInterface
 {
     /**
@@ -23,22 +25,23 @@ public function execute()
             try {
                 foreach ($data as $currencyCode => $rate) {
                     foreach ($rate as $currencyTo => $value) {
-                        $value = abs($this->_objectManager->get(
-                            \Magento\Framework\Locale\FormatInterface::class
-                        )->getNumber($value));
+                        $value = abs(
+                            $this->_objectManager->get(\Magento\Framework\Locale\FormatInterface::class)
+                                ->getNumber($value)
+                        );
                         $data[$currencyCode][$currencyTo] = $value;
                         if ($value == 0) {
-                            $this->messageManager->addWarning(
+                            $this->messageManager->addWarningMessage(
                                 __('Please correct the input data for "%1 => %2" rate.', $currencyCode, $currencyTo)
                             );
                         }
                     }
                 }
 
                 $this->_objectManager->create(\Magento\Directory\Model\Currency::class)->saveRates($data);
-                $this->messageManager->addSuccess(__('All valid rates have been saved.'));
+                $this->messageManager->addSuccessMessage(__('All valid rates have been saved.'));
             } catch (\Exception $e) {
-                $this->messageManager->addError($e->getMessage());
+                $this->messageManager->addErrorMessage($e->getMessage());
             }
         }
 
diff --git a/app/code/Magento/CurrencySymbol/Controller/Adminhtml/System/Currencysymbol/Save.php b/app/code/Magento/CurrencySymbol/Controller/Adminhtml/System/Currencysymbol/Save.php
@@ -1,13 +1,15 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\CurrencySymbol\Controller\Adminhtml\System\Currencysymbol;
 
 use Magento\Framework\App\Action\HttpPostActionInterface as HttpPostActionInterface;
 
+/**
+ * Class Save
+ */
 class Save extends \Magento\CurrencySymbol\Controller\Adminhtml\System\Currencysymbol implements HttpPostActionInterface
 {
     /**
@@ -29,9 +31,9 @@ public function execute()
         try {
             $this->_objectManager->create(\Magento\CurrencySymbol\Model\System\Currencysymbol::class)
                 ->setCurrencySymbolsData($symbolsDataArray);
-            $this->messageManager->addSuccess(__('You applied the custom currency symbols.'));
+            $this->messageManager->addSuccessMessage(__('You applied the custom currency symbols.'));
         } catch (\Exception $e) {
-            $this->messageManager->addError($e->getMessage());
+            $this->messageManager->addErrorMessage($e->getMessage());
         }
 
         $this->getResponse()->setRedirect($this->_redirect->getRedirectUrl($this->getUrl('*')));
diff --git a/app/code/Magento/CurrencySymbol/Test/Unit/Controller/Adminhtml/System/Currency/SaveRatesTest.php b/app/code/Magento/CurrencySymbol/Test/Unit/Controller/Adminhtml/System/Currency/SaveRatesTest.php
@@ -0,0 +1,67 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\CurrencySymbol\Test\Unit\Controller\Adminhtml\System\Currency;
+
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+
+/**
+ * Class SaveRatesTest
+ */
+class SaveRatesTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var \Magento\CurrencySymbol\Controller\Adminhtml\System\Currency\SaveRates
+     */
+    protected $action;
+
+    /**
+     * @var \Magento\Framework\App\RequestInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $requestMock;
+
+    /**
+     * @var \Magento\Framework\App\ResponseInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $responseMock;
+
+    /**
+     *
+     */
+    protected function setUp()
+    {
+        $objectManager = new ObjectManager($this);
+
+        $this->requestMock = $this->createMock(\Magento\Framework\App\RequestInterface::class);
+
+        $this->responseMock = $this->createPartialMock(
+            \Magento\Framework\App\ResponseInterface::class,
+            ['setRedirect', 'sendResponse']
+        );
+
+        $this->action = $objectManager->getObject(
+            \Magento\CurrencySymbol\Controller\Adminhtml\System\Currency\SaveRates::class,
+            [
+                'request' => $this->requestMock,
+                'response' => $this->responseMock,
+            ]
+        );
+    }
+
+    /**
+     *
+     */
+    public function testWithNullRateExecute()
+    {
+        $this->requestMock->expects($this->once())
+            ->method('getParam')
+            ->with('rate')
+            ->willReturn(null);
+
+        $this->responseMock->expects($this->once())->method('setRedirect');
+
+        $this->action->execute();
+    }
+}
diff --git a/app/code/Magento/CurrencySymbol/Test/Unit/Controller/Adminhtml/System/Currencysymbol/SaveTest.php b/app/code/Magento/CurrencySymbol/Test/Unit/Controller/Adminhtml/System/Currencysymbol/SaveTest.php
@@ -128,7 +128,7 @@ public function testExecute()
             ->willReturn($this->filterManagerMock);
 
         $this->messageManagerMock->expects($this->once())
-            ->method('addSuccess')
+            ->method('addSuccessMessage')
             ->with(__('You applied the custom currency symbols.'));
 
         $this->action->execute();
diff --git a/dev/tests/integration/testsuite/Magento/CurrencySymbol/Controller/Adminhtml/System/Currency/FetchRatesTest.php b/dev/tests/integration/testsuite/Magento/CurrencySymbol/Controller/Adminhtml/System/Currency/FetchRatesTest.php
@@ -6,11 +6,30 @@
 
 namespace Magento\CurrencySymbol\Controller\Adminhtml\System\Currency;
 
+use Magento\Framework\Escaper;
+
 /**
  * Fetch Rates Test
  */
 class FetchRatesTest extends \Magento\TestFramework\TestCase\AbstractBackendController
 {
+    /**
+     * @var Escaper
+     */
+    private $escaper;
+
+    /**
+     * Initial setup
+     */
+    protected function setUp()
+    {
+        $this->escaper = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
+            Escaper::class
+        );
+
+        parent::setUp();
+    }
+
     /**
      * Test fetch action without service
      *
@@ -46,7 +65,11 @@ public function testFetchRatesActionWithNonexistentService(): void
         $this->dispatch('backend/admin/system_currency/fetchRates');
 
         $this->assertSessionMessages(
-            $this->contains("The import model can't be initialized. Verify the model and try again."),
+            $this->contains(
+                $this->escaper->escapeHtml(
+                    "The import model can't be initialized. Verify the model and try again."
+                )
+            ),
             \Magento\Framework\Message\MessageInterface::TYPE_ERROR
         );
     }
diff --git a/dev/tests/integration/testsuite/Magento/CurrencySymbol/Controller/Adminhtml/System/Currency/SaveRatesTest.php b/dev/tests/integration/testsuite/Magento/CurrencySymbol/Controller/Adminhtml/System/Currency/SaveRatesTest.php
@@ -3,16 +3,23 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\CurrencySymbol\Controller\Adminhtml\System\Currency;
 
 use Magento\Framework\App\Request\Http as HttpRequest;
+use Magento\Framework\Escaper;
 
 class SaveRatesTest extends \Magento\TestFramework\TestCase\AbstractBackendController
 {
 
     /** @var \Magento\Directory\Model\Currency $currencyRate */
     protected $currencyRate;
 
+    /**
+     * @var Escaper
+     */
+    private $escaper;
+
     /**
      * Initial setup
      */
@@ -21,6 +28,10 @@ protected function setUp()
         $this->currencyRate = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
             \Magento\Directory\Model\Currency::class
         );
+        $this->escaper = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
+            Escaper::class
+        );
+
         parent::setUp();
     }
 
@@ -89,7 +100,9 @@ public function testSaveWithWarningAction()
 
         $this->assertSessionMessages(
             $this->contains(
-                (string)__('Please correct the input data for "%1 => %2" rate.', $currencyCode, $currencyTo)
+                $this->escaper->escapeHtml(
+                    (string)__('Please correct the input data for "%1 => %2" rate.', $currencyCode, $currencyTo)
+                )
             ),
             \Magento\Framework\Message\MessageInterface::TYPE_WARNING
         );
