getMockBuilder('PhpMyAdmin\SqlParser\Utils\Formatter')
->disableOriginalConstructor()
->setMethods(['getDefaultOptions', 'getDefaultFormats'])
->getMock();
$formatter->expects($this->once())
->method('getDefaultOptions')
->willReturn([
'type' => 'text',
'line_ending' => null,
'indentation' => null,
'clause_newline' => null,
'parts_newline' => null,
]);
$formatter->expects($this->once())
->method('getDefaultFormats')
->willReturn($default);
$expectedOptions = [
'type' => 'test-type',
'line_ending' => '
',
'indentation' => ' ',
'clause_newline' => null,
'parts_newline' => 0,
'formats' => $expected,
];
$overridingOptions = [
'type' => 'test-type',
'line_ending' => '
',
'formats' => $overriding,
];
$reflectionMethod = new ReflectionMethod($formatter, 'getMergedOptions');
$reflectionMethod->setAccessible(true);
$this->assertEquals($expectedOptions, $reflectionMethod->invoke($formatter, $overridingOptions));
}
public function mergeFormats()
{
// [default[], overriding[], expected[]]
return [
'empty formats' => [
'default' => [
[
'type' => 0,
'flags' => 0,
'html' => '',
'cli' => '',
'function' => '',
],
],
'overriding' => [
[],
],
'expected' => [
[
'type' => 0,
'flags' => 0,
'html' => '',
'cli' => '',
'function' => '',
],
],
],
'no flags' => [
'default' => [
[
'type' => 0,
'flags' => 0,
'html' => 'html',
'cli' => 'cli',
],
[
'type' => 0,
'flags' => 1,
'html' => 'html',
'cli' => 'cli',
],
],
'overriding' => [
[
'type' => 0,
'html' => 'new html',
'cli' => 'new cli',
],
],
'expected' => [
[
'type' => 0,
'flags' => 0,
'html' => 'new html',
'cli' => 'new cli',
'function' => '',
],
[
'type' => 0,
'flags' => 1,
'html' => 'html',
'cli' => 'cli',
],
],
],
'with flags' => [
'default' => [
[
'type' => -1,
'flags' => 0,
'html' => 'html',
'cli' => 'cli',
],
[
'type' => 0,
'flags' => 0,
'html' => 'html',
'cli' => 'cli',
],
[
'type' => 0,
'flags' => 1,
'html' => 'html',
'cli' => 'cli',
],
],
'overriding' => [
[
'type' => 0,
'flags' => 0,
'html' => 'new html',
'cli' => 'new cli',
],
],
'expected' => [
[
'type' => -1,
'flags' => 0,
'html' => 'html',
'cli' => 'cli',
],
[
'type' => 0,
'flags' => 0,
'html' => 'new html',
'cli' => 'new cli',
'function' => '',
],
[
'type' => 0,
'flags' => 1,
'html' => 'html',
'cli' => 'cli',
],
],
],
'with extra formats' => [
'default' => [
[
'type' => 0,
'flags' => 0,
'html' => 'html',
'cli' => 'cli',
],
],
'overriding' => [
[
'type' => 0,
'flags' => 1,
'html' => 'new html',
'cli' => 'new cli',
],
[
'type' => 1,
'html' => 'new html',
'cli' => 'new cli',
],
[
'type' => 1,
'flags' => 1,
'html' => 'new html',
'cli' => 'new cli',
],
],
'expected' => [
[
'type' => 0,
'flags' => 0,
'html' => 'html',
'cli' => 'cli',
],
[
'type' => 0,
'flags' => 1,
'html' => 'new html',
'cli' => 'new cli',
'function' => '',
],
[
'type' => 1,
'flags' => 0,
'html' => 'new html',
'cli' => 'new cli',
'function' => '',
],
[
'type' => 1,
'flags' => 1,
'html' => 'new html',
'cli' => 'new cli',
'function' => '',
],
],
],
];
}
/**
* @param mixed $query
* @param mixed $text
* @param mixed $cli
* @param mixed $html
*
* @dataProvider formatQueries
*/
public function testFormat($query, $text, $cli, $html, array $options = [])
{
// Test TEXT format
$this->assertEquals($text, Formatter::format($query, ['type' => 'text'] + $options), 'Text formatting failed.');
// Test CLI format
$this->assertEquals($cli, Formatter::format($query, ['type' => 'cli'] + $options), 'CLI formatting failed.');
// Test HTML format
$this->assertEquals($html, Formatter::format($query, ['type' => 'html'] + $options), 'HTML formatting failed.');
}
public function formatQueries()
{
return [
'empty' => [
'query' => '',
'text' => '',
'cli' => "\x1b[0m",
'html' => '',
],
'minimal' => [
'query' => 'select 1',
'text' => 'SELECT' . "\n" .
' 1',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[92m1\x1b[0m",
'html' => 'SELECT
' .
' 1',
],
'simply' => [
'query' => 'select * from tbl where 1',
'text' => 'SELECT' . "\n" .
' *' . "\n" .
'FROM' . "\n" .
' tbl' . "\n" .
'WHERE' . "\n" .
' 1',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[39m*\n" .
"\x1b[35mFROM\n" .
" \x1b[39mtbl\n" .
"\x1b[35mWHERE\n" .
" \x1b[92m1\x1b[0m",
'html' => 'SELECT
' .
' *
' .
'FROM
' .
' tbl
' .
'WHERE
' .
' 1',
],
'typical' => [
'query' => 'SELECT id, if(id=1,"Si","No") from `tbl` where id = 0 or id = 1 group by id order by id desc limit 1 offset 0',
'text' => 'SELECT' . "\n" .
' id,' . "\n" .
' IF(id = 1, "Si", "No")' . "\n" .
'FROM' . "\n" .
' `tbl`' . "\n" .
'WHERE' . "\n" .
' id = 0 OR id = 1' . "\n" .
'GROUP BY' . "\n" .
' id' . "\n" .
'ORDER BY' . "\n" .
' id' . "\n" .
'DESC' . "\n" .
'LIMIT 1 OFFSET 0',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[39mid,\n" .
" \x1b[35mIF\x1b[39m(id = \x1b[92m1\x1b[39m, \x1b[91m\"Si\"\x1b[39m, \x1b[91m\"No\"\x1b[39m)\n" .
"\x1b[35mFROM\n" .
" \x1b[36m`tbl`\n" .
"\x1b[35mWHERE\n" .
" \x1b[39mid = \x1b[92m0 \x1b[35mOR \x1b[39mid = \x1b[92m1\n" .
"\x1b[35mGROUP BY\n" .
" \x1b[39mid\n" .
"\x1b[35mORDER BY\n" .
" \x1b[39mid\n" .
"\x1b[35mDESC\n" .
"LIMIT \x1b[92m1 \x1b[95mOFFSET \x1b[92m0\x1b[0m",
'html' => 'SELECT
' .
' id,
' .
' IF(id = 1, "Si", "No")
' .
'FROM
' .
' `tbl`
' .
'WHERE
' .
' id = 0 OR id = 1
' .
'GROUP BY
' .
' id
' .
'ORDER BY
' .
' id
' .
'DESC
' .
'LIMIT 1 OFFSET 0',
],
'comments' => [
'query' => 'select /* Comment */ *' . "\n" .
'from tbl # Comment' . "\n" .
'where 1 -- Comment',
'text' => 'SELECT' . "\n" .
' /* Comment */ *' . "\n" .
'FROM' . "\n" .
' tbl # Comment' . "\n" .
'WHERE' . "\n" .
' 1 -- Comment',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[37m/* Comment */ \x1b[39m*\n" .
"\x1b[35mFROM\n" .
" \x1b[39mtbl \x1b[37m# Comment\n" .
"\x1b[35mWHERE\n" .
" \x1b[92m1 \x1b[37m-- Comment\x1b[0m",
'html' => 'SELECT
' .
' *
' .
'FROM
' .
' tbl
' .
'WHERE
' .
' 1 ',
],
'strip comments' => [
'query' => 'select /* Comment */ *' . "\n" .
'from tbl # Comment' . "\n" .
'where 1 -- Comment',
'text' => 'SELECT' . "\n" .
' *' . "\n" .
'FROM' . "\n" .
' tbl' . "\n" .
'WHERE' . "\n" .
' 1',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[39m*\n" .
"\x1b[35mFROM\n" .
" \x1b[39mtbl\n" .
"\x1b[35mWHERE\n" .
" \x1b[92m1\x1b[0m",
'html' => 'SELECT
' .
' *
' .
'FROM
' .
' tbl
' .
'WHERE
' .
' 1',
'options' => [
'remove_comments' => true,
],
],
'keywords' => [
'query' => 'select hex("1")',
'text' => 'SELECT' . "\n" .
' HEX("1")',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[95mHEX\x1b[39m(\x1b[91m\"1\"\x1b[39m)\x1b[0m",
'html' => 'SELECT
' .
' HEX("1")',
],
'distinct count' => [
'query' => 'select distinct count(*)',
'text' => 'SELECT DISTINCT' . "\n" .
' COUNT(*)',
'cli' => "\x1b[35mSELECT DISTINCT\n" .
" \x1b[95mCOUNT\x1b[39m(*)\x1b[0m",
'html' => 'SELECT DISTINCT
' .
' COUNT(*)',
],
'create procedure' => [
'query' => 'create procedure test_procedure() begin from tbl select *; end',
'text' => 'CREATE PROCEDURE test_procedure()' . "\n" .
'BEGIN' . "\n" .
' FROM' . "\n" .
' tbl' . "\n" .
' SELECT' . "\n" .
' *;' . "\n" .
'END',
'cli' => "\x1b[35mCREATE PROCEDURE \x1b[39mtest_procedure()\n" .
"\x1b[95mBEGIN\n" .
" \x1b[35mFROM\n" .
" \x1b[39mtbl\n" .
" \x1b[35mSELECT\n" .
" \x1b[39m*;\n" .
"\x1b[95mEND\x1b[0m",
'html' => 'CREATE PROCEDURE test_procedure()
' .
'BEGIN
' .
' FROM
' .
' tbl
' .
' SELECT
' .
' *;
' .
'END',
],
'insert' => [
'query' => 'insert into foo values (0, 0, 0), (1, 1, 1)',
'text' => 'INSERT INTO foo' . "\n" .
'VALUES(0, 0, 0),(1, 1, 1)',
'cli' => "\x1b[35mINSERT INTO \x1b[39mfoo\n" .
"\x1b[35mVALUES\x1b[39m(\x1b[92m0\x1b[39m, \x1b[92m0\x1b[39m, \x1b[92m0\x1b[39m),(\x1b[92m1\x1b[39m, \x1b[92m1\x1b[39m, \x1b[92m1\x1b[39m)\x1b[0m",
'html' => 'INSERT INTO foo
' .
'VALUES(0, 0, 0),(1, 1, 1)',
],
'string as alias' => [
'query' => 'select "Text" as bar',
'text' => 'SELECT' . "\n" .
' "Text" AS bar',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[91m\"Text\" \x1b[35mAS \x1b[39mbar\x1b[0m",
'html' => 'SELECT
' .
' "Text" AS bar',
],
'escape cli' => [
'query' => "select 'text\x1b[33mcolor-inj'",
'text' => 'SELECT' . "\n" .
" 'text\x1B[33mcolor-inj'",
'cli' => "\x1b[35mSELECT\n" .
" \x1b[91m'text\\x1B[33mcolor-inj'\x1b[0m",
'html' => 'SELECT
' .
' \'text' . "\x1b[33m" . 'color-inj\'',
],
'escape html' => [
'query' => "select 'xss' from `xss` , nxss /*sxss*/",
'text' => 'SELECT' . "\n" .
' \'xss\'' . "\n" .
'FROM' . "\n" .
' `xss`,' . "\n" .
' < s > nxss /*sxss*/',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[91m'xss'\n" .
"\x1b[35mFROM\n" .
" \x1b[36m`xss`\x1b[39m,\n" .
" < s > nxss \x1b[37m/*sxss*/\x1b[0m",
'html' => 'SELECT
' .
' \'<s>xss\'
' .
'FROM
' .
' `<s>xss`,
< s > nxss ',
],
'create table' => [
'query' => 'create table if not exists `pma__bookmark` (' . "\n" .
'`id` int(11) not null auto_increment,' . "\n" .
'`dbase` varchar(255) not null default "",' . "\n" .
'`user` varchar(255) not null default "",' . "\n" .
'`label` varchar(255) collate utf8_general_ci not null default "",' . "\n" .
'`query` text not null,' . "\n" .
'primary key (`id`)',
'text' => 'CREATE TABLE IF NOT EXISTS `pma__bookmark`(' . "\n" .
' `id` INT(11) NOT NULL AUTO_INCREMENT,' . "\n" .
' `dbase` VARCHAR(255) NOT NULL DEFAULT "",' . "\n" .
' `user` VARCHAR(255) NOT NULL DEFAULT "",' . "\n" .
' `label` VARCHAR(255) COLLATE utf8_general_ci NOT NULL DEFAULT "",' . "\n" .
' `query` TEXT NOT NULL,' . "\n" .
' PRIMARY KEY(`id`)',
'cli' => "\x1b[35mCREATE TABLE IF NOT EXISTS \x1b[36m`pma__bookmark`\x1b[39m(\n" .
" \x1b[36m`id` \x1b[35mINT\x1b[39m(\x1b[92m11\x1b[39m) \x1b[35mNOT NULL \x1b[95mAUTO_INCREMENT\x1b[39m,\n" .
" \x1b[36m`dbase` \x1b[35mVARCHAR\x1b[39m(\x1b[92m255\x1b[39m) \x1b[35mNOT NULL DEFAULT \x1b[91m\"\"\x1b[39m,\n" .
" \x1b[36m`user` \x1b[35mVARCHAR\x1b[39m(\x1b[92m255\x1b[39m) \x1b[35mNOT NULL DEFAULT \x1b[91m\"\"\x1b[39m,\n" .
" \x1b[36m`label` \x1b[35mVARCHAR\x1b[39m(\x1b[92m255\x1b[39m) \x1b[35mCOLLATE \x1b[39mutf8_general_ci \x1b[35mNOT NULL DEFAULT \x1b[91m\"\"\x1b[39m,\n" .
" \x1b[36m`query` \x1b[95mTEXT \x1b[35mNOT NULL\x1b[39m,\n" .
" \x1b[35mPRIMARY KEY\x1b[39m(\x1b[36m`id`\x1b[39m)\x1b[0m",
'html' => 'CREATE TABLE IF NOT EXISTS `pma__bookmark`(
' .
' `id` INT(11) NOT NULL AUTO_INCREMENT,
' .
' `dbase` VARCHAR(255) NOT NULL DEFAULT "",
' .
' `user` VARCHAR(255) NOT NULL DEFAULT "",
' .
' `label` VARCHAR(255) COLLATE utf8_general_ci NOT NULL DEFAULT "",
' .
' `query` TEXT NOT NULL,
' .
' PRIMARY KEY(`id`)',
],
'join' => [
'query' => 'join tbl2 on c1=c2',
'text' => 'JOIN tbl2 ON c1 = c2',
'cli' => "\x1b[35mJOIN \x1b[39mtbl2 \x1b[35mON \x1b[39mc1 = c2" .
"\x1b[0m",
'html' => 'JOIN tbl2 ON c1 = c2',
],
'named param' => [
'query' => 'select * from tbl where col = :param',
'text' => 'SELECT' . "\n" .
' *' . "\n" .
'FROM' . "\n" .
' tbl' . "\n" .
'WHERE' . "\n" .
' col = :param',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[39m*\n" .
"\x1b[35mFROM\n" .
" \x1b[39mtbl\n" .
"\x1b[35mWHERE\n" .
" \x1b[39mcol = \x1b[31m:param\x1b[0m",
'html' => 'SELECT
' .
' *
' .
'FROM
' .
' tbl
' .
'WHERE
' .
' col = :param',
],
'anon param' => [
'query' => 'select * from tbl where col = ?',
'text' => 'SELECT' . "\n" .
' *' . "\n" .
'FROM' . "\n" .
' tbl' . "\n" .
'WHERE' . "\n" .
' col = ?',
'cli' => "\x1b[35mSELECT\n" .
" \x1b[39m*\n" .
"\x1b[35mFROM\n" .
" \x1b[39mtbl\n" .
"\x1b[35mWHERE\n" .
" \x1b[39mcol = \x1b[31m?\x1b[0m",
'html' => 'SELECT
' .
' *
' .
'FROM
' .
' tbl
' .
'WHERE
' .
' col = ?',
],
];
}
}