class ThemeTest

Same name in this branch
  1. 10 core/modules/system/tests/src/Functional/System/ThemeTest.php \Drupal\Tests\system\Functional\System\ThemeTest
  2. 10 core/modules/system/tests/src/Functional/Theme/ThemeTest.php \Drupal\Tests\system\Functional\Theme\ThemeTest
  3. 10 core/modules/taxonomy/tests/src/Functional/ThemeTest.php \Drupal\Tests\taxonomy\Functional\ThemeTest
Same name in other branches
  1. 9 core/modules/system/tests/src/Kernel/Theme/ThemeTest.php \Drupal\Tests\system\Kernel\Theme\ThemeTest
  2. 9 core/modules/system/tests/src/Functional/System/ThemeTest.php \Drupal\Tests\system\Functional\System\ThemeTest
  3. 9 core/modules/system/tests/src/Functional/Theme/ThemeTest.php \Drupal\Tests\system\Functional\Theme\ThemeTest
  4. 9 core/modules/taxonomy/tests/src/Functional/ThemeTest.php \Drupal\Tests\taxonomy\Functional\ThemeTest
  5. 8.9.x core/modules/system/tests/src/Kernel/Theme/ThemeTest.php \Drupal\Tests\system\Kernel\Theme\ThemeTest
  6. 8.9.x core/modules/system/tests/src/Functional/System/ThemeTest.php \Drupal\Tests\system\Functional\System\ThemeTest
  7. 8.9.x core/modules/system/tests/src/Functional/Theme/ThemeTest.php \Drupal\Tests\system\Functional\Theme\ThemeTest
  8. 8.9.x core/modules/taxonomy/tests/src/Functional/ThemeTest.php \Drupal\Tests\taxonomy\Functional\ThemeTest
  9. 11.x core/modules/system/tests/src/Kernel/Theme/ThemeTest.php \Drupal\Tests\system\Kernel\Theme\ThemeTest
  10. 11.x core/modules/system/tests/src/Functional/System/ThemeTest.php \Drupal\Tests\system\Functional\System\ThemeTest
  11. 11.x core/modules/system/tests/src/Functional/Theme/ThemeTest.php \Drupal\Tests\system\Functional\Theme\ThemeTest
  12. 11.x core/modules/taxonomy/tests/src/Functional/ThemeTest.php \Drupal\Tests\taxonomy\Functional\ThemeTest

Tests low-level theme functions.

@group Theme

Hierarchy

Expanded class hierarchy of ThemeTest

File

core/modules/system/tests/src/Kernel/Theme/ThemeTest.php, line 15

Namespace

