phpmyadmin/tests/classes/Config/FormTest.php

<?php

declare(strict_types=1);

namespace PhpMyAdmin\Tests\Config;

use PhpMyAdmin\Config\ConfigFile;
use PhpMyAdmin\Config\Form;
use PhpMyAdmin\Tests\AbstractTestCase;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Group;
use ReflectionClass;
use ReflectionProperty;

use function array_keys;
use function preg_match;

#[CoversClass(Form::class)]
class FormTest extends AbstractTestCase
{
    protected Form $object;

    /**
     * Configures global environment.
     */
    protected function setUp(): void
    {
        parent::setUp();

        parent::setGlobalConfig();

        $this->object = new Form(
            'pma_form_name',
            ['pma_form1', 'pma_form2'],
            new ConfigFile(),
            1,
        );
    }

    /**
     * tearDown for test cases
     */
    protected function tearDown(): void
    {
        parent::tearDown();

        unset($this->object);
    }

    /**
     * Test for Form::__constructor
     */
    #[Group('medium')]
    public function testContructor(): void
    {
        self::assertEquals(1, $this->object->index);
        self::assertEquals('pma_form_name', $this->object->name);
        self::assertArrayHasKey('pma_form1', $this->object->fields);
    }

    /**
     * Test for Form::getOptionType
     */
    public function testGetOptionType(): void
    {
        (new ReflectionProperty(Form::class, 'fieldsTypes'))->setValue(
            $this->object,
            ['7' => 'Seven'],
        );

        self::assertNull(
            $this->object->getOptionType('123/4/5/6'),
        );

        self::assertEquals(
            'Seven',
            $this->object->getOptionType('123/4/5/7'),
        );
    }

    /**
     * Test for Form::getOptionValueList
     */
    public function testGetOptionValueList(): void
    {
        self::assertEquals(
            ['NHibernate C# DO', 'NHibernate XML'],
            $this->object->getOptionValueList('Export/codegen_format'),
        );

        self::assertEquals(
            ['auto' => 'auto', '1' => 1, '0' => 0],
            $this->object->getOptionValueList('OBGzip'),
        );

        self::assertEquals(
            ['none' => 'Nowhere', 'left' => 'Left', 'right' => 'Right', 'both' => 'Both'],
            $this->object->getOptionValueList('RowActionLinks'),
        );
    }

    /**
     * Test for Form::readFormPathsCallback
     */
    public function testReadFormPathsCallBack(): void
    {
        $reflection = new ReflectionClass(Form::class);
        $method = $reflection->getMethod('readFormPathsCallback');

        $array = ['foo' => ['bar' => ['test' => 1, 1 => ':group:end']]];

        $method->invoke($this->object, $array, 'foo', 'pref');

        $result = $this->object->fields;

        self::assertCount(4, $result);

        self::assertEquals('pma_form1', $result['pma_form1']);

        self::assertEquals('pma_form2', $result['pma_form2']);

        self::assertEquals('preffoo/foo/bar/test', $result[0]);

        // needs regexp because the counter is static
        self::assertMatchesRegularExpression('/^preffoo\/foo\/bar\/\:group\:end\:\d+$/', $result[1]);
    }

    /**
     * Test for Form::readFormPaths
     */
    public function testReadFormPaths(): void
    {
        $reflection = new ReflectionClass(Form::class);
        $method = $reflection->getMethod('readFormPaths');

        $array = ['foo' => ['bar' => ['test' => 1, 1 => ':group:end']]];

        $method->invoke($this->object, $array);

        $result = $this->object->fields;

        self::assertCount(2, $result);

        self::assertEquals('foo/bar/test', $result['test']);

        unset($result['test']);

        // needs regexp because the counter is static
        $key = array_keys($result)[0];
        self::assertIsString($key);

        self::assertMatchesRegularExpression('/^\:group\:end\:(\d+)$/', $key);

        preg_match('/^\:group\:end\:(\d+)$/', $key, $matches);
        $digit = $matches[1];

        self::assertEquals('foo/bar/:group:end:' . $digit, $result[':group:end:' . $digit]);
    }

    /**
     * Test for Form::readTypes
     */
    public function testReadTypes(): void
    {
        $reflection = new ReflectionClass(Form::class);
        $method = $reflection->getMethod('readTypes');

        $this->object->fields = [
            'pma_form1' => 'Servers/1/port',
            'pma_form2' => 'Servers/1/auth_type',
            ':group:end:0' => 'preffoo/foo/bar/test',
            '1' => 'preffoo/foo/bar/:group:end:0',
        ];

        $attrFieldsTypes = $reflection->getProperty('fieldsTypes');

        $method->invoke($this->object, null);

        self::assertEquals(
            ['pma_form1' => 'integer', 'pma_form2' => 'select', ':group:end:0' => 'group', '1' => 'NULL'],
            $attrFieldsTypes->getValue($this->object),
        );
    }

    /**
     * Test for Form::loadForm
     */
    public function testLoadForm(): void
    {
        $this->object = $this->getMockBuilder(Form::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['readFormPaths', 'readTypes'])
            ->getMock();

        $this->object->expects(self::exactly(1))
            ->method('readFormPaths')
            ->with(['testForm']);

        $this->object->expects(self::exactly(1))
            ->method('readTypes');

        $this->object->loadForm('pmaform', ['testForm']);

        self::assertEquals('pmaform', $this->object->name);
    }

    /**
     * Test for Form::cleanGroupPaths
     */
    public function testCleanGroupPaths(): void
    {
        $this->object = $this->getMockBuilder(Form::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['readFormPaths', 'readTypes'])
            ->getMock();

        $this->object->expects(self::exactly(1))->method('readFormPaths')->with([
            ':group:OpenDocument-OpenOffice 試算表',
            'group:test/data',
            'Export/ods_columns',
            'Export/ods_null',
            ':group:end',
        ]);

        $this->object->loadForm('pmaform', [
            ':group:OpenDocument/OpenOffice 試算表',
            'group:test/data',
            'Export/ods_columns',
            'Export/ods_null',
            ':group:end',
        ]);
    }
}