Skip to content

Commit

Permalink
Extract loadTableInfo() from FindReplaceController constructor
Browse files Browse the repository at this point in the history 
Refactors FindReplaceController tests.
Makes private methods private.

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
  • Loading branch information
@MauricioFauth
MauricioFauth committed Mar 9, 2024
1 parent c8654bf commit 861dd4e
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 97 deletions.
7 changes: 0 additions & 7 deletions psalm-baseline.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13035,13 +13035,6 @@
<code><![CDATA[Config::getInstance()]]></code>
</DeprecatedMethod>
</file>
<file src="tests/unit/Controllers/Table/FindReplaceControllerTest.php">
<DeprecatedMethod>
<code><![CDATA[Config::getInstance()]]></code>
<code><![CDATA[DatabaseInterface::getInstance()]]></code>
<code><![CDATA[DatabaseInterface::getInstance()]]></code>
</DeprecatedMethod>
</file>
<file src="tests/unit/Controllers/Table/ImportControllerTest.php">
<DeprecatedMethod>
<code><![CDATA[Config::getInstance()]]></code>
Expand Down
18 changes: 8 additions & 10 deletions src/Controllers/Table/FindReplaceController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,13 @@ class FindReplaceController extends AbstractController
/** @var mixed[] */
private array $columnTypes = [];

private string $connectionCharSet;

public function __construct(
ResponseRenderer $response,
Template $template,
private DatabaseInterface $dbi,
private readonly DbTableExists $dbTableExists,
) {
parent::__construct($response, $template);

$this->loadTableInfo();
$this->connectionCharSet = (string) $this->dbi->fetchValue('SELECT @@character_set_connection');
}

public function __invoke(ServerRequest $request): void
Expand Down Expand Up @@ -99,13 +94,16 @@ public function __invoke(ServerRequest $request): void
return;
}

$this->loadTableInfo();
$connectionCharSet = (string) $this->dbi->fetchValue('SELECT @@character_set_connection');

$useRegex = (bool) $request->getParsedBodyParam('useRegex');
$replaceWith = (string) $request->getParsedBodyParam('replaceWith');
$columnIndex = (int) $request->getParsedBodyParam('columnIndex');

