class DrupalUnitTestCase
Test case for Drupal unit tests.
These tests can not access the database nor files. Calling any Drupal function that needs the database will throw exceptions. These include watchdog(), module_implements(), module_invoke_all() etc.
Hierarchy
- class \DrupalTestCase
- class \DrupalUnitTestCase extends \DrupalTestCase
Expanded class hierarchy of DrupalUnitTestCase
File
-
modules/
simpletest/ drupal_web_test_case.php, line 752
View source
class DrupalUnitTestCase extends DrupalTestCase {
/**
* Constructor for DrupalUnitTestCase.
*/
function __construct($test_id = NULL) {
parent::__construct($test_id);
$this->skipClasses[__CLASS__] = TRUE;
}
/**
* Sets up unit test environment.
*
* Unlike DrupalWebTestCase::setUp(), DrupalUnitTestCase::setUp() does not
* install modules because tests are performed without accessing the database.
* Any required files must be explicitly included by the child class setUp()
* method.
*/
protected function setUp() {
global $conf, $language;
// Store necessary current values before switching to the test environment.
$this->originalFileDirectory = variable_get('file_public_path', conf_path() . '/files');
$this->verboseDirectoryUrl = file_create_url($this->originalFileDirectory . '/simpletest/verbose');
// Set up English language.
$this->originalLanguage = $language;
$this->originalLanguageDefault = variable_get('language_default');
unset($conf['language_default']);
$language = language_default();
// Reset all statics so that test is performed with a clean environment.
drupal_static_reset();
// Generate temporary prefixed database to ensure that tests have a clean starting point.
$this->databasePrefix = Database::getConnection()->prefixTables('{simpletest' . mt_rand(1000, 1000000) . '}');
// Create test directory.
$public_files_directory = $this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10);
file_prepare_directory($public_files_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
$conf['file_public_path'] = $public_files_directory;
// Clone the current connection and replace the current prefix.
$connection_info = Database::getConnectionInfo('default');
Database::renameConnection('default', 'simpletest_original_default');
foreach ($connection_info as $target => $value) {
$connection_info[$target]['prefix'] = array(
'default' => $value['prefix']['default'] . $this->databasePrefix,
);
}
Database::addConnectionInfo('default', 'default', $connection_info['default']);
// Set user agent to be consistent with web test case.
$_SERVER['HTTP_USER_AGENT'] = $this->databasePrefix;
// If locale is enabled then t() will try to access the database and
// subsequently will fail as the database is not accessible.
$module_list = module_list();
if (isset($module_list['locale'])) {
// Transform the list into the format expected as input to module_list().
foreach ($module_list as &$module) {
$module = array(
'filename' => drupal_get_filename('module', $module),
);
}
$this->originalModuleList = $module_list;
unset($module_list['locale']);
module_list(TRUE, FALSE, FALSE, $module_list);
}
$this->setup = TRUE;
}
protected function tearDown() {
global $conf, $language;
// Get back to the original connection.
Database::removeConnection('default');
Database::renameConnection('simpletest_original_default', 'default');
$conf['file_public_path'] = $this->originalFileDirectory;
// Restore modules if necessary.
if (isset($this->originalModuleList)) {
module_list(TRUE, FALSE, FALSE, $this->originalModuleList);
}
// Reset language.
$language = $this->originalLanguage;
if ($this->originalLanguageDefault) {
$GLOBALS['conf']['language_default'] = $this->originalLanguageDefault;
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DrupalTestCase::$assertions | protected | property | Assertions thrown in that test case. | ||
DrupalTestCase::$databasePrefix | protected | property | The database prefix of this test run. | ||
DrupalTestCase::$originalFileDirectory | protected | property | The original file directory, before it was changed for testing purposes. | ||
DrupalTestCase::$originalLanguage | protected | property | The original language. | ||
DrupalTestCase::$originalLanguageDefault | protected | property | The original default language. | ||
DrupalTestCase::$originalTheme | protected | property | The original theme. | ||
DrupalTestCase::$originalThemeKey | protected | property | The original theme key. | ||
DrupalTestCase::$originalThemePath | protected | property | The original theme path. | ||
DrupalTestCase::$results | public | property | Current results of this test case. | ||
DrupalTestCase::$setup | protected | property | Flag to indicate whether the test has been set up. | ||
DrupalTestCase::$setupDatabasePrefix | protected | property | |||
DrupalTestCase::$setupEnvironment | protected | property | |||
DrupalTestCase::$skipClasses | protected | property | This class is skipped when looking for the source of an assertion. | ||
DrupalTestCase::$testId | protected | property | The test run ID. | ||
DrupalTestCase::$timeLimit | protected | property | Time limit for the test. | ||
DrupalTestCase::$useSetupInstallationCache | public | property | Whether to cache the installation part of the setUp() method. | ||
DrupalTestCase::$useSetupModulesCache | public | property | Whether to cache the modules installation part of the setUp() method. | ||
DrupalTestCase::$verboseDirectoryUrl | protected | property | URL to the verbose output file directory. | ||
DrupalTestCase::assert | protected | function | Internal helper: stores the assert. | ||
DrupalTestCase::assertEqual | protected | function | Check to see if two values are equal. | ||
DrupalTestCase::assertFalse | protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | ||
DrupalTestCase::assertIdentical | protected | function | Check to see if two values are identical. | ||
DrupalTestCase::assertNotEqual | protected | function | Check to see if two values are not equal. | ||
DrupalTestCase::assertNotIdentical | protected | function | Check to see if two values are not identical. | ||
DrupalTestCase::assertNotNull | protected | function | Check to see if a value is not NULL. | ||
DrupalTestCase::assertNull | protected | function | Check to see if a value is NULL. | ||
DrupalTestCase::assertTrue | protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | ||
DrupalTestCase::deleteAssert | public static | function | Delete an assertion record by message ID. | ||
DrupalTestCase::error | protected | function | Fire an error assertion. | 1 | |
DrupalTestCase::errorHandler | public | function | Handle errors during test runs. | 1 | |
DrupalTestCase::exceptionHandler | protected | function | Handle exceptions. | ||
DrupalTestCase::fail | protected | function | Fire an assertion that is always negative. | ||
DrupalTestCase::generatePermutations | public static | function | Converts a list of possible parameters into a stack of permutations. | ||
DrupalTestCase::getAssertionCall | protected | function | Cycles through backtrace until the first non-assertion method is found. | ||
DrupalTestCase::getDatabaseConnection | public static | function | Returns the database connection to the site running Simpletest. | ||
DrupalTestCase::insertAssert | public static | function | Store an assertion from outside the testing context. | ||
DrupalTestCase::pass | protected | function | Fire an assertion that is always positive. | ||
DrupalTestCase::randomName | public static | function | Generates a random string containing letters and numbers. | ||
DrupalTestCase::randomString | public static | function | Generates a random string of ASCII characters of codes 32 to 126. | ||
DrupalTestCase::run | public | function | Run all tests in this class. | ||
DrupalTestCase::verbose | protected | function | Logs a verbose message in a text file. | ||
DrupalUnitTestCase::setUp | protected | function | Sets up unit test environment. | 10 | |
DrupalUnitTestCase::tearDown | protected | function | 1 | ||
DrupalUnitTestCase::__construct | function | Constructor for DrupalUnitTestCase. | Overrides DrupalTestCase::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.