ComposerTest Class Reference

Inheritance diagram for ComposerTest:

Public Member Functions
	testValidComposerJson ()
	validateComposerJsonDataProvider ()
	testComponentPathsInRoot ()

Static Public Member Functions
static	setUpBeforeClass ()
static	getBlacklist (string $pattern)

Detailed Description

A test that enforces validity of composer.json files and any other conventions in Magento components

Definition at line 15 of file ComposerTest.php.

Member Function Documentation

getBlacklist()

static getBlacklist ( string  $pattern )

static

Return aggregated blacklist

Parameters

string

$pattern

Returns

string[]

Definition at line 67 of file ComposerTest.php.

    {
        $blacklist = [];
        foreach (glob($pattern) as $list) {
            $blacklist = array_merge($blacklist, file($list, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES));
        }
        return $blacklist;
    }

setUpBeforeClass()

static setUpBeforeClass ( )

static

Definition at line 48 of file ComposerTest.php.

    {
        self::$root = BP;
        self::$rootJson = json_decode(file_get_contents(self::$root . '/composer.json'), true);
        self::$dependencies = [];
        self::$objectManager = Bootstrap::create(BP, $_SERVER)->getObjectManager();
        // A block can be whitelisted and thus not be required to be public
        self::$rootComposerModuleBlacklist = self::getBlacklist(
            __DIR__ . '/_files/blacklist/composer_root_modules*.txt'
        );
        self::$moduleNameBlacklist = self::getBlacklist(__DIR__ . '/_files/blacklist/composer_module_names*.txt');
    }

testComponentPathsInRoot()

testComponentPathsInRoot

(

)

Definition at line 414 of file ComposerTest.php.

    {
        if (!isset(self::$rootJson['extra']) || !isset(self::$rootJson['extra']['component_paths'])) {
            $this->markTestSkipped("The root composer.json file doesn't mention any extra component paths information");
        }
        $this->assertArrayHasKey(
            'replace',
            self::$rootJson,
            "If there are any component paths specified, then they must be reflected in 'replace' section"
        );
        $flat = $this->getFlatPathsInfo(self::$rootJson['extra']['component_paths']);
        foreach ($flat as $item) {
            list($component, $path) = $item;
            $this->assertFileExists(
                self::$root . '/' . $path,
                "Missing or invalid component path: {$component} -> {$path}"
            );
            $this->assertArrayHasKey(
                $component,
                self::$rootJson['replace'],
                "The {$component} is specified in 'extra->component_paths', but missing in 'replace' section"
            );
        }
        foreach (array_keys(self::$rootJson['replace']) as $replace) {
            if (!MagentoComponent::matchMagentoComponent($replace)) {
                $this->assertArrayHasKey(
                    $replace,
                    self::$rootJson['extra']['component_paths'],
                    "The {$replace} is specified in 'replace', but missing in 'extra->component_paths' section"
                );
            }
        }
    }

testValidComposerJson()

testValidComposerJson

(

)

Parameters

string	$dir
string	$packageType

Definition at line 76 of file ComposerTest.php.

    {
        $invoker = new \Magento\Framework\App\Utility\AggregateInvoker($this);
        $invoker(
            function ($dir, $packageType) {
                $file = $dir . '/composer.json';
                $this->assertFileExists($file);
                $this->validateComposerJsonFile($dir);
                $contents = file_get_contents($file);
                $json = json_decode($contents);
                $this->assertCodingStyle($contents);
                $this->assertMagentoConventions($dir, $packageType, $json);
            },
            $this->validateComposerJsonDataProvider()
        );
    }

validateComposerJsonDataProvider()

validateComposerJsonDataProvider

(

)

Returns

array

Definition at line 100 of file ComposerTest.php.

    {
        $root = BP;
        $componentRegistrar = new ComponentRegistrar();
        $result = [];
        foreach ($componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $dir) {
            $result[$dir] = [$dir, 'magento2-module'];
        }
        foreach ($componentRegistrar->getPaths(ComponentRegistrar::LANGUAGE) as $dir) {
            $result[$dir] = [$dir, 'magento2-language'];
        }
        foreach ($componentRegistrar->getPaths(ComponentRegistrar::THEME) as $dir) {
            $result[$dir] = [$dir, 'magento2-theme'];
        }
        foreach ($componentRegistrar->getPaths(ComponentRegistrar::LIBRARY) as $dir) {
            $result[$dir] = [$dir, 'magento2-library'];
        }
        $result[$root] = [$root, 'project'];

        return $result;
    }

---

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

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