CurlHandler.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\DataGenerator\Persist;

use Magento\FunctionalTestingFramework\DataGenerator\Persist\Curl\AdminExecutor;
use Magento\FunctionalTestingFramework\DataGenerator\Persist\Curl\FrontendExecutor;
use Magento\FunctionalTestingFramework\DataGenerator\Persist\Curl\WebapiExecutor;
use Magento\FunctionalTestingFramework\DataGenerator\Persist\Curl\WebapiNoAuthExecutor;
use Magento\FunctionalTestingFramework\DataGenerator\Handlers\OperationDefinitionObjectHandler;
use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
use Magento\FunctionalTestingFramework\DataGenerator\Objects\OperationDefinitionObject;
use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
use Magento\FunctionalTestingFramework\Util\Protocol\CurlInterface;

class CurlHandler
{
    private $operation;

    private $entityObject;

    private $operationDefinition;

    private $requestData;

    private $storeCode;

    private $isJson;

    private static $curlMethodMapping = [
            'create' => CurlInterface::POST,
            'delete' => CurlInterface::DELETE,
            'update' => CurlInterface::PUT,
            'get' => CurlInterface::GET,
        ];

    public function __construct($operation, $entityObject, $storeCode = null)
    {
        $this->operation = $operation;
        $this->entityObject = $entityObject;
        $this->storeCode = $storeCode;

        $this->operationDefinition = OperationDefinitionObjectHandler::getInstance()->getOperationDefinition(
            $this->operation,
            $this->entityObject->getType()
        );
        $this->isJson = false;
    }

    public function executeRequest($dependentEntities)
    {
        $executor = null;
        $successRegex = null;
        $returnRegex = null;

        if ((null !== $dependentEntities) && is_array($dependentEntities)) {
            $entities = array_merge([$this->entityObject], $dependentEntities);
        } else {
            $entities = [$this->entityObject];
        }
        $apiUrl = $this->resolveUrlReference($this->operationDefinition->getApiUrl(), $entities);
        $headers = $this->operationDefinition->getHeaders();
        $authorization = $this->operationDefinition->getAuth();
        $contentType = $this->operationDefinition->getContentType();
        $successRegex = $this->operationDefinition->getSuccessRegex();
        $returnRegex = $this->operationDefinition->getReturnRegex();

        $operationDataResolver = new OperationDataArrayResolver($dependentEntities);
        $this->requestData = $operationDataResolver->resolveOperationDataArray(
            $this->entityObject,
            $this->operationDefinition->getOperationMetadata(),
            $this->operationDefinition->getOperation(),
            false
        );

        if (($contentType === 'application/json') && ($authorization === 'adminOauth')) {
            $this->isJson = true;
            $executor = new WebapiExecutor($this->storeCode);
        } elseif ($authorization === 'adminFormKey') {
            $executor = new AdminExecutor($this->operationDefinition->removeUrlBackend());
        } elseif ($authorization === 'customerFormKey') {
            $executor = new FrontendExecutor(
                $this->requestData['customer_email'],
                $this->requestData['customer_password']
            );
        } elseif ($authorization === 'anonymous') {
            $this->isJson = true;
            $executor = new WebapiNoAuthExecutor($this->storeCode);
        }

        if (!$executor) {
            throw new TestFrameworkException(
                sprintf(
                    "Invalid content type and/or auth type. content type = %s, auth type = %s\n",
                    $contentType,
                    $authorization
                )
            );
        }

        $executor->write(
            $apiUrl,
            $this->requestData,
            self::$curlMethodMapping[$this->operation],
            $headers
        );

        $response = $executor->read($successRegex, $returnRegex);
        $executor->close();

        return $response;
    }

    public function getRequestDataArray()
    {
        return $this->requestData;
    }

    public function isContentTypeJson()
    {
        return $this->isJson;
    }

    private function resolveUrlReference($urlIn, $entityObjects)
    {
        $urlOut = $urlIn;
        $matchedParams = [];
        preg_match_all("/[{](.+?)[}]/", $urlIn, $matchedParams);

        if (!empty($matchedParams)) {
            foreach ($matchedParams[0] as $paramKey => $paramValue) {
                foreach ($entityObjects as $entityObject) {
                    $param = $entityObject->getDataByName(
                        $matchedParams[1][$paramKey],
                        EntityDataObject::CEST_UNIQUE_VALUE
                    );
                    if (null !== $param) {
                        $urlOut = str_replace($paramValue, $param, $urlOut);
                        continue;
                    }
                }
            }
        }
        return $urlOut;
    }
}