class EndOfTransactionQueriesTest
Same name in other branches
- 9 core/tests/Drupal/KernelTests/Core/Cache/EndOfTransactionQueriesTest.php \Drupal\KernelTests\Core\Cache\EndOfTransactionQueriesTest
- 10 core/tests/Drupal/KernelTests/Core/Cache/EndOfTransactionQueriesTest.php \Drupal\KernelTests\Core\Cache\EndOfTransactionQueriesTest
- 11.x core/tests/Drupal/KernelTests/Core/Cache/EndOfTransactionQueriesTest.php \Drupal\KernelTests\Core\Cache\EndOfTransactionQueriesTest
Tests that cache tag invalidation queries are delayed to the end of transactions.
@group Cache
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\AssertHelperTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpunitCompatibilityTrait
- class \Drupal\KernelTests\Core\Cache\EndOfTransactionQueriesTest extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of EndOfTransactionQueriesTest
File
-
core/
tests/ Drupal/ KernelTests/ Core/ Cache/ EndOfTransactionQueriesTest.php, line 18
Namespace
Drupal\KernelTests\Core\CacheView source
class EndOfTransactionQueriesTest extends KernelTestBase {
/**
* {@inheritdoc}
*/
public static $modules = [
'delay_cache_tags_invalidation',
'entity_test',
'system',
'user',
];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
// This can only be checked after installing Drupal as it requires functions
// from bootstrap.inc.
if (!class_exists($this->getDatabaseConnectionInfo()['default']['namespace'] . '\\Connection')) {
$this->markTestSkipped(sprintf('No logging override exists for the %s database driver. Create it, subclass this test class and override ::getDatabaseConnectionInfo().', $this->getDatabaseConnectionInfo()['default']['driver']));
}
$this->installSchema('system', 'sequences');
$this->installEntitySchema('entity_test');
$this->installEntitySchema('user');
// Ensure the cachetags table already exists.
Cache::invalidateTags([
$this->randomString(),
]);
}
/**
* {@inheritdoc}
*/
public function register(ContainerBuilder $container) {
parent::register($container);
// Register a database cache backend rather than memory-based.
$container->register('cache_factory', DatabaseBackendFactory::class)
->addArgument(new Reference('database'))
->addArgument(new Reference('cache_tags.invalidator.checksum'))
->addArgument(new Reference('settings'));
}
/**
* {@inheritdoc}
*/
public function testEntitySave() {
\Drupal::cache()->set('test_cache_pretransaction_foobar', 'something', Cache::PERMANENT, [
'foobar',
]);
\Drupal::cache()->set('test_cache_pretransaction_entity_test_list', 'something', Cache::PERMANENT, [
'entity_test_list',
]);
$entity = EntityTest::create([
'name' => $this->randomString(),
]);
\Drupal::database()->resetLoggedStatements();
$entity->save();
$executed_statements = \Drupal::database()->getLoggedStatements();
$last_statement_index = max(array_keys($executed_statements));
$cachetag_statements = array_keys($this->getStatementsForTable(\Drupal::database()->getLoggedStatements(), 'cachetags'));
$this->assertSame($last_statement_index - count($cachetag_statements) + 1, min($cachetag_statements), 'All of the last queries in the transaction are for the "cachetags" table.');
// Verify that a nested entity save occurred.
$this->assertSame('johndoe', User::load(1)->getAccountName());
// Cache reads occurring during a transaction that DO NOT depend on
// invalidated cache tags result in cache HITs. Similarly, cache writes that
// DO NOT depend on invalidated cache tags DO get written. Of course, if we
// read either one now, outside of the context of the transaction, we expect
// the same.
$this->assertNotEmpty(\Drupal::state()->get('delay_cache_tags_invalidation_entity_test_insert__pretransaction_foobar'));
$this->assertNotEmpty(\Drupal::cache()->get('delay_cache_tags_invalidation_entity_test_insert__during_transaction_foobar'));
$this->assertNotEmpty(\Drupal::state()->get('delay_cache_tags_invalidation_user_insert__during_transaction_foobar'));
$this->assertNotEmpty(\Drupal::cache()->get('test_cache_pretransaction_foobar'));
// Cache reads occurring during a transaction that DO depend on invalidated
// cache tags result in cache MISSes. Similarly, cache writes that DO depend
// on invalidated cache tags DO NOT get written. Of course, if we read
// either one now, outside of the context of the transaction, we expect the
// same.
$this->assertFalse(\Drupal::state()->get('delay_cache_tags_invalidation_entity_test_insert__pretransaction_entity_test_list'));
$this->assertFalse(\Drupal::cache()->get('delay_cache_tags_invalidation_entity_test_insert__during_transaction_entity_test_list'));
$this->assertFalse(\Drupal::state()->get('delay_cache_tags_invalidation_user_insert__during_transaction_entity_test_list'));
$this->assertFalse(\Drupal::cache()->get('test_cache_pretransaction_entity_test_list'));
}
/**
* {@inheritdoc}
*/
public function testEntitySaveRollback() {
\Drupal::cache()->set('test_cache_pretransaction_entity_test_list', 'something', Cache::PERMANENT, [
'entity_test_list',
]);
\Drupal::cache()->set('test_cache_pretransaction_user_list', 'something', Cache::PERMANENT, [
'user_list',
]);
\Drupal::state()->set('delay_cache_tags_invalidation_exception', TRUE);
try {
EntityTest::create([
'name' => $this->randomString(),
])
->save();
$this->fail('Exception not thrown');
} catch (\Exception $e) {
$this->assertEquals('Abort entity save to trigger transaction rollback.', $e->getMessage());
}
// The cache has not been invalidated.
$this->assertNotEmpty(\Drupal::cache()->get('test_cache_pretransaction_entity_test_list'));
$this->assertNotEmpty(\Drupal::cache()->get('test_cache_pretransaction_user_list'));
// Save a user, that should invalidate the cache tagged with user_list but
// not the one with entity_test_list.
User::create([
'name' => 'johndoe',
'status' => 1,
])->save();
$this->assertNotEmpty(\Drupal::cache()->get('test_cache_pretransaction_entity_test_list'));
$this->assertFalse(\Drupal::cache()->get('test_cache_pretransaction_user_list'));
}
/**
* Filters statements by table name.
*
* @param string[] $statements
* A list of query statements.
* @param $table_name
* The name of the table to filter by.
*
* @return string[]
* Filtered statement list.
*/
protected function getStatementsForTable(array $statements, $table_name) {
$tables = array_filter(array_map([
$this,
'statementToTableName',
], $statements));
return array_filter($tables, function ($table_for_statement) use ($table_name) {
return $table_for_statement === $table_name;
});
}
/**
* Returns the table name for a statement.
*
* @param string $statement
* The query statement.
*
* @return string|null
* The name of the table or NULL if none was found.
*/
protected static function statementToTableName($statement) {
if (preg_match('/.*\\{([^\\}]+)\\}.*/', $statement, $matches)) {
return $matches[1];
}
else {
return NULL;
}
}
/**
* {@inheritdoc}
*/
protected function getDatabaseConnectionInfo() {
$info = parent::getDatabaseConnectionInfo();
// Override default database driver to one that does logging. Third-party
// (non-core) database drivers can achieve the same test coverage by
// subclassing this test class and overriding only this method.
// @see \Drupal\database_statement_monitoring_test\LoggedStatementsTrait
// @see \Drupal\database_statement_monitoring_test\mysql\Connection
// @see \Drupal\database_statement_monitoring_test\pgsql\Connection
// @see \Drupal\database_statement_monitoring_test\sqlite\Connection
$info['default']['namespace'] = '\\Drupal\\database_statement_monitoring_test\\' . $info['default']['driver'];
return $info;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | 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. | |||
AssertLegacyTrait::assert | protected | function | ||||
AssertLegacyTrait::assertEqual | protected | function | ||||
AssertLegacyTrait::assertIdentical | protected | function | ||||
AssertLegacyTrait::assertIdenticalObject | protected | function | ||||
AssertLegacyTrait::assertNotEqual | protected | function | ||||
AssertLegacyTrait::assertNotIdentical | protected | function | ||||
AssertLegacyTrait::pass | protected | function | ||||
AssertLegacyTrait::verbose | protected | function | ||||
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. | |||
EndOfTransactionQueriesTest::$modules | public static | property | Modules to enable. | Overrides KernelTestBase::$modules | ||
EndOfTransactionQueriesTest::getDatabaseConnectionInfo | protected | function | Returns the Database connection info to be used for this test. | Overrides KernelTestBase::getDatabaseConnectionInfo | ||
EndOfTransactionQueriesTest::getStatementsForTable | protected | function | Filters statements by table name. | |||
EndOfTransactionQueriesTest::register | public | function | Registers test-specific services. | Overrides KernelTestBase::register | ||
EndOfTransactionQueriesTest::setUp | protected | function | Overrides KernelTestBase::setUp | |||
EndOfTransactionQueriesTest::statementToTableName | protected static | function | Returns the table name for a statement. | |||
EndOfTransactionQueriesTest::testEntitySave | public | function | ||||
EndOfTransactionQueriesTest::testEntitySaveRollback | public | function | ||||
KernelTestBase::$backupGlobals | protected | property | Back up and restore any global variables that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributes | protected | property | Back up and restore static class properties that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributesBlacklist | protected | property | Contains a few static class properties for performance. | |||
KernelTestBase::$classLoader | protected | property | ||||
KernelTestBase::$configImporter | protected | property | @todo Move into Config test base class. | 7 | ||
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | |||
KernelTestBase::$container | protected | property | ||||
KernelTestBase::$databasePrefix | protected | property | ||||
KernelTestBase::$preserveGlobalState | protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. |
|||
KernelTestBase::$root | protected | property | The app root. | |||
KernelTestBase::$runTestInSeparateProcess | 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::$siteDirectory | protected | property | ||||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 6 | ||
KernelTestBase::$vfsRoot | protected | property | The virtual filesystem root directory. | |||
KernelTestBase::assertPostConditions | protected | function | 1 | |||
KernelTestBase::bootEnvironment | protected | function | Bootstraps a basic test environment. | |||
KernelTestBase::bootKernel | private | function | Bootstraps a kernel for a test. | |||
KernelTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |||
KernelTestBase::disableModules | protected | function | Disables modules for this test. | |||
KernelTestBase::enableModules | protected | function | Enables modules for this test. | |||
KernelTestBase::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | |||
KernelTestBase::getDatabasePrefix | public | function | ||||
KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to enable. | |||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to enable for this test. | |||
KernelTestBase::initFileCache | protected | function | Initializes the FileCache component. | |||
KernelTestBase::installConfig | protected | function | Installs default configuration for a given list of modules. | |||
KernelTestBase::installEntitySchema | protected | function | Installs the storage schema for a specific entity type. | |||
KernelTestBase::installSchema | protected | function | Installs database tables from a module schema definition. | |||
KernelTestBase::isTestInIsolation | Deprecated | protected | function | Returns whether the current test method is running in a separate process. | ||
KernelTestBase::prepareTemplate | protected | function | ||||
KernelTestBase::render | protected | function | Renders a render array. | 1 | ||
KernelTestBase::setInstallProfile | protected | function | Sets the install profile and rebuilds the container to update it. | |||
KernelTestBase::setSetting | protected | function | Sets an in-memory Settings variable. | |||
KernelTestBase::setUpBeforeClass | public static | function | 1 | |||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 2 | ||
KernelTestBase::stop | protected | function | Stops test execution. | |||
KernelTestBase::tearDown | protected | function | 5 | |||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | @after | |||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |||
KernelTestBase::__get | Deprecated | public | function | BC: Automatically resolve former KernelTestBase class properties. | ||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | |||
PhpunitCompatibilityTrait::getMock | Deprecated | public | function | Returns a mock object for the specified class using the available method. | ||
PhpunitCompatibilityTrait::setExpectedException | Deprecated | public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | ||
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. | |||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | |||
TestRequirementsTrait::checkModuleRequirements | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | 1 | ||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.