phpmyadmin/tests/unit/Plugins/Export/ExportCodegenTest.php

<?php

declare(strict_types=1);

namespace PhpMyAdmin\Tests\Plugins\Export;

use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\Export\Export;
use PhpMyAdmin\Http\Factory\ServerRequestFactory;
use PhpMyAdmin\Plugins\Export\ExportCodegen;
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup;
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyRootGroup;
use PhpMyAdmin\Properties\Options\Items\HiddenPropertyItem;
use PhpMyAdmin\Properties\Options\Items\SelectPropertyItem;
use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
use PhpMyAdmin\Tests\AbstractTestCase;
use PhpMyAdmin\Transformations;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Medium;
use ReflectionMethod;
use ReflectionProperty;

use function ob_get_clean;
use function ob_start;

#[CoversClass(ExportCodegen::class)]
#[Medium]
class ExportCodegenTest extends AbstractTestCase
{
    protected ExportCodegen $object;

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

        $dbi = $this->createDatabaseInterface();
        DatabaseInterface::$instance = $dbi;
        $this->object = new ExportCodegen(
            new Relation($dbi),
            new Export($dbi),
            new Transformations(),
        );
    }

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

        unset($this->object);
    }

    public function testSetProperties(): void
    {
        $method = new ReflectionMethod(ExportCodegen::class, 'setProperties');
        $method->invoke($this->object, null);

        $attrProperties = new ReflectionProperty(ExportCodegen::class, 'properties');
        $properties = $attrProperties->getValue($this->object);

        self::assertInstanceOf(ExportPluginProperties::class, $properties);

        self::assertSame(
            'CodeGen',
            $properties->getText(),
        );

        self::assertSame(
            'cs',
            $properties->getExtension(),
        );

        self::assertSame(
            'text/cs',
            $properties->getMimeType(),
        );

        self::assertSame(
            'Options',
            $properties->getOptionsText(),
        );

        $options = $properties->getOptions();

        self::assertInstanceOf(OptionsPropertyRootGroup::class, $options);

        self::assertSame(
            'Format Specific Options',
            $options->getName(),
        );

        $generalOptionsArray = $options->getProperties();
        $generalOptions = $generalOptionsArray->current();

        self::assertInstanceOf(OptionsPropertyMainGroup::class, $generalOptions);

        self::assertSame(
            'general_opts',
            $generalOptions->getName(),
        );

        $generalProperties = $generalOptions->getProperties();

        $hidden = $generalProperties->current();
        $generalProperties->next();

        self::assertInstanceOf(HiddenPropertyItem::class, $hidden);

        self::assertSame(
            'structure_or_data',
            $hidden->getName(),
        );

        $select = $generalProperties->current();

        self::assertInstanceOf(SelectPropertyItem::class, $select);

        self::assertSame(
            'format',
            $select->getName(),
        );

        self::assertSame(
            'Format:',
            $select->getText(),
        );

        self::assertSame(
            ['NHibernate C# DO', 'NHibernate XML'],
            $select->getValues(),
        );
    }

    public function testExportHeader(): void
    {
        self::assertTrue(
            $this->object->exportHeader(),
        );
    }

    public function testExportFooter(): void
    {
        self::assertTrue(
            $this->object->exportFooter(),
        );
    }

    public function testExportDBHeader(): void
    {
        self::assertTrue(
            $this->object->exportDBHeader('testDB'),
        );
    }

    public function testExportDBFooter(): void
    {
        self::assertTrue(
            $this->object->exportDBFooter('testDB'),
        );
    }

    public function testExportData(): void
    {
        $GLOBALS['output_kanji_conversion'] = false;
        $GLOBALS['output_charset_conversion'] = false;
        $GLOBALS['buffer_needed'] = false;
        $GLOBALS['asfile'] = true;
        $GLOBALS['save_on_server'] = false;

        $request = ServerRequestFactory::create()->createServerRequest('POST', 'https://example.com/')
            ->withParsedBody(['codegen_format' => '1']);

        $this->object->setExportOptions($request, []);

        ob_start();
        $this->object->exportData('test_db', 'test_table', 'SELECT * FROM `test_db`.`test_table`;');
        $result = ob_get_clean();

        self::assertIsString($result);
        self::assertSame(
            '<?xml version="1.0" encoding="utf-8" ?>' . "\n"
            . '<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" namespace="Test_db" assembly="Test_db">' . "\n"
            . '    <class name="Test_table" table="Test_table">' . "\n"
            . '        <id name="Id" type="Int32" unsaved-value="0">' . "\n"
            . '            <column name="id" sql-type="int" not-null="true" unique="true" index="PRIMARY"/>' . "\n"
            . '            <generator class="native" />' . "\n"
            . '        </id>' . "\n"
            . '        <property name="Name" type="String">' . "\n"
            . '            <column name="name" sql-type="varchar" not-null="true" />' . "\n"
            . '        </property>' . "\n"
            . '        <property name="Datetimefield" type="DateTime">' . "\n"
            . '            <column name="datetimefield" sql-type="datetime" not-null="true" />' . "\n"
            . '        </property>' . "\n"
            . '    </class>' . "\n"
            . '</hibernate-mapping>',
            $result,
        );
    }

    public function testCgMakeIdentifier(): void
    {
        self::assertSame(
            '_Ⅲfoo',
            ExportCodegen::cgMakeIdentifier('Ⅲ{}96`{}foo', true),
        );

        self::assertSame(
            'TestⅢ',
            ExportCodegen::cgMakeIdentifier('`98testⅢ{}96`{}', true),
        );

        self::assertSame(
            'testⅢ',
            ExportCodegen::cgMakeIdentifier('`98testⅢ{}96`{}', false),
        );
    }

    public function testHandleNHibernateCSBody(): void
    {
        $method = new ReflectionMethod(ExportCodegen::class, 'handleNHibernateCSBody');
        $result = $method->invoke($this->object, 'test_db', 'test_table');

        self::assertSame(
            'using System;' . "\n" .
            'using System.Collections;' . "\n" .
            'using System.Collections.Generic;' . "\n" .
            'using System.Text;' . "\n" .
            'namespace Test_db' . "\n" .
            '{' . "\n" .
            '    #region Test_table' . "\n" .
            '    public class Test_table' . "\n" .
            '    {' . "\n" .
            '        #region Member Variables' . "\n" .
            '        protected int _id;' . "\n" .
            '        protected string _name;' . "\n" .
            '        protected DateTime _datetimefield;' . "\n" .
            '        #endregion' . "\n" .
            '        #region Constructors' . "\n" .
            '        public Test_table() { }' . "\n" .
            '        public Test_table(string name, DateTime datetimefield)' . "\n" .
            '        {' . "\n" .
            '            this._name=name;' . "\n" .
            '            this._datetimefield=datetimefield;' . "\n" .
            '        }' . "\n" .
            '        #endregion' . "\n" .
            '        #region Public Properties' . "\n" .
            '        public virtual int Id' . "\n" .
            '        {' . "\n" .
            '            get {return _id;}' . "\n" .
            '            set {_id=value;}' . "\n" .
            '        }' . "\n" .
            '        public virtual string Name' . "\n" .
            '        {' . "\n" .
            '            get {return _name;}' . "\n" .
            '            set {_name=value;}' . "\n" .
            '        }' . "\n" .
            '        public virtual DateTime Datetimefield' . "\n" .
            '        {' . "\n" .
            '            get {return _datetimefield;}' . "\n" .
            '            set {_datetimefield=value;}' . "\n" .
            '        }' . "\n" .
            '        #endregion' . "\n" .
            '    }' . "\n" .
            '    #endregion' . "\n" .
            '}',
            $result,
        );
    }

    public function testHandleNHibernateXMLBody(): void
    {
        $method = new ReflectionMethod(ExportCodegen::class, 'handleNHibernateXMLBody');
        $result = $method->invoke($this->object, 'test_db', 'test_table');

        self::assertSame(
            '<?xml version="1.0" encoding="utf-8" ?>' . "\n" .
            '<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" namespace="Test_db" assembly="Test_db">' . "\n" .
            '    <class name="Test_table" table="Test_table">' . "\n" .
            '        <id name="Id" type="Int32" unsaved-value="0">' . "\n" .
            '            <column name="id" sql-type="int" not-null="true" unique="true" index="PRIMARY"/>' . "\n" .
            '            <generator class="native" />' . "\n" .
            '        </id>' . "\n" .
            '        <property name="Name" type="String">' . "\n" .
            '            <column name="name" sql-type="varchar" not-null="true" />' . "\n" .
            '        </property>' . "\n" .
            '        <property name="Datetimefield" type="DateTime">' . "\n" .
            '            <column name="datetimefield" sql-type="datetime" not-null="true" />' . "\n" .
            '        </property>' . "\n" .
            '    </class>' . "\n" .
            '</hibernate-mapping>',
            $result,
        );
    }
}