DependencyTest Class Reference

Inheritance diagram for DependencyTest:

Public Member Functions
	testUndeclared ()
	collectRedundant ()
	testRedundant ()
	getAllFiles ()

Static Public Member Functions
static	setUpBeforeClass ()

Data Fields
const	TYPE_SOFT = 'soft'
const	TYPE_HARD = 'hard'
const	MAP_TYPE_DECLARED = 'declared'
const	MAP_TYPE_FOUND = 'found'
const	MAP_TYPE_REDUNDANT = 'redundant'
const	DIR_PATH_COUNT = 4

Protected Member Functions
	_getCleanedFileContents ($fileType, $file)
	_collectDependencies ($currentModuleName, $dependencies=[])
	_prepareFiles ($fileType, $files, $skip=null)
	_getDependencies ($module, $type, $mapType)
	_setDependencies ($module, $type, $mapType, $dependencies)
	_isFake ($module)

Static Protected Member Functions
static	_initThemes ()
static	_initRules ()
static	_prepareListConfigXml ()
static	_prepareListDbSchemaXml ()
static	_prepareListRoutesXml ()
static	_prepareMapRouters ()
static	_getTypes ()
static	convertModuleName (string $jsonName, array $packageModuleMap)
static	_initDependencies ()

Static Protected Attributes
static	$_listConfigXml = []
static	$_listDbSchemaXml = []
static	$_listRoutesXml = []
static	$_mapRouters = []
static	$_mapLayoutBlocks = []
static	$_mapLayoutHandles = []
static	$mapDependencies = []
static	$_defaultThemes = ''
static	$_namespaces
static	$_rulesInstances = []

Detailed Description

@SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file DependencyTest.php.

Member Function Documentation

_collectDependencies()

_collectDependencies (   $currentModuleName,   $dependencies = []  )

protected

Collect dependencies

Parameters

string	$currentModuleName
array	$dependencies

Returns

array

Definition at line 379 of file DependencyTest.php.

    {
        if (!count($dependencies)) {
            return [];
        }
        $undeclared = [];
        foreach ($dependencies as $dependency) {
            $this->collectDependency($dependency, $currentModuleName, $undeclared);
        }
        return $undeclared;
    }

_getCleanedFileContents()

_getCleanedFileContents (   $fileType,   $file  )

protected

Return cleaned file contents

Parameters

string	$fileType
string	$file

Returns

string

Definition at line 253 of file DependencyTest.php.

    {
        $contents = (string)file_get_contents($file);
        switch ($fileType) {
            case 'php':
                //Removing php comments
                $contents = preg_replace('~/\*.*?\*/~s', '', $contents);
                $contents = preg_replace('~^\s*//.*$~m', '', $contents);
                break;
            case 'layout':
            case 'config':
            case 'db_schema':
                //Removing xml comments
                $contents = preg_replace('~<!\-\-/.*?\-\->~s', '', $contents);
                break;
            case 'template':
                //Removing html
                $contentsWithoutHtml = '';
                preg_replace_callback(
                    '~(<\?php\s+.*\?>)~sU',
                    function ($matches) use ($contents, &$contentsWithoutHtml) {
                        $contentsWithoutHtml .= $matches[1];
                        return $contents;
                    },
                    $contents
                );
                $contents = $contentsWithoutHtml;
                //Removing php comments
                $contents = preg_replace('~/\*.*?\*/~s', '', $contents);
                $contents = preg_replace('~^\s*//.*$~s', '', $contents);
                break;
        }
        return $contents;
    }

_getDependencies()

_getDependencies (   $module,   $type,   $mapType  )

protected

Retrieve array of dependency items

Parameters

$module
$type
$mapType

Returns

array

Definition at line 837 of file DependencyTest.php.

    {
        if (isset(self::$mapDependencies[$module][$type][$mapType])) {
            return self::$mapDependencies[$module][$type][$mapType];
        }

        return [];
    }

_getTypes()

static _getTypes ( )

staticprotected

