MAGETWO-83340: [2.3] Provide possibility to customize error messages from payment methods

- refactored integration test, added case for default message

Author: mduuude

dev/tests/integration/testsuite/Magento/Checkout/Api/PaymentInformationManagementTest.php

@@ -12,6 +12,7 @@
 use Magento\Braintree\Model\Ui\ConfigProvider;
 use Magento\Framework\Api\SearchCriteriaBuilder;
 use Magento\Framework\App\State;
+use Magento\Framework\App\Area;
 use Magento\Quote\Api\CartRepositoryInterface;
 use Magento\Quote\Api\Data\CartInterface;
 use Magento\Quote\Api\Data\PaymentInterface;
@@ -20,6 +21,11 @@
 use PHPUnit\Framework\TestCase;
 use PHPUnit_Framework_MockObject_MockObject as MockObject;
 
+/**
+ * Class PaymentInformationManagementTest
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class PaymentInformationManagementTest extends TestCase
 {
     /**
@@ -64,9 +70,16 @@ protected function tearDown()
      * @magentoConfigFixture current_store payment/braintree/active 1
      * @dataProvider getErrorPerAreaDataProvider
      * @expectedException \Magento\Framework\Exception\CouldNotSaveException
+     * @param string $area
+     * @param array $testErrorCodes
+     * @param string $expectedOutput
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
-    public function testSavePaymentInformationAndPlaceOrderWithErrors(string $area, string $errorMessage)
-    {
+    public function testSavePaymentInformationAndPlaceOrderWithErrors(
+        string $area,
+        array $testErrorCodes,
+        string $expectedOutput
+    ) {
         /** @var State $state */
         $state = $this->objectManager->get(State::class);
         $state->setAreaCode($area);
@@ -77,31 +90,18 @@ public function testSavePaymentInformationAndPlaceOrderWithErrors(string $area,
         $payment = $this->objectManager->create(PaymentInterface::class);
         $payment->setMethod(ConfigProvider::CODE);
 
-        $errors = [
-            'errors' => [
-                [
-                    'code' => 'fake_code',
-                    'attribute' => 'base',
-                    'message' => 'Error message should not be mapped.'
-                ],
-                [
-                    'code' => 81802,
-                    'attribute' => 'base',
-                    'message' => 'Company is too long.'
-                ],
-                [
-                    'code' => 91511,
-                    'attribute' => 'base',
-                    'message' => 'Customer does not have any credit cards.'
-                ]
-            ]
-        ];
+        $errors = ['errors' => []];
+
+        foreach ($testErrorCodes as $testErrorCode) {
+            array_push($errors['errors'], ['code' => $testErrorCode]);
+        }
+
         $response = new Error(['errors' => $errors]);
 
         $this->client->method('placeRequest')
             ->willReturn(['object' => $response]);
 
-        $this->expectExceptionMessage($errorMessage);
+        $this->expectExceptionMessage($expectedOutput);
 
         /** @var PaymentInformationManagementInterface $paymentInformationManagement */
         $paymentInformationManagement = $this->objectManager->get(PaymentInformationManagementInterface::class);
@@ -118,10 +118,24 @@ public function testSavePaymentInformationAndPlaceOrderWithErrors(string $area,
      */
     public function getErrorPerAreaDataProvider()
     {
-        $globalAreaError = 'Company is too long.';
+        $testErrorGlobal = ['code' => 81802, 'message' => 'Company is too long.'];
+        $testErrorAdmin = ['code' => 91511, 'message' => 'Customer does not have any credit cards.'];
+        $testErrorFake = ['code' => 'fake_code', 'message' => 'Error message should not be mapped.'];
+
         return [
-            ['area' => 'frontend', 'error' => $globalAreaError],
-            ['area' => 'adminhtml', 'error' => $globalAreaError . PHP_EOL . 'Customer does not have any credit cards.'],
+            [
+                Area::AREA_FRONTEND,
+                [$testErrorAdmin['code'], $testErrorFake['code']],
+                'Transaction has been declined. Please try again later.'
+            ], [
+                Area::AREA_FRONTEND,
+                [$testErrorGlobal['code'], $testErrorAdmin['code'], $testErrorFake['code']],
+                $testErrorGlobal['message']
+            ], [
+                Area::AREA_ADMINHTML,
+                [$testErrorGlobal['code'], $testErrorAdmin['code'], $testErrorFake['code']],
+                $testErrorGlobal['message'] . PHP_EOL . $testErrorAdmin['message']
+            ],
         ];
     }
 
@@ -131,7 +145,7 @@ public function getErrorPerAreaDataProvider()
      * @param string $reservedOrderId
      * @return CartInterface
      */
-    private function getQuote(string $reservedOrderId) : CartInterface
+    private function getQuote(string $reservedOrderId): CartInterface
     {
         /** @var SearchCriteriaBuilder $searchCriteriaBuilder */
         $searchCriteriaBuilder = $this->objectManager->get(SearchCriteriaBuilder::class);