cakephp/src/TestSuite/Fixture/TransactionFixtureStrategy.php

<?php
declare(strict_types=1);

/**
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         5.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\TestSuite\Fixture;

use Cake\Database\Connection;
use RuntimeException;

/**
 * Fixture strategy that wraps fixtures in a transaction that is rolled back
 * after each test.
 *
 * Any test that calls Connection::rollback(true) will break this strategy.
 */
class TransactionFixtureStrategy implements FixtureStrategyInterface
{
    /**
     * @var \Cake\TestSuite\Fixture\FixtureHelper
     */
    protected $helper;

    /**
     * @var array<\Cake\Datasource\FixtureInterface>
     */
    protected $fixtures = [];

    /**
     * Initialize strategy.
     */
    public function __construct()
    {
        $this->helper = new FixtureHelper();
    }

    /**
     * @inheritDoc
     */
    public function setupTest(array $fixtureNames): void
    {
        $this->fixtures = $this->helper->loadFixtures($fixtureNames);

        $this->helper->runPerConnection(function ($connection) {
            if ($connection instanceof Connection) {
                assert(
                    $connection->inTransaction() === false,
                    'Cannot start transaction strategy inside a transaction. This is most likely a bug.'
                );
                $connection->enableSavePoints();
                if (!$connection->isSavePointsEnabled()) {
                    throw new RuntimeException(
                        "Could not enable save points for the `{$connection->configName()}` connection. " .
                            'Your database needs to support savepoints in order to use ' .
                            'TransactionFixtureStrategy.'
                    );
                }

                $connection->begin();
                $connection->createSavePoint('__fixtures__');
            }
        }, $this->fixtures);

        $this->helper->insert($this->fixtures);
    }

    /**
     * @inheritDoc
     */
    public function teardownTest(): void
    {
        $this->helper->runPerConnection(function ($connection) {
            if ($connection->inTransaction()) {
                $connection->rollback(true);
            }
        }, $this->fixtures);
    }
}