class SimpleTestTest
Same name in this branch
- 8.9.x core/modules/simpletest/tests/src/Functional/SimpletestTest.php \Drupal\Tests\simpletest\Functional\SimpletestTest
Tests SimpleTest's web interface: check that the intended tests were run and ensure that test reports display the intended results. Also test SimpleTest's internal browser and APIs implicitly.
@group simpletest @group WebTestBase @group legacy
Hierarchy
- class \Drupal\simpletest\TestBase uses \Drupal\Tests\AssertHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\Traits\Core\GeneratePermutationsTrait, \Drupal\Tests\ConfigTestTrait
- class \Drupal\simpletest\WebTestBase extends \Drupal\simpletest\TestBase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\TestFileCreationTrait, \Drupal\system\Tests\Cache\AssertPageCacheContextsAndTagsTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\Traits\Core\CronRunTrait, \Drupal\Core\Test\AssertMailTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\EntityViewTrait
- class \Drupal\simpletest\Tests\SimpleTestTest extends \Drupal\simpletest\WebTestBase
- class \Drupal\simpletest\WebTestBase extends \Drupal\simpletest\TestBase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\TestFileCreationTrait, \Drupal\system\Tests\Cache\AssertPageCacheContextsAndTagsTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\Traits\Core\CronRunTrait, \Drupal\Core\Test\AssertMailTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\EntityViewTrait
Expanded class hierarchy of SimpleTestTest
1 string reference to 'SimpleTestTest'
- SimpleTestTest::stubTest in core/
modules/ simpletest/ src/ Tests/ SimpleTestTest.php - Test to be run and the results confirmed.
File
-
core/
modules/ simpletest/ src/ Tests/ SimpleTestTest.php, line 19
Namespace
Drupal\simpletest\TestsView source
class SimpleTestTest extends WebTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = [
'simpletest',
];
/**
* The results array that has been parsed by getTestResults().
*
* @var array
*/
protected $childTestResults;
/**
* Stores the test ID from each test run for comparison.
*
* Used to ensure they are incrementing.
*/
protected $testIds = [];
/**
* Translated fail message.
*
* @var string
*/
private $failMessage = '';
/**
* Translated pass message.
* @var string
*/
private $passMessage = '';
/**
* A valid and recognized permission.
*
* @var string
*/
protected $validPermission;
/**
* An invalid or unrecognized permission.
*
* @var string
*/
protected $invalidPermission;
protected function setUp() {
if (!$this->isInChildSite()) {
$php = <<<'EOD'
<?php
# Make sure that the $test_class variable is defined when this file is included.
if ($test_class) {
}
# Define a function to be able to check that this file was loaded with
# function_exists().
if (!function_exists('simpletest_test_stub_settings_function')) {
function simpletest_test_stub_settings_function() {}
}
EOD;
file_put_contents($this->siteDirectory . '/' . 'settings.testing.php', $php);
// @see \Drupal\system\Tests\DrupalKernel\DrupalKernelSiteTest
$class = __CLASS__;
$yaml = <<<EOD
services:
# Add a new service.
site.service.yml:
class: {<span class="php-variable">$class</span>}
# Swap out a core service.
cache.backend.database:
class: Drupal\\Core\\Cache\\MemoryBackendFactory
EOD;
file_put_contents($this->siteDirectory . '/testing.services.yml', $yaml);
$original_container = $this->originalContainer;
parent::setUp();
$this->assertNotIdentical(\Drupal::getContainer(), $original_container, 'WebTestBase test creates a new container.');
// Create and log in an admin user.
$this->drupalLogin($this->drupalCreateUser([
'administer unit tests',
]));
}
else {
// This causes three of the five fails that are asserted in
// confirmStubResults().
self::$modules = [
'non_existent_module',
];
parent::setUp();
}
}
/**
* Ensures the tests selected through the web interface are run and displayed.
*/
public function testWebTestRunner() {
$this->passMessage = t('SimpleTest pass.');
$this->failMessage = t('SimpleTest fail.');
$this->validPermission = 'access administration pages';
$this->invalidPermission = 'invalid permission';
if ($this->isInChildSite()) {
// Only run following code if this test is running itself through a CURL
// request.
$this->stubTest();
}
else {
// Run twice so test_ids can be accumulated.
for ($i = 0; $i < 2; $i++) {
// Run this test from web interface.
$this->drupalGet('admin/config/development/testing');
$edit = [];
$edit['tests[Drupal\\simpletest\\Tests\\SimpleTestTest]'] = TRUE;
$this->drupalPostForm(NULL, $edit, t('Run tests'));
// Parse results and confirm that they are correct.
$this->getTestResults();
$this->confirmStubTestResults();
}
// Regression test for #290316.
// Check that test_id is incrementing.
$this->assertTrue($this->testIds[0] != $this->testIds[1], 'Test ID is incrementing.');
}
}
/**
* Test to be run and the results confirmed.
*
* Here we force test results which must match the expected results from
* confirmStubResults().
*/
public function stubTest() {
// Ensure the .htkey file exists since this is only created just before a
// request. This allows the stub test to make requests. The event does not
// fire here and drupal_generate_test_ua() can not generate a key for a
// test in a test since the prefix has changed.
// @see \Drupal\Core\Test\HttpClientMiddleware\TestHttpClientMiddleware::onBeforeSendRequest()
// @see drupal_generate_test_ua();
$test_db = new TestDatabase($this->databasePrefix);
$key_file = DRUPAL_ROOT . '/' . $test_db->getTestSitePath() . '/.htkey';
$private_key = Crypt::randomBytesBase64(55);
$site_path = $this->container
->get('site.path');
file_put_contents($key_file, $private_key);
// Check to see if runtime assertions are indeed on, if successful this
// will be the first of sixteen passes asserted in confirmStubResults()
try {
// Test with minimum possible arguments to make sure no notice for
// missing argument is thrown.
assert(FALSE);
$this->fail('Runtime assertions are not working.');
} catch (\AssertionError $e) {
try {
// Now test with an error message to ensure it is correctly passed
// along by the rethrow.
assert(FALSE, 'Lorem Ipsum');
} catch (\AssertionError $e) {
$this->assertEqual($e->getMessage(), 'Lorem Ipsum', 'Runtime assertions Enabled and running.');
}
}
// This causes the second of the sixteen passes asserted in
// confirmStubResults().
$this->pass($this->passMessage);
// The first three fails are caused by enabling a non-existent module in
// setUp().
// This causes the fourth of the five fails asserted in
// confirmStubResults().
$this->fail($this->failMessage);
// This causes the third to fifth of the sixteen passes asserted in
// confirmStubResults().
$user = $this->drupalCreateUser([
$this->validPermission,
], 'SimpleTestTest');
// This causes the fifth of the five fails asserted in confirmStubResults().
$this->drupalCreateUser([
$this->invalidPermission,
]);
// Test logging in as a user.
// This causes the sixth to tenth of the sixteen passes asserted in
// confirmStubResults().
$this->drupalLogin($user);
// This causes the eleventh of the sixteen passes asserted in
// confirmStubResults().
$this->pass('Test ID is ' . $this->testId . '.');
// These cause the twelfth to fifteenth of the sixteen passes asserted in
// confirmStubResults().
$this->assertTrue(file_exists($site_path . '/settings.testing.php'));
// Check the settings.testing.php file got included.
$this->assertTrue(function_exists('simpletest_test_stub_settings_function'));
// Check that the test-specific service file got loaded.
$this->assertTrue($this->container
->has('site.service.yml'));
$this->assertIdentical(get_class($this->container
->get('cache.backend.database')), 'Drupal\\Core\\Cache\\MemoryBackendFactory');
// These cause the two exceptions asserted in confirmStubResults().
// Call trigger_error() without the required argument to trigger an E_WARNING.
trigger_error();
// Generates a warning inside a PHP function.
array_key_exists(NULL, NULL);
// This causes the sixteenth of the sixteen passes asserted in
// confirmStubResults().
$this->assertNothing();
// This causes the debug message asserted in confirmStubResults().
debug('Foo', 'Debug', FALSE);
}
/**
* Assert nothing.
*/
public function assertNothing() {
$this->pass('This is nothing.');
}
/**
* Confirm that the stub test produced the desired results.
*/
public function confirmStubTestResults() {
$this->assertAssertion(t('Unable to install modules %modules due to missing modules %missing.', [
'%modules' => 'non_existent_module',
'%missing' => 'non_existent_module',
]), 'Other', 'Fail', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->setUp()');
$this->assertAssertion($this->passMessage, 'Other', 'Pass', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
$this->assertAssertion($this->failMessage, 'Other', 'Fail', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
$this->assertAssertion(t('Created permissions: @perms', [
'@perms' => $this->validPermission,
]), 'Role', 'Pass', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
$this->assertAssertion(t('Invalid permission %permission.', [
'%permission' => $this->invalidPermission,
]), 'Role', 'Fail', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
// Check that the user was logged in successfully.
$this->assertAssertion('User SimpleTestTest successfully logged in.', 'User login', 'Pass', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
// Check that a warning is caught by simpletest. The exact error message
// differs between PHP versions so only the function name is checked.
$this->assertAssertion('trigger_error()', 'Warning', 'Fail', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
// Check that the backtracing code works for specific assert function.
$this->assertAssertion('This is nothing.', 'Other', 'Pass', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
// Check that errors that occur inside PHP internal functions are correctly
// reported. The exact error message differs between PHP versions so we
// check only the function name 'array_key_exists'.
$this->assertAssertion('array_key_exists', 'Warning', 'Fail', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
$this->assertAssertion("Debug: 'Foo'", 'Debug', 'Fail', 'SimpleTestTest.php', 'Drupal\\simpletest\\Tests\\SimpleTestTest->stubTest()');
$this->assertEqual('16 passes, 3 fails, 2 exceptions, 3 debug messages', $this->childTestResults['summary']);
$this->testIds[] = $test_id = $this->getTestIdFromResults();
$this->assertTrue($test_id, 'Found test ID in results.');
}
/**
* Fetch the test id from the test results.
*/
public function getTestIdFromResults() {
foreach ($this->childTestResults['assertions'] as $assertion) {
if (preg_match('@^Test ID is ([0-9]*)\\.$@', $assertion['message'], $matches)) {
return $matches[1];
}
}
return NULL;
}
/**
* Asserts that an assertion with specified values is displayed in results.
*
* @param string $message
* Assertion message.
* @param string $type
* Assertion type.
* @param string $status
* Assertion status.
* @param string $file
* File where the assertion originated.
* @param string $function
* Function where the assertion originated.
*
* @return Assertion result.
*/
public function assertAssertion($message, $type, $status, $file, $function) {
$message = trim(strip_tags($message));
$found = FALSE;
foreach ($this->childTestResults['assertions'] as $assertion) {
if (strpos($assertion['message'], $message) !== FALSE && $assertion['type'] == $type && $assertion['status'] == $status && $assertion['file'] == $file && $assertion['function'] == $function) {
$found = TRUE;
break;
}
}
return $this->assertTrue($found, new FormattableMarkup('Found assertion {"@message", "@type", "@status", "@file", "@function"}.', [
'@message' => $message,
'@type' => $type,
'@status' => $status,
"@file" => $file,
"@function" => $function,
]));
}
/**
* Get the results from a test and store them in the class array $results.
*/
public function getTestResults() {
$results = [];
if ($this->parse()) {
if ($details = $this->getResultFieldSet()) {
// Code assumes this is the only test in group.
$results['summary'] = $this->asText($details->div->div[1]);
$results['name'] = $this->asText($details->summary);
$results['assertions'] = [];
$tbody = $details->div->table->tbody;
foreach ($tbody->tr as $row) {
$assertion = [];
$assertion['message'] = $this->asText($row->td[0]);
$assertion['type'] = $this->asText($row->td[1]);
$assertion['file'] = $this->asText($row->td[2]);
$assertion['line'] = $this->asText($row->td[3]);
$assertion['function'] = $this->asText($row->td[4]);
$ok_url = file_url_transform_relative(file_create_url('core/misc/icons/73b355/check.svg'));
$assertion['status'] = $row->td[5]->img['src'] == $ok_url ? 'Pass' : 'Fail';
$results['assertions'][] = $assertion;
}
}
}
$this->childTestResults = $results;
}
/**
* Get the details containing the results for group this test is in.
*/
public function getResultFieldSet() {
$all_details = $this->xpath('//details');
foreach ($all_details as $details) {
if ($this->asText($details->summary) == __CLASS__) {
return $details;
}
}
return FALSE;
}
/**
* Extract the text contained by the element.
*
* @param $element
* Element to extract text from.
*
* @return
* Extracted text.
*/
public 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())));
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
AssertContentTrait::$content | protected | property | The current raw content. | ||||
AssertContentTrait::$drupalSettings | protected | property | The drupalSettings value from the current raw $content. | ||||
AssertContentTrait::$elements | protected | property | The XML structure parsed from the current raw $content. | 1 | |||
AssertContentTrait::$plainTextContent | protected | property | The plain-text content of raw $content (text nodes). | ||||
AssertContentTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | ||||
AssertContentTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | ||||
AssertContentTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | ||||
AssertContentTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | ||||
AssertContentTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | ||||
AssertContentTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | ||||
AssertContentTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | ||||
AssertContentTrait::assertLink | protected | function | Passes if a link with the specified label is found. | ||||
AssertContentTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | ||||
AssertContentTrait::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | ||||
AssertContentTrait::assertNoEscaped | protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. |
||||
AssertContentTrait::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | ||||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | ||||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | ||||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | ||||
AssertContentTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | ||||
AssertContentTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | ||||
AssertContentTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | ||||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | ||||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | ||||
AssertContentTrait::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | ||||
AssertContentTrait::assertNoPattern | protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | ||||
AssertContentTrait::assertNoRaw | protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | ||||
AssertContentTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | ||||
AssertContentTrait::assertNoTitle | protected | function | Pass if the page title is not the given string. | ||||
AssertContentTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | ||||
AssertContentTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | ||||
AssertContentTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | ||||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | ||||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | protected | function | Asserts that a select option in the current page is checked. | ||||
AssertContentTrait::assertOptionWithDrupalSelector | protected | function | Asserts that a select option in the current page exists. | ||||
AssertContentTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | ||||
AssertContentTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | ||||
AssertContentTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | ||||
AssertContentTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | ||||
AssertContentTrait::assertTextPattern | protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | ||||
AssertContentTrait::assertThemeOutput | protected | function | Asserts themed output. | ||||
AssertContentTrait::assertTitle | protected | function | Pass if the page title is the given string. | ||||
AssertContentTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | ||||
AssertContentTrait::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | ||||
AssertContentTrait::buildXPathQuery | protected | function | Builds an XPath query. | ||||
AssertContentTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | ||||
AssertContentTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | ||||
AssertContentTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | ||||
AssertContentTrait::getDrupalSettings | protected | function | Gets the value of drupalSettings for the currently-loaded page. | ||||
AssertContentTrait::getRawContent | protected | function | Gets the current raw content. | ||||
AssertContentTrait::getSelectedItem | protected | function | Get the selected value from a select field. | ||||
AssertContentTrait::getTextContent | protected | function | Retrieves the plain-text content from the current raw content. | ||||
AssertContentTrait::getUrl | protected | function | Get the current URL from the cURL handler. | 1 | |||
AssertContentTrait::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | ||||
AssertContentTrait::removeWhiteSpace | protected | function | Removes all white-space between HTML tags from the raw content. | ||||
AssertContentTrait::setDrupalSettings | protected | function | Sets the value of drupalSettings for the currently-loaded page. | ||||
AssertContentTrait::setRawContent | protected | function | Sets the raw content (e.g. HTML). | ||||
AssertContentTrait::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | ||||
AssertHelperTrait::castSafeStrings | protected static | function | Casts MarkupInterface objects into strings. | ||||
AssertMailTrait::assertMail | protected | function | Asserts that the most recently sent email message has the given value. | ||||
AssertMailTrait::assertMailPattern | protected | function | Asserts that the most recently sent email message has the pattern in it. | ||||
AssertMailTrait::assertMailString | protected | function | Asserts that the most recently sent email message has the string in it. | ||||
AssertMailTrait::getMails | protected | function | Gets an array containing all emails sent during this test case. | Aliased as: drupalGetMails | |||
AssertMailTrait::verboseEmail | protected | function | Outputs to verbose the most recent $count emails sent. | ||||
AssertPageCacheContextsAndTagsTrait::assertCacheContext | protected | function | Asserts whether an expected cache context was present in the last response. | ||||
AssertPageCacheContextsAndTagsTrait::assertCacheContexts | protected | function | Ensures that some cache contexts are present in the current response. | ||||
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge | protected | function | Asserts the max age header. | ||||
AssertPageCacheContextsAndTagsTrait::assertCacheTags | protected | function | Ensures that some cache tags are present in the current response. | ||||
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext | protected | function | Asserts that a cache context was not present in the last response. | ||||
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags | protected | function | Asserts page cache miss, then hit for the given URL; checks cache headers. | ||||
AssertPageCacheContextsAndTagsTrait::debugCacheTags | protected | function | Provides debug information for cache tags. | ||||
AssertPageCacheContextsAndTagsTrait::enablePageCaching | protected | function | Enables page caching. | ||||
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues | protected | function | Gets a specific header value as array. | ||||
BlockCreationTrait::placeBlock | protected | function | Creates a block instance based on default settings. | Aliased as: drupalPlaceBlock | |||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | ||||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | ||||
ContentTypeCreationTrait::createContentType | protected | function | Creates a custom content type based on default settings. | Aliased as: drupalCreateContentType | 1 | ||
CronRunTrait::cronRun | protected | function | Runs cron on the test site. | ||||
EntityViewTrait::buildEntityView | protected | function | Builds the renderable view of an entity. | Aliased as: drupalBuildEntityView | |||
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix | protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 | |||
FunctionalTestSetupTrait::$classLoader | protected | property | The class loader to use for installation and initialization of setup. | ||||
FunctionalTestSetupTrait::$configDirectories | Deprecated | protected | property | The config directories used in this test. | |||
FunctionalTestSetupTrait::$rootUser | protected | property | The "#1" admin user. | ||||
FunctionalTestSetupTrait::doInstall | protected | function | Execute the non-interactive installer. | 1 | |||
FunctionalTestSetupTrait::getDatabaseTypes | protected | function | Returns all supported database driver installer objects. | ||||
FunctionalTestSetupTrait::initConfig | protected | function | Initialize various configurations post-installation. | 2 | |||
FunctionalTestSetupTrait::initKernel | protected | function | Initializes the kernel after installation. | ||||
FunctionalTestSetupTrait::initSettings | protected | function | Initialize settings created during install. | ||||
FunctionalTestSetupTrait::initUserSession | protected | function | Initializes user 1 for the site to be installed. | ||||
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty | protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | ||||
FunctionalTestSetupTrait::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | 1 | |||
FunctionalTestSetupTrait::installParameters | protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 | |||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 23 | |||
FunctionalTestSetupTrait::prepareRequestForGenerator | protected | function | Creates a mock request and sets it on the generator. | ||||
FunctionalTestSetupTrait::prepareSettings | protected | function | Prepares site settings and services before installation. | 2 | |||
FunctionalTestSetupTrait::rebuildAll | protected | function | Resets and rebuilds the environment after setup. | ||||
FunctionalTestSetupTrait::rebuildContainer | protected | function | Rebuilds \Drupal::getContainer(). | ||||
FunctionalTestSetupTrait::resetAll | protected | function | Resets all data structures after having enabled new modules. | ||||
FunctionalTestSetupTrait::setContainerParameter | protected | function | Changes parameters in the services.yml file. | ||||
FunctionalTestSetupTrait::setupBaseUrl | protected | function | Sets up the base URL based upon the environment variable. | ||||
FunctionalTestSetupTrait::writeSettings | protected | function | Rewrites the settings.php file of the test site. | ||||
GeneratePermutationsTrait::generatePermutations | public static | function | Converts a list of possible parameters into a stack of permutations. | ||||
NodeCreationTrait::createNode | protected | function | Creates a node based on default settings. | Aliased as: drupalCreateNode | |||
NodeCreationTrait::getNodeByTitle | public | function | Get a node from the database based on its title. | Aliased as: drupalGetNodeByTitle | |||
RandomGeneratorTrait::$randomGenerator | protected | property | The random generator. | ||||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | 1 | |||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | ||||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | ||||
RandomGeneratorTrait::randomStringValidate | public | function | Callback for random string validation. | ||||
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 3 | |||
SessionTestTrait::$sessionName | protected | property | The name of the session cookie. | ||||
SessionTestTrait::generateSessionName | protected | function | Generates a session cookie name. | ||||
SessionTestTrait::getSessionName | protected | function | Returns the session name in use on the child site. | ||||
SimpleTestTest::$childTestResults | protected | property | The results array that has been parsed by getTestResults(). | ||||
SimpleTestTest::$failMessage | private | property | Translated fail message. | ||||
SimpleTestTest::$invalidPermission | protected | property | An invalid or unrecognized permission. | ||||
SimpleTestTest::$modules | public static | property | Modules to enable. | ||||
SimpleTestTest::$passMessage | private | property | Translated pass message. | ||||
SimpleTestTest::$testIds | protected | property | Stores the test ID from each test run for comparison. | ||||
SimpleTestTest::$validPermission | protected | property | A valid and recognized permission. | ||||
SimpleTestTest::assertAssertion | public | function | Asserts that an assertion with specified values is displayed in results. | ||||
SimpleTestTest::assertNothing | public | function | Assert nothing. | ||||
SimpleTestTest::asText | public | function | Extract the text contained by the element. | ||||
SimpleTestTest::confirmStubTestResults | public | function | Confirm that the stub test produced the desired results. | ||||
SimpleTestTest::getResultFieldSet | public | function | Get the details containing the results for group this test is in. | ||||
SimpleTestTest::getTestIdFromResults | public | function | Fetch the test id from the test results. | ||||
SimpleTestTest::getTestResults | public | function | Get the results from a test and store them in the class array $results. | ||||
SimpleTestTest::setUp | protected | function | Sets up a Drupal site for running functional and integration tests. | Overrides WebTestBase::setUp | |||
SimpleTestTest::stubTest | public | function | Test to be run and the results confirmed. | ||||
SimpleTestTest::testWebTestRunner | public | function | Ensures the tests selected through the web interface are run and displayed. | ||||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||||
TestBase::$assertions | protected | property | Assertions thrown in that test case. | ||||
TestBase::$configImporter | protected | property | The config importer that can used in a test. | ||||
TestBase::$databasePrefix | protected | property | The database prefix of this test run. | ||||
TestBase::$dieOnFail | public | property | Whether to die in case any test assertion fails. | ||||
TestBase::$httpAuthCredentials | protected | property | HTTP authentication credentials (<username>:<password>). | ||||
TestBase::$httpAuthMethod | protected | property | HTTP authentication method (specified as a CURLAUTH_* constant). | ||||
TestBase::$originalConf | protected | property | The original configuration (variables), if available. | ||||
TestBase::$originalConfig | protected | property | The original configuration (variables). | ||||
TestBase::$originalConfigDirectories | protected | property | The original configuration directories. | ||||
TestBase::$originalContainer | protected | property | The original container. | ||||
TestBase::$originalFileDirectory | protected | property | The original file directory, before it was changed for testing purposes. | ||||
TestBase::$originalLanguage | protected | property | The original language. | ||||
TestBase::$originalPrefix | protected | property | The original database prefix when running inside Simpletest. | ||||
TestBase::$originalSessionName | protected | property | The name of the session cookie of the test-runner. | ||||
TestBase::$originalSettings | protected | property | The settings array. | ||||
TestBase::$results | public | property | Current results of this test case. | ||||
TestBase::$skipClasses | protected | property | This class is skipped when looking for the source of an assertion. | ||||
TestBase::$timeLimit | protected | property | Time limit for the test. | ||||
TestBase::$translationFilesDirectory | protected | property | The translation file directory for the test environment. | ||||
TestBase::$verbose | public | property | TRUE if verbose debugging is enabled. | ||||
TestBase::$verboseClassName | protected | property | Safe class name for use in verbose output filenames. | ||||
TestBase::$verboseDirectory | protected | property | Directory where verbose output files are put. | ||||
TestBase::$verboseDirectoryUrl | protected | property | URL to the verbose output file directory. | ||||
TestBase::$verboseId | protected | property | Incrementing identifier for verbose output filenames. | ||||
TestBase::assert | protected | function | Internal helper: stores the assert. | ||||
TestBase::assertEqual | protected | function | Check to see if two values are equal. | ||||
TestBase::assertErrorLogged | protected | function | Asserts that a specific error has been logged to the PHP error log. | ||||
TestBase::assertFalse | protected | function | Check to see if a value is false. | ||||
TestBase::assertIdentical | protected | function | Check to see if two values are identical. | ||||
TestBase::assertIdenticalObject | protected | function | Checks to see if two objects are identical. | ||||
TestBase::assertNoErrorsLogged | protected | function | Asserts that no errors have been logged to the PHP error.log thus far. | ||||
TestBase::assertNotEqual | protected | function | Check to see if two values are not equal. | ||||
TestBase::assertNotIdentical | protected | function | Check to see if two values are not identical. | ||||
TestBase::assertNotNull | protected | function | Check to see if a value is not NULL. | ||||
TestBase::assertNull | protected | function | Check to see if a value is NULL. | ||||
TestBase::assertTrue | protected | function | Check to see if a value is not false. | ||||
TestBase::beforePrepareEnvironment | protected | function | Act on global state information before the environment is altered for a test. | 1 | |||
TestBase::checkRequirements | protected | function | Checks the matching requirements for Test. | 1 | |||
TestBase::checkTestHierarchyMismatch | public | function | Fail the test if it belongs to a PHPUnit-based framework. | ||||
TestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||||
TestBase::deleteAssert | public static | function | Delete an assertion record by message ID. | ||||
TestBase::error | protected | function | Fire an error assertion. | 1 | |||
TestBase::errorHandler | public | function | Handle errors during test runs. | ||||
TestBase::exceptionHandler | protected | function | Handle exceptions. | ||||
TestBase::fail | protected | function | Fire an assertion that is always negative. | ||||
TestBase::filePreDeleteCallback | public static | function | Ensures test files are deletable. | ||||
TestBase::getAssertionCall | protected | function | Cycles through backtrace until the first non-assertion method is found. | ||||
TestBase::getDatabasePrefix | public | function | Gets the database prefix. | ||||
TestBase::getTempFilesDirectory | public | function | Gets the temporary files directory. | ||||
TestBase::insertAssert | Deprecated | public static | function | Store an assertion from outside the testing context. | 1 | ||
TestBase::pass | protected | function | Fire an assertion that is always positive. | ||||
TestBase::prepareDatabasePrefix | private | function | Generates a database prefix for running tests. | Overrides TestSetupTrait::prepareDatabasePrefix | |||
TestBase::restoreEnvironment | private | function | Cleans up the test environment and restores the original environment. | ||||
TestBase::run | public | function | Run all tests in this class. | 2 | |||
TestBase::settingsSet | protected | function | Changes in memory settings. | ||||
TestBase::storeAssertion | protected | function | Helper method to store an assertion record in the configured database. | 1 | |||
TestBase::verbose | protected | function | Logs a verbose message in a text file. | ||||
TestFileCreationTrait::$generatedTestFiles | protected | property | Whether the files were copied to the test files directory. | ||||
TestFileCreationTrait::compareFiles | protected | function | Compares two files based on size and file name. | Aliased as: drupalCompareFiles | |||
TestFileCreationTrait::generateFile | public static | function | Generates a test file. | ||||
TestFileCreationTrait::getTestFiles | protected | function | Gets a list of files that can be used in tests. | Aliased as: drupalGetTestFiles | |||
TestSetupTrait::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | ||||
TestSetupTrait::$container | protected | property | The dependency injection container used in the test. | ||||
TestSetupTrait::$kernel | protected | property | The DrupalKernel instance used in the test. | ||||
TestSetupTrait::$originalSite | protected | property | The site directory of the original parent site. | ||||
TestSetupTrait::$privateFilesDirectory | protected | property | The private file directory for the test environment. | ||||
TestSetupTrait::$publicFilesDirectory | protected | property | The public file directory for the test environment. | ||||
TestSetupTrait::$siteDirectory | protected | property | The site directory of this test run. | ||||
TestSetupTrait::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 2 | |||
TestSetupTrait::$tempFilesDirectory | protected | property | The temporary file directory for the test environment. | ||||
TestSetupTrait::$testId | protected | property | The test run ID. | ||||
TestSetupTrait::changeDatabasePrefix | protected | function | Changes the database connection to the prefixed one. | ||||
TestSetupTrait::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | ||||
TestSetupTrait::getDatabaseConnection | public static | function | Returns the database connection to the site running Simpletest. | ||||
UserCreationTrait::checkPermissions | protected | function | Checks whether a given list of permission names is valid. | ||||
UserCreationTrait::createAdminRole | protected | function | Creates an administrative role. | Aliased as: drupalCreateAdminRole | |||
UserCreationTrait::createRole | protected | function | Creates a role with specified permissions. | Aliased as: drupalCreateRole | |||
UserCreationTrait::createUser | protected | function | Create a user with a given set of permissions. | Aliased as: drupalCreateUser | |||
UserCreationTrait::grantPermissions | protected | function | Grant permissions to a user role. | ||||
UserCreationTrait::setCurrentUser | protected | function | Switch the current logged in user. | ||||
UserCreationTrait::setUpCurrentUser | protected | function | Creates a random user account and sets it as current user. | ||||
WebTestBase::$additionalCurlOptions | protected | property | Additional cURL options. | ||||
WebTestBase::$assertAjaxHeader | protected | property | Whether or not to assert the presence of the X-Drupal-Ajax-Token. | ||||
WebTestBase::$cookieFile | protected | property | The current cookie file used by cURL. | ||||
WebTestBase::$cookies | protected | property | The cookies of the page currently loaded in the internal browser. | ||||
WebTestBase::$curlCookies | protected | property | Cookies to set on curl requests. | ||||
WebTestBase::$curlHandle | protected | property | The handle of the current cURL connection. | ||||
WebTestBase::$customTranslations | protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | ||||
WebTestBase::$dumpHeaders | protected | property | Indicates that headers should be dumped if verbose output is enabled. | 1 | |||
WebTestBase::$headers | protected | property | The headers of the page currently loaded in the internal browser. | ||||
WebTestBase::$loggedInUser | protected | property | The current user logged in using the internal browser. | ||||
WebTestBase::$maximumMetaRefreshCount | protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | ||||
WebTestBase::$maximumRedirects | protected | property | The maximum number of redirects to follow when handling responses. | ||||
WebTestBase::$metaRefreshCount | protected | property | The number of meta refresh redirects followed during ::drupalGet(). | ||||
WebTestBase::$originalBatch | protected | property | The original batch, before it was changed for testing purposes. | ||||
WebTestBase::$originalShutdownCallbacks | protected | property | The original shutdown handlers array, before it was cleaned for testing. | Overrides TestBase::$originalShutdownCallbacks | |||
WebTestBase::$originalUser | protected | property | The original user, before it was changed to a clean uid = 1 for testing. | Overrides TestBase::$originalUser | |||
WebTestBase::$profile | protected | property | The profile to install as a basis for testing. | 2 | |||
WebTestBase::$redirectCount | protected | property | The number of redirects followed during the handling of a request. | ||||
WebTestBase::$sessionId | protected | property | The current session ID, if available. | ||||
WebTestBase::$url | protected | property | The URL currently loaded in the internal browser. | ||||
WebTestBase::addCustomTranslations | protected | function | Queues custom translations to be written to settings.php. | ||||
WebTestBase::assertBlockAppears | protected | function | Checks to see whether a block appears on the page. | ||||
WebTestBase::assertCacheTag | protected | function | Asserts whether an expected cache tag was present in the last response. | ||||
WebTestBase::assertHeader | protected | function | Check if a HTTP response header exists and has the expected value. | ||||
WebTestBase::assertNoBlockAppears | protected | function | Checks to see whether a block does not appears on the page. | ||||
WebTestBase::assertNoCacheTag | protected | function | Asserts whether an expected cache tag was absent in the last response. | ||||
WebTestBase::assertNoResponse | protected | function | Asserts the page did not return the specified response code. | ||||
WebTestBase::assertResponse | protected | function | Asserts the page responds with the specified response code. | 1 | |||
WebTestBase::assertUrl | protected | function | Passes if the internal browser's URL matches the given path. | ||||
WebTestBase::buildUrl | protected | function | Builds an a absolute URL from a system path or a URL object. | ||||
WebTestBase::checkForMetaRefresh | protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | ||||
WebTestBase::clickLink | protected | function | Follows a link by complete name. | ||||
WebTestBase::clickLinkHelper | protected | function | Provides a helper for ::clickLink() and ::clickLinkPartialName(). | ||||
WebTestBase::clickLinkPartialName | protected | function | Follows a link by partial name. | ||||
WebTestBase::curlClose | protected | function | Close the cURL handler and unset the handler. | ||||
WebTestBase::curlExec | protected | function | Initializes and executes a cURL request. | 1 | |||
WebTestBase::curlHeaderCallback | protected | function | Reads headers and registers errors received from the tested site. | ||||
WebTestBase::curlInitialize | protected | function | Initializes the cURL connection. | ||||
WebTestBase::drupalGet | protected | function | Retrieves a Drupal path or an absolute path. | 1 | |||
WebTestBase::drupalGetAjax | protected | function | Requests a path or URL in drupal_ajax format and JSON-decodes the response. | ||||
WebTestBase::drupalGetHeader | protected | function | Gets the value of an HTTP response header. | 1 | |||
WebTestBase::drupalGetHeaders | protected | function | Gets the HTTP response headers of the requested page. | 1 | |||
WebTestBase::drupalGetJSON | protected | function | Retrieves a Drupal path or an absolute path and JSON decodes the result. | ||||
WebTestBase::drupalGetWithFormat | protected | function | Retrieves a Drupal path or an absolute path for a given format. | ||||
WebTestBase::drupalGetXHR | protected | function | Requests a Drupal path or an absolute path as if it is a XMLHttpRequest. | ||||
WebTestBase::drupalHead | protected | function | Retrieves only the headers for a Drupal path or an absolute path. | ||||
WebTestBase::drupalLogin | protected | function | Log in a user with the internal browser. | ||||
WebTestBase::drupalLogout | protected | function | Logs a user out of the internal browser and confirms. | ||||
WebTestBase::drupalPost | protected | function | Perform a POST HTTP request. | ||||
WebTestBase::drupalPostAjaxForm | protected | function | Executes an Ajax form submission. | ||||
WebTestBase::drupalPostForm | protected | function | Executes a form submission. | ||||
WebTestBase::drupalPostWithFormat | protected | function | Performs a POST HTTP request with a specific format. | ||||
WebTestBase::drupalProcessAjaxResponse | protected | function | Processes an AJAX response into current content. | ||||
WebTestBase::drupalUserIsLoggedIn | protected | function | Returns whether a given user account is logged in. | ||||
WebTestBase::findBlockInstance | protected | function | Find a block instance on the page. | ||||
WebTestBase::getAbsoluteUrl | protected | function | Takes a path and returns an absolute path. | ||||
WebTestBase::getAjaxPageStatePostData | protected | function | Get the Ajax page state from drupalSettings and prepare it for POSTing. | ||||
WebTestBase::handleForm | protected | function | Handles form input related to drupalPostForm(). | ||||
WebTestBase::isInChildSite | protected | function | Returns whether the test is being executed from within a test site. | ||||
WebTestBase::restoreBatch | protected | function | Restore the original batch. | ||||
WebTestBase::serializePostValues | protected | function | Serialize POST HTTP request values. | ||||
WebTestBase::setBatch | protected | function | Preserve the original batch, and instantiate the test batch. | ||||
WebTestBase::setHttpResponseDebugCacheabilityHeaders | protected | function | Enables/disables the cacheability headers. | ||||
WebTestBase::tearDown | protected | function | Cleans up after testing. | Overrides TestBase::tearDown | 1 | ||
WebTestBase::translatePostValues | protected | function | Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm(). | ||||
WebTestBase::writeCustomTranslations | protected | function | Writes custom translations to the test site's settings.php. | ||||
WebTestBase::__construct | public | function | Constructor for \Drupal\simpletest\WebTestBase. | Overrides TestBase::__construct | 1 | ||
XdebugRequestTrait::extractCookiesFromRequest | protected | function | Adds xdebug cookies, from request setup. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.