class DrupalTestCase in SimpleTest 5
Same name and namespace in other branches
- 6.2 drupal_web_test_case.php \DrupalTestCase
- 6 drupal_test_case.php \DrupalTestCase
- 7.2 drupal_web_test_case.php \DrupalTestCase
- 7 drupal_web_test_case.php \DrupalTestCase
Test case for typical Drupal tests. Extends WebTestCase for comfortable browser usage but also implements all UnitTestCase methods, I wish WebTestCase would do this.
Hierarchy
- class \DrupalTestCase extends \WebTestCase
Expanded class hierarchy of DrupalTestCase
1 string reference to 'DrupalTestCase'
- DrupalUnitTests::DrupalUnitTests in ./
drupal_unit_tests.php - Constructor
File
- ./
drupal_test_case.php, line 9
View source
class DrupalTestCase extends WebTestCase {
var $_content;
var $_cleanupModules = [];
var $_cleanupVariables = [];
var $_cleanupUsers = [];
var $_cleanupRoles = [];
function DrupalTestCase($label = NULL) {
if (!$label) {
if (method_exists($this, 'get_info')) {
$info = $this
->get_info();
$label = $info['name'];
}
}
$this
->WebTestCase($label);
}
/**
* @abstract Checks to see if we need to send
* a http-auth header to authenticate
* when browsing a site.
*
* @param status Boolean pass true if you want to know if we are using
* HTTP-AUTH
* @return void
*/
function drupalCheckAuth($status = false) {
$check = variable_get('simpletest_httpauth', false);
if ($status) {
return $check;
}
if (variable_get('simpletest_httpauth', false)) {
$html = $this
->authenticate(variable_get('simpletest_httpauth_username', ''), variable_get('simpletest_httpauth_pass', ''));
}
return $html;
}
/**
* @abstract Brokder for the get function
* adds the authentication headers if necessary
* @author Earnest Berry III <earnest.berry@gmail.com>
*
* @param url string Url to retch
* @return void
*/
function drupalGet($url) {
$html = $this->_browser
->get($url);
if ($this
->drupalCheckAuth(true)) {
$html .= $this
->drupalCheckAuth();
}
$this->_content = $this->_browser
->getContent();
return $html;
}
/**
* @abstract Broker for the post function
* adds the authentication headers if necessary
* @author Earnest Berry III <earnest.berry@gmail.com>
*
* @param url string Url to retch
* @return void
*/
function drupalRawPost($action, $edit = []) {
$html = $this->_browser
->post($action, $edit);
if ($this
->drupalCheckAuth(true)) {
$html .= $this
->drupalCheckAuth();
}
$this->_content = $this->_browser
->getContent();
return $html;
}
/**
* Do a post request on a drupal page.
* It will be done as usual post request with SimpleBrowser
*
* @param string $path location of the post form
* @param array $edit field data
* @param string $submit name of the submit button, untranslated
*/
function drupalPostRequest($path, $edit = [], $submit) {
$url = url($path, NULL, NULL, TRUE);
$ret = $this
->drupalGet($url);
$this
->assertTrue($ret, t(' [browser] GET path "@path"', array(
'@path' => $path,
)));
foreach ($edit as $field_name => $field_value) {
$ret = $this->_browser
->setFieldByName($field_name, $field_value) || $this->_browser
->setFieldById("edit-{$field_name}", $field_value);
$this
->assertTrue($ret, " [browser] Setting {$field_name}=\"{$field_value}\"");
}
$ret = $this->_browser
->clickSubmit(t($submit)) || $this->_browser
->clickSubmitById($submit) || $this->_browser
->clickSubmitByName($submit) || $this->_browser
->clickImageByName($submit);
$this
->assertTrue($ret, ' [browser] POST by click on ' . t($submit));
$this->_content = $this->_browser
->getContent();
}
/**
* Follows a link by name. Will click the first link
* found with this link text by default, or a later
* one if an index is given. Match is case insensitive
* with normalised space.
* Does make assertations if the click was sucessful or not
* and it does translate label.
* WARNING: Assertation fails on empty ("") output from the clicked link
*
* @param string $label Text between the anchor tags.
* @param integer $index Link position counting from zero.
* @param boolean $reporting Assertions or not
* @return boolean/string Page on success.
*
* @access public
*/
function clickLink($label, $index = 0) {
$url_before = $this
->getUrl();
$urls = $this->_browser->_page
->getUrlsByLabel($label);
$url_target = 'unknown url';
if (isset($urls[$index])) {
$url_target = $urls[$index]
->asString();
}
$ret = parent::clickLink(t($label), $index);
$this
->assertTrue($ret, str_replace('%', '%%', ' [browser] clicked link ' . t($label) . " ({$url_target}) from {$url_before}"));
$this->_content = $this->_browser
->getContent();
return $ret;
}
/**
* @TODO: needs documentation
*/
function drupalGetContent() {
return $this->_content;
}
/**
* Generates a random string, to be used as name or whatever
* @param integer $number number of characters
* @return ransom string
*/
function randomName($number = 4, $prefix = 'simpletest_') {
$chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_';
for ($x = 0; $x < $number; $x++) {
$prefix .= $chars[mt_rand(0, strlen($chars) - 1)];
if ($x == 0) {
$chars .= '0123456789';
}
}
return $prefix;
}
/**
* Enables a drupal module
* @param string $name name of the module
* @return boolean success
*/
function drupalModuleEnable($name) {
if (module_exists($name)) {
$this
->pass(" [module] {$name} already enabled");
return TRUE;
}
include_once './includes/install.inc';
module_rebuild_cache();
// Rebuild the module cache
if (drupal_get_installed_schema_version($name, TRUE) == SCHEMA_UNINSTALLED) {
drupal_install_modules(array(
$name,
));
}
else {
$try = module_enable(array(
$name,
));
}
if (module_exists($name)) {
if (!isset($this->_cleanupModules[$name])) {
$this->_cleanupModules[$name] = 0;
}
$this
->pass(" [module] {$name} enabled");
return TRUE;
}
else {
$this
->fail(" [module] {$name} could not be enbled, probably file not exists");
return FALSE;
}
}
/**
* Disables a drupal module
* @param string $name name of the module
* @return boolean success
*/
function drupalModuleDisable($name) {
if (!module_exists($name)) {
$this
->pass(" [module] {$name} already disabled");
return TRUE;
}
/* Update table */
db_query("UPDATE {system} SET status = 0 WHERE name = '%s' AND type = 'module'", $name);
if (db_affected_rows()) {
/* Make sure not overwriting when double switching */
if (!isset($this->_cleanupModules[$name])) {
$this->_cleanupModules[$name] = 1;
}
/* refresh module_list */
module_list(TRUE, FALSE);
$this
->pass(" [module] {$name} disabled");
return TRUE;
}
$this
->fail(" [module] {$name} could not be disabled for unknown reason");
return FALSE;
}
/**
* Set a druapl variable and keep track of the changes for tearDown()
* @param string $name name of the value
* @param mixed $value value
*/
function drupalVariableSet($name, $value) {
/* NULL variables would anyways result in default because of isset */
$old_value = variable_get($name, NULL);
if ($value !== $old_value) {
variable_set($name, $value);
/* Use array_key_exists instead of isset so NULL values do not get overwritten */
if (!array_key_exists($name, $this->_cleanupVariables)) {
$this->_cleanupVariables[$name] = $old_value;
}
}
}
/**
* Create a role / perm combination specified by permissions
*
* @param array $permissions Array of the permission strings
* @return integer role-id
*/
function drupalCreateRolePerm($permissions = NULL) {
if ($permissions === NULL) {
$permstring = 'access comments, access content, post comments, post comments without approval';
}
else {
$permstring = implode(', ', $permissions);
}
/* Create role */
$role_name = $this
->randomName();
db_query("INSERT INTO {role} (name) VALUES ('%s')", $role_name);
$role = db_fetch_object(db_query("SELECT * FROM {role} WHERE name = '%s'", $role_name));
$this
->assertTrue($role, " [role] created name: {$role_name}, id: " . (isset($role->rid) ? $role->rid : '-n/a-'));
if ($role && !empty($role->rid)) {
/* Create permissions */
db_query("INSERT INTO {permission} (rid, perm) VALUES (%d, '%s')", $role->rid, $permstring);
$this
->assertTrue(db_affected_rows(), ' [role] created permissions: ' . $permstring);
$this->_cleanupRoles[] = $role->rid;
return $role->rid;
}
else {
return false;
}
}
/**
* Creates a user / role / permissions combination specified by permissions
*
* @param array $permissions Array of the permission strings
* @return array/boolean false if fails. fully loaded user object with added pass_raw property
*/
function drupalCreateUserRolePerm($permissions = NULL) {
/* Create role */
$rid = $this
->drupalCreateRolePerm($permissions);
if (!$rid) {
return FALSE;
}
/* Create user */
$ua = array();
$ua['name'] = $this
->randomName();
$ua['mail'] = $ua['name'] . '@example.com';
$ua['roles'] = array(
$rid => $rid,
);
$ua['pass'] = user_password();
$ua['status'] = 1;
$u = user_save('', $ua);
$this
->assertTrue(!empty($u->uid), " [user] name: {$ua['name']} pass: {$ua['pass']} created");
if (empty($u->uid)) {
return FALSE;
}
/* Add to cleanup list */
$this->_cleanupUsers[] = $u->uid;
/* Add the raw password */
$u->pass_raw = $ua['pass'];
return $u;
}
/**
* Logs in a user with the internal browser
*
* @param object user object with pass_raw property!
* @param $submit value of submit button on log in form
*/
function drupalLoginUser($user = NULL, $submit = 'Log in') {
$this
->drupalGet(url("user", NULL, NULL, TRUE));
// Going to the page retrieves the cookie, as the browser should save it
if ($user === NULL) {
$user = $this
->drupalCreateUserRolePerm();
}
$edit = array(
'name' => $user->name,
'pass' => $user->pass_raw,
);
$this
->drupalPostRequest('user', $edit, $submit);
$this
->assertText($user->name, ' [login] found name: ' . $user->name);
$this
->assertNoText(t('The username %name has been blocked.', array(
'%name' => $user->name,
)), ' [login] not blocked');
$this
->assertNoText(t('The name %name is a reserved username.', array(
'%name' => $user->name,
)), ' [login] not reserved');
return $user;
}
/**
* tearDown implementation, setting back switched modules etc
*/
function tearDown() {
foreach ($this->_cleanupModules as $name => $status) {
db_query("UPDATE {system} SET status = %d WHERE name = '%s' AND type = 'module'", $status, $name);
}
$this->_cleanupModules = array();
// Refresh the modules list
module_list(TRUE, FALSE);
menu_rebuild();
foreach ($this->_cleanupVariables as $name => $value) {
if (is_null($value)) {
variable_del($name);
}
else {
variable_set($name, $value);
}
}
$this->_cleanupVariables = array();
while (sizeof($this->_cleanupRoles) > 0) {
$rid = array_pop($this->_cleanupRoles);
db_query("DELETE FROM {role} WHERE rid = %d", $rid);
db_query("DELETE FROM {permission} WHERE rid = %d", $rid);
}
while (sizeof($this->_cleanupUsers) > 0) {
$uid = array_pop($this->_cleanupUsers);
// cleanup nodes this user created
$result = db_query("SELECT nid FROM {node} WHERE uid = %d", $uid);
while ($node = db_fetch_array($result)) {
node_delete($node['nid']);
}
user_delete(array(), $uid);
}
//Output drupal warnings and messages into assert messages
$drupal_msgs = drupal_get_messages();
foreach ($drupal_msgs as $type => $msgs) {
foreach ($msgs as $msg) {
$this
->assertTrue(TRUE, "{$type}: {$msg}");
}
}
parent::tearDown();
}
/**
* Just some info for the reporter
*/
function run(&$reporter) {
$arr = array(
'class' => get_class($this),
);
if (method_exists($this, 'get_info')) {
$arr = array_merge($arr, $this
->get_info());
}
$reporter->test_info_stack[] = $arr;
parent::run($reporter);
array_pop($reporter->test_info_stack);
}
/**
* Will trigger a pass if the raw text is found on the loaded page
* Fail otherwise.
* @param string $raw Raw string to look for
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertWantedRaw($raw, $message = "%s") {
return $this
->assertExpectation(new TextExpectation($raw), $this->_browser
->getContent(), $message);
}
/**
* Will trigger a pass if the raw text is NOT found on the loaded page
* Fail otherwise.
* @param string $raw Raw string to look for
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertNoUnwantedRaw($raw, $message = "%s") {
return $this
->assertExpectation(new NoTextExpectation($raw), $this->_browser
->getContent(), $message);
}
/* Taken from UnitTestCase */
/**
* Will be true if the value is null.
* @param null $value Supposedly null value.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertNull($value, $message = "%s") {
$dumper =& new SimpleDumper();
$message = sprintf($message, "[" . $dumper
->describeValue($value) . "] should be null");
return $this
->assertTrue(!isset($value), $message);
}
/**
* Will be true if the value is set.
* @param mixed $value Supposedly set value.
* @param string $message Message to display.
* @return boolean True on pass.
* @access public
*/
function assertNotNull($value, $message = "%s") {
$dumper =& new SimpleDumper();
$message = sprintf($message, "[" . $dumper
->describeValue($value) . "] should not be null");
return $this
->assertTrue(isset($value), $message);
}
/**
* Type and class test. Will pass if class
* matches the type name or is a subclass or
* if not an object, but the type is correct.
* @param mixed $object Object to test.
* @param string $type Type name as string.
* @param string $message Message to display.
* @return boolean True on pass.
* @access public
*/
function assertIsA($object, $type, $message = "%s") {
return $this
->assertExpectation(new IsAExpectation($type), $object, $message);
}
/**
* Type and class mismatch test. Will pass if class
* name or underling type does not match the one
* specified.
* @param mixed $object Object to test.
* @param string $type Type name as string.
* @param string $message Message to display.
* @return boolean True on pass.
* @access public
*/
function assertNotA($object, $type, $message = "%s") {
return $this
->assertExpectation(new NotAExpectation($type), $object, $message);
}
/**
* Will trigger a pass if the two parameters have
* the same value only. Otherwise a fail.
* @param mixed $first Value to compare.
* @param mixed $second Value to compare.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertEqual($first, $second, $message = "%s") {
return $this
->assertExpectation(new EqualExpectation($first), $second, $message);
}
/**
* Will trigger a pass if the two parameters have
* a different value. Otherwise a fail.
* @param mixed $first Value to compare.
* @param mixed $second Value to compare.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertNotEqual($first, $second, $message = "%s") {
return $this
->assertExpectation(new NotEqualExpectation($first), $second, $message);
}
/**
* Will trigger a pass if the two parameters have
* the same value and same type. Otherwise a fail.
* @param mixed $first Value to compare.
* @param mixed $second Value to compare.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertIdentical($first, $second, $message = "%s") {
return $this
->assertExpectation(new IdenticalExpectation($first), $second, $message);
}
/**
* Will trigger a pass if the two parameters have
* the different value or different type.
* @param mixed $first Value to compare.
* @param mixed $second Value to compare.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertNotIdentical($first, $second, $message = "%s") {
return $this
->assertExpectation(new NotIdenticalExpectation($first), $second, $message);
}
/**
* Will trigger a pass if both parameters refer
* to the same object. Fail otherwise.
* @param mixed $first Object reference to check.
* @param mixed $second Hopefully the same object.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertReference(&$first, &$second, $message = "%s") {
$dumper =& new SimpleDumper();
$message = sprintf($message, "[" . $dumper
->describeValue($first) . "] and [" . $dumper
->describeValue($second) . "] should reference the same object");
return $this
->assertTrue(SimpleTestCompatibility::isReference($first, $second), $message);
}
/**
* Will trigger a pass if both parameters refer
* to different objects. Fail otherwise.
* @param mixed $first Object reference to check.
* @param mixed $second Hopefully not the same object.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertCopy(&$first, &$second, $message = "%s") {
$dumper =& new SimpleDumper();
$message = sprintf($message, "[" . $dumper
->describeValue($first) . "] and [" . $dumper
->describeValue($second) . "] should not be the same object");
return $this
->assertFalse(SimpleTestCompatibility::isReference($first, $second), $message);
}
/**
* Will trigger a pass if the Perl regex pattern
* is found in the subject. Fail otherwise.
* @param string $pattern Perl regex to look for including
* the regex delimiters.
* @param string $subject String to search in.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertWantedPattern($pattern, $subject, $message = "%s") {
return $this
->assertExpectation(new WantedPatternExpectation($pattern), $subject, $message);
}
/**
* Will trigger a pass if the Perl regex pattern
* is not present in subject. Fail if found.
* @param string $pattern Perl regex to look for including
* the regex delimiters.
* @param string $subject String to search in.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertNoUnwantedPattern($pattern, $subject, $message = "%s") {
return $this
->assertExpectation(new UnwantedPatternExpectation($pattern), $subject, $message);
}
/**
* Confirms that no errors have occurred so
* far in the test method.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertNoErrors($message = "%s") {
$queue =& SimpleErrorQueue::instance();
return $this
->assertTrue($queue
->isEmpty(), sprintf($message, "Should be no errors"));
}
/**
* Confirms that an error has occurred and
* optionally that the error text matches exactly.
* @param string $expected Expected error text or
* false for no check.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertError($expected = false, $message = "%s") {
$queue =& SimpleErrorQueue::instance();
if ($queue
->isEmpty()) {
$this
->fail(sprintf($message, "Expected error not found"));
return;
}
list($severity, $content, $file, $line, $globals) = $queue
->extract();
$severity = SimpleErrorQueue::getSeverityAsString($severity);
return $this
->assertTrue(!$expected || $expected == $content, "Expected [{$expected}] in PHP error [{$content}] severity [{$severity}] in [{$file}] line [{$line}]");
}
/**
* Confirms that an error has occurred and
* that the error text matches a Perl regular
* expression.
* @param string $pattern Perl regular expression to
* match against.
* @param string $message Message to display.
* @return boolean True on pass
* @access public
*/
function assertErrorPattern($pattern, $message = "%s") {
$queue =& SimpleErrorQueue::instance();
if ($queue
->isEmpty()) {
$this
->fail(sprintf($message, "Expected error not found"));
return;
}
list($severity, $content, $file, $line, $globals) = $queue
->extract();
$severity = SimpleErrorQueue::getSeverityAsString($severity);
return $this
->assertTrue((bool) preg_match($pattern, $content), "Expected pattern match [{$pattern}] in PHP error [{$content}] severity [{$severity}] in [{$file}] line [{$line}]");
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DrupalTestCase:: |
property | |||
DrupalTestCase:: |
property | |||
DrupalTestCase:: |
property | |||
DrupalTestCase:: |
property | |||
DrupalTestCase:: |
property | |||
DrupalTestCase:: |
function | Will trigger a pass if both parameters refer to different objects. Fail otherwise. | ||
DrupalTestCase:: |
function | Will trigger a pass if the two parameters have the same value only. Otherwise a fail. | ||
DrupalTestCase:: |
function | Confirms that an error has occurred and optionally that the error text matches exactly. | ||
DrupalTestCase:: |
function | Confirms that an error has occurred and that the error text matches a Perl regular expression. | ||
DrupalTestCase:: |
function | Will trigger a pass if the two parameters have the same value and same type. Otherwise a fail. | ||
DrupalTestCase:: |
function | Type and class test. Will pass if class matches the type name or is a subclass or if not an object, but the type is correct. | ||
DrupalTestCase:: |
function | Confirms that no errors have occurred so far in the test method. | ||
DrupalTestCase:: |
function | Type and class mismatch test. Will pass if class name or underling type does not match the one specified. | ||
DrupalTestCase:: |
function | Will trigger a pass if the two parameters have a different value. Otherwise a fail. | ||
DrupalTestCase:: |
function | Will trigger a pass if the two parameters have the different value or different type. | ||
DrupalTestCase:: |
function | Will be true if the value is set. | ||
DrupalTestCase:: |
function | Will trigger a pass if the Perl regex pattern is not present in subject. Fail if found. | ||
DrupalTestCase:: |
function | Will trigger a pass if the raw text is NOT found on the loaded page Fail otherwise. | ||
DrupalTestCase:: |
function | Will be true if the value is null. | ||
DrupalTestCase:: |
function | Will trigger a pass if both parameters refer to the same object. Fail otherwise. | ||
DrupalTestCase:: |
function | Will trigger a pass if the Perl regex pattern is found in the subject. Fail otherwise. | ||
DrupalTestCase:: |
function | Will trigger a pass if the raw text is found on the loaded page Fail otherwise. | ||
DrupalTestCase:: |
function | Follows a link by name. Will click the first link found with this link text by default, or a later one if an index is given. Match is case insensitive with normalised space. Does make assertations if the click was sucessful or not and it does… | ||
DrupalTestCase:: |
function | @abstract Checks to see if we need to send a http-auth header to authenticate when browsing a site. | ||
DrupalTestCase:: |
function | Create a role / perm combination specified by permissions | ||
DrupalTestCase:: |
function | Creates a user / role / permissions combination specified by permissions | ||
DrupalTestCase:: |
function | @abstract Brokder for the get function adds the authentication headers if necessary @author Earnest Berry III <earnest.berry@gmail.com> | ||
DrupalTestCase:: |
function | @TODO: needs documentation | ||
DrupalTestCase:: |
function | Logs in a user with the internal browser | ||
DrupalTestCase:: |
function | Disables a drupal module | ||
DrupalTestCase:: |
function | Enables a drupal module | ||
DrupalTestCase:: |
function | Do a post request on a drupal page. It will be done as usual post request with SimpleBrowser | ||
DrupalTestCase:: |
function | @abstract Broker for the post function adds the authentication headers if necessary @author Earnest Berry III <earnest.berry@gmail.com> | ||
DrupalTestCase:: |
function | |||
DrupalTestCase:: |
function | Set a druapl variable and keep track of the changes for tearDown() | ||
DrupalTestCase:: |
function | Generates a random string, to be used as name or whatever | ||
DrupalTestCase:: |
function | Just some info for the reporter | ||
DrupalTestCase:: |
function | tearDown implementation, setting back switched modules etc | 1 |