prestashop-module/tests/RetailcrmTest.php

<?php
/**
 * MIT License
 *
 * Copyright (c) 2021 DIGITAL RETAIL TECHNOLOGIES SL
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to http://www.prestashop.com for more information.
 *
 *  @author    DIGITAL RETAIL TECHNOLOGIES SL <mail@simlachat.com>
 *  @copyright 2021 DIGITAL RETAIL TECHNOLOGIES SL
 *  @license   https://opensource.org/licenses/MIT  The MIT License
 *
 * Don't forget to prefix your containers with your own identifier
 * to avoid any conflicts with others containers.
 */

class RetailCRMTest extends RetailcrmTestCase
{
    private $retailcrmModule;

    protected function setUp()
    {
        parent::setUp();

        $this->setConfig();

        $this->retailcrmModule = new RetailCRM();
        $this->retailcrmModule->api = $this->getApiMock(
            [
                'customersCreate',
                'customersEdit',
                'customersGet',
                'ordersCreate',
                'ordersEdit',
                'ordersGet',
                'ordersPaymentEdit',
                'ordersPaymentCreate',
            ]
        );
    }

    private function mockMethodsForOrderUpload($crmId, $cmsId, $reference)
    {
        $this->apiClientMock->expects($this->any())->method('ordersCreate')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'id' => $crmId,
                'order' => [
                    'externalId' => $cmsId,
                    'id' => $crmId,
                    'number' => $reference,
                ],
            ])
        ));
        $this->apiClientMock->expects($this->any())->method('ordersEdit')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'id' => $crmId,
                'order' => [
                    'externalId' => $cmsId,
                    'id' => $crmId,
                    'number' => $reference,
                ],
            ])
        ));
        $this->apiClientMock->expects($this->any())->method('customersGet')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'customer' => [],
            ])
        ));
        $this->apiClientMock->expects($this->any())->method('customersCreate')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'customer' => [],
            ])
        ));
        $this->apiClientMock->expects($this->any())->method('ordersPaymentCreate')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'payment' => [],
            ])
        ));
    }

    public function testUploadOrders()
    {
        Configuration::updateValue(RetailCRM::API_URL, 'https://test.test');
        Configuration::updateValue(RetailCRM::API_KEY, 'test_key');

        $order = new Order(1);
        $reference = $order->reference;
        $updReference = 'test';

        $this->apiClientMock->expects($this->any())->method('ordersGet')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'order' => [],
            ])
        ));

        $this->mockMethodsForOrderUpload(1, 1, $updReference);

        RetailcrmExport::$api = $this->retailcrmModule->api;

        Configuration::updateValue(RetailCRM::ENABLE_ORDER_NUMBER_RECEIVING, false);
        RetailcrmExport::uploadOrders([1]);
        $firstUpdOrder = new Order(1);

        $this->assertEquals($reference, $firstUpdOrder->reference);

        Configuration::updateValue(RetailCRM::ENABLE_ORDER_NUMBER_RECEIVING, true);
        RetailcrmExport::uploadOrders([1]);
        $secondUpdOrder = new Order(1);

        $this->assertEquals($updReference, $secondUpdOrder->reference);
    }

    public function testHookActionCustomerAccountAdd()
    {
        $newCustomer = new Customer(1);
        $params = ['newCustomer' => $newCustomer];

        $this->apiClientMock->expects($this->any())->method('customersGet')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'customer' => [],
            ])
        ));
        $this->apiClientMock->expects($this->any())->method('customersCreate')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'customer' => [],
            ])
        ));

        $this->assertTrue($this->retailcrmModule->hookActionCustomerAccountAdd($params));
    }

    public function testHookActionCustomerAccountUpdate()
    {
        $customer = new Customer(1);
        $params = ['customer' => $customer];

        $this->apiClientMock->expects($this->any())->method('customersGet')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'customer' => [
                    'phones' => [],
                ],
            ])
        ));
        $this->apiClientMock->expects($this->any())->method('customersEdit')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'customer' => [],
            ])
        ));

        $this->assertTrue($this->retailcrmModule->hookActionCustomerAccountUpdate($params));
    }

    public function testHookActionOrderEdited()
    {
        $order = new Order(1);
        $customer = new Customer($order->id_customer);
        $params = ['order' => $order, 'customer' => $customer];
        $reference = $order->reference;
        $updReference = 'test';

        $this->apiClientMock->expects($this->any())->method('ordersGet')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'order' => [
                    'number' => $updReference,
                ],
            ])
        ));

        $this->mockMethodsForOrderUpload(1, 1, $updReference);

        Configuration::updateValue(RetailCRM::ENABLE_ORDER_NUMBER_RECEIVING, false);

        $this->assertTrue($this->retailcrmModule->hookActionOrderEdited($params));
        $order = new Order(1);
        $this->assertEquals($reference, $order->reference);

        Configuration::updateValue(RetailCRM::ENABLE_ORDER_NUMBER_RECEIVING, true);

        $this->assertTrue($this->retailcrmModule->hookActionOrderEdited($params));
        $order = new Order(1);
        $this->assertEquals($updReference, $order->reference);
    }

    /**
     * @param $newOrder
     *
     * @dataProvider dataProvider
     */
    public function testHookActionOrderStatusPostUpdate($newOrder)
    {
        $order = new Order(1);
        $customer = new Customer($order->id_customer);
        $cart = $this->createMock('Cart');
        $cart->expects($this->any())->method('getProducts')->willReturn($this->getProducts());
        $cart->expects($this->any())->method('getAddressCollection')->willReturn($this->getAddressCollection());
        $status = new stdClass();
        $reference = $order->reference;
        $updReference = 'test';

        if (false === $newOrder) {
            $status->id = 11;

            $params = [
                'newOrderStatus' => $status,
                'id_order' => $order->id,
            ];
        } else {
            $status->id = 'new';

            $params = [
                'orderStatus' => $status,
                'customer' => $customer,
                'order' => $order,
                'cart' => $cart,
            ];

            $this->apiClientMock->expects($this->any())->method('ordersGet')->willReturn(new RetailcrmApiResponse(
                200,
                json_encode([
                    'success' => true,
                    'order' => [],
                ])
            ));
        }

        $this->mockMethodsForOrderUpload(1, 1, $updReference);

        Configuration::updateValue(RetailCRM::ENABLE_ORDER_NUMBER_RECEIVING, false);

        $this->assertTrue($this->retailcrmModule->hookActionOrderStatusPostUpdate($params));
        $this->assertEquals($reference, $order->reference);

        Configuration::updateValue(RetailCRM::ENABLE_ORDER_NUMBER_RECEIVING, true);

        $this->assertTrue($this->retailcrmModule->hookActionOrderStatusPostUpdate($params));
        $this->assertEquals($updReference, $order->reference);
    }

    /**
     * @param $ordersGet
     *
     * @dataProvider ordersGetDataProvider
     */
    public function testHookActionPaymentCCAdd($ordersGet)
    {
        $order = new Order(1);

        $orderPayment = RetailcrmTestHelper::createOrderPayment($order->reference);
        $cart = new Cart($order->id_cart);

        $params = [
            'paymentCC' => $orderPayment,
            'cart' => $cart,
        ];

        $this->apiClientMock->expects($this->any())->method('ordersPaymentCreate')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'payment' => [],
            ])
        ));
        $this->apiClientMock->expects($this->any())->method('ordersGet')->willReturn(new RetailcrmApiResponse(
            200,
            json_encode([
                'success' => true,
                'order' => [],
            ])
        ));

        $referenceMock = $this->createMock('RetailcrmReferences');
        $referenceMock->expects($this->once())->method('getSystemPaymentModules')->willReturn($this->getSystemPaymentModules());
        $this->retailcrmModule->reference = $referenceMock;
        $this->apiClientMock->expects($this->any())->method('ordersGet')->willReturn($ordersGet);

        $result = $this->retailcrmModule->hookActionPaymentCCAdd($params);

        $this->assertInternalType('bool', $result);
        $this->assertTrue($result);

        RetailcrmTestHelper::deleteOrderPayment($orderPayment->id);
    }

    /**
     * @return array
     */
    public function dataProvider()
    {
        return [
            [
                'newOrder' => true,
            ],
            [
                'newOrder' => false,
            ],
        ];
    }

    /**
     * @return array
     */
    public function ordersGetDataProvider()
    {
        return [
            [
                'ordersGet' => [
                    'success' => true,
                    'order' => [
                        'payments' => [
                            [
                                'type' => 'bankwire',
                            ],
                        ],
                        'totalSumm' => 1500,
                    ],
                ],
            ],
            [
                'ordersGet' => [
                    'success' => true,
                    'order' => [
                        'payments' => [
                            [
                                'type' => 'cheque',
                            ],
                        ],
                        'totalSumm' => 1500,
                    ],
                ],
            ],
        ];
    }

    /**
     * @return array
     */
    private function getProducts()
    {
        return [
            [
                'id_product_attribute' => 1,
                'id_product' => 1,
                'attributes' => '',
                'rate' => 1,
                'price' => 100,
                'name' => 'Test product 1',
                'quantity' => 2,
            ],
            [
                'id_product_attribute' => 1,
                'id_product' => 2,
                'attributes' => '',
                'rate' => 1,
                'price' => 100,
                'name' => 'Test product 2',
                'quantity' => 1,
            ],
        ];
    }

    /**
     * @return array
     */
    private function getAddressCollection()
    {
        $address = new Address(1);

        return [$address];
    }

    /**
     * @return array
     */
    private function getSystemPaymentModules()
    {
        return [
            [
                'id' => '3',
                'code' => 'bankwire',
                'name' => 'Bank wire',
            ],
            [
                'id' => '30',
                'code' => 'cheque',
                'name' => 'Payment by check',
            ],
        ];
    }
}