class DriverSpecificTransactionTestBase

Same name in other branches
  1. 10 core/tests/Drupal/KernelTests/Core/Database/DriverSpecificTransactionTestBase.php \Drupal\KernelTests\Core\Database\DriverSpecificTransactionTestBase

Tests the transaction abstraction system.

We test nesting by having two transaction layers, an outer and inner. The outer layer encapsulates the inner layer. Our transaction nesting abstraction should allow the outer layer function to call any function it wants, especially the inner layer that starts its own transaction, and be confident that, when the function it calls returns, its own transaction is still "alive."

Call structure: transactionOuterLayer() Start transaction transactionInnerLayer() Start transaction (does nothing in database) [Maybe decide to roll back] Do more stuff Should still be in transaction A

These method can be overridden by non-core database driver if their transaction behavior is different from core. For example, both oci8 (Oracle) and mysqli (MySql) clients do not have a solution to check if a transaction is active, and mysqli does not fail when rolling back and no transaction active.

Hierarchy

Expanded class hierarchy of DriverSpecificTransactionTestBase

3 files declare their use of DriverSpecificTransactionTestBase
TransactionTest.php in core/modules/sqlite/tests/src/Kernel/sqlite/TransactionTest.php
TransactionTest.php in core/modules/mysql/tests/src/Kernel/mysql/TransactionTest.php
TransactionTest.php in core/modules/pgsql/tests/src/Kernel/pgsql/TransactionTest.php

File

core/tests/Drupal/KernelTests/Core/Database/DriverSpecificTransactionTestBase.php, line 41

Namespace

Drupal\KernelTests\Core\Database
View source 
class DriverSpecificTransactionTestBase extends DriverSpecificDatabaseTestBase {
    
    /**
     * Keeps track of the post-transaction callback action executed.
     */
    protected ?string $postTransactionCallbackAction = NULL;
    
