BulkInsertTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\Database\Query;
 
use Doctrine\DBAL\Platforms\AbstractPlatform;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\MockObject\MockObject;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\Query\BulkInsertQuery;
use ‪TYPO3\CMS\Core\Tests\Unit\Database\Mocks\MockPlatform\MockMySQLPlatform;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪BulkInsertTest extends UnitTestCase
{
    protected ‪Connection&MockObject ‪$connection;
    protected ?AbstractPlatform ‪$platform;
    protected string ‪$testTable = 'testTable';
 
    protected function ‪setUp(): void
    {
        parent::setUp();
 
        $this->connection = $this->createMock(Connection::class);
 
        $this->connection
            ->method('quoteIdentifier')
            ->willReturnArgument(0);
        $this->connection
            ->method('getDatabasePlatform')
            ->willReturn(new ‪MockMySQLPlatform());
    }
 
    #[Test]
    public function ‪getSQLWithoutSpecifiedValuesThrowsException(): void
    {
        $this->expectException(\LogicException::class);
        $this->expectExceptionMessage('You need to add at least one set of values before generating the SQL.');
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable);
 
        $query->getSQL();
    }
 
    #[Test]
    public function ‪insertWithoutColumnAndTypeSpecification(): void
    {
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable);
 
        $query->addValues([]);
 
        self::assertSame("INSERT INTO {$this->testTable} VALUES ()", (string)$query);
        self::assertSame([], $query->getParameters());
        self::assertSame([], $query->getParameterTypes());
    }
 
    public function ‪insertWithoutColumnSpecification(): void
    {
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable);
 
        $query->addValues([], [‪Connection::PARAM_BOOL]);
 
        self::assertSame("INSERT INTO {$this->testTable} VALUES ()", (string)$query);
        self::assertSame([], $query->getParameters());
        self::assertSame([], $query->getParameterTypes());
    }
 
    #[Test]
    public function ‪singleInsertWithoutColumnSpecification(): void
    {
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable);
 
        $query->addValues(['bar', 'baz', 'named' => 'bloo']);
 
        self::assertSame("INSERT INTO {$this->testTable} VALUES (?, ?, ?)", (string)$query);
        self::assertSame(['bar', 'baz', 'bloo'], $query->getParameters());
        self::assertSame([null, null, null], $query->getParameterTypes());
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable);
 
        $query->addValues(
            ['bar', 'baz', 'named' => 'bloo'],
            ['named' => ‪Connection::PARAM_BOOL, null, ‪Connection::PARAM_INT]
        );
 
        self::assertSame("INSERT INTO {$this->testTable} VALUES (?, ?, ?)", (string)$query);
        self::assertSame(['bar', 'baz', 'bloo'], $query->getParameters());
        self::assertSame([null, ‪Connection::PARAM_INT, ‪Connection::PARAM_BOOL], $query->getParameterTypes());
    }
 
    #[Test]
    public function ‪multiInsertWithoutColumnSpecification(): void
    {
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable);
 
        $query->addValues([]);
        $query->addValues(['bar', 'baz']);
        $query->addValues(['bar', 'baz', 'bloo']);
        $query->addValues(['bar', 'baz', 'named' => 'bloo']);
 
        self::assertSame("INSERT INTO {$this->testTable} VALUES (), (?, ?), (?, ?, ?), (?, ?, ?)", (string)$query);
        self::assertSame(['bar', 'baz', 'bar', 'baz', 'bloo', 'bar', 'baz', 'bloo'], $query->getParameters());
        self::assertSame([null, null, null, null, null, null, null, null], $query->getParameterTypes());
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable);
 
        $query->addValues([], [‪Connection::PARAM_INT]);
        $query->addValues(['bar', 'baz'], [1 => ‪Connection::PARAM_BOOL]);
        $query->addValues(['bar', 'baz', 'bloo'], [‪Connection::PARAM_INT, null, ‪Connection::PARAM_BOOL]);
        $query->addValues(
            ['bar', 'baz', 'named' => 'bloo'],
            ['named' => ‪Connection::PARAM_INT, null, ‪Connection::PARAM_BOOL]
        );
 
        self::assertSame("INSERT INTO {$this->testTable} VALUES (), (?, ?), (?, ?, ?), (?, ?, ?)", (string)$query);
        self::assertSame(['bar', 'baz', 'bar', 'baz', 'bloo', 'bar', 'baz', 'bloo'], $query->getParameters());
        self::assertSame(
            [
                null,
                ‪Connection::PARAM_BOOL,
                ‪Connection::PARAM_INT,
                null,
                ‪Connection::PARAM_BOOL,
                null,
                ‪Connection::PARAM_BOOL,
                ‪Connection::PARAM_INT,
            ],
            $query->getParameterTypes()
        );
    }
 
    #[Test]
    public function ‪singleInsertWithColumnSpecificationAndPositionalTypeValues(): void
    {
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
 
        $query->addValues(['bar', 'baz']);
 
        self::assertSame("INSERT INTO {$this->testTable} (bar, baz) VALUES (?, ?)", (string)$query);
        self::assertSame(['bar', 'baz'], $query->getParameters());
        self::assertSame([‪Connection::PARAM_STR, ‪Connection::PARAM_STR], $query->getParameterTypes());
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
 
        $query->addValues(['bar', 'baz'], [1 => ‪Connection::PARAM_BOOL]);
 
        self::assertSame("INSERT INTO {$this->testTable} (bar, baz) VALUES (?, ?)", (string)$query);
        self::assertSame(['bar', 'baz'], $query->getParameters());
        self::assertSame([‪Connection::PARAM_STR, ‪Connection::PARAM_BOOL], $query->getParameterTypes());
    }
 
    #[Test]
    public function ‪singleInsertWithColumnSpecificationAndNamedTypeValues(): void
    {
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
 
        $query->addValues(['baz' => 'baz', 'bar' => 'bar']);
 
        self::assertSame("INSERT INTO {$this->testTable} (bar, baz) VALUES (?, ?)", (string)$query);
        self::assertSame(['bar', 'baz'], $query->getParameters());
        self::assertSame([‪Connection::PARAM_STR, ‪Connection::PARAM_STR], $query->getParameterTypes());
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
 
        $query->addValues(['baz' => 'baz', 'bar' => 'bar'], [null, ‪Connection::PARAM_INT]);
 
        self::assertSame("INSERT INTO {$this->testTable} (bar, baz) VALUES (?, ?)", (string)$query);
        self::assertSame(['bar', 'baz'], $query->getParameters());
        self::assertSame([‪Connection::PARAM_STR, ‪Connection::PARAM_INT], $query->getParameterTypes());
    }
 
    #[Test]
    public function ‪singleInsertWithColumnSpecificationAndMixedTypeValues(): void
    {
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
 
        $query->addValues([1 => 'baz', 'bar' => 'bar']);
 
        self::assertSame("INSERT INTO {$this->testTable} (bar, baz) VALUES (?, ?)", (string)$query);
        self::assertSame(['bar', 'baz'], $query->getParameters());
        self::assertSame([‪Connection::PARAM_STR, ‪Connection::PARAM_STR], $query->getParameterTypes());
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
 
        $query->addValues([1 => 'baz', 'bar' => 'bar'], [‪Connection::PARAM_INT, ‪Connection::PARAM_BOOL]);
 
        self::assertSame("INSERT INTO {$this->testTable} (bar, baz) VALUES (?, ?)", (string)$query);
        self::assertSame(['bar', 'baz'], $query->getParameters());
        self::assertSame([‪Connection::PARAM_INT, ‪Connection::PARAM_BOOL], $query->getParameterTypes());
    }
 
    #[Test]
    public function ‪multiInsertWithColumnSpecification(): void
    {
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
 
        $query->addValues(['bar', 'baz']);
        $query->addValues([1 => 'baz', 'bar' => 'bar']);
        $query->addValues(['bar', 'baz' => 'baz']);
        $query->addValues(['bar' => 'bar', 'baz' => 'baz']);
 
        self::assertSame(
            "INSERT INTO {$this->testTable} (bar, baz) VALUES (?, ?), (?, ?), (?, ?), (?, ?)",
            (string)$query
        );
        self::assertSame(['bar', 'baz', 'bar', 'baz', 'bar', 'baz', 'bar', 'baz'], $query->getParameters());
        self::assertSame([‪Connection::PARAM_STR, ‪Connection::PARAM_STR, ‪Connection::PARAM_STR, ‪Connection::PARAM_STR, ‪Connection::PARAM_STR, ‪Connection::PARAM_STR, ‪Connection::PARAM_STR, ‪Connection::PARAM_STR], $query->getParameterTypes());
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
 
        $query->addValues(['bar', 'baz'], ['baz' => ‪Connection::PARAM_BOOL, 'bar' => ‪Connection::PARAM_INT]);
        $query->addValues([1 => 'baz', 'bar' => 'bar'], [1 => ‪Connection::PARAM_BOOL, 'bar' => ‪Connection::PARAM_INT]);
        $query->addValues(['bar', 'baz' => 'baz'], [null, null]);
        $query->addValues(
            ['bar' => 'bar', 'baz' => 'baz'],
            ['bar' => ‪Connection::PARAM_INT, 'baz' => ‪Connection::PARAM_BOOL]
        );
 
        self::assertSame(
            "INSERT INTO {$this->testTable} (bar, baz) VALUES (?, ?), (?, ?), (?, ?), (?, ?)",
            (string)$query
        );
        self::assertSame(['bar', 'baz', 'bar', 'baz', 'bar', 'baz', 'bar', 'baz'], $query->getParameters());
        self::assertSame(
            [
                ‪Connection::PARAM_INT,
                ‪Connection::PARAM_BOOL,
                ‪Connection::PARAM_INT,
                ‪Connection::PARAM_BOOL,
                ‪Connection::PARAM_STR,
                ‪Connection::PARAM_STR,
                ‪Connection::PARAM_INT,
                ‪Connection::PARAM_BOOL,
            ],
            $query->getParameterTypes()
        );
    }
 
    #[Test]
    public function ‪emptyInsertWithColumnSpecificationThrowsException(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage('No value specified for column bar (index 0).');
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
        $query->addValues([]);
    }
 
    #[Test]
    public function ‪insertWithColumnSpecificationAndMultipleValuesForColumnThrowsException(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage('Multiple values specified for column baz (index 1).');
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
        $query->addValues(['bar', 'baz', 'baz' => 666]);
    }
 
    #[Test]
    public function ‪insertWithColumnSpecificationAndMultipleTypesForColumnThrowsException(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage('Multiple types specified for column baz (index 1).');
 
        $query = new ‪BulkInsertQuery($this->connection, $this->testTable, ['bar', 'baz']);
        $query->addValues(
            ['bar', 'baz'],
            [‪Connection::PARAM_INT, ‪Connection::PARAM_INT, 'baz' => ‪Connection::PARAM_STR]
        );
    }
}