PyzTest\Glue\Orders\RestApi\OrdersRestApiCest

Complexity

Total Complexity

10

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	requestGetOrderDetailsWithoutAuthorizationToken()	0	20	1
A	requestGetEmptyListOfOrders()	0	23	1
A	requestGetOrderDetails()	0	29	1
A	requestGetCustomerOrder()	0	22	1
A	authorizeCustomer()	0	5	1
A	loadFixtures()	0	5	1
A	requestGetOrderDetailsWithIncorrectOrderReference()	0	20	1
A	requestGetListOfOrdersWithSingleOrder()	0	32	1
A	requestGetCustomerOrderAuthorizationError()	0	21	1
A	requestGetListOfOrderWithoutAuthorizationToken()	0	11	1

<?php

/**
 * This file is part of the Spryker Commerce OS.
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

declare(strict_types = 1);

namespace PyzTest\Glue\Orders\RestApi;

use Codeception\Util\HttpCode;
use Generated\Shared\Transfer\CustomerTransfer;
use PyzTest\Glue\Orders\OrdersApiTester;
use Spryker\Glue\OrdersRestApi\OrdersRestApiConfig;

/**
 * Auto-generated group annotations
 *
 * @group PyzTest
 * @group Glue
 * @group Orders
 * @group RestApi
 * @group OrdersRestApiCest
 * Add your own group annotations below this line
 * @group EndToEnd
 */
class OrdersRestApiCest
{
    /**
     * @var \PyzTest\Glue\Orders\RestApi\OrdersRestApiFixtures
     */
    protected OrdersRestApiFixtures $fixtures;

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function loadFixtures(OrdersApiTester $I): void
    {
        /** @var \PyzTest\Glue\Orders\RestApi\OrdersRestApiFixtures $fixtures */
        $fixtures = $I->loadFixtures(OrdersRestApiFixtures::class);
        $this->fixtures = $fixtures;
    }

