MC-29527: Support sale operation by Magento payment provider gateway

Author: viktym

app/code/Magento/Payment/Model/Method/Adapter.php

@@ -677,13 +677,11 @@ public function canSale(): bool
     /**
      * @inheritdoc
      */
-    public function sale(InfoInterface $payment, $amount)
+    public function sale(InfoInterface $payment, float $amount)
     {
         $this->executeCommand(
             'sale',
             ['payment' => $payment, 'amount' => $amount]
         );
-
-        return $this;
     }
 }

app/code/Magento/Payment/Model/SaleOperationInterface.php

@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Payment\Model;
 
 /**
@@ -24,7 +26,7 @@ public function canSale(): bool;
      *
      * @param InfoInterface $payment
      * @param float $amount
-     * @return $this
+     * @return void
      */
-    public function sale(InfoInterface $payment, $amount);
+    public function sale(InfoInterface $payment, float $amount);
 }

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

@@ -3,8 +3,11 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Sales\Model\Order\Payment\Operations;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Sales\Api\Data\InvoiceInterface;
 use Magento\Sales\Api\Data\OrderPaymentInterface;
 use Magento\Sales\Model\Order\Payment;
@@ -22,14 +25,17 @@ class ProcessInvoiceOperation extends AbstractOperation
      * @param InvoiceInterface $invoice
      * @param string $operationMethod
      * @return OrderPaymentInterface
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
-    public function execute(OrderPaymentInterface $payment, InvoiceInterface $invoice, string $operationMethod)
-    {
+    public function execute(
+        OrderPaymentInterface $payment,
+        InvoiceInterface $invoice,
+        string $operationMethod
+    ): OrderPaymentInterface {
         /**
          * @var $payment Payment
          */
-        $amountToCapture = $payment->formatAmount($invoice->getBaseGrandTotal());
+        $amountToCapture = $payment->formatAmount($invoice->getBaseGrandTotal(), true);
         $order = $payment->getOrder();
 
         $payment->setTransactionId(
@@ -63,7 +69,7 @@ public function execute(OrderPaymentInterface $payment, InvoiceInterface $invoic
         }
 
         if ($invoice->getIsPaid()) {
-            throw new \Magento\Framework\Exception\LocalizedException(
+            throw new LocalizedException(
                 __('The transaction "%1" cannot be captured yet.', $invoice->getTransactionId())
             );
         }

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

@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Sales\Model\Order\Payment\Operations;
 
 use Magento\Framework\Exception\LocalizedException;
@@ -36,19 +38,15 @@ public function __construct(
      * @return OrderPaymentInterface
      * @throws LocalizedException
      */
-    public function execute(OrderPaymentInterface $payment)
+    public function execute(OrderPaymentInterface $payment): OrderPaymentInterface
     {
         /** @var $payment Payment */
         $invoice = $payment->getOrder()->prepareInvoice();
         $invoice->register();
-
-        if ($payment->getMethodInstance()->canCapture()) {
-            $this->processInvoiceOperation->execute($payment, $invoice, 'sale');
-            if ($invoice->getIsPaid()) {
-                $invoice->pay();
-            }
+        $this->processInvoiceOperation->execute($payment, $invoice, 'sale');
+        if ($invoice->getIsPaid()) {
+            $invoice->pay();
         }
-
         $payment->getOrder()->addRelatedObject($invoice);
         $payment->setCreatedInvoice($invoice);
         if ($payment->getIsFraudDetected()) {

app/code/Magento/Sales/Test/Unit/Model/Order/Payment/Operations/SaleOperationTest.php

@@ -61,8 +61,6 @@ public function testExecute(Invoice $invoice)
 
         /** @var MethodInterface|\PHPUnit_Framework_MockObject_MockObject $paymentMethod */
         $paymentMethod = $this->getMockForAbstractClass(MethodInterface::class);
-        $paymentMethod->method('canCapture')
-            ->willReturn(true);
 
         /** @var Payment|\PHPUnit_Framework_MockObject_MockObject  $orderPayment| */
         $orderPayment = $this->getMockBuilder(Payment::class)

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

@@ -19,7 +19,7 @@
 use Magento\Sales\Model\Order\Payment;
 use Magento\Sales\Model\Order\Payment\Operations\SaleOperation;
 use Magento\Sales\Model\Order\Payment\Transaction;
-use PHPUnit_Framework_MockObject_MockObject as MockObject;
+use PHPUnit\Framework\MockObject\MockObject;
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
@@ -50,17 +50,17 @@ class PaymentTest extends \PHPUnit\Framework\TestCase
     private $helper;
 
     /**
-     * @var \Magento\Framework\Event\Manager | \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Framework\Event\Manager|MockObject
      */
     protected $eventManagerMock;
 
     /**
-     * @var \Magento\Directory\Model\PriceCurrency | \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Directory\Model\PriceCurrency|MockObject
      */
     protected $priceCurrencyMock;
 
     /**
-     * @var \Magento\Directory\Model\Currency | \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Directory\Model\Currency|MockObject
      */
     protected $currencyMock;
 
@@ -85,53 +85,53 @@ class PaymentTest extends \PHPUnit\Framework\TestCase
     private $transactionId;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @var MockObject
      */
     protected $transactionCollectionFactory;
 
     /**
-     * @var \Magento\Sales\Model\Order\CreditmemoFactory|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Sales\Model\Order\CreditmemoFactory|MockObject
      */
     protected $creditmemoFactoryMock;
 
     /**
-     * @var \Magento\Sales\Model\Order\Creditmemo | \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Sales\Model\Order\Creditmemo|MockObject
      */
     protected $creditMemoMock;
 
     /**
-     * @var \Magento\Sales\Model\Order\Payment\Transaction\Repository | \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Sales\Model\Order\Payment\Transaction\Repository|MockObject
      */
     protected $transactionRepositoryMock;
 
     /**
-     * @var \Magento\Sales\Model\Order\Payment\Transaction\ManagerInterface| \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Sales\Model\Order\Payment\Transaction\ManagerInterface|MockObject
      */
     protected $transactionManagerMock;
 
     /**
-     * @var \Magento\Sales\Model\Order\Payment\Transaction\BuilderInterface | \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Sales\Model\Order\Payment\Transaction\BuilderInterface|MockObject
      */
 
     protected $transactionBuilderMock;
 
     /**
-     * @var \Magento\Sales\Model\Order\Payment\Processor|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Sales\Model\Order\Payment\Processor|MockObject
      */
     protected $paymentProcessor;
 
     /**
-     * @var \Magento\Sales\Model\OrderRepository|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Sales\Model\OrderRepository|MockObject
      */
     protected $orderRepository;
 
     /**
-     * @var CreditmemoManagementInterface
+     * @var CreditmemoManagementInterface|MockObject
      */
     private $creditmemoManagerMock;
 
     /**
-     * @var SaleOperation|\PHPUnit_Framework_MockObject_MockObject
+     * @var SaleOperation|MockObject
      */
     private $saleOperation;