class LayoutBuilderTest in Drupal 9

Same name in this branch

9 core/modules/layout_builder/tests/src/Functional/LayoutBuilderTest.php \Drupal\Tests\layout_builder\Functional\LayoutBuilderTest
9 core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderTest.php \Drupal\Tests\layout_builder\FunctionalJavascript\LayoutBuilderTest

Same name and namespace in other branches

8 core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderTest.php \Drupal\Tests\layout_builder\FunctionalJavascript\LayoutBuilderTest

Tests the Layout Builder UI.

@group layout_builder

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase
  - class \Drupal\Tests\layout_builder\FunctionalJavascript\LayoutBuilderTest uses ContextualLinkClickTrait, LayoutBuilderSortTrait

Expanded class hierarchy of LayoutBuilderTest

File

core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderTest.php, line 16

Namespace

Drupal\Tests\layout_builder\FunctionalJavascript

View source

class LayoutBuilderTest extends WebDriverTestBase {
  use ContextualLinkClickTrait;
  use LayoutBuilderSortTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'block_content',
    'field_ui',
    'layout_builder',
    'layout_test',
    'node',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * The node to customize with Layout Builder.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $node;

  /**
   * A string used to mark the current page.
   *
   * @var string
   *
   * @todo Remove in https://www.drupal.org/project/drupal/issues/2909782.
   */
  private $pageReloadMarker;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->drupalPlaceBlock('local_tasks_block');
    $bundle = BlockContentType::create([
      'id' => 'basic',
      'label' => 'Basic',
    ]);
    $bundle
      ->save();
    block_content_add_body_field($bundle
      ->id());
    BlockContent::create([
      'info' => 'My custom block',
      'type' => 'basic',
      'body' => [
        [
          'value' => 'This is the block content',
          'format' => filter_default_format(),
        ],
      ],
    ])
      ->save();
    $this
      ->createContentType([
      'type' => 'bundle_with_section_field',
    ]);
    $this->node = $this
      ->createNode([
      'type' => 'bundle_with_section_field',
      'title' => 'The node title',
      'body' => [
        [
          'value' => 'The node body',
        ],
      ],
    ]);
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access contextual links',
      'configure any layout',
      'administer node display',
    ], 'foobar'));
  }

  /**
   * Tests the Layout Builder UI.
   */
  public function testLayoutBuilderUi() {
    $layout_url = 'node/1/layout';
    $node_url = 'node/1';
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Ensure the block is not displayed initially.
    $this
      ->drupalGet($node_url);
    $assert_session
      ->pageTextContains('The node body');
    $assert_session
      ->pageTextNotContains('Powered by Drupal');
    $assert_session
      ->linkNotExists('Layout');
    $this
      ->enableLayoutsForBundle('admin/structure/types/manage/bundle_with_section_field/display', TRUE);

    // The existing content is still shown until overridden.
    $this
      ->drupalGet($node_url);
    $assert_session
      ->pageTextContains('The node body');

    // Enter the layout editing mode.
    $assert_session
      ->linkExists('Layout');
    $this
      ->clickLink('Layout');
    $this
      ->markCurrentPage();
    $assert_session
      ->pageTextContains('The node body');
    $assert_session
      ->linkExists('Add section');

    // Add a new block.
    $this
      ->openAddBlockForm('Powered by Drupal');
    $page
      ->fillField('settings[label]', 'This is the label');
    $page
      ->checkField('settings[label_display]');

    // Save the new block, and ensure it is displayed on the page.
    $page
      ->pressButton('Add block');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->assertNoElementAfterWait('css', '#drupal-off-canvas');
    $assert_session
      ->addressEquals($layout_url);
    $assert_session
      ->pageTextContains('Powered by Drupal');
    $assert_session
      ->pageTextContains('This is the label');
    $this
      ->assertPageNotReloaded();

    // Until the layout is saved, the new block is not visible on the node page.
    $this
      ->drupalGet($node_url);
    $assert_session
      ->pageTextNotContains('Powered by Drupal');

    // When returning to the layout edit mode, the new block is visible.
    $this
      ->drupalGet($layout_url);
    $assert_session
      ->pageTextContains('Powered by Drupal');

    // Save the layout, and the new block is visible.
    $page
      ->pressButton('Save layout');
    $assert_session
      ->addressEquals($node_url);
    $assert_session
      ->pageTextContains('Powered by Drupal');
    $assert_session
      ->pageTextContains('This is the label');
    $assert_session
      ->elementExists('css', '.layout');
    $this
      ->drupalGet($layout_url);
    $this
      ->markCurrentPage();
    $assert_session
      ->linkExists('Add section');
    $this
      ->clickLink('Add section');
    $this
      ->assertNotEmpty($assert_session
      ->waitForElementVisible('named', [
      'link',
      'Two column',
    ]));
    $this
      ->clickLink('Two column');
    $assert_session
      ->waitForElementVisible('named', [
      'button',
      'Add section',
    ]);
    $page
      ->pressButton('Add section');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->assertNoElementAfterWait('css', '.layout__region--second .block-system-powered-by-block');
    $assert_session
      ->elementTextNotContains('css', '.layout__region--second', 'Powered by Drupal');

    // Drag the block to a region in different section.
    $this
      ->sortableTo('.block-system-powered-by-block', '.layout__region--content', '.layout__region--second');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Ensure the drag succeeded.
    $assert_session
      ->elementExists('css', '.layout__region--second .block-system-powered-by-block');
    $assert_session
      ->elementTextContains('css', '.layout__region--second', 'Powered by Drupal');
    $this
      ->assertPageNotReloaded();

    // Ensure the dragged block is still in the correct position after reload.
    $this
      ->drupalGet($layout_url);
    $assert_session
      ->elementExists('css', '.layout__region--second .block-system-powered-by-block');
    $assert_session
      ->elementTextContains('css', '.layout__region--second', 'Powered by Drupal');

    // Ensure the dragged block is still in the correct position after save.
    $page
      ->pressButton('Save layout');
    $assert_session
      ->elementExists('css', '.layout__region--second .block-system-powered-by-block');
    $assert_session
      ->elementTextContains('css', '.layout__region--second', 'Powered by Drupal');

    // Reconfigure a block and ensure that the layout content is updated.
    $this
      ->drupalGet($layout_url);
    $this
      ->markCurrentPage();
    $this
      ->clickContextualLink('.block-system-powered-by-block', 'Configure');
    $this
      ->assertOffCanvasFormAfterWait('layout_builder_update_block');
    $page
      ->fillField('settings[label]', 'This is the new label');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->assertNoElementAfterWait('css', '#drupal-off-canvas');
    $assert_session
      ->addressEquals($layout_url);
    $assert_session
      ->pageTextContains('Powered by Drupal');
    $assert_session
      ->pageTextContains('This is the new label');
    $assert_session
      ->pageTextNotContains('This is the label');

    // Remove a block.
    $this
      ->clickContextualLink('.block-system-powered-by-block', 'Remove block');
    $this
      ->assertOffCanvasFormAfterWait('layout_builder_remove_block');
    $assert_session
      ->pageTextContains('Are you sure you want to remove the This is the new label block?');
    $assert_session
      ->pageTextContains('This action cannot be undone.');
    $page
      ->pressButton('Remove');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->assertNoElementAfterWait('css', '#drupal-off-canvas');
    $assert_session
      ->pageTextNotContains('Powered by Drupal');
    $assert_session
      ->linkExists('Add block');
    $assert_session
      ->addressEquals($layout_url);
    $this
      ->assertPageNotReloaded();
    $page
      ->pressButton('Save layout');
    $assert_session
      ->elementExists('css', '.layout');

    // Test deriver-based blocks.
    $this
      ->drupalGet($layout_url);
    $this
      ->markCurrentPage();
    $this
      ->openAddBlockForm('My custom block');
    $page
      ->pressButton('Add block');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->pageTextContains('This is the block content');

    // Remove both sections.
    $assert_session
      ->linkExists('Remove Section 1');
    $this
      ->clickLink('Remove Section 1');
    $this
      ->assertOffCanvasFormAfterWait('layout_builder_remove_section');
    $assert_session
      ->pageTextContains('Are you sure you want to remove section 1?');
    $assert_session
      ->pageTextContains('This action cannot be undone.');
    $page
      ->pressButton('Remove');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->linkExists('Remove Section 1');
    $this
      ->clickLink('Remove Section 1');
    $this
      ->assertOffCanvasFormAfterWait('layout_builder_remove_section');
    $page
      ->pressButton('Remove');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->pageTextNotContains('This is the block content');
    $assert_session
      ->linkNotExists('Add block');
    $this
      ->assertPageNotReloaded();
    $page
      ->pressButton('Save layout');

    // Removing all sections results in no layout being used.
    $assert_session
      ->addressEquals($node_url);
    $assert_session
      ->elementNotExists('css', '.layout');
    $assert_session
      ->pageTextNotContains('The node body');
  }

  /**
   * Tests configurable layouts.
   */
  public function testConfigurableLayoutSections() {
    $layout_url = 'node/1/layout';
    \Drupal::entityTypeManager()
      ->getStorage('entity_view_display')
      ->create([
      'targetEntityType' => 'node',
      'bundle' => 'bundle_with_section_field',
      'mode' => 'full',
    ])
      ->enable()
      ->setThirdPartySetting('layout_builder', 'enabled', TRUE)
      ->setThirdPartySetting('layout_builder', 'allow_custom', TRUE)
      ->save();
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalGet($layout_url);
    $this
      ->markCurrentPage();
    $assert_session
      ->linkExists('Add section');
    $this
      ->clickLink('Add section');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->elementExists('css', '#drupal-off-canvas');
    $assert_session
      ->linkExists('One column');
    $this
      ->clickLink('One column');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Add another section.
    $assert_session
      ->linkExists('Add section');
    $this
      ->clickLink('Add section');
    $assert_session
      ->waitForElementVisible('named', [
      'link',
      'Layout plugin (with settings)',
    ]);
    $assert_session
      ->elementExists('css', '#drupal-off-canvas');
    $assert_session
      ->linkExists('Layout plugin (with settings)');
    $this
      ->clickLink('Layout plugin (with settings)');
    $this
      ->assertOffCanvasFormAfterWait('layout_builder_configure_section');
    $assert_session
      ->fieldExists('layout_settings[setting_1]');
    $page
      ->pressButton('Add section');
    $assert_session
      ->assertNoElementAfterWait('css', '#drupal-off-canvas');
    $assert_session
      ->pageTextContains('Default');
    $assert_session
      ->linkExists('Add block');

    // Ensure validation error is displayed for ConfigureSectionForm.
    $assert_session
      ->linkExists('Add section');
    $this
      ->clickLink('Add section');
    $assert_session
      ->waitForElementVisible('named', [
      'link',
      'Layout plugin (with settings)',
    ]);
    $this
      ->clickLink('Layout plugin (with settings)');
    $this
      ->assertOffCanvasFormAfterWait('layout_builder_configure_section');
    $page
      ->fillField('layout_settings[setting_1]', 'Test Validation Error Message');
    $page
      ->pressButton('Add section');
    $assert_session
      ->waitForElement('css', '.messages--error');
    $assert_session
      ->pageTextContains('Validation Error Message');
    $page
      ->fillField('layout_settings[setting_1]', 'Setting 1 Value');
    $page
      ->pressButton('Add section');
    $assert_session
      ->assertNoElementAfterWait('css', '#drupal-off-canvas');
    $assert_session
      ->pageTextContains('Setting 1 Value');

    // Configure the existing section.
    $assert_session
      ->linkExists('Configure Section 1');
    $this
      ->clickLink('Configure Section 1');
    $this
      ->assertOffCanvasFormAfterWait('layout_builder_configure_section');
    $page
      ->fillField('layout_settings[setting_1]', 'Test setting value');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertNoElementAfterWait('css', '#drupal-off-canvas');
    $assert_session
      ->pageTextContains('Test setting value');
    $this
      ->assertPageNotReloaded();
  }

  /**
   * Tests bypassing the off-canvas dialog.
   */
  public function testLayoutNoDialog() {
    $layout_url = 'node/1/layout';
    \Drupal::entityTypeManager()
      ->getStorage('entity_view_display')
      ->create([
      'targetEntityType' => 'node',
      'bundle' => 'bundle_with_section_field',
      'mode' => 'full',
    ])
      ->enable()
      ->setThirdPartySetting('layout_builder', 'enabled', TRUE)
      ->setThirdPartySetting('layout_builder', 'allow_custom', TRUE)
      ->save();
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Set up a layout with one section.
    $this
      ->drupalGet(Url::fromRoute('layout_builder.choose_section', [
      'section_storage_type' => 'overrides',
      'section_storage' => 'node.1',
      'delta' => 0,
    ]));
    $assert_session
      ->linkExists('One column');
    $this
      ->clickLink('One column');
    $page
      ->pressButton('Add section');

    // Add a block.
    $this
      ->drupalGet(Url::fromRoute('layout_builder.add_block', [
      'section_storage_type' => 'overrides',
      'section_storage' => 'node.1',
      'delta' => 0,
      'region' => 'content',
      'plugin_id' => 'system_powered_by_block',
    ]));
    $assert_session
      ->assertNoElementAfterWait('css', '#drupal-off-canvas');
    $page
      ->fillField('settings[label]', 'The block label');
    $page
      ->fillField('settings[label_display]', TRUE);
    $page
      ->pressButton('Add block');
    $assert_session
      ->addressEquals($layout_url);
    $assert_session
      ->pageTextContains('Powered by Drupal');
    $assert_session
      ->pageTextContains('The block label');

    // Remove the section.
    $this
      ->drupalGet(Url::fromRoute('layout_builder.remove_section', [
      'section_storage_type' => 'overrides',
      'section_storage' => 'node.1',
      'delta' => 0,
    ]));
    $page
      ->pressButton('Remove');
    $assert_session
      ->addressEquals($layout_url);
    $assert_session
      ->pageTextNotContains('Powered by Drupal');
    $assert_session
      ->pageTextNotContains('The block label');
    $assert_session
      ->linkNotExists('Add block');
  }

  /**
   * {@inheritdoc}
   *
   * @todo Remove this in https://www.drupal.org/project/drupal/issues/2918718.
   */
  protected function clickContextualLink($selector, $link_locator, $force_visible = TRUE) {

    /** @var \Drupal\FunctionalJavascriptTests\JSWebAssert $assert_session */
    $assert_session = $this
      ->assertSession();

    /** @var \Behat\Mink\Element\DocumentElement $page */
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->waitFor(10, function () use ($page, $selector) {
      return $page
        ->find('css', "{$selector} .contextual-links");
    });
    if (count($page
      ->findAll('css', "{$selector} .contextual-links")) > 1) {
      throw new \Exception('More than one contextual links found by selector');
    }
    if ($force_visible && $page
      ->find('css', "{$selector} .contextual .trigger.visually-hidden")) {
      $this
        ->toggleContextualTriggerVisibility($selector);
    }
    $link = $assert_session
      ->elementExists('css', $selector)
      ->findLink($link_locator);
    $this
      ->assertNotEmpty($link);
    if (!$link
      ->isVisible()) {
      $button = $assert_session
        ->waitForElementVisible('css', "{$selector} .contextual button");
      $this
        ->assertNotEmpty($button);
      $button
        ->press();
      $link = $page
        ->waitFor(10, function () use ($link) {
        return $link
          ->isVisible() ? $link : FALSE;
      });
    }
    $link
      ->click();
    if ($force_visible) {
      $this
        ->toggleContextualTriggerVisibility($selector);
    }
  }

  /**
   * Enable layouts.
   *
   * @param string $path
   *   The path for the manage display page.
   * @param bool $allow_custom
   *   Whether to allow custom layouts.
   */
  private function enableLayoutsForBundle($path, $allow_custom = FALSE) {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalGet($path);
    $page
      ->checkField('layout[enabled]');
    if ($allow_custom) {
      $this
        ->assertNotEmpty($assert_session
        ->waitForElementVisible('css', 'input[name="layout[allow_custom]"]'));
      $page
        ->checkField('layout[allow_custom]');
    }
    $page
      ->pressButton('Save');
    $this
      ->assertNotEmpty($assert_session
      ->waitForElementVisible('css', '#edit-manage-layout'));
    $assert_session
      ->linkExists('Manage layout');
  }

  /**
   * Opens the add block form in the off-canvas dialog.
   *
   * @param string $block_title
   *   The block title which will be the link text.
   */
  private function openAddBlockForm($block_title) {
    $assert_session = $this
      ->assertSession();
    $assert_session
      ->linkExists('Add block');
    $this
      ->clickLink('Add block');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertNotEmpty($assert_session
      ->waitForElementVisible('named', [
      'link',
      $block_title,
    ]));
    $this
      ->clickLink($block_title);
    $this
      ->assertOffCanvasFormAfterWait('layout_builder_add_block');
  }

  /**
   * Waits for the specified form and returns it when available and visible.
   *
   * @param string $expected_form_id
   *   The expected form ID.
   */
  private function assertOffCanvasFormAfterWait($expected_form_id) {
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $off_canvas = $this
      ->assertSession()
      ->waitForElementVisible('css', '#drupal-off-canvas');
    $this
      ->assertNotNull($off_canvas);
    $form_id_element = $off_canvas
      ->find('hidden_field_selector', [
      'hidden_field',
      'form_id',
    ]);

    // Ensure the form ID has the correct value and that the form is visible.
    $this
      ->assertNotEmpty($form_id_element);
    $this
      ->assertSame($expected_form_id, $form_id_element
      ->getValue());
    $this
      ->assertTrue($form_id_element
      ->getParent()
      ->isVisible());
  }

  /**
   * Marks the page to assist determining if the page has been reloaded.
   *
   * @todo Remove in https://www.drupal.org/project/drupal/issues/2909782.
   */
  private function markCurrentPage() {
    $this->pageReloadMarker = $this
      ->randomMachineName();
    $this
      ->getSession()
      ->executeScript('document.body.appendChild(document.createTextNode("' . $this->pageReloadMarker . '"));');
  }

  /**
   * Asserts that the page has not been reloaded.
   *
   * @todo Remove in https://www.drupal.org/project/drupal/issues/2909782.
   */
  private function assertPageNotReloaded() {
    $this
      ->assertSession()
      ->pageTextContains($this->pageReloadMarker);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
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 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::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 drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
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.	39
BrowserTestBase::$root	protected	property	The app root.
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 Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
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::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
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::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::__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
ContextualLinkClickTrait::toggleContextualTriggerVisibility	protected	function	Toggles the visibility of a contextual trigger.
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::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.
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
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.	2
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
LayoutBuilderSortTrait::sortableUpdate	protected	function	Define to provide any necessary callback following layout change. Overrides SortableTestTrait::sortableUpdate
LayoutBuilderTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LayoutBuilderTest::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules
LayoutBuilderTest::$node	protected	property	The node to customize with Layout Builder.
LayoutBuilderTest::$pageReloadMarker	private	property	A string used to mark the current page.
LayoutBuilderTest::assertOffCanvasFormAfterWait	private	function	Waits for the specified form and returns it when available and visible.
LayoutBuilderTest::assertPageNotReloaded	private	function	Asserts that the page has not been reloaded.
LayoutBuilderTest::clickContextualLink	protected	function	@todo Remove this in https://www.drupal.org/project/drupal/issues/2918718. Overrides ContextualLinkClickTrait::clickContextualLink
LayoutBuilderTest::enableLayoutsForBundle	private	function	Enable layouts.
LayoutBuilderTest::markCurrentPage	private	function	Marks the page to assist determining if the page has been reloaded.
LayoutBuilderTest::openAddBlockForm	private	function	Opens the add block form in the off-canvas dialog.
LayoutBuilderTest::setUp	protected	function	Overrides BrowserTestBase::setUp
LayoutBuilderTest::testConfigurableLayoutSections	public	function	Tests configurable layouts.
LayoutBuilderTest::testLayoutBuilderUi	public	function	Tests the Layout Builder UI.
LayoutBuilderTest::testLayoutNoDialog	public	function	Tests bypassing the off-canvas dialog.
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::$randomGenerator	protected	property	The random generator.
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.	1
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	public	function	Callback for random string validation.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
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.
SortableTestTrait::sortableAfter	protected	function	Simulates a drag moving an element after its sibling in the same container.
SortableTestTrait::sortableTo	protected	function	Simulates a drag on an element from one container to another.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
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.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
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::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
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	public static	function	Returns the database connection to the site running Simpletest.
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::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.	2
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::drupalPostForm Deprecated	protected	function	Executes a form submission.
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.
WebDriverTestBase::$disableCssAnimations	protected	property	Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$failOnJavascriptConsoleErrors	protected	property	Determines if a test should fail on JavaScript console errors.	3
WebDriverTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass	1
WebDriverTestBase::assertJsCondition	protected	function	Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession	public	function	Returns WebAssert object. Overrides UiHelperTrait::assertSession
WebDriverTestBase::createScreenshot	protected	function	Creates a screenshot.
WebDriverTestBase::getDrupalSettings	protected	function	Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink	protected	function	Initializes Mink sessions. Overrides BrowserTestBase::initMink
WebDriverTestBase::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown	protected	function	Overrides BrowserTestBase::tearDown	1
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class LayoutBuilderTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation