class BlockTest in Drupal 9

Same name in this branch

9 core/modules/jsonapi/tests/src/Functional/BlockTest.php \Drupal\Tests\jsonapi\Functional\BlockTest
9 core/modules/block/tests/src/Functional/BlockTest.php \Drupal\Tests\block\Functional\BlockTest
9 core/modules/views/tests/src/Unit/Plugin/views/display/BlockTest.php \Drupal\Tests\views\Unit\Plugin\views\display\BlockTest
9 core/modules/block/tests/src/Kernel/Plugin/migrate/source/BlockTest.php \Drupal\Tests\block\Kernel\Plugin\migrate\source\BlockTest

Same name and namespace in other branches

8 core/modules/block/tests/src/Functional/BlockTest.php \Drupal\Tests\block\Functional\BlockTest

Tests basic block functionality.

@group block

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\block\Functional\BlockTestBase
  - class \Drupal\Tests\block\Functional\BlockTest

Expanded class hierarchy of BlockTest

File

core/modules/block/tests/src/Functional/BlockTest.php, line 16

Namespace

Drupal\Tests\block\Functional

View source

class BlockTest extends BlockTestBase {

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

  /**
   * Tests block visibility.
   */
  public function testBlockVisibility() {
    $block_name = 'system_powered_by_block';

    // Create a random title for the block.
    $title = $this
      ->randomMachineName(8);

    // Enable a standard block.
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $edit = [
      'id' => strtolower($this
        ->randomMachineName(8)),
      'region' => 'sidebar_first',
      'settings[label]' => $title,
      'settings[label_display]' => TRUE,
    ];

    // Set the block to be hidden on any user path, and to be shown only to
    // authenticated users.
    $edit['visibility[request_path][pages]'] = '/user*';
    $edit['visibility[request_path][negate]'] = TRUE;
    $edit['visibility[user_role][roles][' . RoleInterface::AUTHENTICATED_ID . ']'] = TRUE;
    $this
      ->drupalGet('admin/structure/block/add/' . $block_name . '/' . $default_theme);
    $this
      ->assertSession()
      ->checkboxChecked('edit-visibility-request-path-negate-0');
    $this
      ->submitForm($edit, 'Save block');
    $this
      ->assertSession()
      ->pageTextContains('The block configuration has been saved.');
    $this
      ->clickLink('Configure');
    $this
      ->assertSession()
      ->checkboxChecked('edit-visibility-request-path-negate-1');

    // Confirm that the block is displayed on the front page.
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->pageTextContains($title);

    // Confirm that the block is not displayed according to block visibility
    // rules.
    $this
      ->drupalGet('user');
    $this
      ->assertSession()
      ->pageTextNotContains($title);

    // Confirm that the block is not displayed to anonymous users.
    $this
      ->drupalLogout();
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->pageTextNotContains($title);

    // Confirm that an empty block is not displayed.
    $this
      ->assertSession()
      ->pageTextNotContains('Powered by Drupal');
    $this
      ->assertSession()
      ->responseNotContains('sidebar-first');
  }

  /**
   * Tests that visibility can be properly toggled.
   */
  public function testBlockToggleVisibility() {
    $block_name = 'system_powered_by_block';

    // Create a random title for the block.
    $title = $this
      ->randomMachineName(8);

    // Enable a standard block.
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $edit = [
      'id' => strtolower($this
        ->randomMachineName(8)),
      'region' => 'sidebar_first',
      'settings[label]' => $title,
    ];
    $block_id = $edit['id'];

    // Set the block to be shown only to authenticated users.
    $edit['visibility[user_role][roles][' . RoleInterface::AUTHENTICATED_ID . ']'] = TRUE;
    $this
      ->drupalGet('admin/structure/block/add/' . $block_name . '/' . $default_theme);
    $this
      ->submitForm($edit, 'Save block');
    $this
      ->clickLink('Configure');
    $this
      ->assertSession()
      ->checkboxChecked('edit-visibility-user-role-roles-authenticated');
    $edit = [
      'visibility[user_role][roles][' . RoleInterface::AUTHENTICATED_ID . ']' => FALSE,
    ];
    $this
      ->submitForm($edit, 'Save block');
    $this
      ->clickLink('Configure');
    $this
      ->assertSession()
      ->checkboxNotChecked('edit-visibility-user-role-roles-authenticated');

    // Ensure that no visibility is configured.

    /** @var \Drupal\block\BlockInterface $block */
    $block = Block::load($block_id);
    $visibility_config = $block
      ->getVisibilityConditions()
      ->getConfiguration();
    $this
      ->assertSame([], $visibility_config);
    $this
      ->assertSame([], $block
      ->get('visibility'));
  }