Retrieve dependency types array

Returns

array

Definition at line 682 of file DependencyTest.php.

    {
        return [self::TYPE_HARD, self::TYPE_SOFT];
    }

_initDependencies()

static _initDependencies ( )

staticprotected

Initialise map of dependencies.

Returns

void @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Exceptions

Definition at line 722 of file DependencyTest.php.

    {
        $packageModuleMap = self::getPackageModuleMapping();
        $jsonFiles = Files::init()->getComposerFiles(ComponentRegistrar::MODULE, false);
        foreach ($jsonFiles as $file) {
            $contents = file_get_contents($file);
            $decodedJson = json_decode($contents);
            if (null == $decodedJson) {
                throw new \Exception("Invalid Json: $file");
            }
            $json = new \Magento\Framework\Config\Composer\Package(json_decode($contents));
            $moduleName = self::convertModuleName($json->get('name'), $packageModuleMap);
            if (!isset(self::$mapDependencies[$moduleName])) {
                self::$mapDependencies[$moduleName] = [];
            }
            foreach (self::_getTypes() as $type) {
                if (!isset(self::$mapDependencies[$moduleName][$type])) {
                    self::$mapDependencies[$moduleName][$type] = [
                        self::MAP_TYPE_DECLARED  => [],
                        self::MAP_TYPE_FOUND     => [],
                        self::MAP_TYPE_REDUNDANT => [],
                    ];
                }
            }

            $require = array_keys((array)$json->get('require'));
            self::addDependencies($moduleName, $require, self::TYPE_HARD, $packageModuleMap);

            $suggest = array_keys((array)$json->get('suggest'));
            self::addDependencies($moduleName, $suggest, self::TYPE_SOFT, $packageModuleMap);
        }
    }

_initRules()

static _initRules ( )

staticprotected

Create rules objects

Definition at line 225 of file DependencyTest.php.

    {
        $replaceFilePattern = str_replace('\\', '/', realpath(__DIR__)) . '/_files/dependency_test/*.php';
        $dbRuleTables = [];
        foreach (glob($replaceFilePattern) as $fileName) {
            $dbRuleTables = array_merge($dbRuleTables, @include $fileName);
        }
        self::$_rulesInstances = [
            new DeclarativeSchemaRule($dbRuleTables),
            new PhpRule(self::$_mapRouters, self::$_mapLayoutBlocks),
            new DbRule($dbRuleTables),
            new LayoutRule(
                self::$_mapRouters,
                self::$_mapLayoutBlocks,
                self::$_mapLayoutHandles
            ),
            new DiRule(new VirtualTypeMapper()),
            new ReportsConfigRule($dbRuleTables),
        ];
    }

_initThemes()

static _initThemes ( )

staticprotected

Initialize default themes

Definition at line 209 of file DependencyTest.php.

    {
        $defaultThemes = [];
        foreach (self::$_listConfigXml as $file) {
            $config = simplexml_load_file($file);
            $nodes = @($config->xpath("/config/*/design/theme/full_name") ?: []);
            foreach ($nodes as $node) {
                $defaultThemes[] = (string)$node;
            }
        }
        self::$_defaultThemes = sprintf('#app/design.*/(%s)/.*#', implode('|', array_unique($defaultThemes)));
    }

_isFake()

_isFake (   $module )

protected

Check if module is fake

Parameters

$module

Returns

bool

Definition at line 870 of file DependencyTest.php.

    {
        return isset(self::$mapDependencies[$module]) ? false : true;
    }

_prepareFiles()

_prepareFiles (   $fileType,   $files,   $skip = null  )

protected

Convert file list to data provider structure

Parameters

string	$fileType
array	$files
bool | null	$skip

Returns

array

Definition at line 473 of file DependencyTest.php.

    {
        $result = [];
        foreach ($files as $relativePath => $file) {
            $absolutePath = $file[0];
            if (!$skip && substr_count($relativePath, '/') < self::DIR_PATH_COUNT) {
                continue;
            }
            $result[$relativePath] = [$fileType, $absolutePath];
        }
        return $result;
    }

