Merge remote-tracking branch 'origin/MAGETWO-58237' into bugfixes

Author: Olexandr Lysenko

app/code/Magento/Sales/Controller/Adminhtml/Order/Creditmemo/Save.php

@@ -102,6 +102,7 @@ public function execute()
                 $creditmemoManagement = $this->_objectManager->create(
                     \Magento\Sales\Api\CreditmemoManagementInterface::class
                 );
+                $creditmemo->getOrder()->setCustomerNoteNotify(!empty($data['send_email']));
                 $creditmemoManagement->refund($creditmemo, (bool)$data['do_offline']);
 
                 if (!empty($data['send_email'])) {

app/code/Magento/Sales/Model/Order/Payment.php

@@ -8,6 +8,7 @@
 
 namespace Magento\Sales\Model\Order;
 
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\Sales\Model\Order\Payment\Info;
@@ -105,6 +106,11 @@ class Payment extends Info implements OrderPaymentInterface
      */
     protected $orderRepository;
 
+    /**
+     * @var OrderStateResolverInterface
+     */
+    private $orderStateResolver;
+
     /**
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
@@ -692,7 +698,12 @@ public function refund($creditmemo)
         }
         $message = $message = $this->prependMessage($message);
         $message = $this->_appendTransactionToMessage($transaction, $message);
-        $this->setOrderStateProcessing($message);
+        $orderState = $this->getOrderStateResolver()->getStateForOrder($this->getOrder());
+        $this->getOrder()
+            ->addStatusHistoryComment(
+                $message,
+                $this->getOrder()->getConfig()->getStateDefaultStatus($orderState)
+            )->setIsCustomerNotified($creditmemo->getOrder()->getCustomerNoteNotify());
         $this->_eventManager->dispatch(
             'sales_order_payment_refund',
             ['payment' => $this, 'creditmemo' => $creditmemo]
@@ -1388,6 +1399,19 @@ protected function _getInvoiceForTransactionId($transactionId)
         return false;
     }
 
+    /**
+     * @deprecated
+     * @return OrderStateResolverInterface
+     */
+    private function getOrderStateResolver()
+    {
+        if ($this->orderStateResolver === null) {
+            $this->orderStateResolver = ObjectManager::getInstance()->get(OrderStateResolverInterface::class);
+        }
+
+        return$this->orderStateResolver;
+    }
+
     //@codeCoverageIgnoreStart
     /**
      * Returns account_status

app/code/Magento/Sales/Model/RefundInvoice.php

@@ -218,6 +218,7 @@ public function execute(
         $connection->beginTransaction();
         try {
             $creditmemo->setState(\Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED);
+            $order->setCustomerNoteNotify($notify);
             $order = $this->paymentAdapter->refund($creditmemo, $order, $isOnline);
             $order->setState(
                 $this->orderStateResolver->getStateForOrder($order, [])

app/code/Magento/Sales/Model/RefundOrder.php

@@ -186,6 +186,7 @@ public function execute(
         $connection->beginTransaction();
         try {
             $creditmemo->setState(\Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED);
+            $order->setCustomerNoteNotify($notify);
             $order = $this->paymentAdapter->refund($creditmemo, $order);
             $order->setState(
                 $this->orderStateResolver->getStateForOrder($order, [])

app/code/Magento/Sales/Model/Service/CreditmemoService.php

@@ -182,7 +182,7 @@ public function refund(
             $connection->commit();
         } catch (\Exception $e) {
             $connection->rollBack();
-            throw new \Magento\Framework\Exception\LocalizedException($e->getMessage());
+            throw new \Magento\Framework\Exception\LocalizedException(__($e->getMessage()));
         }
 
         return $creditmemo;

app/code/Magento/Sales/Test/Unit/Model/Order/PaymentTest.php

@@ -19,8 +19,16 @@ class PaymentTest extends \PHPUnit_Framework_TestCase
 {
     const TRANSACTION_ID = 'ewr34fM49V0';
 
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
     private $mockContext;
 
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $orderStateResolverMock;
+
     /**
      * @var Payment
      */
@@ -59,6 +67,9 @@ class PaymentTest extends \PHPUnit_Framework_TestCase
     /** @var \Magento\Sales\Model\Order\Invoice | \PHPUnit_Framework_MockObject_MockObject $orderMock */
     private $invoiceMock;
 
+    /**
+     * @var string
+     */
     private $transactionId;
 
     /**
@@ -271,14 +282,19 @@ function ($value) {
                 'getGrandTotal',
                 'getBaseGrandTotal',
                 'getDoTransaction',
-                'getInvoice'
+                'getInvoice',
+                'getOrder'
             ],
             [],
             '',
             false
         );
-
+        $this->orderStateResolverMock = $this->getMockBuilder(Order\OrderStateResolverInterface::class)
+            ->disableOriginalConstructor()
+            ->getMockForAbstractClass();
         $this->payment = $this->initPayment();
+        $helper = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
+        $helper->setBackwardCompatibleProperty($this->payment, 'orderStateResolver', $this->orderStateResolverMock);
         $this->payment->setMethod('any');
         $this->payment->setOrder($this->orderMock);
         $this->transactionId = self::TRANSACTION_ID;
@@ -1465,6 +1481,9 @@ public function testRefund()
         $this->creditMemoMock->expects(static::once())
             ->method('getInvoice')
             ->willReturn($this->invoiceMock);
+        $this->creditMemoMock->expects(static::once())
+            ->method('getOrder')
+            ->willReturn($this->orderMock);
 
         $captureTranId = self::TRANSACTION_ID . '-' . Transaction::TYPE_CAPTURE;
         $captureTransaction = $this->getMockBuilder(Transaction::class)
@@ -1499,7 +1518,10 @@ public function testRefund()
 
         $status = 'status';
         $message = 'We refunded ' . $amount . ' online. Transaction ID: "' . $refundTranId . '"';
-        $this->mockGetDefaultStatus(Order::STATE_PROCESSING, $status);
+        $this->orderStateResolverMock->expects($this->once())->method('getStateForOrder')
+            ->with($this->orderMock)
+            ->willReturn(Order::STATE_CLOSED);
+        $this->mockGetDefaultStatus(Order::STATE_CLOSED, $status);
         $this->assertOrderUpdated(Order::STATE_PROCESSING, $status, $message);
 
         static::assertSame($this->payment, $this->payment->refund($this->creditMemoMock));

app/code/Magento/Sales/Test/Unit/Model/RefundInvoiceTest.php

@@ -287,6 +287,7 @@ public function testOrderCreditmemo($invoiceId, $items, $notify, $appendComment)
             ->method('validate')
             ->with($this->creditmemoItemCreationMock)
             ->willReturn([]);
+        $this->orderMock->expects($this->once())->method('setCustomerNoteNotify')->with($notify);
         $this->paymentAdapterMock->expects($this->once())
             ->method('refund')
             ->with($this->creditmemoMock, $this->orderMock)

app/code/Magento/Sales/Test/Unit/Model/RefundOrderTest.php

@@ -238,6 +238,7 @@ public function testOrderCreditmemo($orderId, $notify, $appendComment)
                 [CreationQuantityValidator::class],
                 $this->orderMock
             )->willReturn([]);
+        $this->orderMock->expects($this->once())->method('setCustomerNoteNotify')->with($notify);
         $this->paymentAdapterMock->expects($this->once())
             ->method('refund')
             ->with($this->creditmemoMock, $this->orderMock)
@@ -246,41 +247,33 @@ public function testOrderCreditmemo($orderId, $notify, $appendComment)
             ->method('getStateForOrder')
             ->with($this->orderMock, [])
             ->willReturn(Order::STATE_CLOSED);
-
         $this->orderMock->expects($this->once())
             ->method('setState')
             ->with(Order::STATE_CLOSED)
             ->willReturnSelf();
-
         $this->orderMock->expects($this->once())
             ->method('getState')
             ->willReturn(Order::STATE_CLOSED);
-
         $this->configMock->expects($this->once())
             ->method('getStateDefaultStatus')
             ->with(Order::STATE_CLOSED)
             ->willReturn('Closed');
-
         $this->orderMock->expects($this->once())
             ->method('setStatus')
             ->with('Closed')
             ->willReturnSelf();
-
         $this->creditmemoMock->expects($this->once())
             ->method('setState')
             ->with(\Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED)
             ->willReturnSelf();
-
         $this->creditmemoRepositoryMock->expects($this->once())
             ->method('save')
             ->with($this->creditmemoMock)
             ->willReturn($this->creditmemoMock);
-
         $this->orderRepositoryMock->expects($this->once())
             ->method('save')
             ->with($this->orderMock)
             ->willReturn($this->orderMock);
-
         if ($notify) {
             $this->notifierMock->expects($this->once())
                 ->method('notify')

dev/tests/functional/tests/app/Magento/Sales/Test/Block/Adminhtml/Order/History.php

@@ -21,6 +21,20 @@ class History extends Block
      */
     protected $commentHistory = '.note-list-comment';
 
+    /**
+     * Comment history status.
+     *
+     * @var string
+     */
+    protected $commentHistoryStatus = '.note-list-status';
+
+    /**
+     * Comment history notified status.
+     *
+     * @var string
+     */
+    protected $commentHistoryNotifiedStatus = '.note-list-customer';
+
     /**
      * Authorized Amount.
      *
@@ -103,6 +117,28 @@ public function getRefundedAmount()
         return $result;
     }
 
+    /**
+     * Gets the status which presented in comment
+     *
+     * @return string
+     */
+    public function getStatus()
+    {
+        $this->waitCommentsHistory();
+        return $this->_rootElement->find($this->commentHistoryStatus, Locator::SELECTOR_CSS)->getText();
+    }
+
+    /**
+     * Gets the is customer notified status which presented in comment
+     *
+     * @return string
+     */
+    public function getNotifiedStatus()
+    {
+        $this->waitCommentsHistory();
+        return $this->_rootElement->find($this->commentHistoryNotifiedStatus, Locator::SELECTOR_CSS)->getText();
+    }
+
     /**
      * Wait for comments history is visible.
      *

dev/tests/functional/tests/app/Magento/Sales/Test/Constraint/AssertOrderCommentsHistoryNotifyStatus.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Sales\Test\Constraint;
+
+use Magento\Sales\Test\Page\Adminhtml\SalesOrderView;
+use Magento\Sales\Test\Page\Adminhtml\OrderIndex;
+use Magento\Mtf\Constraint\AbstractConstraint;
+use Magento\Sales\Test\Fixture\OrderInjectable;
+
+/**
+ * Class AssertOrderCommentsHistoryNotifyStatus
+ */
+class AssertOrderCommentsHistoryNotifyStatus extends AbstractConstraint
+{
+    /**
+     * Assert that comment about refunded amount exist in Comments History section on order page in Admin.
+     *
+     * @param SalesOrderView $salesOrderView
+     * @param OrderIndex $salesOrder
+     * @param OrderInjectable $order
+     * @param array $data
+     */
+    public function processAssert(
+        SalesOrderView $salesOrderView,
+        OrderIndex $salesOrder,
+        OrderInjectable $order,
+        array $data
+    ) {
+        $salesOrder->open();
+        $salesOrder->getSalesOrderGrid()->searchAndOpen(['id' => $order->getId()]);
+        $sendMail = isset($data['form_data']['send_email']) ? filter_var(
+            $data['form_data']['send_email'],
+            FILTER_VALIDATE_BOOLEAN
+        ) : false;
+        \PHPUnit_Framework_Assert::assertContains(
+            $salesOrderView->getOrderHistoryBlock()->getNotifiedStatus(),
+            (bool)$sendMail ? 'Customer Notified' : 'Customer Not Notified'
+        );
+    }
+
+    /**
+     * Returns string representation of successful assertion.
+     *
+     * @return string
+     */
+    public function toString()
+    {
+        return "Message with appropriate notification status is available in Comments History section.";
+    }
+}