You are here

class SearchByPageTesterTest in Search by Page 8

Base class for testing Search by Page.

@group search_by_page

Hierarchy

Expanded class hierarchy of SearchByPageTesterTest

File

tests/src/Functional/SearchByPageTesterTest.php, line 21
General Functional Tests for the Search by Page module. By Jennifer Hodgdon of Poplar ProductivityWare, www.poplarware.com

Namespace

Drupal\Tests\search_by_page\Functional
View source
class SearchByPageTesterTest extends BrowserTestBase {
  const LANGUAGE_NONE = Language::LANGCODE_NOT_SPECIFIED;
  public $envinfo1, $envinfo2, $envid1, $envid2 = [];
  public static $modules = [
    'search_by_page',
    'search_by_page_paths',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->setUpEnvironments();
  }

  /**
   * Creates two environments for Search by Page.
   */
  public function setUpEnvironments() {
    $user = $this
      ->createUser([
      'administer search by page',
      'access administration pages',
      'administer site configuration',
      'administer search',
    ]);
    $this
      ->drupalLogin($user);

    // Content access permissions always need to be rebuilt for some reason.
    node_access_rebuild();

    // Verify this module is active in Search.
    $active = \Drupal::state()
      ->get('search_active_modules', [
      'node',
      'user',
    ]);
    $this
      ->assertTrue(in_array('search_by_page', $active));

    // Clear out any existing search environments that may have been defined.
    $envs = search_by_page_list_environments();
    foreach ($envs as $env) {
      \Drupal::moduleHandler()
        ->invokeAll('search_by_page_delete_environment', $env);
    }

    // Define two new environments. They should have ID numbers 1 and 2.
    $this->envinfo1 = [
      'environment_name' => 'env1',
      'set_as_default' => 1,
      'page_title' => t('Search page 1 title'),
      'block_title' => t('Search block 1 title'),
      'field_label' => t('Search field 1 label'),
      'button_label' => t('Search button 1 label'),
      'page_path' => 'search_path_1',
      'exclude_tags' => 'tagtoexclude',
    ];
    $this
      ->drupalPostForm('admin/config/search/search_by_page/add', $this->envinfo1, 'Save configuration');
    $this->envid1 = 1;
    $this->envinfo2 = [
      'environment_name' => 'env2',
      'set_as_default' => 2,
      'page_title' => t('Search page 2 title'),
      'block_title' => t('Search block 2 title'),
      'field_label' => t('Search field 2 label'),
      'button_label' => t('Search button 2 label'),
      'page_path' => 'search_path_2',
    ];
    $this
      ->drupalPostForm('admin/config/search/search_by_page/add', $this->envinfo2, 'Save configuration');
    $this->envid2 = 2;

    // Reset the permissions cache.
    $this
      ->checkPermissions([]);
    $this
      ->drupalLogout();
  }

  /**
   * Returns the permission name to search the given search environment.
   */
  public function searchPerm($envinfo) {
    return 'search page environment ' . $envinfo['environment_name'];
  }

  /**
   * Updates the search index.
   *
   * Logs current user out, and runs cron to make sure search content
   * is indexed.
   */
  public function doCronRun() {

    // Make sure we are logged out before cron run.
    if ($this->loggedInUser) {
      $this
        ->drupalLogout();
    }
    $this
      ->drupalGet('cron/' . \Drupal::state()
      ->get('system.cron_key'));
  }

  /**
   * Returns the unique role ID created by the testing framework.
   */
  public function getNewRoleID($account) {
    $roles = $account->roles;
    $allroles = user_roles();
    foreach ($roles as $id => $name) {
      if ($id != AccountInterface::ANONYMOUS_ROLE && $id != AccountInterface::AUTHENTICATED_ROLE) {
        $this
          ->assertTrue(isset($allroles[$id]) && $allroles[$id], 'Found a role for new user and it exists');
        return $id;
      }
    }
    $this
      ->fail('Did not find a new role for new user');
    return AccountInterface::ANONYMOUS_ROLE;
  }

