[ECP-8677] Make /donations endpoints more testable and write API functional tests (#2356)

* setup api functional tests for donations

* [ECP-8677] Update the payload

* [ECP-8677] Make the donation functionality more testable and update the test

* [ECP-8677] Use https for base url

* [ECP-8677] Formatting

* [ECP-8677] Fix class name

* [ECP-8677] Remove type declaration

* Revert "[ECP-8677] Use https for base url"

This reverts commit 0636b89.

* [ECP-8677] Write unit tests

* [ECP-8677] Update test mock

* [ECP-8677] Use generated mock for factory classes

* [ECP-8677] Remove method argument and use property instead

* [ECP-8677] Write unit tests

* [ECP-8677] Exclude view directory from SonarCloud

* [ECP-8677] Update unit test

* [ECP-8677] Update unit test mocks

---------

Co-authored-by: RokPopov <[email protected]>
Co-authored-by: raoulritter <[email protected]>

Author: 3 people

.github/Makefile

@@ -103,6 +103,13 @@ graphql:
 	@cd ${MAGENTO_ROOT}/dev/tests/api-functional && \
 		${MAGENTO_ROOT}/vendor/bin/phpunit --prepend ${GRAPHQL_PHP} --configuration ${GRAPHQL_XML} ${GRAPHQL_SUITE}
 
+# REST API tests
+restapi:
+	@cd ${MAGENTO_ROOT}/dev/tests/api-functional && \
+        ${MAGENTO_ROOT}/vendor/bin/phpunit --prepend /data/extensions/workdir/Test/phpunit_rest.php \
+        --configuration ${MAGENTO_ROOT}/dev/tests/api-functional/phpunit_rest.xml.dist \
+        ${MAGENTO_ROOT}/vendor/adyen/module-payment/Test/api-functional/Webapi
+
 # Destroy services
 clean:
 	docker-compose -f workflows/templates/docker-compose.yml down --volumes --rmi local

.github/workflows/restapi-test.yml

@@ -0,0 +1,43 @@
+name: REST API Tests
+on: [pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        php-version: ["8.1"]
+        magento-version: ["2.4.5"]
+    runs-on: ubuntu-latest
+    env:
+      PHP_VERSION: ${{ matrix.php-version }}
+      MAGENTO_VERSION: ${{ matrix.magento-version }}
+      ADMIN_USERNAME: ${{secrets.MAGENTO_ADMIN_USERNAME}}
+      ADMIN_PASSWORD: ${{secrets.MAGENTO_ADMIN_PASSWORD}}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Magento
+        run: docker-compose -f .github/workflows/templates/docker-compose.yml run --rm web make magento
+
+      - name: Start web server in background
+        run: docker-compose -f .github/workflows/templates/docker-compose.yml up -d web
+        env:
+          DONATION_ACCOUNT: ${{secrets.DONATION_ACCOUNT}}
+          ADYEN_MERCHANT: ${{secrets.ADYEN_MERCHANT}}
+          ADYEN_API_KEY: ${{secrets.ADYEN_API_KEY}}
+          ADYEN_CLIENT_KEY: ${{secrets.ADYEN_CLIENT_KEY}}
+
+      - name: Setup permissions
+        run: docker exec magento2-container make fs
+
+      - name: Check install
+        run: docker exec magento2-container make sys-check
+
+      - name: Install plugin
+        run: docker exec -u www-data magento2-container make plugin
+
+      - run: docker exec magento2-container /etc/init.d/cron stop
+
+      - name: Run REST API tests
+        run: docker exec magento2-container make restapi

Api/AdyenDonationsInterface.php

@@ -17,8 +17,9 @@ interface AdyenDonationsInterface
     /**
      * Build and send donation payment request
      *
+     * @param int $orderId
      * @param string $payload
      * @return void
      */
-    public function donate(string $payload): void;
+    public function donate(int $orderId, string $payload): void;
 }

Api/GuestAdyenDonationsInterface.php

@@ -17,9 +17,9 @@ interface GuestAdyenDonationsInterface
     /**
      * Build and send donation payment request for guest shoppers
      *
+     * @param string $cartId
      * @param string $payload
-     * @param string $orderId
      * @return void
      */
-    public function donate(string $payload, string $orderId): void;
+    public function donate(string $cartId, string $payload): void;
 }

