You are here

Home » API reference » Drupal 9 » InlineBlockTest.php

class InlineBlockTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/layout_builder/tests/src/FunctionalJavascript/InlineBlockTest.php \Drupal\Tests\layout_builder\FunctionalJavascript\InlineBlockTest

Tests that the inline block feature works correctly.

@group layout_builder

Hierarchy

Expanded class hierarchy of InlineBlockTest

File

core/modules/layout_builder/tests/src/FunctionalJavascript/InlineBlockTest.php, line 13

Namespace

Drupal\Tests\layout_builder\FunctionalJavascript
View source 
class InlineBlockTest extends InlineBlockTestBase {

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

  /**
   * Tests adding and editing of inline blocks.
   */
  public function testInlineBlocks() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access contextual links',
      'configure any layout',
      'administer node display',
      'administer node fields',
      'create and edit custom blocks',
    ]));

    // Enable layout builder.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[enabled]' => TRUE,
    ], 'Save');
    $this
      ->clickLink('Manage layout');
    $assert_session
      ->addressEquals(static::FIELD_UI_PREFIX . '/display/default/layout');

    // Add a basic block with the body field set.
    $this
      ->addInlineBlockToLayout('Block title', 'The DEFAULT block body');
    $this
      ->assertSaveLayout();
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $this
      ->drupalGet('node/2');
    $assert_session
      ->pageTextContains('The DEFAULT block body');

    // Enable overrides.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[allow_custom]' => TRUE,
    ], 'Save');
    $this
      ->drupalGet('node/1/layout');

    // Confirm the block can be edited.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->configureInlineBlock('The DEFAULT block body', 'The NEW block body!');
    $this
      ->assertSaveLayout();
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The NEW block body');
    $assert_session
      ->pageTextNotContains('The DEFAULT block body');
    $this
      ->drupalGet('node/2');

    // Node 2 should use default layout.
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $assert_session
      ->pageTextNotContains('The NEW block body');

    // Add a basic block with the body field set.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->addInlineBlockToLayout('2nd Block title', 'The 2nd block body');
    $this
      ->assertSaveLayout();
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The NEW block body!');
    $assert_session
      ->pageTextContains('The 2nd block body');
    $this
      ->drupalGet('node/2');

    // Node 2 should use default layout.
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $assert_session
      ->pageTextNotContains('The NEW block body');
    $assert_session
      ->pageTextNotContains('The 2nd block body');

    // Confirm the block can be edited.
    $this
      ->drupalGet('node/1/layout');

    /** @var \Behat\Mink\Element\NodeElement $inline_block_2 */
    $inline_block_2 = $page
      ->findAll('css', static::INLINE_BLOCK_LOCATOR)[1];
    $uuid = $inline_block_2
      ->getAttribute('data-layout-block-uuid');
    $block_css_locator = static::INLINE_BLOCK_LOCATOR . "[data-layout-block-uuid=\"{$uuid}\"]";
    $this
      ->configureInlineBlock('The 2nd block body', 'The 2nd NEW block body!', $block_css_locator);
    $this
      ->assertSaveLayout();
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The NEW block body!');
    $assert_session
      ->pageTextContains('The 2nd NEW block body!');
    $this
      ->drupalGet('node/2');

    // Node 2 should use default layout.
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $assert_session
      ->pageTextNotContains('The NEW block body!');
    $assert_session
      ->pageTextNotContains('The 2nd NEW block body!');

    // The default layout entity block should be changed.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
    $assert_session
      ->pageTextContains('The DEFAULT block body');

    // Confirm default layout still only has 1 entity block.
    $assert_session
      ->elementsCount('css', static::INLINE_BLOCK_LOCATOR, 1);
  }

  /**
   * Tests adding a new entity block and then not saving the layout.
   *
   * @dataProvider layoutNoSaveProvider
   */
  public function testNoLayoutSave($operation, $no_save_button_text, $confirm_button_text) {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access contextual links',
      'configure any layout',
      'administer node display',
      'create and edit custom blocks',
    ]));
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->assertEmpty($this->blockStorage
      ->loadMultiple(), 'No entity blocks exist');

    // Enable layout builder and overrides.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[enabled]' => TRUE,
      'layout[allow_custom]' => TRUE,
    ], 'Save');
    $this
      ->drupalGet('node/1/layout');
    $this
      ->addInlineBlockToLayout('Block title', 'The block body');
    $page
      ->pressButton($no_save_button_text);
    if ($confirm_button_text) {
      $page
        ->pressButton($confirm_button_text);
    }
    $this
      ->drupalGet('node/1');
    $this
      ->assertEmpty($this->blockStorage
      ->loadMultiple(), 'No entity blocks were created when layout changes are discarded.');
    $assert_session
      ->pageTextNotContains('The block body');
    $this
      ->drupalGet('node/1/layout');
    $this
      ->addInlineBlockToLayout('Block title', 'The block body');
    $this
      ->assertSaveLayout();
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The block body');
    $blocks = $this->blockStorage
      ->loadMultiple();
    $this
      ->assertCount(1, $blocks);

    /** @var \Drupal\Core\Entity\ContentEntityBase $block */
    $block = array_pop($blocks);
    $revision_id = $block
      ->getRevisionId();

    // Confirm the block can be edited.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->configureInlineBlock('The block body', 'The block updated body');
    $page
      ->pressButton($no_save_button_text);
    if ($confirm_button_text) {
      $page
        ->pressButton($confirm_button_text);
    }
    $this
      ->drupalGet('node/1');
    $blocks = $this->blockStorage
      ->loadMultiple();

    // When reverting or discarding the update block should not be on the page.
    $assert_session
      ->pageTextNotContains('The block updated body');
    if ($operation === 'discard_changes') {

      // When discarding the original block body should appear.
      $assert_session
        ->pageTextContains('The block body');
      $this
        ->assertCount(1, $blocks);
      $block = array_pop($blocks);
      $this
        ->assertEquals($block
        ->getRevisionId(), $revision_id);
      $this
        ->assertEquals('The block body', $block
        ->get('body')
        ->getValue()[0]['value']);
    }
    else {

      // The block should not be visible.
      // Blocks are currently only deleted when the parent entity is deleted.
      $assert_session
        ->pageTextNotContains('The block body');
    }
  }

  /**
   * Provides test data for ::testNoLayoutSave().
   */
  public function layoutNoSaveProvider() {
    return [
      'discard_changes' => [
        'discard_changes',
        'Discard changes',
        'Confirm',
      ],
      'revert' => [
        'revert',
        'Revert to defaults',
        'Revert',
      ],
    ];
  }

  /**
   * Tests entity blocks revisioning.
   */
  public function testInlineBlocksRevisioning() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access contextual links',
      'configure any layout',
      'administer node display',
      'administer node fields',
      'administer nodes',
      'bypass node access',
      'create and edit custom blocks',
    ]));

    // Enable layout builder and overrides.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[enabled]' => TRUE,
      'layout[allow_custom]' => TRUE,
    ], 'Save');
    $this
      ->drupalGet('node/1/layout');

    // Add an inline block.
    $this
      ->addInlineBlockToLayout('Block title', 'The DEFAULT block body');
    $this
      ->assertSaveLayout();
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The DEFAULT block body');

    /** @var \Drupal\node\NodeStorageInterface $node_storage */
    $node_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('node');
    $original_revision_id = $node_storage
      ->getLatestRevisionId(1);

    // Create a new revision.
    $this
      ->drupalGet('node/1/edit');
    $page
      ->findField('title[0][value]')
      ->setValue('Node updated');
    $page
      ->pressButton('Save');
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $assert_session
      ->linkExists('Revisions');

    // Update the block.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->configureInlineBlock('The DEFAULT block body', 'The NEW block body');
    $this
      ->assertSaveLayout();
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The NEW block body');
    $assert_session
      ->pageTextNotContains('The DEFAULT block body');
    $revision_url = "node/1/revisions/{$original_revision_id}";

    // Ensure viewing the previous revision shows the previous block revision.
    $this
      ->drupalGet("{$revision_url}/view");
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $assert_session
      ->pageTextNotContains('The NEW block body');

    // Revert to first revision.
    $revision_url = "{$revision_url}/revert";
    $this
      ->drupalGet($revision_url);
    $page
      ->pressButton('Revert');
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $assert_session
      ->pageTextNotContains('The NEW block body');
  }

  /**
   * Tests entity blocks revisioning.
   */
  public function testInlineBlocksRevisioningIntegrity() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access contextual links',
      'configure any layout',
      'administer node display',
      'view all revisions',
      'access content',
      'create and edit custom blocks',
    ]));
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[enabled]' => TRUE,
      'layout[allow_custom]' => TRUE,
    ], 'Save');
    $block_1_locator = static::INLINE_BLOCK_LOCATOR;
    $block_2_locator = sprintf('%s + %s', static::INLINE_BLOCK_LOCATOR, static::INLINE_BLOCK_LOCATOR);

    // Add two blocks to the page and assert the content in each.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->addInlineBlockToLayout('Block 1', 'Block 1 original');
    $this
      ->addInlineBlockToLayout('Block 2', 'Block 2 original');
    $this
      ->assertSaveLayout();
    $this
      ->assertNodeRevisionContent(3, [
      'Block 1 original',
      'Block 2 original',
    ]);
    $this
      ->assertBlockRevisionCountByTitle('Block 1', 1);
    $this
      ->assertBlockRevisionCountByTitle('Block 2', 1);

    // Update the contents of one of the blocks and assert the updated content
    // appears on the next revision.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->configureInlineBlock('Block 2 original', 'Block 2 updated', $block_2_locator);
    $this
      ->assertSaveLayout();
    $this
      ->assertNodeRevisionContent(4, [
      'Block 1 original',
      'Block 2 updated',
    ]);
    $this
      ->assertBlockRevisionCountByTitle('Block 1', 1);
    $this
      ->assertBlockRevisionCountByTitle('Block 2', 2);

    // Update block 1 without creating a new revision of the parent.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->configureInlineBlock('Block 1 original', 'Block 1 updated', $block_1_locator);
    $this
      ->getSession()
      ->getPage()
      ->uncheckField('revision');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Save layout');
    $this
      ->assertNotEmpty($this
      ->assertSession()
      ->waitForElement('css', '.messages--status'));
    $this
      ->assertNodeRevisionContent(4, [
      'Block 1 updated',
      'Block 2 updated',
    ]);
    $this
      ->assertBlockRevisionCountByTitle('Block 1', 2);
    $this
      ->assertBlockRevisionCountByTitle('Block 2', 2);

    // Reassert all of the parent revisions contain the correct block content
    // and the integrity of the revisions was preserved.
    $this
      ->assertNodeRevisionContent(3, [
      'Block 1 original',
      'Block 2 original',
    ]);
  }

  /**
   * Assert the contents of a node revision.
   *
   * @param int $revision_id
   *   The revision ID to assert.
   * @param array $content
   *   The content items to assert on the page.
   */
  protected function assertNodeRevisionContent($revision_id, array $content) {
    $this
      ->drupalGet("node/1/revisions/{$revision_id}/view");
    foreach ($content as $content_item) {
      $this
        ->assertSession()
        ->pageTextContains($content_item);
    }
  }

  /**
   * Assert the number of block content revisions by the block title.
   *
   * @param string $block_title
   *   The block title.
   * @param int $expected_revision_count
   *   The revision count.
   */
  protected function assertBlockRevisionCountByTitle($block_title, $expected_revision_count) {
    $actual_revision_count = $this->blockStorage
      ->getQuery()
      ->accessCheck(FALSE)
      ->condition('info', $block_title)
      ->allRevisions()
      ->count()
      ->execute();
    $this
      ->assertEquals($actual_revision_count, $expected_revision_count);
  }

  /**
   * Tests that entity blocks deleted correctly.
   */
  public function testDeletion() {

    /** @var \Drupal\Core\Cron $cron */
    $cron = \Drupal::service('cron');

    /** @var \Drupal\layout_builder\InlineBlockUsageInterface $usage */
    $usage = \Drupal::service('inline_block.usage');
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer content types',
      'access contextual links',
      'configure any layout',
      'administer node display',
      'administer node fields',
      'administer nodes',
      'bypass node access',
      'create and edit custom blocks',
    ]));
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Enable layout builder.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[enabled]' => TRUE,
    ], 'Save');

    // Add a block to default layout.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->clickLink('Manage layout');
    $assert_session
      ->addressEquals(static::FIELD_UI_PREFIX . '/display/default/layout');
    $this
      ->addInlineBlockToLayout('Block title', 'The DEFAULT block body');
    $this
      ->assertSaveLayout();
    $this
      ->assertCount(1, $this->blockStorage
      ->loadMultiple());
    $default_block_id = $this
      ->getLatestBlockEntityId();

    // Ensure the block shows up on node pages.
    $this
      ->drupalGet('node/1');
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $this
      ->drupalGet('node/2');
    $assert_session
      ->pageTextContains('The DEFAULT block body');

    // Enable overrides.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[allow_custom]' => TRUE,
    ], 'Save');

    // Ensure we have 2 copies of the block in node overrides.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->assertSaveLayout();
    $node_1_block_id = $this
      ->getLatestBlockEntityId();
    $this
      ->drupalGet('node/2/layout');
    $this
      ->assertSaveLayout();
    $node_2_block_id = $this
      ->getLatestBlockEntityId();
    $this
      ->assertCount(3, $this->blockStorage
      ->loadMultiple());
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->clickLink('Manage layout');
    $assert_session
      ->addressEquals(static::FIELD_UI_PREFIX . '/display/default/layout');
    $this
      ->assertNotEmpty($this->blockStorage
      ->load($default_block_id));
    $this
      ->assertNotEmpty($usage
      ->getUsage($default_block_id));

    // Remove block from default.
    $this
      ->removeInlineBlockFromLayout();
    $this
      ->assertSaveLayout();

    // Ensure the block in the default was deleted.
    $this->blockStorage
      ->resetCache([
      $default_block_id,
    ]);
    $this
      ->assertEmpty($this->blockStorage
      ->load($default_block_id));

    // Ensure other blocks still exist.
    $this
      ->assertCount(2, $this->blockStorage
      ->loadMultiple());
    $this
      ->assertEmpty($usage
      ->getUsage($default_block_id));
    $this
      ->drupalGet('node/1/layout');
    $assert_session
      ->pageTextContains('The DEFAULT block body');
    $this
      ->removeInlineBlockFromLayout();
    $this
      ->assertSaveLayout();
    $cron
      ->run();

    // Ensure entity block is not deleted because it is needed in revision.
    $this
      ->assertNotEmpty($this->blockStorage
      ->load($node_1_block_id));
    $this
      ->assertCount(2, $this->blockStorage
      ->loadMultiple());
    $this
      ->assertNotEmpty($usage
      ->getUsage($node_1_block_id));

    // Ensure entity block is deleted when node is deleted.
    $this
      ->drupalGet('node/1/delete');
    $page
      ->pressButton('Delete');
    $this
      ->assertEmpty(Node::load(1));
    $cron
      ->run();
    $this
      ->assertEmpty($this->blockStorage
      ->load($node_1_block_id));
    $this
      ->assertEmpty($usage
      ->getUsage($node_1_block_id));
    $this
      ->assertCount(1, $this->blockStorage
      ->loadMultiple());

    // Add another block to the default.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->clickLink('Manage layout');
    $assert_session
      ->addressEquals(static::FIELD_UI_PREFIX . '/display/default/layout');
    $this
      ->addInlineBlockToLayout('Title 2', 'Body 2');
    $this
      ->assertSaveLayout();
    $cron
      ->run();
    $default_block2_id = $this
      ->getLatestBlockEntityId();
    $this
      ->assertCount(2, $this->blockStorage
      ->loadMultiple());

    // Delete the other node so bundle can be deleted.
    $this
      ->assertNotEmpty($usage
      ->getUsage($node_2_block_id));
    $this
      ->drupalGet('node/2/delete');
    $page
      ->pressButton('Delete');
    $this
      ->assertEmpty(Node::load(2));
    $cron
      ->run();

    // Ensure entity block was deleted.
    $this
      ->assertEmpty($this->blockStorage
      ->load($node_2_block_id));
    $this
      ->assertEmpty($usage
      ->getUsage($node_2_block_id));
    $this
      ->assertCount(1, $this->blockStorage
      ->loadMultiple());

    // Delete the bundle which has the default layout.
    $this
      ->assertNotEmpty($usage
      ->getUsage($default_block2_id));
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/delete');
    $page
      ->pressButton('Delete');
    $cron
      ->run();

    // Ensure the entity block in default is deleted when bundle is deleted.
    $this
      ->assertEmpty($this->blockStorage
      ->load($default_block2_id));
    $this
      ->assertEmpty($usage
      ->getUsage($default_block2_id));
    $this
      ->assertCount(0, $this->blockStorage
      ->loadMultiple());
  }

  /**
   * Tests access to the block edit form of inline blocks.
   *
   * This module does not provide links to these forms but in case the paths are
   * accessed directly they should accessible by users with the
   * 'configure any layout' permission.
   *
   * @see layout_builder_block_content_access()
   */
  public function testAccess() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access contextual links',
      'configure any layout',
      'administer node display',
      'administer node fields',
      'create and edit custom blocks',
    ]));
    $assert_session = $this
      ->assertSession();

    // Enable layout builder and overrides.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[enabled]' => TRUE,
      'layout[allow_custom]' => TRUE,
    ], 'Save');

    // Ensure we have 2 copies of the block in node overrides.
    $this
      ->drupalGet('node/1/layout');
    $this
      ->addInlineBlockToLayout('Block title', 'Block body');
    $this
      ->assertSaveLayout();
    $node_1_block_id = $this
      ->getLatestBlockEntityId();
    $this
      ->drupalGet("block/{$node_1_block_id}");
    $assert_session
      ->pageTextNotContains('You are not authorized to access this page');
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer nodes',
    ]));
    $this
      ->drupalGet("block/{$node_1_block_id}");
    $assert_session
      ->pageTextContains('You are not authorized to access this page');
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'create and edit custom blocks',
    ]));
    $this
      ->drupalGet("block/{$node_1_block_id}");
    $assert_session
      ->pageTextNotContains('You are not authorized to access this page');
  }

  /**
   * Tests the workflow for adding an inline block depending on number of types.
   *
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testAddWorkFlow() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $type_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('block_content_type');
    foreach ($type_storage
      ->loadByProperties() as $type) {
      $type
        ->delete();
    }
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access contextual links',
      'configure any layout',
      'administer node display',
      'administer node fields',
      'create and edit custom blocks',
    ]));

    // Enable layout builder and overrides.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
    $this
      ->submitForm([
      'layout[enabled]' => TRUE,
      'layout[allow_custom]' => TRUE,
    ], 'Save');
    $layout_default_path = 'admin/structure/types/manage/bundle_with_section_field/display/default/layout';
    $this
      ->drupalGet($layout_default_path);

    // Add a basic block with the body field set.
    $page
      ->clickLink('Add block');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Confirm that with no block content types the link does not appear.
    $assert_session
      ->linkNotExists('Create custom block');
    $this
      ->createBlockContentType('basic', 'Basic block');
    $this
      ->drupalGet($layout_default_path);

    // Add a basic block with the body field set.
    $page
      ->clickLink('Add block');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Confirm with only 1 type the "Create custom block" link goes directly t
    // block add form.
    $assert_session
      ->linkNotExists('Basic block');
    $this
      ->clickLink('Create custom block');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->fieldExists('Title');
    $this
      ->createBlockContentType('advanced', 'Advanced block');
    $this
      ->drupalGet($layout_default_path);

    // Add a basic block with the body field set.
    $page
      ->clickLink('Add block');

    // Confirm that, when more than 1 type exists, "Create custom block" shows a
    // list of block types.
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->linkNotExists('Basic block');
    $assert_session
      ->linkNotExists('Advanced block');
    $this
      ->clickLink('Create custom block');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->fieldNotExists('Title');
    $assert_session
      ->linkExists('Basic block');
    $assert_session
      ->linkExists('Advanced block');
    $this
      ->clickLink('Advanced block');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->fieldExists('Title');
  }

  /**
   * Tests the 'create and edit custom blocks' permission to add a new block.
   */
  public function testAddInlineBlocksPermission() {
    LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default')
      ->enableLayoutBuilder()
      ->setOverridable()
      ->save();
    $assert = function ($permissions, $expected) {
      $assert_session = $this
        ->assertSession();
      $page = $this
        ->getSession()
        ->getPage();
      $this
        ->drupalLogin($this
        ->drupalCreateUser($permissions));
      $this
        ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
      $page
        ->clickLink('Add block');
      $this
        ->assertNotEmpty($assert_session
        ->waitForElementVisible('css', '#drupal-off-canvas .block-categories'));
      if ($expected) {
        $assert_session
          ->linkExists('Create custom block');
      }
      else {
        $assert_session
          ->linkNotExists('Create custom block');
      }
    };
    $permissions = [
      'configure any layout',
      'administer node display',
    ];
    $assert($permissions, FALSE);
    $permissions[] = 'create and edit custom blocks';
    $assert($permissions, TRUE);
  }

  /**
   * Tests 'create and edit custom blocks' permission to edit an existing block.
   */
  public function testEditInlineBlocksPermission() {
    LayoutBuilderEntityViewDisplay::load('node.bundle_with_section_field.default')
      ->enableLayoutBuilder()
      ->setOverridable()
      ->save();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access contextual links',
      'configure any layout',
      'administer node display',
      'create and edit custom blocks',
    ]));
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
    $this
      ->addInlineBlockToLayout('The block label', 'The body value');
    $assert = function ($permissions, $expected) {
      $assert_session = $this
        ->assertSession();
      $this
        ->drupalLogin($this
        ->drupalCreateUser($permissions));
      $this
        ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
      $this
        ->clickContextualLink(static::INLINE_BLOCK_LOCATOR, 'Configure');
      $assert_session
        ->assertWaitOnAjaxRequest();
      if ($expected) {
        $assert_session
          ->fieldExists('settings[block_form][body][0][value]');
      }
      else {
        $assert_session
          ->fieldNotExists('settings[block_form][body][0][value]');
      }
    };
    $permissions = [
      'access contextual links',
      'configure any layout',
      'administer node display',
    ];
    $assert($permissions, FALSE);
    $permissions[] = 'create and edit custom blocks';
    $assert($permissions, TRUE);
  }

}

