TransactionTest.php

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Database\Live;

use CodeIgniter\Database\Exceptions\DatabaseException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\DatabaseTestTrait;
use Config\Database;
use PHPUnit\Framework\Attributes\Group;
use Tests\Support\Database\Seeds\CITestSeeder;

/**
 * @internal
 */
#[Group('DatabaseLive')]
final class TransactionTest extends CIUnitTestCase
{
    use DatabaseTestTrait;

    protected $refresh = true;
    protected $seed    = CITestSeeder::class;

    protected function setUp(): void
    {
        // Reset connection instance.
        $this->db = Database::connect($this->DBGroup, false);

        parent::setUp();
    }

    /**
     * Sets $DBDebug to false.
     *
     * WARNING: this value will persist! take care to roll it back.
     */
    protected function disableDBDebug(): void
    {
        $this->setPrivateProperty($this->db, 'DBDebug', false);
    }

    /**
     * Sets $DBDebug to true.
     */
    protected function enableDBDebug(): void
    {
        $this->setPrivateProperty($this->db, 'DBDebug', true);
    }

    public function testTransStartDBDebugTrue(): void
    {
        $this->enableDBDebug();

        $builder = $this->db->transException(true)->table('job');
        $e       = null;

        try {
            $this->db->transStart();

            $jobData = [
                'name'        => 'Grocery Sales',
                'description' => 'Discount!',
            ];
            $builder->insert($jobData);

            // Duplicate entry '1' for key 'PRIMARY'
            $jobData = [
                'id'          => 1,
                'name'        => 'Comedian',
                'description' => 'Theres something in your teeth',
            ];
            $builder->insert($jobData);

            $this->db->transComplete();
        } catch (DatabaseException $e) {
            // Do nothing.

            // MySQLi
            // mysqli_sql_exception: Duplicate entry '1' for key 'PRIMARY'

            // SQLite3
            // ErrorException: SQLite3::exec(): UNIQUE constraint failed: db_job.id

            // Postgres
            // ErrorException: pg_query(): Query failed: ERROR:  duplicate key value violates unique constraint "pk_db_job"
            //   DETAIL:  Key (id)=(1) already exists.

            // SQLSRV
            // Exception: [Microsoft][ODBC Driver 17 for SQL Server][SQL Server]Cannot insert explicit
            //   value for identity column in table 'db_job' when IDENTITY_INSERT is set to OFF.

            // OCI8
            // ErrorException: oci_execute(): ORA-00001: unique constraint (ORACLE.pk_db_job) violated
        }

        $this->assertInstanceOf(DatabaseException::class, $e);
        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);
    }

    public function testTransStartDBDebugFalse(): void
    {
        $this->disableDBDebug();

        $builder = $this->db->table('job');

        $this->db->transStart();

        $jobData = [
            'name'        => 'Grocery Sales',
            'description' => 'Discount!',
        ];
        $builder->insert($jobData);

        $this->assertTrue($this->db->transStatus());

        // Duplicate entry '1' for key 'PRIMARY'
        $jobData = [
            'id'          => 1,
            'name'        => 'Comedian',
            'description' => 'Theres something in your teeth',
        ];
        $builder->insert($jobData);

        $this->assertFalse($this->db->transStatus());

        $this->db->transComplete();

        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);

        $this->enableDBDebug();
    }

    public function testTransStrictTrueAndDBDebugFalse(): void
    {
        $this->disableDBDebug();

        $builder = $this->db->table('job');

        // The first transaction group
        $this->db->transStart();

        $jobData = [
            'name'        => 'Grocery Sales',
            'description' => 'Discount!',
        ];
        $builder->insert($jobData);

        $this->assertTrue($this->db->transStatus());

        // Duplicate entry '1' for key 'PRIMARY'
        $jobData = [
            'id'          => 1,
            'name'        => 'Comedian',
            'description' => 'Theres something in your teeth',
        ];
        $builder->insert($jobData);

        $this->assertFalse($this->db->transStatus());

        $this->db->transComplete();

        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);

        // The second transaction group
        $this->db->transStart();

        $jobData = [
            'name'        => 'Comedian',
            'description' => 'Theres something in your teeth',
        ];
        $builder->insert($jobData);

        $this->assertFalse($this->db->transStatus());

        $this->db->transComplete();

        $this->dontSeeInDatabase('job', ['name' => 'Comedian']);

        $this->enableDBDebug();
    }

    public function testTransStrictFalseAndDBDebugFalse(): void
    {
        $this->disableDBDebug();

        $builder = $this->db->table('job');

        $this->db->transStrict(false);

        // The first transaction group
        $this->db->transStart();

        $jobData = [
            'name'        => 'Grocery Sales',
            'description' => 'Discount!',
        ];
        $builder->insert($jobData);

        $this->assertTrue($this->db->transStatus());

        // Duplicate entry '1' for key 'PRIMARY'
        $jobData = [
            'id'          => 1,
            'name'        => 'Comedian',
            'description' => 'Theres something in your teeth',
        ];
        $builder->insert($jobData);

        $this->assertFalse($this->db->transStatus());

        $this->db->transComplete();

        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);

        // The second transaction group
        $this->db->transStart();

        $jobData = [
            'name'        => 'Comedian',
            'description' => 'Theres something in your teeth',
        ];
        $builder->insert($jobData);

        $this->assertTrue($this->db->transStatus());

        $this->db->transComplete();

        $this->seeInDatabase('job', ['name' => 'Comedian']);

        $this->enableDBDebug();
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/9362
     */
    public function testTransInsertBatchFailed(): void
    {
        $data = [
            [
                'name' => 'Grocery Sales',
            ],
            [
                'name' => null,
            ],
        ];

        $db = $this->db;

        if ($this->db->DBDriver === 'MySQLi') {
            // strict mode is required for MySQLi to throw an exception here
            $config                    = config('Database');
            $config->tests['strictOn'] = true;

            $db = Database::connect($config->tests);
        }

        $db->transStrict(false)->transBegin();
        $db->table('job')->insertBatch($data);

        $this->assertFalse($db->transStatus());

        $db->transComplete();

        $db->transStrict();

        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);
    }
}