class LayoutBuilderBlocksTest

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

Tests the Layout Builder UI with blocks.

@group layout_builder

Hierarchy

Expanded class hierarchy of LayoutBuilderBlocksTest

File

core/modules/layout_builder/tests/src/Functional/LayoutBuilderBlocksTest.php, line 17

Namespace

Drupal\Tests\layout_builder\Functional
View source 
class LayoutBuilderBlocksTest extends LayoutBuilderTestBase {
    
    /**
     * Tests that block plugins can define custom attributes and contextual links.
     */
    public function testPluginsProvidingCustomAttributesAndContextualLinks() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'access contextual links',
            'configure any layout',
            'administer node display',
        ]));
        $this->drupalGet('admin/structure/types/manage/bundle_with_section_field/display/default');
        $this->submitForm([
            'layout[enabled]' => TRUE,
        ], 'Save');
        $page->clickLink('Manage layout');
        $page->clickLink('Add section');
        $page->clickLink('Layout Builder Test Plugin');
        $page->pressButton('Add section');
        $page->clickLink('Add block');
        $page->clickLink('Test Attributes');
        $page->pressButton('Add block');
        $page->pressButton('Save layout');
        $this->drupalGet('node/1');
        $assert_session->elementExists('css', '.attribute-test-class');
        $assert_session->elementExists('css', '[custom-attribute=test]');
        $assert_session->elementExists('css', 'div[data-contextual-id*="layout_builder_test"]');
    }
    
    /**
     * Tests preview-aware layout & block plugins.
     */
    public function testPreviewAwarePlugins() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
            'administer node display',
        ]));
        $this->drupalGet('admin/structure/types/manage/bundle_with_section_field/display/default');
        $this->submitForm([
            'layout[enabled]' => TRUE,
        ], 'Save');
        $page->clickLink('Manage layout');
        $page->clickLink('Add section');
        $page->clickLink('Layout Builder Test Plugin');
        $page->pressButton('Add section');
        $page->clickLink('Add block');
        $page->clickLink('Preview-aware block');
        $page->pressButton('Add block');
        $assert_session->elementExists('css', '.go-birds-preview');
        $assert_session->pageTextContains('The block template is being previewed.');
        $assert_session->pageTextContains('This block is being rendered in preview mode.');
        $page->pressButton('Save layout');
        $this->drupalGet('node/1');
        $assert_session->elementNotExists('css', '.go-birds-preview');
        $assert_session->pageTextNotContains('The block template is being previewed.');
        $assert_session->pageTextContains('This block is being rendered normally.');
    }
    
    /**
     * {@inheritdoc}
     */
    public function testLayoutBuilderChooseBlocksAlter() : void {
        // See layout_builder_test_plugin_filter_block__layout_builder_alter().
        $assert_session = $this->assertSession();
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
            'administer node display',
            'administer node fields',
        ]));
        // 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');
        $assert_session->linkExists('Manage layout');
        $this->clickLink('Manage layout');
        // Add a new block.
        $this->clickLink('Add block');
        // Verify that blocks not modified are present.
        $assert_session->linkExists('Powered by Drupal');
        $assert_session->linkExists('Default revision');
        // Verify that blocks explicitly removed are not present.
        $assert_session->linkNotExists('Help');
        $assert_session->linkNotExists('Sticky at top of lists');
        $assert_session->linkNotExists('Main page content');
        $assert_session->linkNotExists('Page title');
        $assert_session->linkNotExists('Messages');
        $assert_session->linkNotExists('Help');
        $assert_session->linkNotExists('Tabs');
        $assert_session->linkNotExists('Primary admin actions');
        // Verify that Changed block is not present on first section.
        $assert_session->linkNotExists('Changed');
        // Go back to Manage layout.
        $this->drupalGet('admin/structure/types/manage/bundle_with_section_field/display/default');
        $this->clickLink('Manage layout');
        // Add a new section.
        $this->clickLink('Add section', 1);
        $assert_session->linkExists('Two column');
        $this->clickLink('Two column');
        $assert_session->buttonExists('Add section');
        $this->getSession()
            ->getPage()
            ->pressButton('Add section');
        // Add a new block to second section.
        $this->clickLink('Add block', 1);
        // Verify that Changed block is present on second section.
        $assert_session->linkExists('Changed');
    }
    
    /**
     * Tests that deleting a View block used in Layout Builder works.
     */
    public function testDeletedView() : 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');
        $this->drupalGet('node/1');
        $assert_session->linkExists('Layout');
        $this->clickLink('Layout');
        $this->clickLink('Add block');
        $this->clickLink('Test Block View');
        $page->pressButton('Add block');
        $assert_session->pageTextContains('Test Block View');
        $assert_session->elementExists('css', '.block-views-blocktest-block-view-block-1');
        $page->pressButton('Save');
        $assert_session->pageTextContains('Test Block View');
        $assert_session->elementExists('css', '.block-views-blocktest-block-view-block-1');
        View::load('test_block_view')->delete();
        $this->drupalGet('node/1');
        // Node can be loaded after deleting the View.
        $assert_session->pageTextContains(Node::load(1)->getTitle());
        $assert_session->pageTextNotContains('Test Block View');
    }
    
    /**
     * Tests the usage of placeholders for empty blocks.
     *
     * @see \Drupal\Core\Render\PreviewFallbackInterface::getPreviewFallbackString()
     * @see \Drupal\layout_builder\EventSubscriber\BlockComponentRenderArray::onBuildRender()
     */
    public function testBlockPlaceholder() : 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';
        $this->drupalGet("{$field_ui_prefix}/display/default");
        $this->submitForm([
            'layout[enabled]' => TRUE,
        ], 'Save');
        // Customize the default view mode.
        $this->drupalGet("{$field_ui_prefix}/display/default/layout");
        // Add a block whose content is controlled by state and is empty by default.
        $this->clickLink('Add block');
        $this->clickLink('Test block caching');
        $page->fillField('settings[label]', 'The block label');
        $page->pressButton('Add block');
        $block_content = 'I am content';
        $placeholder_content = 'Placeholder for the "The block label" block';
        // The block placeholder is displayed and there is no content.
        $assert_session->pageTextContains($placeholder_content);
        $assert_session->pageTextNotContains($block_content);
        // Set block content and reload the page.
        \Drupal::state()->set('block_test.content', $block_content);
        $this->getSession()
            ->reload();
        // The block placeholder is no longer displayed and the content is visible.
        $assert_session->pageTextNotContains($placeholder_content);
        $assert_session->pageTextContains($block_content);
    }
    
    /**
     * Tests the ability to use a specified block label for field blocks.
     */
    public function testFieldBlockLabel() : 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';
        $this->drupalGet("{$field_ui_prefix}/display/default");
        $this->submitForm([
            'layout[enabled]' => TRUE,
        ], 'Save');
        // Customize the default view mode.
        $this->drupalGet("{$field_ui_prefix}/display/default/layout");
        // Add a body block whose label will be overridden.
        $this->clickLink('Add block');
        $this->clickLink('Body');
        // Enable the Label Display and set the Label to a modified field
        // block label.
        $modified_field_block_label = 'Modified Field Block Label';
        $page->checkField('settings[label_display]');
        $page->fillField('settings[label]', $modified_field_block_label);
        // Save the block and layout.
        $page->pressButton('Add block');
        $page->pressButton('Save layout');
        // Revisit the default layout view mode page.
        $this->drupalGet("{$field_ui_prefix}/display/default/layout");
        // The modified field block label is displayed.
        $assert_session->pageTextContains($modified_field_block_label);
    }
    
    /**
     * Tests the Block UI when Layout Builder is installed.
     */
    public function testBlockUiListing() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->drupalLogin($this->drupalCreateUser([
            'administer blocks',
        ]));
        $this->drupalGet('admin/structure/block');
        $page->clickLink('Place block');
        // Ensure that blocks expected to appear are available.
        $assert_session->pageTextContains('Test HTML block');
        $assert_session->pageTextContains('Block test');
        // Ensure that blocks not expected to appear are not available.
        $assert_session->pageTextNotContains('Body');
        $assert_session->pageTextNotContains('Content fields');
    }

}

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
LayoutBuilderBlocksTest::testBlockPlaceholder public function Tests the usage of placeholders for empty blocks.
LayoutBuilderBlocksTest::testBlockUiListing public function Tests the Block UI when Layout Builder is installed.
LayoutBuilderBlocksTest::testDeletedView public function Tests that deleting a View block used in Layout Builder works.
LayoutBuilderBlocksTest::testFieldBlockLabel public function Tests the ability to use a specified block label for field blocks.
LayoutBuilderBlocksTest::testLayoutBuilderChooseBlocksAlter public function
LayoutBuilderBlocksTest::testPluginsProvidingCustomAttributesAndContextualLinks public function Tests that block plugins can define custom attributes and contextual links.
LayoutBuilderBlocksTest::testPreviewAwarePlugins public function Tests preview-aware layout & block plugins.
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. 5
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.