Block/Checkout/Success.php

@@ -15,7 +15,10 @@
 use Adyen\Payment\Helper\Data;
 use Adyen\Payment\Helper\PaymentResponseHandler;
 use Adyen\Payment\Model\Ui\AdyenCheckoutSuccessConfigProvider;
-use Magento\Checkout\Model\Session;
+use Magento\Checkout\Model\Session as CheckoutSession;
+use Magento\Customer\Model\Session as CustomerSession;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Quote\Model\QuoteIdToMaskedQuoteId;
 use Magento\Framework\Serialize\SerializerInterface;
 use Magento\Framework\View\Element\Template;
 use Magento\Framework\View\Element\Template\Context;
@@ -25,62 +28,22 @@
 
 class Success extends Template
 {
-
-    /**
-     * @var Order $order
-     */
     protected $order;
+    protected CheckoutSession $checkoutSession;
+    protected CustomerSession $customerSession;
+    protected OrderFactory $orderFactory;
+    protected Data $adyenHelper;
+    protected StoreManagerInterface $storeManager;
+    private Config $configHelper;
+    private SerializerInterface $serializerInterface;
+    private AdyenCheckoutSuccessConfigProvider $configProvider;
+    private QuoteIdToMaskedQuoteId $quoteIdToMaskedQuoteId;
 
-    /**
-     * @var Session
-     */
-    protected $checkoutSession;
-
-    /**
-     * @var OrderFactory
-     */
-    protected $orderFactory;
-
-
-    /**
-     * @var Data
-     */
-    protected $adyenHelper;
-
-    /**
-     * @var StoreManagerInterface
-     */
-    protected $storeManager;
-
-    /**
-     * @var Config
-     */
-    private $configHelper;
-
-    /**
-     * @var SerializerInterface
-     */
-    private $serializerInterface;
-
-    /**
-     * @var AdyenCheckoutSuccessConfigProvider
-     */
-    private $configProvider;
-
-    /**
-     * Success constructor.
-     *
-     * @param Context $context
-     * @param Session $checkoutSession
-     * @param OrderFactory $orderFactory
-     * @param Data $adyenHelper
-     * @param Config $configHelper
-     * @param StoreManagerInterface $storeManager
-     * @param array $data
-     */
     public function __construct(
         Context $context,
-        Session $checkoutSession,
+        CheckoutSession $checkoutSession,
+        CustomerSession $customerSession,
+        QuoteIdToMaskedQuoteId $quoteIdToMaskedQuoteId,
         OrderFactory $orderFactory,
         Data $adyenHelper,
         Config $configHelper,
@@ -90,6 +53,8 @@ public function __construct(
         array $data = []
     ) {
         $this->checkoutSession = $checkoutSession;
+        $this->customerSession = $customerSession;
+        $this->quoteIdToMaskedQuoteId = $quoteIdToMaskedQuoteId;
         $this->orderFactory = $orderFactory;
         $this->adyenHelper = $adyenHelper;
         $this->configHelper = $configHelper;
@@ -204,4 +169,16 @@ public function getOrder()
         return $this->order;
     }
 
+    /**
+     * @throws NoSuchEntityException
+     */
+    public function getMaskedQuoteId(): ?string
+    {
+        return $this->quoteIdToMaskedQuoteId->execute($this->getOrder()->getQuoteId());
+    }
+
+    public function getIsCustomerLoggedIn(): bool
+    {
+        return $this->customerSession->isLoggedIn();
+    }
 }

Model/Api/AdyenDonations.php

@@ -17,53 +17,63 @@
 use Adyen\Payment\Helper\Config;
 use Adyen\Payment\Helper\Data;
 use Adyen\Payment\Helper\PaymentMethods;
+use Adyen\Payment\Model\Sales\OrderRepository;
 use Adyen\Payment\Model\Ui\AdyenCcConfigProvider;
 use Adyen\Util\Uuid;
-use Magento\Checkout\Model\Session;
+use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Payment\Gateway\Command\CommandPoolInterface;
+use Magento\Sales\Api\Data\OrderInterface;
 use Magento\Sales\Model\Order;
-use Magento\Sales\Model\OrderFactory;
 
 class AdyenDonations implements AdyenDonationsInterface
 {
     private CommandPoolInterface $commandPool;
-    private Session $checkoutSession;
-    private OrderFactory $orderFactory;
     private Json $jsonSerializer;
     protected Data $dataHelper;
     private ChargedCurrency $chargedCurrency;
     private Config $config;
     private PaymentMethods $paymentMethodsHelper;
+    private OrderRepository $orderRepository;
 
     private $donationTryCount;
 
     public function __construct(
         CommandPoolInterface $commandPool,
-        OrderFactory $orderFactory,
-        Session $checkoutSession,
         Json $jsonSerializer,
         Data $dataHelper,
         ChargedCurrency $chargedCurrency,
         Config $config,
-        PaymentMethods $paymentMethodsHelper
+        PaymentMethods $paymentMethodsHelper,
+        OrderRepository $orderRepository
     ) {
         $this->commandPool = $commandPool;
-        $this->orderFactory = $orderFactory;
-        $this->checkoutSession = $checkoutSession;
         $this->jsonSerializer = $jsonSerializer;
         $this->dataHelper = $dataHelper;
         $this->chargedCurrency = $chargedCurrency;
         $this->config = $config;
         $this->paymentMethodsHelper = $paymentMethodsHelper;
+        $this->orderRepository = $orderRepository;
     }
 
-    public function donate(string $payload): void
+    /**
+     * @throws NoSuchEntityException
+     * @throws LocalizedException
+     * @throws InputException
+     */
+    public function donate(int $orderId, string $payload): void
+    {
+        $order = $this->orderRepository->get($orderId);
+
+        $this->makeDonation($payload, $order);
+    }
+
+    public function makeDonation(string $payload, OrderInterface $order): void
     {
         $payload = $this->jsonSerializer->unserialize($payload);
-        /** @var Order */
-        $order = $this->orderFactory->create()->load($this->checkoutSession->getLastOrderId());
+
         $paymentMethodInstance = $order->getPayment()->getMethodInstance();
         $donationToken = $order->getPayment()->getAdditionalInformation('donationToken');
 

Model/Api/GuestAdyenDonations.php

@@ -12,38 +12,46 @@
 
 namespace Adyen\Payment\Model\Api;
 
+use Adyen\AdyenException;
 use Adyen\Payment\Api\GuestAdyenDonationsInterface;
-use Magento\Checkout\Model\Session;
+use Adyen\Payment\Model\Sales\OrderRepository;
 use Magento\Framework\Exception\LocalizedException;
-
+use Magento\Quote\Model\QuoteIdMaskFactory;
 
 class GuestAdyenDonations implements GuestAdyenDonationsInterface
 {
-    private $checkoutSession;
-    private $adyenDonationsModel;
+    private AdyenDonations $adyenDonationsModel;
+    private QuoteIdMaskFactory $quoteIdMaskFactory;
+    private OrderRepository $orderRepository;
 
     public function __construct(
-        Session $checkoutSession,
-        AdyenDonations $adyenDonationsModel
+        AdyenDonations $adyenDonationsModel,
+        QuoteIdMaskFactory $quoteIdMaskFactory,
+        OrderRepository $orderRepository
     ) {
-        $this->checkoutSession = $checkoutSession;
         $this->adyenDonationsModel = $adyenDonationsModel;
+        $this->quoteIdMaskFactory = $quoteIdMaskFactory;
+        $this->orderRepository = $orderRepository;
     }
 
     /**
+     * @param string $cartId
      * @param string $payload
-     * @param string $orderId
      * @return void
+     * @throws AdyenException
      * @throws LocalizedException
      */
-    public function donate(string $payload, string $orderId): void
+    public function donate(string $cartId, string $payload): void
     {
-        if ($this->checkoutSession->getLastOrderId() !== $orderId) {
-            throw new LocalizedException(
-                __("Donation failed!")
-            );
+        $quoteIdMask = $this->quoteIdMaskFactory->create()->load($cartId, 'masked_id');
+        $quoteId = $quoteIdMask->getQuoteId();
+
+        $order = $this->orderRepository->getOrderByQuoteId($quoteId);
+
+        if (!$order) {
+            throw new AdyenException('Donation Failed!');
         }
 
-        $this->adyenDonationsModel->donate($payload);
+        $this->adyenDonationsModel->makeDonation($payload, $order);
     }
 }