class DisplayBlockTest in Zircon Profile 8

Tests the block display plugin.

@group block

Hierarchy

• class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
  • class \Drupal\simpletest\WebTestBase uses AssertContentTrait, UserCreationTrait
    • class \Drupal\views\Tests\ViewTestBase uses ViewResultAssertionTrait
      • class \Drupal\block\Tests\Views\DisplayBlockTest uses AssertPageCacheContextsAndTagsTrait

See also

\Drupal\block\Plugin\views\display\Block

File

core/modules/block/src/Tests/Views/DisplayBlockTest.php, line 25

Contains \Drupal\block\Tests\Views\DisplayBlockTest.

Namespace

Drupal\block\Tests\Views

class DisplayBlockTest extends ViewTestBase {
  use AssertPageCacheContextsAndTagsTrait;

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = array(
    'node',
    'block_test_views',
    'test_page_test',
    'contextual',
    'views_ui',
  );

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = array(
    'test_view_block',
    'test_view_block2',
  );
  protected function setUp() {
    parent::setUp();
    ViewTestData::createTestViews(get_class($this), array(
      'block_test_views',
    ));
    $this
      ->enableViewsTestModule();
  }

  /**
   * Tests default and custom block categories.
   */
  public function testBlockCategory() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser(array(
      'administer views',
      'administer blocks',
    )));

    // Create a new view in the UI.
    $edit = array();
    $edit['label'] = $this
      ->randomString();
    $edit['id'] = strtolower($this
      ->randomMachineName());
    $edit['show[wizard_key]'] = 'standard:views_test_data';
    $edit['description'] = $this
      ->randomString();
    $edit['block[create]'] = TRUE;
    $edit['block[style][row_plugin]'] = 'fields';
    $this
      ->drupalPostForm('admin/structure/views/add', $edit, t('Save and edit'));
    $pattern = '//tr[.//td[text()=:category] and .//td//a[contains(@href, :href)]]';

    // Test that the block was given a default category corresponding to its
    // base table.
    $arguments = array(
      ':href' => \Drupal::Url('block.admin_add', array(
        'plugin_id' => 'views_block:' . $edit['id'] . '-block_1',
        'theme' => 'classy',
      )),
      ':category' => t('Lists (Views)'),
    );
    $this
      ->drupalGet('admin/structure/block');
    $this
      ->clickLinkPartialName('Place block');
    $elements = $this
      ->xpath($pattern, $arguments);
    $this
      ->assertTrue(!empty($elements), 'The test block appears in the category for its base table.');

    // Duplicate the block before changing the category.
    $this
      ->drupalPostForm('admin/structure/views/view/' . $edit['id'] . '/edit/block_1', array(), t('Duplicate @display_title', array(
      '@display_title' => 'Block',
    )));
    $this
      ->assertUrl('admin/structure/views/view/' . $edit['id'] . '/edit/block_2');

    // Change the block category to a random string.
    $this
      ->drupalGet('admin/structure/views/view/' . $edit['id'] . '/edit/block_1');
    $link = $this
      ->xpath('//a[@id="views-block-1-block-category" and normalize-space(text())=:category]', $arguments);
    $this
      ->assertTrue(!empty($link));
    $this
      ->clickLink(t('Lists (Views)'));
    $category = $this
      ->randomString();
    $this
      ->drupalPostForm(NULL, array(
      'block_category' => $category,
    ), t('Apply'));

    // Duplicate the block after changing the category.
    $this
      ->drupalPostForm(NULL, array(), t('Duplicate @display_title', array(
      '@display_title' => 'Block',
    )));
    $this
      ->assertUrl('admin/structure/views/view/' . $edit['id'] . '/edit/block_3');
    $this
      ->drupalPostForm(NULL, array(), t('Save'));

    // Test that the blocks are listed under the correct categories.
    $arguments[':category'] = $category;
    $this
      ->drupalGet('admin/structure/block');
    $this
      ->clickLinkPartialName('Place block');
    $elements = $this
      ->xpath($pattern, $arguments);
    $this
      ->assertTrue(!empty($elements), 'The test block appears in the custom category.');
    $arguments = array(
      ':href' => \Drupal::Url('block.admin_add', array(
        'plugin_id' => 'views_block:' . $edit['id'] . '-block_2',
        'theme' => 'classy',
      )),
      ':category' => t('Lists (Views)'),
    );
    $elements = $this
      ->xpath($pattern, $arguments);
    $this
      ->assertTrue(!empty($elements), 'The first duplicated test block remains in the original category.');
    $arguments = array(
      ':href' => \Drupal::Url('block.admin_add', array(
        'plugin_id' => 'views_block:' . $edit['id'] . '-block_3',
        'theme' => 'classy',
      )),
      ':category' => $category,
    );
    $elements = $this
      ->xpath($pattern, $arguments);
    $this
      ->assertTrue(!empty($elements), 'The second duplicated test block appears in the custom category.');
  }

  /**
   * Tests removing a block display.
   */
  public function testDeleteBlockDisplay() {

    // To test all combinations possible we first place create two instances
    // of the block display of the first view.
    $block_1 = $this
      ->drupalPlaceBlock('views_block:test_view_block-block_1', array(
      'label' => 'test_view_block-block_1:1',
    ));
    $block_2 = $this
      ->drupalPlaceBlock('views_block:test_view_block-block_1', array(
      'label' => 'test_view_block-block_1:2',
    ));

    // Then we add one instance of blocks for each of the two displays of the
    // second view.
    $block_3 = $this
      ->drupalPlaceBlock('views_block:test_view_block2-block_1', array(
      'label' => 'test_view_block2-block_1',
    ));
    $block_4 = $this
      ->drupalPlaceBlock('views_block:test_view_block2-block_2', array(
      'label' => 'test_view_block2-block_2',
    ));
    $this
      ->drupalGet('test-page');
    $this
      ->assertBlockAppears($block_1);
    $this
      ->assertBlockAppears($block_2);
    $this
      ->assertBlockAppears($block_3);
    $this
      ->assertBlockAppears($block_4);
    $block_storage = $this->container
      ->get('entity.manager')
      ->getStorage('block');

    // Remove the block display, so both block entities from the first view
    // should both disappear.
    $view = Views::getView('test_view_block');
    $view
      ->initDisplay();
    $view->displayHandlers
      ->remove('block_1');
    $view->storage
      ->save();
    $this
      ->assertFalse($block_storage
      ->load($block_1
      ->id()), 'The block for this display was removed.');
    $this
      ->assertFalse($block_storage
      ->load($block_2
      ->id()), 'The block for this display was removed.');
    $this
      ->assertTrue($block_storage
      ->load($block_3
      ->id()), 'A block from another view was unaffected.');
    $this
      ->assertTrue($block_storage
      ->load($block_4
      ->id()), 'A block from another view was unaffected.');
    $this
      ->drupalGet('test-page');
    $this
      ->assertNoBlockAppears($block_1);
    $this
      ->assertNoBlockAppears($block_2);
    $this
      ->assertBlockAppears($block_3);
    $this
      ->assertBlockAppears($block_4);

    // Remove the first block display of the second view and ensure the block
    // instance of the second block display still exists.
    $view = Views::getView('test_view_block2');
    $view
      ->initDisplay();
    $view->displayHandlers
      ->remove('block_1');
    $view->storage
      ->save();
    $this
      ->assertFalse($block_storage
      ->load($block_3
      ->id()), 'The block for this display was removed.');
    $this
      ->assertTrue($block_storage
      ->load($block_4
      ->id()), 'A block from another display on the same view was unaffected.');
    $this
      ->drupalGet('test-page');
    $this
      ->assertNoBlockAppears($block_3);
    $this
      ->assertBlockAppears($block_4);
  }

  /**
   * Test the block form for a Views block.
   */
  public function testViewsBlockForm() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser(array(
      'administer blocks',
    )));
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $this
      ->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
    $elements = $this
      ->xpath('//input[@name="label"]');
    $this
      ->assertTrue(empty($elements), 'The label field is not found for Views blocks.');

    // Test that that machine name field is hidden from display and has been
    // saved as expected from the default value.
    $this
      ->assertNoFieldById('edit-machine-name', 'views_block__test_view_block_1', 'The machine name is hidden on the views block form.');

    // Save the block.
    $this
      ->drupalPostForm(NULL, array(), t('Save block'));
    $storage = $this->container
      ->get('entity.manager')
      ->getStorage('block');
    $block = $storage
      ->load('views_block__test_view_block_block_1');

    // This will only return a result if our new block has been created with the
    // expected machine name.
    $this
      ->assertTrue(!empty($block), 'The expected block was loaded.');
    for ($i = 2; $i <= 3; $i++) {

      // Place the same block again and make sure we have a new ID.
      $this
        ->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, array(), t('Save block'));
      $block = $storage
        ->load('views_block__test_view_block_block_1_' . $i);

      // This will only return a result if our new block has been created with the
      // expected machine name.
      $this
        ->assertTrue(!empty($block), 'The expected block was loaded.');
    }

    // Tests the override capability of items per page.
    $this
      ->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
    $edit = array();
    $edit['settings[override][items_per_page]'] = 10;
    $this
      ->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, $edit, t('Save block'));
    $block = $storage
      ->load('views_block__test_view_block_block_1_4');
    $config = $block
      ->getPlugin()
      ->getConfiguration();
    $this
      ->assertEqual(10, $config['items_per_page'], "'Items per page' is properly saved.");
    $edit['settings[override][items_per_page]'] = 5;
    $this
      ->drupalPostForm('admin/structure/block/manage/views_block__test_view_block_block_1_4', $edit, t('Save block'));
    $block = $storage
      ->load('views_block__test_view_block_block_1_4');
    $config = $block
      ->getPlugin()
      ->getConfiguration();
    $this
      ->assertEqual(5, $config['items_per_page'], "'Items per page' is properly saved.");

    // Tests the override of the label capability.
    $edit = array();
    $edit['settings[views_label_checkbox]'] = 1;
    $edit['settings[views_label]'] = 'Custom title';
    $this
      ->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, $edit, t('Save block'));
    $block = $storage
      ->load('views_block__test_view_block_block_1_5');
    $config = $block
      ->getPlugin()
      ->getConfiguration();
    $this
      ->assertEqual('Custom title', $config['views_label'], "'Label' is properly saved.");
  }

  /**
   * Tests the actual rendering of the views block.
   */
  public function testBlockRendering() {

    // Create a block and set a custom title.
    $block = $this
      ->drupalPlaceBlock('views_block:test_view_block-block_1', array(
      'label' => 'test_view_block-block_1:1',
      'views_label' => 'Custom title',
    ));
    $this
      ->drupalGet('');
    $result = $this
      ->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
    $this
      ->assertEqual((string) $result[0], 'Custom title');

    // Don't override the title anymore.
    $plugin = $block
      ->getPlugin();
    $plugin
      ->setConfigurationValue('views_label', '');
    $block
      ->save();
    $this
      ->drupalGet('');
    $result = $this
      ->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
    $this
      ->assertEqual((string) $result[0], 'test_view_block');

    // Hide the title.
    $block
      ->getPlugin()
      ->setConfigurationValue('label_display', FALSE);
    $block
      ->save();
    $this
      ->drupalGet('');
    $result = $this
      ->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
    $this
      ->assertTrue(empty($result), 'The title is not visible.');
    $this
      ->assertCacheTags(array_merge($block
      ->getCacheTags(), [
      'block_view',
      'config:block_list',
      'config:system.site',
      'config:views.view.test_view_block',
      'rendered',
    ]));
  }

  /**
   * Tests the various testcases of empty block rendering.
   */
  public function testBlockEmptyRendering() {
    $url = new Url('test_page_test.test_page');

    // Remove all views_test_data entries.
    \Drupal::database()
      ->truncate('views_test_data')
      ->execute();

    /** @var \Drupal\views\ViewEntityInterface $view */
    $view = View::load('test_view_block');
    $view
      ->invalidateCaches();
    $block = $this
      ->drupalPlaceBlock('views_block:test_view_block-block_1', array(
      'label' => 'test_view_block-block_1:1',
      'views_label' => 'Custom title',
    ));
    $this
      ->drupalGet('');
    $this
      ->assertEqual(1, count($this
      ->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]')));
    $display =& $view
      ->getDisplay('block_1');
    $display['display_options']['block_hide_empty'] = TRUE;
    $view
      ->save();
    $this
      ->drupalGet($url);
    $this
      ->assertEqual(0, count($this
      ->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]')));

    // Ensure that the view cachability metadata is propagated even, for an
    // empty block.
    $this
      ->assertCacheTags(array_merge($block
      ->getCacheTags(), [
      'block_view',
      'config:block_list',
      'config:views.view.test_view_block',
      'rendered',
    ]));
    $this
      ->assertCacheContexts([
      'url.query_args:_wrapper_format',
    ]);

    // Add a header displayed on empty result.
    $display =& $view
      ->getDisplay('block_1');
    $display['display_options']['defaults']['header'] = FALSE;
    $display['display_options']['header']['example'] = [
      'field' => 'area_text_custom',
      'id' => 'area_text_custom',
      'table' => 'views',
      'plugin_id' => 'text_custom',
      'content' => 'test header',
      'empty' => TRUE,
    ];
    $view
      ->save();
    $this
      ->drupalGet($url);
    $this
      ->assertEqual(1, count($this
      ->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]')));
    $this
      ->assertCacheTags(array_merge($block
      ->getCacheTags(), [
      'block_view',
      'config:block_list',
      'config:views.view.test_view_block',
      'rendered',
    ]));
    $this
      ->assertCacheContexts([
      'url.query_args:_wrapper_format',
    ]);

    // Hide the header on empty results.
    $display =& $view
      ->getDisplay('block_1');
    $display['display_options']['defaults']['header'] = FALSE;
    $display['display_options']['header']['example'] = [
      'field' => 'area_text_custom',
      'id' => 'area_text_custom',
      'table' => 'views',
      'plugin_id' => 'text_custom',
      'content' => 'test header',
      'empty' => FALSE,
    ];
    $view
      ->save();
    $this
      ->drupalGet($url);
    $this
      ->assertEqual(0, count($this
      ->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]')));
    $this
      ->assertCacheTags(array_merge($block
      ->getCacheTags(), [
      'block_view',
      'config:block_list',
      'config:views.view.test_view_block',
      'rendered',
    ]));
    $this
      ->assertCacheContexts([
      'url.query_args:_wrapper_format',
    ]);

    // Add an empty text.
    $display =& $view
      ->getDisplay('block_1');
    $display['display_options']['defaults']['empty'] = FALSE;
    $display['display_options']['empty']['example'] = [
      'field' => 'area_text_custom',
      'id' => 'area_text_custom',
      'table' => 'views',
      'plugin_id' => 'text_custom',
      'content' => 'test empty',
    ];
    $view
      ->save();
    $this
      ->drupalGet($url);
    $this
      ->assertEqual(1, count($this
      ->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]')));
    $this
      ->assertCacheTags(array_merge($block
      ->getCacheTags(), [
      'block_view',
      'config:block_list',
      'config:views.view.test_view_block',
      'rendered',
    ]));
    $this
      ->assertCacheContexts([
      'url.query_args:_wrapper_format',
    ]);
  }

  /**
   * Tests the contextual links on a Views block.
   */
  public function testBlockContextualLinks() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser(array(
      'administer views',
      'access contextual links',
      'administer blocks',
    )));
    $block = $this
      ->drupalPlaceBlock('views_block:test_view_block-block_1');
    $cached_block = $this
      ->drupalPlaceBlock('views_block:test_view_block-block_1');
    $this
      ->drupalGet('test-page');
    $id = 'block:block=' . $block
      ->id() . ':langcode=en|entity.view.edit_form:view=test_view_block:location=block&name=test_view_block&display_id=block_1&langcode=en';
    $cached_id = 'block:block=' . $cached_block
      ->id() . ':langcode=en|entity.view.edit_form:view=test_view_block:location=block&name=test_view_block&display_id=block_1&langcode=en';

    // @see \Drupal\contextual\Tests\ContextualDynamicContextTest:assertContextualLinkPlaceHolder()
    $this
      ->assertRaw('<div' . new Attribute(array(
      'data-contextual-id' => $id,
    )) . '></div>', format_string('Contextual link placeholder with id @id exists.', array(
      '@id' => $id,
    )));
    $this
      ->assertRaw('<div' . new Attribute(array(
      'data-contextual-id' => $cached_id,
    )) . '></div>', format_string('Contextual link placeholder with id @id exists.', array(
      '@id' => $cached_id,
    )));

    // Get server-rendered contextual links.
    // @see \Drupal\contextual\Tests\ContextualDynamicContextTest:renderContextualLinks()
    $post = array(
      'ids[0]' => $id,
      'ids[1]' => $cached_id,
    );
    $response = $this
      ->drupalPostWithFormat('contextual/render', 'json', $post, array(
      'query' => array(
        'destination' => 'test-page',
      ),
    ));
    $this
      ->assertResponse(200);
    $json = Json::decode($response);
    $this
      ->assertIdentical($json[$id], '<ul class="contextual-links"><li class="block-configure"><a href="' . base_path() . 'admin/structure/block/manage/' . $block
      ->id() . '">Configure block</a></li><li class="entityviewedit-form"><a href="' . base_path() . 'admin/structure/views/view/test_view_block/edit/block_1">Edit view</a></li></ul>');
    $this
      ->assertIdentical($json[$cached_id], '<ul class="contextual-links"><li class="block-configure"><a href="' . base_path() . 'admin/structure/block/manage/' . $cached_block
      ->id() . '">Configure block</a></li><li class="entityviewedit-form"><a href="' . base_path() . 'admin/structure/views/view/test_view_block/edit/block_1">Edit view</a></li></ul>');
  }

}

Members

Name	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.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts	protected	function	Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge	protected	function	Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags	protected	function	Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags	protected	function	Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::debugCacheTags	protected	function	Provides debug information for cache tags.
AssertPageCacheContextsAndTagsTrait::enablePageCaching	protected	function	Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues	protected	function	Gets a specific header value as array.
DisplayBlockTest::$modules	public static	property	Modules to install. Overrides ViewTestBase::$modules
DisplayBlockTest::$testViews	public static	property	Views used by this test.
DisplayBlockTest::setUp	protected	function	Sets up a Drupal site for running functional and integration tests. Overrides ViewTestBase::setUp
DisplayBlockTest::testBlockCategory	public	function	Tests default and custom block categories.
DisplayBlockTest::testBlockContextualLinks	public	function	Tests the contextual links on a Views block.
DisplayBlockTest::testBlockEmptyRendering	public	function	Tests the various testcases of empty block rendering.
DisplayBlockTest::testBlockRendering	public	function	Tests the actual rendering of the views block.
DisplayBlockTest::testDeleteBlockDisplay	public	function	Tests removing a block display.
DisplayBlockTest::testViewsBlockForm	public	function	Test the block form for a Views block.
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.
ViewResultAssertionTrait::assertIdenticalResultset	protected	function	Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper	protected	function	Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset	protected	function	Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet	protected	function	Returns a very simple test dataset.	1
ViewTestBase::enableViewsTestModule	protected	function	Sets up the views_test_data.module.
ViewTestBase::executeView	protected	function	Executes a view with debugging.
ViewTestBase::helperButtonHasLabel	protected	function	Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet	protected	function	Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition	protected	function	Returns the schema definition.	1
ViewTestBase::viewsData	protected	function	Returns the views data definition.	8
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