Skip to content

Commit de656cb

Browse files
MauricioFauthMauricioFauth
authored
Merge pull request #20191 from MauricioFauth/controllers-tests
Add unit tests for some controller classes
2 parents 211de12 + 985455a commit de656cb

19 files changed

Lines changed: 4891 additions & 51 deletions

‎psalm-baseline.xml‎

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -691,16 +691,6 @@
691691
<code><![CDATA[Response]]></code>
692692
</PossiblyUnusedReturnValue>
693693
</file>
694-
<file src="src/Controllers/Database/CentralColumns/PopulateColumnsController.php">
695-
<PossiblyUnusedMethod>
696-
<code><![CDATA[__construct]]></code>
697-
</PossiblyUnusedMethod>
698-
</file>
699-
<file src="src/Controllers/Database/CentralColumnsController.php">
700-
<PossiblyUnusedMethod>
701-
<code><![CDATA[__construct]]></code>
702-
</PossiblyUnusedMethod>
703-
</file>
704694
<file src="src/Controllers/Database/DataDictionaryController.php">
705695
<MixedArgument>
706696
<code><![CDATA[Current::$database]]></code>
@@ -715,9 +705,6 @@
715705
<PossiblyNullArrayOffset>
716706
<code><![CDATA[$pkArray]]></code>
717707
</PossiblyNullArrayOffset>
718-
<PossiblyUnusedMethod>
719-
<code><![CDATA[__construct]]></code>
720-
</PossiblyUnusedMethod>
721708
</file>
722709
<file src="src/Controllers/Database/DesignerController.php">
723710
<MixedArgument>
@@ -786,9 +773,6 @@
786773
<code><![CDATA[$tableSelect]]></code>
787774
<code><![CDATA[$tableStructure]]></code>
788775
</MixedAssignment>
789-
<PossiblyUnusedMethod>
790-
<code><![CDATA[__construct]]></code>
791-
</PossiblyUnusedMethod>
792776
</file>
793777
<file src="src/Controllers/Database/ImportController.php">
794778
<MixedArrayAccess>
@@ -801,25 +785,12 @@
801785
<MixedMethodCall>
802786
<code><![CDATA[$_SESSION[Ajax::SESSION_KEY]['handler']::getIdKey()]]></code>
803787
</MixedMethodCall>
804-
<PossiblyUnusedMethod>
805-
<code><![CDATA[__construct]]></code>
806-
</PossiblyUnusedMethod>
807-
</file>
808-
<file src="src/Controllers/Database/MultiTableQuery/QueryController.php">
809-
<PossiblyUnusedMethod>
810-
<code><![CDATA[__construct]]></code>
811-
</PossiblyUnusedMethod>
812788
</file>
813789
<file src="src/Controllers/Database/MultiTableQuery/TablesController.php">
814790
<PossiblyUnusedReturnValue>
815791
<code><![CDATA[Response]]></code>
816792
</PossiblyUnusedReturnValue>
817793
</file>
818-
<file src="src/Controllers/Database/MultiTableQueryController.php">
819-
<PossiblyUnusedMethod>
820-
<code><![CDATA[__construct]]></code>
821-
</PossiblyUnusedMethod>
822-
</file>
823794
<file src="src/Controllers/Database/PrivilegesController.php">
824795
<PossiblyUnusedReturnValue>
825796
<code><![CDATA[Response]]></code>

‎src/Controllers/Database/CentralColumns/PopulateColumnsController.php‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,10 @@
1313
use PhpMyAdmin\Routing\Route;
1414

