You are here

class BlockTest in Zircon Profile 8.0

Same name in this branch
  1. 8.0 core/modules/block/src/Tests/BlockTest.php \Drupal\block\Tests\BlockTest
  2. 8.0 core/modules/views/tests/src/Unit/Plugin/views/display/BlockTest.php \Drupal\Tests\views\Unit\Plugin\views\display\BlockTest
  3. 8.0 core/modules/block/tests/src/Unit/Plugin/migrate/source/BlockTest.php \Drupal\Tests\block\Unit\Plugin\migrate\source\BlockTest
Same name and namespace in other branches
  1. 8 core/modules/block/src/Tests/BlockTest.php \Drupal\block\Tests\BlockTest

Tests basic block functionality.

@group block

Hierarchy

Expanded class hierarchy of BlockTest

File

core/modules/block/src/Tests/BlockTest.php, line 20
Contains \Drupal\block\Tests\BlockTest.

Namespace

Drupal\block\Tests
View source
class BlockTest extends BlockTestBase {

  /**
   * Tests block visibility.
   */
  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 = array(
      'id' => strtolower($this
        ->randomMachineName(8)),
      'region' => 'sidebar_first',
      'settings[label]' => $title,
    );

    // 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
      ->assertFieldChecked('edit-visibility-request-path-negate-0');
    $this
      ->drupalPostForm(NULL, $edit, t('Save block'));
    $this
      ->assertText('The block configuration has been saved.', 'Block was saved');
    $this
      ->clickLink('Configure');
    $this
      ->assertFieldChecked('edit-visibility-request-path-negate-1');
    $this
      ->drupalGet('');
    $this
      ->assertText($title, 'Block was displayed on the front page.');
    $this
      ->drupalGet('user');
    $this
      ->assertNoText($title, 'Block was not displayed according to block visibility rules.');

    // Confirm that the block is not displayed to anonymous users.
    $this
      ->drupalLogout();
    $this
      ->drupalGet('');
    $this
      ->assertNoText($title, 'Block was not displayed to anonymous users.');

