BlockInvalidRegionTest.php in Drupal 9

Namespace

Drupal\Tests\block\Functional

File

core/modules/block/tests/src/Functional/BlockInvalidRegionTest.php

<?php

namespace Drupal\Tests\block\Functional;

use Drupal\Tests\BrowserTestBase;
use Drupal\block\Entity\Block;

/**
 * Tests that an active block assigned to a non-existing region triggers the
 * warning message and is disabled.
 *
 * @group block
 */
class BlockInvalidRegionTest extends BrowserTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  protected static $modules = [
    'block',
    'block_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';
  protected function setUp() : void {
    parent::setUp();

    // Create an admin user.
    $admin_user = $this
      ->drupalCreateUser([
      'administer site configuration',
      'access administration pages',
      'administer blocks',
    ]);
    $this
      ->drupalLogin($admin_user);
  }

  /**
   * Tests that blocks assigned to invalid regions work correctly.
   */
  public function testBlockInInvalidRegion() {

    // Enable a test block and place it in an invalid region.
    $block = $this
      ->drupalPlaceBlock('test_html');
    \Drupal::configFactory()
      ->getEditable('block.block.' . $block
      ->id())
      ->set('region', 'invalid_region')
      ->save();
    $block = Block::load($block
      ->id());
    $warning_message = 'The block ' . $block
      ->id() . ' was assigned to the invalid region invalid_region and has been disabled.';

    // Clearing the cache should disable the test block placed in the invalid region.
    $this
      ->drupalGet('admin/config/development/performance');
    $this
      ->submitForm([], 'Clear all caches');
    $this
      ->assertSession()
      ->pageTextContains($warning_message);

    // Clear the cache to check if the warning message is not triggered.
    $this
      ->drupalGet('admin/config/development/performance');
    $this
      ->submitForm([], 'Clear all caches');
    $this
      ->assertSession()
      ->pageTextNotContains($warning_message);

    // Place disabled test block in the invalid region of the default theme.
    \Drupal::configFactory()
      ->getEditable('block.block.' . $block
      ->id())
      ->set('region', 'invalid_region')
      ->save();
    $block = Block::load($block
      ->id());

    // Clear the cache to check if the warning message is not triggered.
    $this
      ->drupalGet('admin/config/development/performance');
    $this
      ->submitForm([], 'Clear all caches');
    $this
      ->assertSession()
      ->pageTextNotContains($warning_message);
  }

}

Classes

Name	Description
BlockInvalidRegionTest	Tests that an active block assigned to a non-existing region triggers the warning message and is disabled.