You are here

Home » API reference » Zircon Profile 8.0 » DbLogTest.php

class DbLogTest in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/dblog/src/Tests/DbLogTest.php \Drupal\dblog\Tests\DbLogTest

Generate events and verify dblog entries; verify user access to log reports based on permissions.

@group dblog

Hierarchy

Expanded class hierarchy of DbLogTest

File

core/modules/dblog/src/Tests/DbLogTest.php, line 23
Contains \Drupal\dblog\Tests\DbLogTest.

Namespace

Drupal\dblog\Tests
View source 
class DbLogTest extends WebTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'dblog',
    'node',
    'forum',
    'help',
    'block',
  );

  /**
   * A user with some relevant administrative permissions.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * A user without any permissions.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $webUser;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalPlaceBlock('system_breadcrumb_block');
    $this
      ->drupalPlaceBlock('page_title_block');

    // Create users with specific permissions.
    $this->adminUser = $this
      ->drupalCreateUser(array(
      'administer site configuration',
      'access administration pages',
      'access site reports',
      'administer users',
    ));
    $this->webUser = $this
      ->drupalCreateUser(array());
  }

  /**
   * Tests Database Logging module functionality through interfaces.
   *
   * First logs in users, then creates database log events, and finally tests
   * Database Logging module functionality through both the admin and user
   * interfaces.
   */
  function testDbLog() {

    // Login the admin user.
    $this
      ->drupalLogin($this->adminUser);
    $row_limit = 100;
    $this
      ->verifyRowLimit($row_limit);
    $this
      ->verifyCron($row_limit);
    $this
      ->verifyEvents();
    $this
      ->verifyReports();
    $this
      ->verifyBreadcrumbs();
    $this
      ->verifyLinkEscaping();

    // Verify the overview table sorting.
    $orders = array(
      'Date',
      'Type',
      'User',
    );
    $sorts = array(
      'asc',
      'desc',
    );
    foreach ($orders as $order) {
      foreach ($sorts as $sort) {
        $this
          ->verifySort($sort, $order);
      }
    }

    // Login the regular user.
    $this
      ->drupalLogin($this->webUser);
    $this
      ->verifyReports(403);
  }

  /**
   * Verifies setting of the database log row limit.
   *
   * @param int $row_limit
   *   The row limit.
   */
  private function verifyRowLimit($row_limit) {

    // Change the database log row limit.
    $edit = array();
    $edit['dblog_row_limit'] = $row_limit;
    $this
      ->drupalPostForm('admin/config/development/logging', $edit, t('Save configuration'));
    $this
      ->assertResponse(200);

    // Check row limit variable.
    $current_limit = $this
      ->config('dblog.settings')
      ->get('row_limit');
    $this
      ->assertTrue($current_limit == $row_limit, format_string('[Cache] Row limit variable of @count equals row limit of @limit', array(
      '@count' => $current_limit,
      '@limit' => $row_limit,
    )));
  }

  /**
   * Verifies that cron correctly applies the database log row limit.
   *
   * @param int $row_limit
   *   The row limit.
   */
  private function verifyCron($row_limit) {

    // Generate additional log entries.
    $this
      ->generateLogEntries($row_limit + 10);

    // Verify that the database log row count exceeds the row limit.
    $count = db_query('SELECT COUNT(wid) FROM {watchdog}')
      ->fetchField();
    $this
      ->assertTrue($count > $row_limit, format_string('Dblog row count of @count exceeds row limit of @limit', array(
      '@count' => $count,
      '@limit' => $row_limit,
    )));

    // Run a cron job.
    $this
      ->cronRun();

    // Verify that the database log row count equals the row limit plus one
    // because cron adds a record after it runs.
    $count = db_query('SELECT COUNT(wid) FROM {watchdog}')
      ->fetchField();
    $this
      ->assertTrue($count == $row_limit + 1, format_string('Dblog row count of @count equals row limit of @limit plus one', array(
      '@count' => $count,
      '@limit' => $row_limit,
    )));
  }

  /**
   * Generates a number of random database log events.
   *
   * @param int $count
   *   Number of watchdog entries to generate.
   * @param array $options
   *   These options are used to override the defaults for the test.
   *   An associative array containing any of the following keys:
   *   - 'channel': String identifying the log channel to be output to.
   *     If the channel is not set, the default of 'custom' will be used.
   *   - 'message': String containing a message to be output to the log.
   *     A simple default message is used if not provided.
   *   - 'variables': Array of variables that match the message string.
   *   - 'severity': Log severity level as defined in logging_severity_levels.
   *   - 'link': String linking to view the result of the event.
   *   - 'user': String identifying the username.
   *   - 'uid': Int identifying the user id for the user.
   *   - 'request_uri': String identifying the location of the request.
   *   - 'referer': String identifying the referring url.
   *   - 'ip': String The ip address of the client machine triggering the log
   *     entry.
   *   - 'timestamp': Int unix timestamp.
   */
  private function generateLogEntries($count, $options = array()) {
    global $base_root;

    // Make it just a little bit harder to pass the link part of the test.
    $link = urldecode('/content/xo%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A%E9%85%B1%E5%87%89%E6%8B%8C%E7%B4%A0%E9%B8%A1%E7%85%A7%E7%83%A7%E9%B8%A1%E9%BB%84%E7%8E%AB%E7%91%B0-%E7%A7%91%E5%B7%9E%E7%9A%84%E5%B0%8F%E4%B9%9D%E5%AF%A8%E6%B2%9F%E7%BB%9D%E7%BE%8E%E9%AB%98%E5%B1%B1%E6%B9%96%E6%B3%8A-lake-isabelle');

    // Prepare the fields to be logged
    $log = $options + array(
      'channel' => 'custom',
      'message' => 'Dblog test log message',
      'variables' => array(),
      'severity' => RfcLogLevel::NOTICE,
      'link' => $link,
      'user' => $this->adminUser,
      'uid' => $this->adminUser
        ->id(),
      'request_uri' => $base_root . \Drupal::request()
        ->getRequestUri(),
      'referer' => \Drupal::request()->server
        ->get('HTTP_REFERER'),
      'ip' => '127.0.0.1',
      'timestamp' => REQUEST_TIME,
    );
    $logger = $this->container
      ->get('logger.dblog');
    $message = $log['message'] . ' Entry #';
    for ($i = 0; $i < $count; $i++) {
      $log['message'] = $message . $i;
      $logger
        ->log($log['severity'], $log['message'], $log);
    }
  }

  /**
   * Confirms that database log reports are displayed at the correct paths.
   *
   * @param int $response
   *   (optional) HTTP response code. Defaults to 200.
   */
  private function verifyReports($response = 200) {

    // View the database log help page.
    $this
      ->drupalGet('admin/help/dblog');
    $this
      ->assertResponse($response);
    if ($response == 200) {
      $this
        ->assertText(t('Database Logging'), 'DBLog help was displayed');
    }

    // View the database log report page.
    $this
      ->drupalGet('admin/reports/dblog');
    $this
      ->assertResponse($response);
    if ($response == 200) {
      $this
        ->assertText(t('Recent log messages'), 'DBLog report was displayed');
    }

    // View the database log page-not-found report page.
    $this
      ->drupalGet('admin/reports/page-not-found');
    $this
      ->assertResponse($response);
    if ($response == 200) {
      $this
        ->assertText("Top 'page not found' errors", 'DBLog page-not-found report was displayed');
    }

    // View the database log access-denied report page.
    $this
      ->drupalGet('admin/reports/access-denied');
    $this
      ->assertResponse($response);
    if ($response == 200) {
      $this
        ->assertText("Top 'access denied' errors", 'DBLog access-denied report was displayed');
    }

    // View the database log event page.
    $wid = db_query('SELECT MIN(wid) FROM {watchdog}')
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $this
      ->assertResponse($response);
    if ($response == 200) {
      $this
        ->assertText(t('Details'), 'DBLog event node was displayed');
    }
  }

  /**
   * Generates and then verifies breadcrumbs.
   */
  private function verifyBreadcrumbs() {

    // View the database log event page.
    $wid = db_query('SELECT MIN(wid) FROM {watchdog}')
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $xpath = '//nav[@class="breadcrumb"]/ol/li[last()]/a';
    $this
      ->assertEqual(current($this
      ->xpath($xpath)), 'Recent log messages', 'DBLogs link displayed at breadcrumb in event page.');
  }

  /**
   * Generates and then verifies various types of events.
   */
  private function verifyEvents() {

    // Invoke events.
    $this
      ->doUser();
    $this
      ->drupalCreateContentType(array(
      'type' => 'article',
      'name' => t('Article'),
    ));
    $this
      ->drupalCreateContentType(array(
      'type' => 'page',
      'name' => t('Basic page'),
    ));
    $this
      ->doNode('article');
    $this
      ->doNode('page');
    $this
      ->doNode('forum');

    // When a user account is canceled, any content they created remains but the
    // uid = 0. Records in the watchdog table related to that user have the uid
    // set to zero.
  }

  /**
   * Verifies the sorting functionality of the database logging reports table.
   *
   * @param string $sort
   *   The sort direction.
   * @param string $order
   *   The order by which the table should be sorted.
   */
  public function verifySort($sort = 'asc', $order = 'Date') {
    $this
      ->drupalGet('admin/reports/dblog', array(
      'query' => array(
        'sort' => $sort,
        'order' => $order,
      ),
    ));
    $this
      ->assertResponse(200);
    $this
      ->assertText(t('Recent log messages'), 'DBLog report was displayed correctly and sorting went fine.');
  }

  /**
   * Tests the escaping of links in the operation row of a database log detail
   * page.
   */
  private function verifyLinkEscaping() {
    $link = \Drupal::l('View', Url::fromRoute('entity.node.canonical', array(
      'node' => 1,
    )));
    $message = 'Log entry added to do the verifyLinkEscaping test.';
    $this
      ->generateLogEntries(1, array(
      'message' => $message,
      'link' => $link,
    ));
    $result = db_query_range('SELECT wid FROM {watchdog} ORDER BY wid DESC', 0, 1);
    $this
      ->drupalGet('admin/reports/dblog/event/' . $result
      ->fetchField());

    // Check if the link exists (unescaped).
    $this
      ->assertRaw($link);
  }

  /**
   * Generates and then verifies some user events.
   */
  private function doUser() {

    // Set user variables.
    $name = $this
      ->randomMachineName();
    $pass = user_password();

    // Add a user using the form to generate an add user event (which is not
    // triggered by drupalCreateUser).
    $edit = array();
    $edit['name'] = $name;
    $edit['mail'] = $name . '@example.com';
    $edit['pass[pass1]'] = $pass;
    $edit['pass[pass2]'] = $pass;
    $edit['status'] = 1;
    $this
      ->drupalPostForm('admin/people/create', $edit, t('Create new account'));
    $this
      ->assertResponse(200);

    // Retrieve the user object.
    $user = user_load_by_name($name);
    $this
      ->assertTrue($user != NULL, format_string('User @name was loaded', array(
      '@name' => $name,
    )));

    // pass_raw property is needed by drupalLogin.
    $user->pass_raw = $pass;

    // Login user.
    $this
      ->drupalLogin($user);

    // Logout user.
    $this
      ->drupalLogout();

    // Fetch the row IDs in watchdog that relate to the user.
    $result = db_query('SELECT wid FROM {watchdog} WHERE uid = :uid', array(
      ':uid' => $user
        ->id(),
    ));
    foreach ($result as $row) {
      $ids[] = $row->wid;
    }
    $count_before = isset($ids) ? count($ids) : 0;
    $this
      ->assertTrue($count_before > 0, format_string('DBLog contains @count records for @name', array(
      '@count' => $count_before,
      '@name' => $user
        ->getUsername(),
    )));

    // Login the admin user.
    $this
      ->drupalLogin($this->adminUser);

    // Delete the user created at the start of this test.
    // We need to POST here to invoke batch_process() in the internal browser.
    $this
      ->drupalPostForm('user/' . $user
      ->id() . '/cancel', array(
      'user_cancel_method' => 'user_cancel_reassign',
    ), t('Cancel account'));

    // View the database log report.
    $this
      ->drupalGet('admin/reports/dblog');
    $this
      ->assertResponse(200);

    // Verify that the expected events were recorded.
    // Add user.
    // Default display includes name and email address; if too long, the email
    // address is replaced by three periods.
    $this
      ->assertLogMessage(t('New user: %name %email.', array(
      '%name' => $name,
      '%email' => '<' . $user
        ->getEmail() . '>',
    )), 'DBLog event was recorded: [add user]');

    // Login user.
    $this
      ->assertLogMessage(t('Session opened for %name.', array(
      '%name' => $name,
    )), 'DBLog event was recorded: [login user]');

    // Logout user.
    $this
      ->assertLogMessage(t('Session closed for %name.', array(
      '%name' => $name,
    )), 'DBLog event was recorded: [logout user]');

    // Delete user.
    $message = t('Deleted user: %name %email.', array(
      '%name' => $name,
      '%email' => '<' . $user
        ->getEmail() . '>',
    ));
    $message_text = Unicode::truncate(Html::decodeEntities(strip_tags($message)), 56, TRUE, TRUE);

    // Verify that the full message displays on the details page.
    $link = FALSE;
    if ($links = $this
      ->xpath('//a[text()="' . $message_text . '"]')) {

      // Found link with the message text.
      $links = array_shift($links);
      foreach ($links
        ->attributes() as $attr => $value) {
        if ($attr == 'href') {

          // Extract link to details page.
          $link = Unicode::substr($value, strpos($value, 'admin/reports/dblog/event/'));
          $this
            ->drupalGet($link);

          // Check for full message text on the details page.
          $this
            ->assertRaw($message, 'DBLog event details was found: [delete user]');
          break;
        }
      }
    }
    $this
      ->assertTrue($link, 'DBLog event was recorded: [delete user]');

    // Visit random URL (to generate page not found event).
    $not_found_url = $this
      ->randomMachineName(60);
    $this
      ->drupalGet($not_found_url);
    $this
      ->assertResponse(404);

    // View the database log page-not-found report page.
    $this
      ->drupalGet('admin/reports/page-not-found');
    $this
      ->assertResponse(200);

    // Check that full-length URL displayed.
    $this
      ->assertText($not_found_url, 'DBLog event was recorded: [page not found]');
  }

  /**
   * Generates and then verifies some node events.
   *
   * @param string $type
   *   A node type (e.g., 'article', 'page' or 'forum').
   */
  private function doNode($type) {

    // Create user.
    $perm = array(
      'create ' . $type . ' content',
      'edit own ' . $type . ' content',
      'delete own ' . $type . ' content',
    );
    $user = $this
      ->drupalCreateUser($perm);

    // Login user.
    $this
      ->drupalLogin($user);

    // Create a node using the form in order to generate an add content event
    // (which is not triggered by drupalCreateNode).
    $edit = $this
      ->getContent($type);
    $title = $edit['title[0][value]'];
    $this
      ->drupalPostForm('node/add/' . $type, $edit, t('Save'));
    $this
      ->assertResponse(200);

    // Retrieve the node object.
    $node = $this
      ->drupalGetNodeByTitle($title);
    $this
      ->assertTrue($node != NULL, format_string('Node @title was loaded', array(
      '@title' => $title,
    )));

    // Edit the node.
    $edit = $this
      ->getContentUpdate($type);
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, t('Save'));
    $this
      ->assertResponse(200);

    // Delete the node.
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/delete', array(), t('Delete'));
    $this
      ->assertResponse(200);

    // View the node (to generate page not found event).
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertResponse(404);

    // View the database log report (to generate access denied event).
    $this
      ->drupalGet('admin/reports/dblog');
    $this
      ->assertResponse(403);

    // Login the admin user.
    $this
      ->drupalLogin($this->adminUser);

    // View the database log report.
    $this
      ->drupalGet('admin/reports/dblog');
    $this
      ->assertResponse(200);

    // Verify that node events were recorded.
    // Was node content added?
    $this
      ->assertLogMessage(t('@type: added %title.', array(
      '@type' => $type,
      '%title' => $title,
    )), 'DBLog event was recorded: [content added]');

    // Was node content updated?
    $this
      ->assertLogMessage(t('@type: updated %title.', array(
      '@type' => $type,
      '%title' => $title,
    )), 'DBLog event was recorded: [content updated]');

    // Was node content deleted?
    $this
      ->assertLogMessage(t('@type: deleted %title.', array(
      '@type' => $type,
      '%title' => $title,
    )), 'DBLog event was recorded: [content deleted]');

    // View the database log access-denied report page.
    $this
      ->drupalGet('admin/reports/access-denied');
    $this
      ->assertResponse(200);

    // Verify that the 'access denied' event was recorded.
    $this
      ->assertText('admin/reports/dblog', 'DBLog event was recorded: [access denied]');

    // View the database log page-not-found report page.
    $this
      ->drupalGet('admin/reports/page-not-found');
    $this
      ->assertResponse(200);

    // Verify that the 'page not found' event was recorded.
    $this
      ->assertText('node/' . $node
      ->id(), 'DBLog event was recorded: [page not found]');
  }

  /**
   * Creates random content based on node content type.
   *
   * @param string $type
   *   Node content type (e.g., 'article').
   *
   * @return array
   *   Random content needed by various node types.
   */
  private function getContent($type) {
    switch ($type) {
      case 'forum':
        $content = array(
          'title[0][value]' => $this
            ->randomMachineName(8),
          'taxonomy_forums' => array(
            1,
          ),
          'body[0][value]' => $this
            ->randomMachineName(32),
        );
        break;
      default:
        $content = array(
          'title[0][value]' => $this
            ->randomMachineName(8),
          'body[0][value]' => $this
            ->randomMachineName(32),
        );
        break;
    }
    return $content;
  }

  /**
   * Creates random content as an update based on node content type.
   *
   * @param string $type
   *   Node content type (e.g., 'article').
   *
   * @return array
   *   Random content needed by various node types.
   */
  private function getContentUpdate($type) {
    $content = array(
      'body[0][value]' => $this
        ->randomMachineName(32),
    );
    return $content;
  }

  /**
   * Tests the addition and clearing of log events through the admin interface.
   *
   * Logs in the admin user, creates a database log event, and tests the
   * functionality of clearing the database log through the admin interface.
   */
  public function testDBLogAddAndClear() {
    global $base_root;

    // Get a count of how many watchdog entries already exist.
    $count = db_query('SELECT COUNT(*) FROM {watchdog}')
      ->fetchField();
    $log = array(
      'channel' => 'system',
      'message' => 'Log entry added to test the doClearTest clear down.',
      'variables' => array(),
      'severity' => RfcLogLevel::NOTICE,
      'link' => NULL,
      'user' => $this->adminUser,
      'uid' => $this->adminUser
        ->id(),
      'request_uri' => $base_root . \Drupal::request()
        ->getRequestUri(),
      'referer' => \Drupal::request()->server
        ->get('HTTP_REFERER'),
      'ip' => '127.0.0.1',
      'timestamp' => REQUEST_TIME,
    );

    // Add a watchdog entry.
    $this->container
      ->get('logger.dblog')
      ->log($log['severity'], $log['message'], $log);

    // Make sure the table count has actually been incremented.
    $this
      ->assertEqual($count + 1, db_query('SELECT COUNT(*) FROM {watchdog}')
      ->fetchField(), format_string('\\Drupal\\dblog\\Logger\\DbLog->log() added an entry to the dblog :count', array(
      ':count' => $count,
    )));

    // Login the admin user.
    $this
      ->drupalLogin($this->adminUser);

    // Post in order to clear the database table.
    $this
      ->drupalPostForm('admin/reports/dblog', array(), t('Clear log messages'));

    // Confirm that the logs should be cleared.
    $this
      ->drupalPostForm(NULL, array(), 'Confirm');

    // Count the rows in watchdog that previously related to the deleted user.
    $count = db_query('SELECT COUNT(*) FROM {watchdog}')
      ->fetchField();
    $this
      ->assertEqual($count, 0, format_string('DBLog contains :count records after a clear.', array(
      ':count' => $count,
    )));
  }

  /**
   * Tests the database log filter functionality at admin/reports/dblog.
   */
  public function testFilter() {
    $this
      ->drupalLogin($this->adminUser);

    // Clear the log to ensure that only generated entries will be found.
    db_delete('watchdog')
      ->execute();

    // Generate 9 random watchdog entries.
    $type_names = array();
    $types = array();
    for ($i = 0; $i < 3; $i++) {
      $type_names[] = $type_name = $this
        ->randomMachineName();
      $severity = RfcLogLevel::EMERGENCY;
      for ($j = 0; $j < 3; $j++) {
        $types[] = $type = array(
          'count' => $j + 1,
          'type' => $type_name,
          'severity' => $severity++,
        );
        $this
          ->generateLogEntries($type['count'], array(
          'channel' => $type['type'],
          'severity' => $type['severity'],
        ));
      }
    }

    // View the database log page.
    $this
      ->drupalGet('admin/reports/dblog');

    // Confirm that all the entries are displayed.
    $count = $this
      ->getTypeCount($types);
    foreach ($types as $key => $type) {
      $this
        ->assertEqual($count[$key], $type['count'], 'Count matched');
    }

    // Filter by each type and confirm that entries with various severities are
    // displayed.
    foreach ($type_names as $type_name) {
      $edit = array(
        'type[]' => array(
          $type_name,
        ),
      );
      $this
        ->drupalPostForm(NULL, $edit, t('Filter'));

      // Count the number of entries of this type.
      $type_count = 0;
      foreach ($types as $type) {
        if ($type['type'] == $type_name) {
          $type_count += $type['count'];
        }
      }
      $count = $this
        ->getTypeCount($types);
      $this
        ->assertEqual(array_sum($count), $type_count, 'Count matched');
    }

    // Set the filter to match each of the two filter-type attributes and
    // confirm the correct number of entries are displayed.
    foreach ($types as $type) {
      $edit = array(
        'type[]' => array(
          $type['type'],
        ),
        'severity[]' => array(
          $type['severity'],
        ),
      );
      $this
        ->drupalPostForm(NULL, $edit, t('Filter'));
      $count = $this
        ->getTypeCount($types);
      $this
        ->assertEqual(array_sum($count), $type['count'], 'Count matched');
    }
    $this
      ->drupalGet('admin/reports/dblog', array(
      'query' => array(
        'order' => 'Type',
      ),
    ));
    $this
      ->assertResponse(200);
    $this
      ->assertText(t('Operations'), 'Operations text found');

    // Clear all logs and make sure the confirmation message is found.
    $this
      ->drupalPostForm('admin/reports/dblog', array(), t('Clear log messages'));

    // Confirm that the logs should be cleared.
    $this
      ->drupalPostForm(NULL, array(), 'Confirm');
    $this
      ->assertText(t('Database log cleared.'), 'Confirmation message found');
  }

  /**
   * Gets the database log event information from the browser page.
   *
   * @return array
   *   List of log events where each event is an array with following keys:
   *   - severity: (int) A database log severity constant.
   *   - type: (string) The type of database log event.
   *   - message: (string) The message for this database log event.
   *   - user: (string) The user associated with this database log event.
   */
  protected function getLogEntries() {
    $entries = array();
    if ($table = $this
      ->xpath('.//table[@id="admin-dblog"]')) {
      $table = array_shift($table);
      foreach ($table->tbody->tr as $row) {
        $entries[] = array(
          'severity' => $this
            ->getSeverityConstant($row['class']),
          'type' => $this
            ->asText($row->td[1]),
          'message' => $this
            ->asText($row->td[3]),
          'user' => $this
            ->asText($row->td[4]),
        );
      }
    }
    return $entries;
  }

  /**
   * Gets the count of database log entries by database log event type.
   *
   * @param array $types
   *   The type information to compare against.
   *
   * @return array
   *   The count of each type keyed by the key of the $types array.
   */
  protected function getTypeCount(array $types) {
    $entries = $this
      ->getLogEntries();
    $count = array_fill(0, count($types), 0);
    foreach ($entries as $entry) {
      foreach ($types as $key => $type) {
        if ($entry['type'] == $type['type'] && $entry['severity'] == $type['severity']) {
          $count[$key]++;
          break;
        }
      }
    }
    return $count;
  }

  /**
   * Gets the watchdog severity constant corresponding to the CSS class.
   *
   * @param string $class
   *   CSS class attribute.
   *
   * @return int|null
   *   The watchdog severity constant or NULL if not found.
   */
  protected function getSeverityConstant($class) {
    $map = array_flip(DbLogController::getLogLevelClassMap());

    // Find the class that contains the severity.
    $classes = explode(' ', $class);
    foreach ($classes as $class) {
      if (isset($map[$class])) {
        return $map[$class];
      }
    }
    return NULL;
  }

  /**
   * Extracts the text contained by the XHTML element.
   *
   * @param \SimpleXMLElement $element
   *   Element to extract text from.
   *
   * @return string
   *   Extracted text.
   */
  protected function asText(\SimpleXMLElement $element) {
    if (!is_object($element)) {
      return $this
        ->fail('The element is not an element.');
    }
    return trim(html_entity_decode(strip_tags($element
      ->asXML())));
  }

  /**
   * Confirms that a log message appears on the database log overview screen.
   *
   * This function should only be used for the admin/reports/dblog page, because
   * it checks for the message link text truncated to 56 characters. Other log
   * pages have no detail links so they contain the full message text.
   *
   * @param string $log_message
   *   The database log message to check.
   * @param string $message
   *   The message to pass to simpletest.
   */
  protected function assertLogMessage($log_message, $message) {
    $message_text = Unicode::truncate(Html::decodeEntities(strip_tags($log_message)), 56, TRUE, TRUE);
    $this
      ->assertLink($message_text, 0, $message);
  }

  /**
   * Tests that the details page displays correctly for a temporary user.
   */
  public function testTemporaryUser() {

    // Create a temporary user.
    $tempuser = $this
      ->drupalCreateUser();
    $tempuser_uid = $tempuser
      ->id();

    // Log in as the admin user.
    $this
      ->drupalLogin($this->adminUser);

    // Generate a single watchdog entry.
    $this
      ->generateLogEntries(1, array(
      'user' => $tempuser,
      'uid' => $tempuser_uid,
    ));
    $wid = db_query('SELECT MAX(wid) FROM {watchdog}')
      ->fetchField();

    // Check if the full message displays on the details page.
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $this
      ->assertText('Dblog test log message');

    // Delete the user.
    user_delete($tempuser
      ->id());
    $this
      ->drupalGet('user/' . $tempuser_uid);
    $this
      ->assertResponse(404);

    // Check if the full message displays on the details page.
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $this
      ->assertText('Dblog test log message');
  }

  /**
   * Make sure HTML tags are filtered out in the log overview links.
   */
  public function testOverviewLinks() {
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->generateLogEntries(1, [
      'message' => "&lt;script&gt;alert('foo');&lt;/script&gt;<strong>Lorem</strong> ipsum dolor sit amet, consectetur adipiscing & elit.",
    ]);
    $this
      ->drupalGet('admin/reports/dblog');
    $this
      ->assertResponse(200);

    // Make sure HTML tags are filtered out.
    $this
      ->assertRaw('title="alert(&#039;foo&#039;);Lorem ipsum dolor sit amet, consectetur adipiscing &amp; elit. Entry #0">&lt;script&gt;alert(&#039;foo&#039;);&lt;/script&gt;Lorem ipsum dolor sit…</a>');
    $this
      ->assertNoRaw("<script>alert('foo');</script>");
  }

}

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.
DbLogTest::$adminUser protected property A user with some relevant administrative permissions.
DbLogTest::$modules public static property Modules to enable.
DbLogTest::$webUser protected property A user without any permissions.
DbLogTest::assertLogMessage protected function Confirms that a log message appears on the database log overview screen.
DbLogTest::asText protected function Extracts the text contained by the XHTML element.
DbLogTest::doNode private function Generates and then verifies some node events.
DbLogTest::doUser private function Generates and then verifies some user events.
DbLogTest::generateLogEntries private function Generates a number of random database log events.
DbLogTest::getContent private function Creates random content based on node content type.
DbLogTest::getContentUpdate private function Creates random content as an update based on node content type.
DbLogTest::getLogEntries protected function Gets the database log event information from the browser page.
DbLogTest::getSeverityConstant protected function Gets the watchdog severity constant corresponding to the CSS class.
DbLogTest::getTypeCount protected function Gets the count of database log entries by database log event type.
DbLogTest::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp
DbLogTest::testDbLog function Tests Database Logging module functionality through interfaces.
DbLogTest::testDBLogAddAndClear public function Tests the addition and clearing of log events through the admin interface.
DbLogTest::testFilter public function Tests the database log filter functionality at admin/reports/dblog.
DbLogTest::testOverviewLinks public function Make sure HTML tags are filtered out in the log overview links.
DbLogTest::testTemporaryUser public function Tests that the details page displays correctly for a temporary user.
DbLogTest::verifyBreadcrumbs private function Generates and then verifies breadcrumbs.
DbLogTest::verifyCron private function Verifies that cron correctly applies the database log row limit.
DbLogTest::verifyEvents private function Generates and then verifies various types of events.
DbLogTest::verifyLinkEscaping private function Tests the escaping of links in the operation row of a database log detail page.
DbLogTest::verifyReports private function Confirms that database log reports are displayed at the correct paths.
DbLogTest::verifyRowLimit private function Verifies setting of the database log row limit.
DbLogTest::verifySort public function Verifies the sorting functionality of the database logging reports table.
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