phpmyadmin/tests/unit/Controllers/Table/StructureControllerTest.php

<?php

declare(strict_types=1);

namespace PhpMyAdmin\Tests\Controllers\Table;

use PhpMyAdmin\Charsets;
use PhpMyAdmin\Clock\Clock;
use PhpMyAdmin\Config;
use PhpMyAdmin\Config\PageSettings;
use PhpMyAdmin\Config\UserPreferences;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\Controllers\Table\StructureController;
use PhpMyAdmin\Current;
use PhpMyAdmin\Dbal\DatabaseInterface;
use PhpMyAdmin\DbTableExists;
use PhpMyAdmin\Http\Factory\ServerRequestFactory;
use PhpMyAdmin\Indexes\Index;
use PhpMyAdmin\Template;
use PhpMyAdmin\Tests\AbstractTestCase;
use PhpMyAdmin\Tests\Stubs\DbiDummy;
use PhpMyAdmin\Tests\Stubs\ResponseRenderer;
use PhpMyAdmin\Transformations;
use PhpMyAdmin\Util;
use PHPUnit\Framework\Attributes\CoversClass;
use ReflectionProperty;

#[CoversClass(StructureController::class)]
class StructureControllerTest extends AbstractTestCase
{
    protected DatabaseInterface $dbi;

    protected DbiDummy $dummyDbi;

    protected function setUp(): void
    {
        parent::setUp();

        $this->dummyDbi = $this->createDbiDummy();
        $this->dbi = $this->createDatabaseInterface($this->dummyDbi);
        DatabaseInterface::$instance = $this->dbi;
    }