    /**
     * @depends loadFixtures
     *
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function requestGetEmptyListOfOrders(OrdersApiTester $I): void
    {
        // Arrange
        $this->authorizeCustomer($I, $this->fixtures->getCustomerWithoutOrders());

        // Act
        $I->sendGET(
            $I->formatUrl(OrdersRestApiConfig::RESOURCE_ORDERS),
        );

        // Assert
        $I->seeResponseCodeIs(HttpCode::OK);
        $I->seeResponseIsJson();
        $I->seeResponseMatchesOpenApiSchema();

        $I->amSure('The returned resource contains empty collection')
            ->whenI()
            ->seeResponseDataContainsEmptyCollection();

It seems like seeResponseDataContainsEmptyCollection() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $I->amSure('The returned resource has correct self-link')
            ->whenI()
            ->seeResponseLinksContainsSelfLink(

It seems like seeResponseLinksContainsSelfLink() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                $I->formatFullUrl(OrdersRestApiConfig::RESOURCE_ORDERS),
            );
    }

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function requestGetListOfOrdersWithSingleOrder(OrdersApiTester $I): void
    {
        // Arrange
        $this->authorizeCustomer($I, $this->fixtures->getCustomerWithOrders());

        // Act
        $I->sendGET(
            $I->formatUrl(OrdersRestApiConfig::RESOURCE_ORDERS),
        );

        // Assert
        $I->seeResponseCodeIs(HttpCode::OK);
        $I->seeResponseIsJson();
        $I->seeResponseMatchesOpenApiSchema();

        $I->amSure('The returned resource has correct self-link')
            ->whenI()
            ->seeResponseLinksContainsSelfLink(
                $I->formatFullUrl(OrdersRestApiConfig::RESOURCE_ORDERS),
            );

        $I->amSure('The returned resource has not empty collection')
            ->whenI()
            ->seeResponseDataContainsNonEmptyCollection();

It seems like seeResponseDataContainsNonEmptyCollection() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $I->amSure('The returned resource has correct resource collection type')
            ->whenI()
            ->seeResponseDataContainsResourceCollectionOfType('orders');

It seems like seeResponseDataContainsResourceCollectionOfType() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $I->amSure('The returned resource has correct size')
            ->whenI()
            ->seeResponseDataContainsResourceCollectionOfTypeWithSizeOf('orders', 1);

It seems like seeResponseDataContainsResourceCollectionOfTypeWithSizeOf() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function requestGetOrderDetails(OrdersApiTester $I): void
    {
        // Arrange
        $this->authorizeCustomer($I, $this->fixtures->getCustomerWithOrders());
        $orderReference = $this->fixtures->geSaveOrderTransfer()->getOrderReference();

        // Act
        $I->sendGET(
            $I->formatUrl(
                '{orders}/{customerOrderReference}',
                [
                    'orders' => OrdersRestApiConfig::RESOURCE_ORDERS,
                    'customerOrderReference' => $orderReference,
                ],
            ),
        );

        // Assert
        $I->seeResponseCodeIs(HttpCode::OK);
        $I->seeResponseIsJson();
        $I->seeResponseMatchesOpenApiSchema();

        $I->amSure('The returned resource is of correct type')
            ->whenI()
            ->seeResponseDataContainsSingleResourceOfType('orders');

It seems like seeResponseDataContainsSingleResourceOfType() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $I->amSure('The returned resource has correct id')
            ->whenI()
            ->seeSingleResourceIdEqualTo($orderReference);

It seems like seeSingleResourceIdEqualTo() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function requestGetCustomerOrder(OrdersApiTester $I): void
    {
        // Arrange
        $customerTransfer = $this->fixtures->getCustomerWithOrders();
        $this->authorizeCustomer($I, $customerTransfer);

        // Act
        $I->sendGET(
            $I->formatUrl(
                '{customer}/{customerReference}/{orders}',
                [
                    'customer' => OrdersRestApiConfig::RESOURCE_CUSTOMERS,
                    'customerReference' => $customerTransfer->getCustomerReference(),
                    'orders' => OrdersRestApiConfig::RESOURCE_ORDERS,
                ],
            ),
        );

        // Assert
        $I->seeResponseCodeIs(HttpCode::OK);
        $I->seeResponseIsJson();
        $I->seeResponseMatchesOpenApiSchema();
    }

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function requestGetCustomerOrderAuthorizationError(OrdersApiTester $I): void
    {
        // Arrange
        $this->authorizeCustomer($I, $this->fixtures->getCustomerWithOrders());

        // Act
        $I->sendGET(
            $I->formatUrl(
                '{customer}/{customerReference}/{orders}',
                [
                    'customer' => OrdersRestApiConfig::RESOURCE_CUSTOMERS,
                    'customerReference' => 'wrongCustomerReference',
                    'orders' => OrdersRestApiConfig::RESOURCE_ORDERS,
                ],
            ),
        );

        // Assert
        $I->seeResponseCodeIs(HttpCode::FORBIDDEN);
        $I->seeResponseIsJson();
        $I->seeResponseMatchesOpenApiSchema();
    }

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function requestGetListOfOrderWithoutAuthorizationToken(OrdersApiTester $I): void
    {
        // Act
        $I->sendGET(
            $I->formatUrl(OrdersRestApiConfig::RESOURCE_ORDERS),
        );

        // Assert
        $I->seeResponseCodeIs(HttpCode::FORBIDDEN);
        $I->seeResponseIsJson();
        $I->seeResponseMatchesOpenApiSchema();
    }

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function requestGetOrderDetailsWithoutAuthorizationToken(OrdersApiTester $I): void
    {
        // Arrange
        $orderReference = $this->fixtures->geSaveOrderTransfer()->getOrderReference();

        // Act
        $I->sendGET(
            $I->formatUrl(
                '{orders}/{customerOrderReference}',
                [
                    'orders' => OrdersRestApiConfig::RESOURCE_ORDERS,
                    'customerOrderReference' => $orderReference,
                ],
            ),
        );

        // Assert
        $I->seeResponseCodeIs(HttpCode::FORBIDDEN);
        $I->seeResponseIsJson();
        $I->seeResponseMatchesOpenApiSchema();
    }

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     *
     * @return void
     */
    public function requestGetOrderDetailsWithIncorrectOrderReference(OrdersApiTester $I): void
    {
        // Arrange
        $this->authorizeCustomer($I, $this->fixtures->getCustomerWithOrders());

        // Act
        $I->sendGET(
            $I->formatUrl(
                '{orders}/{customerOrderReference}',
                [
                    'orders' => OrdersRestApiConfig::RESOURCE_ORDERS,
                    'customerOrderReference' => 'test',
                ],
            ),
        );

        // Assert
        $I->seeResponseCodeIs(HttpCode::NOT_FOUND);
        $I->seeResponseIsJson();
        $I->seeResponseMatchesOpenApiSchema();
    }

    /**
     * @param \PyzTest\Glue\Orders\OrdersApiTester $I
     * @param \Generated\Shared\Transfer\CustomerTransfer $customerTransfer
     *
     * @return void
     */
    protected function authorizeCustomer(OrdersApiTester $I, CustomerTransfer $customerTransfer): void
    {
        $token = $I->haveAuthorizationToGlue($customerTransfer)->getAccessToken();

        $I->amBearerAuthenticated($token);
    }
}