ActionGroupObjectHandler.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\Test\Handlers;

use Magento\FunctionalTestingFramework\ObjectManager\ObjectHandlerInterface;
use Magento\FunctionalTestingFramework\ObjectManagerFactory;
use Magento\FunctionalTestingFramework\Test\Objects\ActionGroupObject;
use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
use Magento\FunctionalTestingFramework\Test\Parsers\ActionGroupDataParser;
use Magento\FunctionalTestingFramework\Test\Util\ActionGroupObjectExtractor;
use Magento\FunctionalTestingFramework\Test\Util\ObjectExtensionUtil;

class ActionGroupObjectHandler implements ObjectHandlerInterface
{
    const BEFORE_AFTER_ERROR_MSG = "Merge Error - Steps cannot have both before and after attributes.\tTestStep='%s'";
    const ACTION_GROUP_ROOT = 'actionGroups';
    const ACTION_GROUP = 'actionGroup';

    private static $ACTION_GROUP_OBJECT_HANDLER;

    private $actionGroups = [];

    private $extendUtil;

    public static function getInstance()
    {
        if (!self::$ACTION_GROUP_OBJECT_HANDLER) {
            self::$ACTION_GROUP_OBJECT_HANDLER = new ActionGroupObjectHandler();
            self::$ACTION_GROUP_OBJECT_HANDLER->initActionGroups();
        }

        return self::$ACTION_GROUP_OBJECT_HANDLER;
    }

    private function __construct()
    {
        $this->extendUtil = new ObjectExtensionUtil();
    }

    public function getObject($actionGroupName)
    {
        if (array_key_exists($actionGroupName, $this->actionGroups)) {
            $actionGroupObject = $this->actionGroups[$actionGroupName];
            return $this->extendActionGroup($actionGroupObject);
        }

        return null;
    }

    public function getAllObjects()
    {
        foreach ($this->actionGroups as $actionGroupName => $actionGroup) {
            $this->actionGroups[$actionGroupName] = $this->extendActionGroup($actionGroup);
        }
        return $this->actionGroups;
    }

    private function initActionGroups()
    {
        $actionGroupParser = ObjectManagerFactory::getObjectManager()->create(ActionGroupDataParser::class);
        $parsedActionGroups = $actionGroupParser->readActionGroupData();

        $actionGroupObjectExtractor = new ActionGroupObjectExtractor();

        foreach ($parsedActionGroups[ActionGroupObjectHandler::ACTION_GROUP_ROOT] as
                 $actionGroupName => $actionGroupData) {
            if (!is_array($actionGroupData)) {
                continue;
            }

            $this->actionGroups[$actionGroupName] =
                $actionGroupObjectExtractor->extractActionGroup($actionGroupData);
        }
    }

    private function extendActionGroup($actionGroupObject)
    {
        if ($actionGroupObject->getParentName() !== null) {
            return $this->extendUtil->extendActionGroup($actionGroupObject);
        }
        return $actionGroupObject;
    }
}