  /**
   * Tests block visibility when leaving "pages" textarea empty.
   */
  public function testBlockVisibilityListedEmpty() {
    $block_name = 'system_powered_by_block';

    // Create a random title for the block.
    $title = $this
      ->randomMachineName(8);

    // Enable a standard block.
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $edit = [
      'id' => strtolower($this
        ->randomMachineName(8)),
      'region' => 'sidebar_first',
      'settings[label]' => $title,
      'visibility[request_path][negate]' => TRUE,
    ];

    // Set the block to be hidden on any user path, and to be shown only to
    // authenticated users.
    $this
      ->drupalGet('admin/structure/block/add/' . $block_name . '/' . $default_theme);
    $this
      ->submitForm($edit, 'Save block');
    $this
      ->assertSession()
      ->pageTextContains('The block configuration has been saved.');

    // Confirm that block was not displayed according to block visibility
    // rules.
    $this
      ->drupalGet('user');
    $this
      ->assertSession()
      ->pageTextNotContains($title);

    // Confirm that block was not displayed according to block visibility
    // rules regardless of path case.
    $this
      ->drupalGet('USER');
    $this
      ->assertSession()
      ->pageTextNotContains($title);

    // Confirm that the block is not displayed to anonymous users.
    $this
      ->drupalLogout();
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->pageTextNotContains($title);
  }

  /**
   * Tests adding a block from the library page with a weight query string.
   */
  public function testAddBlockFromLibraryWithWeight() {
    $default_theme = $this
      ->config('system.theme')
      ->get('default');

    // Test one positive, zero, and one negative weight.
    foreach ([
      '7',
      '0',
      '-9',
    ] as $weight) {
      $options = [
        'query' => [
          'region' => 'sidebar_first',
          'weight' => $weight,
        ],
      ];
      $this
        ->drupalGet(Url::fromRoute('block.admin_library', [
        'theme' => $default_theme,
      ], $options));
      $block_name = 'system_powered_by_block';
      $add_url = Url::fromRoute('block.admin_add', [
        'plugin_id' => $block_name,
        'theme' => $default_theme,
      ]);

      // Verify that one link is found, with the the expected link text.
      $xpath = $this
        ->assertSession()
        ->buildXPathQuery('//a[contains(@href, :href)]', [
        ':href' => $add_url
          ->toString(),
      ]);
      $this
        ->assertSession()
        ->elementsCount('xpath', $xpath, 1);
      $this
        ->assertSession()
        ->elementTextEquals('xpath', $xpath, 'Place block');
      $link = $this
        ->getSession()
        ->getPage()
        ->find('xpath', $xpath);
      list($path, $query_string) = explode('?', $link
        ->getAttribute('href'), 2);
      parse_str($query_string, $query_parts);
      $this
        ->assertEquals($weight, $query_parts['weight'], 'Found the expected weight query string.');

      // Create a random title for the block.
      $title = $this
        ->randomMachineName(8);
      $block_id = strtolower($this
        ->randomMachineName(8));
      $edit = [
        'id' => $block_id,
        'settings[label]' => $title,
      ];

      // Create the block using the link parsed from the library page.
      $this
        ->drupalGet($this
        ->getAbsoluteUrl($link
        ->getAttribute('href')));
      $this
        ->submitForm($edit, 'Save block');

      // Ensure that the block was created with the expected weight.

      /** @var \Drupal\block\BlockInterface $block */
      $block = Block::load($block_id);
      $this
        ->assertEquals($weight, $block
        ->getWeight(), 'Found the block with expected weight.');
    }
  }

