tests/unit/TransformationsTest.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Tests;
   6
   7 use PhpMyAdmin\Config;
   8 use PhpMyAdmin\ConfigStorage\Relation;
   9 use PhpMyAdmin\ConfigStorage\RelationParameters;
  10 use PhpMyAdmin\Current;
  11 use PhpMyAdmin\Dbal\DatabaseInterface;
  12 use PhpMyAdmin\Tests\Stubs\DummyResult;
  13 use PhpMyAdmin\Transformations;
  14 use PHPUnit\Framework\Attributes\CoversClass;
  15 use PHPUnit\Framework\Attributes\DataProvider;
  16 use ReflectionProperty;
  17
  18 #[CoversClass(Transformations::class)]
  19 class TransformationsTest extends AbstractTestCase
  20 {
  21     private Transformations $transformations;
  22
  23     /**
  24      * Set up global environment.
  25      */
  26     protected function setUp(): void
  27     {
  28         parent::setUp();
  29
  30         DatabaseInterface::$instance = $this->createDatabaseInterface();
  31         Current::$table = 'table';
  32         Current::$database = 'db';
  33         $config = Config::getInstance();
  34         $config->settings = ['ServerDefault' => 1, 'ActionLinksMode' => 'icons'];
  35         $config->selectedServer['pmadb'] = 'pmadb';
  36         $config->selectedServer['user'] = 'user';
  37         $config->selectedServer['bookmarktable'] = '';
  38         $config->selectedServer['relation'] = '';
  39         $config->selectedServer['table_info'] = '';
  40         $config->selectedServer['table_coords'] = '';
  41         $config->selectedServer['column_info'] = 'column_info';
  42
  43         $this->transformations = new Transformations();
  44     }
  45
  46     /**
  47      * Test for parsing options.
  48      *
  49      * @param string  $input    String to parse
  50      * @param mixed[] $expected Expected result
  51      */
  52     #[DataProvider('getOptionsData')]
  53     public function testGetOptions(string $input, array $expected): void
  54     {
  55         self::assertSame(
  56             $expected,
  57             $this->transformations->getOptions($input),
  58         );
  59     }
  60
  61     /**
  62      * Data provided for parsing options
  63      *
  64      * @return mixed[][]
  65      */
  66     public static function getOptionsData(): array
  67     {
  68         return [
  69             ['option1 , option2 ', ['option1 ', ' option2 ']],
  70             ["'option1' ,' option2' ", ['option1', ' option2']],
  71             ["'2,3' ,' ,, option ,,' ", ['2,3', ' ,, option ,,']],
  72             ["'',,", ['', '', '']],
  73             ['', []],
  74         ];
  75     }
  76
  77     public function testGetTypes(): void
  78     {
  79         self::assertEquals(
  80             [
  81                 'mimetype' => [
  82                     'Application/Octetstream' => 'Application/Octetstream',
  83                     'Image/JPEG' => 'Image/JPEG',
  84                     'Image/PNG' => 'Image/PNG',
  85                     'Text/Plain' => 'Text/Plain',
  86                     'Text/Octetstream' => 'Text/Octetstream',
  87                 ],
  88                 'transformation' => [
  89                     'Application/Octetstream: Download',
  90                     'Application/Octetstream: Hex',
  91                     'Image/JPEG: Inline',
  92                     'Image/JPEG: Link',
  93                     'Image/PNG: Inline',
  94                     'Text/Octetstream: Sql',
  95                     'Text/Plain: Binarytoip',
  96                     'Text/Plain: Bool2Text',
  97                     'Text/Plain: Dateformat',
  98                     'Text/Plain: External',
  99                     'Text/Plain: Formatted',
 100                     'Text/Plain: Imagelink',
 101                     'Text/Plain: Json',
 102                     'Text/Plain: Sql',
 103                     'Text/Plain: Xml',
 104                     'Text/Plain: Link',
 105                     'Text/Plain: Longtoipv4',
 106                     'Text/Plain: PreApPend',
 107                     'Text/Plain: Substring',
 108                 ],
 109                 'transformation_file' => [
 110                     'Output/Application_Octetstream_Download.php',
 111                     'Output/Application_Octetstream_Hex.php',
 112                     'Output/Image_JPEG_Inline.php',
 113                     'Output/Image_JPEG_Link.php',
 114                     'Output/Image_PNG_Inline.php',
 115                     'Output/Text_Octetstream_Sql.php',
 116                     'Output/Text_Plain_Binarytoip.php',
 117                     'Output/Text_Plain_Bool2Text.php',
 118                     'Output/Text_Plain_Dateformat.php',
 119                     'Output/Text_Plain_External.php',
 120                     'Output/Text_Plain_Formatted.php',
 121                     'Output/Text_Plain_Imagelink.php',
 122                     'Output/Text_Plain_Json.php',
 123                     'Output/Text_Plain_Sql.php',
 124                     'Output/Text_Plain_Xml.php',
 125                     'Text_Plain_Link.php',
 126                     'Text_Plain_Longtoipv4.php',
 127                     'Text_Plain_PreApPend.php',
 128                     'Text_Plain_Substring.php',
 129                 ],
 130                 'input_transformation' => [
 131                     'Image/JPEG: Upload',
 132                     'Text/Plain: FileUpload',
 133                     'Text/Plain: Iptobinary',
 134                     'Text/Plain: Iptolong',
 135                     'Text/Plain: JsonEditor',
 136                     'Text/Plain: RegexValidation',
 137                     'Text/Plain: SqlEditor',
 138                     'Text/Plain: XmlEditor',
 139                     'Text/Plain: Link',
 140                     'Text/Plain: Longtoipv4',
 141                     'Text/Plain: PreApPend',
 142                     'Text/Plain: Substring',
 143                 ],
 144                 'input_transformation_file' => [
 145                     'Input/Image_JPEG_Upload.php',
 146                     'Input/Text_Plain_FileUpload.php',
 147                     'Input/Text_Plain_Iptobinary.php',
 148                     'Input/Text_Plain_Iptolong.php',
 149                     'Input/Text_Plain_JsonEditor.php',
 150                     'Input/Text_Plain_RegexValidation.php',
 151                     'Input/Text_Plain_SqlEditor.php',
 152                     'Input/Text_Plain_XmlEditor.php',
 153                     'Text_Plain_Link.php',
 154                     'Text_Plain_Longtoipv4.php',
 155                     'Text_Plain_PreApPend.php',
 156                     'Text_Plain_Substring.php',
 157                 ],
 158             ],
 159             $this->transformations->getAvailableMimeTypes(),
 160         );
 161     }
 162
 163     /**
 164      * Tests getting mime types for table
 165      */
 166     public function testGetMime(): void
 167     {
 168         $relationParameters = RelationParameters::fromArray([
 169             'db' => 'pmadb',
 170             'mimework' => true,
 171             'trackingwork' => true,
 172             'column_info' => 'column_info',
 173         ]);
 174         (new ReflectionProperty(Relation::class, 'cache'))->setValue(null, $relationParameters);
 175         self::assertSame(
 176             [
 177                 'o' => [
 178                     'column_name' => 'o',
 179                     'mimetype' => 'Text/plain',
 180                     'transformation' => 'Sql',
 181                     'transformation_options' => '',
 182                     'input_transformation' => 'regex',
 183                     'input_transformation_options' => '/pma/i',
 184                 ],
 185                 'col' => [
 186                     'column_name' => 'col',
 187                     'mimetype' => 'T',
 188                     'transformation' => 'O/P',
 189                     'transformation_options' => '',
 190                     'input_transformation' => 'i/p',
 191                     'input_transformation_options' => '',
 192                 ],
 193             ],
 194             $this->transformations->getMime('pma_test', 'table1'),
 195         );
 196     }
 197
 198     /**
 199      * Test for clear
 200      */
 201     public function testClear(): void
 202     {
 203         // Mock dbi
 204         $dbi = $this->getMockBuilder(DatabaseInterface::class)
 205             ->disableOriginalConstructor()
 206             ->getMock();
 207         $dbi->expects(self::any())
 208             ->method('tryQuery')
 209             ->willReturn(self::createStub(DummyResult::class));
 210         DatabaseInterface::$instance = $dbi;
 211
 212         (new ReflectionProperty(Relation::class, 'cache'))->setValue(null, null);
 213
 214         // Case 1 : no configuration storage
 215         $actual = $this->transformations->clear('db');
 216         self::assertFalse($actual);
 217
 218         $relationParameters = RelationParameters::fromArray([
 219             'db' => 'pmadb',
 220             'mimework' => true,
 221             'column_info' => 'column_info',
 222         ]);
 223         (new ReflectionProperty(Relation::class, 'cache'))->setValue(null, $relationParameters);
 224
 225         // Case 2 : database delete
 226         $actual = $this->transformations->clear('db');
 227         self::assertTrue($actual);
 228
 229         // Case 3 : table delete
 230         $actual = $this->transformations->clear('db', 'table');
 231         self::assertTrue($actual);
 232
 233         // Case 4 : column delete
 234         $actual = $this->transformations->clear('db', 'table', 'col');
 235         self::assertTrue($actual);
 236     }
 237
 238     /**
 239      * @param string $value    value
 240      * @param string $expected expected result
 241      */
 242     #[DataProvider('fixupData')]
 243     public function testFixup(string $value, string $expected): void
 244     {
 245         self::assertSame(
 246             $expected,
 247             $this->transformations->fixUpMime($value),
 248         );
 249     }
 250
 251     /** @return mixed[][] */
 252     public static function fixupData(): array
 253     {
 254         return [
 255             ['text_plain_bool2text.php', 'Text_Plain_Bool2Text.php'],
 256             ['application_octetstream_download.php', 'Application_Octetstream_Download.php'],
 257             ['text_plain_json.php', 'Text_Plain_Json.php'],
 258             ['image_jpeg_link.php', 'Image_JPEG_Link.php'],
 259             ['text_plain_dateformat.php', 'Text_Plain_Dateformat.php'],
 260         ];
 261     }
 262
 263     /**
 264      * Test for getDescription
 265      *
 266      * @param string $file                transformation file
 267      * @param string $expectedDescription expected description
 268      */
 269     #[DataProvider('providerGetDescription')]
 270     public function testGetDescription(string $file, string $expectedDescription): void
 271     {
 272         self::assertSame(
 273             $expectedDescription,
 274             $this->transformations->getDescription($file),
 275         );
 276     }
 277
 278     /** @return mixed[][] */
 279     public static function providerGetDescription(): array
 280     {
 281         return [
 282             ['../../../../test', ''],
 283             ['Input/Text_Plain_SqlEditor', 'Syntax highlighted CodeMirror editor for SQL.'],
 284             ['Output/Text_Plain_Sql', 'Formats text as SQL query with syntax highlighting.'],
 285         ];
 286     }
 287
 288     /**
 289      * Test for getName
 290      *
 291      * @param string $file         transformation file
 292      * @param string $expectedName expected name
 293      */
 294     #[DataProvider('providerGetName')]
 295     public function testGetName(string $file, string $expectedName): void
 296     {
 297         self::assertSame(
 298             $expectedName,
 299             $this->transformations->getName($file),
 300         );
 301     }
 302
 303     /** @return mixed[][] */
 304     public static function providerGetName(): array
 305     {
 306         return [['../../../../test', ''], ['Input/Text_Plain_SqlEditor', 'SQL'], ['Output/Text_Plain_Sql', 'SQL']];
 307     }
 308 }