ShowTableInfoTest.php

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Commands\Database;

use CodeIgniter\CLI\CLI;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\DatabaseTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Database;
use PHPUnit\Framework\Attributes\Group;
use Tests\Support\Database\Seeds\CITestSeeder;

/**
 * @internal
 */
#[Group('DatabaseLive')]
final class ShowTableInfoTest extends CIUnitTestCase
{
    use DatabaseTestTrait;
    use StreamFilterTrait;

    protected $migrateOnce = true;

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

        putenv('NO_COLOR=1');
        CLI::init();
    }

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

        putenv('NO_COLOR');
        CLI::init();
    }

    private function getNormalizedResult(): string
    {
        return str_replace(PHP_EOL, "\n", $this->getStreamFilterBuffer());
    }

    public function testDbTable(): void
    {
        command('db:table db_migrations');

        $result = $this->getNormalizedResult();

        $expected = 'Data of Table "db_migrations":';
        $this->assertStringContainsString($expected, $result);

        $expectedPattern = '/\| id[[:blank:]]+\| version[[:blank:]]+\| class[[:blank:]]+\| group[[:blank:]]+\| namespace[[:blank:]]+\| time[[:blank:]]+\| batch \|/';
        $this->assertMatchesRegularExpression($expectedPattern, $result);
    }

    public function testDbTableShowsWithInvalidDBGroup(): void
    {
        command('db:table --show --dbgroup invalid');

        $result = $this->getNormalizedResult();

        $expected = '"invalid" is not a valid database connection group.';
        $this->assertStringContainsString($expected, $result);
    }

    public function testDbTableShowsDBConfig(): void
    {
        command('db:table --show');

        $result = $this->getNormalizedResult();

        $expectedPattern = '/\| hostname[[:blank:]]+\| database[[:blank:]]+\| username[[:blank:]]+\| DBDriver[[:blank:]]+\| DBPrefix[[:blank:]]+\| port[[:blank:]]+\|/';
        $this->assertMatchesRegularExpression($expectedPattern, $result);
    }

    public function testDbTableShow(): void
    {
        command('db:table --show');

        $result = $this->getNormalizedResult();

        $expected = 'The following is a list of the names of all database tables:';
        $this->assertStringContainsString($expected, $result);

        $expected = <<<'EOL'
            +----+---------------------------+-------------+---------------+
            | ID | Table Name                | Num of Rows | Num of Fields |
            +----+---------------------------+-------------+---------------+
            EOL;
        $this->assertStringContainsString($expected, $result);
    }

    public function testDbTableMetadata(): void
    {
        command('db:table db_migrations --metadata');

        $result = $this->getNormalizedResult();

        $expected = 'List of Metadata Information in Table "db_migrations":';
        $this->assertStringContainsString($expected, $result);

        $result   = preg_replace('/\s+/', ' ', $result);
        $expected = <<<'EOL'
            | Field Name | Type | Max Length | Nullable | Default | Primary Key |
            EOL;
        $this->assertStringContainsString($expected, (string) $result);
    }

    public function testDbTableDesc(): void
    {
        $seeder = Database::seeder();
        $seeder->call(CITestSeeder::class);

        command('db:table db_user --desc');

        $result = $this->getNormalizedResult();

        $expected = 'Data of Table "db_user":';
        $this->assertStringContainsString($expected, $result);

        $expected = <<<'EOL'
            +----+--------------------+--------------------+---------+------------+------------+------------+
            | id | name               | email              | country | created_at | updated_at | deleted_at |
            +----+--------------------+--------------------+---------+------------+------------+------------+
            | 4  | Chris Martin       | chris@world.com    | UK      |            |            |            |
            | 3  | Richard A Cause... | richard@world.c... | US      |            |            |            |
            | 2  | Ahmadinejad        | ahmadinejad@wor... | Iran    |            |            |            |
            | 1  | Derek Jones        | derek@world.com    | US      |            |            |            |
            +----+--------------------+--------------------+---------+------------+------------+------------+
            EOL;
        $this->assertStringContainsString($expected, $result);
    }

    public function testDbTableLimitFieldValueLength(): void
    {
        command('db:table db_user --limit-field-value 5');

        $result = $this->getNormalizedResult();

        $expected = 'Data of Table "db_user":';
        $this->assertStringContainsString($expected, $result);

        $expected = <<<'EOL'
            +----+----------+----------+---------+------------+------------+------------+
            | id | name     | email    | country | created_at | updated_at | deleted_at |
            +----+----------+----------+---------+------------+------------+------------+
            | 1  | Derek... | derek... | US      |            |            |            |
            | 2  | Ahmad... | ahmad... | Iran    |            |            |            |
            | 3  | Richa... | richa... | US      |            |            |            |
            | 4  | Chris... | chris... | UK      |            |            |            |
            +----+----------+----------+---------+------------+------------+------------+
            EOL;
        $this->assertStringContainsString($expected, $result);
    }

    public function testDbTableLimitRows(): void
    {
        command('db:table db_user --limit-rows 2');

        $result = $this->getNormalizedResult();

        $expected = 'Data of Table "db_user":';
        $this->assertStringContainsString($expected, $result);

        $expected = <<<'EOL'
            +----+-------------+--------------------+---------+------------+------------+------------+
            | id | name        | email              | country | created_at | updated_at | deleted_at |
            +----+-------------+--------------------+---------+------------+------------+------------+
            | 1  | Derek Jones | derek@world.com    | US      |            |            |            |
            | 2  | Ahmadinejad | ahmadinejad@wor... | Iran    |            |            |            |
            +----+-------------+--------------------+---------+------------+------------+------------+
            EOL;
        $this->assertStringContainsString($expected, $result);
    }

    public function testDbTableAllOptions(): void
    {
        command('db:table db_user --limit-rows 2 --limit-field-value 5 --desc');

        $result = $this->getNormalizedResult();

        $expected = 'Data of Table "db_user":';
        $this->assertStringContainsString($expected, $result);

        $expected = <<<'EOL'
            +----+----------+----------+---------+------------+------------+------------+
            | id | name     | email    | country | created_at | updated_at | deleted_at |
            +----+----------+----------+---------+------------+------------+------------+
            | 4  | Chris... | chris... | UK      |            |            |            |
            | 3  | Richa... | richa... | US      |            |            |            |
            +----+----------+----------+---------+------------+------------+------------+
            EOL;
        $this->assertStringContainsString($expected, $result);
    }
}