You are here

class LayoutBuilderLockTest in Layout Builder Lock 8

Tests Layout Builder Lock.

@group layout_builder_lock

Hierarchy

Expanded class hierarchy of LayoutBuilderLockTest

File

tests/src/Functional/LayoutBuilderLockTest.php, line 20

Namespace

Drupal\Tests\layout_builder_lock\Functional
View source
class LayoutBuilderLockTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'layout_builder',
    'layout_builder_lock',
    'block_content',
    'block',
    'node',
    'user',
  ];

  /**
   * The body field uuid.
   *
   * @var string
   */
  protected $body_field_block_uuid;

  /**
   * The custom default block uuid.
   *
   * @var string
   */
  protected $custom_default_block_uuid;

  /**
   * The editor block uuid.
   *
   * @var string
   */
  protected $custom_editor_block_uuid;

  /**
   * The default theme to use.
   *
   * @var string
   */
  protected $defaultTheme = 'stark';

  /**
   * A user with all permissions.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * A user with all permissions except bypass.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUserNoBypass;

  /**
   * A user with default permissions.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $editor;

  /**
   * A user which can override lock settings overrides.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $editorOverride;

  /**
   * The default editor permissions.
   *
   * @var array
   */
  protected $editorPermissions = [
    'bypass node access',
    'configure any layout',
    'create and edit custom blocks',
    'access contextual links',
  ];

  /**
   * The editor permissions.
   *
   * @var array
   */
  protected $editorOverridePermissions = [
    'bypass node access',
    'configure any layout',
    'create and edit custom blocks',
    'access contextual links',
    'manage lock settings on overrides',
  ];

  /**
   * The editor permissions.
   *
   * @var array
   */
  protected $adminUserNoBypassPermissions = [
    'bypass node access',
    'configure any layout',
    'create and edit custom blocks',
    'access contextual links',
    'administer node display',
    'manage lock settings on sections',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Enable Layout Builder for landing page.
    $this
      ->createContentType([
      'type' => 'landing_page',
    ]);
    $bundle = BlockContentType::create([
      'id' => 'basic',
      'label' => 'Basic',
      'revision' => FALSE,
    ]);
    $bundle
      ->save();
    block_content_add_body_field($bundle
      ->id());
    LayoutBuilderEntityViewDisplay::load('node.landing_page.default')
      ->enableLayoutBuilder()
      ->setOverridable()
      ->save();
    try {
      $this->adminUser = $this
        ->createUser([], 'administrator', TRUE);
    } catch (EntityStorageException $ignored) {
    }
    try {
      $this->adminUserNoBypass = $this
        ->createUser($this->adminUserNoBypassPermissions, 'administratorNoByPass');
    } catch (EntityStorageException $ignored) {
    }
    try {
      $this->editor = $this
        ->createUser($this->editorPermissions, 'editor');
    } catch (EntityStorageException $ignored) {
    }
    try {
      $this->editorOverride = $this
        ->createUser($this->editorOverridePermissions, 'editorOverride');
    } catch (EntityStorageException $ignored) {
    }
  }

  /**
   * Tests locking features on sections.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testLock() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Create first node.
    $node_1 = $this
      ->drupalCreateNode([
      'type' => 'landing_page',
      'title' => 'Homepage 1',
    ]);

    // Check as editor.
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/' . $node_1
      ->id() . '/layout');

    // Get the block uuid from the body field.
    $id = $assert_session
      ->elementExists('css', '.layout-builder__region > div:nth-child(3)');
    $this->body_field_block_uuid = $id
      ->getAttribute('data-layout-block-uuid');

    // Check links and access.
    $this
      ->checkLinksAndAccess($assert_session, $node_1);

    // Configure the section locks.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('/layout_builder/configure/section/defaults/node.landing_page.default/0');
    $edit = [];
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_BLOCK_ADD . ']'] = TRUE;
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_BLOCK_MOVE . ']'] = TRUE;
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_BLOCK_UPDATE . ']'] = TRUE;
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_BLOCK_DELETE . ']'] = TRUE;
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_BEFORE . ']'] = TRUE;
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_BLOCK_MOVE . ']'] = TRUE;
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_AFTER . ']'] = TRUE;
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_CONFIGURE . ']'] = TRUE;
    $this
      ->drupalPostForm(NULL, $edit, 'Update');
    $page
      ->pressButton('Save layout');

    // Create second node.
    $node_2 = $this
      ->drupalCreateNode([
      'type' => 'landing_page',
      'title' => 'Homepage 2',
    ]);

    // Check as editor.
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/' . $node_2
      ->id() . '/layout');
    $this
      ->checkLinksAndAccess($assert_session, $node_2, TRUE, 403);

    // Links will still exist on node 1 as the overridden settings are used.
    $this
      ->drupalGet('node/' . $node_1
      ->id() . '/layout');
    $this
      ->checkLinksAndAccess($assert_session, $node_1);

    // Override per entity is allowed for administrators.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('layout_builder/configure/section/overrides/node.' . $node_2
      ->id() . '/0');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->responseContains('Lock settings');

    // Check if a user can manage override.
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/' . $node_2
      ->id() . '/layout');
    $assert_session
      ->responseNotContains('Configure section 1');
    $this
      ->drupalGet('layout_builder/configure/section/overrides/node.' . $node_2
      ->id() . '/0');
    $assert_session
      ->statusCodeEquals(403);
    $this
      ->drupalLogin($this->editorOverride);
    $this
      ->drupalGet('node/' . $node_2
      ->id() . '/layout');
    $assert_session
      ->responseContains('Configure section 1');
    $this
      ->drupalGet('layout_builder/configure/section/overrides/node.' . $node_2
      ->id() . '/0');
    $assert_session
      ->statusCodeEquals(200);

    // Override settings on override.
    $node_3 = $this
      ->drupalCreateNode([
      'type' => 'landing_page',
      'title' => 'Homepage 3',
    ]);
    $this
      ->drupalGet('node/' . $node_3
      ->id() . '/layout');
    $assert_session
      ->statusCodeEquals(200);
    $this
      ->drupalGet('layout_builder/configure/section/overrides/node.' . $node_3
      ->id() . '/0');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->responseContains('Lock settings');
    $edit = [];
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_AFTER . ']'] = FALSE;
    $this
      ->drupalPostForm(NULL, $edit, 'Update');
    $page
      ->pressButton('Save layout');
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/' . $node_3
      ->id() . '/layout');
    $this
      ->checkLinksAndAccess($assert_session, $node_3, TRUE, 403, TRUE);

    // Try to add a new section.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/1/layout_onecol');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->responseContains('Locks can be configured when the section has been added.');
    $this
      ->drupalPostForm(NULL, [], 'Add section');
    $assert_session
      ->statusCodeEquals(200);

    // Test the 'bypass lock settings on layout overrides', in combination
    // with 'manage lock settings on sections'. In this case, the user does not
    // have the permission to do anything on the override.
    $this
      ->drupalLogin($this->adminUserNoBypass);
    $this
      ->drupalGet('/layout_builder/configure/section/defaults/node.landing_page.default/0');
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->responseContains('Lock settings');
    $this
      ->drupalGet('node/' . $node_2
      ->id() . '/layout');
    $this
      ->checkLinksAndAccess($assert_session, $node_2, TRUE, 403);

    // Check custom inline block can be updated in a section that is configured
    // to allow adding new blocks and not allowing updating default blocks.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('/layout_builder/configure/section/defaults/node.landing_page.default/0');
    $edit = [];
    $edit['layout_builder_lock[' . LayoutBuilderLock::LOCKED_BLOCK_ADD . ']'] = FALSE;
    $this
      ->drupalPostForm(NULL, $edit, 'Update');
    $this
      ->drupalGet('/layout_builder/add/block/defaults/node.landing_page.default/0/content/inline_block:basic');
    $edit = [];
    $edit['settings[label]'] = 'Default custom block title';
    $edit['settings[block_form][body][0][value]'] = 'Default custom block content';
    $this
      ->drupalPostForm(NULL, $edit, 'Add block');

    // Get the block uuid from the custom block.
    $id = $assert_session
      ->elementExists('css', '.layout-builder__region > div:nth-child(4)');
    $this->custom_default_block_uuid = $id
      ->getAttribute('data-layout-block-uuid');
    $page
      ->pressButton('Save layout');
    $this
      ->drupalGet('/layout_builder/configure/section/defaults/node.landing_page.default/0');
    $assert_session
      ->checkboxNotChecked('layout_builder_lock[4]');
    $this
      ->drupalGet('/layout_builder/update/block/defaults/node.landing_page.default/0/content/' . $this->custom_default_block_uuid);
    $assert_session
      ->statusCodeEquals(200);
    $assert_session
      ->responseContains('Default custom block content');

    // Check as editor.
    $node_4 = $this
      ->drupalCreateNode([
      'type' => 'landing_page',
      'title' => 'Landing page 2',
    ]);
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/' . $node_4
      ->id() . '/layout');
    $assert_session
      ->responseContains('Default custom block content');
    $assert_session
      ->linkExists('Add block');
    $this
      ->drupalGet('/layout_builder/update/block/overrides/node.' . $node_4
      ->id() . '/0/content/' . $this->custom_default_block_uuid);
    $assert_session
      ->statusCodeEquals(403);

    // Add custom block as editor
    $this
      ->drupalGet('/layout_builder/add/block/overrides/node.' . $node_4
      ->id() . '/0/content/inline_block:basic');
    $edit = [];
    $edit['settings[label]'] = 'Editor block title';
    $edit['settings[block_form][body][0][value]'] = 'Editor block content';
    $this
      ->drupalPostForm(NULL, $edit, 'Add block');
    $id = $assert_session
      ->elementExists('css', '.layout-builder__region > div:nth-child(5)');
    $this->custom_editor_block_uuid = $id
      ->getAttribute('data-layout-block-uuid');
    $page
      ->pressButton('Save layout');
    $assert_session
      ->responseContains('Editor block content');
    $this
      ->drupalGet('/layout_builder/update/block/overrides/node.' . $node_4
      ->id() . '/0/content/' . $this->custom_editor_block_uuid);
    $assert_session
      ->statusCodeEquals(200);
  }

  /**
   * Tests with at least 3 sections.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testMultipleSections() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Ensure the lock settings are added to the correct section when adding a
    // new section before an existing section.
    // We expect that:
    //  - we can't add lock settings for new sections,
    //    @see https://www.drupal.org/project/layout_builder_lock/issues/3129009
    //  - the settings are stored on the correct section
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/0/layout_onecol');
    $assert_session
      ->responseContains('Locks can be configured when the section has been added.');

    // Add a new section above default
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/0/layout_onecol');
    $this
      ->drupalPostForm(NULL, [
      'layout_settings[label]' => 'section above default',
    ], 'Add section');
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/0');
    $this
      ->drupalPostForm(NULL, [
      'layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_CONFIGURE . ']' => TRUE,
    ], 'Update');

    // Add a new section between previous created and default
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/1/layout_onecol');
    $this
      ->drupalPostForm(NULL, [
      'layout_settings[label]' => 'new section in between',
    ], 'Add section');
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/1');
    $this
      ->drupalPostForm(NULL, [
      'layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_BEFORE . ']' => TRUE,
    ], 'Update');
    $page
      ->pressButton('Save layout');

    // we expect that the first section (first added) has the `locked section configure` checkbox checked
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/0');
    $assert_session
      ->checkboxChecked('layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_CONFIGURE . ']');
    $assert_session
      ->checkboxNotChecked('layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_BEFORE . ']');

    // we expect that the second section (last added) has the `locked section before` checkbox checked
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/1');
    $assert_session
      ->checkboxChecked('layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_BEFORE . ']');
    $assert_session
      ->checkboxNotChecked('layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_CONFIGURE . ']');

    // we expect that the third section (default) has no checkboxes checked
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/2');
    $assert_session
      ->checkboxNotChecked('layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_CONFIGURE . ']');
    $assert_session
      ->checkboxNotChecked('layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_BEFORE . ']');

    // Create a node.
    $node = $this
      ->drupalCreateNode([
      'type' => 'landing_page',
      'title' => 'Homepage',
    ]);

    // Simply login as an editor. Should not throw any PHP error
    // @see https://www.drupal.org/project/layout_builder_lock/issues/3121250
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/' . $node
      ->id() . '/layout');
    $assert_session
      ->linkByHrefExists('/layout_builder/choose/section/overrides/node.' . $node
      ->id() . '/0');
    $assert_session
      ->linkByHrefNotExists('/layout_builder/choose/section/overrides/node.' . $node
      ->id() . '/1');
    $assert_session
      ->linkByHrefExists('/layout_builder/choose/section/overrides/node.' . $node
      ->id() . '/2');
    $assert_session
      ->linkExists('Configure new section in between');
    $assert_session
      ->linkExists('Configure Section 3');

    // Ensure sections with empty lock config don't mess up the subsequent
    // 'configure section' links.
    $this
      ->drupalLogin($this->adminUser);

    // Add a section without config so it has a section delta > 1.
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/2/layout_onecol');
    $this
      ->drupalPostForm(NULL, [
      'layout_settings[label]' => 'section without any lock config',
    ], 'Add section');

    // Add extra sections that have section configuration locked
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/3/layout_onecol');
    $this
      ->drupalPostForm(NULL, [
      'layout_settings[label]' => 'section with locked section configuration  1',
    ], 'Add section');
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/3');
    $this
      ->drupalPostForm(NULL, [
      'layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_CONFIGURE . ']' => TRUE,
      'layout_settings[label]' => 'section with locked section configuration  1',
    ], 'Update');
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/5/layout_onecol');
    $this
      ->drupalPostForm(NULL, [
      'layout_settings[label]' => 'section with locked section configuration  2',
    ], 'Add section');
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/5');
    $this
      ->drupalPostForm(NULL, [
      'layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_CONFIGURE . ']' => TRUE,
      'layout_settings[label]' => 'section with locked section configuration  2',
    ], 'Update');
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/6/layout_onecol');
    $this
      ->drupalPostForm(NULL, [
      'layout_settings[label]' => 'section with locked section configuration  3',
    ], 'Add section');
    $this
      ->drupalGet('layout_builder/configure/section/defaults/node.landing_page.default/6');
    $this
      ->drupalPostForm(NULL, [
      'layout_builder_lock[' . LayoutBuilderLock::LOCKED_SECTION_CONFIGURE . ']' => TRUE,
      'layout_settings[label]' => 'section with locked section configuration 3',
    ], 'Update');
    $page
      ->pressButton('Save layout');

    // Create a node.
    $node = $this
      ->drupalCreateNode([
      'type' => 'landing_page',
      'title' => 'Homepage',
    ]);
    $this
      ->drupalLogin($this->editor);
    $this
      ->drupalGet('node/' . $node
      ->id() . '/layout');
    $assert_session
      ->linkNotExists('Configure section above default');
    $assert_session
      ->linkExists('Configure new section in between');
    $assert_session
      ->linkExists('Configure section without any lock config');
    $assert_session
      ->linkNotExists('Configure section with locked configure 1');
    $assert_session
      ->linkExists('Configure Section 5');
    $assert_session
      ->linkNotExists('Configure section with locked configure 2');
    $assert_session
      ->linkNotExists('Configure section with locked configure 3');
  }

  /**
   * Checks links and access.
   *
   * @param \Drupal\Tests\WebAssert $assert_session
   * @param \Drupal\node\NodeInterface $node
   * @param bool $locked
   * @param int $code
   * @param null $allow_section_after
   *
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  protected function checkLinksAndAccess(WebAssert $assert_session, NodeInterface $node, $locked = FALSE, $code = 200, $allow_section_after = NULL) {
    if ($code == 200) {
      $assert_session
        ->linkExists('Add block');
      $assert_session
        ->linkExists('Add section');
      $assert_session
        ->linkExists('Remove Section 1');
      $assert_session
        ->linkExists('Configure Section 1');
      $assert_session
        ->responseContains('js-layout-builder-block');
      $assert_session
        ->responseContains('js-layout-builder-region');
    }
    else {
      if ($allow_section_after) {
        $assert_session
          ->linkExists('Add section');
      }
      else {
        $assert_session
          ->linkNotExists('Add section');
      }
      $assert_session
        ->linkNotExists('Add block');
      $assert_session
        ->linkNotExists('Remove Section 1');
      $assert_session
        ->linkNotExists('Configure Section 1');
      $assert_session
        ->responseNotContains('js-layout-builder-block');
      $assert_session
        ->responseNotContains('js-layout-builder-region');
    }
    $this
      ->checkContextualLinks($assert_session, $locked);
    $this
      ->checkRouteAccess($assert_session, $node, $code, $allow_section_after);
  }

  /**
   * Checks access to routes related to layout builder.
   *
   * @param \Drupal\Tests\WebAssert $assert_session
   * @param \Drupal\node\NodeInterface $node
   * @param int $code
   * @param null $section_after
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  protected function checkRouteAccess(WebAssert $assert_session, NodeInterface $node, $code = 200, $section_after = NULL) {
    $paths = [
      'layout_builder/configure/section/overrides/node.' . $node
        ->id() . '/0',
      'layout_builder/remove/section/overrides/node.' . $node
        ->id() . '/0',
      'layout_builder/choose/section/overrides/node.' . $node
        ->id() . '/0',
      'layout_builder/choose/section/overrides/node.' . $node
        ->id() . '/1',
      'layout_builder/choose/block/overrides/node.' . $node
        ->id() . '/0/content',
      'layout_builder/update/block/overrides/node.' . $node
        ->id() . '/0/content/' . $this->body_field_block_uuid,
      'layout_builder/move/block/overrides/node.' . $node
        ->id() . '/0/content/' . $this->body_field_block_uuid,
      'layout_builder/remove/block/overrides/node.' . $node
        ->id() . '/0/content/' . $this->body_field_block_uuid,
    ];
    foreach ($paths as $path) {
      $this
        ->drupalGet($path);
      if ($section_after && $path == 'layout_builder/choose/section/overrides/node.' . $node
        ->id() . '/1') {
        $assert_session
          ->statusCodeEquals(200);
      }
      else {
        $assert_session
          ->statusCodeEquals($code);
      }
    }
  }

  /**
   * Check contextual links.
   *
   * @param \Drupal\Tests\WebAssert $assert_session
   * @param bool $locked
   *
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   */
  protected function checkContextualLinks(WebAssert $assert_session, $locked = FALSE) {

    // Parse contextual links - target body field.
    $id = $assert_session
      ->elementExists('css', '.layout-builder__region > div:nth-child(3) > div');
    $value = $id
      ->getAttribute('data-contextual-id');
    $has_layout_builder_lock_element = FALSE;
    $layout_builder_lock_elements = $layout_builder_block_elements = [];
    $elements = explode('&', $value);
    foreach ($elements as $element) {

      // Layout Builder Lock element.
      if (strpos($element, 'layout_builder_lock') !== FALSE) {
        $has_layout_builder_lock_element = TRUE;
        $layout_builder_lock_elements = explode(':', str_replace([
          '%3A',
          'layout_builder_lock=',
        ], [
          ':',
          '',
        ], $element));
      }

      // Layout Builder Block elements.
      if (strpos($element, 'operations') !== FALSE) {
        $ex = explode(':', $element, 2);
        $layout_builder_block_elements = explode(':', str_replace([
          '%3A',
          'operations=',
        ], [
          ':',
          '',
        ], $ex[1]));
      }
    }
    if ($locked) {
      if ($has_layout_builder_lock_element) {
        self::assertTrue(in_array('layout_builder_block_move', $layout_builder_lock_elements));
        self::assertTrue(!in_array('move', $layout_builder_block_elements));
        self::assertTrue(in_array('layout_builder_block_update', $layout_builder_lock_elements));
        self::assertTrue(!in_array('update', $layout_builder_block_elements));
        self::assertTrue(in_array('layout_builder_block_remove', $layout_builder_lock_elements));
        self::assertTrue(!in_array('remove', $layout_builder_block_elements));
      }
      else {

        // Trigger an explicit fail.
        self::assertTrue($has_layout_builder_lock_element);
      }
    }
    else {
      self::assertTrue(empty($has_layout_builder_lock_element));
      self::assertTrue(in_array('move', $layout_builder_block_elements));
      self::assertTrue(in_array('update', $layout_builder_block_elements));
      self::assertTrue(in_array('remove', $layout_builder_block_elements));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
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
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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 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. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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 Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
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
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
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. 23
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.
LayoutBuilderLockTest::$adminUser protected property A user with all permissions.
LayoutBuilderLockTest::$adminUserNoBypass protected property A user with all permissions except bypass.
LayoutBuilderLockTest::$adminUserNoBypassPermissions protected property The editor permissions.
LayoutBuilderLockTest::$body_field_block_uuid protected property The body field uuid.
LayoutBuilderLockTest::$custom_default_block_uuid protected property The custom default block uuid.
LayoutBuilderLockTest::$custom_editor_block_uuid protected property The editor block uuid.
LayoutBuilderLockTest::$defaultTheme protected property The default theme to use. Overrides BrowserTestBase::$defaultTheme
LayoutBuilderLockTest::$editor protected property A user with default permissions.
LayoutBuilderLockTest::$editorOverride protected property A user which can override lock settings overrides.
LayoutBuilderLockTest::$editorOverridePermissions protected property The editor permissions.
LayoutBuilderLockTest::$editorPermissions protected property The default editor permissions.
LayoutBuilderLockTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
LayoutBuilderLockTest::checkContextualLinks protected function Check contextual links.
LayoutBuilderLockTest::checkLinksAndAccess protected function Checks links and access.
LayoutBuilderLockTest::checkRouteAccess protected function Checks access to routes related to layout builder.
LayoutBuilderLockTest::setUp protected function Overrides BrowserTestBase::setUp
LayoutBuilderLockTest::testLock public function Tests locking features on sections.
LayoutBuilderLockTest::testMultipleSections public function Tests with at least 3 sections.
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements 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. 2
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. 2
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::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a 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::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::drupalPostForm 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::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.