1515
#[Route('/database/central-columns/populate', ['POST'])]
16-
final class PopulateColumnsController implements InvocableController
16+
final readonly class PopulateColumnsController implements InvocableController
1717
{
18-
public function __construct(
19-
private readonly ResponseRenderer $response,
20-
private readonly CentralColumns $centralColumns,
21-
) {
18+
public function __construct(private ResponseRenderer $response, private CentralColumns $centralColumns)
19+
{
2220
}
2321

2422
public function __invoke(ServerRequest $request): Response

‎src/Controllers/Database/DataDictionaryController.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@
2020
use function str_replace;
2121

2222
#[Route('/database/data-dictionary', ['GET'])]
23-
final class DataDictionaryController implements InvocableController
23+
final readonly class DataDictionaryController implements InvocableController
2424
{
2525
public function __construct(
26-
private readonly ResponseRenderer $response,
27-
private readonly Relation $relation,
28-
private readonly Transformations $transformations,
29-
private readonly DatabaseInterface $dbi,
26+
private ResponseRenderer $response,
27+
private Relation $relation,
28+
private Transformations $transformations,
29+
private DatabaseInterface $dbi,
3030
) {
3131
}
3232

‎src/Controllers/Database/ExportController.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@
2727
use function is_array;
2828

2929
#[Route('/database/export', ['GET', 'POST'])]
30-
final class ExportController implements InvocableController
30+
final readonly class ExportController implements InvocableController
3131
{
3232
public function __construct(
33-
private readonly ResponseRenderer $response,
34-
private readonly Export $export,
35-
private readonly Options $exportOptions,
36-
private readonly PageSettings $pageSettings,
37-
private readonly DbTableExists $dbTableExists,
33+
private ResponseRenderer $response,
34+
private Export $export,
35+
private Options $exportOptions,
36+
private PageSettings $pageSettings,
37+
private DbTableExists $dbTableExists,
3838
) {
3939
}
4040

‎src/Controllers/Database/MultiTableQuery/QueryController.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
use PhpMyAdmin\Url;
1616

1717
#[Route('/database/multi-table-query/query', ['POST'])]
18-
final class QueryController implements InvocableController
18+
final readonly class QueryController implements InvocableController
1919
{
20-
public function __construct(private readonly ResponseRenderer $response, private readonly Sql $sql)
20+
public function __construct(private ResponseRenderer $response, private Sql $sql)
2121
{
2222
}
2323

‎src/Controllers/Database/MultiTableQueryController.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818
* Handles database multi-table querying
1919
*/
2020
#[Route('/database/multi-table-query', ['GET'])]
21-
final class MultiTableQueryController implements InvocableController
21+
final readonly class MultiTableQueryController implements InvocableController
2222
{
2323
public function __construct(
24-
private readonly ResponseRenderer $response,
25-
private readonly Template $template,
26-
private readonly DatabaseInterface $dbi,
24+
private ResponseRenderer $response,
25+
private Template $template,
26+
private DatabaseInterface $dbi,
2727
) {
2828
}
2929

‎tests/unit/Controllers/Database/CentralColumns/PopulateColumnsControllerTest.php‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace PhpMyAdmin\Tests\Controllers\Database\CentralColumns;
6+
7+
use Fig\Http\Message\StatusCodeInterface;
8+
use PhpMyAdmin\Controllers\Database\CentralColumns\PopulateColumnsController;
9+
use PhpMyAdmin\Current;
10+
use PhpMyAdmin\Database\CentralColumns;
11+
use PhpMyAdmin\Http\Factory\ServerRequestFactory;
12+
use PhpMyAdmin\Tests\AbstractTestCase;
13+
use PhpMyAdmin\Tests\Stubs\ResponseRenderer;
14+
use PHPUnit\Framework\Attributes\CoversClass;
15+
16+
#[CoversClass(PopulateColumnsController::class)]
17+
final class PopulateColumnsControllerTest extends AbstractTestCase
18+
{
19+
public function testPopulateColumns(): void
20+
{
21+
$dbi = $this->createDatabaseInterface();
22+
23+
Current::$database = 'test_db';
24+
$request = ServerRequestFactory::create()->createServerRequest('POST', 'https://example.com/')
25+
->withQueryParams(['route' => '/database/central-columns/populate'])
26+
->withParsedBody(['db' => 'test_db', 'selectedTable' => 'test_table']);
27+
28+
$response = (new PopulateColumnsController(new ResponseRenderer(), new CentralColumns($dbi)))($request);
29+
30+
self::assertSame(StatusCodeInterface::STATUS_OK, $response->getStatusCode());
31+
self::assertSame(
32+
<<<'HTML'
33+
<option value="id">id</option>
34+
<option value="name">name</option>
35+
<option value="datetimefield">datetimefield</option>
36+
37+
HTML,
38+
(string) $response->getBody(),
39+
);
40+
}
41+
}

‎tests/unit/Controllers/Database/CentralColumnsControllerTest.php‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace PhpMyAdmin\Tests\Controllers\Database;
6+
7+
use Fig\Http\Message\StatusCodeInterface;
8+
use PhpMyAdmin\Config;
9+
use PhpMyAdmin\Controllers\Database\CentralColumnsController;
10+
use PhpMyAdmin\Database\CentralColumns;
11+
use PhpMyAdmin\Http\Factory\ServerRequestFactory;
12+
use PhpMyAdmin\Tests\AbstractTestCase;
13+
use PhpMyAdmin\Tests\Stubs\ResponseRenderer;
14+
use PHPUnit\Framework\Attributes\CoversClass;
15+
16+
#[CoversClass(CentralColumnsController::class)]
17+
final class CentralColumnsControllerTest extends AbstractTestCase
18+
{
19+
public function testEmptyList(): void
20+
{
21+
$dbiDummy = $this->createDbiDummy();
22+
$dbiDummy->addResult('SHOW TABLES FROM `test_db`;', [['test_table']], ['Tables_in_test_db']);
23+
$config = new Config();
24+
$dbi = $this->createDatabaseInterface($dbiDummy, $config);
25+
26+
$request = ServerRequestFactory::create()->createServerRequest('GET', 'https://example.com/')
27+
->withQueryParams(['route' => '/database/central-columns', 'db' => 'test_db']);
28+
29+
$response = (new CentralColumnsController(new ResponseRenderer(), new CentralColumns($dbi), $config))($request);
30+
31+
$dbiDummy->assertAllQueriesConsumed();
32+
self::assertSame(StatusCodeInterface::STATUS_OK, $response->getStatusCode());
33+
self::assertStringEqualsFile(
34+
__DIR__ . '/Fixtures/CentralColumns-testEmptyList.html',
35+
(string) $response->getBody(),
36+
);
37+
}
38+
}

‎tests/unit/Controllers/Database/DataDictionaryControllerTest.php‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace PhpMyAdmin\Tests\Controllers\Database;
6+
7+
use Fig\Http\Message\StatusCodeInterface;
8+
use PhpMyAdmin\Config;
9+
use PhpMyAdmin\ConfigStorage\Relation;
10+
use PhpMyAdmin\Controllers\Database\DataDictionaryController;
11+
use PhpMyAdmin\Current;
12+
use PhpMyAdmin\Http\Factory\ServerRequestFactory;
13+
use PhpMyAdmin\Tests\AbstractTestCase;
14+
use PhpMyAdmin\Tests\Stubs\ResponseRenderer;
15+
use PhpMyAdmin\Transformations;
16+
use PHPUnit\Framework\Attributes\CoversClass;
17+
18+
#[CoversClass(DataDictionaryController::class)]
19+
final class DataDictionaryControllerTest extends AbstractTestCase
20+
{
21+
public function testController(): void
22+
{
23+
$dbiDummy = $this->createDbiDummy();
24+
$dbiDummy->addSelectDb('test_db');
25+
$dbiDummy->addResult('SHOW TABLES FROM `test_db`;', [['test_table']], ['Tables_in_test_db']);
26+
27+
// phpcs:disable Generic.Files.LineLength.TooLong
28+
$dbiDummy->addResult(
29+
'SELECT *, `TABLE_SCHEMA` AS `Db`, `TABLE_NAME` AS `Name`, `TABLE_TYPE` AS `TABLE_TYPE`, `ENGINE` AS `Engine`, `ENGINE` AS `Type`, `VERSION` AS `Version`, `ROW_FORMAT` AS `Row_format`, `TABLE_ROWS` AS `Rows`, `AVG_ROW_LENGTH` AS `Avg_row_length`, `DATA_LENGTH` AS `Data_length`, `MAX_DATA_LENGTH` AS `Max_data_length`, `INDEX_LENGTH` AS `Index_length`, `DATA_FREE` AS `Data_free`, `AUTO_INCREMENT` AS `Auto_increment`, `CREATE_TIME` AS `Create_time`, `UPDATE_TIME` AS `Update_time`, `CHECK_TIME` AS `Check_time`, `TABLE_COLLATION` AS `Collation`, `CHECKSUM` AS `Checksum`, `CREATE_OPTIONS` AS `Create_options`, `TABLE_COMMENT` AS `Comment` FROM `information_schema`.`TABLES` t WHERE `TABLE_SCHEMA` COLLATE utf8_bin IN (\'test_db\') AND t.`TABLE_NAME` COLLATE utf8_bin = \'test_table\' ORDER BY Name ASC',
30+
[['ref', 'test_db', 'test_table', 'BASE TABLE', 'InnoDB', '10', 'Dynamic', '3', '5461', '16384', '0', '49152', '0', '4', '2021-11-07 15:21:00', null, null, 'utf8mb4_general_ci', null, '', '', '0', 'N', 'test_db', 'test_table', 'BASE TABLE', 'InnoDB', 'InnoDB', '10', 'Dynamic', '3', '5461', '16384', '0', '49152', '0', '4', '2021-11-07 15:21:00', null, null, 'utf8mb4_general_ci', null, '', '']],
31+
['TABLE_CATALOG', 'TABLE_SCHEMA', 'TABLE_NAME', 'TABLE_TYPE', 'ENGINE', 'VERSION', 'ROW_FORMAT', 'TABLE_ROWS', 'AVG_ROW_LENGTH', 'DATA_LENGTH', 'MAX_DATA_LENGTH', 'INDEX_LENGTH', 'DATA_FREE', 'AUTO_INCREMENT', 'CREATE_TIME', 'UPDATE_TIME', 'CHECK_TIME', 'TABLE_COLLATION', 'CHECKSUM', 'CREATE_OPTIONS', 'TABLE_COMMENT', 'MAX_INDEX_LENGTH', 'TEMPORARY', 'Db', 'Name', 'TABLE_TYPE', 'Engine', 'Type', 'Version', 'Row_format', 'Rows', 'Avg_row_length', 'Data_length', 'Max_data_length', 'Index_length', 'Data_free', 'Auto_increment', 'Create_time', 'Update_time', 'Check_time', 'Collation', 'Checksum', 'Create_options', 'Comment'],
32+
);
33+
// phpcs:enable
34+
35+
$config = new Config();
36+
$dbi = $this->createDatabaseInterface($dbiDummy, $config);
37+
$relation = new Relation($dbi, $config);
38+
39+
Current::$database = 'test_db';
40+
$request = ServerRequestFactory::create()->createServerRequest('GET', 'https://example.com/')
41+
->withQueryParams(['route' => '/database/data-dictionary', 'db' => 'test_db']);
42+
43+
$response = (new DataDictionaryController(
44+
new ResponseRenderer(),
45+
$relation,
46+
new Transformations($dbi, $relation),
47+
$dbi,
48+
))($request);
49+
50+
$dbiDummy->assertAllSelectsConsumed();
51+
$dbiDummy->assertAllQueriesConsumed();
52+
self::assertSame(StatusCodeInterface::STATUS_OK, $response->getStatusCode());
53+
self::assertStringEqualsFile(
54+
__DIR__ . '/Fixtures/DataDictionary-testController.html',
55+
(string) $response->getBody(),
56+
);
57+
}
58+
}

‎tests/unit/Controllers/Database/ExportControllerTest.php‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace PhpMyAdmin\Tests\Controllers\Database;
6+
7+
use Fig\Http\Message\StatusCodeInterface;
8+
use PhpMyAdmin\Clock\Clock;
9+
use PhpMyAdmin\Config;
10+
use PhpMyAdmin\Config\PageSettings;
11+
use PhpMyAdmin\Config\UserPreferences;
12+
use PhpMyAdmin\Config\UserPreferencesHandler;
13+
use PhpMyAdmin\ConfigStorage\Relation;
14+
use PhpMyAdmin\Controllers\Database\ExportController;
15+
use PhpMyAdmin\Current;
16+
use PhpMyAdmin\DbTableExists;
17+
use PhpMyAdmin\Export\Export;
18+
use PhpMyAdmin\Export\Options;
19+
use PhpMyAdmin\Export\OutputHandler;
20+
use PhpMyAdmin\Export\TemplateModel;
21+
use PhpMyAdmin\Http\Factory\ServerRequestFactory;
22+
use PhpMyAdmin\I18n\LanguageManager;
23+
use PhpMyAdmin\Template;
24+
use PhpMyAdmin\Tests\AbstractTestCase;
25+
use PhpMyAdmin\Tests\Stubs\DbiDummy;
26+
use PhpMyAdmin\Tests\Stubs\ResponseRenderer;
27+
use PhpMyAdmin\Theme\ThemeManager;
28+
use PHPUnit\Framework\Attributes\CoversClass;
29+
30+
#[CoversClass(ExportController::class)]
31+
final class ExportControllerTest extends AbstractTestCase
32+
{
33+
public function testController(): void
34+
{
35+
$_SERVER['SCRIPT_NAME'] = 'index.php';
36+
Current::$database = 'test_db';
37+
Export::$singleTable = false;
38+
39+
$dbiDummy = $this->createDbiDummy();
40+
$dbiDummy->addSelectDb('test_db');
41+
$dbiDummy->addResult('SHOW TABLES FROM `test_db`;', [['test_table']], ['Tables_in_test_db']);
42+
43+
$request = ServerRequestFactory::create()->createServerRequest('GET', 'https://example.com/')
44+
->withQueryParams(['route' => '/database/export', 'db' => 'test_db']);
45+
46+
$response = ($this->getExportController($dbiDummy))($request);
47+
48+
$dbiDummy->assertAllSelectsConsumed();
49+
$dbiDummy->assertAllQueriesConsumed();
50+
self::assertSame(StatusCodeInterface::STATUS_OK, $response->getStatusCode());
51+
self::assertStringEqualsFile(
52+
__DIR__ . '/Fixtures/Export-testController.html',
53+
(string) $response->getBody(),
54+
);
55+
}
56+
57+
private function getExportController(DbiDummy $dbiDummy): ExportController
58+
{
59+
$config = new Config();
60+
$dbi = $this->createDatabaseInterface($dbiDummy, $config);
61+
$responseRenderer = new ResponseRenderer();
62+
$relation = new Relation($dbi, $config);
63+
$userPreferences = new UserPreferences($dbi, $relation, new Template($config), $config, new Clock());
64+
$userPreferencesHandler = new UserPreferencesHandler(
65+
$config,
66+
$dbi,
67+
$userPreferences,
68+
new LanguageManager($config),
69+
new ThemeManager(),
70+
);
71+
72+
return new ExportController(
73+
$responseRenderer,
74+
new Export($dbi, new OutputHandler()),
75+
new Options($relation, new TemplateModel($dbi), $userPreferencesHandler),
76+
new PageSettings($userPreferences, $responseRenderer),
77+
new DbTableExists($dbi),
78+
);
79+
}
80+
}

0 commit comments

Comments
 (0)