    /**
     * Create a root Drupal transaction.
     */
    protected function createRootTransaction(string $name = '', bool $insertRow = TRUE) : Transaction {
        $this->assertFalse($this->connection
            ->inTransaction());
        $this->assertSame(0, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Start root transaction. Corresponds to 'BEGIN TRANSACTION' on the
        // database.
        $transaction = $this->connection
            ->startTransaction($name);
        $this->assertTrue($this->connection
            ->inTransaction());
        $this->assertSame(1, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Insert a single row into the testing table.
        if ($insertRow) {
            $this->insertRow('David');
            $this->assertRowPresent('David');
        }
        return $transaction;
    }
    
    /**
     * Create a Drupal savepoint transaction after root.
     */
    protected function createFirstSavepointTransaction(string $name = '', bool $insertRow = TRUE) : Transaction {
        $this->assertTrue($this->connection
            ->inTransaction());
        $this->assertSame(1, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Starts a savepoint transaction. Corresponds to 'SAVEPOINT savepoint_1'
        // on the database. The name can be changed by the $name argument.
        $savepoint = $this->connection
            ->startTransaction($name);
        $this->assertTrue($this->connection
            ->inTransaction());
        $this->assertSame(2, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Insert a single row into the testing table.
        if ($insertRow) {
            $this->insertRow('Roger');
            $this->assertRowPresent('Roger');
        }
        return $savepoint;
    }
    
    /**
     * Encapsulates a transaction's "inner layer" with an "outer layer".
     *
     * This "outer layer" transaction starts and then encapsulates the "inner
     * layer" transaction. This nesting is used to evaluate whether the database
     * transaction API properly supports nesting. By "properly supports," we mean
     * the outer transaction continues to exist regardless of what functions are
     * called and whether those functions start their own transactions.
     *
     * In contrast, a typical database would commit the outer transaction, start
     * a new transaction for the inner layer, commit the inner layer transaction,
     * and then be confused when the outer layer transaction tries to commit its
     * transaction (which was already committed when the inner transaction
     * started).
     *
     * @param $suffix
     *   Suffix to add to field values to differentiate tests.
     * @param $rollback
     *   Whether or not to try rolling back the transaction when we're done.
     * @param $ddl_statement
     *   Whether to execute a DDL statement during the inner transaction.
     */
    protected function transactionOuterLayer($suffix, $rollback = FALSE, $ddl_statement = FALSE) {
        $depth = $this->connection
            ->transactionManager()
            ->stackDepth();
        $txn = $this->connection
            ->startTransaction();
        // Insert a single row into the testing table.
        $this->connection
            ->insert('test')
            ->fields([
            'name' => 'David' . $suffix,
            'age' => '24',
        ])
            ->execute();
        $this->assertTrue($this->connection
            ->inTransaction(), 'In transaction before calling nested transaction.');
        // We're already in a transaction, but we call ->transactionInnerLayer
        // to nest another transaction inside the current one.
        $this->transactionInnerLayer($suffix, $rollback, $ddl_statement);
        $this->assertTrue($this->connection
            ->inTransaction(), 'In transaction after calling nested transaction.');
        if ($rollback) {
            // Roll back the transaction, if requested.
            // This rollback should propagate to the last savepoint.
            $txn->rollBack();
            $this->assertSame($depth, $this->connection
                ->transactionManager()
                ->stackDepth(), 'Transaction has rolled back to the last savepoint after calling rollBack().');
        }
    }
    
    /**
     * Creates an "inner layer" transaction.
     *
     * This "inner layer" transaction is either used alone or nested inside of the
     * "outer layer" transaction.
     *
     * @param $suffix
     *   Suffix to add to field values to differentiate tests.
     * @param $rollback
     *   Whether or not to try rolling back the transaction when we're done.
     * @param $ddl_statement
     *   Whether to execute a DDL statement during the transaction.
     */
    protected function transactionInnerLayer($suffix, $rollback = FALSE, $ddl_statement = FALSE) {
        $depth = $this->connection
            ->transactionManager()
            ->stackDepth();
        // Start a transaction. If we're being called from ->transactionOuterLayer,
        // then we're already in a transaction. Normally, that would make starting
        // a transaction here dangerous, but the database API handles this problem
        // for us by tracking the nesting and avoiding the danger.
        $txn = $this->connection
            ->startTransaction();
        $depth2 = $this->connection
            ->transactionManager()
            ->stackDepth();
        $this->assertGreaterThan($depth, $depth2, 'Transaction depth has increased with new transaction.');
        // Insert a single row into the testing table.
        $this->connection
            ->insert('test')
            ->fields([
            'name' => 'Daniel' . $suffix,
            'age' => '19',
        ])
            ->execute();
        $this->assertTrue($this->connection
            ->inTransaction(), 'In transaction inside nested transaction.');
        if ($ddl_statement) {
            $table = [
                'fields' => [
                    'id' => [
                        'type' => 'serial',
                        'unsigned' => TRUE,
                        'not null' => TRUE,
                    ],
                ],
                'primary key' => [
                    'id',
                ],
            ];
            $this->connection
                ->schema()
                ->createTable('database_test_1', $table);
            $this->assertTrue($this->connection
                ->inTransaction(), 'In transaction inside nested transaction.');
        }
        if ($rollback) {
            // Roll back the transaction, if requested.
            // This rollback should propagate to the last savepoint.
            $txn->rollBack();
            $this->assertSame($depth, $this->connection
                ->transactionManager()
                ->stackDepth(), 'Transaction has rolled back to the last savepoint after calling rollBack().');
        }
    }
    
    /**
     * Tests root transaction rollback.
     */
    public function testRollbackRoot() : void {
        $transaction = $this->createRootTransaction();
        // Rollback. Since we are at the root, the transaction is closed.
        // Corresponds to 'ROLLBACK' on the database.
        $transaction->rollBack();
        $this->assertRowAbsent('David');
        $this->assertFalse($this->connection
            ->inTransaction());
        $this->assertSame(0, $this->connection
            ->transactionManager()
            ->stackDepth());
    }
    
    /**
     * Tests root transaction rollback after savepoint rollback.
     */
    public function testRollbackRootAfterSavepointRollback() : void {
        $transaction = $this->createRootTransaction();
        $savepoint = $this->createFirstSavepointTransaction();
        // Rollback savepoint. It should get released too. Corresponds to 'ROLLBACK
        // TO savepoint_1' plus 'RELEASE savepoint_1' on the database.
        $savepoint->rollBack();
        $this->assertRowPresent('David');
        $this->assertRowAbsent('Roger');
        $this->assertTrue($this->connection
            ->inTransaction());
        $this->assertSame(1, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Try to rollback root. No savepoint is active, this should succeed.
        $transaction->rollBack();
        $this->assertRowAbsent('David');
        $this->assertRowAbsent('Roger');
        $this->assertFalse($this->connection
            ->inTransaction());
        $this->assertSame(0, $this->connection
            ->transactionManager()
            ->stackDepth());
    }
    
    /**
     * Tests root transaction rollback failure when savepoint is open.
     */
    public function testRollbackRootWithActiveSavepoint() : void {
        $transaction = $this->createRootTransaction();
        $savepoint = $this->createFirstSavepointTransaction();
        // Try to rollback root. Since a savepoint is active, this should fail.
        $this->expectException(TransactionOutOfOrderException::class);
        $this->expectExceptionMessageMatches("/^Error attempting rollback of .*\\\\drupal_transaction\\. Active stack: .*\\\\drupal_transaction > .*\\\\savepoint_1/");
        $transaction->rollBack();
    }
    
    /**
     * Tests savepoint transaction rollback.
     */
    public function testRollbackSavepoint() : void {
        $transaction = $this->createRootTransaction();
        $savepoint = $this->createFirstSavepointTransaction();
        // Rollback savepoint. It should get released too. Corresponds to 'ROLLBACK
        // TO savepoint_1' plus 'RELEASE savepoint_1' on the database.
        $savepoint->rollBack();
        $this->assertRowPresent('David');
        $this->assertRowAbsent('Roger');
        $this->assertTrue($this->connection
            ->inTransaction());
        $this->assertSame(1, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Insert a row.
        $this->insertRow('Syd');
        // Commit root. Corresponds to 'COMMIT' on the database.
        unset($transaction);
        $this->assertRowPresent('David');
        $this->assertRowAbsent('Roger');
        $this->assertRowPresent('Syd');
        $this->assertFalse($this->connection
            ->inTransaction());
        $this->assertSame(0, $this->connection
            ->transactionManager()
            ->stackDepth());
    }
    
    /**
     * Tests savepoint transaction duplicated rollback.
     */
    public function testRollbackTwiceSameSavepoint() : void {
        $transaction = $this->createRootTransaction();
        $savepoint = $this->createFirstSavepointTransaction();
        // Rollback savepoint. It should get released too. Corresponds to 'ROLLBACK
        // TO savepoint_1' plus 'RELEASE savepoint_1' on the database.
        $savepoint->rollBack();
        $this->assertRowPresent('David');
        $this->assertRowAbsent('Roger');
        $this->assertTrue($this->connection
            ->inTransaction());
        $this->assertSame(1, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Insert a row.
        $this->insertRow('Syd');
        // Rollback savepoint again. Should fail since it was released already.
        try {
            $savepoint->rollBack();
            $this->fail('Expected TransactionOutOfOrderException was not thrown');
        } catch (\Exception $e) {
            $this->assertInstanceOf(TransactionOutOfOrderException::class, $e);
            $this->assertMatchesRegularExpression("/^Error attempting rollback of .*\\\\savepoint_1\\. Active stack: .*\\\\drupal_transaction/", $e->getMessage());
        }
        $this->assertRowPresent('David');
        $this->assertRowAbsent('Roger');
        $this->assertRowPresent('Syd');
        $this->assertTrue($this->connection
            ->inTransaction());
        $this->assertSame(1, $this->connection
            ->transactionManager()
            ->stackDepth());
    }
    
    /**
     * Tests savepoint transaction rollback failure when later savepoints exist.
     */
    public function testRollbackSavepointWithLaterSavepoint() : void {
        $transaction = $this->createRootTransaction();
        $savepoint1 = $this->createFirstSavepointTransaction();
        // Starts another savepoint transaction. Corresponds to 'SAVEPOINT
        // savepoint_2' on the database.
        $savepoint2 = $this->connection
            ->startTransaction();
        $this->assertTrue($this->connection
            ->inTransaction());
        $this->assertSame(3, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Insert a row.
        $this->insertRow('Syd');
        $this->assertRowPresent('David');
        $this->assertRowPresent('Roger');
        $this->assertRowPresent('Syd');
        // Try to rollback to savepoint 1. Out of order.
        $this->expectException(TransactionOutOfOrderException::class);
        $this->expectExceptionMessageMatches("/^Error attempting rollback of .*\\\\savepoint_1\\. Active stack: .*\\\\drupal_transaction > .*\\\\savepoint_1 > .*\\\\savepoint_2/");
        $savepoint1->rollBack();
    }
    
    /**
     * Tests a committed transaction.
     *
     * The behavior of this test should be identical for connections that support
     * transactions and those that do not.
     */
    public function testCommittedTransaction() : void {
        try {
            // Create two nested transactions. The changes should be committed.
            $this->transactionOuterLayer('A');
            // Because we committed, both of the inserted rows should be present.
            $saved_age = $this->connection
                ->query('SELECT [age] FROM {test} WHERE [name] = :name', [
                ':name' => 'DavidA',
            ])
                ->fetchField();
            $this->assertSame('24', $saved_age, 'Can retrieve DavidA row after commit.');
            $saved_age = $this->connection
                ->query('SELECT [age] FROM {test} WHERE [name] = :name', [
                ':name' => 'DanielA',
            ])
                ->fetchField();
            $this->assertSame('19', $saved_age, 'Can retrieve DanielA row after commit.');
        } catch (\Exception $e) {
            $this->fail($e->getMessage());
        }
    }
    
    /**
     * Tests the compatibility of transactions with DDL statements.
     */
    public function testTransactionWithDdlStatement() : void {
        // First, test that a commit works normally, even with DDL statements.
        $transaction = $this->createRootTransaction('', FALSE);
        $this->insertRow('row');
        $this->executeDDLStatement();
        unset($transaction);
        $this->assertRowPresent('row');
        // Even in different order.
        $this->cleanUp();
        $transaction = $this->createRootTransaction('', FALSE);
        $this->executeDDLStatement();
        $this->insertRow('row');
        unset($transaction);
        $this->assertRowPresent('row');
        // Even with stacking.
        $this->cleanUp();
        $transaction = $this->createRootTransaction('', FALSE);
        $transaction2 = $this->createFirstSavepointTransaction('', FALSE);
        $this->executeDDLStatement();
        unset($transaction2);
        $transaction3 = $this->connection
            ->startTransaction();
        $this->insertRow('row');
        unset($transaction3);
        unset($transaction);
        $this->assertRowPresent('row');
        // A transaction after a DDL statement should still work the same.
        $this->cleanUp();
        $transaction = $this->createRootTransaction('', FALSE);
        $transaction2 = $this->createFirstSavepointTransaction('', FALSE);
        $this->executeDDLStatement();
        unset($transaction2);
        $transaction3 = $this->connection
            ->startTransaction();
        $this->insertRow('row');
        $transaction3->rollBack();
        unset($transaction3);
        unset($transaction);
        $this->assertRowAbsent('row');
        // The behavior of a rollback depends on the type of database server.
        if ($this->connection
            ->supportsTransactionalDDL()) {
            // For database servers that support transactional DDL, a rollback
            // of a transaction including DDL statements should be possible.
            $this->cleanUp();
            $transaction = $this->createRootTransaction('', FALSE);
            $this->insertRow('row');
            $this->executeDDLStatement();
            $transaction->rollBack();
            unset($transaction);
            $this->assertRowAbsent('row');
            // Including with stacking.
            $this->cleanUp();
            $transaction = $this->createRootTransaction('', FALSE);
            $transaction2 = $this->createFirstSavepointTransaction('', FALSE);
            $this->executeDDLStatement();
            unset($transaction2);
            $transaction3 = $this->connection
                ->startTransaction();
            $this->insertRow('row');
            unset($transaction3);
            $transaction->rollBack();
            unset($transaction);
            $this->assertRowAbsent('row');
        }
        else {
            // For database servers that do not support transactional DDL,
            // the DDL statement should commit the transaction stack.
            $this->cleanUp();
            $transaction = $this->createRootTransaction('', FALSE);
            $this->insertRow('row');
            $this->executeDDLStatement();
            // Try to rollback the outer transaction. It should fail and void
            // the transaction stack.
            $transaction->rollBack();
            $manager = $this->connection
                ->transactionManager();
            $reflectedTransactionState = new \ReflectionMethod($manager, 'getConnectionTransactionState');
            $this->assertSame(ClientConnectionTransactionState::Voided, $reflectedTransactionState->invoke($manager));
            unset($transaction);
            $this->assertRowPresent('row');
        }
    }
    
    /**
     * Inserts a single row into the testing table.
     */
    protected function insertRow($name) {
        $this->connection
            ->insert('test')
            ->fields([
            'name' => $name,
        ])
            ->execute();
    }
    
    /**
     * Executes a DDL statement.
     */
    protected function executeDDLStatement() {
        static $count = 0;
        $table = [
            'fields' => [
                'id' => [
                    'type' => 'serial',
                    'unsigned' => TRUE,
                    'not null' => TRUE,
                ],
            ],
            'primary key' => [
                'id',
            ],
        ];
        $this->connection
            ->schema()
            ->createTable('database_test_' . ++$count, $table);
    }
    
    /**
     * Starts over for a new test.
     */
    protected function cleanUp() {
        $this->connection
            ->truncate('test')
            ->execute();
        $this->postTransactionCallbackAction = NULL;
    }
    
    /**
     * Asserts that a given row is present in the test table.
     *
     * @param string $name
     *   The name of the row.
     * @param string $message
     *   The message to log for the assertion.
     *
     * @internal
     */
    public function assertRowPresent(string $name, ?string $message = NULL) : void {
        $present = (bool) $this->connection
            ->query('SELECT 1 FROM {test} WHERE [name] = :name', [
            ':name' => $name,
        ])
            ->fetchField();
        $this->assertTrue($present, $message ?? "Row '{$name}' should be present, but it actually does not exist.");
    }
    
    /**
     * Asserts that a given row is absent from the test table.
     *
     * @param string $name
     *   The name of the row.
     * @param string $message
     *   The message to log for the assertion.
     *
     * @internal
     */
    public function assertRowAbsent(string $name, ?string $message = NULL) : void {
        $present = (bool) $this->connection
            ->query('SELECT 1 FROM {test} WHERE [name] = :name', [
            ':name' => $name,
        ])
            ->fetchField();
        $this->assertFalse($present, $message ?? "Row '{$name}' should be absent, but it actually exists.");
    }
    
    /**
     * Tests transaction stacking, commit, and rollback.
     */
    public function testTransactionStacking() : void {
        // Standard case: pop the inner transaction before the outer transaction.
        $transaction = $this->createRootTransaction('', FALSE);
        $this->insertRow('outer');
        $transaction2 = $this->createFirstSavepointTransaction('', FALSE);
        $this->insertRow('inner');
        // Pop the inner transaction.
        unset($transaction2);
        $this->assertTrue($this->connection
            ->inTransaction(), 'Still in a transaction after popping the inner transaction');
        // Pop the outer transaction.
        unset($transaction);
        $this->assertFalse($this->connection
            ->inTransaction(), 'Transaction closed after popping the outer transaction');
        $this->assertRowPresent('outer');
        $this->assertRowPresent('inner');
        // Rollback the inner transaction.
        $this->cleanUp();
        $transaction = $this->createRootTransaction('', FALSE);
        $this->insertRow('outer');
        $transaction2 = $this->createFirstSavepointTransaction('', FALSE);
        $this->insertRow('inner');
        // Now rollback the inner transaction.
        $transaction2->rollBack();
        unset($transaction2);
        $this->assertTrue($this->connection
            ->inTransaction(), 'Still in a transaction after popping the outer transaction');
        // Pop the outer transaction, it should commit.
        $this->insertRow('outer-after-inner-rollback');
        unset($transaction);
        $this->assertFalse($this->connection
            ->inTransaction(), 'Transaction closed after popping the inner transaction');
        $this->assertRowPresent('outer');
        $this->assertRowAbsent('inner');
        $this->assertRowPresent('outer-after-inner-rollback');
    }
    
    /**
     * Tests that transactions can continue to be used if a query fails.
     */
    public function testQueryFailureInTransaction() : void {
        $transaction = $this->createRootTransaction('test_transaction', FALSE);
        $this->connection
            ->schema()
            ->dropTable('test');
        // Test a failed query using the query() method.
        try {
            $this->connection
                ->query('SELECT [age] FROM {test} WHERE [name] = :name', [
                ':name' => 'David',
            ])
                ->fetchField();
            $this->fail('Using the query method should have failed.');
        } catch (\Exception) {
            // Just continue testing.
        }
        // Test a failed select query.
        try {
            $this->connection
                ->select('test')
                ->fields('test', [
                'name',
            ])
                ->execute();
            $this->fail('Select query should have failed.');
        } catch (\Exception) {
            // Just continue testing.
        }
        // Test a failed insert query.
        try {
            $this->connection
                ->insert('test')
                ->fields([
                'name' => 'David',
                'age' => '24',
            ])
                ->execute();
            $this->fail('Insert query should have failed.');
        } catch (\Exception) {
            // Just continue testing.
        }
        // Test a failed update query.
        try {
            $this->connection
                ->update('test')
                ->fields([
                'name' => 'Tiffany',
            ])
                ->condition('id', 1)
                ->execute();
            $this->fail('Update query should have failed.');
        } catch (\Exception) {
            // Just continue testing.
        }
        // Test a failed delete query.
        try {
            $this->connection
                ->delete('test')
                ->condition('id', 1)
                ->execute();
            $this->fail('Delete query should have failed.');
        } catch (\Exception) {
            // Just continue testing.
        }
        // Test a failed merge query.
        try {
            $this->connection
                ->merge('test')
                ->key('job', 'Presenter')
                ->fields([
                'age' => '31',
                'name' => 'Tiffany',
            ])
                ->execute();
            $this->fail('Merge query should have failed.');
        } catch (\Exception) {
            // Just continue testing.
        }
        // Test a failed upsert query.
        try {
            $this->connection
                ->upsert('test')
                ->key('job')
                ->fields([
                'job',
                'age',
                'name',
            ])
                ->values([
                'job' => 'Presenter',
                'age' => 31,
                'name' => 'Tiffany',
            ])
                ->execute();
            $this->fail('Upsert query should have failed.');
        } catch (\Exception) {
            // Just continue testing.
        }
        // Create the missing schema and insert a row.
        $this->installSchema('database_test', [
            'test',
        ]);
        $this->connection
            ->insert('test')
            ->fields([
            'name' => 'David',
            'age' => '24',
        ])
            ->execute();
        // Commit the transaction.
        unset($transaction);
        $saved_age = $this->connection
            ->query('SELECT [age] FROM {test} WHERE [name] = :name', [
            ':name' => 'David',
        ])
            ->fetchField();
        $this->assertEquals('24', $saved_age);
    }
    
    /**
     * Tests releasing a savepoint before last is safe.
     */
    public function testReleaseIntermediateSavepoint() : void {
        $transaction = $this->createRootTransaction();
        $savepoint1 = $this->createFirstSavepointTransaction('', FALSE);
        // Starts a savepoint transaction. Corresponds to 'SAVEPOINT savepoint_2'
        // on the database.
        $savepoint2 = $this->connection
            ->startTransaction();
        $this->assertSame(3, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Starts a savepoint transaction. Corresponds to 'SAVEPOINT savepoint_3'
        // on the database.
        $savepoint3 = $this->connection
            ->startTransaction();
        $this->assertSame(4, $this->connection
            ->transactionManager()
            ->stackDepth());
        // Starts a savepoint transaction. Corresponds to 'SAVEPOINT savepoint_4'
        // on the database.
        $savepoint4 = $this->connection
            ->startTransaction();
        $this->assertSame(5, $this->connection
            ->transactionManager()
            ->stackDepth());
        $this->insertRow('row');
        // Commit a savepoint transaction. Corresponds to 'RELEASE SAVEPOINT
        // savepoint_2' on the database.
        unset($savepoint2);
        // Since we have committed an intermediate savepoint Transaction object,
        // the savepoints created later have been dropped by the database already.
        $this->assertSame(2, $this->connection
            ->transactionManager()
            ->stackDepth());
        $this->assertRowPresent('row');
        // Commit the remaining Transaction objects. The client transaction is
        // eventually committed.
        unset($savepoint1);
        unset($transaction);
        $this->assertFalse($this->connection
            ->inTransaction());
        $this->assertRowPresent('row');
    }
    
    /**
     * Tests committing a transaction while savepoints are active.
     */
    public function testCommitWithActiveSavepoint() : void {
        $transaction = $this->createRootTransaction();
        $savepoint1 = $this->createFirstSavepointTransaction('', FALSE);
        // Starts a savepoint transaction. Corresponds to 'SAVEPOINT savepoint_2'
        // on the database.
        $savepoint2 = $this->connection
            ->startTransaction();
        $this->assertSame(3, $this->connection
            ->transactionManager()
            ->stackDepth());
        $this->insertRow('row');
        // Commit the root transaction. Corresponds to 'COMMIT' on the database.
        unset($transaction);
        // Since we have committed the outer (root) Transaction object, the inner
        // (savepoint) ones have been dropped by the database already, and we are
        // no longer in an active transaction state.
        $this->assertSame(0, $this->connection
            ->transactionManager()
            ->stackDepth());
        $this->assertFalse($this->connection
            ->inTransaction());
        $this->assertRowPresent('row');
        // Unpile the inner (savepoint) Transaction object, it should be a no-op
        // anyway given it was dropped by the database already, and removed from
        // our transaction stack.
        unset($savepoint2);
        $this->assertSame(0, $this->connection
            ->transactionManager()
            ->stackDepth());
        $this->assertFalse($this->connection
            ->inTransaction());
        $this->assertRowPresent('row');
    }
    
    /**
     * Tests for transaction names.
     */
    public function testTransactionName() : void {
        $transaction = $this->createRootTransaction('', FALSE);
        $this->assertSame('drupal_transaction', $transaction->name());
        $savepoint1 = $this->createFirstSavepointTransaction('', FALSE);
        $this->assertSame('savepoint_1', $savepoint1->name());
        $this->expectException(TransactionNameNonUniqueException::class);
        $this->expectExceptionMessage("savepoint_1 is already in use.");
        $savepointFailure = $this->connection
            ->startTransaction('savepoint_1');
    }
    
    /**
     * Tests that adding a post-transaction callback fails with no transaction.
     */
    public function testRootTransactionEndCallbackAddedWithoutTransaction() : void {
        $this->expectException(\LogicException::class);
        $this->connection
            ->transactionManager()
            ->addPostTransactionCallback([
            $this,
            'rootTransactionCallback',
        ]);
    }
    
    /**
     * Tests post-transaction callback executes after transaction commit.
     */
    public function testRootTransactionEndCallbackCalledOnCommit() : void {
        $transaction = $this->createRootTransaction('', FALSE);
        $this->connection
            ->transactionManager()
            ->addPostTransactionCallback([
            $this,
            'rootTransactionCallback',
        ]);
        $this->insertRow('row');
        $this->assertNull($this->postTransactionCallbackAction);
        unset($transaction);
        $this->assertSame('rtcCommit', $this->postTransactionCallbackAction);
        $this->assertRowPresent('row');
        $this->assertRowPresent('rtcCommit');
    }
    
    /**
     * Tests post-transaction callback executes after transaction rollback.
     */
    public function testRootTransactionEndCallbackCalledAfterRollbackAndDestruction() : void {
        $transaction = $this->createRootTransaction('', FALSE);
        $this->connection
            ->transactionManager()
            ->addPostTransactionCallback([
            $this,
            'rootTransactionCallback',
        ]);
        $this->insertRow('row');
        $this->assertNull($this->postTransactionCallbackAction);
        // Callbacks are processed only when destructing the transaction.
        // Executing a rollback is not sufficient by itself.
        $transaction->rollBack();
        $this->assertNull($this->postTransactionCallbackAction);
        $this->assertRowAbsent('rtcCommit');
        $this->assertRowAbsent('rtcRollback');
        $this->assertRowAbsent('row');
        // Destruct the transaction.
        unset($transaction);
        // The post-transaction callback should now have inserted a 'rtcRollback'
        // row.
        $this->assertSame('rtcRollback', $this->postTransactionCallbackAction);
        $this->assertRowAbsent('rtcCommit');
        $this->assertRowPresent('rtcRollback');
        $this->assertRowAbsent('row');
    }
    
    /**
     * Tests post-transaction callback executes after a DDL statement.
     */
    public function testRootTransactionEndCallbackCalledAfterDdlAndDestruction() : void {
        $transaction = $this->createRootTransaction('', FALSE);
        $this->connection
            ->transactionManager()
            ->addPostTransactionCallback([
            $this,
            'rootTransactionCallback',
        ]);
        $this->insertRow('row');
        $this->assertNull($this->postTransactionCallbackAction);
        // Callbacks are processed only when destructing the transaction.
        // Executing a DDL statement is not sufficient itself.
        // We cannot use truncate here, since it has protective code to fall back
        // to a transactional delete when in transaction. We drop an unrelated
        // table instead.
        $this->connection
            ->schema()
            ->dropTable('test_people');
        $this->assertNull($this->postTransactionCallbackAction);
        $this->assertRowAbsent('rtcCommit');
        $this->assertRowAbsent('rtcRollback');
        $this->assertRowPresent('row');
        // Destruct the transaction.
        unset($transaction);
        // The post-transaction callback should now have inserted a 'rtcCommit'
        // row.
        $this->assertSame('rtcCommit', $this->postTransactionCallbackAction);
        $this->assertRowPresent('rtcCommit');
        $this->assertRowAbsent('rtcRollback');
        $this->assertRowPresent('row');
    }
    
    /**
     * A post-transaction callback for testing purposes.
     */
    public function rootTransactionCallback(bool $success) : void {
        $this->postTransactionCallbackAction = $success ? 'rtcCommit' : 'rtcRollback';
        $this->insertRow($this->postTransactionCallbackAction);
    }
    
    /**
     * Tests TransactionManager failure.
     */
    public function testTransactionManagerFailureOnPendingStackItems() : void {
        $connectionInfo = Database::getConnectionInfo();
        Database::addConnectionInfo('default', 'test_fail', $connectionInfo['default']);
        $testConnection = Database::getConnection('test_fail');
        // Add a fake item to the stack.
        $manager = $testConnection->transactionManager();
        $reflectionMethod = new \ReflectionMethod($manager, 'addStackItem');
        $reflectionMethod->invoke($manager, 'bar', new StackItem('qux', StackItemType::Root));
        // Ensure transaction state can be determined during object destruction.
        // This is necessary for the test to pass when xdebug.mode has the 'develop'
        // option enabled.
        $reflectionProperty = new \ReflectionProperty(TransactionManagerBase::class, 'connectionTransactionState');
        $reflectionProperty->setValue($manager, ClientConnectionTransactionState::Active);
        // Ensure that __destruct() results in an assertion error. Note that this
        // will normally be called by PHP during the object's destruction but Drupal
        // will commit all transactions when a database is closed thereby making
        // this impossible to test unless it is called directly.
        try {
            $manager->__destruct();
            $this->fail("Expected AssertionError error not thrown");
        } catch (\AssertionError $e) {
            $this->assertStringStartsWith('Transaction $stack was not empty. Active stack: bar\\qux', $e->getMessage());
        }
        // Clean up.
        $reflectionProperty = new \ReflectionProperty(TransactionManagerBase::class, 'stack');
        $reflectionProperty->setValue($manager, []);
        unset($testConnection);
        Database::closeConnection('test_fail');
    }

}

Members

Title 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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::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.
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.
DatabaseTestSchemaDataTrait::addSampleData protected function Sets up our sample data.
DatabaseTestSchemaInstallTrait::installSampleSchema protected function Sets up our sample table schema.
DriverSpecificDatabaseTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
DriverSpecificDatabaseTestBase::setUp protected function Overrides DriverSpecificKernelTestBase::setUp
DriverSpecificKernelTestBase::$connection protected property The database connection for testing. 1
DriverSpecificTransactionTestBase::$postTransactionCallbackAction protected property Keeps track of the post-transaction callback action executed.
DriverSpecificTransactionTestBase::assertRowAbsent public function Asserts that a given row is absent from the test table.
DriverSpecificTransactionTestBase::assertRowPresent public function Asserts that a given row is present in the test table.
DriverSpecificTransactionTestBase::cleanUp protected function Starts over for a new test.
DriverSpecificTransactionTestBase::createFirstSavepointTransaction protected function Create a Drupal savepoint transaction after root.
DriverSpecificTransactionTestBase::createRootTransaction protected function Create a root Drupal transaction.
DriverSpecificTransactionTestBase::executeDDLStatement protected function Executes a DDL statement.
DriverSpecificTransactionTestBase::insertRow protected function Inserts a single row into the testing table.
DriverSpecificTransactionTestBase::rootTransactionCallback public function A post-transaction callback for testing purposes.
DriverSpecificTransactionTestBase::testCommittedTransaction public function Tests a committed transaction.
DriverSpecificTransactionTestBase::testCommitWithActiveSavepoint public function Tests committing a transaction while savepoints are active.
DriverSpecificTransactionTestBase::testQueryFailureInTransaction public function Tests that transactions can continue to be used if a query fails.
DriverSpecificTransactionTestBase::testReleaseIntermediateSavepoint public function Tests releasing a savepoint before last is safe.
DriverSpecificTransactionTestBase::testRollbackRoot public function Tests root transaction rollback.
DriverSpecificTransactionTestBase::testRollbackRootAfterSavepointRollback public function Tests root transaction rollback after savepoint rollback.
DriverSpecificTransactionTestBase::testRollbackRootWithActiveSavepoint public function Tests root transaction rollback failure when savepoint is open.
DriverSpecificTransactionTestBase::testRollbackSavepoint public function Tests savepoint transaction rollback.
DriverSpecificTransactionTestBase::testRollbackSavepointWithLaterSavepoint public function Tests savepoint transaction rollback failure when later savepoints exist.
DriverSpecificTransactionTestBase::testRollbackTwiceSameSavepoint public function Tests savepoint transaction duplicated rollback.
DriverSpecificTransactionTestBase::testRootTransactionEndCallbackAddedWithoutTransaction public function Tests that adding a post-transaction callback fails with no transaction.
DriverSpecificTransactionTestBase::testRootTransactionEndCallbackCalledAfterDdlAndDestruction public function Tests post-transaction callback executes after a DDL statement.
DriverSpecificTransactionTestBase::testRootTransactionEndCallbackCalledAfterRollbackAndDestruction public function Tests post-transaction callback executes after transaction rollback.
DriverSpecificTransactionTestBase::testRootTransactionEndCallbackCalledOnCommit public function Tests post-transaction callback executes after transaction commit.
DriverSpecificTransactionTestBase::testTransactionManagerFailureOnPendingStackItems public function Tests TransactionManager failure.
DriverSpecificTransactionTestBase::testTransactionName public function Tests for transaction names.
DriverSpecificTransactionTestBase::testTransactionStacking public function Tests transaction stacking, commit, and rollback.
DriverSpecificTransactionTestBase::testTransactionWithDdlStatement public function Tests the compatibility of transactions with DDL statements.
DriverSpecificTransactionTestBase::transactionInnerLayer protected function Creates an "inner layer" transaction.
DriverSpecificTransactionTestBase::transactionOuterLayer protected function Encapsulates a transaction's "inner layer" with an "outer layer".
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
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 protected function Bootstraps a kernel for a test. 1
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. 2
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 28
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. 3
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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.