    // Confirm that an empty block is not displayed.
    $this
      ->assertNoText('Powered by Drupal', 'Empty block not displayed.');
    $this
      ->assertNoRaw('sidebar-first', 'Empty sidebar-first region is not displayed.');
  }

  /**
   * 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 = array(
      '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
      ->drupalPostForm('admin/structure/block/add/' . $block_name . '/' . $default_theme, $edit, t('Save block'));
    $this
      ->clickLink('Configure');
    $this
      ->assertFieldChecked('edit-visibility-user-role-roles-authenticated');
    $edit = [
      'visibility[user_role][roles][' . RoleInterface::AUTHENTICATED_ID . ']' => FALSE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save block');
    $this
      ->clickLink('Configure');
    $this
      ->assertNoFieldChecked('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
      ->assertIdentical([], $visibility_config);
    $this
      ->assertIdentical([], $block
      ->get('visibility'));
  }

  /**
   * Test block visibility when leaving "pages" textarea empty.
   */
  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 = array(
      '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
      ->drupalPostForm('admin/structure/block/add/' . $block_name . '/' . $default_theme, $edit, t('Save block'));
    $this
      ->assertText('The block configuration has been saved.', 'Block was saved');
    $this
      ->drupalGet('user');
    $this
      ->assertNoText($title, 'Block was not displayed according to block visibility rules.');
    $this
      ->drupalGet('USER');
    $this
      ->assertNoText($title, 'Block was not displayed according to block visibility rules regardless of path case.');

    // Confirm that the block is not displayed to anonymous users.
    $this
      ->drupalLogout();
    $this
      ->drupalGet('');
    $this
      ->assertNoText($title, 'Block was not displayed to anonymous users on the front page.');
  }

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

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

    // Select the 'Powered by Drupal' block to be configured and moved.
    $block = array();
    $block['id'] = 'system_powered_by_block';
    $block['settings[label]'] = $this
      ->randomMachineName(8);
    $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
      ->drupalPostForm('admin/structure/block/add/' . $block['id'] . '/' . $block['theme'], array(
      'settings[label]' => $block['settings[label]'],
      'id' => $block['id'],
      'region' => $block['region'],
    ), t('Save block'));
    $this
      ->assertText(t('The block configuration has been saved.'), 'Block title set.');

    // Check to see if the block was created by checking its configuration.
    $instance = Block::load($block['id']);
    $this
      ->assertEqual($instance
      ->label(), $block['settings[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);
    }

    // Set the block to the disabled region.
    $edit = array();
    $edit['blocks[' . $block['id'] . '][region]'] = -1;
    $this
      ->drupalPostForm('admin/structure/block', $edit, t('Save blocks'));

    // Confirm that the block is now listed as disabled.
    $this
      ->assertText(t('The block settings have been updated.'), 'Block successfully move to disabled region.');

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

    // Check for <div id="block-my-block-instance-name"> if the machine name
    // is my_block_instance_name.
    $xpath = $this
      ->buildXPathQuery('//div[@id=:id]/*', array(
      ':id' => 'block-' . str_replace('_', '-', strtolower($block['id'])),
    ));
    $this
      ->assertNoFieldByXPath($xpath, FALSE, 'Block found in no regions.');

    // Test deleting the block from the edit form.
    $this
      ->drupalGet('admin/structure/block/manage/' . $block['id']);
    $this
      ->clickLink(t('Delete'));
    $this
      ->assertRaw(t('Are you sure you want to delete the block %name?', array(
      '%name' => $block['settings[label]'],
    )));
    $this
      ->drupalPostForm(NULL, array(), t('Delete'));
    $this
      ->assertRaw(t('The block %name has been deleted.', array(
      '%name' => $block['settings[label]'],
    )));

    // Test deleting a block via "Configure block" link.
    $block = $this
      ->drupalPlaceBlock('system_powered_by_block');
    $this
      ->drupalGet('admin/structure/block/manage/' . $block
      ->id(), array(
      'query' => array(
        'destination' => 'admin',
      ),
    ));
    $this
      ->clickLink(t('Delete'));
    $this
      ->assertRaw(t('Are you sure you want to delete the block %name?', array(
      '%name' => $block
        ->label(),
    )));
    $this
      ->drupalPostForm(NULL, array(), t('Delete'));
    $this
      ->assertRaw(t('The block %name has been deleted.', array(
      '%name' => $block
        ->label(),
    )));
    $this
      ->assertUrl('admin');
    $this
      ->assertNoRaw($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_handler')
      ->install([
      'bartik',
      'seven',
      'stark',
    ]);
    $theme_settings = $this
      ->config('system.theme');
    foreach ([
      'bartik',
      'seven',
      'stark',
    ] as $theme) {
      $this
        ->drupalGet('admin/structure/block/list/' . $theme);
      $this
        ->assertTitle(t('Block layout') . ' | Drupal');

      // Select the 'Powered by Drupal' block to be placed.
      $block = array();
      $block['id'] = strtolower($this
        ->randomMachineName());
      $block['theme'] = $theme;
      $block['region'] = 'content';
      $this
        ->drupalPostForm('admin/structure/block/add/system_powered_by_block', $block, t('Save block'));
      $this
        ->assertText(t('The block configuration has been saved.'));
      $this
        ->assertUrl('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('');
      $elements = $this
        ->xpath('//div[@id = :id]', array(
        ':id' => Html::getUniqueId('block-' . $block['id']),
      ));
      $this
        ->assertTrue(!empty($elements), 'The block was found.');
    }
  }

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

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

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

  /**
   * Test block title display settings.
   */
  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 = array(
      'id' => $id,
      'region' => 'sidebar_first',
      'settings[label]' => $title,
    );
    $this
      ->drupalPostForm('admin/structure/block/add/' . $block_name . '/' . $default_theme, $edit, t('Save block'));
    $this
      ->assertText('The block configuration has been saved.', 'Block was saved');
    $this
      ->drupalGet('user');
    $this
      ->assertText($title, 'Block title was displayed by default.');
    $edit = array(
      'settings[label_display]' => FALSE,
    );
    $this
      ->drupalPostForm('admin/structure/block/manage/' . $id, $edit, t('Save block'));
    $this
      ->assertText('The block configuration has been saved.', 'Block was saved');
    $this
      ->drupalGet('admin/structure/block/manage/' . $id);
    $this
      ->assertNoFieldChecked('edit-settings-label-display', 'The display_block option has the correct default value on the configuration form.');
    $this
      ->drupalGet('user');
    $this
      ->assertNoText($title, 'Block title was not displayed when hidden.');
  }

  /**
   * 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'.
   */
  function moveBlockToRegion(array $block, $region) {

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

    // Confirm that the block was moved to the proper region.
    $this
      ->assertText(t('The block settings have been updated.'), format_string('Block successfully moved to %region_name region.', array(
      '%region_name' => $region,
    )));

    // Confirm that the block is being displayed.
    $this
      ->drupalGet('');
    $this
      ->assertText(t($block['settings[label]']), 'Block successfully being displayed on the page.');

    // Confirm that the custom block was found at the proper region.
    $xpath = $this
      ->buildXPathQuery('//div[@class=:region-class]//div[@id=:block-id]/*', array(
      ':region-class' => 'region region-' . Html::getClass($region),
      ':block-id' => 'block-' . str_replace('_', '-', strtolower($block['id'])),
    ));
    $this
      ->assertFieldByXPath($xpath, NULL, t('Block found in %region_name region.', array(
      '%region_name' => Html::getClass($region),
    )));
  }

  /**
   * Test 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', array(
      'id' => 'powered',
    ));

    // Prime the page cache.
    $this
      ->drupalGet('<front>');
    $this
      ->assertEqual($this
      ->drupalGetHeader('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
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT');
    $cid_parts = array(
      \Drupal::url('<front>', array(), array(
        'absolute' => TRUE,
      )),
      'html',
    );
    $cid = implode(':', $cid_parts);
    $cache_entry = \Drupal::cache('render')
      ->get($cid);
    $expected_cache_tags = array(
      'config:block_list',
      'block_view',
      'config:block.block.powered',
      'config:user.role.anonymous',
      'rendered',
    );
    sort($expected_cache_tags);
    $keys = \Drupal::service('cache_contexts_manager')
      ->convertTokensToKeys([
      'languages:language_interface',
      'theme',
      'user.permissions',
    ])
      ->getKeys();
    $this
      ->assertIdentical($cache_entry->tags, $expected_cache_tags);
    $cache_entry = \Drupal::cache('render')
      ->get('entity_view:block:powered:' . implode(':', $keys));
    $expected_cache_tags = array(
      'block_view',
      'config:block.block.powered',
      'rendered',
    );
    sort($expected_cache_tags);
    $this
      ->assertIdentical($cache_entry->tags, $expected_cache_tags);

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

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

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

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->drupalGet('<front>');
    $this
      ->assertEqual($this
      ->drupalGetHeader('X-Drupal-Cache'), 'HIT');
    $cid_parts = array(
      \Drupal::url('<front>', array(), array(
        'absolute' => TRUE,
      )),
      'html',
    );
    $cid = implode(':', $cid_parts);
    $cache_entry = \Drupal::cache('render')
      ->get($cid);
    $expected_cache_tags = array(
      'config:block_list',
      'block_view',
      'config:block.block.powered',
      'config:block.block.powered-2',
      'config:user.role.anonymous',
      'rendered',
    );
    sort($expected_cache_tags);
    $this
      ->assertEqual($cache_entry->tags, $expected_cache_tags);
    $expected_cache_tags = array(
      '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
      ->assertIdentical($cache_entry->tags, $expected_cache_tags);
    $expected_cache_tags = array(
      '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
      ->assertIdentical($cache_entry->tags, $expected_cache_tags);

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

    // Delete the "Powered by Drupal" blocks; verify a cache miss.
    entity_delete_multiple('block', array(
      'powered',
      'powered-2',
    ));
    $this
      ->drupalGet('<front>');
    $this
      ->assertEqual($this
      ->drupalGetHeader('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
      ->assertText('You can place blocks for each theme on the block layout page');
    $this
      ->assertLinkByHref('admin/structure/block');
  }

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

    /** @var \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler */
    $theme_handler = \Drupal::service('theme_handler');
    $theme_handler
      ->install([
      'seven',
    ]);
    $theme_handler
      ->setDefault('seven');
    $block = $this
      ->drupalPlaceBlock('system_powered_by_block', [
      'theme' => 'seven',
      'region' => 'help',
    ]);
    $this
      ->drupalGet('<front>');
    $this
      ->assertText('Powered by Drupal');
    $theme_handler
      ->setDefault('classy');
    $theme_handler
      ->uninstall([
      'seven',
    ]);

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

  /**
   * Tests the block access.
   */
  public function testBlockAccess() {
    $this
      ->drupalPlaceBlock('test_access', [
      'region' => 'help',
    ]);
    $this
      ->drupalGet('<front>');
    $this
      ->assertNoText('Hello test world');
    \Drupal::state()
      ->set('test_block_access', TRUE);
    $this
      ->drupalGet('<front>');
    $this
      ->assertText('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
      ->assertEqual($block
      ->getVisibility()['user_role']['roles'], [
      $role1
        ->id() => $role1
        ->id(),
      $role2
        ->id() => $role2
        ->id(),
    ]);
    $role1
      ->delete();
    $block = Block::load($block
      ->id());
    $this
      ->assertEqual($block
      ->getVisibility()['user_role']['roles'], [
      $role2
        ->id() => $role2
        ->id(),
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 2
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
BlockTest::moveBlockToRegion function Moves a block to a given region via the UI and confirms the result.
BlockTest::testBlock function Test configuring and moving a module-define block to specific regions.
BlockTest::testBlockAccess public function Tests the block access.
BlockTest::testBlockCacheTags public function Test 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 function Tests block visibility.
BlockTest::testBlockVisibilityListedEmpty function Test block visibility when leaving "pages" textarea empty.
BlockTest::testHideBlockTitle function Test block title display settings.
BlockTest::testThemeAdminLink public function Tests that a link exists to block layout from the appearance form.
BlockTest::testThemeName function Test 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 public static property Modules to install. 1
BlockTestBase::$regions protected property A list of theme regions to test.
BlockTestBase::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp 1
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.
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.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$classLoader protected property The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories protected property The config directories used in this test.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. 12
WebTestBase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$kernel protected property The kernel used in this test. Overrides TestBase::$kernel
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 30
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$rootUser protected property The "#1" admin user.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertMail protected function Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString protected function Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code.
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 2
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::doInstall protected function Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView protected function Builds the renderable view of an entity.
WebTestBase::drupalCompareFiles protected function Compare two files based on size and file name.
WebTestBase::drupalCreateContentType protected function Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode protected function Creates a node based on default settings.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails protected function Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle function Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles protected function Gets a list of files that can be used in tests.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPlaceBlock protected function Creates a block instance based on default settings.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::getDatabaseTypes protected function Returns all supported database driver installer objects.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::initConfig protected function Initialize various configurations post-installation.
WebTestBase::initKernel protected function Initializes the kernel after installation.
WebTestBase::initSettings protected function Initialize settings created during install.
WebTestBase::initUserSession protected function Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`.
WebTestBase::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 2
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings protected function Prepares site settings and services before installation. 1
WebTestBase::rebuildAll protected function Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer protected function Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables protected function Refreshes in-memory configuration and state information. 1
WebTestBase::resetAll protected function Resets all data structures after having enabled new modules.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setContainerParameter protected function Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 2
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings protected function Rewrites the settings.php file of the test site.
WebTestBase::__construct function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1