class LayoutBuilderOverridesTest

Same name in other branches
  1. 10 core/modules/layout_builder/tests/src/Functional/LayoutBuilderOverridesTest.php \Drupal\Tests\layout_builder\Functional\LayoutBuilderOverridesTest

Tests the Layout Builder UI.

@group layout_builder

Hierarchy

Expanded class hierarchy of LayoutBuilderOverridesTest

File

core/modules/layout_builder/tests/src/Functional/LayoutBuilderOverridesTest.php, line 15

Namespace

Drupal\Tests\layout_builder\Functional
View source 
class LayoutBuilderOverridesTest extends LayoutBuilderTestBase {
    
    /**
     * Tests deleting a field in-use by an overridden layout.
     */
    public function testDeleteField() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
            'administer node fields',
        ]));
        // Enable layout builder overrides.
        LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default')->enableLayoutBuilder()
            ->setOverridable()
            ->save();
        // Ensure there is a layout override.
        $this->drupalGet('node/1/layout');
        $page->pressButton('Save layout');
        // Delete one of the fields in use.
        $this->drupalGet('admin/structure/types/manage/bundle_with_section_field/fields/node.bundle_with_section_field.body/delete');
        $page->pressButton('Delete');
        // The node should still be accessible.
        $this->drupalGet('node/1');
        $assert_session->statusCodeEquals(200);
        $this->drupalGet('node/1/layout');
        $assert_session->statusCodeEquals(200);
    }
    
    /**
     * Tests Layout Builder overrides without access to edit the default layout.
     */
    public function testOverridesWithoutDefaultsAccess() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
        ]));
        LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default')->enableLayoutBuilder()
            ->setOverridable()
            ->save();
        $this->drupalGet('node/1');
        $page->clickLink('Layout');
        $assert_session->elementTextContains('css', '.layout-builder__message.layout-builder__message--overrides', 'You are editing the layout for this Bundle with section field content item.');
        $assert_session->linkNotExists('Edit the template for all Bundle with section field content items instead.');
    }
    
    /**
     * Tests Layout Builder overrides without Field UI installed.
     */
    public function testOverridesWithoutFieldUi() : void {
        $this->container
            ->get('module_installer')
            ->uninstall([
            'field_ui',
        ]);
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
        ]));
        LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default')->enableLayoutBuilder()
            ->setOverridable()
            ->save();
        $this->drupalGet('node/1');
        $page->clickLink('Layout');
        $assert_session->elementTextContains('css', '.layout-builder__message.layout-builder__message--overrides', 'You are editing the layout for this Bundle with section field content item.');
        $assert_session->linkNotExists('Edit the template for all Bundle with section field content items instead.');
    }
    
    /**
     * Tests functionality of Layout Builder for overrides.
     */
    public function testOverrides() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
            'administer node display',
        ]));
        // From the manage display page, go to manage the layout.
        $this->drupalGet('admin/structure/types/manage/bundle_with_section_field/display/default');
        $this->submitForm([
            'layout[enabled]' => TRUE,
        ], 'Save');
        $this->submitForm([
            'layout[allow_custom]' => TRUE,
        ], 'Save');
        // @todo This should not be necessary.
        $this->container
            ->get('entity_field.manager')
            ->clearCachedFieldDefinitions();
        // Add a block with a custom label.
        $this->drupalGet('node/1');
        $page->clickLink('Layout');
        // The layout form should not contain fields for the title of the node by
        // default.
        $assert_session->fieldNotExists('title[0][value]');
        $assert_session->elementTextContains('css', '.layout-builder__message.layout-builder__message--overrides', 'You are editing the layout for this Bundle with section field content item. Edit the template for all Bundle with section field content items instead.');
        $assert_session->linkExists('Edit the template for all Bundle with section field content items instead.');
        $page->clickLink('Add block');
        $page->clickLink('Powered by Drupal');
        $page->fillField('settings[label]', 'This is an override');
        $page->checkField('settings[label_display]');
        $page->pressButton('Add block');
        $page->pressButton('Save layout');
        $assert_session->pageTextContains('This is an override');
        // Get the UUID of the component.
        $components = Node::load(1)->get('layout_builder__layout')
            ->getSection(0)
            ->getComponents();
        $uuid = array_key_last($components);
        $this->drupalGet('layout_builder/update/block/overrides/node.1/0/content/' . $uuid);
        $page->uncheckField('settings[label_display]');
        $page->pressButton('Update');
        $assert_session->pageTextNotContains('This is an override');
        $page->pressButton('Save layout');
        $assert_session->pageTextNotContains('This is an override');
    }
    
    /**
     * Tests a custom alter of the overrides form.
     */
    public function testOverridesFormAlter() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
            'administer node display',
            'administer nodes',
        ]));
        $field_ui_prefix = 'admin/structure/types/manage/bundle_with_section_field';
        // Enable overrides.
        $this->drupalGet("{$field_ui_prefix}/display/default");
        $this->submitForm([
            'layout[enabled]' => TRUE,
        ], 'Save');
        $this->drupalGet("{$field_ui_prefix}/display/default");
        $this->submitForm([
            'layout[allow_custom]' => TRUE,
        ], 'Save');
        $this->drupalGet('node/1');
        // The status checkbox should be checked by default.
        $page->clickLink('Layout');
        $assert_session->checkboxChecked('status[value]');
        $page->pressButton('Save layout');
        $assert_session->pageTextContains('The layout override has been saved.');
        // Unchecking the status checkbox will unpublish the entity.
        $page->clickLink('Layout');
        $page->uncheckField('status[value]');
        $page->pressButton('Save layout');
        $assert_session->statusCodeEquals(403);
        $assert_session->pageTextContains('The layout override has been saved.');
    }
    
    /**
     * Tests removing all sections from overrides and defaults.
     */
    public function testRemovingAllSections() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
            'administer node display',
        ]));
        $field_ui_prefix = 'admin/structure/types/manage/bundle_with_section_field';
        // Enable overrides.
        $this->drupalGet("{$field_ui_prefix}/display/default");
        $this->submitForm([
            'layout[enabled]' => TRUE,
        ], 'Save');
        $this->drupalGet("{$field_ui_prefix}/display/default");
        $this->submitForm([
            'layout[allow_custom]' => TRUE,
        ], 'Save');
        // By default, there is one section.
        $this->drupalGet('node/1');
        $assert_session->elementsCount('css', '.layout', 1);
        $assert_session->pageTextContains('The first node body');
        $page->clickLink('Layout');
        $assert_session->elementsCount('css', '.layout', 1);
        $assert_session->elementsCount('css', '.layout-builder__add-block', 1);
        $assert_session->elementsCount('css', '.layout-builder__add-section', 2);
        // Remove the only section from the override.
        $page->clickLink('Remove Section 1');
        $page->pressButton('Remove');
        $assert_session->elementsCount('css', '.layout', 0);
        $assert_session->elementsCount('css', '.layout-builder__add-block', 0);
        $assert_session->elementsCount('css', '.layout-builder__add-section', 1);
        // The override is still used instead of the default, despite being empty.
        $page->pressButton('Save layout');
        $assert_session->elementsCount('css', '.layout', 0);
        $assert_session->pageTextNotContains('The first node body');
        $page->clickLink('Layout');
        $assert_session->elementsCount('css', '.layout', 0);
        $assert_session->elementsCount('css', '.layout-builder__add-block', 0);
        $assert_session->elementsCount('css', '.layout-builder__add-section', 1);
        // Add one section to the override.
        $page->clickLink('Add section');
        $page->clickLink('One column');
        $page->pressButton('Add section');
        $assert_session->elementsCount('css', '.layout', 1);
        $assert_session->elementsCount('css', '.layout-builder__add-block', 1);
        $assert_session->elementsCount('css', '.layout-builder__add-section', 2);
        $page->pressButton('Save layout');
        $assert_session->elementsCount('css', '.layout', 1);
        $assert_session->pageTextNotContains('The first node body');
        // By default, the default has one section.
        $this->drupalGet("{$field_ui_prefix}/display/default/layout");
        $assert_session->elementsCount('css', '.layout', 1);
        $assert_session->elementsCount('css', '.layout-builder__add-block', 1);
        $assert_session->elementsCount('css', '.layout-builder__add-section', 2);
        // Remove the only section from the default.
        $page->clickLink('Remove Section 1');
        $page->pressButton('Remove');
        $assert_session->elementsCount('css', '.layout', 0);
        $assert_session->elementsCount('css', '.layout-builder__add-block', 0);
        $assert_session->elementsCount('css', '.layout-builder__add-section', 1);
        $page->pressButton('Save layout');
        $page->clickLink('Manage layout');
        $assert_session->elementsCount('css', '.layout', 0);
        $assert_session->elementsCount('css', '.layout-builder__add-block', 0);
        $assert_session->elementsCount('css', '.layout-builder__add-section', 1);
        // The override is still in use.
        $this->drupalGet('node/1');
        $assert_session->elementsCount('css', '.layout', 1);
        $assert_session->pageTextNotContains('The first node body');
        $page->clickLink('Layout');
        $assert_session->elementsCount('css', '.layout', 1);
        $assert_session->elementsCount('css', '.layout-builder__add-block', 1);
        $assert_session->elementsCount('css', '.layout-builder__add-section', 2);
        // Revert the override.
        $page->pressButton('Revert to defaults');
        $page->pressButton('Revert');
        $assert_session->elementsCount('css', '.layout', 0);
        $assert_session->pageTextNotContains('The first node body');
    }

}