if ($request->hasBodyParam('find')) {
$find = (string) $request->getParsedBodyParam('find');
$preview = $this->getReplacePreview($columnIndex, $find, $replaceWith, $useRegex, $this->connectionCharSet);
$preview = $this->getReplacePreview($columnIndex, $find, $replaceWith, $useRegex, $connectionCharSet);
$this->response->addJSON('preview', $preview);

return;
Expand All @@ -115,7 +113,7 @@ public function __invoke(ServerRequest $request): void

if ($request->hasBodyParam('replace')) {
$findString = (string) $request->getParsedBodyParam('findString');
$this->replace($columnIndex, $findString, $replaceWith, $useRegex, $this->connectionCharSet);
$this->replace($columnIndex, $findString, $replaceWith, $useRegex, $connectionCharSet);
$this->response->addHTML(
Generator::getMessage(
__('Your SQL query has been executed successfully.'),
Expand Down Expand Up @@ -168,7 +166,7 @@ private function loadTableInfo(): void
/**
* Display selection form action
*/
public function displaySelectionFormAction(): void
private function displaySelectionFormAction(): void
{
if (! isset($GLOBALS['goto'])) {
$GLOBALS['goto'] = Util::getScriptNameForOption(
Expand Down Expand Up @@ -203,7 +201,7 @@ public function displaySelectionFormAction(): void
*
* @return string HTML for previewing strings found and their replacements
*/
public function getReplacePreview(
private function getReplacePreview(
int $columnIndex,
string $find,
string $replaceWith,
Expand Down Expand Up @@ -303,7 +301,7 @@ private function getRegexReplaceRows(
* @param bool $useRegex to use Regex replace or not
* @param string $charSet character set of the connection
*/
public function replace(
private function replace(
int $columnIndex,
string $find,
string $replaceWith,
Expand Down
153 changes: 73 additions & 80 deletions tests/unit/Controllers/Table/FindReplaceControllerTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,110 +4,103 @@

namespace PhpMyAdmin\Tests\Controllers\Table;

use PhpMyAdmin\ColumnFull;
use PhpMyAdmin\Config;
use PhpMyAdmin\Controllers\Table\FindReplaceController;
use PhpMyAdmin\Current;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\DbTableExists;
use PhpMyAdmin\ResponseRenderer;
use PhpMyAdmin\Http\Factory\ServerRequestFactory;
use PhpMyAdmin\Template;
use PhpMyAdmin\Tests\AbstractTestCase;
use PhpMyAdmin\Types;
use PhpMyAdmin\Tests\Stubs\ResponseRenderer;
use PHPUnit\Framework\Attributes\CoversClass;

#[CoversClass(FindReplaceController::class)]
class FindReplaceControllerTest extends AbstractTestCase
final class FindReplaceControllerTest extends AbstractTestCase
{
protected function setUp(): void
{
parent::setUp();

parent::setLanguage();

parent::setGlobalConfig();

Current::$database = 'db';
Current::$table = 'table';
Config::getInstance()->selectedServer['DisableIS'] = false;

$dbi = $this->getMockBuilder(DatabaseInterface::class)
->disableOriginalConstructor()
->getMock();
$dbi->types = new Types($dbi);

$columns = [
new ColumnFull('Field1', 'Type1', 'Collation1', false, '', null, '', '', ''),
new ColumnFull('Field2', 'Type2', 'Collation2', false, '', null, '', '', ''),
];
$dbi->expects(self::any())->method('getColumns')
->willReturn($columns);

$showCreateTable = "CREATE TABLE `table` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`dbase` varchar(255) COLLATE utf8_bin NOT NULL DEFAULT '',
`user` varchar(255) COLLATE utf8_bin NOT NULL DEFAULT '',
`label` varchar(255) CHARACTER SET utf8 NOT NULL DEFAULT '',
`query` text COLLATE utf8_bin NOT NULL,
PRIMARY KEY (`id`),
KEY `foreign_field` (`foreign_db`,`foreign_table`)
) ENGINE=MyISAM AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COLLATE=utf8_bin "
. "COMMENT='table'";

$dbi->expects(self::any())->method('fetchValue')
->willReturn($showCreateTable);
$dbi->expects(self::any())->method('quoteString')
->willReturnCallback(static fn (string $string): string => "'" . $string . "'");

DatabaseInterface::$instance = $dbi;
}

public function testReplace(): void
{
$dbi = DatabaseInterface::getInstance();
$tableSearch = new FindReplaceController(
ResponseRenderer::getInstance(),
Current::$database = 'test_db';
Current::$table = 'test_table';

$dbiDummy = $this->createDbiDummy();
$dbiDummy->addSelectDb('test_db');
$dbiDummy->addResult('SELECT 1 FROM `test_db`.`test_table` LIMIT 1;', [['1']]);
$dbiDummy->addResult('SELECT @@character_set_connection', [['utf8mb4']]);
// phpcs:ignore Generic.Files.LineLength.TooLong
$dbiDummy->addResult('UPDATE `test_table` SET `id` = REPLACE(`id`, \'Field\', \'Column\') WHERE `id` LIKE \'%Field%\' COLLATE utf8mb4_bin', true);
$dbi = $this->createDatabaseInterface($dbiDummy);

$responseRenderer = new ResponseRenderer();
$controller = new FindReplaceController(
$responseRenderer,
new Template(),
$dbi,
new DbTableExists($dbi),
);
$columnIndex = 0;
$find = 'Field';
$replaceWith = 'Column';
$useRegex = false;
$charSet = 'UTF-8';
$tableSearch->replace($columnIndex, $find, $replaceWith, $useRegex, $charSet);

$sqlQuery = $GLOBALS['sql_query'];
$result = 'UPDATE `table` SET `Field1` = '
. "REPLACE(`Field1`, 'Field', 'Column') "
. "WHERE `Field1` LIKE '%Field%' COLLATE UTF-8_bin";
self::assertSame($result, $sqlQuery);
$request = ServerRequestFactory::create()->createServerRequest('GET', 'http://example.com/')
->withParsedBody([
'db' => 'test_db',
'table' => 'test_table',
'replace' => '1',
'replaceWith' => 'Column',
'columnIndex' => '0',
'findString' => 'Field',
]);

$controller($request);

self::assertStringContainsString(
'<pre>' . "\n"
. 'UPDATE `test_table` SET `id` = REPLACE(`id`, \'Field\', \'Column\')'
. ' WHERE `id` LIKE \'%Field%\' COLLATE utf8mb4_bin'
. "\n" . '</pre>',
$responseRenderer->getHTMLResult(),
);
self::assertSame([], $responseRenderer->getJSONResult());
}

public function testReplaceWithRegex(): void
{
$dbi = DatabaseInterface::getInstance();
$tableSearch = new FindReplaceController(
ResponseRenderer::getInstance(),
Current::$database = 'test_db';
Current::$table = 'test_table';

$dbiDummy = $this->createDbiDummy();
$dbiDummy->addSelectDb('test_db');
$dbiDummy->addResult('SELECT 1 FROM `test_db`.`test_table` LIMIT 1;', [['1']]);
$dbiDummy->addResult('SELECT @@character_set_connection', [['utf8mb4']]);
// phpcs:ignore Generic.Files.LineLength.TooLong
$dbiDummy->addResult('SELECT `id`, 1, COUNT(*) FROM `test_db`.`test_table` WHERE `id` RLIKE \'Field\' COLLATE utf8mb4_bin GROUP BY `id` ORDER BY `id` ASC', []);
// phpcs:ignore Generic.Files.LineLength.TooLong
$dbiDummy->addResult('UPDATE `test_table` SET `id` = `id` WHERE `id` RLIKE \'Field\' COLLATE utf8mb4_bin', true);
$dbi = $this->createDatabaseInterface($dbiDummy);

$responseRenderer = new ResponseRenderer();
$controller = new FindReplaceController(
$responseRenderer,
new Template(),
$dbi,
new DbTableExists($dbi),
);

$columnIndex = 0;
$find = 'Field';
$replaceWith = 'Column';
$useRegex = true;
$charSet = 'UTF-8';

$tableSearch->replace($columnIndex, $find, $replaceWith, $useRegex, $charSet);

$sqlQuery = $GLOBALS['sql_query'];

$result = 'UPDATE `table` SET `Field1` = `Field1`'
. " WHERE `Field1` RLIKE 'Field' COLLATE UTF-8_bin";

self::assertSame($result, $sqlQuery);
$request = ServerRequestFactory::create()->createServerRequest('GET', 'http://example.com/')
->withParsedBody([
'db' => 'test_db',
'table' => 'test_table',
'replace' => '1',
'useRegex' => 'On',
'replaceWith' => 'Column',
'columnIndex' => '0',
'findString' => 'Field',
]);

$controller($request);

self::assertStringContainsString(
'<pre>' . "\n"
. 'UPDATE `test_table` SET `id` = `id` WHERE `id` RLIKE \'Field\' COLLATE utf8mb4_bin'
. "\n" . '</pre>',
$responseRenderer->getHTMLResult(),
);
self::assertSame([], $responseRenderer->getJSONResult());
}
}

0 comments on commit 861dd4e

Please sign in to comment.