View source
<?php
namespace Drupal\Tests\Core\Extension;
use Drupal\Component\FileCache\FileCacheFactory;
use Drupal\Core\Extension\Extension;
use Drupal\Core\Extension\ExtensionDiscovery;
use Drupal\Tests\UnitTestCase;
use org\bovigo\vfs\vfsStream;
use Symfony\Component\Yaml\Yaml;
class ExtensionDiscoveryTest extends UnitTestCase {
public function testExtensionDiscoveryVfs() {
$filesystem = [];
$files_by_type_and_name_expected = $this
->populateFilesystemStructure($filesystem);
$vfs = vfsStream::setup('root', NULL, $filesystem);
$root = $vfs
->url();
$this
->assertFileExists($root . '/core/modules/system/system.module');
$this
->assertFileExists($root . '/core/modules/system/system.info.yml');
$extension_discovery = new ExtensionDiscovery($root, FALSE, NULL, 'sites/default');
$extensions_by_type = [];
$files_by_type_and_name = [];
foreach ([
'profile',
'module',
'theme',
'theme_engine',
] as $type) {
$extensions_by_type[$type] = $extension_discovery
->scan($type, FALSE);
foreach ($extensions_by_type[$type] as $name => $extension) {
$files_by_type_and_name[$type][$name] = $extension
->getPathname();
}
if ($type === 'profile') {
$extension_discovery
->setProfileDirectories([
'my_profile' => 'profiles/my_profile',
]);
}
}
$this
->assertEquals($files_by_type_and_name_expected, $files_by_type_and_name);
$extension_expected = new Extension($root, 'module', 'core/modules/system/system.info.yml', 'system.module');
$extension_expected->subpath = 'modules/system';
$extension_expected->origin = 'core';
$this
->assertEquals($extension_expected, $extensions_by_type['module']['system'], 'system');
$extension_expected = new Extension($root, 'theme_engine', 'core/themes/engines/twig/twig.info.yml', 'twig.engine');
$extension_expected->subpath = 'themes/engines/twig';
$extension_expected->origin = 'core';
$this
->assertEquals($extension_expected, $extensions_by_type['theme_engine']['twig'], 'twig');
}
public function testExtensionDiscoveryCache() {
$extension = new Extension($this->root, 'module', 'core/modules/user/user.info.yml', 'user.module');
$extension->subpath = 'modules/user';
$extension->origin = 'core';
FileCacheFactory::setConfiguration([]);
$file_cache = FileCacheFactory::get('extension_discovery');
$file_cache
->set($this->root . '/core/modules/user/user.info.yml', $extension);
$extension_discovery = new ExtensionDiscovery($this->root, TRUE, [], 'sites/default');
$modules = $extension_discovery
->scan('module', FALSE);
$this
->assertArrayHasKey('user', $modules);
$this
->assertEquals((array) $extension, (array) $modules['user']);
$this
->assertNotSame($extension, $modules['user']);
$this
->assertSame([
'type' => 'module',
'pathname' => 'core/modules/user/user.info.yml',
'filename' => 'user.module',
'subpath' => 'modules/user',
], $file_cache
->get($this->root . '/core/modules/user/user.info.yml'));
}
public function testExtensionDiscoveryTypeComment() : void {
$extension_discovery = new ExtensionDiscovery($this->root, TRUE, [], 'sites/default');
$modules = $extension_discovery
->scan('module', TRUE);
$this
->assertArrayHasKey('module_info_type_comment', $modules);
}
protected function populateFilesystemStructure(array &$filesystem_structure) {
$info_by_file = [
'core/profiles/standard/standard.info.yml' => [
'type' => 'profile',
],
'core/profiles/minimal/minimal.info.yml' => [
'type' => 'profile',
],
'core/themes/test_theme/test_theme.info.yml' => [
'type' => 'theme',
],
'sites/default/themes/test_theme/test_theme.info.yml' => [
'type' => 'theme',
],
'sites/default/profiles/minimal/minimal.info.yml' => [
'type' => 'profile',
],
'profiles/my_profile/my_profile.info.yml' => [
'type' => 'profile',
],
'profiles/my_profile/modules/my_profile_nested_module/my_profile_nested_module.info.yml' => [],
'profiles/other_profile/other_profile.info.yml' => [
'type' => 'profile',
],
'core/modules/user/user.info.yml' => [],
'profiles/other_profile/modules/other_profile_nested_module/other_profile_nested_module.info.yml' => [],
'core/modules/system/system.info.yml' => [],
'modules/devel/devel.info.yml' => [],
'modules/poorly_placed_theme/poorly_placed_theme.info.yml' => [
'type' => 'theme',
],
'core/themes/engines/twig/twig.info.yml' => [
'type' => 'theme_engine',
],
];
$files_by_type_and_name_expected = [];
$content_by_file = [];
foreach ($info_by_file as $file => $info) {
$name = basename($file, '.info.yml');
$info += [
'type' => 'module',
'name' => "Name of ({$name})",
'core' => '8.x',
];
$type = $info['type'];
$content_by_file[$file] = Yaml::dump($info);
$files_by_type_and_name_expected[$type][$name] = $file;
}
$content_by_file['core/modules/system/system.module'] = '<?php';
$content_by_file['core/themes/engines/twig/twig.engine'] = '<?php';
foreach ($content_by_file as $file => $content) {
$pieces = explode('/', $file);
$this
->addFileToFilesystemStructure($filesystem_structure, $pieces, $content);
}
unset($files_by_type_and_name_expected['module']['other_profile_nested_module']);
return $files_by_type_and_name_expected;
}
protected function addFileToFilesystemStructure(array &$filesystem_structure, array $pieces, $content) {
$piece = array_shift($pieces);
if ($pieces !== []) {
$filesystem_structure += [
$piece => [],
];
$this
->addFileToFilesystemStructure($filesystem_structure[$piece], $pieces, $content);
}
else {
$filesystem_structure[$piece] = $content;
}
}
}