<?php
declare(strict_types=1);
namespace ParagonIE\EasyDB\Tests;
use ParagonIE\EasyDB\EasyDB;
use ParagonIE\EasyDB\Exception as Issues;
use ParagonIE\EasyDB\Factory;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use TypeError;
#[CoversClass(EasyDB::class)]
#[CoversClass(Factory::class)]
class EscapeIdentifierTest extends EasyDBTestCase
{
/**
* EasyDB data provider
* Returns an array of callables that return instances of EasyDB
* @return array
* @see EasyDBTestCase::goodFactoryCreateArgument2EasyDBProvider()
*/
public static function goodFactoryCreateArgument2EasyDBWithIdentifierProvider(): array
{
$provider = [
[
'foo',
[true, false],
],
[
'foo1',
[true, false],
],
[
'foo_2',
[true, false],
],
[
'foo.bar',
[true],
],
[
'foo.bar.baz',
[true],
],
[
'foo.bar.baz.why.would.an.identifier.even.be.this.long.anyway',
[true],
],
];
return array_reduce(
static::goodFactoryCreateArgument2EasyDBProvider(),
function (array $was, array $cbArgs) use ($provider) {
foreach ($provider as $args) {
foreach (array_reverse($cbArgs) as $cbArg) {
array_unshift($args, $cbArg);
}
$was[] = $args;
}
return $was;
},
[]
);
}
/**
* EasyDB data provider
* Returns an array of callables that return instances of EasyDB
* @return array
* @see EasyDBTestCase::goodFactoryCreateArgument2EasyDBProvider()
*/
public static function goodFactoryCreateArgument2EasyDBWithBadIdentifierProvider(): array
{
$identifiers = [
1,
'2foo',
'foo 3',
'foo-4',
null,
false,
[]
];
return array_reduce(
static::goodFactoryCreateArgument2EasyDBProvider(),
function (array $was, array $cbArgs) use ($identifiers) {
foreach ($identifiers as $identifier) {
$args = [$identifier];
foreach (array_reverse($cbArgs) as $cbArg) {
array_unshift($args, $cbArg);
}
$was[] = $args;
}
return $was;
},
[]
);
}
private function getExpectedEscapedIdentifier($string, $driver, $quote, bool $allowSeparators): string
{
if ($allowSeparators) {
$str = \preg_replace('/[^\.0-9a-zA-Z_]/', '', $string);
if (\strpos($str, '.') !== false) {
$pieces = \explode('.', $str);
foreach ($pieces as $i => $p) {
$pieces[$i] = $this->getExpectedEscapedIdentifier($p, $driver, $quote, false);
}
return \implode('.', $pieces);
}
} else {
$str = \preg_replace('/[^0-9a-zA-Z_]/', '', $string);
}
if ($quote) {
return match ($driver) {
'mssql' => '[' . $str . ']',
'mysql' => '`' . $str . '`',
default => '"' . $str . '"',
};
}
return $str;
}
/**
* @param callable $cb
* @param $identifier
* @param bool[] $withAllowSeparators
* @dataProvider goodFactoryCreateArgument2EasyDBWithIdentifierProvider
*/
#[DataProvider("goodFactoryCreateArgument2EasyDBWithIdentifierProvider")]
public function testEscapeIdentifier(callable $cb, $identifier, array $withAllowSeparators)
{
$db = $this->easyDBExpectedFromCallable($cb);
$db->setAllowSeparators(false); // resetting to default
foreach ($withAllowSeparators as $allowSeparators) {
$db->setAllowSeparators($allowSeparators);
$this->assertEquals(
$db->escapeIdentifier($identifier, true),
$this->getExpectedEscapedIdentifier($identifier, $db->getDriver(), true, $allowSeparators)
);
$this->assertEquals(
$db->escapeIdentifier($identifier, false),
$this->getExpectedEscapedIdentifier($identifier, $db->getDriver(), false, $allowSeparators)
);
}
$db->setAllowSeparators(false); // resetting to default
}
/**
* @dataProvider goodFactoryCreateArgument2EasyDBWithBadIdentifierProvider
* @depends testEscapeIdentifier
* @param callable $cb
* @param $identifier
*/
#[DataProvider("goodFactoryCreateArgument2EasyDBWithBadIdentifierProvider")]
public function testEscapeIdentifierThrowsSomething(callable $cb, $identifier)
{
$db = $this->easyDBExpectedFromCallable($cb);
$thrown = false;
try {
$db->escapeIdentifier($identifier);
} catch (Issues\InvalidIdentifier $e) {
$this->assertTrue(true);
$thrown = true;
} catch (TypeError $e) {
$this->assertTrue(true);
$thrown = true;
} catch (AssertionFailedError $e) {
if (preg_match(
(
'/^' .
preg_quote(
('Argument 1 passed to ' . EasyDB::class . '::escapeIdentifier()'),
'/'
) .
' must be an instance of string, [^ ]+ given$/'
),
$e->getMessage()
)) {
$this->assertTrue(true);
$thrown = true;
} else {
throw $e;
}
} finally {
if (!$thrown) {
$this->assertTrue(
false,
(
'Argument 2 of ' .
static::class .
'::' .
__METHOD__ .
'() must cause either ' .
Issues\InvalidIdentifier::class .
' or ' .
TypeError::class .
' (' .
var_export($identifier, true) .
')'
)
);
}
}
}
}
|
Download
