Dom.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\Page\Config;

use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
use Magento\FunctionalTestingFramework\Exceptions\Collector\ExceptionCollector;
use Magento\FunctionalTestingFramework\Config\Dom\NodeMergingConfig;
use Magento\FunctionalTestingFramework\Config\Dom\NodePathMatcher;
use Magento\FunctionalTestingFramework\Util\ModulePathExtractor;
use Magento\FunctionalTestingFramework\Util\Validation\DuplicateNodeValidationUtil;

class Dom extends \Magento\FunctionalTestingFramework\Config\MftfDom
{
    const PAGE_META_FILENAME_ATTRIBUTE = "filename";
    const PAGE_META_NAME_ATTRIBUTE = "name";

    private $modulePathExtractor;

    private $validationUtil;

    public function __construct(
        $xml,
        $filename,
        $exceptionCollector,
        array $idAttributes = [],
        $typeAttributeName = null,
        $schemaFile = null,
        $errorFormat = self::ERROR_FORMAT_DEFAULT
    ) {
        $this->modulePathExtractor = new ModulePathExtractor();
        $this->validationUtil = new DuplicateNodeValidationUtil('name', $exceptionCollector);
        parent::__construct(
            $xml,
            $filename,
            $exceptionCollector,
            $idAttributes,
            $typeAttributeName,
            $schemaFile,
            $errorFormat
        );
    }

    public function initDom($xml, $filename = null)
    {
        $dom = parent::initDom($xml, $filename);

        $pagesNode = $dom->getElementsByTagName('pages')->item(0);
        $this->validationUtil->validateChildUniqueness(
            $pagesNode,
            $filename,
            $pagesNode->getAttribute(self::PAGE_META_NAME_ATTRIBUTE)
        );
        $pageNodes = $dom->getElementsByTagName('page');
        $currentModule =
            $this->modulePathExtractor->extractModuleName($filename) .
            '_' .
            $this->modulePathExtractor->getExtensionPath($filename);
        foreach ($pageNodes as $pageNode) {
            $pageModule = $pageNode->getAttribute("module");
            $pageName = $pageNode->getAttribute("name");
            if ($pageModule !== $currentModule) {
                if (MftfApplicationConfig::getConfig()->verboseEnabled()) {
                    print(
                        "Page Module does not match path Module. " .
                        "(Page, Module): ($pageName, $pageModule) - Path Module: $currentModule" .
                        PHP_EOL
                    );
                }
            }
            $pageNode->setAttribute(self::PAGE_META_FILENAME_ATTRIBUTE, $filename);
        }
        return $dom;
    }
}