_prepareListConfigXml()

static _prepareListConfigXml ( )

staticprotected

Prepare list of config.xml files (by modules).

Definition at line 535 of file DependencyTest.php.

    {
        $files = Files::init()->getConfigFiles('config.xml', [], false);
        foreach ($files as $file) {
            if (preg_match('/(?<namespace>[A-Z][a-z]+)[_\/\\\\](?<module>[A-Z][a-zA-Z]+)/', $file, $matches)) {
                $module = $matches['namespace'] . '\\' . $matches['module'];
                self::$_listConfigXml[$module] = $file;
            }
        }
    }

_prepareListDbSchemaXml()

static _prepareListDbSchemaXml ( )

staticprotected

Prepare list of db_schema.xml files (by modules)

Definition at line 549 of file DependencyTest.php.

    {
        $files = Files::init()->getDbSchemaFiles('db_schema.xml', [], false);
        foreach ($files as $file) {
            if (preg_match('/(?<namespace>[A-Z][a-z]+)[_\/\\\\](?<module>[A-Z][a-zA-Z]+)/', $file, $matches)) {
                $module = $matches['namespace'] . '\\' . $matches['module'];
                self::$_listDbSchemaXml[$module] = $file;
            }
        }
    }

_prepareListRoutesXml()

static _prepareListRoutesXml ( )

staticprotected

Prepare list of routes.xml files (by modules)

Definition at line 563 of file DependencyTest.php.

    {
        $files = Files::init()->getConfigFiles('*/routes.xml', [], false);
        foreach ($files as $file) {
            if (preg_match('/(?<namespace>[A-Z][a-z]+)[_\/\\\\](?<module>[A-Z][a-zA-Z]+)/', $file, $matches)) {
                $module = $matches['namespace'] . '\\' . $matches['module'];
                self::$_listRoutesXml[$module][] = $file;
            }
        }
    }

_prepareMapRouters()

static _prepareMapRouters ( )

staticprotected

Prepare map of routers

Definition at line 577 of file DependencyTest.php.

    {
        $pattern = '/(?<namespace>[A-Z][a-z]+)[_\/\\\\](?<module>[A-Z][a-zA-Z]+)\/Controller\/' .
            '(?<path>[\/\w]*).php/';

        $files = Files::init()->getPhpFiles(Files::INCLUDE_APP_CODE | Files::INCLUDE_NON_CLASSES);
        foreach ($files as $file) {
            if (preg_match($pattern, $file, $matches)) {
                $module = $matches['namespace'] . '\\' . $matches['module'];
                if (!empty(self::$_listRoutesXml[$module])) {
                    foreach (self::$_listRoutesXml[$module] as $configFile) {
                        self::updateRoutersMap($module, $configFile);
                    }
                }
            }
        }
    }

_setDependencies()

_setDependencies (   $module,   $type,   $mapType,   $dependencies  )

protected

Set dependency map items

Parameters

$module
$type
$mapType
$dependencies

Definition at line 854 of file DependencyTest.php.

    {
        if (!is_array($dependencies)) {
            $dependencies = [$dependencies];
        }
        if (isset(self::$mapDependencies[$module][$type][$mapType])) {
            self::$mapDependencies[$module][$type][$mapType] = $dependencies;
        }
    }

collectRedundant()

collectRedundant

(

)

Collect redundant dependencies @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 423 of file DependencyTest.php.

    {
        foreach (array_keys(self::$mapDependencies) as $module) {
            $declared = $this->_getDependencies($module, self::TYPE_HARD, self::MAP_TYPE_DECLARED);
            $found = array_merge(
                $this->_getDependencies($module, self::TYPE_HARD, self::MAP_TYPE_FOUND),
                $this->_getDependencies($module, self::TYPE_SOFT, self::MAP_TYPE_FOUND)
            );
            $found['Magento\Framework'] = 'Magento\Framework';
            $this->_setDependencies($module, self::TYPE_HARD, self::MAP_TYPE_REDUNDANT, array_diff($declared, $found));
        }
    }

