class LayoutTest

Same name in other branches
  1. 9 core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php \Drupal\Tests\layout_discovery\Kernel\LayoutTest
  2. 8.9.x core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php \Drupal\Tests\layout_discovery\Kernel\LayoutTest
  3. 11.x core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php \Drupal\Tests\layout_discovery\Kernel\LayoutTest

Tests Layout functionality.

@group Layout @group #slow

Hierarchy

Expanded class hierarchy of LayoutTest

File

core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php, line 16

Namespace

Drupal\Tests\layout_discovery\Kernel
View source
class LayoutTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'layout_discovery',
        'layout_test',
    ];
    
    /**
     * The layout plugin manager.
     *
     * @var \Drupal\Core\Layout\LayoutPluginManagerInterface
     */
    protected $layoutPluginManager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->layoutPluginManager = $this->container
            ->get('plugin.manager.core.layout');
    }
    
    /**
     * Tests that a layout provided by a theme has the preprocess function set.
     */
    public function testThemeProvidedLayout() : void {
        $this->container
            ->get('theme_installer')
            ->install([
            'test_layout_theme',
        ]);
        $this->config('system.theme')
            ->set('default', 'test_layout_theme')
            ->save();
        $theme_definitions = $this->container
            ->get('theme.registry')
            ->get();
        $this->assertContains('template_preprocess_layout', $theme_definitions['test_layout_theme']['preprocess functions']);
    }
    
    /**
     * Tests rendering a layout.
     *
     * @dataProvider renderLayoutData
     */
    public function testRenderLayout($layout_id, $config, $regions, array $html) : void {
        $layout = $this->layoutPluginManager
            ->createInstance($layout_id, $config);
        $built['layout'] = $layout->build($regions);
        $built['layout']['#prefix'] = 'Test prefix' . "\n";
        $built['layout']['#suffix'] = 'Test suffix' . "\n";
        // Assume each layout is contained by a form, in order to ensure the
        // building of the layout does not interfere with form processing.
        $form_state = new FormState();
        $form_builder = $this->container
            ->get('form_builder');
        $form_builder->prepareForm('the_form_id', $built, $form_state);
        $form_builder->processForm('the_form_id', $built, $form_state);
        $this->render($built);
        // Add in the wrapping form elements and prefix/suffix.
        array_unshift($html, 'Test prefix');
        array_unshift($html, '<form data-drupal-selector="the-form-id" action="/" method="post" id="the-form-id" accept-charset="UTF-8">');
        // Retrieve the build ID from the rendered HTML since the string is random.
        $build_id_input = $this->cssSelect('input[name="form_build_id"]')[0]
            ->asXML();
        $form_id_input = '<input data-drupal-selector="edit-the-form-id" type="hidden" name="form_id" value="the_form_id"/>';
        $html[] = 'Test suffix';
        $html[] = $build_id_input . "\n" . $form_id_input . "\n" . '</form>';
        // Match the HTML to the full form element.
        $this->assertSame(implode("\n", $html), $this->cssSelect('#the-form-id')[0]
            ->asXML());
    }
    
    /**
     * {@inheritdoc}
     */
    protected function render(array &$elements) {
        $content = parent::render($elements);
        // Strip leading whitespace from every line.
        $this->content = preg_replace('/^\\s+/m', '', $content);
        return $this->content;
    }
    
    /**
     * Data provider for testRenderLayout().
     */
    public static function renderLayoutData() {
        $html = [];
        $html[] = '<div data-drupal-selector="edit-layout" class="layout layout--onecol">';
        $html[] = '<div data-drupal-selector="edit-content" class="layout__region layout__region--content">';
        $html[] = 'This is the content';
        $html[] = '</div>';
        $html[] = '</div>';
        $data['layout_onecol'] = [
            'layout_onecol',
            [],
            [
                'content' => [
                    '#markup' => 'This is the content',
                ],
            ],
            $html,
        ];
        $html = [];
        $html[] = '<div data-drupal-selector="edit-layout" class="layout-example-1col clearfix">';
        $html[] = '<div data-drupal-selector="edit-top" class="region-top">';
        $html[] = 'This string added by #process.';
        $html[] = '</div>';
        $html[] = '<div data-drupal-selector="edit-bottom" class="region-bottom">';
        $html[] = 'This is the bottom';
        $html[] = '</div>';
        $html[] = '</div>';
        $data['layout_test_1col_with_form'] = [
            'layout_test_1col',
            [],
            [
                'top' => [
                    '#process' => [
                        [
                            static::class,
                            'processCallback',
                        ],
                    ],
                ],
                'bottom' => [
                    '#markup' => 'This is the bottom',
                ],
            ],
            $html,
        ];
        $html = [];
        $html[] = '<div data-drupal-selector="edit-layout" class="layout-example-1col clearfix">';
        $html[] = '<div data-drupal-selector="edit-top" class="region-top">';
        $html[] = 'This is the top';
        $html[] = '</div>';
        $html[] = '<div data-drupal-selector="edit-bottom" class="region-bottom">';
        $html[] = 'This is the bottom';
        $html[] = '</div>';
        $html[] = '</div>';
        $data['layout_test_1col'] = [
            'layout_test_1col',
            [],
            [
                'top' => [
                    '#markup' => 'This is the top',
                ],
                'bottom' => [
                    '#markup' => 'This is the bottom',
                ],
            ],
            $html,
        ];
        $html = [];
        $html[] = '<div data-drupal-selector="edit-layout" class="layout layout--layout-test-1col-no-template">';
        $html[] = '<div data-drupal-selector="edit-top" class="layout__region layout__region--top">';
        $html[] = 'This is the top';
        $html[] = '</div>';
        $html[] = '<div data-drupal-selector="edit-bottom" class="layout__region layout__region--bottom">';
        $html[] = 'This is the bottom';
        $html[] = '</div>';
        $html[] = '</div>';
        $data['layout_test_1col_no_template'] = [
            'layout_test_1col_no_template',
            [],
            [
                'top' => [
                    '#markup' => 'This is the top',
                ],
                'bottom' => [
                    '#markup' => 'This is the bottom',
                ],
            ],
            $html,
        ];
        $html = [];
        $html[] = '<div data-drupal-selector="edit-layout" class="layout-example-2col clearfix">';
        $html[] = '<div data-drupal-selector="edit-left" class="class-added-by-preprocess region-left">';
        $html[] = 'This is the left';
        $html[] = '</div>';
        $html[] = '<div data-drupal-selector="edit-right" class="region-right">';
        $html[] = 'This is the right';
        $html[] = '</div>';
        $html[] = '</div>';
        $data['layout_test_2col'] = [
            'layout_test_2col',
            [],
            [
                'left' => [
                    '#markup' => 'This is the left',
                ],
                'right' => [
                    '#markup' => 'This is the right',
                ],
            ],
            $html,
        ];
        $html = [];
        $html[] = '<div data-drupal-selector="edit-layout" class="layout-test-plugin clearfix">';
        $html[] = '<div>';
        $html[] = '<span class="setting-1-label">Blah: </span>';
        $html[] = 'Config value';
        $html[] = '</div>';
        $html[] = '<div data-drupal-selector="edit-main" class="region-main">';
        $html[] = 'Main region';
        $html[] = '</div>';
        $html[] = '</div>';
        $data['layout_test_plugin'] = [
            'layout_test_plugin',
            [
                'setting_1' => 'Config value',
            ],
            [
                'main' => [
                    '#markup' => 'Main region',
                ],
            ],
            $html,
        ];
        return $data;
    }
    
    /**
     * Provides a test #process callback.
     */
    public static function processCallback($element) {
        $element['#markup'] = 'This string added by #process.';
        return $element;
    }

}

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::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.
LayoutTest::$layoutPluginManager protected property The layout plugin manager.
LayoutTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
LayoutTest::processCallback public static function Provides a test #process callback.
LayoutTest::render protected function Renders a render array. Overrides KernelTestBase::render
LayoutTest::renderLayoutData public static function Data provider for testRenderLayout().
LayoutTest::setUp protected function Overrides KernelTestBase::setUp
LayoutTest::testRenderLayout public function Tests rendering a layout.
LayoutTest::testThemeProvidedLayout public function Tests that a layout provided by a theme has the preprocess function set.
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.

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