mongodb_watchdog.test in MongoDB 7
Same filename and directory in other branches
Contains \MongoDBLogTestCase.
File
mongodb_watchdog/mongodb_watchdog.testView source
<?php
/**
* @file
* Contains \MongoDBLogTestCase.
*/
/**
* Test the behaviour of watchdog() mongodb_watchdog, not dblog.
*/
// phpcs:ignore
class MongoDBLogTestCase extends DrupalWebTestCase {
/**
* Name of the test helper module invoking watchdog for test.
*/
const MODULE = 'watchdog_test';
/**
* The name of the variable holding the system watchdog limit level.
*
* @var string
*/
const LIMIT_VARIABLE = 'watchdog_limit';
/**
* An administrator-type user account.
*
* @var object
*/
protected $bigUser;
/**
* A basic authenticated user account.
*
* @var object
*/
protected $anyUser;
/**
* The current MongoDB collection.
*
* @var MongoCollection
*/
protected $collection;
/**
* The current test group.
*
* @var string
*/
protected $group = 'Before setUp()';
/**
* D6 misses REQUEST_TIME, use a custom value to minimize D6/D7 differences.
*
* @var int
*/
protected $requestTime;
/**
* {@inheritdoc}
*/
public static function getInfo() {
return array(
'name' => 'MongoDB log functionality',
'description' => 'Generate events and verify watchdog entries; verify user access to log reports based on persmissions.',
'group' => 'MongoDB: Watchdog',
);
}
/**
* Enable modules and create users with specific permissions.
*/
public function setUp() {
// Support using the MongoDB cache.
drupal_flush_all_caches();
$this->group = t('Setup');
parent::setUp('mongodb', 'mongodb_watchdog', 'blog', 'poll');
// Create users.
$this->bigUser = $this
->drupalCreateUser(array(
'administer site configuration',
'access administration pages',
'access site reports',
'administer users',
));
$this->anyUser = $this
->drupalCreateUser(array(
'access content',
));
$this->requestTime = REQUEST_TIME;
try {
$this->collection = mongodb_collection(variable_get('mongodb_watchdog', 'watchdog'));
} catch (Exception $e) {
$this->collection = NULL;
}
$this
->assertNotNull($this->collection, t('Access MongoDB watchdog collection'), $this->group);
}
/**
* Clear the MongoDB data: simpletest only clears the main SQL database.
*
* Non-PHPdoc.
*
* @see DrupalWebTestCase::tearDown()
*/
public function tearDown() {
$this->group = t('Teardown');
$this
->pass('Clear watchdog collections', $this->group);
module_load_include('inc', 'mongodb_watchdog', 'mongodb_watchdog.admin');
mongodb_watchdog_clear_log_submit();
// Support using the MongoDB cache.
drupal_flush_all_caches();
parent::tearDown();
}
/**
* Simplified query to look for a logged message.
*
* @param string $message
* The message to look for.
*
* @return string|null
* The document matching the message, or NULL if none was found.
*/
protected function find($message) {
$ret = $this->collection
->findOne(array(
'message' => $message,
));
return $ret;
}
/**
* Assert that a given entry is present in the watchdog.
*
* @param string $message
* The message to look for.
*/
public function assertEntry($message) {
$logged = $this
->find($message);
$this
->assertNotNull($logged, t('Event %message is logged', array(
'%message' => $message,
)), $this->group);
$this
->assertTrue(isset($logged['message']) && $logged['message'] == $message, t('Logged message is unchanged'), $this->group);
}
/**
* Assert that a given entry is not present in the watchdog.
*
* @param string $message
* The message to look for.
*/
public function assertNoEntry($message) {
$logged = $this
->find($message);
$this
->assertNull($logged, t('Event %message is not logged', array(
'%message' => $message,
)), $this->group);
}
/**
* Ensure collection is available and inform on behalf of caller if if is not.
*
* @return bool
* Was the collection available ?
*/
protected function checkCollection() {
if (!empty($this->collection)) {
return TRUE;
}
$stack = debug_backtrace();
$method = $stack[1]['function'];
if (strtolower(substr($method, 0, 4)) == 'test') {
$this
->pass(t('%test test skipped: no collection.', array(
'%test' => substr($method, 4),
)), $this->group);
}
return FALSE;
}
/**
* Test the default and non-default mongodb_watchdog insertion behaviours.
*
* Make sure the module applies the watchdog_limit variable,
*/
public function testWatchdogLimit() {
// Bypass test if testing system does not have a MongoDB connection.
if (!$this
->checkCollection()) {
return;
}
// Default limit should be WATCHDOG_DEBUG.
$this->group = t('Defaults');
$this
->assertEqual(variable_get(self::LIMIT_VARIABLE, WATCHDOG_DEBUG), WATCHDOG_DEBUG, t('%name defaults to WATCHDOG_DEBUG', array(
'%name' => self::LIMIT_VARIABLE,
)), $this->group);
// Test at this default level.
$message = $this
->randomString(32);
$this
->pass(t('Logging %message', array(
'%message' => $message,
)), $this->group);
watchdog(self::MODULE, $message, array(), WATCHDOG_DEBUG);
$this
->assertEntry($message);
// Now request a higher level: unimportant events should be ignored...
$this->group = t('Ignoring');
variable_set(self::LIMIT_VARIABLE, WATCHDOG_NOTICE);
$message = $this
->randomString(32);
$this
->pass(t('Logging %message', array(
'%message' => $message,
)), $this->group);
watchdog(self::MODULE, $message, array(), WATCHDOG_DEBUG);
$this
->assertNoEntry($message);
// ... but events at the limit or more important should be logged.
$this->group = t('Logging');
$message = $this
->randomString(32);
$this
->pass(t('Logging %message', array(
'%message' => $message,
)), $this->group);
watchdog(self::MODULE, $message, array(), WATCHDOG_NOTICE);
$this
->assertEntry($message);
$message = $this
->randomString(32);
$this
->pass(t('Logging %message', array(
'%message' => $message,
)), $this->group);
watchdog(self::MODULE, $message, array(), WATCHDOG_ERROR);
$this
->assertEntry($message);
}
/* @FIXME Below this line is older broken code inherited from dblog tests. */
/**
* Test dblog functionality through the admin and user interfaces.
*/
protected function ztestDbLog() {
// Login the admin user.
$this
->drupalLogin($this->bigUser);
// No implementation.
/*
$row_limit = 100;
$this->verifyRowLimit($row_limit);
*/
// No implementation.
/* $this->verifyCron($row_limit); */
$this
->verifyEvents();
$this
->verifyReports();
// Login the regular user.
$this
->drupalLogin($this->anyUser);
$this
->verifyReports(403);
}
/**
* Generate dblog entries.
*
* @param int $count
* Number of log entries to generate.
* @param string $type
* The type of watchdog entry.
* @param int $severity
* The severity of the watchdog entry.
*/
private function generateLogEntries($count, $type = 'custom', $severity = WATCHDOG_NOTICE) {
global $base_root;
// Prepare the fields to be logged.
$message = 'Log entry added to test the dblog row limit.';
$log = array(
'type' => $type,
'message' => $message,
'variables' => array(),
'severity' => $severity,
'link' => NULL,
'user' => $this->bigUser,
'request_uri' => $base_root . request_uri(),
'referer' => $_SERVER['HTTP_REFERER'],
'ip' => ip_address(),
'timestamp' => $this->requestTime,
);
for ($i = 0; $i < $count; $i++) {
$log['message'] = $this
->randomString();
dblog_watchdog($log);
}
}
/**
* Verify the logged in user has the desired access to the dblog nodes.
*
* @param int $response
* HTTP response code.
*/
private function verifyReports($response = 200) {
$quote = ''';
// View dblog help node.
$this
->drupalGet('admin/help/dblog');
$this
->assertResponse($response);
if ($response == 200) {
$this
->assertText(t('Database logging'), t('DBLog help was displayed'));
}
// View dblog report node.
$this
->drupalGet('admin/reports/dblog');
$this
->assertResponse($response);
if ($response == 200) {
$this
->assertText(t('Recent log entries'), t('DBLog report was displayed'));
}
// View dblog page-not-found report node.
$this
->drupalGet('admin/reports/page-not-found');
$this
->assertResponse($response);
if ($response == 200) {
// phpcs:ignore
$this
->assertText(t("Top {$quote}page not found{$quote} errors"), t('DBLog page-not-found report was displayed'));
}
// View dblog access-denied report node.
$this
->drupalGet('admin/reports/access-denied');
$this
->assertResponse($response);
if ($response == 200) {
// phpcs:ignore
$this
->assertText(t("Top {$quote}access denied{$quote} errors"), t('DBLog access-denied report was displayed'));
}
// View dblog event node.
$this
->drupalGet('admin/reports/event/1');
$this
->assertResponse($response);
if ($response == 200) {
$this
->assertText(t('Details'), t('DBLog event node was displayed'));
}
}
/**
* Verify 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.
}
/**
* Generate and verify user events.
*/
private function doUser() {
// Set user variables.
$name = $this
->randomName();
$pass = user_password();
// Add user using form to generate 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 user object.
$user = user_load_by_name($name);
$this
->assertTrue($user != NULL, t('User @name was loaded', array(
'@name' => $name,
)));
// Needed by drupalLogin.
$user->pass_raw = $pass;
// Login user.
$this
->drupalLogin($user);
// Logout user.
$this
->drupalLogout();
// Fetch row ids in watchdog that relate to the user.
$collection = mongodb_collection(variable_get('mongodb_watchdog', 'watchdog'));
$query = array(
'uid' => $user->uid,
);
$result = $collection
->find($query, array(
'_id' => 1,
));
foreach ($result as $row) {
$ids[] = $row['_id'];
}
$count_before = isset($ids) ? count($ids) : 0;
$this
->assertTrue($count_before > 0, t('DBLog contains @count records for @name', array(
'@count' => $count_before,
'@name' => $user->name,
)));
// Login the admin user.
$this
->drupalLogin($this->bigUser);
// On D6, delete user. On D7, cancel it.
// 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'));
// Count rows that have uids for the user.
$count = $collection
->find($query)
->count();
$this
->assertTrue($count == 0, t('DBLog contains @count records for @name', array(
'@count' => $count,
'@name' => $user->name,
)));
// Count rows in watchdog that previously related to the deleted user.
if (!empty($ids)) {
$query['_id']['$in'] = $ids;
}
$count_after = $collection
->find($query)
->count();
$this
->assertTrue($count_after == $count_before, t('DBLog contains @count records for @name that now have uid = 0', array(
'@count' => $count_before,
'@name' => $user->name,
)));
unset($ids);
// Fetch row ids in watchdog that relate to the user.
$result = $collection
->find($query, array(
'_id' => 1,
));
foreach ($result as $row) {
$ids[] = $row->wid;
}
$this
->assertTrue(!isset($ids), t('DBLog contains no records for @name', array(
'@name' => $user->name,
)));
// View the dblog report.
$this
->drupalGet('admin/reports/dblog');
$this
->assertResponse(200);
// Verify events were recorded.
// Add user.
// Default display includes name and email address; if too long then email
// is replaced by three periods.
$this
->assertRaw(t('New user: %name', array(
'%name' => $name,
)), t('DBLog event was recorded: [add user]'));
// Login user.
$this
->assertRaw(t('Session opened for %name', array(
'%name' => $name,
)), t('DBLog event was recorded: [login user]'));
// Logout user.
$this
->assertRaw(t('Session closed for %name', array(
'%name' => $name,
)), t('DBLog event was recorded: [logout user]'));
// Delete user.
$this
->assertRaw(t('Deleted user: %name', array(
'%name' => $name,
)), t('DBLog event was recorded: [delete user]'));
}
/**
* Generate and verify node events.
*
* @param string $type
* Content type.
*/
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 node using form to generate add content event, which is not
// triggered by drupalCreateNode.
$edit = $this
->getContent($type);
$langcode = LANGUAGE_NONE;
$title = $edit["title[{$langcode}][0][value]"];
$this
->drupalPost('node/add/' . $type, $edit, t('Save'));
$this
->assertResponse(200);
// Retrieve node object.
$node = $this
->drupalGetNodeByTitle($title);
$this
->assertTrue($node != NULL, t('Node @title was loaded', array(
'@title' => $title,
)));
// Edit node.
$edit = $this
->getContentUpdate($type);
$this
->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
$this
->assertResponse(200);
// Delete node.
$this
->drupalPost('node/' . $node->nid . '/delete', array(), t('Delete'));
$this
->assertResponse(200);
// View node (to generate page not found event).
$this
->drupalGet('node/' . $node->nid);
$this
->assertResponse(404);
// View the dblog report (to generate access denied event).
$this
->drupalGet('admin/reports/dblog');
$this
->assertResponse(403);
// Login the admin user.
$this
->drupalLogin($this->bigUser);
// View the dblog report.
$this
->drupalGet('admin/reports/dblog');
$this
->assertResponse(200);
// Verify events were recorded.
// Content added.
$this
->assertRaw(t('@type: added %title', array(
'@type' => $type,
'%title' => $title,
)), t('DBLog event was recorded: [content added]'));
// Content updated.
$this
->assertRaw(t('@type: updated %title', array(
'@type' => $type,
'%title' => $title,
)), t('DBLog event was recorded: [content updated]'));
// Content deleted.
$this
->assertRaw(t('@type: deleted %title', array(
'@type' => $type,
'%title' => $title,
)), t('DBLog event was recorded: [content deleted]'));
// View dblog access-denied report node.
$this
->drupalGet('admin/reports/access-denied');
$this
->assertResponse(200);
// Access denied.
$this
->assertText(t('admin/reports/dblog'), t('DBLog event was recorded: [access denied]'));
// View dblog page-not-found report node.
$this
->drupalGet('admin/reports/page-not-found');
$this
->assertResponse(200);
// Page not found.
$this
->assertText(t('node/@nid', array(
'@nid' => $node->nid,
)), t('DBLog event was recorded: [page not found]'));
}
/**
* Create content based on content type.
*
* @param string $type
* Content type.
*
* @return array
* Content.
*/
private function getContent($type) {
$langcode = LANGUAGE_NONE;
switch ($type) {
case 'poll':
$content = array(
"title[{$langcode}][0][value]" => $this
->randomName(8),
'choice[new:0][chtext]' => $this
->randomName(32),
'choice[new:1][chtext]' => $this
->randomName(32),
);
break;
default:
$content = array(
"title[{$langcode}][0][value]" => $this
->randomName(8),
"body[{$langcode}][0][value]" => $this
->randomName(32),
);
break;
}
return $content;
}
/**
* Create content update based on content type.
*
* @param string $type
* Content type.
*
* @return array
* Content.
*/
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;
}
/**
* Test clearing dblog functionality through the admin interface.
*/
protected function ztestDbLogAddAndClear() {
global $base_root;
// Get a count of how many watchdog entries there are.
$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->bigUser,
'request_uri' => $base_root . request_uri(),
'referer' => $_SERVER['HTTP_REFERER'],
'ip' => ip_address(),
'timestamp' => $this->requestTime,
);
// Add a watchdog entry.
dblog_watchdog($log);
// Make sure the table count has actually incremented.
$this
->assertEqual($count + 1, db_query('SELECT COUNT(*) FROM {watchdog}')
->fetchField(), t('dblog_watchdog() added an entry to the dblog :count', array(
':count' => $count,
)));
// Login the admin user.
$this
->drupalLogin($this->bigUser);
// Now post to clear the db table.
$this
->drupalPost('admin/reports/dblog', array(), t('Clear log messages'));
// Count rows in watchdog that previously related to the deleted user.
$count = db_query('SELECT COUNT(*) FROM {watchdog}')
->fetchField();
$this
->assertEqual($count, 0, t('DBLog contains :count records after a clear.', array(
':count' => $count,
)));
}
/**
* Test the dblog filter on admin/reports/dblog.
*/
protected function ztestFilter() {
$this
->drupalLogin($this->bigUser);
// Clear log to ensure that only generated entries are found.
db_delete('watchdog')
->execute();
// Generate 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' => mt_rand(1, 5),
'type' => $type_name,
'severity' => $severity++,
);
$this
->generateLogEntries($type['count'], $type['type'], $type['severity']);
}
}
// View the dblog.
$this
->drupalGet('admin/reports/dblog');
// Confirm 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 filter to match each of the three type attributes and confirm the
// number of entries 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');
}
}
/**
* Get the log entry information form the page.
*
* @return array
* List of entries and their information.
*/
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;
}
/**
* Get the count of entries per 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;
}
/**
* Get 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) {
// 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;
}
/**
* Extract the text contained by the 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())));
}
}Classes
Name |
Description |
|---|---|
| MongoDBLogTestCase |