convertModuleName()

static convertModuleName ( string  $jsonName, array  $packageModuleMap  )

staticprotected

Converts a composer json component name into the Magento Module form

Parameters

string	$jsonName	The name of a composer json component or dependency e.g. 'magento/module-theme'
array	$packageModuleMap	Mapping package name with module namespace.

Returns

string The corresponding Magento Module e.g. 'Magento\Theme'

Definition at line 694 of file DependencyTest.php.

                                                                                          : string
    {
        if (isset($packageModuleMap[$jsonName])) {
            return $packageModuleMap[$jsonName];
        }

        if (strpos($jsonName, 'magento/magento') !== false || strpos($jsonName, 'magento/framework') !== false) {
            $moduleName = str_replace('/', "\t", $jsonName);
            $moduleName = str_replace('framework-', "Framework\t", $moduleName);
            $moduleName = str_replace('-', ' ', $moduleName);
            $moduleName = ucwords($moduleName);
            $moduleName = str_replace("\t", '\\', $moduleName);
            $moduleName = str_replace(' ', '', $moduleName);

            return $moduleName;
        }

        return $jsonName;
    }

getAllFiles()

getAllFiles

(

)

Return all files

Returns

array

Definition at line 491 of file DependencyTest.php.

    {
        $files = [];

        // Get all php files
        $files = array_merge(
            $files,
            $this->_prepareFiles(
                'php',
                Files::init()->getPhpFiles(Files::INCLUDE_APP_CODE | Files::AS_DATA_SET | Files::INCLUDE_NON_CLASSES),
                true
            )
        );

        // Get all configuration files
        $files = array_merge(
            $files,
            $this->_prepareFiles('config', Files::init()->getConfigFiles())
        );

        // Get all configuration files
        $files = array_merge(
            $files,
            $this->_prepareFiles('db_schema', Files::init()->getDbSchemaFiles())
        );

        //Get all layout updates files
        $files = array_merge(
            $files,
            $this->_prepareFiles('layout', Files::init()->getLayoutFiles())
        );

        // Get all template files
        $files = array_merge(
            $files,
            $this->_prepareFiles('template', Files::init()->getPhtmlFiles())
        );

        return $files;
    }

setUpBeforeClass()

static setUpBeforeClass ( )

static

Sets up data

Definition at line 163 of file DependencyTest.php.

    {
        $root = BP;
        $rootJson = json_decode(file_get_contents($root . '/composer.json'), true);
        if (preg_match('/magento\/project-*/', $rootJson['name']) == 1) {
            // The Dependency test is skipped for vendor/magento build
            self::markTestSkipped(
                'MAGETWO-43654: The build is running from vendor/magento. DependencyTest is skipped.'
            );
        }

        self::$_namespaces = implode('|', Files::init()->getNamespaces());

        self::_prepareListConfigXml();
        self::_prepareListDbSchemaXml();
        self::_prepareListRoutesXml();

        self::_prepareMapRouters();
        self::_prepareMapLayoutBlocks();
        self::_prepareMapLayoutHandles();

        self::getLibraryWhiteLists();

        self::_initDependencies();
        self::_initThemes();
        self::_initRules();
    }

testRedundant()

testRedundant

(

)

Check redundant dependencies

@depends collectRedundant

Definition at line 441 of file DependencyTest.php.

    {
        $output = [];
        foreach (array_keys(self::$mapDependencies) as $module) {
            $result = [];
            $redundant = $this->_getDependencies($module, self::TYPE_HARD, self::MAP_TYPE_REDUNDANT);
            if (count($redundant)) {
                $result[] = sprintf(
                    "\r\nModule %s: %s [%s]",
                    $module,
                    self::TYPE_HARD,
                    implode(', ', array_values($redundant))
                );
            }

            if (count($result)) {
                $output[] = implode(', ', $result);
            }
        }
        if (count($output)) {
            $this->fail("Redundant dependencies found!\r\n" . implode(' ', $output));
        }
    }

