You are here

class DbLogTest in Drupal 8

Same name in this branch
  1. 8 core/modules/dblog/tests/src/Functional/DbLogTest.php \Drupal\Tests\dblog\Functional\DbLogTest
  2. 8 core/modules/dblog/tests/src/Kernel/DbLogTest.php \Drupal\Tests\dblog\Kernel\DbLogTest
Same name and namespace in other branches
  1. 9 core/modules/dblog/tests/src/Functional/DbLogTest.php \Drupal\Tests\dblog\Functional\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/tests/src/Functional/DbLogTest.php, line 22

Namespace

Drupal\Tests\dblog\Functional
View source
class DbLogTest extends BrowserTestBase {
  use FakeLogEntries;

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

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * 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([
      'administer site configuration',
      'access administration pages',
      'access site reports',
      'administer users',
    ]);
    $this->webUser = $this
      ->drupalCreateUser([]);
  }

  /**
   * 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.
   */
  public function testDbLog() {

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

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

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

  /**
   * Test individual log event page.
   */
  public function testLogEventPage() {

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

    // Since referrer and location links vary by how the tests are run, inject
    // fake log data to test these.
    $context = [
      'request_uri' => 'http://example.com?dblog=1',
      'referer' => 'http://example.org?dblog=2',
      'uid' => 0,
      'channel' => 'testing',
      'link' => 'foo/bar',
      'ip' => '0.0.1.0',
      'timestamp' => REQUEST_TIME,
    ];
    \Drupal::service('logger.dblog')
      ->log(RfcLogLevel::NOTICE, 'Test message', $context);
    $query = Database::getConnection()
      ->select('watchdog');
    $query
      ->addExpression('MAX(wid)');
    $wid = $query
      ->execute()
      ->fetchField();

    // Verify the links appear correctly.
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $this
      ->assertLinkByHref($context['request_uri']);
    $this
      ->assertLinkByHref($context['referer']);

    // Verify hostname.
    $this
      ->assertRaw($context['ip'], 'Found hostname on the detail page.');

    // Verify location.
    $this
      ->assertRaw($context['request_uri'], 'Found location on the detail page.');

    // Verify severity.
    $this
      ->assertText('Notice', 'The severity was properly displayed on the detail page.');
  }

  /**
   * Tests that a 403 event is logged with the exception triggering it.
   */
  public function test403LogEventPage() {
    $assert_session = $this
      ->assertSession();
    $uri = 'admin/reports';
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet($uri);
    $assert_session
      ->statusCodeEquals(403);
    $this
      ->drupalLogin($this->adminUser);
    $query = Database::getConnection()
      ->select('watchdog')
      ->condition('type', 'access denied');
    $query
      ->addExpression('MAX(wid)');
    $wid = $query
      ->execute()
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $table = $this
      ->xpath("//table[@class='dblog-event']");
    $this
      ->assertCount(1, $table);

    // Verify type, severity and location.
    $type = $table[0]
      ->findAll('xpath', "//tr/th[contains(text(), 'Type')]/../td");
    $this
      ->assertCount(1, $type);
    $this
      ->assertEquals('access denied', $type[0]
      ->getText());
    $severity = $table[0]
      ->findAll('xpath', "//tr/th[contains(text(), 'Severity')]/../td");
    $this
      ->assertCount(1, $severity);
    $this
      ->assertEquals('Warning', $severity[0]
      ->getText());
    $location = $table[0]
      ->findAll('xpath', "//tr/th[contains(text(), 'Location')]/../td/a");
    $this
      ->assertCount(1, $location);
    $href = $location[0]
      ->getAttribute('href');
    $this
      ->assertEquals($this->baseUrl . '/' . $uri, $href);

    // Verify message.
    $message = $table[0]
      ->findAll('xpath', "//tr/th[contains(text(), 'Message')]/../td");
    $this
      ->assertCount(1, $message);
    $regex = "@Path: .+admin/reports\\. Drupal\\\\Core\\\\Http\\\\Exception\\\\CacheableAccessDeniedHttpException: The 'access site reports' permission is required\\. in Drupal\\\\Core\\\\Routing\\\\AccessAwareRouter->checkAccess\\(\\) \\(line \\d+ of .+/core/lib/Drupal/Core/Routing/AccessAwareRouter\\.php\\)\\.@";
    $this
      ->assertRegExp($regex, $message[0]
      ->getText());
  }

  /**
   * Test not-existing log event page.
   */
  public function testLogEventNotFoundPage() {

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

    // Try to read details of not existing event.
    $this
      ->drupalGet('admin/reports/dblog/event/999999');

    // Verify 404 response.
    $this
      ->assertSession()
      ->statusCodeEquals(404);
  }

  /**
   * Test individual log event page with missing log attributes.
   *
   * In some cases few log attributes are missing. For example:
   * - Missing referer: When request is made to a specific url directly and
   *   error occurred. In this case there is no referer.
   * - Incorrect location: When location attribute is incorrect uri which can
   *   not be used to generate a valid link.
   */
  public function testLogEventPageWithMissingInfo() {
    $this
      ->drupalLogin($this->adminUser);
    $connection = Database::getConnection();

    // Test log event page with missing referer.
    $this
      ->generateLogEntries(1, [
      'referer' => NULL,
    ]);
    $query = $connection
      ->select('watchdog');
    $query
      ->addExpression('MAX(wid)');
    $wid = $query
      ->execute()
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);

    // Verify table headers are present, even though the referrer is missing.
    $this
      ->assertText('Referrer', 'Referrer header is present on the detail page.');

    // Verify severity.
    $this
      ->assertText('Notice', 'The severity is properly displayed on the detail page.');

    // Test log event page with incorrect location.
    $request_uri = '/some/incorrect/url';
    $this
      ->generateLogEntries(1, [
      'request_uri' => $request_uri,
    ]);
    $query = $connection
      ->select('watchdog');
    $query
      ->addExpression('MAX(wid)');
    $wid = $query
      ->execute()
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);

    // Verify table headers are present.
    $this
      ->assertText('Location', 'Location header is present on the detail page.');

    // Verify severity.
    $this
      ->assertText('Notice', 'The severity is properly displayed on the detail page.');

    // Verify location is available as plain text.
    $this
      ->assertEquals($request_uri, $this
      ->cssSelect('table.dblog-event > tbody > tr:nth-child(4) > td')[0]
      ->getHtml());
    $this
      ->assertSession()
      ->linkNotExists($request_uri);
  }

  /**
   * 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 = [];
    $edit['dblog_row_limit'] = $row_limit;
    $this
      ->drupalPostForm('admin/config/development/logging', $edit, t('Save configuration'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);

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

  /**
   * Clear the entry logs by clicking on 'Clear log messages' button.
   */
  protected function clearLogsEntries() {
    $this
      ->drupalGet(Url::fromRoute('dblog.confirm'));
  }

  /**
   * Filters the logs according to the specific severity and log entry type.
   *
   * @param string $type
   *   (optional) The log entry type.
   * @param string $severity
   *   (optional) The log entry severity.
   */
  protected function filterLogsEntries($type = NULL, $severity = NULL) {
    $edit = [];
    if (isset($type)) {
      $edit['type[]'] = $type;
    }
    if (isset($severity)) {
      $edit['severity[]'] = $severity;
    }
    $this
      ->drupalPostForm(NULL, $edit, t('Filter'));
  }

  /**
   * 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
      ->assertSession()
      ->statusCodeEquals($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
      ->assertSession()
      ->statusCodeEquals($response);
    if ($response == 200) {
      $this
        ->assertText(t('Recent log messages'), 'DBLog report was displayed');
    }
    $this
      ->drupalGet('admin/reports/dblog/confirm');
    $this
      ->assertSession()
      ->statusCodeEquals($response);
    if ($response == 200) {
      $this
        ->assertText(t('Are you sure you want to delete the recent logs?'), 'DBLog clear logs form was displayed');
    }

    // View the database log page-not-found report page.
    $this
      ->drupalGet('admin/reports/page-not-found');
    $this
      ->assertSession()
      ->statusCodeEquals($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
      ->assertSession()
      ->statusCodeEquals($response);
    if ($response == 200) {
      $this
        ->assertText("Top 'access denied' errors", 'DBLog access-denied report was displayed');
    }

    // View the database log event page.
    $query = Database::getConnection()
      ->select('watchdog');
    $query
      ->addExpression('MIN(wid)');
    $wid = $query
      ->execute()
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $this
      ->assertSession()
      ->statusCodeEquals($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.
    $query = Database::getConnection()
      ->select('watchdog');
    $query
      ->addExpression('MIN(wid)');
    $wid = $query
      ->execute()
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $xpath = '//nav[@class="breadcrumb"]/ol/li[last()]/a';
    $this
      ->assertEqual(current($this
      ->xpath($xpath))
      ->getText(), '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([
      'type' => 'article',
      'name' => t('Article'),
    ]);
    $this
      ->drupalCreateContentType([
      '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', [
      'query' => [
        'sort' => $sort,
        'order' => $order,
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(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 = Link::fromTextAndUrl('View', Url::fromRoute('entity.node.canonical', [
      'node' => 1,
    ]))
      ->toString();
    $message = 'Log entry added to do the verifyLinkEscaping test.';
    $this
      ->generateLogEntries(1, [
      'message' => $message,
      'link' => $link,
    ]);
    $result = Database::getConnection()
      ->select('watchdog', 'w')
      ->fields('w', [
      'wid',
    ])
      ->orderBy('wid', 'DESC')
      ->range(0, 1)
      ->execute();
    $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 = [];
    $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
      ->assertSession()
      ->statusCodeEquals(200);

    // Retrieve the user object.
    $user = user_load_by_name($name);
    $this
      ->assertNotNull($user, new FormattableMarkup('User @name was loaded', [
      '@name' => $name,
    ]));

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

    // Log in user.
    $this
      ->drupalLogin($user);

    // Log out user.
    $this
      ->drupalLogout();

    // Fetch the row IDs in watchdog that relate to the user.
    $result = Database::getConnection()
      ->select('watchdog', 'w')
      ->fields('w', [
      'wid',
    ])
      ->condition('uid', $user
      ->id())
      ->execute();
    foreach ($result as $row) {
      $ids[] = $row->wid;
    }
    $count_before = isset($ids) ? count($ids) : 0;
    $this
      ->assertGreaterThan(0, $count_before, new FormattableMarkup('DBLog contains @count records for @name', [
      '@count' => $count_before,
      '@name' => $user
        ->getAccountName(),
    ]));

    // Log in 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', [
      'user_cancel_method' => 'user_cancel_reassign',
    ], t('Cancel account'));

    // View the database log report.
    $this
      ->drupalGet('admin/reports/dblog');
    $this
      ->assertSession()
      ->statusCodeEquals(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.', [
      '%name' => $name,
      '%email' => '<' . $user
        ->getEmail() . '>',
    ]), 'DBLog event was recorded: [add user]');

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

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

    // Delete user.
    $message = t('Deleted user: %name %email.', [
      '%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);
      $value = $links
        ->getAttribute('href');

      // Extract link to details page.
      $link = mb_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]');
    }
    $this
      ->assertNotEmpty($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
      ->assertSession()
      ->statusCodeEquals(404);

    // View the database log page-not-found report page.
    $this
      ->drupalGet('admin/reports/page-not-found');
    $this
      ->assertSession()
      ->statusCodeEquals(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 = [
      'create ' . $type . ' content',
      'edit own ' . $type . ' content',
      'delete own ' . $type . ' content',
    ];
    $user = $this
      ->drupalCreateUser($perm);

    // Log in 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
      ->assertSession()
      ->statusCodeEquals(200);

    // Retrieve the node object.
    $node = $this
      ->drupalGetNodeByTitle($title);
    $this
      ->assertNotNull($node, new FormattableMarkup('Node @title was loaded', [
      '@title' => $title,
    ]));

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

    // Delete the node.
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/delete', [], t('Delete'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);

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

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

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

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

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

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

    // Was node content deleted?
    $this
      ->assertLogMessage(t('@type: deleted %title.', [
      '@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
      ->assertSession()
      ->statusCodeEquals(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
      ->assertSession()
      ->statusCodeEquals(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 = [
          'title[0][value]' => $this
            ->randomMachineName(8),
          'taxonomy_forums' => 1,
          'body[0][value]' => $this
            ->randomMachineName(32),
        ];
        break;
      default:
        $content = [
          '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 = [
      '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;
    $connection = Database::getConnection();

    // Get a count of how many watchdog entries already exist.
    $count = $connection
      ->select('watchdog')
      ->countQuery()
      ->execute()
      ->fetchField();
    $log = [
      'channel' => 'system',
      'message' => 'Log entry added to test the doClearTest clear down.',
      'variables' => [],
      'severity' => RfcLogLevel::NOTICE,
      'link' => NULL,
      '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, (int) $connection
      ->select('watchdog')
      ->countQuery()
      ->execute()
      ->fetchField(), new FormattableMarkup('\\Drupal\\dblog\\Logger\\DbLog->log() added an entry to the dblog :count', [
      ':count' => $count,
    ]));

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

    // Post in order to clear the database table.
    $this
      ->clearLogsEntries();

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

    // Count the rows in watchdog that previously related to the deleted user.
    $count = $connection
      ->select('watchdog')
      ->countQuery()
      ->execute()
      ->fetchField();
    $this
      ->assertEqual($count, 0, new FormattableMarkup('DBLog contains :count records after a clear.', [
      ':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.
    Database::getConnection()
      ->delete('watchdog')
      ->execute();

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

      // 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) {
      $this
        ->filterLogsEntries($type['type'], $type['severity']);
      $count = $this
        ->getTypeCount($types);
      $this
        ->assertEqual(array_sum($count), $type['count'], 'Count matched');
    }
    $this
      ->drupalGet('admin/reports/dblog', [
      'query' => [
        'order' => 'Type',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertText(t('Operations'), 'Operations text found');

    // Clear all logs and make sure the confirmation message is found.
    $this
      ->clearLogsEntries();

    // Confirm that the logs should be cleared.
    $this
      ->drupalPostForm(NULL, [], '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 = [];
    if ($table = $this
      ->getLogsEntriesTable()) {
      foreach ($table as $row) {
        $cells = $row
          ->findAll('css', 'td');
        $entries[] = [
          'severity' => $this
            ->getSeverityConstant($row
            ->getAttribute('class')),
          'type' => $cells[1]
            ->getText(),
          'message' => $cells[3]
            ->getText(),
          'user' => $cells[4]
            ->getText(),
        ];
      }
    }
    return $entries;
  }

  /**
   * Find the Logs table in the DOM.
   *
   * @return \SimpleXMLElement[]
   *   The return value of a xpath search.
   */
  protected function getLogsEntriesTable() {
    return $this
      ->xpath('.//table[@id="admin-dblog"]/tbody/tr');
  }

  /**
   * 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;
  }

  /**
   * 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
      ->assertSession()
      ->linkExists($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, [
      'user' => $tempuser,
      'uid' => $tempuser_uid,
    ]);
    $query = Database::getConnection()
      ->select('watchdog');
    $query
      ->addExpression('MAX(wid)');
    $wid = $query
      ->execute()
      ->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.
    $tempuser
      ->delete();
    $this
      ->drupalGet('user/' . $tempuser_uid);
    $this
      ->assertSession()
      ->statusCodeEquals(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
      ->assertSession()
      ->statusCodeEquals(200);

    // Make sure HTML tags are filtered out.
    $this
      ->assertRaw('title="alert(&#039;foo&#039;);Lorem');
    $this
      ->assertNoRaw("<script>alert('foo');</script>");

    // Make sure HTML tags are filtered out in admin/reports/dblog/event/ too.
    $this
      ->generateLogEntries(1, [
      'message' => "<script>alert('foo');</script> <strong>Lorem ipsum</strong>",
    ]);
    $query = Database::getConnection()
      ->select('watchdog');
    $query
      ->addExpression('MAX(wid)');
    $wid = $query
      ->execute()
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $this
      ->assertNoRaw("<script>alert('foo');</script>");
    $this
      ->assertRaw("alert('foo'); <strong>Lorem ipsum</strong>");
  }

  /**
   * Test sorting for entries with the same timestamp.
   */
  public function testSameTimestampEntries() {
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->generateLogEntries(1, [
      'timestamp' => 1498062000,
      'type' => 'same_time',
      'message' => 'First',
    ]);
    $this
      ->generateLogEntries(1, [
      'timestamp' => 1498062000,
      'type' => 'same_time',
      'message' => 'Second',
    ]);
    $this
      ->generateLogEntries(1, [
      'timestamp' => 1498062000,
      'type' => 'same_time',
      'message' => 'Third',
    ]);
    $this
      ->drupalGet('admin/reports/dblog');
    $entries = $this
      ->getLogEntries();
    $this
      ->assertEquals($entries[0]['message'], 'Third Entry #0');
    $this
      ->assertEquals($entries[1]['message'], 'Second Entry #0');
    $this
      ->assertEquals($entries[2]['message'], 'First Entry #0');
  }

  /**
   * Tests that the details page displays correctly backtrace.
   */
  public function testBacktrace() {
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('/error-test/generate-warnings');
    $query = Database::getConnection()
      ->select('watchdog');
    $query
      ->addExpression('MAX(wid)');
    $wid = $query
      ->execute()
      ->fetchField();
    $this
      ->drupalGet('admin/reports/dblog/event/' . $wid);
    $error_user_notice = [
      '%type' => 'User warning',
      '@message' => 'Drupal & awesome',
      '%function' => ErrorTestController::class . '->generateWarnings()',
      '%file' => drupal_get_path('module', 'error_test') . '/error_test.module',
    ];

    // Check if the full message displays on the details page and backtrace is a
    // pre-formatted text.
    $message = new FormattableMarkup('%type: @message in %function (line', $error_user_notice);
    $this
      ->assertRaw($message);
    $this
      ->assertRaw('<pre class="backtrace">');
  }

}

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::$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
DbLogTest::$adminUser protected property A user with some relevant administrative permissions.
DbLogTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 1
DbLogTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 1
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::clearLogsEntries protected function Clear the entry logs by clicking on 'Clear log messages' button.
DbLogTest::doNode private function Generates and then verifies some node events.
DbLogTest::doUser private function Generates and then verifies some user events.
DbLogTest::filterLogsEntries protected function Filters the logs according to the specific severity and log entry type. 1
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::getLogsEntriesTable protected function Find the Logs table in the DOM. 1
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 Overrides BrowserTestBase::setUp
DbLogTest::test403LogEventPage public function Tests that a 403 event is logged with the exception triggering it.
DbLogTest::testBacktrace public function Tests that the details page displays correctly backtrace.
DbLogTest::testDbLog public 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::testLogEventNotFoundPage public function Test not-existing log event page.
DbLogTest::testLogEventPage public function Test individual log event page.
DbLogTest::testLogEventPageWithMissingInfo public function Test individual log event page with missing log attributes.
DbLogTest::testOverviewLinks public function Make sure HTML tags are filtered out in the log overview links.
DbLogTest::testSameTimestampEntries public function Test sorting for entries with the same timestamp.
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::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.
FakeLogEntries::generateLogEntries private function Generates a number of random database log events.
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
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.