EntityDataObject.php

Go to the documentation of this file.

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

use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;

class EntityDataObject
{
    const NO_UNIQUE_PROCESS = 0;
    const SUITE_UNIQUE_VALUE = 1;
    const CEST_UNIQUE_VALUE = 2;
    const SUITE_UNIQUE_NOTATION = 3;
    const CEST_UNIQUE_NOTATION = 4;
    const SUITE_UNIQUE_FUNCTION = 'msqs';
    const CEST_UNIQUE_FUNCTION = 'msq';

    private $name;

    private $type;

    private $linkedEntities = [];

    private $vars;

    private $data = [];

    private $uniquenessData = [];

    private $parentEntity;

    public function __construct($name, $type, $data, $linkedEntities, $uniquenessData, $vars = [], $parentEntity = null)
    {
        $this->name = $name;
        $this->type = $type;
        $this->data = $data;
        $this->linkedEntities = $linkedEntities;
        if ($uniquenessData) {
            $this->uniquenessData = $uniquenessData;
        }

        $this->vars = $vars;
        $this->parentEntity = $parentEntity;
    }

    public function getName()
    {
        return $this->name;
    }

    public function getType()
    {
        return $this->type;
    }

    public function getAllData()
    {
        return $this->data;
    }

    public function getDataByName($name, $uniquenessFormat)
    {
        if (MftfApplicationConfig::getConfig()->verboseEnabled()) {
            LoggingUtil::getInstance()->getLogger(EntityDataObject::class)
                ->debug("Fetching data field from entity", ["entity" => $this->getName(), "field" => $name]);
        }

        if (!$this->isValidUniqueDataFormat($uniquenessFormat)) {
            $exceptionMessage = sprintf("Invalid unique data format value: %s \n", $uniquenessFormat);
            LoggingUtil::getInstance()->getLogger(EntityDataObject::class)
                ->error($exceptionMessage, ["entity" => $this->getName(), "field" => $name]);
            throw new TestFrameworkException($exceptionMessage);
        }

        $name_lower = strtolower($name);

        if ($this->data !== null && array_key_exists($name_lower, $this->data)) {
            $uniquenessData = $this->getUniquenessDataByName($name_lower);
            if (null === $uniquenessData || $uniquenessFormat == self::NO_UNIQUE_PROCESS) {
                return $this->data[$name_lower];
            }
            return $this->formatUniqueData($name_lower, $uniquenessData, $uniquenessFormat);
        }

        return null;
    }

    public function getParentName()
    {
        return $this->parentEntity;
    }

    private function formatUniqueData($name, $uniqueData, $uniqueDataFormat)
    {
        switch ($uniqueDataFormat) {
            case self::SUITE_UNIQUE_VALUE:
                $this->checkUniquenessFunctionExists(self::SUITE_UNIQUE_FUNCTION, $uniqueDataFormat);
                if ($uniqueData == 'prefix') {
                    return msqs($this->getName()) . $this->data[$name];
                } else { // $uniData == 'suffix'
                    return $this->data[$name] . msqs($this->getName());
                }
                break;
            case self::CEST_UNIQUE_VALUE:
                $this->checkUniquenessFunctionExists(self::CEST_UNIQUE_FUNCTION, $uniqueDataFormat);
                if ($uniqueData == 'prefix') {
                    return msq($this->getName()) . $this->data[$name];
                } else { // $uniqueData == 'suffix'
                    return $this->data[$name] . msq($this->getName());
                }
                break;
            case self::SUITE_UNIQUE_NOTATION:
                if ($uniqueData == 'prefix') {
                    return self::SUITE_UNIQUE_FUNCTION . '("' . $this->getName() . '")' . $this->data[$name];
                } else { // $uniqueData == 'suffix'
                    return $this->data[$name] . self::SUITE_UNIQUE_FUNCTION . '("' . $this->getName() . '")';
                }
                break;
            case self::CEST_UNIQUE_NOTATION:
                if ($uniqueData == 'prefix') {
                    return self::CEST_UNIQUE_FUNCTION . '("' . $this->getName() . '")' . $this->data[$name];
                } else { // $uniqueData == 'suffix'
                    return $this->data[$name] . self::CEST_UNIQUE_FUNCTION . '("' . $this->getName() . '")';
                }
                break;
            default:
                break;
        }
        return null;
    }

    private function checkUniquenessFunctionExists($function, $uniqueDataFormat)
    {
        if (!function_exists($function)) {
            $exceptionMessage = sprintf(
                'Unique data format value: %s can only be used when running cests.\n',
                $uniqueDataFormat
            );

            throw new TestFrameworkException($exceptionMessage);
        }
    }

    public function getVarReference($key)
    {
        if (array_key_exists($key, $this->vars)) {
            return $this->vars[$key];
        }

        return null;
    }

    public function getLinkedEntitiesOfType($type)
    {
        $groupedArray = [];

        foreach ($this->linkedEntities as $entityName => $entityType) {
            if ($entityType == $type) {
                $groupedArray[] = $entityName;
            }
        }

        return $groupedArray;
    }

    public function getLinkedEntities()
    {
        return $this->linkedEntities;
    }

    public function getVarReferences()
    {
        return $this->vars;
    }

    public function getUniquenessDataByName($dataName)
    {
        $name = strtolower($dataName);

        if (array_key_exists($name, $this->uniquenessData)) {
            return $this->uniquenessData[$name];
        }

        return null;
    }

    public function getUniquenessData()
    {
        return $this->uniquenessData;
    }

    private function isValidUniqueDataFormat($uniDataFormat)
    {
        return in_array(
            $uniDataFormat,
            [
                self::NO_UNIQUE_PROCESS,
                self::SUITE_UNIQUE_VALUE,
                self::CEST_UNIQUE_VALUE,
                self::SUITE_UNIQUE_NOTATION,
                self::CEST_UNIQUE_NOTATION
            ],
            true
        );
    }
}