class RegistryTest
Same name in this branch
- 11.x core/tests/Drupal/KernelTests/Core/Theme/RegistryTest.php \Drupal\KernelTests\Core\Theme\RegistryTest
Same name in other branches
- 9 core/tests/Drupal/KernelTests/Core/Theme/RegistryTest.php \Drupal\KernelTests\Core\Theme\RegistryTest
- 9 core/tests/Drupal/Tests/Core/Theme/RegistryTest.php \Drupal\Tests\Core\Theme\RegistryTest
- 8.9.x core/tests/Drupal/KernelTests/Core/Theme/RegistryTest.php \Drupal\KernelTests\Core\Theme\RegistryTest
- 8.9.x core/tests/Drupal/Tests/Core/Theme/RegistryTest.php \Drupal\Tests\Core\Theme\RegistryTest
- 10 core/tests/Drupal/KernelTests/Core/Theme/RegistryTest.php \Drupal\KernelTests\Core\Theme\RegistryTest
- 10 core/tests/Drupal/Tests/Core/Theme/RegistryTest.php \Drupal\Tests\Core\Theme\RegistryTest
@coversDefaultClass \Drupal\Core\Theme\Registry @group Theme
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Core\Theme\RegistryTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of RegistryTest
1 file declares its use of RegistryTest
- RegistryTest.php in core/
tests/ Drupal/ Tests/ Core/ Theme/ RegistryTest.php
File
-
core/
tests/ Drupal/ Tests/ Core/ Theme/ RegistryTest.php, line 18
Namespace
Drupal\Tests\Core\ThemeView source
class RegistryTest extends UnitTestCase {
/**
* The mocked theme registry.
*
* @var \Drupal\Core\Theme\Registry|\PHPUnit\Framework\MockObject\MockObject
*/
protected $registry;
/**
* The mocked cache backend.
*
* @var \Drupal\Core\Cache\CacheBackendInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $cache;
/**
* The mocked lock backend.
*
* @var \Drupal\Core\Lock\LockBackendInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $lock;
/**
* The mocked module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $moduleHandler;
/**
* The mocked theme handler.
*
* @var \Drupal\Core\Extension\ThemeHandlerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $themeHandler;
/**
* The mocked theme initialization.
*
* @var \Drupal\Core\Theme\ThemeInitializationInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $themeInitialization;
/**
* The mocked cache backend.
*
* @var \Drupal\Core\Cache\CacheBackendInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $runtimeCache;
/**
* The theme manager.
*
* @var \Drupal\Core\Theme\ThemeManagerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $themeManager;
/**
* The module list.
*
* @var \Drupal\Core\Extension\ModuleExtensionList|\PHPUnit\Framework\MockObject\MockObject
*/
protected $moduleList;
/**
* The kernel.
*
* @var \Symfony\Component\HttpKernel\HttpKernelInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $kernel;
/**
* The list of functions that get_defined_functions() should provide.
*
* @var array
*/
public static $functions = [];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->cache = $this->createMock('Drupal\\Core\\Cache\\CacheBackendInterface');
$this->lock = $this->createMock('Drupal\\Core\\Lock\\LockBackendInterface');
$this->moduleHandler = $this->createMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$this->themeHandler = $this->createMock('Drupal\\Core\\Extension\\ThemeHandlerInterface');
$this->themeInitialization = $this->createMock('Drupal\\Core\\Theme\\ThemeInitializationInterface');
$this->runtimeCache = $this->createMock('Drupal\\Core\\Cache\\CacheBackendInterface');
$this->themeManager = $this->createMock('Drupal\\Core\\Theme\\ThemeManagerInterface');
$this->moduleList = $this->createMock(ModuleExtensionList::class);
$this->kernel = $this->createMock(HttpKernelInterface::class);
$this->registry = new Registry($this->root, $this->cache, $this->lock, $this->moduleHandler, $this->themeHandler, $this->themeInitialization, $this->runtimeCache, $this->moduleList, $this->kernel);
$this->registry
->setThemeManager($this->themeManager);
}
/**
* {@inheritdoc}
*/
protected function tearDown() : void {
parent::tearDown();
static::$functions = [];
}
/**
* Tests getting the theme registry defined by a module.
*/
public function testGetRegistryForModule() : void {
$test_theme = new ActiveTheme([
'name' => 'test_theme',
'path' => 'core/modules/system/tests/themes/test_theme/test_theme.info.yml',
'engine' => 'twig',
'owner' => 'twig',
'libraries_override' => [],
'libraries_extend' => [],
'libraries' => [],
'extension' => '.twig',
'base_theme_extensions' => [],
]);
$test_stable = new ActiveTheme([
'name' => 'test_stable',
'path' => 'core/tests/fixtures/test_stable/test_stable.info.yml',
'engine' => 'twig',
'owner' => 'twig',
'libraries_override' => [],
'libraries_extend' => [],
'libraries' => [],
'extension' => '.twig',
'base_theme_extensions' => [],
]);
$this->themeManager
->expects($this->exactly(2))
->method('getActiveTheme')
->willReturnOnConsecutiveCalls($test_theme, $test_stable);
// Include the module and theme files so that hook_theme can be called.
include_once $this->root . '/core/modules/system/tests/modules/theme_test/theme_test.module';
include_once $this->root . '/core/tests/fixtures/test_stable/test_stable.theme';
$themeTestTheme = new ThemeTestHooks();
$this->moduleHandler
->expects($this->atLeastOnce())
->method('invoke')
->with('theme_test', 'theme')
->willReturn($themeTestTheme->theme(NULL, NULL, NULL, NULL));
$this->moduleHandler
->expects($this->atLeastOnce())
->method('invokeAllWith')
->with('theme')
->willReturnCallback(function (string $hook, callable $callback) {
$callback(function () {
}, 'theme_test');
});
$this->moduleHandler
->expects($this->atLeastOnce())
->method('getModuleList')
->willReturn([]);
$this->moduleList
->expects($this->exactly(2))
->method('getPath')
->with('theme_test')
->willReturn('core/modules/system/tests/modules/theme_test');
$registry = $this->registry
->get();
// Ensure that the registry entries from the module are found.
$this->assertArrayHasKey('theme_test', $registry);
$this->assertArrayHasKey('theme_test_template_test', $registry);
$this->assertArrayHasKey('theme_test_template_test_2', $registry);
$this->assertArrayHasKey('theme_test_suggestion_provided', $registry);
$this->assertArrayHasKey('theme_test_specific_suggestions', $registry);
$this->assertArrayHasKey('theme_test_suggestions', $registry);
$this->assertArrayHasKey('theme_test_foo', $registry);
$this->assertArrayHasKey('theme_test_render_element', $registry);
$this->assertNotContains('test_stable_preprocess_theme_test_render_element', $registry['theme_test_render_element']['preprocess functions']);
// The second call will initialize with the second theme. Ensure that this
// returns a different object and the discovery for the second theme's
// preprocess function worked.
$other_registry = $this->registry
->get();
$this->assertNotSame($registry, $other_registry);
$this->assertContains('test_stable_preprocess_theme_test_render_element', $other_registry['theme_test_render_element']['preprocess functions']);
}
/**
* @covers ::postProcessExtension
* @covers ::completeSuggestion
* @covers ::mergePreprocessFunctions
*
* @dataProvider providerTestPostProcessExtension
*
* @param array $defined_functions
* An array of functions to be used in place of get_defined_functions().
* @param array $hooks
* An array of theme hooks to process.
* @param array $expected
* The expected results.
*/
public function testPostProcessExtension($defined_functions, $hooks, $expected) : void {
static::$functions['user'] = $defined_functions;
$theme = $this->prophesize(ActiveTheme::class);
$theme->getBaseThemeExtensions()
->willReturn([]);
$theme->getName()
->willReturn('test');
$theme->getEngine()
->willReturn('twig');
$this->moduleHandler
->expects($this->atLeastOnce())
->method('getModuleList')
->willReturn([]);
$class = new \ReflectionClass(Registry::class);
$reflection_method = $class->getMethod('postProcessExtension');
$reflection_method->invokeArgs($this->registry, [
&$hooks,
$theme->reveal(),
]);
$this->assertEquals($expected, $hooks);
}
/**
* Provides test data to ::testPostProcessExtension().
*/
public static function providerTestPostProcessExtension() {
// This is test data for unit testing
// \Drupal\Core\Theme\Registry::postProcessExtension(), not what happens
// before it. Therefore, for all test data:
// - Explicitly defined hooks also come with explicitly defined preprocess
// functions, because those are collected in
// \Drupal\Core\Theme\Registry::processExtension().
// - Explicitly defined hooks that set a 'base hook' also have
// 'incomplete preprocess functions' set to TRUE, since that is done in
// \Drupal\Core\Theme\Registry::processExtension().
$data = [];
// Test the discovery of suggestions via the presence of preprocess
// functions that follow the "__" naming pattern.
$data['base_hook_with_auto-discovered_suggestions'] = [
'defined_functions' => [
'test_preprocess_test_hook__suggestion',
'test_preprocess_test_hook__suggestion__another',
],
'hooks' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
],
'expected' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'test_hook__suggestion' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'test_preprocess_test_hook__suggestion',
],
'base hook' => 'test_hook',
],
'test_hook__suggestion__another' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'test_preprocess_test_hook__suggestion',
'test_preprocess_test_hook__suggestion__another',
],
'base hook' => 'test_hook',
],
],
];
// Test that suggestions following the "__" naming pattern can also be
// explicitly defined in hook_theme(), such as 'field__node__title' defined
// in node_theme().
$data['base_hook_with_explicit_suggestions'] = [
'defined_functions' => [],
'hooks' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'test_hook__suggestion__another' => [
'base hook' => 'test_hook',
'preprocess functions' => [
'explicit_preprocess_test_hook__suggestion__another',
],
'incomplete preprocess functions' => TRUE,
],
],
'expected' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'test_hook__suggestion__another' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'explicit_preprocess_test_hook__suggestion__another',
],
'base hook' => 'test_hook',
],
],
];
// Same as above, but also test that a preprocess function for an
// intermediary suggestion level gets discovered.
$data['base_hook_with_explicit_suggestions_and_intermediary_preprocess_function'] = [
'defined_functions' => [
'test_preprocess_test_hook__suggestion',
],
'hooks' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'test_hook__suggestion__another' => [
'base hook' => 'test_hook',
'preprocess functions' => [
'explicit_preprocess_test_hook__suggestion__another',
],
'incomplete preprocess functions' => TRUE,
],
],
'expected' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'test_hook__suggestion' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'test_preprocess_test_hook__suggestion',
],
'base hook' => 'test_hook',
],
'test_hook__suggestion__another' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'test_preprocess_test_hook__suggestion',
'explicit_preprocess_test_hook__suggestion__another',
],
'base hook' => 'test_hook',
],
],
];
// Test that hooks not following the "__" naming pattern can explicitly
// specify a base hook, such as is done in
// \Drupal\Core\Layout\LayoutPluginManager::getThemeImplementations().
$data['child_hook_without_magic_naming'] = [
'defined_functions' => [],
'hooks' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'child_hook' => [
'base hook' => 'test_hook',
'preprocess functions' => [
'explicit_preprocess_child_hook',
],
'incomplete preprocess functions' => TRUE,
],
],
'expected' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'child_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'explicit_preprocess_child_hook',
],
'base hook' => 'test_hook',
],
],
];
// Same as above, but also test that such child hooks can also be extended
// with magically named suggestions.
$data['child_hook_with_suggestions'] = [
'defined_functions' => [
'test_preprocess_child_hook__suggestion',
'test_preprocess_child_hook__suggestion__another',
],
'hooks' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'child_hook' => [
'base hook' => 'test_hook',
'preprocess functions' => [
'explicit_preprocess_child_hook',
],
'incomplete preprocess functions' => TRUE,
],
],
'expected' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'child_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'explicit_preprocess_child_hook',
],
'base hook' => 'test_hook',
],
'child_hook__suggestion' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'explicit_preprocess_child_hook',
'test_preprocess_child_hook__suggestion',
],
'base hook' => 'test_hook',
],
'child_hook__suggestion__another' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'explicit_preprocess_child_hook',
'test_preprocess_child_hook__suggestion',
'test_preprocess_child_hook__suggestion__another',
],
'base hook' => 'test_hook',
],
],
];
// Test that a suggestion following the "__" naming pattern can specify a
// different base hook than what is implied by that pattern. Ensure that
// preprocess functions from both the naming pattern and from 'base hook'
// are collected.
$data['suggestion_with_alternate_base_hook'] = [
'defined_functions' => [
'test_preprocess_test_hook__suggestion',
],
'hooks' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'alternate_base_hook' => [
'preprocess functions' => [
'explicit_preprocess_alternate_base_hook',
],
],
'test_hook__suggestion__another' => [
'base hook' => 'alternate_base_hook',
'preprocess functions' => [
'explicit_preprocess_test_hook__suggestion__another',
],
'incomplete preprocess functions' => TRUE,
],
],
'expected' => [
'test_hook' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
],
],
'alternate_base_hook' => [
'preprocess functions' => [
'explicit_preprocess_alternate_base_hook',
],
],
'test_hook__suggestion' => [
'preprocess functions' => [
'explicit_preprocess_test_hook',
'test_preprocess_test_hook__suggestion',
],
'base hook' => 'test_hook',
],
'test_hook__suggestion__another' => [
'preprocess functions' => [
'explicit_preprocess_alternate_base_hook',
'explicit_preprocess_test_hook',
'test_preprocess_test_hook__suggestion',
'explicit_preprocess_test_hook__suggestion__another',
],
'base hook' => 'alternate_base_hook',
],
],
];
// Test when a base hook is missing.
$data['missing_base_hook'] = [
'defined_functions' => [],
'hooks' => [
'child_hook' => [
'base hook' => 'test_hook',
'preprocess functions' => [
'explicit_preprocess_child_hook',
],
'incomplete preprocess functions' => TRUE,
],
],
'expected' => [
'child_hook' => [
'preprocess functions' => [
'explicit_preprocess_child_hook',
],
'base hook' => 'test_hook',
],
],
];
return $data;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RegistryTest::$cache | protected | property | The mocked cache backend. | |
RegistryTest::$functions | public static | property | The list of functions that get_defined_functions() should provide. | |
RegistryTest::$kernel | protected | property | The kernel. | |
RegistryTest::$lock | protected | property | The mocked lock backend. | |
RegistryTest::$moduleHandler | protected | property | The mocked module handler. | |
RegistryTest::$moduleList | protected | property | The module list. | |
RegistryTest::$registry | protected | property | The mocked theme registry. | |
RegistryTest::$runtimeCache | protected | property | The mocked cache backend. | |
RegistryTest::$themeHandler | protected | property | The mocked theme handler. | |
RegistryTest::$themeInitialization | protected | property | The mocked theme initialization. | |
RegistryTest::$themeManager | protected | property | The theme manager. | |
RegistryTest::providerTestPostProcessExtension | public static | function | Provides test data to ::testPostProcessExtension(). | |
RegistryTest::setUp | protected | function | Overrides UnitTestCase::setUp | |
RegistryTest::tearDown | protected | function | ||
RegistryTest::testGetRegistryForModule | public | function | Tests getting the theme registry defined by a module. | |
RegistryTest::testPostProcessExtension | public | function | @covers ::postProcessExtension @covers ::completeSuggestion @covers ::mergePreprocessFunctions |
|
UnitTestCase::$root | protected | property | The app root. | |
UnitTestCase::getClassResolverStub | protected | function | Returns a stub class resolver. | |
UnitTestCase::getConfigFactoryStub | public | function | Returns a stub config factory that behaves according to the passed array. | |
UnitTestCase::getConfigStorageStub | public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase::getContainerWithCacheTagsInvalidator | protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.