  /**
   * Helper function: returns an array of last index times for items.
   *
   * @return
   *   Array whose keys are the internal Search by Page IDs for the items,
   *   and whose values are the last time the item was indexed by Search by
   *   Page.
   */
  public function getIndexTimes() {
    $times = [];
    return \Drupal::database()
      ->query('SELECT pid, last_index_time FROM {search_by_page_path}')
      ->fetchAllKeyed();
  }

  /**
   * Helper function: Verifies reindexing.
   *
   * Tests that one item was reindexed, and it was the oldest item, given
   * previous and current output from getIndexTimes(). Assumes, but does
   * not explicitly check, that the array keys are the same for the two
   * arrays.
   *
   * @param $prev
   *   Previous index times array.
   * @param $curr
   *   Current index times array.
   */
  public function verifyIndexCycling($prev, $curr) {
    $keys = array_keys($prev);
    $min_val = min($prev);
    $count = 0;
    foreach ($keys as $key) {
      if ($prev[$key] != $curr[$key]) {
        $count++;
        $this
          ->assertEqual($prev[$key], $min_val, "Item indexed was the oldest");
      }
    }
    $this
      ->assertEqual($count, 1, "Exactly one item was indexed");
  }

  /**
   * Implements hook_search_by_page_excerpt_match().
   *
   * For testing of the search_by_page_excerpt() function.
   */
  public function search_by_page_test_search_by_page_excerpt_match($key, $text, $offset, $boundary) {

    // Find the root form of the keyword -- in this simple example,
    // all but the last 3 characters.
    $key = mb_substr($key, 0, -3);
    if (mb_strlen($key) < 3) {
      return FALSE;
    }

    // Look for this modified key at the start of a word.
    $match = array();
    if (!preg_match('/' . $boundary . $key . '/iu', $text, $match, PREG_OFFSET_CAPTURE, $offset)) {

      // didn't match our modified key.
      return FALSE;
    }

    // If we get here, we have a match. Find the end of the word we
    // actually matched, so it can be highlighted.
    $pos = $match[0][1];
    if (preg_match('/' . $boundary . '/iu', $text, $match, PREG_OFFSET_CAPTURE, $pos + mb_strlen($key))) {
      $keyfound = mb_substr($text, $pos, $match[0][1] - $pos);
    }
    return array(
      'where' => $pos,
      'keyword' => $keyfound,
    );
  }

  /**
   * Implements hook_permission().
   *
   * Sets up permissions for this module.
   */
  public function search_by_page_test_permission() {
    return array(
      'view test private content' => array(
        'title' => 'View test private content',
      ),
    );
  }

  /**
   * Implements hook_node_access_records().
   *
   * Sets up node access for testing purposes. If a node is marked
   * "test_private", it is only available to users with
   * 'view test private content' permissions. Code taken form the
   * Node Access Example module on drupal.org.
   */
  public function search_by_page_test_node_access_records($node) {

    // Only restrict access to nodes marked private
    if ($node->test_private) {
      $grants = array();
      $grants[] = array(
        'realm' => 'search_by_page_test',
        'gid' => 888,
        'grant_view' => 1,
        'grant_update' => 0,
        'grant_delete' => 0,
        'priority' => 999,
      );
      return $grants;
    }
  }

  /**
   * Implements hook_node_grants().
   *
   * Sets up node access for testing purposes. If a node is marked
   * "test_private", it is only available to users with
   * 'view test private content' permissions. Code taken form the
   * Node Access Example module on drupal.org.
   */
  public function serch_by_page_test_node_grants($account, $op) {
    $grants = array();
    if ($op == 'view' && user_access('view test private content', $account)) {
      $grants['search_by_page_test'] = array(
        888,
      );
    }
    return $grants;
  }