Members

Namesort descending 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::clickContextualLink protected function Clicks a contextual link. 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
InlineBlockTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
InlineBlockTest::assertBlockRevisionCountByTitle protected function Assert the number of block content revisions by the block title.
InlineBlockTest::assertNodeRevisionContent protected function Assert the contents of a node revision.
InlineBlockTest::layoutNoSaveProvider public function Provides test data for ::testNoLayoutSave().
InlineBlockTest::testAccess public function Tests access to the block edit form of inline blocks.
InlineBlockTest::testAddInlineBlocksPermission public function Tests the 'create and edit custom blocks' permission to add a new block.
InlineBlockTest::testAddWorkFlow public function Tests the workflow for adding an inline block depending on number of types.
InlineBlockTest::testDeletion public function Tests that entity blocks deleted correctly.
InlineBlockTest::testEditInlineBlocksPermission public function Tests 'create and edit custom blocks' permission to edit an existing block.
InlineBlockTest::testInlineBlocks public function Tests adding and editing of inline blocks.
InlineBlockTest::testInlineBlocksRevisioning public function Tests entity blocks revisioning.
InlineBlockTest::testInlineBlocksRevisioningIntegrity public function Tests entity blocks revisioning.
InlineBlockTest::testNoLayoutSave public function Tests adding a new entity block and then not saving the layout.
InlineBlockTestBase::$blockStorage protected property The block storage.
InlineBlockTestBase::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules 1
InlineBlockTestBase::addInlineBlockToLayout protected function Adds an entity block to the layout.
InlineBlockTestBase::assertDialogClosedAndTextVisible protected function Asserts that the dialog closes and the new text appears on the main canvas.
InlineBlockTestBase::assertSaveLayout protected function Saves a layout and asserts the message is correct.
InlineBlockTestBase::configureInlineBlock protected function Configures an inline block in the Layout Builder.
InlineBlockTestBase::createBlockContentType protected function Creates a block content type.
InlineBlockTestBase::FIELD_UI_PREFIX constant Path prefix for the field UI for the test bundle.
InlineBlockTestBase::getLatestBlockEntityId protected function Gets the latest block entity id.
InlineBlockTestBase::INLINE_BLOCK_LOCATOR constant Locator for inline blocks.
InlineBlockTestBase::removeInlineBlockFromLayout protected function Removes an entity block from the layout but does not save the layout.
InlineBlockTestBase::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
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.
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.