class BlockTestBase

Same name and namespace in other branches
  1. 11.x core/modules/block/tests/src/Functional/BlockTestBase.php \Drupal\Tests\block\Functional\BlockTestBase
  2. 10 core/modules/block/tests/src/Functional/BlockTestBase.php \Drupal\Tests\block\Functional\BlockTestBase
  3. 8.9.x core/modules/block/src/Tests/BlockTestBase.php \Drupal\block\Tests\BlockTestBase
  4. 8.9.x core/modules/block/tests/src/Functional/BlockTestBase.php \Drupal\Tests\block\Functional\BlockTestBase

Provides setup and helper methods for block module tests.

Hierarchy

Expanded class hierarchy of BlockTestBase

File

core/modules/block/tests/src/Functional/BlockTestBase.php, line 11

Namespace

Drupal\Tests\block\Functional
View source
abstract class BlockTestBase extends BrowserTestBase {
  
  /**
   * Modules to install.
   *
   * @var array
   */
  protected static $modules = [
    'block',
    'filter',
    'test_page_test',
    'help',
    'block_test',
  ];
  
  /**
   * A list of theme regions to test.
   *
   * @var array
   */
  protected $regions;
  
  /**
   * A test user with administrative privileges.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    // Use the test page as the front page.
    $this->config('system.site')
      ->set('page.front', '/test-page')
      ->save();
    // Create Full HTML text format.
    $full_html_format = FilterFormat::create([
      'format' => 'full_html',
      'name' => 'Full HTML',
    ]);
    $full_html_format->save();
    // Create and log in an administrative user having access to the Full HTML
    // text format.
    $this->adminUser = $this->drupalCreateUser([
      'administer blocks',
      $full_html_format->getPermissionName(),
      'access administration pages',
    ]);
    $this->drupalLogin($this->adminUser);
    // Define the existing regions.
    $this->regions = [
      'header',
      'sidebar_first',
      'content',
      'sidebar_second',
      'footer',
    ];
    $block_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('block');
    $blocks = $block_storage->loadByProperties([
      'theme' => $this->config('system.theme')
        ->get('default'),
    ]);
    foreach ($blocks as $block) {
      $block->delete();
    }
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.