  /**
   * Implements hook_node_load().
   *
   * Manage the "private" flag on nodes. Code taken form the
   * Node Access Example module on drupal.org.
   */
  public function search_by_page_test_node_load($nodes, $types) {
    $result = \Drupal::database()
      ->query('SELECT * FROM {search_by_page_test_access} WHERE nid IN(:nids)', array(
      ':nids' => array_keys($nodes),
    ))
      ->fetchAll();
    foreach ($result as $item) {
      $nodes[$item->nid]->test_private = $item->private;
    }
  }

  /**
   * Implements hook_node_delete().
   *
   * Manage the "private" flag on nodes. Code taken form the
   * Node Access Example module on drupal.org.
   */
  public function search_by_page_test_node_delete($node) {
    \Drupal::database()
      ->delete('search_by_page_test_access')
      ->condition('nid', $node->nid)
      ->execute();
  }

  /**
   * Implements hook_node_insert().
   *
   * Manage the "private" flag on nodes. Code taken form the
   * Node Access Example module on drupal.org.
   */
  public function search_by_page_test_node_insert($node) {

    // Make sure we are saving an integer for this field!
    if (isset($node->test_private) && $node->test_private) {
      $node->test_private = 1;
    }
    else {
      $node->test_private = 0;
    }
    \Drupal::database()
      ->insert('search_by_page_test_access')
      ->fields(array(
      'nid' => $node->nid,
      'private' => $node->test_private,
    ))
      ->execute();
  }

  /**
   * Implements hook_node_update().
   *
   * Manage the "private" flag on nodes. Code taken form the
   * Node Access Example module on drupal.org.
   */
  public function search_by_page_test_node_update($node) {

    // Make sure we are saving an integer for this field!
    if (isset($node->test_private) && $node->test_private) {
      $node->test_private = 1;
    }
    else {
      $node->test_private = 0;
    }
    \Drupal::database()
      ->update('search_by_page_test_access')
      ->fields(array(
      'private' => $node->test_private,
    ))
      ->condition('nid', $node->nid)
      ->execute();
  }

  /**
   * Implements hook_node_info().
   *
   * Defines two node types, so that they can be set up for searching or not
   * searching.
   */
  public function search_by_page_test_node_info() {
    return array(
      'search_by_page_indexed' => array(
        'name' => t('SBP Indexed'),
        'base' => 'search_by_page_test',
        'description' => t('Content to be indexed for searching in tests'),
        'has_title' => TRUE,
      ),
      'search_by_page_hidden' => array(
        'name' => t('SBP Hidden'),
        'base' => 'search_by_page_test',
        'description' => t('Content not to be indexed for searching in tests'),
        'has_title' => TRUE,
      ),
    );
  }

  /**
   * Implements hook_form().
   */
  public function search_by_page_test_form($node, $form_state) {
    return node_content_form($node, $form_state);
  }

  /**
   * Implements hook_menu().
   *
   * Sets up pages that can be rendered and searched.
   */
  public function search_by_page_test_menu() {
    $items = array();
    $items['search_by_page_test_priv_page'] = array(
      'title' => 'Search by Page private page',
      'description' => 'Test content',
      'page callback' => 'search_by_page_test_make_priv_page',
      'access arguments' => array(
        'view test private content',
      ),
      'type' => MENU_SUGGESTED_ITEM,
    );
    $items['search_by_page_test_pub_page'] = array(
      'title' => 'Search by Page public page',
      'description' => 'Test content',
      'page callback' => 'search_by_page_test_make_pub_page',
      'access arguments' => array(
        'access content',
      ),
      'type' => MENU_SUGGESTED_ITEM,
    );
    $items['search_by_page_test_another_page'] = array(
      'title' => 'Search by Page another Page',
      'description' => 'Test content',
      'page callback' => 'search_by_page_test_make_another_page',
      'access arguments' => array(
        'access content',
      ),
      'type' => MENU_SUGGESTED_ITEM,
    );
    $items['search_by_page_test_queried_page'] = array(
      'title' => 'Search by Page queried Page',
      'description' => 'Test content',
      'page callback' => 'search_by_page_test_make_queried_page',
      'access arguments' => array(
        'access content',
      ),
      'type' => MENU_SUGGESTED_ITEM,
    );
    $items['search_by_page_test_exclude_page'] = array(
      'title' => 'Search by Page exclude Page',
      'description' => 'Test content',
      'page callback' => 'search_by_page_test_make_exclude_page',
      'access arguments' => array(
        'access content',
      ),
      'type' => MENU_SUGGESTED_ITEM,
    );
    $items['search_by_page_test_output_page'] = array(
      'title' => 'Search by Page output Page',
      'description' => 'Test content',
      'page callback' => 'search_by_page_test_make_output_page',
      'access arguments' => array(
        'access content',
      ),
      'type' => MENU_SUGGESTED_ITEM,
    );
    return $items;
  }

  /**
   * Page callback function for path 'search_by_page_test_priv_page'.
   */
  public function search_by_page_test_make_priv_page() {
    return '<h2>' . t('Trees') . '</h2>' . '<ul>' . '<li>' . t('Pine') . '</li>' . '<li>' . t('Spruce') . '</li>' . '</ul>';
  }

  /**
   * Page callback function for path 'search_by_page_test_pub_page'.
   */
  public function search_by_page_test_make_pub_page() {
    return '<h2>' . t('Trees') . '</h2>' . '<ul>' . '<li>' . t('Oak') . '</li>' . '<li>' . t('Maple') . '</li>' . '</ul>';
  }

  /**
   * Page callback function for path 'search_by_page_test_another_page'.
   */
  public function search_by_page_test_make_another_page() {
    return '<h2>' . t('Trees') . '</h2>' . '<ul>' . '<li>' . t('Apple') . '</li>' . '<li>' . t('Pear') . '</li>' . '</ul>';
  }

  /**
   * Page callback function for path 'search_by_page_test_output_page'.
   *
   * This page intentionally does some things designed to screw up the
   * Search by Page output:
   * - Sets the page title.
   * - Sets the breadcrumb.
   * - Sets the active trail.
   * - Prints some output instead of just returning output.
   */
  public function search_by_page_test_make_output_page() {
    drupal_set_title('wrong page title');
    print "wrong information printed";
    drupal_set_breadcrumb(array(
      l('wrong breadcrumb', '<front>'),
      l('wrong breadcrumb 2', 'search_by_page_test_pub_page'),
    ));
    $trail = menu_get_active_trail();
    $i = 1;
    foreach ($trail as $item) {
      $item['title'] = "wrong trail {$i}";
      $i++;
    }
    menu_set_active_trail($trail);
    return '<h2>' . t('Trees') . '</h2>' . '<ul>' . '<li>' . t('Apple') . '</li>' . '<li>' . t('Pear') . '</li>' . '</ul>';
  }

  /**
   * Page callback function for path 'search_by_page_test_queried_page'.
   */
  public function search_by_page_test_make_queried_page() {

    // Print out different text depending on the value of the query arg.
    $value = $_GET['a'];
    $text = $value == 3 ? t('three') : t('four');
    return '<p>' . $text . '</p>' . '<h2>' . t('Trees') . '</h2>' . '<ul>' . '<li>' . t('Walnut') . '</li>' . '<li>' . t('Hazelnut') . '</li>' . '</ul>';
  }

  /**
   * Page callback function for path 'search_by_page_test_exclude_page'.
   */
  public function search_by_page_test_make_exclude_page() {
    return '<h2>' . t('Trees') . '</h2>' . '<tagtoexclude><ul>' . '<li>' . t('Poplar') . '</li>' . '</ul></tagtoexclude><p>Cottonwood</p>';
  }

  /**
   * Implements MODULE_preprocess_HOOK() for search-result.tpl.php.
   *
   * Makes sure the 'type' is displayed, so that the internationalization
   * test can verify it's translated.
   */
  public function search_by_page_test_preprocess_search_result(&$variables) {
    if (isset($variables['result']['type'])) {
      $variables['info_split']['type'] = Html::escape($variables['result']['type']);
      $variables['info'] = implode(' - ', $variables['info_split']);
    }
  }

  /**
   * Implements hook_block_info().
   *
   * Sets up two test blocks.
   */
  public function search_by_page_test_block_info() {
    return array(
      'cat' => array(
        'info' => t('Pet block 1'),
      ),
      'dog' => array(
        'info' => t('Pet block 2'),
      ),
    );
  }

  /**
   * Implements hook_block_view().
   *
   * @see search_by_page_test_block_info()
   */
  public function search_by_page_test_block_view($delta = '') {
    $text = Html::escape($delta);
    return array(
      'subject' => ucfirst($text) . ' title',
      'content' => $text . ' block body',
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SearchByPageTesterTest::$envinfo1 public property
SearchByPageTesterTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 1
SearchByPageTesterTest::doCronRun public function Updates the search index.
SearchByPageTesterTest::getIndexTimes public function Helper function: returns an array of last index times for items.
SearchByPageTesterTest::getNewRoleID public function Returns the unique role ID created by the testing framework.
SearchByPageTesterTest::LANGUAGE_NONE constant 15
SearchByPageTesterTest::searchPerm public function Returns the permission name to search the given search environment.
SearchByPageTesterTest::search_by_page_test_block_info public function Implements hook_block_info().
SearchByPageTesterTest::search_by_page_test_block_view public function Implements hook_block_view().
SearchByPageTesterTest::search_by_page_test_form public function Implements hook_form().
SearchByPageTesterTest::search_by_page_test_make_another_page public function Page callback function for path 'search_by_page_test_another_page'.
SearchByPageTesterTest::search_by_page_test_make_exclude_page public function Page callback function for path 'search_by_page_test_exclude_page'.
SearchByPageTesterTest::search_by_page_test_make_output_page public function Page callback function for path 'search_by_page_test_output_page'.
SearchByPageTesterTest::search_by_page_test_make_priv_page public function Page callback function for path 'search_by_page_test_priv_page'.
SearchByPageTesterTest::search_by_page_test_make_pub_page public function Page callback function for path 'search_by_page_test_pub_page'.
SearchByPageTesterTest::search_by_page_test_make_queried_page public function Page callback function for path 'search_by_page_test_queried_page'.
SearchByPageTesterTest::search_by_page_test_menu public function Implements hook_menu().
SearchByPageTesterTest::search_by_page_test_node_access_records public function Implements hook_node_access_records().
SearchByPageTesterTest::search_by_page_test_node_delete public function Implements hook_node_delete().
SearchByPageTesterTest::search_by_page_test_node_info public function Implements hook_node_info().
SearchByPageTesterTest::search_by_page_test_node_insert public function Implements hook_node_insert().
SearchByPageTesterTest::search_by_page_test_node_load public function Implements hook_node_load().
SearchByPageTesterTest::search_by_page_test_node_update public function Implements hook_node_update().
SearchByPageTesterTest::search_by_page_test_permission public function Implements hook_permission().
SearchByPageTesterTest::search_by_page_test_preprocess_search_result public function Implements MODULE_preprocess_HOOK() for search-result.tpl.php.
SearchByPageTesterTest::search_by_page_test_search_by_page_excerpt_match public function Implements hook_search_by_page_excerpt_match().
SearchByPageTesterTest::serch_by_page_test_node_grants public function Implements hook_node_grants().
SearchByPageTesterTest::setUp protected function Overrides BrowserTestBase::setUp 15
SearchByPageTesterTest::setUpEnvironments public function Creates two environments for Search by Page.
SearchByPageTesterTest::verifyIndexCycling public function Helper function: Verifies reindexing.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.