  /**
   * Tests configuring and moving a module-define block to specific regions.
   */
  public function testBlock() {

    // Place page title block to test error messages.
    $this
      ->drupalPlaceBlock('page_title_block');

    // Disable the block.
    $this
      ->drupalGet('admin/structure/block');
    $this
      ->clickLink('Disable');

    // Select the 'Powered by Drupal' block to be configured and moved.
    $block = [];
    $block['id'] = 'system_powered_by_block';
    $block['settings[label]'] = $this
      ->randomMachineName(8);
    $block['settings[label_display]'] = TRUE;
    $block['theme'] = $this
      ->config('system.theme')
      ->get('default');
    $block['region'] = 'header';

    // Set block title to confirm that interface works and override any custom titles.
    $this
      ->drupalGet('admin/structure/block/add/' . $block['id'] . '/' . $block['theme']);
    $this
      ->submitForm([
      'settings[label]' => $block['settings[label]'],
      'settings[label_display]' => $block['settings[label_display]'],
      'id' => $block['id'],
      'region' => $block['region'],
    ], 'Save block');
    $this
      ->assertSession()
      ->pageTextContains('The block configuration has been saved.');

    // Check to see if the block was created by checking its configuration.
    $instance = Block::load($block['id']);
    $this
      ->assertEquals($block['settings[label]'], $instance
      ->label(), 'Stored block title found.');

    // Check whether the block can be moved to all available regions.
    foreach ($this->regions as $region) {
      $this
        ->moveBlockToRegion($block, $region);
    }

    // Disable the block.
    $this
      ->drupalGet('admin/structure/block');
    $this
      ->clickLink('Disable');

    // Confirm that the block is now listed as disabled.
    $this
      ->assertSession()
      ->pageTextContains('The block settings have been updated.');

    // Confirm that the block instance title and markup are not displayed.
    $this
      ->drupalGet('node');
    $this
      ->assertSession()
      ->pageTextNotContains($block['settings[label]']);

    // Check for <div id="block-my-block-instance-name"> if the machine name
    // is my_block_instance_name.
    $xpath = $this
      ->assertSession()
      ->buildXPathQuery('//div[@id=:id]/*', [
      ':id' => 'block-' . str_replace('_', '-', strtolower($block['id'])),
    ]);
    $this
      ->assertSession()
      ->elementNotExists('xpath', $xpath);

    // Test deleting the block from the edit form.
    $this
      ->drupalGet('admin/structure/block/manage/' . $block['id']);
    $this
      ->clickLink('Remove block');
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to remove the block ' . $block['settings[label]'] . ' from the Footer region?');
    $this
      ->submitForm([], 'Remove');
    $this
      ->assertSession()
      ->pageTextContains('The block ' . $block['settings[label]'] . ' has been removed from the Footer region.');

    // Test deleting a block via "Configure block" link.
    $block = $this
      ->drupalPlaceBlock('system_powered_by_block');
    $this
      ->drupalGet('admin/structure/block/manage/' . $block
      ->id(), [
      'query' => [
        'destination' => 'admin',
      ],
    ]);
    $this
      ->clickLink('Remove block');
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to remove the block ' . $block
      ->label() . ' from the Left sidebar region?');
    $this
      ->submitForm([], 'Remove');
    $this
      ->assertSession()
      ->pageTextContains('The block ' . $block
      ->label() . ' has been removed from the Left sidebar region.');
    $this
      ->assertSession()
      ->addressEquals('admin');
    $this
      ->assertSession()
      ->responseNotContains($block
      ->id());
  }

  /**
   * Tests that the block form has a theme selector when not passed via the URL.
   */
  public function testBlockThemeSelector() {

    // Install all themes.
    \Drupal::service('theme_installer')
      ->install([
      'bartik',
      'seven',
      'stark',
    ]);
    $theme_settings = $this
      ->config('system.theme');
    foreach ([
      'bartik',
      'seven',
      'stark',
    ] as $theme) {
      $this
        ->drupalGet('admin/structure/block/list/' . $theme);
      $this
        ->assertSession()
        ->titleEquals('Block layout | Drupal');

      // Select the 'Powered by Drupal' block to be placed.
      $block = [];
      $block['id'] = strtolower($this
        ->randomMachineName());
      $block['theme'] = $theme;
      $block['region'] = 'content';
      $this
        ->drupalGet('admin/structure/block/add/system_powered_by_block');
      $this
        ->submitForm($block, 'Save block');
      $this
        ->assertSession()
        ->pageTextContains('The block configuration has been saved.');
      $this
        ->assertSession()
        ->addressEquals('admin/structure/block/list/' . $theme . '?block-placement=' . Html::getClass($block['id']));

      // Set the default theme and ensure the block is placed.
      $theme_settings
        ->set('default', $theme)
        ->save();
      $this
        ->drupalGet('');
      $block_id = Html::getUniqueId('block-' . $block['id']);
      $this
        ->assertSession()
        ->elementExists('xpath', "//div[@id = '{$block_id}']");
    }
  }

  /**
   * Tests block display of theme titles.
   */
  public function testThemeName() {

    // Enable the help block.
    $this
      ->drupalPlaceBlock('help_block', [
      'region' => 'help',
    ]);
    $this
      ->drupalPlaceBlock('local_tasks_block');

    // Explicitly set the default and admin themes.
    $theme = 'block_test_specialchars_theme';
    \Drupal::service('theme_installer')
      ->install([
      $theme,
    ]);
    $this
      ->drupalGet('admin/structure/block');
    $this
      ->assertSession()
      ->assertEscaped('<"Cat" & \'Mouse\'>');
    $this
      ->drupalGet('admin/structure/block/list/block_test_specialchars_theme');
    $this
      ->assertSession()
      ->assertEscaped('Demonstrate block regions (<"Cat" & \'Mouse\'>)');
  }

  /**
   * Tests block title display settings.
   */
  public function testHideBlockTitle() {
    $block_name = 'system_powered_by_block';

    // Create a random title for the block.
    $title = $this
      ->randomMachineName(8);
    $id = strtolower($this
      ->randomMachineName(8));

    // Enable a standard block.
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $edit = [
      'id' => $id,
      'region' => 'sidebar_first',
      'settings[label]' => $title,
    ];
    $this
      ->drupalGet('admin/structure/block/add/' . $block_name . '/' . $default_theme);
    $this
      ->submitForm($edit, 'Save block');
    $this
      ->assertSession()
      ->pageTextContains('The block configuration has been saved.');

    // Confirm that the block is not displayed by default.
    $this
      ->drupalGet('user');
    $this
      ->assertSession()
      ->pageTextNotContains($title);
    $edit = [
      'settings[label_display]' => TRUE,
    ];
    $this
      ->drupalGet('admin/structure/block/manage/' . $id);
    $this
      ->submitForm($edit, 'Save block');
    $this
      ->assertSession()
      ->pageTextContains('The block configuration has been saved.');
    $this
      ->drupalGet('admin/structure/block/manage/' . $id);
    $this
      ->assertSession()
      ->checkboxChecked('edit-settings-label-display');

    // Confirm that the block is displayed when enabled.
    $this
      ->drupalGet('user');
    $this
      ->assertSession()
      ->pageTextContains($title);
  }

  /**
   * Moves a block to a given region via the UI and confirms the result.
   *
   * @param array $block
   *   An array of information about the block, including the following keys:
   *   - module: The module providing the block.
   *   - title: The title of the block.
   *   - delta: The block's delta key.
   * @param string $region
   *   The machine name of the theme region to move the block to, for example
   *   'header' or 'sidebar_first'.
   */
  public function moveBlockToRegion(array $block, $region) {

    // Set the created block to a specific region.
    $block += [
      'theme' => $this
        ->config('system.theme')
        ->get('default'),
    ];
    $edit = [];
    $edit['blocks[' . $block['id'] . '][region]'] = $region;
    $this
      ->drupalGet('admin/structure/block');
    $this
      ->submitForm($edit, 'Save blocks');

    // Confirm that the block was moved to the proper region.
    $this
      ->assertSession()
      ->pageTextContains('The block settings have been updated.');

    // Confirm that the block is being displayed.
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->pageTextContains($block['settings[label]']);

    // Confirm that the custom block was found at the proper region.
    $xpath = $this
      ->assertSession()
      ->buildXPathQuery('//div[@class=:region-class]//div[@id=:block-id]/*', [
      ':region-class' => 'region region-' . Html::getClass($region),
      ':block-id' => 'block-' . str_replace('_', '-', strtolower($block['id'])),
    ]);
    $this
      ->assertSession()
      ->elementExists('xpath', $xpath);
  }

  /**
   * Tests that cache tags are properly set and bubbled up to the page cache.
   *
   * Verify that invalidation of these cache tags works:
   * - "block:<block ID>"
   * - "block_plugin:<block plugin ID>"
   */
  public function testBlockCacheTags() {

    // The page cache only works for anonymous users.
    $this
      ->drupalLogout();

    // Enable page caching.
    $config = $this
      ->config('system.performance');
    $config
      ->set('cache.page.max_age', 300);
    $config
      ->save();

    // Place the "Powered by Drupal" block.
    $block = $this
      ->drupalPlaceBlock('system_powered_by_block', [
      'id' => 'powered',
    ]);

    // Prime the page cache.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags in
    // both the page and block caches.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $cid_parts = [
      Url::fromRoute('<front>', [], [
        'absolute' => TRUE,
      ])
        ->toString(),
      '',
    ];
    $cid = implode(':', $cid_parts);
    $cache_entry = \Drupal::cache('page')
      ->get($cid);
    $expected_cache_tags = [
      'config:block_list',
      'block_view',
      'config:block.block.powered',
      'config:user.role.anonymous',
      'http_response',
      'rendered',
    ];
    sort($expected_cache_tags);
    $keys = \Drupal::service('cache_contexts_manager')
      ->convertTokensToKeys([
      'languages:language_interface',
      'theme',
      'user.permissions',
    ])
      ->getKeys();
    $this
      ->assertSame($expected_cache_tags, $cache_entry->tags);
    $cache_entry = \Drupal::cache('render')
      ->get('entity_view:block:powered:' . implode(':', $keys));
    $expected_cache_tags = [
      'block_view',
      'config:block.block.powered',
      'rendered',
    ];
    sort($expected_cache_tags);
    $this
      ->assertSame($expected_cache_tags, $cache_entry->tags);

    // The "Powered by Drupal" block is modified; verify a cache miss.
    $block
      ->setRegion('content');
    $block
      ->save();
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');

    // Now we should have a cache hit again.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');

    // Place the "Powered by Drupal" block another time; verify a cache miss.
    $this
      ->drupalPlaceBlock('system_powered_by_block', [
      'id' => 'powered-2',
    ]);
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');
    $cid_parts = [
      Url::fromRoute('<front>', [], [
        'absolute' => TRUE,
      ])
        ->toString(),
      '',
    ];
    $cid = implode(':', $cid_parts);
    $cache_entry = \Drupal::cache('page')
      ->get($cid);
    $expected_cache_tags = [
      'config:block_list',
      'block_view',
      'config:block.block.powered',
      'config:block.block.powered-2',
      'config:user.role.anonymous',
      'http_response',
      'rendered',
    ];
    sort($expected_cache_tags);
    $this
      ->assertEquals($expected_cache_tags, $cache_entry->tags);
    $expected_cache_tags = [
      'block_view',
      'config:block.block.powered',
      'rendered',
    ];
    sort($expected_cache_tags);
    $keys = \Drupal::service('cache_contexts_manager')
      ->convertTokensToKeys([
      'languages:language_interface',
      'theme',
      'user.permissions',
    ])
      ->getKeys();
    $cache_entry = \Drupal::cache('render')
      ->get('entity_view:block:powered:' . implode(':', $keys));
    $this
      ->assertSame($expected_cache_tags, $cache_entry->tags);
    $expected_cache_tags = [
      'block_view',
      'config:block.block.powered-2',
      'rendered',
    ];
    sort($expected_cache_tags);
    $keys = \Drupal::service('cache_contexts_manager')
      ->convertTokensToKeys([
      'languages:language_interface',
      'theme',
      'user.permissions',
    ])
      ->getKeys();
    $cache_entry = \Drupal::cache('render')
      ->get('entity_view:block:powered-2:' . implode(':', $keys));
    $this
      ->assertSame($expected_cache_tags, $cache_entry->tags);

    // Now we should have a cache hit again.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'HIT');

    // Delete the "Powered by Drupal" blocks; verify a cache miss.
    $block_storage = \Drupal::entityTypeManager()
      ->getStorage('block');
    $block_storage
      ->load('powered')
      ->delete();
    $block_storage
      ->load('powered-2')
      ->delete();
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->responseHeaderEquals('X-Drupal-Cache', 'MISS');
  }

  /**
   * Tests that a link exists to block layout from the appearance form.
   */
  public function testThemeAdminLink() {
    $this
      ->drupalPlaceBlock('help_block', [
      'region' => 'help',
    ]);
    $theme_admin = $this
      ->drupalCreateUser([
      'administer blocks',
      'administer themes',
      'access administration pages',
    ]);
    $this
      ->drupalLogin($theme_admin);
    $this
      ->drupalGet('admin/appearance');
    $this
      ->assertSession()
      ->pageTextContains('You can place blocks for each theme on the block layout page');
    $this
      ->assertSession()
      ->linkByHrefExists('admin/structure/block');
  }

  /**
   * Tests that uninstalling a theme removes its block configuration.
   */
  public function testUninstallTheme() {

    /** @var \Drupal\Core\Extension\ThemeInstallerInterface $theme_installer */
    $theme_installer = \Drupal::service('theme_installer');
    $theme_installer
      ->install([
      'seven',
    ]);
    $this
      ->config('system.theme')
      ->set('default', 'seven')
      ->save();
    $block = $this
      ->drupalPlaceBlock('system_powered_by_block', [
      'theme' => 'seven',
      'region' => 'help',
    ]);
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('Powered by Drupal');
    $this
      ->config('system.theme')
      ->set('default', 'classy')
      ->save();
    $theme_installer
      ->uninstall([
      'seven',
    ]);

    // Ensure that the block configuration does not exist anymore.
    $this
      ->assertNull(Block::load($block
      ->id()));
  }

  /**
   * Tests the block access.
   */
  public function testBlockAccess() {
    $this
      ->drupalPlaceBlock('test_access', [
      'region' => 'help',
    ]);
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextNotContains('Hello test world');
    \Drupal::state()
      ->set('test_block_access', TRUE);
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('Hello test world');
  }

  /**
   * Tests block_user_role_delete.
   */
  public function testBlockUserRoleDelete() {
    $role1 = Role::create([
      'id' => 'test_role1',
      'name' => $this
        ->randomString(),
    ]);
    $role1
      ->save();
    $role2 = Role::create([
      'id' => 'test_role2',
      'name' => $this
        ->randomString(),
    ]);
    $role2
      ->save();
    $block = Block::create([
      'id' => $this
        ->randomMachineName(),
      'plugin' => 'system_powered_by_block',
    ]);
    $block
      ->setVisibilityConfig('user_role', [
      'roles' => [
        $role1
          ->id() => $role1
          ->id(),
        $role2
          ->id() => $role2
          ->id(),
      ],
    ]);
    $block
      ->save();
    $this
      ->assertEquals([
      $role1
        ->id() => $role1
        ->id(),
      $role2
        ->id() => $role2
        ->id(),
    ], $block
      ->getVisibility()['user_role']['roles']);
    $role1
      ->delete();
    $block = Block::load($block
      ->id());
    $this
      ->assertEquals([
      $role2
        ->id() => $role2
        ->id(),
    ], $block
      ->getVisibility()['user_role']['roles']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BlockTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
BlockTest::moveBlockToRegion	public	function	Moves a block to a given region via the UI and confirms the result.
BlockTest::testAddBlockFromLibraryWithWeight	public	function	Tests adding a block from the library page with a weight query string.
BlockTest::testBlock	public	function	Tests configuring and moving a module-define block to specific regions.
BlockTest::testBlockAccess	public	function	Tests the block access.
BlockTest::testBlockCacheTags	public	function	Tests that cache tags are properly set and bubbled up to the page cache.
BlockTest::testBlockThemeSelector	public	function	Tests that the block form has a theme selector when not passed via the URL.
BlockTest::testBlockToggleVisibility	public	function	Tests that visibility can be properly toggled.
BlockTest::testBlockUserRoleDelete	public	function	Tests block_user_role_delete.
BlockTest::testBlockVisibility	public	function	Tests block visibility.
BlockTest::testBlockVisibilityListedEmpty	public	function	Tests block visibility when leaving "pages" textarea empty.
BlockTest::testHideBlockTitle	public	function	Tests block title display settings.
BlockTest::testThemeAdminLink	public	function	Tests that a link exists to block layout from the appearance form.
BlockTest::testThemeName	public	function	Tests block display of theme titles.
BlockTest::testUninstallTheme	public	function	Tests that uninstalling a theme removes its block configuration.
BlockTestBase::$adminUser	protected	property	A test user with administrative privileges.
BlockTestBase::$modules	protected static	property	Modules to install. Overrides BrowserTestBase::$modules	1
BlockTestBase::$regions	protected	property	A list of theme regions to test.
BlockTestBase::setUp	protected	function	Overrides BrowserTestBase::setUp	1
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::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::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$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::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::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::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__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
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::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.	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
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::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	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.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class BlockTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation