class ThemeHandlerTest

Same name in other branches
  1. 9 core/tests/Drupal/Tests/Core/Extension/ThemeHandlerTest.php \Drupal\Tests\Core\Extension\ThemeHandlerTest
  2. 8.9.x core/tests/Drupal/Tests/Core/Extension/ThemeHandlerTest.php \Drupal\Tests\Core\Extension\ThemeHandlerTest
  3. 10 core/tests/Drupal/Tests/Core/Extension/ThemeHandlerTest.php \Drupal\Tests\Core\Extension\ThemeHandlerTest

@coversDefaultClass \Drupal\Core\Extension\ThemeHandler @group Extension

Hierarchy

Expanded class hierarchy of ThemeHandlerTest

File

core/tests/Drupal/Tests/Core/Extension/ThemeHandlerTest.php, line 17

Namespace

Drupal\Tests\Core\Extension
View source
class ThemeHandlerTest extends UnitTestCase {
    
    /**
     * The mocked config factory.
     *
     * @var \Drupal\Core\Config\ConfigFactoryInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $configFactory;
    
    /**
     * The theme listing service.
     *
     * @var \Drupal\Core\Extension\ThemeExtensionList|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $themeList;
    
    /**
     * The tested theme handler.
     *
     * @var \Drupal\Core\Extension\ThemeHandler|\Drupal\Tests\Core\Extension\StubThemeHandler
     */
    protected $themeHandler;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->configFactory = $this->getConfigFactoryStub([
            'core.extension' => [
                'module' => [],
                'theme' => [
                    'stark' => 'stark',
                ],
                'disabled' => [
                    'theme' => [],
                ],
            ],
        ]);
        $this->themeList = $this->getMockBuilder(ThemeExtensionList::class)
            ->disableOriginalConstructor()
            ->getMock();
        $this->themeHandler = new StubThemeHandler($this->root, $this->configFactory, $this->themeList);
        $container = $this->createMock('Symfony\\Component\\DependencyInjection\\ContainerInterface');
        $container->expects($this->any())
            ->method('get')
            ->with('class_loader')
            ->willReturn($this->createMock(ClassLoader::class));
        \Drupal::setContainer($container);
    }
    
    /**
     * Tests rebuilding the theme data.
     *
     * @see \Drupal\Core\Extension\ThemeHandler::rebuildThemeData()
     * @group legacy
     */
    public function testRebuildThemeData() : void {
        $this->expectDeprecation("\\Drupal\\Core\\Extension\\ThemeHandlerInterface::rebuildThemeData() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal::service('extension.list.theme')->reset()->getList() instead. See https://www.drupal.org/node/3413196");
        $this->themeList
            ->expects($this->once())
            ->method('reset')
            ->willReturnSelf();
        $this->themeList
            ->expects($this->once())
            ->method('getList')
            ->willReturn([
            'stark' => new Extension($this->root, 'theme', 'core/themes/stark/stark.info.yml', 'stark.theme'),
        ]);
        $theme_data = $this->themeHandler
            ->rebuildThemeData();
        $this->assertCount(1, $theme_data);
        $info = $theme_data['stark'];
        // Ensure some basic properties.
        $this->assertInstanceOf('Drupal\\Core\\Extension\\Extension', $info);
        $this->assertEquals('stark', $info->getName());
        $this->assertEquals('core/themes/stark/stark.info.yml', $info->getPathname());
        $this->assertEquals('core/themes/stark/stark.theme', $info->getExtensionPathname());
    }
    
    /**
     * Tests empty libraries in theme.info.yml file.
     */
    public function testThemeLibrariesEmpty() : void {
        $theme = new Extension($this->root, 'theme', 'core/modules/system/tests/themes/test_theme_libraries_empty', 'test_theme_libraries_empty.info.yml');
        try {
            $this->themeHandler
                ->addTheme($theme);
            $this->assertTrue(TRUE, 'Empty libraries key in theme.info.yml does not cause PHP warning');
        } catch (\Exception) {
            $this->fail('Empty libraries key in theme.info.yml causes PHP warning.');
        }
    }
    
    /**
     * Test that a missing theme doesn't break ThemeHandler::listInfo().
     *
     * @covers ::listInfo
     */
    public function testMissingTheme() : void {
        $themes = $this->themeHandler
            ->listInfo();
        $this->assertSame([], $themes);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
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.
ThemeHandlerTest::$configFactory protected property The mocked config factory.
ThemeHandlerTest::$themeHandler protected property The tested theme handler.
ThemeHandlerTest::$themeList protected property The theme listing service.
ThemeHandlerTest::setUp protected function Overrides UnitTestCase::setUp
ThemeHandlerTest::testMissingTheme public function Test that a missing theme doesn't break ThemeHandler::listInfo().
ThemeHandlerTest::testRebuildThemeData public function Tests rebuilding the theme data.
ThemeHandlerTest::testThemeLibrariesEmpty public function Tests empty libraries in theme.info.yml file.
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::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::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.