abstract class TestBase in SimpleTest 8.3
Base class for Drupal tests.
Do not extend this class directly; use \Drupal\simpletest\WebTestBase.
Hierarchy
- class \Drupal\simpletest\TestBase uses TestSetupTrait, AssertHelperTrait, ConfigTestTrait, RandomGeneratorTrait, GeneratePermutationsTrait
Expanded class hierarchy of TestBase
Deprecated
in Drupal 8.8.0 and will be removed before Drupal 9.0.0. Instead, use one of the phpunit base test classes like Drupal\Tests\BrowserTestBase. See https://www.drupal.org/node/3030340.
File
- src/
TestBase.php, line 32
Namespace
Drupal\simpletestView source
abstract class TestBase {
use BaseAssertHelperTrait;
use TestSetupTrait;
use RandomGeneratorTrait;
use GeneratePermutationsTrait;
// For backwards compatibility switch the visibility of the methods to public.
use ConfigTestTrait {
configImporter as public;
copyConfig as public;
}
/**
* The database prefix of this test run.
*
* @var string
*/
protected $databasePrefix = NULL;
/**
* Time limit for the test.
*
* @var int
*/
protected $timeLimit = 500;
/**
* Current results of this test case.
*
* @var array
*/
public $results = [
'#pass' => 0,
'#fail' => 0,
'#exception' => 0,
'#debug' => 0,
];
/**
* Assertions thrown in that test case.
*
* @var array
*/
protected $assertions = [];
/**
* This class is skipped when looking for the source of an assertion.
*
* When displaying which function an assert comes from, it's not too useful
* to see "WebTestBase->drupalLogin()', we would like to see the test
* that called it. So we need to skip the classes defining these helper
* methods.
*/
protected $skipClasses = [
__CLASS__ => TRUE,
];
/**
* TRUE if verbose debugging is enabled.
*
* @var bool
*/
public $verbose;
/**
* Incrementing identifier for verbose output filenames.
*
* @var int
*/
protected $verboseId = 0;
/**
* Safe class name for use in verbose output filenames.
*
* Namespaces separator (\) replaced with _.
*
* @var string
*/
protected $verboseClassName;
/**
* Directory where verbose output files are put.
*
* @var string
*/
protected $verboseDirectory;
/**
* URL to the verbose output file directory.
*
* @var string
*/
protected $verboseDirectoryUrl;
/**
* The original configuration (variables), if available.
*
* @var string
* @todo Remove all remnants of $GLOBALS['conf'].
* @see https://www.drupal.org/node/2183323
*/
protected $originalConf;
/**
* The original configuration (variables).
*
* @var string
*/
protected $originalConfig;
/**
* The original configuration directories.
*
* An array of paths keyed by the CONFIG_*_DIRECTORY constants defined by
* core/includes/bootstrap.inc.
*
* @var array
*/
protected $originalConfigDirectories;
/**
* The original container.
*
* @var \Symfony\Component\DependencyInjection\ContainerInterface
*/
protected $originalContainer;
/**
* The original file directory, before it was changed for testing purposes.
*
* @var string
*/
protected $originalFileDirectory = NULL;
/**
* The original language.
*
* @var \Drupal\Core\Language\LanguageInterface
*/
protected $originalLanguage;
/**
* The original database prefix when running inside Simpletest.
*
* @var string
*/
protected $originalPrefix;
/**
* The name of the session cookie of the test-runner.
*
* @var string
*/
protected $originalSessionName;
/**
* The settings array.
*
* @var array
*/
protected $originalSettings;
/**
* The original array of shutdown function callbacks.
*
* @var array
*/
protected $originalShutdownCallbacks;
/**
* The original user, before testing began.
*
* @var \Drupal\Core\Session\AccountProxyInterface
*/
protected $originalUser;
/**
* The translation file directory for the test environment.
*
* This is set in TestBase::prepareEnvironment().
*
* @var string
*/
protected $translationFilesDirectory;
/**
* Whether to die in case any test assertion fails.
*
* @var bool
*
* @see run-tests.sh
*/
public $dieOnFail = FALSE;
/**
* The config importer that can used in a test.
*
* @var \Drupal\Core\Config\ConfigImporter
*/
protected $configImporter;
/**
* HTTP authentication method (specified as a CURLAUTH_* constant).
*
* @var int
* @see http://php.net/manual/function.curl-setopt.php
*/
protected $httpAuthMethod = CURLAUTH_BASIC;
/**
* HTTP authentication credentials (<username>:<password>).
*
* @var string
*/
protected $httpAuthCredentials = NULL;
/**
* Constructor for Test.
*
* @param $test_id
* Tests with the same id are reported together.
*/
public function __construct($test_id = NULL) {
$this->testId = $test_id;
}
/**
* Fail the test if it belongs to a PHPUnit-based framework.
*
* This would probably be caused by automated test conversions such as those
* in https://www.drupal.org/project/drupal/issues/2770921.
*/
public function checkTestHierarchyMismatch() {
// We can use getPhpunitTestSuite() because it uses a regex on the class'
// namespace to deduce the PHPUnit test suite.
if (TestDiscovery::getPhpunitTestSuite(get_class($this)) !== FALSE) {
$this
->fail(get_class($this) . ' incorrectly subclasses ' . __CLASS__ . ', it should probably extend \\Drupal\\Tests\\BrowserTestBase instead.');
}
}
/**
* Performs setup tasks before each individual test method is run.
*/
protected abstract function setUp();
/**
* Checks the matching requirements for Test.
*
* @return
* Array of errors containing a list of unmet requirements.
*/
protected function checkRequirements() {
return [];
}
/**
* Helper method to store an assertion record in the configured database.
*
* This method decouples database access from assertion logic.
*
* @param array $assertion
* Keyed array representing an assertion, as generated by assert().
*
* @see self::assert()
*
* @return \Drupal\Core\Database\StatementInterface|int|null
* The message ID.
*/
protected function storeAssertion(array $assertion) {
return self::getDatabaseConnection()
->insert('simpletest', [
'return' => Database::RETURN_INSERT_ID,
])
->fields($assertion)
->execute();
}
/**
* Internal helper: stores the assert.
*
* @param $status
* Can be 'pass', 'fail', 'exception', 'debug'.
* TRUE is a synonym for 'pass', FALSE for 'fail'.
* @param string|\Drupal\Component\Render\MarkupInterface $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
* @param $caller
* By default, the assert comes from a function whose name starts with
* 'test'. Instead, you can specify where this assert originates from
* by passing in an associative array as $caller. Key 'file' is
* the name of the source file, 'line' is the line number and 'function'
* is the caller function itself.
*/
protected function assert($status, $message = '', $group = 'Other', array $caller = NULL) {
if ($message instanceof MarkupInterface) {
$message = (string) $message;
}
// Convert boolean status to string status.
if (is_bool($status)) {
$status = $status ? 'pass' : 'fail';
}
// Increment summary result counter.
$this->results['#' . $status]++;
// Get the function information about the call to the assertion method.
if (!$caller) {
$caller = $this
->getAssertionCall();
}
// Creation assertion array that can be displayed while tests are running.
$assertion = [
'test_id' => $this->testId,
'test_class' => get_class($this),
'status' => $status,
'message' => $message,
'message_group' => $group,
'function' => $caller['function'],
'line' => $caller['line'],
'file' => $caller['file'],
];
// Store assertion for display after the test has completed.
$message_id = $this
->storeAssertion($assertion);
$assertion['message_id'] = $message_id;
$this->assertions[] = $assertion;
// We do not use a ternary operator here to allow a breakpoint on
// test failure.
if ($status == 'pass') {
return TRUE;
}
else {
if ($this->dieOnFail && ($status == 'fail' || $status == 'exception')) {
exit(1);
}
return FALSE;
}
}
/**
* Store an assertion from outside the testing context.
*
* This is useful for inserting assertions that can only be recorded after
* the test case has been destroyed, such as PHP fatal errors. The caller
* information is not automatically gathered since the caller is most likely
* inserting the assertion on behalf of other code. In all other respects
* the method behaves just like \Drupal\simpletest\TestBase::assert() in terms
* of storing the assertion.
*
* @return
* Message ID of the stored assertion.
*
* @deprecated in Drupal 8.8.0 and will be removed before Drupal 9.0.0. Use
* simpletest_insert_assert() instead.
*
* @see https://www.drupal.org/node/3030340
* @see \Drupal\simpletest\TestBase::assert()
* @see \Drupal\simpletest\TestBase::deleteAssert()
*/
public static function insertAssert($test_id, $test_class, $status, $message = '', $group = 'Other', array $caller = []) {
// Convert boolean status to string status.
if (is_bool($status)) {
$status = $status ? 'pass' : 'fail';
}
$caller += [
'function' => 'Unknown',
'line' => 0,
'file' => 'Unknown',
];
$assertion = [
'test_id' => $test_id,
'test_class' => $test_class,
'status' => $status,
'message' => $message,
'message_group' => $group,
'function' => $caller['function'],
'line' => $caller['line'],
'file' => $caller['file'],
];
// We can't use storeAssertion() because this method is static.
return self::getDatabaseConnection()
->insert('simpletest')
->fields($assertion)
->execute();
}
/**
* Delete an assertion record by message ID.
*
* @param $message_id
* Message ID of the assertion to delete.
*
* @return
* TRUE if the assertion was deleted, FALSE otherwise.
*
* @see \Drupal\simpletest\TestBase::insertAssert()
*/
public static function deleteAssert($message_id) {
// We can't use storeAssertion() because this method is static.
return (bool) self::getDatabaseConnection()
->delete('simpletest')
->condition('message_id', $message_id)
->execute();
}
/**
* Cycles through backtrace until the first non-assertion method is found.
*
* @return
* Array representing the true caller.
*/
protected function getAssertionCall() {
$backtrace = debug_backtrace();
// The first element is the call. The second element is the caller.
// We skip calls that occurred in one of the methods of our base classes
// or in an assertion function.
while (($caller = $backtrace[1]) && (isset($caller['class']) && isset($this->skipClasses[$caller['class']]) || substr($caller['function'], 0, 6) == 'assert')) {
// We remove that call.
array_shift($backtrace);
}
return Error::getLastCaller($backtrace);
}
/**
* Check to see if a value is not false.
*
* False values are: empty string, 0, NULL, and FALSE.
*
* @param $value
* The value on which the assertion is to be done.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertTrue($value, $message = '', $group = 'Other') {
return $this
->assert((bool) $value, $message ? $message : new FormattableMarkup('Value @value is TRUE.', [
'@value' => var_export($value, TRUE),
]), $group);
}
/**
* Check to see if a value is false.
*
* False values are: empty string, 0, NULL, and FALSE.
*
* @param $value
* The value on which the assertion is to be done.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertFalse($value, $message = '', $group = 'Other') {
return $this
->assert(!$value, $message ? $message : new FormattableMarkup('Value @value is FALSE.', [
'@value' => var_export($value, TRUE),
]), $group);
}
/**
* Check to see if a value is NULL.
*
* @param $value
* The value on which the assertion is to be done.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNull($value, $message = '', $group = 'Other') {
return $this
->assert(!isset($value), $message ? $message : new FormattableMarkup('Value @value is NULL.', [
'@value' => var_export($value, TRUE),
]), $group);
}
/**
* Check to see if a value is not NULL.
*
* @param $value
* The value on which the assertion is to be done.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNotNull($value, $message = '', $group = 'Other') {
return $this
->assert(isset($value), $message ? $message : new FormattableMarkup('Value @value is not NULL.', [
'@value' => var_export($value, TRUE),
]), $group);
}
/**
* Check to see if two values are equal.
*
* @param $first
* The first value to check.
* @param $second
* The second value to check.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertEqual($first, $second, $message = '', $group = 'Other') {
// Cast objects implementing MarkupInterface to string instead of
// relying on PHP casting them to string depending on what they are being
// comparing with.
$first = $this
->castSafeStrings($first);
$second = $this
->castSafeStrings($second);
$is_equal = $first == $second;
if (!$is_equal || !$message) {
$default_message = new FormattableMarkup('Value @first is equal to value @second.', [
'@first' => var_export($first, TRUE),
'@second' => var_export($second, TRUE),
]);
$message = $message ? $message . PHP_EOL . $default_message : $default_message;
}
return $this
->assert($is_equal, $message, $group);
}
/**
* Check to see if two values are not equal.
*
* @param $first
* The first value to check.
* @param $second
* The second value to check.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNotEqual($first, $second, $message = '', $group = 'Other') {
// Cast objects implementing MarkupInterface to string instead of
// relying on PHP casting them to string depending on what they are being
// comparing with.
$first = $this
->castSafeStrings($first);
$second = $this
->castSafeStrings($second);
$not_equal = $first != $second;
if (!$not_equal || !$message) {
$default_message = new FormattableMarkup('Value @first is not equal to value @second.', [
'@first' => var_export($first, TRUE),
'@second' => var_export($second, TRUE),
]);
$message = $message ? $message . PHP_EOL . $default_message : $default_message;
}
return $this
->assert($not_equal, $message, $group);
}
/**
* Check to see if two values are identical.
*
* @param $first
* The first value to check.
* @param $second
* The second value to check.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertIdentical($first, $second, $message = '', $group = 'Other') {
$is_identical = $first === $second;
if (!$is_identical || !$message) {
$default_message = new FormattableMarkup('Value @first is identical to value @second.', [
'@first' => var_export($first, TRUE),
'@second' => var_export($second, TRUE),
]);
$message = $message ? $message . PHP_EOL . $default_message : $default_message;
}
return $this
->assert($is_identical, $message, $group);
}
/**
* Check to see if two values are not identical.
*
* @param $first
* The first value to check.
* @param $second
* The second value to check.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNotIdentical($first, $second, $message = '', $group = 'Other') {
$not_identical = $first !== $second;
if (!$not_identical || !$message) {
$default_message = new FormattableMarkup('Value @first is not identical to value @second.', [
'@first' => var_export($first, TRUE),
'@second' => var_export($second, TRUE),
]);
$message = $message ? $message . PHP_EOL . $default_message : $default_message;
}
return $this
->assert($not_identical, $message, $group);
}
/**
* Checks to see if two objects are identical.
*
* @param object $object1
* The first object to check.
* @param object $object2
* The second object to check.
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertIdenticalObject($object1, $object2, $message = '', $group = 'Other') {
$message = $message ?: new FormattableMarkup('@object1 is identical to @object2', [
'@object1' => var_export($object1, TRUE),
'@object2' => var_export($object2, TRUE),
]);
$identical = TRUE;
foreach ($object1 as $key => $value) {
$identical = $identical && isset($object2->{$key}) && $object2->{$key} === $value;
}
return $this
->assertTrue($identical, $message, $group);
}
/**
* Asserts that no errors have been logged to the PHP error.log thus far.
*
* @return bool
* TRUE if the assertion succeeded, FALSE otherwise.
*
* @see \Drupal\simpletest\TestBase::prepareEnvironment()
* @see \Drupal\Core\DrupalKernel::bootConfiguration()
*/
protected function assertNoErrorsLogged() {
// Since PHP only creates the error.log file when an actual error is
// triggered, it is sufficient to check whether the file exists.
return $this
->assertFalse(file_exists(DRUPAL_ROOT . '/' . $this->siteDirectory . '/error.log'), 'PHP error.log is empty.');
}
/**
* Asserts that a specific error has been logged to the PHP error log.
*
* @param string $error_message
* The expected error message.
*
* @return bool
* TRUE if the assertion succeeded, FALSE otherwise.
*
* @see \Drupal\simpletest\TestBase::prepareEnvironment()
* @see \Drupal\Core\DrupalKernel::bootConfiguration()
*/
protected function assertErrorLogged($error_message) {
$error_log_filename = DRUPAL_ROOT . '/' . $this->siteDirectory . '/error.log';
if (!file_exists($error_log_filename)) {
$this
->error('No error logged yet.');
}
$content = file_get_contents($error_log_filename);
$rows = explode(PHP_EOL, $content);
// We iterate over the rows in order to be able to remove the logged error
// afterwards.
$found = FALSE;
foreach ($rows as $row_index => $row) {
if (strpos($content, $error_message) !== FALSE) {
$found = TRUE;
unset($rows[$row_index]);
}
}
file_put_contents($error_log_filename, implode("\n", $rows));
return $this
->assertTrue($found, sprintf('The %s error message was logged.', $error_message));
}
/**
* Fire an assertion that is always positive.
*
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* TRUE.
*/
protected function pass($message = NULL, $group = 'Other') {
return $this
->assert(TRUE, $message, $group);
}
/**
* Fire an assertion that is always negative.
*
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*
* @return
* FALSE.
*/
protected function fail($message = NULL, $group = 'Other') {
return $this
->assert(FALSE, $message, $group);
}
/**
* Fire an error assertion.
*
* @param $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
* @param $caller
* The caller of the error.
*
* @return
* FALSE.
*/
protected function error($message = '', $group = 'Other', array $caller = NULL) {
if ($group == 'User notice') {
// Since 'User notice' is set by trigger_error() which is used for debug
// set the message to a status of 'debug'.
return $this
->assert('debug', $message, 'Debug', $caller);
}
return $this
->assert('exception', $message, $group, $caller);
}
/**
* Logs a verbose message in a text file.
*
* The link to the verbose message will be placed in the test results as a
* passing assertion with the text '[verbose message]'.
*
* @param $message
* The verbose message to be stored.
*
* @see simpletest_verbose()
*/
protected function verbose($message) {
// Do nothing if verbose debugging is disabled.
if (!$this->verbose) {
return;
}
$message = '<hr />ID #' . $this->verboseId . ' (<a href="' . $this->verboseClassName . '-' . ($this->verboseId - 1) . '-' . $this->testId . '.html">Previous</a> | <a href="' . $this->verboseClassName . '-' . ($this->verboseId + 1) . '-' . $this->testId . '.html">Next</a>)<hr />' . $message;
$verbose_filename = $this->verboseClassName . '-' . $this->verboseId . '-' . $this->testId . '.html';
if (file_put_contents($this->verboseDirectory . '/' . $verbose_filename, $message)) {
$url = $this->verboseDirectoryUrl . '/' . $verbose_filename;
// Not using \Drupal\Core\Utility\LinkGeneratorInterface::generate()
// to avoid invoking the theme system, so that unit tests
// can use verbose() as well.
$url = '<a href="' . $url . '" target="_blank">Verbose message</a>';
$this
->error($url, 'User notice');
}
$this->verboseId++;
}
/**
* Run all tests in this class.
*
* Regardless of whether $methods are passed or not, only method names
* starting with "test" are executed.
*
* @param $methods
* (optional) A list of method names in the test case class to run; e.g.,
* array('testFoo', 'testBar'). By default, all methods of the class are
* taken into account, but it can be useful to only run a few selected test
* methods during debugging.
*/
public function run(array $methods = []) {
$this
->checkTestHierarchyMismatch();
$class = get_class($this);
if ($missing_requirements = $this
->checkRequirements()) {
$object_info = new \ReflectionObject($this);
$caller = [
'file' => $object_info
->getFileName(),
];
foreach ($missing_requirements as $missing_requirement) {
TestBase::insertAssert($this->testId, $class, FALSE, $missing_requirement, 'Requirements check', $caller);
}
return;
}
TestServiceProvider::$currentTest = $this;
$simpletest_config = $this
->config('simpletest.settings');
// Unless preset from run-tests.sh, retrieve the current verbose setting.
if (!isset($this->verbose)) {
$this->verbose = $simpletest_config
->get('verbose');
}
if ($this->verbose) {
// Initialize verbose debugging.
$this->verbose = TRUE;
$this->verboseDirectory = PublicStream::basePath() . '/simpletest/verbose';
$this->verboseDirectoryUrl = file_create_url($this->verboseDirectory);
if (\Drupal::service('file_system')
->prepareDirectory($this->verboseDirectory, FileSystemInterface::CREATE_DIRECTORY) && !file_exists($this->verboseDirectory . '/.htaccess')) {
file_put_contents($this->verboseDirectory . '/.htaccess', "<IfModule mod_expires.c>\nExpiresActive Off\n</IfModule>\n");
}
$this->verboseClassName = str_replace("\\", "_", $class);
}
// HTTP auth settings (<username>:<password>) for the simpletest browser
// when sending requests to the test site.
$this->httpAuthMethod = (int) $simpletest_config
->get('httpauth.method');
$username = $simpletest_config
->get('httpauth.username');
$password = $simpletest_config
->get('httpauth.password');
if (!empty($username) && !empty($password)) {
$this->httpAuthCredentials = $username . ':' . $password;
}
// Force assertion failures to be thrown as exceptions.
Handle::register();
set_error_handler([
$this,
'errorHandler',
]);
// Iterate through all the methods in this class, unless a specific list of
// methods to run was passed.
$test_methods = array_filter(get_class_methods($class), function ($method) {
return strpos($method, 'test') === 0;
});
if (empty($test_methods)) {
// Call $this->assert() here because we need to pass along custom caller
// information, lest the wrong originating code file/line be identified.
$this
->assert(FALSE, 'No test methods found.', 'Requirements', [
'function' => __METHOD__ . '()',
'file' => __FILE__,
'line' => __LINE__,
]);
}
if ($methods) {
$test_methods = array_intersect($test_methods, $methods);
}
foreach ($test_methods as $method) {
// Insert a fail record. This will be deleted on completion to ensure
// that testing completed.
$method_info = new \ReflectionMethod($class, $method);
$caller = [
'file' => $method_info
->getFileName(),
'line' => $method_info
->getStartLine(),
'function' => $class . '->' . $method . '()',
];
$test_completion_check_id = TestBase::insertAssert($this->testId, $class, FALSE, 'The test did not complete due to a fatal error.', 'Completion check', $caller);
try {
$this
->prepareEnvironment();
} catch (\Exception $e) {
$this
->exceptionHandler($e);
// The prepareEnvironment() method isolates the test from the parent
// Drupal site by creating a random database prefix and test site
// directory. If this fails, a test would possibly operate in the
// parent site. Therefore, the entire test run for this test class
// has to be aborted.
// restoreEnvironment() cannot be called, because we do not know
// where exactly the environment setup failed.
break;
}
try {
$this
->setUp();
} catch (\Exception $e) {
$this
->exceptionHandler($e);
// Abort if setUp() fails, since all test methods will fail.
// But ensure to clean up and restore the environment, since
// prepareEnvironment() succeeded.
$this
->restoreEnvironment();
break;
}
try {
$this
->{$method}();
} catch (\Exception $e) {
$this
->exceptionHandler($e);
}
try {
$this
->tearDown();
} catch (\Exception $e) {
$this
->exceptionHandler($e);
// If a test fails to tear down, abort the entire test class, since
// it is likely that all tests will fail in the same way and a
// failure here only results in additional test artifacts that have
// to be manually deleted.
$this
->restoreEnvironment();
break;
}
$this
->restoreEnvironment();
// Remove the test method completion check record.
TestBase::deleteAssert($test_completion_check_id);
}
TestServiceProvider::$currentTest = NULL;
// Clear out the error messages and restore error handler.
\Drupal::messenger()
->deleteAll();
restore_error_handler();
}
/**
* Generates a database prefix for running tests.
*
* The database prefix is used by prepareEnvironment() to setup a public files
* directory for the test to be run, which also contains the PHP error log,
* which is written to in case of a fatal error. Since that directory is based
* on the database prefix, all tests (even unit tests) need to have one, in
* order to access and read the error log.
*
* @see TestBase::prepareEnvironment()
*
* The generated database table prefix is used for the Drupal installation
* being performed for the test. It is also used as user agent HTTP header
* value by the cURL-based browser of WebTestBase, which is sent to the Drupal
* installation of the test. During early Drupal bootstrap, the user agent
* HTTP header is parsed, and if it matches, all database queries use the
* database table prefix that has been generated here.
*
* @see WebTestBase::curlInitialize()
* @see drupal_valid_test_ua()
*/
private function prepareDatabasePrefix() {
$test_db = new TestDatabase();
$this->siteDirectory = $test_db
->getTestSitePath();
$this->databasePrefix = $test_db
->getDatabasePrefix();
// As soon as the database prefix is set, the test might start to execute.
// All assertions as well as the SimpleTest batch operations are associated
// with the testId, so the database prefix has to be associated with it.
$affected_rows = self::getDatabaseConnection()
->update('simpletest_test_id')
->fields([
'last_prefix' => $this->databasePrefix,
])
->condition('test_id', $this->testId)
->execute();
if (!$affected_rows) {
throw new \RuntimeException('Failed to set up database prefix.');
}
}
/**
* Act on global state information before the environment is altered for a test.
*
* Allows e.g. KernelTestBase to prime system/extension info from the
* parent site (and inject it into the test environment so as to improve
* performance).
*/
protected function beforePrepareEnvironment() {
}
/**
* Prepares the current environment for running the test.
*
* Backups various current environment variables and resets them, so they do
* not interfere with the Drupal site installation in which tests are executed
* and can be restored in TestBase::restoreEnvironment().
*
* Also sets up new resources for the testing environment, such as the public
* filesystem and configuration directories.
*
* This method is private as it must only be called once by TestBase::run()
* (multiple invocations for the same test would have unpredictable
* consequences) and it must not be callable or overridable by test classes.
*
* @see TestBase::beforePrepareEnvironment()
*/
private function prepareEnvironment() {
$user = \Drupal::currentUser();
// Allow (base) test classes to backup global state information.
$this
->beforePrepareEnvironment();
// Create the database prefix for this test.
$this
->prepareDatabasePrefix();
$language_interface = \Drupal::languageManager()
->getCurrentLanguage();
// When running the test runner within a test, back up the original database
// prefix.
if (DRUPAL_TEST_IN_CHILD_SITE) {
$this->originalPrefix = drupal_valid_test_ua();
}
// Backup current in-memory configuration.
$site_path = \Drupal::service('site.path');
$this->originalSite = $site_path;
$this->originalSettings = Settings::getAll();
$this->originalConfig = $GLOBALS['config'];
// @todo Remove all remnants of $GLOBALS['conf'].
// @see https://www.drupal.org/node/2183323
$this->originalConf = isset($GLOBALS['conf']) ? $GLOBALS['conf'] : NULL;
// Backup statics and globals.
$this->originalContainer = \Drupal::getContainer();
$this->originalLanguage = $language_interface;
// Save further contextual information.
// Use the original files directory to avoid nesting it within an existing
// simpletest directory if a test is executed within a test.
$this->originalFileDirectory = Settings::get('file_public_path', $site_path . '/files');
$this->originalUser = isset($user) ? clone $user : NULL;
// Prevent that session data is leaked into the UI test runner by closing
// the session and then setting the session-name (i.e. the name of the
// session cookie) to a random value. If a test starts a new session, then
// it will be associated with a different session-name. After the test-run
// it can be safely destroyed.
// @see TestBase::restoreEnvironment()
if (PHP_SAPI !== 'cli' && session_status() === PHP_SESSION_ACTIVE) {
session_write_close();
}
$this->originalSessionName = session_name();
session_name('SIMPLETEST' . Crypt::randomBytesBase64());
// Save and clean the shutdown callbacks array because it is static cached
// and will be changed by the test run. Otherwise it will contain callbacks
// from both environments and the testing environment will try to call the
// handlers defined by the original one.
$callbacks =& drupal_register_shutdown_function();
$this->originalShutdownCallbacks = $callbacks;
$callbacks = [];
// Create test directory ahead of installation so fatal errors and debug
// information can be logged during installation process.
\Drupal::service('file_system')
->prepareDirectory($this->siteDirectory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
// Prepare filesystem directory paths.
$this->publicFilesDirectory = $this->siteDirectory . '/files';
$this->privateFilesDirectory = $this->siteDirectory . '/private';
$this->tempFilesDirectory = $this->siteDirectory . '/temp';
$this->translationFilesDirectory = $this->siteDirectory . '/translations';
$this->generatedTestFiles = FALSE;
// Ensure the configImporter is refreshed for each test.
$this->configImporter = NULL;
// Unregister all custom stream wrappers of the parent site.
// Availability of Drupal stream wrappers varies by test base class:
// - KernelTestBase supports and maintains stream wrappers in a custom
// way.
// - WebTestBase re-initializes Drupal stream wrappers after installation.
// The original stream wrappers are restored after the test run.
// @see TestBase::restoreEnvironment()
$this->originalContainer
->get('stream_wrapper_manager')
->unregister();
// Reset statics.
drupal_static_reset();
// Ensure there is no service container.
$this->container = NULL;
\Drupal::unsetContainer();
// Unset globals.
unset($GLOBALS['config_directories']);
unset($GLOBALS['config']);
unset($GLOBALS['conf']);
// Log fatal errors.
ini_set('log_errors', 1);
ini_set('error_log', DRUPAL_ROOT . '/' . $this->siteDirectory . '/error.log');
// Change the database prefix.
$this
->changeDatabasePrefix();
// After preparing the environment and changing the database prefix, we are
// in a valid test environment.
drupal_valid_test_ua($this->databasePrefix);
// Reset settings.
new Settings([
// For performance, simply use the database prefix as hash salt.
'hash_salt' => $this->databasePrefix,
'container_yamls' => [],
]);
Environment::setTimeLimit($this->timeLimit);
}
/**
* Performs cleanup tasks after each individual test method has been run.
*/
protected function tearDown() {
}
/**
* Cleans up the test environment and restores the original environment.
*
* Deletes created files, database tables, and reverts environment changes.
*
* This method needs to be invoked for both unit and integration tests.
*
* @see TestBase::prepareDatabasePrefix()
* @see TestBase::changeDatabasePrefix()
* @see TestBase::prepareEnvironment()
*/
private function restoreEnvironment() {
// Destroy the session if one was started during the test-run.
$_SESSION = [];
if (PHP_SAPI !== 'cli' && session_status() === PHP_SESSION_ACTIVE) {
session_destroy();
$params = session_get_cookie_params();
setcookie(session_name(), '', REQUEST_TIME - 3600, $params['path'], $params['domain'], $params['secure'], $params['httponly']);
}
session_name($this->originalSessionName);
// Reset all static variables.
// Unsetting static variables will potentially invoke destruct methods,
// which might call into functions that prime statics and caches again.
// In that case, all functions are still operating on the test environment,
// which means they may need to access its filesystem and database.
drupal_static_reset();
if ($this->container && $this->container
->has('state') && ($state = $this->container
->get('state'))) {
$captured_emails = $state
->get('system.test_mail_collector') ?: [];
$emailCount = count($captured_emails);
if ($emailCount) {
$message = $emailCount == 1 ? '1 email was sent during this test.' : $emailCount . ' emails were sent during this test.';
$this
->pass($message, 'Email');
}
}
// Sleep for 50ms to allow shutdown functions and terminate events to
// complete. Further information: https://www.drupal.org/node/2194357.
usleep(50000);
// Remove all prefixed tables.
$original_connection_info = Database::getConnectionInfo('simpletest_original_default');
$original_prefix = $original_connection_info['default']['prefix']['default'];
$test_connection_info = Database::getConnectionInfo('default');
$test_prefix = $test_connection_info['default']['prefix']['default'];
if ($original_prefix != $test_prefix) {
$tables = Database::getConnection()
->schema()
->findTables('%');
foreach ($tables as $table) {
if (Database::getConnection()
->schema()
->dropTable($table)) {
unset($tables[$table]);
}
}
}
// In case a fatal error occurred that was not in the test process read the
// log to pick up any fatal errors.
(new TestDatabase($this->databasePrefix))
->logRead($this->testId, get_class($this));
// Restore original dependency injection container.
$this->container = $this->originalContainer;
\Drupal::setContainer($this->originalContainer);
// Delete test site directory.
\Drupal::service('file_system')
->deleteRecursive($this->siteDirectory, [
$this,
'filePreDeleteCallback',
]);
// Restore original database connection.
Database::removeConnection('default');
Database::renameConnection('simpletest_original_default', 'default');
// Reset all static variables.
// All destructors of statically cached objects have been invoked above;
// this second reset is guaranteed to reset everything to nothing.
drupal_static_reset();
// Restore original in-memory configuration.
$GLOBALS['config'] = $this->originalConfig;
$GLOBALS['conf'] = $this->originalConf;
new Settings($this->originalSettings);
// Re-initialize original stream wrappers of the parent site.
// This must happen after static variables have been reset and the original
// container and $config_directories are restored, as simpletest_log_read()
// uses the public stream wrapper to locate the error.log.
$this->originalContainer
->get('stream_wrapper_manager')
->register();
if (isset($this->originalPrefix)) {
drupal_valid_test_ua($this->originalPrefix);
}
else {
drupal_valid_test_ua(FALSE);
}
// Restore original shutdown callbacks.
$callbacks =& drupal_register_shutdown_function();
$callbacks = $this->originalShutdownCallbacks;
}
/**
* Handle errors during test runs.
*
* Because this is registered in set_error_handler(), it has to be public.
*
* @see set_error_handler
*/
public function errorHandler($severity, $message, $file = NULL, $line = NULL) {
if ($severity & error_reporting()) {
$error_map = [
E_STRICT => 'Run-time notice',
E_WARNING => 'Warning',
E_NOTICE => 'Notice',
E_CORE_ERROR => 'Core error',
E_CORE_WARNING => 'Core warning',
E_USER_ERROR => 'User error',
E_USER_WARNING => 'User warning',
E_USER_NOTICE => 'User notice',
E_RECOVERABLE_ERROR => 'Recoverable error',
E_DEPRECATED => 'Deprecated',
E_USER_DEPRECATED => 'User deprecated',
];
$backtrace = debug_backtrace();
// Add verbose backtrace for errors, but not for debug() messages.
if ($severity !== E_USER_NOTICE) {
$verbose_backtrace = $backtrace;
array_shift($verbose_backtrace);
$message .= '<pre class="backtrace">' . Error::formatBacktrace($verbose_backtrace) . '</pre>';
}
$this
->error($message, $error_map[$severity], Error::getLastCaller($backtrace));
}
return TRUE;
}
/**
* Handle exceptions.
*
* @see set_exception_handler
*/
protected function exceptionHandler($exception) {
$backtrace = $exception
->getTrace();
$verbose_backtrace = $backtrace;
// Push on top of the backtrace the call that generated the exception.
array_unshift($backtrace, [
'line' => $exception
->getLine(),
'file' => $exception
->getFile(),
]);
$decoded_exception = Error::decodeException($exception);
unset($decoded_exception['backtrace']);
$message = new FormattableMarkup('%type: @message in %function (line %line of %file). <pre class="backtrace">@backtrace</pre>', $decoded_exception + [
'@backtrace' => Error::formatBacktrace($verbose_backtrace),
]);
$this
->error($message, 'Uncaught exception', Error::getLastCaller($backtrace));
}
/**
* Changes in memory settings.
*
* @param $name
* The name of the setting to return.
* @param $value
* The value of the setting.
*
* @see \Drupal\Core\Site\Settings::get()
*/
protected function settingsSet($name, $value) {
$settings = Settings::getAll();
$settings[$name] = $value;
new Settings($settings);
}
/**
* Ensures test files are deletable.
*
* Some tests chmod generated files to be read only. During
* TestBase::restoreEnvironment() and other cleanup operations, these files
* need to get deleted too.
*
* @see \Drupal\Core\File\FileSystemInterface::deleteRecursive()
*/
public static function filePreDeleteCallback($path) {
// When the webserver runs with the same system user as the test runner, we
// can make read-only files writable again. If not, chmod will fail while
// the file deletion still works if file permissions have been configured
// correctly. Thus, we ignore any problems while running chmod.
@chmod($path, 0700);
}
/**
* Configuration accessor for tests. Returns non-overridden configuration.
*
* @param $name
* Configuration name.
*
* @return \Drupal\Core\Config\Config
* The configuration object with original configuration data.
*/
protected function config($name) {
return \Drupal::configFactory()
->getEditable($name);
}
/**
* Gets the database prefix.
*
* @return string
* The database prefix
*/
public function getDatabasePrefix() {
return $this->databasePrefix;
}
/**
* Gets the temporary files directory.
*
* @return string
* The temporary files directory.
*/
public function getTempFilesDirectory() {
return $this->tempFilesDirectory;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
|
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
|
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
|
GeneratePermutationsTrait:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
|
RandomGeneratorTrait:: |
protected | property | The random generator. | |
|
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
|
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
|
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
|
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
|
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
|
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
|
TestBase:: |
protected | property | Assertions thrown in that test case. | |
|
TestBase:: |
protected | property | The config importer that can used in a test. | |
|
TestBase:: |
protected | property | The database prefix of this test run. | |
|
TestBase:: |
public | property | Whether to die in case any test assertion fails. | |
|
TestBase:: |
protected | property | HTTP authentication credentials (<username>:<password>). | |
|
TestBase:: |
protected | property | HTTP authentication method (specified as a CURLAUTH_* constant). | |
|
TestBase:: |
protected | property | The original configuration (variables), if available. | |
|
TestBase:: |
protected | property | The original configuration (variables). | |
|
TestBase:: |
protected | property | The original configuration directories. | |
|
TestBase:: |
protected | property | The original container. | |
|
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
|
TestBase:: |
protected | property | The original language. | |
|
TestBase:: |
protected | property | The original database prefix when running inside Simpletest. | |
|
TestBase:: |
protected | property | The name of the session cookie of the test-runner. | |
|
TestBase:: |
protected | property | The settings array. | |
|
TestBase:: |
protected | property | The original array of shutdown function callbacks. | 1 |
|
TestBase:: |
protected | property | The original user, before testing began. | 1 |
|
TestBase:: |
public | property | Current results of this test case. | |
|
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
|
TestBase:: |
protected | property | Time limit for the test. | |
|
TestBase:: |
protected | property | The translation file directory for the test environment. | |
|
TestBase:: |
public | property | TRUE if verbose debugging is enabled. | |
|
TestBase:: |
protected | property | Safe class name for use in verbose output filenames. | |
|
TestBase:: |
protected | property | Directory where verbose output files are put. | |
|
TestBase:: |
protected | property | URL to the verbose output file directory. | |
|
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
|
TestBase:: |
protected | function | Internal helper: stores the assert. | |
|
TestBase:: |
protected | function | Check to see if two values are equal. | |
|
TestBase:: |
protected | function | Asserts that a specific error has been logged to the PHP error log. | |
|
TestBase:: |
protected | function | Check to see if a value is false. | |
|
TestBase:: |
protected | function | Check to see if two values are identical. | |
|
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
|
TestBase:: |
protected | function | Asserts that no errors have been logged to the PHP error.log thus far. | |
|
TestBase:: |
protected | function | Check to see if two values are not equal. | |
|
TestBase:: |
protected | function | Check to see if two values are not identical. | |
|
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
|
TestBase:: |
protected | function | Check to see if a value is NULL. | |
|
TestBase:: |
protected | function | Check to see if a value is not false. | |
|
TestBase:: |
protected | function | Act on global state information before the environment is altered for a test. | 1 |
|
TestBase:: |
protected | function | Checks the matching requirements for Test. | 1 |
|
TestBase:: |
public | function | Fail the test if it belongs to a PHPUnit-based framework. | |
|
TestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
|
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
|
TestBase:: |
protected | function | Fire an error assertion. | 1 |
|
TestBase:: |
public | function | Handle errors during test runs. | |
|
TestBase:: |
protected | function | Handle exceptions. | |
|
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
|
TestBase:: |
public static | function | Ensures test files are deletable. | |
|
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
|
TestBase:: |
public | function | Gets the database prefix. | |
|
TestBase:: |
public | function | Gets the temporary files directory. | |
|
TestBase:: |
public static | function | Store an assertion from outside the testing context. | 1 |
|
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
|
TestBase:: |
private | function |
Generates a database prefix for running tests. Overrides TestSetupTrait:: |
|
|
TestBase:: |
private | function | Prepares the current environment for running the test. | |
|
TestBase:: |
private | function | Cleans up the test environment and restores the original environment. | |
|
TestBase:: |
public | function | Run all tests in this class. | 2 |
|
TestBase:: |
protected | function | Changes in memory settings. | |
|
TestBase:: |
abstract protected | function | Performs setup tasks before each individual test method is run. | 2 |
|
TestBase:: |
protected | function | Helper method to store an assertion record in the configured database. | 1 |
|
TestBase:: |
protected | function | Performs cleanup tasks after each individual test method has been run. | 2 |
|
TestBase:: |
protected | function | Logs a verbose message in a text file. | |
|
TestBase:: |
public | function | Constructor for Test. | 2 |
|
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
|
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
|
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
|
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
|
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
|
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
|
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
|
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 2 |
|
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
|
TestSetupTrait:: |
protected | property | The test run ID. | |
|
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
|
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
|
TestSetupTrait:: |
public static | function | Returns the database connection to the site running Simpletest. |