test/classes/TemplateTest.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Tests;
   6
   7 use PhpMyAdmin\Template;
   8 use PhpMyAdmin\Twig\Extensions\Node\TransNode;
   9 use Twig\Error\LoaderError;
  10
  11 /**
  12  * @covers \PhpMyAdmin\Template
  13  */
  14 class TemplateTest extends AbstractTestCase
  15 {
  16     /** @var Template */
  17     protected $template;
  18
  19     /**
  20      * Sets up the fixture.
  21      */
  22     protected function setUp(): void
  23     {
  24         parent::setUp();
  25         $this->template = new Template();
  26     }
  27
  28     /**
  29      * Test that Twig Environment can be built
  30      * and that all Twig extensions are loaded
  31      */
  32     public function testGetTwigEnvironment(): void
  33     {
  34         global $cfg;
  35
  36         $this->loadContainerBuilder();
  37
  38         $cfg['environment'] = 'production';
  39         $twig = Template::getTwigEnvironment(null);
  40         $this->assertFalse($twig->isDebug());
  41         $this->assertFalse(TransNode::$enableAddDebugInfo);
  42         $cfg['environment'] = 'development';
  43         $twig = Template::getTwigEnvironment(null);
  44         $this->assertTrue($twig->isDebug());
  45         $this->assertTrue(TransNode::$enableAddDebugInfo);
  46     }
  47
  48     /**
  49      * Test for set function
  50      *
  51      * @param string $data Template name
  52      *
  53      * @dataProvider providerTestSet
  54      */
  55     public function testSet(string $data): void
  56     {
  57         $result = $this->template->render($data, [
  58             'variable1' => 'value1',
  59             'variable2' => 'value2',
  60         ]);
  61         $this->assertStringContainsString('value1', $result);
  62         $this->assertStringContainsString('value2', $result);
  63     }
  64
  65     /**
  66      * Data provider for testSet
  67      *
  68      * @return array
  69      */
  70     public function providerTestSet(): array
  71     {
  72         return [
  73             ['test/add_data'],
  74         ];
  75     }
  76
  77     /**
  78      * Test for render
  79      *
  80      * @param string $templateFile Template name
  81      * @param string $key          Template variable array key
  82      * @param string $value        Template variable array value
  83      *
  84      * @dataProvider providerTestDynamicRender
  85      */
  86     public function testDynamicRender(string $templateFile, string $key, string $value): void
  87     {
  88         $this->assertEquals(
  89             $value,
  90             $this->template->render($templateFile, [$key => $value])
  91         );
  92     }
  93
  94     /**
  95      * Data provider for testDynamicRender
  96      *
  97      * @return array
  98      */
  99     public function providerTestDynamicRender(): array
 100     {
 101         return [
 102             [
 103                 'test/echo',
 104                 'variable',
 105                 'value',
 106             ],
 107         ];
 108     }
 109
 110     /**
 111      * Test for render
 112      */
 113     public function testRenderTemplateNotFound(): void
 114     {
 115         $this->expectException(LoaderError::class);
 116         $this->template->render('template not found');
 117     }
 118
 119     /**
 120      * Test for render
 121      *
 122      * @param string $templateFile   Template name
 123      * @param string $expectedResult Expected result
 124      *
 125      * @dataProvider providerTestRender
 126      */
 127     public function testRender(string $templateFile, string $expectedResult): void
 128     {
 129         $this->assertEquals(
 130             $expectedResult,
 131             $this->template->render($templateFile)
 132         );
 133     }
 134
 135     /**
 136      * Data provider for testSet
 137      *
 138      * @return array
 139      */
 140     public function providerTestRender(): array
 141     {
 142         return [
 143             [
 144                 'test/static',
 145                 'static content',
 146             ],
 147         ];
 148     }
 149
 150     /**
 151      * Test for render
 152      *
 153      * @param string $templateFile   Template name
 154      * @param array  $renderParams   Render params
 155      * @param string $expectedResult Expected result
 156      *
 157      * @dataProvider providerTestRenderGettext
 158      */
 159     public function testRenderGettext(string $templateFile, array $renderParams, string $expectedResult): void
 160     {
 161         $this->assertEquals(
 162             $expectedResult,
 163             $this->template->render($templateFile, $renderParams)
 164         );
 165     }
 166
 167     /**
 168      * Data provider for testRenderGettext
 169      *
 170      * @return array
 171      */
 172     public function providerTestRenderGettext(): array
 173     {
 174         return [
 175             [
 176                 'test/gettext/gettext',
 177                 [],
 178                 'Text',
 179             ],
 180             [
 181                 'test/gettext/pgettext',
 182                 [],
 183                 'Text',
 184             ],
 185             [
 186                 'test/gettext/notes',
 187                 [],
 188                 'Text',
 189             ],
 190             [
 191                 'test/gettext/plural',
 192                 ['table_count' => 1],
 193                 'One table',
 194             ],
 195             [
 196                 'test/gettext/plural',
 197                 ['table_count' => 2],
 198                 '2 tables',
 199             ],
 200             [
 201                 'test/gettext/plural_notes',
 202                 ['table_count' => 1],
 203                 'One table',
 204             ],
 205             [
 206                 'test/gettext/plural_notes',
 207                 ['table_count' => 2],
 208                 '2 tables',
 209             ],
 210         ];
 211     }
 212 }