Drupal\Tests\system\Kernel\Theme
View source
class ThemeTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'theme_test',
        'node',
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        \Drupal::service('theme_installer')->install([
            'test_theme',
        ]);
    }
    
    /**
     * Tests attribute merging.
     *
     * Render arrays that use a render element and templates (and hence call
     * template_preprocess()) must ensure the attributes at different occasions
     * are all merged correctly:
     *   - $variables['attributes'] as passed in to the theme hook implementation.
     *   - the render element's #attributes
     *   - any attributes set in the template's preprocessing function
     */
    public function testAttributeMerging() : void {
        $theme_test_render_element = [
            'elements' => [
                '#attributes' => [
                    'data-foo' => 'bar',
                ],
            ],
            'attributes' => [
                'id' => 'some_attribute',
            ],
        ];
        $this->assertThemeOutput('theme_test_render_element', $theme_test_render_element, '<div id="some_attribute" data-foo="bar" data-variables-are-preprocessed></div>' . "\n");
    }
    
    /**
     * Tests that ThemeManager renders the expected data types.
     */
    public function testThemeDataTypes() : void {
        // theme_test_false is an implemented theme hook so \Drupal::theme() service
        // should return a string or an object that implements MarkupInterface,
        // even though the theme function itself can return anything.
        $types = [
            'null' => NULL,
            'false' => FALSE,
            'integer' => 1,
            'string' => 'foo',
            'empty_string' => '',
        ];
        foreach ($types as $type => $example) {
            $output = \Drupal::theme()->render('theme_test_foo', [
                'foo' => $example,
            ]);
            $this->assertTrue($output instanceof MarkupInterface || is_string($output), "\\Drupal::theme() returns an object that implements MarkupInterface or a string for data type {$type}.");
            if ($output instanceof MarkupInterface) {
                $this->assertSame((string) $example, $output->__toString());
            }
            elseif (is_string($output)) {
                $this->assertSame('', $output, 'A string will be return when the theme returns an empty string.');
            }
        }
        // suggestion_not_implemented is not an implemented theme hook so \Drupal::theme() service
        // should return FALSE instead of a string.
        $output = \Drupal::theme()->render([
            'suggestion_not_implemented',
        ], []);
        $this->assertFalse($output, '\\Drupal::theme() returns FALSE when a hook suggestion is not implemented.');
    }
    
    /**
     * Tests function theme_get_suggestions() for SA-CORE-2009-003.
     */
    public function testThemeSuggestions() : void {
        // Set the front page as something random otherwise the CLI
        // test runner fails.
        $this->config('system.site')
            ->set('page.front', '/nobody-home')
            ->save();
        $args = [
            'node',
            '1',
            'edit',
        ];
        $suggestions = theme_get_suggestions($args, 'page');
        $this->assertEquals([
            'page__node',
            'page__node__%',
            'page__node__1',
            'page__node__edit',
        ], $suggestions, 'Found expected node edit page suggestions');
        // Check attack vectors.
        $args = [
            'node',
            '\\1',
        ];
        $suggestions = theme_get_suggestions($args, 'page');
        $this->assertEquals([
            'page__node',
            'page__node__%',
            'page__node__1',
        ], $suggestions, 'Removed invalid \\ from suggestions');
        $args = [
            'node',
            '1/',
        ];
        $suggestions = theme_get_suggestions($args, 'page');
        $this->assertEquals([
            'page__node',
            'page__node__%',
            'page__node__1',
        ], $suggestions, 'Removed invalid / from suggestions');
        $args = [
            'node',
            "1\x00",
        ];
        $suggestions = theme_get_suggestions($args, 'page');
        $this->assertEquals([
            'page__node',
            'page__node__%',
            'page__node__1',
        ], $suggestions, 'Removed invalid \\0 from suggestions');
        // Define path with hyphens to be used to generate suggestions.
        $args = [
            'node',
            '1',
            'hyphen-path',
        ];
        $result = [
            'page__node',
            'page__node__%',
            'page__node__1',
            'page__node__hyphen_path',
        ];
        $suggestions = theme_get_suggestions($args, 'page');
        $this->assertEquals($result, $suggestions, 'Found expected page suggestions for paths containing hyphens.');
    }
    
    /**
     * Tests the listInfo() function.
     */
    public function testListThemes() : void {
        $this->container
            ->get('theme_installer')
            ->install([
            'test_subtheme',
        ]);
        $theme_handler = $this->container
            ->get('theme_handler');
        $themes = $theme_handler->listInfo();
        // Check if ThemeHandlerInterface::listInfo() retrieves enabled themes.
        $this->assertSame(1, $themes['test_theme']->status, 'Installed theme detected');
        // Check if ThemeHandlerInterface::listInfo() returns disabled themes.
        // Check for base theme and subtheme lists.
        $base_theme_list = [
            'test_basetheme' => 'Theme test base theme',
        ];
        $sub_theme_list = [
            'test_subsubtheme' => 'Theme test subsubtheme',
            'test_subtheme' => 'Theme test subtheme',
        ];
        $this->assertSame($sub_theme_list, $themes['test_basetheme']->sub_themes, 'Base theme\'s object includes list of subthemes.');
        $this->assertSame($base_theme_list, $themes['test_subtheme']->base_themes, 'Subtheme\'s object includes list of base themes.');
        // Check for theme engine in subtheme.
        $this->assertSame('twig', $themes['test_subtheme']->engine, 'Subtheme\'s object includes the theme engine.');
        // Check for theme engine prefix.
        $this->assertSame('twig', $themes['test_basetheme']->prefix, 'Base theme\'s object includes the theme engine prefix.');
        $this->assertSame('twig', $themes['test_subtheme']->prefix, 'Subtheme\'s object includes the theme engine prefix.');
    }
    
    /**
     * Tests child element rendering for 'render element' theme hooks.
     */
    public function testDrupalRenderChildren() : void {
        $element = [
            '#theme' => 'theme_test_render_element_children',
            'child' => [
                '#markup' => 'Foo',
            ],
        ];
        $this->assertThemeOutput('theme_test_render_element_children', $element, 'Foo', "\\Drupal::service('renderer')->render() avoids #theme recursion loop when rendering a render element.");
        $element = [
            '#theme_wrappers' => [
                'theme_test_render_element_children',
            ],
            'child' => [
                '#markup' => 'Foo',
            ],
        ];
        $this->assertThemeOutput('theme_test_render_element_children', $element, 'Foo', "\\Drupal::service('renderer')->render() avoids #theme_wrappers recursion loop when rendering a render element.");
    }
    
    /**
     * Tests drupal_find_theme_templates().
     */
    public function testFindThemeTemplates() : void {
        $registry = $this->container
            ->get('theme.registry')
            ->get();
        $templates = drupal_find_theme_templates($registry, '.html.twig', $this->getThemePath('test_theme'));
        $this->assertEquals('node--1', $templates['node__1']['template'], 'Template node--1.html.twig was found in test_theme.');
    }
    
    /**
     * Tests the update registry is correct during theme install and uninstall.
     */
    public function testThemeUpdateManagement() : void {
        // Install modules the theme is dependent on and enable the post update
        // function.
        \Drupal::state()->set('test_theme_depending_on_modules.post_update', TRUE);
        \Drupal::service('module_installer')->install([
            'test_module_required_by_theme',
            'test_another_module_required_by_theme',
        ]);
        
        /** @var \Drupal\Core\Update\UpdateRegistry $post_update_registry */
        $post_update_registry = \Drupal::service('update.post_update_registry');
        $this->assertEmpty($post_update_registry->getUpdateFunctions('test_theme_depending_on_modules'), 'No updates test_theme_depending_on_modules for prior to install.');
        \Drupal::service('theme_installer')->install([
            'test_theme_depending_on_modules',
        ]);
        // Ensure the post update function has been added to the list of
        // existing updates.
        $this->assertContains('test_theme_depending_on_modules_post_update_module_install', \Drupal::service('keyvalue')->get('post_update')
            ->get('existing_updates'));
        \Drupal::service('theme_installer')->uninstall([
            'test_theme_depending_on_modules',
        ]);
        // Ensure the post update function has been removed from the list of
        // existing updates.
        $this->assertNotContains('test_theme_depending_on_modules_post_update_module_install', \Drupal::service('keyvalue')->get('post_update')
            ->get('existing_updates'));
    }
    
    /**
     * Tests the update registry is correct during theme install and uninstall.
     */
    public function testThemeUpdateManagementRemovedPostUpdates() : void {
        // Install modules the theme is dependent on and enable the removed post
        // updates function.
        \Drupal::state()->set('test_theme_depending_on_modules.removed_post_updates', TRUE);
        \Drupal::service('module_installer')->install([
            'test_module_required_by_theme',
            'test_another_module_required_by_theme',
        ]);
        $post_update_registry = \Drupal::service('update.post_update_registry');
        $this->assertEmpty($post_update_registry->getUpdateFunctions('test_theme_depending_on_modules'), 'No updates test_theme_depending_on_modules for prior to install.');
        \Drupal::service('theme_installer')->install([
            'test_theme_depending_on_modules',
        ]);
        // Ensure the removed post update function has been added to the list of
        // existing updates.
        $this->assertContains('test_theme_depending_on_modules_post_update_foo', \Drupal::service('keyvalue')->get('post_update')
            ->get('existing_updates'));
        \Drupal::service('theme_installer')->uninstall([
            'test_theme_depending_on_modules',
        ]);
        // Ensure the removed post update function has been removed from the list of
        // existing updates.
        $this->assertNotContains('test_theme_depending_on_modules_post_update_foo', \Drupal::service('keyvalue')->get('post_update')
            ->get('existing_updates'));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
ThemeTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
ThemeTest::setUp protected function Overrides KernelTestBase::setUp
ThemeTest::testAttributeMerging public function Tests attribute merging.
ThemeTest::testDrupalRenderChildren public function Tests child element rendering for &#039;render element&#039; theme hooks.
ThemeTest::testFindThemeTemplates public function Tests drupal_find_theme_templates().
ThemeTest::testListThemes public function Tests the listInfo() function.
ThemeTest::testThemeDataTypes public function Tests that ThemeManager renders the expected data types.
ThemeTest::testThemeSuggestions public function Tests function theme_get_suggestions() for SA-CORE-2009-003.
ThemeTest::testThemeUpdateManagement public function Tests the update registry is correct during theme install and uninstall.
ThemeTest::testThemeUpdateManagementRemovedPostUpdates public function Tests the update registry is correct during theme install and uninstall.

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