testUndeclared()

testUndeclared

(

)

Check undeclared modules dependencies for specified file

Parameters

string	$fileType
string	$file

Definition at line 288 of file DependencyTest.php.

    {
        $invoker = new \Magento\Framework\App\Utility\AggregateInvoker($this);
        $invoker(
            function ($fileType, $file) {
                // Validates file when it is belonged to default themes
                $componentRegistrar = new ComponentRegistrar();
                foreach ($componentRegistrar->getPaths(ComponentRegistrar::THEME) as $themeDir) {
                    if (strpos($file, $themeDir . '/') !== false) {
                        return;
                    }
                }

                $foundModuleName = '';
                foreach ($componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $moduleName => $moduleDir) {
                    if (strpos($file, $moduleDir . '/') !== false) {
                        $foundModuleName = str_replace('_', '\\', $moduleName);
                        break;
                    }
                }
                if (empty($foundModuleName)) {
                    return;
                }

                $module = $foundModuleName;
                $contents = $this->_getCleanedFileContents($fileType, $file);

                $dependencies = $this->getDependenciesFromFiles($module, $fileType, $file, $contents);

                // Collect dependencies
                $undeclaredDependency = $this->_collectDependencies($module, $dependencies);

                // Prepare output message
                $result = [];
                foreach ($undeclaredDependency as $type => $modules) {
                    $modules = array_unique($modules);
                    if (!count($modules)) {
                        continue;
                    }
                    $result[] = sprintf("%s [%s]", $type, implode(', ', $modules));
                }
                if (count($result)) {
                    $this->fail('Module ' . $module . ' has undeclared dependencies: ' . implode(', ', $result));
                }
            },
            $this->getAllFiles()
        );
    }

Field Documentation

$_defaultThemes

$_defaultThemes = ''

staticprotected

Definition at line 135 of file DependencyTest.php.

$_listConfigXml

$_listConfigXml = []

staticprotected

Definition at line 57 of file DependencyTest.php.

$_listDbSchemaXml

$_listDbSchemaXml = []

staticprotected

Definition at line 68 of file DependencyTest.php.

$_listRoutesXml

$_listRoutesXml = []

staticprotected

Definition at line 79 of file DependencyTest.php.

$_mapLayoutBlocks

$_mapLayoutBlocks = []

staticprotected

Definition at line 102 of file DependencyTest.php.

$_mapLayoutHandles

$_mapLayoutHandles = []

staticprotected

Definition at line 114 of file DependencyTest.php.

$_mapRouters

$_mapRouters = []

staticprotected

Definition at line 90 of file DependencyTest.php.

$_namespaces

$_namespaces

staticprotected

Definition at line 144 of file DependencyTest.php.

$_rulesInstances

$_rulesInstances = []

staticprotected

Definition at line 151 of file DependencyTest.php.

$mapDependencies

$mapDependencies = []

staticprotected

Definition at line 128 of file DependencyTest.php.

DIR_PATH_COUNT

const DIR_PATH_COUNT = 4

Count of directories in path

Definition at line 46 of file DependencyTest.php.

MAP_TYPE_DECLARED

const MAP_TYPE_DECLARED = 'declared'

Types of dependencies map arrays

Definition at line 37 of file DependencyTest.php.

MAP_TYPE_FOUND

const MAP_TYPE_FOUND = 'found'

Definition at line 39 of file DependencyTest.php.

MAP_TYPE_REDUNDANT

const MAP_TYPE_REDUNDANT = 'redundant'

Definition at line 41 of file DependencyTest.php.

TYPE_HARD

const TYPE_HARD = 'hard'

Definition at line 32 of file DependencyTest.php.

TYPE_SOFT

const TYPE_SOFT = 'soft'

Types of dependencies between modules

Definition at line 30 of file DependencyTest.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/static/testsuite/Magento/Test/Integrity/DependencyTest.php