Behat tests for orders in the Back Office. Various Behat features created and scenarios added

classes/order/Order.php

@@ -53,6 +53,7 @@ class OrderCore extends ObjectModel
     /** @var int Customer id */
     public $id_customer;
 
+    // todo: string received instead of int
     /** @var int Carrier id */
     public $id_carrier;
 

src/Adapter/Address/CommandHandler/SetRequiredFieldsForAddressHandler.php

@@ -26,7 +26,7 @@
 
 namespace PrestaShop\PrestaShop\Adapter\Address\CommandHandler;
 
-use CustomerAddress;
+use Address;
 use PrestaShop\PrestaShop\Core\Domain\Address\Command\SetRequiredFieldsForAddressCommand;
 use PrestaShop\PrestaShop\Core\Domain\Address\CommandHandler\SetRequiredFieldsForAddressHandlerInterface;
 use PrestaShop\PrestaShop\Core\Domain\Address\Exception\CannotSetRequiredFieldsForAddressException;
@@ -46,7 +46,7 @@ final class SetRequiredFieldsForAddressHandler implements SetRequiredFieldsForAd
      */
     public function handle(SetRequiredFieldsForAddressCommand $command)
     {
-        $address = new CustomerAddress();
+        $address = new Address();
 
         try {
             if ($address->addFieldsRequiredDatabase($command->getRequiredFields())) {

src/Adapter/Order/CommandHandler/AddOrderFromBackOfficeHandler.php

@@ -88,7 +88,7 @@ public function handle(AddOrderFromBackOfficeCommand $command)
                 $cart->secure_key
             );
         } catch (Exception $e) {
-            throw new OrderException('Failed to add order.', 0, $e);
+            throw new OrderException('Failed to add order. ' . $e->getMessage(), 0, $e);
         }
 
         if (!$paymentModule->currentOrder) {

src/Core/Domain/Order/Command/AddOrderFromBackOfficeCommand.php

@@ -133,6 +133,8 @@ private function assertIsModuleName($moduleName)
 
     /**
      * @param int $orderStateId
+     *
+     * @throws OrderException
      */
     private function assertOrderStateIsPositiveInt($orderStateId)
     {

src/Core/Domain/Order/QueryResult/OrderPaymentsForViewing.php

@@ -29,6 +29,8 @@
 class OrderPaymentsForViewing
 {
     /**
+     * hint - collection would be better
+     *
      * @var OrderPaymentForViewing[]
      */
     private $payments = [];

src/Core/Domain/Order/QueryResult/OrderProductsForViewing.php

@@ -29,6 +29,8 @@
 class OrderProductsForViewing
 {
     /**
+     * hint - collection could be better
+     *
      * @var OrderProductForViewing[]
      */
     private $products = [];

src/Core/Domain/Order/QueryResult/OrderShippingForViewing.php

@@ -78,6 +78,8 @@ public function __construct(
     }
 
     /**
+     * hint - collection of OrderCarrierForViewing objects would be better
+     *
      * @return OrderCarrierForViewing[]
      */
     public function getCarriers(): array

src/Core/Domain/Product/Query/SearchProducts.php

@@ -46,8 +46,6 @@ class SearchProducts
     /**
      * @param string $phrase
      * @param int $resultsLimit
-     *
-     * @throws ProductException
      */
     public function __construct(string $phrase, int $resultsLimit)
     {

src/PrestaShopBundle/Controller/Admin/Sell/Order/OrderController.php

@@ -26,7 +26,10 @@
 
 namespace PrestaShopBundle\Controller\Admin\Sell\Order;
 
+use Context;
+use Currency;
 use Exception;
+use Language;
 use PrestaShop\PrestaShop\Core\Domain\Cart\Exception\CartConstraintException;
 use PrestaShop\PrestaShop\Core\Domain\Cart\Query\GetCartInformation;
 use PrestaShop\PrestaShop\Core\Domain\CustomerMessage\Command\AddOrderCustomerMessageCommand;
@@ -48,13 +51,13 @@
 use PrestaShop\PrestaShop\Core\Domain\Order\Exception\OrderNotFoundException;
 use PrestaShop\PrestaShop\Core\Domain\Order\Exception\TransistEmailSendingException;
 use PrestaShop\PrestaShop\Core\Domain\Order\Invoice\Command\GenerateInvoiceCommand;
-use PrestaShop\PrestaShop\Core\Domain\Order\OrderConstraints;
 use PrestaShop\PrestaShop\Core\Domain\Order\Invoice\Command\UpdateInvoiceNoteCommand;
+use PrestaShop\PrestaShop\Core\Domain\Order\OrderConstraints;
 use PrestaShop\PrestaShop\Core\Domain\Order\Payment\Command\AddPaymentCommand;
 use PrestaShop\PrestaShop\Core\Domain\Order\Product\Command\UpdateProductInOrderCommand;
 use PrestaShop\PrestaShop\Core\Domain\Order\Query\GetOrderForViewing;
-use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\Query\GetOrderPreview;
+use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderForViewing;
 use PrestaShop\PrestaShop\Core\Domain\Order\QueryResult\OrderPreview;
 use PrestaShop\PrestaShop\Core\Domain\Order\ValueObject\OrderId;
 use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\OrderGridDefinitionFactory;
@@ -137,8 +140,8 @@ private function getOrderToolbarButtons(): array
     public function createAction()
     {
         return $this->render('@PrestaShop/Admin/Sell/Order/Order/create.html.twig', [
-            'currencies' => \Currency::getCurrenciesByIdShop(\Context::getContext()->shop->id),
-            'languages' => \Language::getLanguages(true, \Context::getContext()->shop->id),
+            'currencies' => Currency::getCurrenciesByIdShop(Context::getContext()->shop->id),
+            'languages' => Language::getLanguages(true, Context::getContext()->shop->id),
         ]);
     }
 

tests/Integration/Behaviour/Features/Context/CarrierFeatureContext.php

@@ -196,6 +196,8 @@ public function createAddress($addressName, $postCode, $stateName)
         $address->alias = 'alias';
         $address->add();
         $this->addresses[$addressName] = $address;
+
+        SharedStorage::getStorage()->set($addressName, $address->id);
     }
 
     /**

tests/Integration/Behaviour/Features/Context/CustomerFeatureContext.php

@@ -88,7 +88,7 @@ public function customerHasAddressInCountry($reference, $isoCode)
             }
         }
 
-        throw new Exception(sprintf(
+        throw new RuntimeException(sprintf(
             'Customer does not have address in "%s" country',
             $isoCode
         ));

tests/Integration/Behaviour/Features/Context/CustomerManagerFeatureContext.php

@@ -32,6 +32,7 @@
 use PrestaShop\PrestaShop\Core\Domain\Customer\Command\DeleteCustomerCommand;
 use PrestaShop\PrestaShop\Core\Domain\Customer\Command\EditCustomerCommand;
 use PrestaShop\PrestaShop\Core\Domain\Customer\Command\TransformGuestToCustomerCommand;
+use PrestaShop\PrestaShop\Core\Domain\Customer\Exception\DuplicateCustomerEmailException;
 use PrestaShop\PrestaShop\Core\Domain\Customer\Query\GetCustomerForEditing;
 use PrestaShop\PrestaShop\Core\Domain\Customer\QueryResult\EditableCustomer;
 use PrestaShop\PrestaShop\Core\Domain\Customer\ValueObject\CustomerDeleteMethod;
@@ -65,6 +66,8 @@ class CustomerManagerFeatureContext extends AbstractPrestaShopFeatureContext
     protected $customerRegistry = [];
 
     /**
+     * todo hint: move to domain context?
+     *
      * @When /^I create a customer "(.+)" with following properties:$/
      */
     public function createACustomerUsingCommand($customerReference, TableNode $table)
@@ -110,9 +113,13 @@ public function createACustomerUsingCommand($customerReference, TableNode $table
 
         $this->latestResult = $id->getValue();
         $this->customerRegistry[$customerReference] = $id->getValue();
+
+        SharedStorage::getStorage()->set($customerReference, $id->getValue());
     }
 
     /**
+     * todo hint: move to domain context?
+     *
      * @When /^I attempt to create a customer "(.+)" with following properties:$/
      */
     public function attemptToCreateACustomerUsingCommand($customerReference, TableNode $table)
@@ -129,6 +136,24 @@ public function attemptToCreateACustomerUsingCommand($customerReference, TableNo
         }
     }
 
+    /**
+     * todo hint: move to domain context?
+     *
+     * @When I create not existing customer :customerReference with following properties:
+     *
+     * @param string $customerReference
+     * @param TableNode $table
+     */
+    public function iCreateNotExistingCustomerWithFollowingProperties(string $customerReference, TableNode $table)
+    {
+        try {
+            /** @var CustomerId $customerIdObject */
+            $customerIdObject = $this->createACustomerUsingCommand($customerReference, $table);
+            SharedStorage::getStorage()->set($customerReference, $customerIdObject->getValue());
+        } catch (DuplicateCustomerEmailException $e) {
+        }
+    }
+
     /**
      * @When /^I edit customer "(.+)" and I change the following properties:$/
      */

tests/Integration/Behaviour/Features/Context/Domain/AbstractDomainFeatureContext.php

@@ -104,8 +104,6 @@ protected function assertLastErrorIsNull()
     /**
      * @param string $expectedError
      * @param int|null $errorCode
-     *
-     * @throws RuntimeException
      */
     protected function assertLastErrorIs($expectedError, $errorCode = null)
     {

tests/Integration/Behaviour/Features/Context/Domain/CartFeatureContext.php

@@ -29,16 +29,18 @@
 use Cart;
 use Configuration;
 use Context;
-use Currency;
 use Country;
+use Currency;
+use Customer;
 use Exception;
 use PrestaShop\PrestaShop\Core\Domain\Cart\Command\CreateEmptyCustomerCartCommand;
 use PrestaShop\PrestaShop\Core\Domain\Cart\Command\SetFreeShippingToCartCommand;
 use PrestaShop\PrestaShop\Core\Domain\Cart\Command\UpdateCartAddressesCommand;
 use PrestaShop\PrestaShop\Core\Domain\Cart\Command\UpdateProductQuantityInCartCommand;
 use PrestaShop\PrestaShop\Core\Domain\Cart\ValueObject\CartId;
 use PrestaShop\PrestaShop\Core\Domain\Cart\ValueObject\QuantityAction;
-use Product;
+use PrestaShop\PrestaShop\Core\Domain\Product\Query\SearchProducts;
+use RuntimeException;
 use Tests\Integration\Behaviour\Features\Context\SharedStorage;
 
 class CartFeatureContext extends AbstractDomainFeatureContext
@@ -60,45 +62,64 @@ public function addCurrencyToContext($currencyIsoCode)
 
     /**
      * @When I create an empty cart :cartReference for customer :customerReference
+     *
+     * @param string $cartReference
+     * @param string $customerReference
      */
-    public function createEmptyCartForCustomer($cartReference, $customerReference)
+    public function createEmptyCartForCustomer(string $cartReference, string $customerReference)
     {
         // Clear static cache each time you create a cart
         Cart::resetStaticCache();
+        /** @var Customer $customer */
         $customer = SharedStorage::getStorage()->get($customerReference);
 
-        /** @var CartId $cartId */
-        $cartId = $this->getCommandBus()->handle(
+        /** @var CartId $cartIdObject */
+        $cartIdObject = $this->getCommandBus()->handle(
             new CreateEmptyCustomerCartCommand(
-                (int) $customer->id,
-                (int) Context::getContext()->shop->id
+                (int) $customer->id
             )
         );
 
-        SharedStorage::getStorage()->set($cartReference, new Cart($cartId->getValue()));
+        SharedStorage::getStorage()->set($cartReference, $cartIdObject->getValue());
     }
 
     /**
-     * @When I add :quantity products with reference :productReference to the cart :reference
+     * @When I add :quantity products :productName to the cart :cartReference
+     *
+     * @param int $quantity
+     * @param string $productName
+     * @param string $cartReference
      */
-    public function addProductToCarts($quantity, $productReference, $reference)
+    public function addProductsToCarts(int $quantity, string $productName, string $cartReference)
     {
-        $productId = (int) Product::getIdByReference($productReference);
+        /** @var array $productsMap */
+        $productsMap = $this->getQueryBus()->handle(new SearchProducts($productName, 1));
+        $productId = array_key_first($productsMap);
+
+        if (!$productId) {
+            throw new RuntimeException('Product with name "%s" does not exist', $productName);
+        }
 
         $this->getCommandBus()->handle(
             new UpdateProductQuantityInCartCommand(
-                (int) SharedStorage::getStorage()->get($reference)->id,
+                SharedStorage::getStorage()->get($cartReference),
                 $productId,
                 (int) $quantity,
                 QuantityAction::INCREASE_PRODUCT_QUANTITY
             )
         );
+
+        SharedStorage::getStorage()->set($productName, $productId);
     }
 
     /**
      * @When I select :countryIsoCode address as delivery and invoice address for customer :customerReference in cart :cartReference
+     *
+     * @param string $countryIsoCode
+     * @param string $customerReference
+     * @param string $cartReference
      */
-    public function selectAddressAsDeliveryAndInvoiceAddress($countryIsoCode, $customerReference, $cartReference)
+    public function selectAddressAsDeliveryAndInvoiceAddress(string $countryIsoCode, string $customerReference, string $cartReference)
     {
         $customer = SharedStorage::getStorage()->get($customerReference);
 
@@ -120,21 +141,23 @@ public function selectAddressAsDeliveryAndInvoiceAddress($countryIsoCode, $custo
 
         $this->getCommandBus()->handle(
             new UpdateCartAddressesCommand(
-                (int) SharedStorage::getStorage()->get($cartReference)->id,
+                (int) SharedStorage::getStorage()->get($cartReference),
                 $addressId,
                 $addressId
             )
         );
     }
 
     /**
-     * @When I set Free shipping to the cart :reference
+     * @When I set Free shipping to the cart :cartReference
+     *
+     * @param string $cartReference
      */
-    public function setFreeShippingToCart($reference)
+    public function setFreeShippingToCart(string $cartReference)
     {
         $this->getCommandBus()->handle(
             new SetFreeShippingToCartCommand(
-                (int) SharedStorage::getStorage()->get($reference)->id,
+                SharedStorage::getStorage()->get($cartReference),
                 true
             )
         );