MySQLPDOConnectorTest::getUpdatedUtfCharset() - Code Metrics - Inspection of "MNT Update utf8 aliases for mysql 8 and mariadb 10..." - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — 4.11 (#10334)

by Steve
created 2022-05-25 04:23 UTC
MySQLPDOConnectorTest::getUpdatedUtfCharset() A

↳ Parent: MySQLPDOConnectorTest
Complexity

Conditions	4
Paths	5
Size

Total Lines	6
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	4
eloc	3
c	1
b	0
f	0
nc	5
nop	1
dl	0
loc	6
rs	10
<?php

namespace SilverStripe\ORM\Tests;

use PDO;
use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\Connect\MySQLDatabase;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Dev\TestOnly;
use SilverStripe\ORM\Tests\MySQLPDOConnectorTest\PDOConnector;
use SilverStripe\ORM\DB;

/**
 * @requires extension PDO
 * @requires extension pdo_mysql
 */
class MySQLPDOConnectorTest extends SapphireTest implements TestOnly
{
    /**
     * @dataProvider charsetProvider
     */
    public function testConnectionCharsetControl($charset, $defaultCollation)
    {
        $config = DB::getConfig();
        $config['driver'] = 'mysql';
        $config['charset'] = $charset;
        $config['database'] = 'information_schema';
        Config::inst()->set(MySQLDatabase::class, 'connection_collation', $defaultCollation);
        Config::inst()->/** @scrutinizer ignore-call */ set(MySQLDatabase::class, 'connection_collation', $defaultCollation);

        if (strtolower(substr($config['type'] ?? '', 0, 5)) !== 'mysql') {
            return $this->markTestSkipped('The test only relevant for MySQL');
        }

        $connector = new PDOConnector();
        $connector->connect($config);
        $connection = $connector->getPDOConnection();

        $cset = $connection->query('show variables like "character_set_connection"')->fetch(PDO::FETCH_NUM)[1];
        $collation = $connection->query('show variables like "collation_connection"')->fetch(PDO::FETCH_NUM)[1];

        $this->assertEquals($this->getUpdatedUtfCharset($charset), $cset);
        $this->assertEquals($this->getUpdatedUtfCollation($defaultCollation), $collation);

        unset($cset, $connection, $connector, $config);
    }

    /**
     * @dataProvider charsetProvider
     */
    public function testConnectionCollationControl($charset, $defaultCollation, $customCollation)
    {
        $config = DB::getConfig();
        $config['charset'] = $charset;
        $config['driver'] = 'mysql';
        $config['database'] = 'information_schema';
        Config::inst()->set(MySQLDatabase::class, 'connection_collation', $customCollation);

        if (strtolower(substr($config['type'] ?? '', 0, 5)) !== 'mysql') {
            return $this->markTestSkipped('The test only relevant for MySQL');
        }

        $connector = new PDOConnector();
        $connector->connect($config);
        $connection = $connector->getPDOConnection();

        $cset = $connection->query('show variables like "character_set_connection"')->fetch(PDO::FETCH_NUM)[1];
        $collation = $connection->query('show variables like "collation_connection"')->fetch(PDO::FETCH_NUM)[1];

        $this->assertEquals($this->getUpdatedUtfCharset($charset), $cset);
        $this->assertEquals($this->getUpdatedUtfCollation($customCollation), $collation);

        unset($cset, $connection, $connector, $config);
    }

    public function charsetProvider()
    {
        return [
            ['ascii', 'ascii_general_ci', 'ascii_bin'],
            ['utf8', 'utf8_general_ci', 'utf8_unicode_520_ci'],
            ['utf8mb4', 'utf8mb4_general_ci', 'utf8mb4_unicode_520_ci']
        ];
    }

    public function testUtf8mb4GeneralCollation()
    {
        $charset = 'utf8mb4';
        $collation = 'utf8mb4_general_ci';

        $config = DB::getConfig();
        $config['charset'] = $charset;
        $config['driver'] = 'mysql';
        $config['database'] = 'information_schema';
        Config::inst()->set(MySQLDatabase::class, 'connection_collation', $collation);

        if (strtolower(substr($config['type'] ?? '', 0, 5)) !== 'mysql') {
            return $this->markTestSkipped('The test only relevant for MySQL');
        }

        $connector = new PDOConnector();
        $connector->connect($config);
        $connection = $connector->getPDOConnection();

        $result = $connection->query(
            "select `a`.`value` from (select 'rst' `value` union select 'rßt' `value`) `a` order by `value`"
        )->fetchAll();

        $this->assertCount(1, $result, '`utf8mb4_general_ci` handles both values as equal to "rst"');
        $this->assertEquals('rst', $result[0][0]);
    }

    public function testUtf8mb4UnicodeCollation()
    {
        $charset = 'utf8mb4';
        $collation = 'utf8mb4_unicode_ci';

        $config = DB::getConfig();
        $config['charset'] = $charset;
        $config['driver'] = 'mysql';
        $config['database'] = 'information_schema';
        Config::inst()->set(MySQLDatabase::class, 'connection_collation', $collation);

        if (strtolower(substr($config['type'] ?? '', 0, 5)) !== 'mysql') {
            return $this->markTestSkipped('The test only relevant for MySQL');
        }

        $connector = new PDOConnector();
        $connector->connect($config);
        $connection = $connector->getPDOConnection();

        $result = $connection->query(
            "select `a`.`value` from (select 'rst' `value` union select 'rßt' `value`) `a` order by `value`"
        )->fetchAll();

        $this->assertCount(2, $result, '`utf8mb4_unicode_ci` must recognise "rst" and "rßt" as different values');
        $this->assertEquals('rßt', $result[0][0]);
        $this->assertEquals('rst', $result[1][0]);
    }

    private function getUpdatedUtfCharset(string $charset): string
    {
        if ($charset !== 'utf8') {
            return $charset;
        }
        return $this->isMySqlgte80() || $this->isMariaDBgte106() ? 'utf8mb3' : 'utf8';
    }

    private function getUpdatedUtfCollation(string $collation): string
    {
        if ($collation === 'utf8_general_ci') {
            return $this->isMariaDBgte106() ? 'utf8mb3_general_ci' : 'utf8_general_ci';
        }
        if ($collation === 'utf8_unicode_520_ci') {
            return $this->isMariaDBgte106() ? 'utf8mb3_unicode_520_ci' : 'utf8_unicode_520_ci';
        }
        return $collation;
    }

    /**
     * MySQL has used utf8 as an alias for utf8mb3
     * Beginning with MySQL 8.0.28, utf8mb3 is used
     * https://dev.mysql.com/doc/refman/8.0/en/charset-unicode-utf8mb3.html
     */
    private function isMySqlgte80()
    {
        if (preg_match('#^([0-9]+)\.[0-9]+\.[0-9]+$#', $this->getDBVersion(), $m)) {
            return (int) $m[1] >= 8;
        }
        return false;
    }

    /**
     * Until MariaDB 10.5, utf8mb3 was an alias for utf8.
     * From MariaDB 10.6, utf8 is by default an alias for utf8mb3
     * https://mariadb.com/kb/en/unicode/
     */
    private function isMariaDBgte106()
    {
        if (preg_match('#^([0-9]+)\.([0-9]+)\.[0-9]+-mariadb#', $this->getDBVersion(), $m)) {
            return (int) $m[1] >= 11 || ((int) $m[1] >= 10 && (int) $m[2] >= 6);
        }
        return false;
    }

    private $dbVersion = '';

    private function getDBVersion()
    {
        if ($this->dbVersion === '') {
            $this->dbVersion = DB::query('SELECT VERSION();')->first()['VERSION()'];
            $this->dbVersion = strtolower($this->dbVersion);
        }
        return $this->dbVersion;
    }
}

silverstripe / silverstripe-framework

Pull Request — 4.11 (#10334)

MySQLPDOConnectorTest::getUpdatedUtfCharset() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