    public function testStructureController(): void
    {
        Current::$database = 'test_db';
        Current::$table = 'test_table';
        Current::$lang = 'en';
        $config = Config::getInstance();
        $config->selectedServer = $config->getSettings()->Servers[1]->asArray();
        $config->selectedServer['DisableIS'] = true;
        $config->settings['ShowStats'] = false;
        $config->settings['ShowPropertyComments'] = false;
        (new ReflectionProperty(Relation::class, 'cache'))->setValue(null, null);
        (new ReflectionProperty(Template::class, 'twig'))->setValue(null, null);
        (new ReflectionProperty(Charsets::class, 'collations'))->setValue(null, []);

        $this->dummyDbi->addSelectDb('test_db');
        $this->dummyDbi->addSelectDb('test_db');
        $this->dummyDbi->addResult('SELECT 1 FROM `test_db`.`test_table` LIMIT 1;', [[1]]);
        $this->dummyDbi->addResult(
            'SHOW COLLATION',
            [
                ['utf8mb4_general_ci', 'utf8mb4', '45', 'Yes', 'Yes', '1'],
                ['armscii8_general_ci', 'armscii8', '32', 'Yes', 'Yes', '1'],
                ['utf8_general_ci', 'utf8', '33', 'Yes', 'Yes', '1'],
                ['utf8_bin', 'utf8', '83', '', 'Yes', '1'],
                ['latin1_swedish_ci', 'latin1', '8', 'Yes', 'Yes', '1'],
            ],
            ['Collation', 'Charset', 'Id', 'Default', 'Compiled', 'Sortlen'],
        );
        // phpcs:disable Generic.Files.LineLength.TooLong
        $this->dummyDbi->addResult(
            'SELECT * FROM `information_schema`.`PARTITIONS` WHERE `TABLE_SCHEMA` = \'test_db\' AND `TABLE_NAME` = \'test_table\'',
            [
                ['def', 'test_db', 'test_table', null, null, null, null, null, null, null, null, null, '3', '5461', '16384', null, '0', '0', '2022-02-21 13:34:11', null, null, null, '', '', null],
            ],
            ['TABLE_CATALOG', 'TABLE_SCHEMA', 'TABLE_NAME', 'PARTITION_NAME', 'SUBPARTITION_NAME', 'PARTITION_ORDINAL_POSITION', 'SUBPARTITION_ORDINAL_POSITION', 'PARTITION_METHOD', 'SUBPARTITION_METHOD', 'PARTITION_EXPRESSION', 'SUBPARTITION_EXPRESSION', 'PARTITION_DESCRIPTION', 'TABLE_ROWS', 'AVG_ROW_LENGTH', 'DATA_LENGTH', 'MAX_DATA_LENGTH', 'INDEX_LENGTH', 'DATA_FREE', 'CREATE_TIME', 'UPDATE_TIME', 'CHECK_TIME', 'CHECKSUM', 'PARTITION_COMMENT', 'NODEGROUP', 'TABLESPACE_NAME'],
        );
        $this->dummyDbi->addResult(
            'SELECT DISTINCT `PARTITION_NAME` FROM `information_schema`.`PARTITIONS` WHERE `TABLE_SCHEMA` = \'test_db\' AND `TABLE_NAME` = \'test_table\'',
            [[null]],
            ['PARTITION_NAME'],
        );
        // phpcs:enable

        $relation = new Relation($this->dbi, $config);
        $template = new Template($config);
        $userPreferences = new UserPreferences($this->dbi, $relation, $template, $config, new Clock());
        $response = new ResponseRenderer();
        $pageSettings = new PageSettings($userPreferences, $response);
        $pageSettings->init('TableStructure');
        $fields = $this->dbi->getColumns(Current::$database, Current::$table);

        $request = ServerRequestFactory::create()->createServerRequest('GET', 'http://example.com/')
            ->withQueryParams(['route' => '/table/structure', 'db' => 'test_db', 'table' => 'test_table']);

        (new StructureController(
            $response,
            $template,
            $relation,
            new Transformations($this->dbi, $relation),
            $this->dbi,
            $pageSettings,
            new DbTableExists($this->dbi),
            $config,
        ))($request);

        $expected = $pageSettings->getHTML();
        $expected .= $template->render('table/structure/display_structure', [
            'collations' => [
                'utf8mb4_general_ci' => [
                    'name' => 'utf8mb4_general_ci',
                    'description' => 'Unicode (UCA 4.0.0), case-insensitive',
                ],
            ],
            'is_foreign_key_supported' => true,
            'indexes' => Index::getFromTable($this->dbi, Current::$table, Current::$database),
            'indexes_duplicates' => Index::findDuplicates(Current::$table, Current::$database),
            'relation_parameters' => $relation->getRelationParameters(),
            'hide_structure_actions' => true,
            'db' => 'test_db',
            'table' => 'test_table',
            'db_is_system_schema' => false,
            'tbl_is_view' => false,
            'mime_map' => [],
            'tbl_storage_engine' => 'INNODB',
            'primary' => Index::getPrimary($this->dbi, Current::$table, Current::$database),
            'columns_list' => ['id', 'name', 'datetimefield'],
            'table_stats' => null,
            'fields' => $fields,
            'extracted_columnspecs' => [
                1 => Util::extractColumnSpec($fields['id']->type),
                2 => Util::extractColumnSpec($fields['name']->type),
                3 => Util::extractColumnSpec($fields['datetimefield']->type),
            ],
            'columns_with_index' => [],
            'central_list' => [],
            'comments_map' => [],
            'browse_mime' => true,
            'show_column_comments' => true,
            'show_stats' => false,
            'mysql_int_version' => $this->dbi->getVersion(),
            'is_mariadb' => $this->dbi->isMariaDB(),
            'is_active' => false,
            'have_partitioning' => true,
            'partitions' => [],
            'partition_names' => [null],
            'default_sliders_state' => 'closed',
            'attributes' => [1 => ' ', 2 => ' ', 3 => ' '],
            'displayed_fields' => [
                1 => [
                    'text' => 'id',
                    'icon' => '<img src="themes/dot.gif" title="Primary" alt="Primary" class="icon ic_b_primary">',
                ],
                2 => ['text' => 'name', 'icon' => ''],
                3 => ['text' => 'datetimefield', 'icon' => ''],
            ],
            'row_comments' => [1 => '', 2 => '', 3 => ''],
            'route' => '/table/structure',
        ]);

        self::assertSame($expected, $response->getHTMLResult());

        $this->dummyDbi->assertAllSelectsConsumed();
        $this->dummyDbi->assertAllQueriesConsumed();
    }
}