class KernelTestBaseTest in Drupal 10
Same name and namespace in other branches
- 8 core/tests/Drupal/KernelTests/KernelTestBaseTest.php \Drupal\KernelTests\KernelTestBaseTest
- 9 core/tests/Drupal/KernelTests/KernelTestBaseTest.php \Drupal\KernelTests\KernelTestBaseTest
@coversDefaultClass \Drupal\KernelTests\KernelTestBase
@group PHPUnit @group Test @group KernelTests
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, ConfigTestTrait, ExtensionListTestTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\KernelTestBaseTest
Expanded class hierarchy of KernelTestBaseTest
File
- core/
tests/ Drupal/ KernelTests/ KernelTestBaseTest.php, line 21
Namespace
Drupal\KernelTestsView source
class KernelTestBaseTest extends KernelTestBase {
/**
* @covers ::setUpBeforeClass
*/
public function testSetUpBeforeClass() {
// Note: PHPUnit automatically restores the original working directory.
$this
->assertSame(realpath(__DIR__ . '/../../../../'), getcwd());
}
/**
* @covers ::bootEnvironment
*/
public function testBootEnvironment() {
$this
->assertMatchesRegularExpression('/^test\\d{8}$/', $this->databasePrefix);
$this
->assertStringStartsWith('vfs://root/sites/simpletest/', $this->siteDirectory);
$this
->assertEquals([
'root' => [
'sites' => [
'simpletest' => [
substr($this->databasePrefix, 4) => [
'files' => [
'config' => [
'sync' => [],
],
],
],
],
],
],
], vfsStream::inspect(new vfsStreamStructureVisitor())
->getStructure());
}
/**
* @covers ::getDatabaseConnectionInfo
*/
public function testGetDatabaseConnectionInfoWithOutManualSetDbUrl() {
$options = $this->container
->get('database')
->getConnectionOptions();
$this
->assertSame($this->databasePrefix, $options['prefix']);
}
/**
* @covers ::setUp
*/
public function testSetUp() {
$this
->assertTrue($this->container
->has('request_stack'));
$this
->assertTrue($this->container
->initialized('request_stack'));
$request = $this->container
->get('request_stack')
->getCurrentRequest();
$this
->assertNotEmpty($request);
$this
->assertEquals('/', $request
->getPathInfo());
$this
->assertSame($request, \Drupal::request());
$this
->assertEquals($this, $GLOBALS['conf']['container_service_providers']['test']);
$GLOBALS['destroy-me'] = TRUE;
$this
->assertArrayHasKey('destroy-me', $GLOBALS);
$database = $this->container
->get('database');
$database
->schema()
->createTable('foo', [
'fields' => [
'number' => [
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
],
],
]);
$this
->assertTrue($database
->schema()
->tableExists('foo'));
// Ensure that the database tasks have been run during set up. Neither MySQL
// nor SQLite make changes that are testable.
if ($database
->driver() == 'pgsql') {
$this
->assertEquals('on', $database
->query("SHOW standard_conforming_strings")
->fetchField());
$this
->assertEquals('escape', $database
->query("SHOW bytea_output")
->fetchField());
}
$this
->assertNotNull(FileCacheFactory::getPrefix());
}
/**
* @covers ::setUp
* @depends testSetUp
*/
public function testSetUpDoesNotLeak() {
$this
->assertArrayNotHasKey('destroy-me', $GLOBALS);
// Ensure that we have a different database prefix.
$schema = $this->container
->get('database')
->schema();
$this
->assertFalse($schema
->tableExists('foo'));
}
/**
* @covers ::register
*/
public function testRegister() {
// Verify that this container is identical to the actual container.
$this
->assertInstanceOf('Symfony\\Component\\DependencyInjection\\ContainerInterface', $this->container);
$this
->assertSame($this->container, \Drupal::getContainer());
// The request service should never exist.
$this
->assertFalse($this->container
->has('request'));
// Verify that there is a request stack.
$request = $this->container
->get('request_stack')
->getCurrentRequest();
$this
->assertInstanceOf('Symfony\\Component\\HttpFoundation\\Request', $request);
$this
->assertSame($request, \Drupal::request());
// Trigger a container rebuild.
$this
->enableModules([
'system',
]);
// Verify that this container is identical to the actual container.
$this
->assertInstanceOf('Symfony\\Component\\DependencyInjection\\ContainerInterface', $this->container);
$this
->assertSame($this->container, \Drupal::getContainer());
// The request service should never exist.
$this
->assertFalse($this->container
->has('request'));
// Verify that there is a request stack (and that it persisted).
$new_request = $this->container
->get('request_stack')
->getCurrentRequest();
$this
->assertInstanceOf('Symfony\\Component\\HttpFoundation\\Request', $new_request);
$this
->assertSame($new_request, \Drupal::request());
$this
->assertSame($request, $new_request);
// Ensure getting the router.route_provider does not trigger a deprecation
// message that errors.
$this->container
->get('router.route_provider');
}
/**
* Tests whether the fixture allows us to install modules and configuration.
*
* @see ::testSubsequentContainerIsolation()
*/
public function testContainerIsolation() {
$this
->enableModules([
'system',
'user',
]);
$this
->assertNull($this
->installConfig('user'));
}
/**
* Tests whether the fixture can re-install modules and configuration.
*
* @depends testContainerIsolation
*/
public function testSubsequentContainerIsolation() {
$this
->enableModules([
'system',
'user',
]);
$this
->assertNull($this
->installConfig('user'));
}
/**
* Tests that an outbound HTTP request can be performed inside of a test.
*/
public function testOutboundHttpRequest() {
// The middleware test.http_client.middleware calls drupal_generate_test_ua
// which checks the DRUPAL_TEST_IN_CHILD_SITE constant, that is not defined
// in Kernel tests.
try {
/** @var \GuzzleHttp\Psr7\Response $response */
$response = $this->container
->get('http_client')
->head('http://example.com');
self::assertEquals(200, $response
->getStatusCode());
} catch (\Throwable $e) {
// Ignore any HTTP errors, any other exception is considered an error.
self::assertInstanceOf(GuzzleException::class, $e, sprintf('Asserting that a possible exception is thrown. Got "%s" with message: "%s".', get_class($e), $e
->getMessage()));
}
}
/**
* @covers ::render
*/
public function testRender() {
$type = 'processed_text';
$element_info = $this->container
->get('element_info');
$this
->assertSame([
'#defaults_loaded' => TRUE,
], $element_info
->getInfo($type));
$this
->enableModules([
'filter',
]);
$this
->assertNotSame($element_info, $this->container
->get('element_info'));
$this
->assertNotEmpty($this->container
->get('element_info')
->getInfo($type));
$build = [
'#type' => 'html_tag',
'#tag' => 'h3',
'#value' => 'Inner',
];
$expected = "<h3>Inner</h3>\n";
$this
->assertEquals('core', \Drupal::theme()
->getActiveTheme()
->getName());
$output = \Drupal::service('renderer')
->renderRoot($build);
$this
->assertEquals('core', \Drupal::theme()
->getActiveTheme()
->getName());
$this
->assertEquals($expected, $build['#markup']);
$this
->assertEquals($expected, $output);
}
/**
* @covers ::render
*/
public function testRenderWithTheme() {
$this
->enableModules([
'system',
]);
$build = [
'#type' => 'textfield',
'#name' => 'test',
];
$expected = '/' . preg_quote('<input type="text" name="test"', '/') . '/';
$this
->assertArrayNotHasKey('theme', $GLOBALS);
$output = \Drupal::service('renderer')
->renderRoot($build);
$this
->assertEquals('core', \Drupal::theme()
->getActiveTheme()
->getName());
$this
->assertMatchesRegularExpression($expected, (string) $build['#children']);
$this
->assertMatchesRegularExpression($expected, (string) $output);
}
/**
* @covers ::bootKernel
*/
public function testBootKernel() {
$this
->assertNull($this->container
->get('request_stack')
->getParentRequest(), 'There should only be one request on the stack');
$this
->assertEquals('public', \Drupal::config('system.file')
->get('default_scheme'));
}
/**
* Tests the assumption that local time is in 'Australia/Sydney'.
*/
public function testLocalTimeZone() {
// The 'Australia/Sydney' time zone is set in core/tests/bootstrap.php
$this
->assertEquals('Australia/Sydney', date_default_timezone_get());
}
/**
* Tests that a test method is skipped when it requires a module not present.
*
* In order to catch checkRequirements() regressions, we have to make a new
* test object and run checkRequirements() here.
*
* @covers ::checkRequirements
* @covers ::checkModuleRequirements
*/
public function testMethodRequiresModule() {
require __DIR__ . '/../../fixtures/KernelMissingDependentModuleMethodTest.php';
$stub_test = new KernelMissingDependentModuleMethodTest();
// We have to setName() to the method name we're concerned with.
$stub_test
->setName('testRequiresModule');
// We cannot use $this->setExpectedException() because PHPUnit would skip
// the test before comparing the exception type.
try {
$stub_test
->publicCheckRequirements();
$this
->fail('Missing required module throws skipped test exception.');
} catch (SkippedTestError $e) {
$this
->assertEquals('Required modules: module_does_not_exist', $e
->getMessage());
}
}
/**
* Tests that a test case is skipped when it requires a module not present.
*
* In order to catch checkRequirements() regressions, we have to make a new
* test object and run checkRequirements() here.
*
* @covers ::checkRequirements
* @covers ::checkModuleRequirements
*/
public function testRequiresModule() {
require __DIR__ . '/../../fixtures/KernelMissingDependentModuleTest.php';
$stub_test = new KernelMissingDependentModuleTest();
// We have to setName() to the method name we're concerned with.
$stub_test
->setName('testRequiresModule');
// We cannot use $this->setExpectedException() because PHPUnit would skip
// the test before comparing the exception type.
try {
$stub_test
->publicCheckRequirements();
$this
->fail('Missing required module throws skipped test exception.');
} catch (SkippedTestError $e) {
$this
->assertEquals('Required modules: module_does_not_exist', $e
->getMessage());
}
}
/**
* {@inheritdoc}
*/
protected function tearDown() : void {
parent::tearDown();
// Check that all tables of the test instance have been deleted. At this
// point the original database connection is restored so we need to prefix
// the tables.
$connection = Database::getConnection();
if ($connection
->databaseType() === 'sqlite') {
$result = $connection
->query("SELECT name FROM " . $this->databasePrefix . ".sqlite_master WHERE type = :type AND name LIKE :table_name AND name NOT LIKE :pattern", [
':type' => 'table',
':table_name' => '%',
':pattern' => 'sqlite_%',
])
->fetchAllKeyed(0, 0);
$this
->assertEmpty($result, 'All test tables have been removed.');
}
else {
$tables = $connection
->schema()
->findTables($this->databasePrefix . '%');
$this
->assertEmpty($tables, 'All test tables have been removed.');
}
}
/**
* Ensures KernelTestBase tests can access modules in profiles.
*/
public function testProfileModules() {
$this
->assertFileExists('core/profiles/demo_umami/modules/demo_umami_content/demo_umami_content.info.yml');
$this
->assertSame('core/profiles/demo_umami/modules/demo_umami_content/demo_umami_content.info.yml', \Drupal::service('extension.list.module')
->getPathname('demo_umami_content'));
}
/**
* Tests the dump() function provided by the var-dumper Symfony component.
*/
public function testVarDump() {
// Append the stream capturer to the STDOUT stream, so that we can test the
// dump() output and also prevent it from actually outputting in this
// particular test.
stream_filter_register("capture", StreamCapturer::class);
stream_filter_append(STDOUT, "capture");
// Dump some variables.
$this
->enableModules([
'system',
'user',
]);
$role = Role::create([
'id' => 'test_role',
'label' => 'Test role',
]);
dump($role);
dump($role
->id());
$this
->assertStringContainsString('Drupal\\user\\Entity\\Role', StreamCapturer::$cache);
$this
->assertStringContainsString('test_role', StreamCapturer::$cache);
}
/**
* @covers ::bootEnvironment
*/
public function testDatabaseDriverModuleEnabled() {
$module = Database::getConnection()
->getProvider();
// Test that the module that is providing the database driver is enabled.
$this
->assertSame(1, \Drupal::service('extension.list.module')
->get($module)->status);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 3 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected static | property | Modules to enable. | 117 |
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 4 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 2 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
12 |
KernelTestBase:: |
protected | function | Renders a render array. | |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
protected | function | 90 | |
KernelTestBase:: |
public static | function | ||
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 1 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
KernelTestBaseTest:: |
protected | function |
Overrides KernelTestBase:: |
|
KernelTestBaseTest:: |
public | function | @covers ::bootEnvironment | |
KernelTestBaseTest:: |
public | function | @covers ::bootKernel | |
KernelTestBaseTest:: |
public | function | Tests whether the fixture allows us to install modules and configuration. | |
KernelTestBaseTest:: |
public | function | @covers ::bootEnvironment | |
KernelTestBaseTest:: |
public | function | @covers ::getDatabaseConnectionInfo | |
KernelTestBaseTest:: |
public | function | Tests the assumption that local time is in 'Australia/Sydney'. | |
KernelTestBaseTest:: |
public | function | Tests that a test method is skipped when it requires a module not present. | |
KernelTestBaseTest:: |
public | function | Tests that an outbound HTTP request can be performed inside of a test. | |
KernelTestBaseTest:: |
public | function | Ensures KernelTestBase tests can access modules in profiles. | |
KernelTestBaseTest:: |
public | function | @covers ::register | |
KernelTestBaseTest:: |
public | function | @covers ::render | |
KernelTestBaseTest:: |
public | function | @covers ::render | |
KernelTestBaseTest:: |
public | function | Tests that a test case is skipped when it requires a module not present. | |
KernelTestBaseTest:: |
public | function | @covers ::setUp | |
KernelTestBaseTest:: |
public | function | @covers ::setUpBeforeClass | |
KernelTestBaseTest:: |
public | function | @covers ::setUp @depends testSetUp | |
KernelTestBaseTest:: |
public | function | Tests whether the fixture can re-install modules and configuration. | |
KernelTestBaseTest:: |
public | function | Tests the dump() function provided by the var-dumper Symfony component. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
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. | |
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. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |