Tests logging messages to the database.
Expanded class hierarchy of DBLogTestCase
class DBLogTestCase extends DrupalWebTestCase {
/**
* A user with some relevant administrative permissions.
*
* @var object
*/
protected $big_user;
/**
* A user without any permissions.
*
* @var object
*/
protected $any_user;
public static function getInfo() {
return array(
'name' => 'DBLog functionality',
'description' => 'Generate events and verify dblog entries; verify user access to log reports based on persmissions.',
'group' => 'DBLog',
);
}
/**
* Enable modules and create users with specific permissions.
*/
function setUp() {
parent::setUp('dblog', 'blog', 'poll');
// Create users.
$this->big_user = $this
->drupalCreateUser(array(
'administer site configuration',
'access administration pages',
'access site reports',
'administer users',
));
$this->any_user = $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->big_user);
$row_limit = 100;
$this
->verifyRowLimit($row_limit);
$this
->verifyCron($row_limit);
$this
->verifyEvents();
$this
->verifyReports();
// Login the regular user.
$this
->drupalLogin($this->any_user);
$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
->drupalPost('admin/config/development/logging', $edit, t('Save configuration'));
$this
->assertResponse(200);
// Check row limit variable.
$current_limit = variable_get('dblog_row_limit', 1000);
$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,
)));
// Verify dblog row limit equals specified row limit.
$current_limit = unserialize(db_query("SELECT value FROM {variable} WHERE name = :dblog_limit", array(
':dblog_limit' => 'dblog_row_limit',
))
->fetchField());
$this
->assertTrue($current_limit == $row_limit, format_string('[Variable table] 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 string $type
* (optional) The type of watchdog entry. Defaults to 'custom'.
* @param int $severity
* (optional) The severity of the watchdog entry. Defaults to WATCHDOG_NOTICE.
*/
private function generateLogEntries($count, $type = 'custom', $severity = WATCHDOG_NOTICE) {
global $base_root;
// This long URL makes it just a little bit harder to pass the link part of
// the test with a mix of English words and a repeating series of random
// percent-encoded Chinese characters.
$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 = array(
'type' => $type,
'message' => 'Log entry added to test the dblog row limit.',
'variables' => array(),
'severity' => $severity,
'link' => $link,
'user' => $this->big_user,
'uid' => isset($this->big_user->uid) ? $this->big_user->uid : 0,
'request_uri' => $base_root . request_uri(),
'referer' => $_SERVER['HTTP_REFERER'],
'ip' => ip_address(),
'timestamp' => REQUEST_TIME,
);
$message = 'Log entry added to test the dblog row limit. Entry #';
for ($i = 0; $i < $count; $i++) {
$log['message'] = $message . $i;
dblog_watchdog($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) {
$quote = ''';
// 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(t('Top ' . $quote . 'page not found' . $quote . ' 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(t('Top ' . $quote . 'access denied' . $quote . ' errors'), 'DBLog access-denied report was displayed');
}
// View the database log event page.
$this
->drupalGet('admin/reports/event/1');
$this
->assertResponse($response);
if ($response == 200) {
$this
->assertText(t('Details'), 'DBLog event node was displayed');
}
}
/**
* Generates and then verifies various types of events.
*/
private function verifyEvents() {
// Invoke events.
$this
->doUser();
$this
->doNode('article');
$this
->doNode('blog');
$this
->doNode('page');
$this
->doNode('poll');
// When a user account is canceled, any content they created remains but the
// uid = 0. Their blog entry shows as "'s blog" on the home page. Records
// in the watchdog table related to that user have the uid set to zero.
}
/**
* Generates and then verifies some user events.
*/
private function doUser() {
// Set user variables.
$name = $this
->randomName();
$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
->drupalPost('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->uid,
));
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->name,
)));
// Login the admin user.
$this
->drupalLogin($this->big_user);
// Delete the user created at the start of this test.
// We need to POST here to invoke batch_process() in the internal browser.
$this
->drupalPost('user/' . $user->uid . '/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->mail,
)), '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->mail . '>',
));
$message_text = truncate_utf8(filter_xss($message, array()), 56, TRUE, TRUE);
// Verify that the full message displays on the details page.
$link = FALSE;
if ($links = $this
->xpath('//a[text()="' . html_entity_decode($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 = drupal_substr($value, strpos($value, 'admin/reports/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
->randomName(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 'poll').
*/
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);
$langcode = LANGUAGE_NONE;
$title = $edit["title"];
$this
->drupalPost('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
->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
$this
->assertResponse(200);
// Delete the node.
$this
->drupalPost('node/' . $node->nid . '/delete', array(), t('Delete'));
$this
->assertResponse(200);
// View the node (to generate page not found event).
$this
->drupalGet('node/' . $node->nid);
$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->big_user);
// 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(t('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(t('node/@nid', array(
'@nid' => $node->nid,
)), '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) {
$langcode = LANGUAGE_NONE;
switch ($type) {
case 'poll':
$content = array(
"title" => $this
->randomName(8),
'choice[new:0][chtext]' => $this
->randomName(32),
'choice[new:1][chtext]' => $this
->randomName(32),
);
break;
default:
$content = array(
"title" => $this
->randomName(8),
"body[{$langcode}][0][value]" => $this
->randomName(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) {
switch ($type) {
case 'poll':
$content = array(
'choice[chid:1][chtext]' => $this
->randomName(32),
'choice[chid:2][chtext]' => $this
->randomName(32),
);
break;
default:
$langcode = LANGUAGE_NONE;
$content = array(
"body[{$langcode}][0][value]" => $this
->randomName(32),
);
break;
}
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.
*/
protected 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(
'type' => 'custom',
'message' => 'Log entry added to test the doClearTest clear down.',
'variables' => array(),
'severity' => WATCHDOG_NOTICE,
'link' => NULL,
'user' => $this->big_user,
'uid' => isset($this->big_user->uid) ? $this->big_user->uid : 0,
'request_uri' => $base_root . request_uri(),
'referer' => $_SERVER['HTTP_REFERER'],
'ip' => ip_address(),
'timestamp' => REQUEST_TIME,
);
// Add a watchdog entry.
dblog_watchdog($log);
// Make sure the table count has actually been incremented.
$this
->assertEqual($count + 1, db_query('SELECT COUNT(*) FROM {watchdog}')
->fetchField(), format_string('dblog_watchdog() added an entry to the dblog :count', array(
':count' => $count,
)));
// Login the admin user.
$this
->drupalLogin($this->big_user);
// Post in order to clear the database table.
$this
->drupalPost('admin/reports/dblog', array(), t('Clear log messages'));
// 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.
*/
protected function testFilter() {
$this
->drupalLogin($this->big_user);
// 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
->randomName();
$severity = WATCHDOG_EMERGENCY;
for ($j = 0; $j < 3; $j++) {
$types[] = $type = array(
'count' => $j + 1,
'type' => $type_name,
'severity' => $severity++,
);
$this
->generateLogEntries($type['count'], $type['type'], $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
->drupalPost(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 $key => $type) {
$edit = array(
'type[]' => array(
$type['type'],
),
'severity[]' => array(
$type['severity'],
),
);
$this
->drupalPost(NULL, $edit, t('Filter'));
$count = $this
->getTypeCount($types);
$this
->assertEqual(array_sum($count), $type['count'], 'Count matched');
}
// Clear all logs and make sure the confirmation message is found.
$this
->drupalPost('admin/reports/dblog', array(), t('Clear log messages'));
$this
->assertText(t('Database log cleared.'), 'Confirmation message found');
}
/**
* Verifies that exceptions are caught in dblog_watchdog().
*/
protected function testDBLogException() {
$log = array(
'type' => 'custom',
'message' => 'Log entry added to test watchdog handling of Exceptions.',
'variables' => array(),
'severity' => WATCHDOG_NOTICE,
'link' => NULL,
'user' => $this->big_user,
'uid' => isset($this->big_user->uid) ? $this->big_user->uid : 0,
'request_uri' => request_uri(),
'referer' => $_SERVER['HTTP_REFERER'],
'ip' => ip_address(),
'timestamp' => REQUEST_TIME,
);
// Remove watchdog table temporarily to simulate it missing during
// installation.
db_query("DROP TABLE {watchdog}");
// Add a watchdog entry.
// This should not throw an Exception, but fail silently.
dblog_watchdog($log);
}
/**
* 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.
*
* @ingroup logging_severity_levels
*/
protected function getSeverityConstant($class) {
// Reversed array from dblog_overview().
$map = array(
'dblog-debug' => WATCHDOG_DEBUG,
'dblog-info' => WATCHDOG_INFO,
'dblog-notice' => WATCHDOG_NOTICE,
'dblog-warning' => WATCHDOG_WARNING,
'dblog-error' => WATCHDOG_ERROR,
'dblog-critical' => WATCHDOG_CRITICAL,
'dblog-alert' => WATCHDOG_ALERT,
'dblog-emerg' => WATCHDOG_EMERGENCY,
);
// 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 = truncate_utf8(filter_xss($log_message, array()), 56, TRUE, TRUE);
// After filter_xss(), HTML entities should be converted to their character
// equivalents because assertLink() uses this string in xpath() to query the
// Document Object Model (DOM).
$this
->assertLink(html_entity_decode($message_text), 0, $message);
}
/**
* Make sure HTML tags are filtered out in the log detail page.
*/
public function testLogMessageSanitized() {
$this
->drupalLogin($this->big_user);
// Make sure dangerous HTML tags are filtered out in log detail page.
$log = array(
'uid' => 0,
'type' => 'custom',
'message' => "<script>alert('foo');</script> <strong>Lorem ipsum</strong>",
'variables' => NULL,
'severity' => WATCHDOG_NOTICE,
'link' => 'foo/bar',
'request_uri' => 'http://example.com?dblog=1',
'referer' => 'http://example.org?dblog=2',
'ip' => '0.0.1.0',
'timestamp' => REQUEST_TIME,
);
dblog_watchdog($log);
$wid = db_query('SELECT MAX(wid) FROM {watchdog}')
->fetchField();
$this
->drupalGet('admin/reports/event/' . $wid);
$this
->assertResponse(200);
$this
->assertNoRaw("<script>alert('foo');</script>");
$this
->assertRaw("alert('foo'); <strong>Lorem ipsum</strong>");
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DBLogTestCase:: |
public static | function | ||
DrupalWebTestCase:: |
protected | function | ||
DrupalTestCase:: |
protected | property | ||
DrupalTestCase:: |
protected | property | ||
DBLogTestCase:: |
protected | property | A user with some relevant administrative permissions. | |
DBLogTestCase:: |
protected | property | A user without any permissions. | |
DrupalWebTestCase:: |
protected | property | Additional cURL options. | |
DrupalTestCase:: |
protected | property | Assertions thrown in that test case. | |
DrupalWebTestCase:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
DrupalWebTestCase:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field doesn't exist or its value doesn't match, by XPath. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field exists in the current page with the given ID and value. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field exists in the current page with the given name and value. | |
DrupalWebTestCase:: |
protected | function | Asserts that a field exists with the given name or ID. | |
DrupalWebTestCase:: |
protected | function | Asserts that a select option in the current page is checked. | |
DrupalWebTestCase:: |
protected | function | Asserts that a select option in the current page is not checked. | |
DrupalWebTestCase:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
DrupalWebTestCase:: |
protected | function | Asserts that the most recently sent e-mail message has the given value. | |
DrupalWebTestCase:: |
protected | function | Asserts that the most recently sent e-mail message has the pattern in it. | |
DrupalWebTestCase:: |
protected | function | Asserts that the most recently sent e-mail message has the string in it. | |
DrupalWebTestCase:: |
protected | function | Asserts the page did not return the specified response code. | |
DrupalWebTestCase:: |
protected | function | Asserts the page responds with the specified response code. | |
DrupalWebTestCase:: |
protected | function | Asserts themed output. | |
DrupalWebTestCase:: |
protected | function | Builds an XPath query. | |
DrupalWebTestCase:: |
protected | function | Changes the database connection to the prefixed one. | |
DrupalWebTestCase:: |
protected | function | Check for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive. | |
DrupalWebTestCase:: |
protected | function | Check to make sure that the array of permissions are valid. | |
DrupalTestCase:: |
protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | |
DrupalTestCase:: |
protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | |
DrupalTestCase:: |
protected | function | Check to see if a value is not NULL. | |
DrupalTestCase:: |
protected | function | Check to see if a value is NULL. | |
DrupalTestCase:: |
protected | function | Check to see if two values are equal. | |
DrupalTestCase:: |
protected | function | Check to see if two values are identical. | |
DrupalTestCase:: |
protected | function | Check to see if two values are not equal. | |
DrupalTestCase:: |
protected | function | Check to see if two values are not identical. | |
DrupalWebTestCase:: |
protected | function | Close the cURL handler and unset the handler. | |
DrupalWebTestCase:: |
protected | function | Compare two files based on size and file name. | |
DBLogTestCase:: |
protected | function | Confirms that a log message appears on the database log overview screen. | |
DBLogTestCase:: |
private | function | Confirms that database log reports are displayed at the correct paths. | |
DrupalWebTestCase:: |
function |
Constructor for DrupalWebTestCase. Overrides DrupalTestCase:: |
1 | |
DrupalTestCase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
DrupalWebTestCase:: |
protected | function | Create a user with a given set of permissions. | |
DrupalWebTestCase:: |
protected | function | Creates a custom content type based on default settings. | |
DrupalWebTestCase:: |
protected | function | Creates a node based on default settings. | |
DrupalWebTestCase:: |
protected | function | Creates a role with specified permissions. | |
DBLogTestCase:: |
private | function | Creates random content as an update based on node content type. | |
DBLogTestCase:: |
private | function | Creates random content based on node content type. | |
DrupalTestCase:: |
public | property | Current results of this test case. | |
DrupalTestCase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
DrupalTestCase:: |
public static | function | Delete an assertion record by message ID. | |
DrupalWebTestCase:: |
protected | function | Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. | 6 |
DBLogTestCase:: |
function |
Enable modules and create users with specific permissions. Overrides DrupalWebTestCase:: |
||
DrupalWebTestCase:: |
protected | function | Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser. | |
DrupalWebTestCase:: |
protected | function | Execute an Ajax submission. | |
DBLogTestCase:: |
protected | function | Extracts the text contained by the XHTML element. | |
DrupalTestCase:: |
protected | function | Fire an assertion that is always negative. | |
DrupalTestCase:: |
protected | function | Fire an assertion that is always positive. | |
DrupalTestCase:: |
protected | function | Fire an error assertion. | 1 |
DrupalTestCase:: |
protected | property | Flag to indicate whether the test has been set up. | |
DrupalWebTestCase:: |
protected | function | Follows a link by name. | |
DrupalWebTestCase:: |
protected | function | Generate a token for the currently logged in user. | |
DrupalWebTestCase:: |
protected | function | Generates a database prefix for running tests. | |
DBLogTestCase:: |
private | function | Generates a number of random database log events. | |
DrupalTestCase:: |
public static | function | Generates a random string containing letters and numbers. | |
DrupalTestCase:: |
public static | function | Generates a random string of ASCII characters of codes 32 to 126. | |
DBLogTestCase:: |
private | function | Generates and then verifies some node events. | |
DBLogTestCase:: |
private | function | Generates and then verifies some user events. | |
DBLogTestCase:: |
private | function | Generates and then verifies various types of events. | |
DrupalWebTestCase:: |
protected | function | Get a list files that can be used in tests. | |
DrupalWebTestCase:: |
function | Get a node from the database based on its title. | ||
DrupalWebTestCase:: |
protected | function | Get all option elements, including nested options, in a select. | |
DrupalWebTestCase:: |
protected | function | Get the current URL from the cURL handler. | |
DrupalWebTestCase:: |
protected | function | Get the selected value from a select field. | |
DrupalWebTestCase:: |
protected | function | Gets an array containing all e-mails sent during this test case. | |
DBLogTestCase:: |
protected | function | Gets the count of database log entries by database log event type. | |
DrupalWebTestCase:: |
protected | function | Gets the current raw HTML of requested page. | |
DBLogTestCase:: |
protected | function | Gets the database log event information from the browser page. | |
DrupalWebTestCase:: |
protected | function | Gets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the… | |
DrupalWebTestCase:: |
protected | function | Gets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed… | |
DrupalWebTestCase:: |
protected | function | Gets the value of the Drupal.settings JavaScript variable for the currently loaded page. | |
DBLogTestCase:: |
protected | function | Gets the watchdog severity constant corresponding to the CSS class. | |
DrupalTestCase:: |
public | function | Handle errors during test runs. | 1 |
DrupalTestCase:: |
protected | function | Handle exceptions. | |
DrupalWebTestCase:: |
protected | function | Handle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type. | |
DrupalWebTestCase:: |
protected | function | Helper for assertText and assertNoText. | |
DrupalWebTestCase:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
DrupalWebTestCase:: |
protected | function | Helper function: construct an XPath for the given set of attributes and value. | |
DrupalWebTestCase:: |
protected | property | HTTP authentication credentials (<username>:<password>). | |
DrupalWebTestCase:: |
protected | property | HTTP authentication method | |
DrupalWebTestCase:: |
protected | function | Initializes and executes a cURL request. | |
DrupalWebTestCase:: |
protected | function | Initializes the cURL connection. | |
DrupalTestCase:: |
protected | function | Internal helper: stores the assert. | |
DrupalWebTestCase:: |
protected | function | Log in a user with the internal browser. | |
DrupalTestCase:: |
protected | function | Logs a verbose message in a text file. | |
DBLogTestCase:: |
public | function | Make sure HTML tags are filtered out in the log detail page. | |
DrupalWebTestCase:: |
protected | function | Outputs to verbose the most recent $count emails sent. | |
DrupalWebTestCase:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
DrupalWebTestCase:: |
protected | function | Pass if a link containing a given href (part) is found. | |
DrupalWebTestCase:: |
protected | function | Pass if a link containing a given href (part) is not found. | |
DrupalWebTestCase:: |
protected | function | Pass if a link with the specified label is found, and optional with the specified index. | |
DrupalWebTestCase:: |
protected | function | Pass if a link with the specified label is not found. | |
DrupalWebTestCase:: |
protected | function | Pass if the internal browser's URL matches the given path. | |
DrupalWebTestCase:: |
protected | function | Pass if the page title is not the given string. | |
DrupalWebTestCase:: |
protected | function | Pass if the page title is the given string. | |
DrupalWebTestCase:: |
protected | function | Pass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated. | |
DrupalWebTestCase:: |
protected | function | Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated. | |
DrupalWebTestCase:: |
protected | function | Pass if the text is found MORE THAN ONCE on the text version of the page. | |
DrupalWebTestCase:: |
protected | function | Pass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents. | |
DrupalWebTestCase:: |
protected | function | Pass if the text is found ONLY ONCE on the text version of the page. | |
DrupalWebTestCase:: |
protected | function | Pass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents. | |
DrupalWebTestCase:: |
protected | function | Perform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page. | |
DrupalWebTestCase:: |
protected | function | Preload the registry from the testing site. | |
DrupalWebTestCase:: |
protected | function | Prepares the current environment for running the test. | |
DrupalWebTestCase:: |
protected | function | Reads headers and registers errors received from the tested site. | |
DrupalWebTestCase:: |
protected | function | Refresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread. | 1 |
DrupalWebTestCase:: |
protected | function | Reset all data structures after having enabled new modules. | |
DrupalWebTestCase:: |
protected | function | Retrieve a Drupal path or an absolute path and JSON decode the result. | |
DrupalWebTestCase:: |
protected | function | Retrieves a Drupal path or an absolute path. | |
DrupalWebTestCase:: |
protected | function | Retrieves only the headers for a Drupal path or an absolute path. | |
DrupalTestCase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
DrupalTestCase:: |
public | function | Run all tests in this class. | |
DrupalWebTestCase:: |
protected | function | Runs cron in the Drupal installed by Simpletest. | |
DrupalWebTestCase:: |
protected | function | Sets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page. | |
DrupalWebTestCase:: |
protected | function | Sets the value of the Drupal.settings JavaScript variable for the currently loaded page. | |
DrupalTestCase:: |
public static | function | Store an assertion from outside the testing context. | |
DrupalWebTestCase:: |
protected | function | Takes a path and returns an absolute path. | |
DBLogTestCase:: |
function | Tests Database Logging module functionality through interfaces. | ||
DBLogTestCase:: |
protected | function | Tests the addition and clearing of log events through the admin interface. | |
DBLogTestCase:: |
protected | function | Tests the database log filter functionality at admin/reports/dblog. | |
DrupalWebTestCase:: |
protected | property | The content of the page currently loaded in the internal browser (plain text version). | |
DrupalWebTestCase:: |
protected | property | The content of the page currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | property | The cookies of the page currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | property | The current cookie file used by cURL. | |
DrupalWebTestCase:: |
protected | property | The current session ID, if available. | |
DrupalWebTestCase:: |
protected | property | The current session name, if available. | |
DrupalWebTestCase:: |
protected | property | The current user logged in using the internal browser. | |
DrupalTestCase:: |
protected | property | The database prefix of this test run. | |
DrupalWebTestCase:: |
protected | property | The handle of the current cURL connection. | |
DrupalWebTestCase:: |
protected | property | The headers of the page currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | property | The number of redirects followed during the handling of a request. | |
DrupalTestCase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
DrupalWebTestCase:: |
protected | property | The original shutdown handlers array, before it was cleaned for testing purposes. | |
DrupalWebTestCase:: |
protected | property | The original user, before it was changed to a clean uid = 1 for testing purposes. | |
DrupalWebTestCase:: |
protected | property | The parsed version of the page. | |
DrupalWebTestCase:: |
protected | property | The profile to install as a basis for testing. | 20 |
DrupalTestCase:: |
protected | property | The test run ID. | |
DrupalWebTestCase:: |
protected | property | The URL currently loaded in the internal browser. | |
DrupalWebTestCase:: |
protected | property | The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser. | |
DrupalTestCase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
DrupalTestCase:: |
protected | property | Time limit for the test. | |
DrupalTestCase:: |
protected | property | URL to the verbose output file directory. | |
DBLogTestCase:: |
private | function | Verifies setting of the database log row limit. | |
DBLogTestCase:: |
private | function | Verifies that cron correctly applies the database log row limit. | |
DBLogTestCase:: |
protected | function | Verifies that exceptions are caught in dblog_watchdog(). | |
DrupalWebTestCase:: |
protected | property | Whether the files were copied to the test files directory. | |
DrupalWebTestCase:: |
protected | function | Will trigger a pass if the Perl regex pattern is found in the raw content. | |
DrupalWebTestCase:: |
protected | function | Will trigger a pass if the perl regex pattern is not present in raw content. |