Members

Title 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::$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::$profile protected property The profile to install as a basis for testing. 41
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::__construct public function 1
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
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldUiTestTrait::assertFieldDoesNotExist protected function Asserts that the field doesn't exist in the overview form.
FieldUiTestTrait::assertFieldDoesNotExistOnOverview protected function Asserts that the field does not appear on the overview form.
FieldUiTestTrait::assertFieldExistsOnOverview protected function Asserts that the field appears on the overview form.
FieldUiTestTrait::assertTableHeaderExistsByLabel protected function Asserts that a header cell appears on a table.
FieldUiTestTrait::fieldUIAddExistingField public function Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField public function Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField public function Deletes a field through the Field UI.
FieldUiTestTrait::getFieldFromGroup public function Helper function that returns the name of the group that a field is in.
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. 8
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
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. 29
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
LayoutBuilderOverridesTest::testDeleteField public function Tests deleting a field in-use by an overridden layout.
LayoutBuilderOverridesTest::testOverrides public function Tests functionality of Layout Builder for overrides.
LayoutBuilderOverridesTest::testOverridesFormAlter public function Tests a custom alter of the overrides form.
LayoutBuilderOverridesTest::testOverridesWithoutDefaultsAccess public function Tests Layout Builder overrides without access to edit the default layout.
LayoutBuilderOverridesTest::testOverridesWithoutFieldUi public function Tests Layout Builder overrides without Field UI installed.
LayoutBuilderOverridesTest::testRemovingAllSections public function Tests removing all sections from overrides and defaults.
LayoutBuilderTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 1
LayoutBuilderTestBase::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules 1
LayoutBuilderTestBase::setUp protected function Overrides BrowserTestBase::setUp 1
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
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.
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::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. 3
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::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.