class LayoutSectionTest

Same name in other branches
  1. 9 core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php \Drupal\Tests\layout_builder\Functional\LayoutSectionTest
  2. 8.9.x core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php \Drupal\Tests\layout_builder\Functional\LayoutSectionTest
  3. 11.x core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php \Drupal\Tests\layout_builder\Functional\LayoutSectionTest

Tests the rendering of a layout section field.

@group layout_builder

Hierarchy

Expanded class hierarchy of LayoutSectionTest

File

core/modules/layout_builder/tests/src/Functional/LayoutSectionTest.php, line 18

Namespace

Drupal\Tests\layout_builder\Functional
View source
class LayoutSectionTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field_ui',
        'layout_builder',
        'node',
        'block_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->createContentType([
            'type' => 'bundle_without_section_field',
        ]);
        $this->createContentType([
            'type' => 'bundle_with_section_field',
        ]);
        LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default')->enableLayoutBuilder()
            ->setOverridable()
            ->save();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
            'administer node display',
            'administer node fields',
            'administer content types',
        ], 'foobar'));
    }
    
    /**
     * Provides test data for ::testLayoutSectionFormatter().
     */
    public static function providerTestLayoutSectionFormatter() {
        $data = [];
        $data['block_with_global_context'] = [
            [
                [
                    'section' => new Section('layout_onecol', [], [
                        'baz' => new SectionComponent('baz', 'content', [
                            'id' => 'test_context_aware',
                            'context_mapping' => [
                                'user' => '@user.current_user_context:current_user',
                            ],
                        ]),
                    ]),
                ],
            ],
            [
                '.layout--onecol',
                '#test_context_aware--username',
            ],
            [
                'foobar',
            ],
            'user',
            'user:2',
            'UNCACHEABLE',
        ];
        $data['block_with_entity_context'] = [
            [
                [
                    'section' => new Section('layout_onecol', [], [
                        'baz' => new SectionComponent('baz', 'content', [
                            'id' => 'field_block:node:bundle_with_section_field:body',
                            'context_mapping' => [
                                'entity' => 'layout_builder.entity',
                            ],
                        ]),
                    ]),
                ],
            ],
            [
                '.layout--onecol',
                '.field--name-body',
            ],
            [
                'Body',
                'The node body',
            ],
            '',
            '',
            'MISS',
        ];
        $data['single_section_single_block'] = [
            [
                [
                    'section' => new Section('layout_onecol', [], [
                        'baz' => new SectionComponent('baz', 'content', [
                            'id' => 'system_powered_by_block',
                        ]),
                    ]),
                ],
            ],
            '.layout--onecol',
            'Powered by',
            '',
            '',
            'MISS',
        ];
        $data['multiple_sections'] = [
            [
                [
                    'section' => new Section('layout_onecol', [], [
                        'baz' => new SectionComponent('baz', 'content', [
                            'id' => 'system_powered_by_block',
                        ]),
                    ]),
                ],
                [
                    'section' => new Section('layout_twocol', [], [
                        'foo' => new SectionComponent('foo', 'first', [
                            'id' => 'test_block_instantiation',
                            'display_message' => 'foo text',
                        ]),
                        'bar' => new SectionComponent('bar', 'second', [
                            'id' => 'test_block_instantiation',
                            'display_message' => 'bar text',
                        ]),
                    ]),
                ],
            ],
            [
                '.layout--onecol',
                '.layout--twocol',
            ],
            [
                'Powered by',
                'foo text',
                'bar text',
            ],
            'user.permissions',
            '',
            'MISS',
        ];
        return $data;
    }
    
    /**
     * Tests layout_section formatter output.
     *
     * @dataProvider providerTestLayoutSectionFormatter
     */
    public function testLayoutSectionFormatter($layout_data, $expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, $expected_dynamic_cache) : void {
        $node = $this->createSectionNode($layout_data);
        $canonical_url = $node->toUrl('canonical');
        $this->drupalGet($canonical_url);
        $this->assertLayoutSection($expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, $expected_dynamic_cache);
        $this->drupalGet($canonical_url->toString() . '/layout');
        $this->assertLayoutSection($expected_selector, $expected_content, $expected_cache_contexts, $expected_cache_tags, 'UNCACHEABLE');
    }
    
    /**
     * Tests the access checking of the section formatter.
     */
    public function testLayoutSectionFormatterAccess() : void {
        $node = $this->createSectionNode([
            [
                'section' => new Section('layout_onecol', [], [
                    'baz' => new SectionComponent('baz', 'content', [
                        'id' => 'test_access',
                    ]),
                ]),
            ],
        ]);
        // Restrict access to the block.
        $this->container
            ->get('state')
            ->set('test_block_access', FALSE);
        $this->drupalGet($node->toUrl('canonical'));
        $this->assertLayoutSection('.layout--onecol', NULL, '', '', 'UNCACHEABLE');
        // Ensure the block was not rendered.
        $this->assertSession()
            ->pageTextNotContains('Hello test world');
        // Grant access to the block, and ensure it was rendered.
        $this->container
            ->get('state')
            ->set('test_block_access', TRUE);
        $this->drupalGet($node->toUrl('canonical'));
        $this->assertLayoutSection('.layout--onecol', 'Hello test world', '', '', 'UNCACHEABLE');
    }
    
    /**
     * Ensures that the entity title is displayed.
     */
    public function testLayoutPageTitle() : void {
        $this->drupalPlaceBlock('page_title_block');
        $node = $this->createSectionNode([]);
        $this->drupalGet($node->toUrl('canonical')
            ->toString() . '/layout');
        $this->assertSession()
            ->titleEquals('Edit layout for The node title | Drupal');
        $this->assertEquals('Edit layout for The node title', $this->cssSelect('h1.page-title')[0]
            ->getText());
    }
    
    /**
     * Tests that no Layout link shows without a section field.
     */
    public function testLayoutUrlNoSectionField() : void {
        $node = $this->createNode([
            'type' => 'bundle_without_section_field',
            'title' => 'The node title',
            'body' => [
                [
                    'value' => 'The node body',
                ],
            ],
        ]);
        $node->save();
        $this->drupalGet($node->toUrl('canonical')
            ->toString() . '/layout');
        $this->assertSession()
            ->statusCodeEquals(403);
    }
    
    /**
     * Tests that deleting a field removes it from the layout.
     */
    public function testLayoutDeletingField() : void {
        $assert_session = $this->assertSession();
        $this->drupalGet('/admin/structure/types/manage/bundle_with_section_field/display/default/layout');
        $assert_session->statusCodeEquals(200);
        $assert_session->elementExists('css', '.field--name-body');
        // Delete the field from both bundles.
        $this->drupalGet('/admin/structure/types/manage/bundle_without_section_field/fields/node.bundle_without_section_field.body/delete');
        $this->submitForm([], 'Delete');
        $this->drupalGet('/admin/structure/types/manage/bundle_with_section_field/display/default/layout');
        $assert_session->statusCodeEquals(200);
        $assert_session->elementExists('css', '.field--name-body');
        $this->drupalGet('/admin/structure/types/manage/bundle_with_section_field/fields/node.bundle_with_section_field.body/delete');
        $this->submitForm([], 'Delete');
        $this->drupalGet('/admin/structure/types/manage/bundle_with_section_field/display/default/layout');
        $assert_session->statusCodeEquals(200);
        $assert_session->elementNotExists('css', '.field--name-body');
    }
    
    /**
     * Tests that deleting a bundle removes the layout.
     */
    public function testLayoutDeletingBundle() : void {
        $assert_session = $this->assertSession();
        $display = LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default');
        $this->assertInstanceOf(LayoutBuilderEntityViewDisplay::class, $display);
        $this->drupalGet('/admin/structure/types/manage/bundle_with_section_field/delete');
        $this->submitForm([], 'Delete');
        $assert_session->statusCodeEquals(200);
        $display = LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default');
        $this->assertNull($display);
    }
    
    /**
     * Asserts the output of a layout section.
     *
     * @param string|array $expected_selector
     *   A selector or list of CSS selectors to find.
     * @param string|array $expected_content
     *   A string or list of strings to find.
     * @param string $expected_cache_contexts
     *   A string of cache contexts to be found in the header.
     * @param string $expected_cache_tags
     *   A string of cache tags to be found in the header.
     * @param string $expected_dynamic_cache
     *   The expected dynamic cache header. Either 'HIT', 'MISS' or 'UNCACHEABLE'.
     *
     * @internal
     */
    protected function assertLayoutSection($expected_selector, $expected_content, string $expected_cache_contexts = '', string $expected_cache_tags = '', string $expected_dynamic_cache = 'MISS') : void {
        $assert_session = $this->assertSession();
        // Find the given selector.
        foreach ((array) $expected_selector as $selector) {
            $element = $this->cssSelect($selector);
            $this->assertNotEmpty($element);
        }
        // Find the given content.
        foreach ((array) $expected_content as $content) {
            $assert_session->pageTextContains($content);
        }
        if ($expected_cache_contexts) {
            $assert_session->responseHeaderContains('X-Drupal-Cache-Contexts', $expected_cache_contexts);
        }
        if ($expected_cache_tags) {
            $assert_session->responseHeaderContains('X-Drupal-Cache-Tags', $expected_cache_tags);
        }
        $assert_session->responseHeaderEquals('X-Drupal-Dynamic-Cache', $expected_dynamic_cache);
    }
    
    /**
     * Creates a node with a section field.
     *
     * @param array $section_values
     *   An array of values for a section field.
     *
     * @return \Drupal\node\NodeInterface
     *   The node object.
     */
    protected function createSectionNode(array $section_values) {
        return $this->createNode([
            'type' => 'bundle_with_section_field',
            'title' => 'The node title',
            'body' => [
                [
                    'value' => 'The node body',
                ],
            ],
            OverridesSectionStorage::FIELD_NAME => $section_values,
        ]);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
LayoutSectionTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LayoutSectionTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
LayoutSectionTest::assertLayoutSection protected function Asserts the output of a layout section.
LayoutSectionTest::createSectionNode protected function Creates a node with a section field.
LayoutSectionTest::providerTestLayoutSectionFormatter public static function Provides test data for ::testLayoutSectionFormatter().
LayoutSectionTest::setUp protected function Overrides BrowserTestBase::setUp
LayoutSectionTest::testLayoutDeletingBundle public function Tests that deleting a bundle removes the layout.
LayoutSectionTest::testLayoutDeletingField public function Tests that deleting a field removes it from the layout.
LayoutSectionTest::testLayoutPageTitle public function Ensures that the entity title is displayed.
LayoutSectionTest::testLayoutSectionFormatter public function Tests layout_section formatter output.
LayoutSectionTest::testLayoutSectionFormatterAccess public function Tests the access checking of the section formatter.
LayoutSectionTest::testLayoutUrlNoSectionField public function Tests that no Layout link shows without a section field.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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