tests/unit/ResponseRendererTest.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Tests;
   6
   7 use Fig\Http\Message\StatusCodeInterface;
   8 use PhpMyAdmin\Config;
   9 use PhpMyAdmin\Current;
  10 use PhpMyAdmin\Dbal\DatabaseInterface;
  11 use PhpMyAdmin\Header;
  12 use PhpMyAdmin\Html\MySQLDocumentation;
  13 use PhpMyAdmin\Message;
  14 use PhpMyAdmin\ResponseRenderer;
  15 use PhpMyAdmin\Scripts;
  16 use PhpMyAdmin\Template;
  17 use PHPUnit\Framework\Attributes\CoversClass;
  18 use ReflectionProperty;
  19
  20 use function array_column;
  21 use function json_decode;
  22
  23 #[CoversClass(ResponseRenderer::class)]
  24 final class ResponseRendererTest extends AbstractTestCase
  25 {
  26     protected function setUp(): void
  27     {
  28         parent::setUp();
  29
  30         DatabaseInterface::$instance = $this->createDatabaseInterface();
  31
  32         Current::$lang = 'en';
  33     }
  34
  35     public function testSetAjax(): void
  36     {
  37         $_REQUEST = [];
  38         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
  39         $response = ResponseRenderer::getInstance();
  40         self::assertFalse($response->isAjax());
  41         $response->setAjax(true);
  42         self::assertTrue($response->isAjax());
  43         $response->setAjax(false);
  44         self::assertFalse($response->isAjax());
  45         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
  46     }
  47
  48     public function testAddScriptFiles(): void
  49     {
  50         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
  51         $response = ResponseRenderer::getInstance();
  52         $header = $response->getHeader();
  53         $headerScripts = (new ReflectionProperty(Header::class, 'scripts'))->getValue($header);
  54         self::assertInstanceOf(Scripts::class, $headerScripts);
  55         $files = array_column($headerScripts->getFiles(), 'name');
  56         self::assertNotContains('server/privileges.js', $files);
  57         self::assertNotContains('vendor/zxcvbn-ts.js', $files);
  58
  59         $response->addScriptFiles(['server/privileges.js', 'vendor/zxcvbn-ts.js']);
  60
  61         $files = array_column($headerScripts->getFiles(), 'name');
  62         self::assertContains('server/privileges.js', $files);
  63         self::assertContains('vendor/zxcvbn-ts.js', $files);
  64         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
  65     }
  66
  67     public function testMissingParameterError(): void
  68     {
  69         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
  70         $responseRenderer = ResponseRenderer::getInstance();
  71         $responseRenderer->setAjax(false);
  72
  73         $message = 'Missing parameter: param_name';
  74         $message .= MySQLDocumentation::showDocumentation('faq', 'faqmissingparameters', true);
  75         $message .= '[br]';
  76         $expected = Message::error($message)->getDisplay();
  77
  78         $response = $responseRenderer->missingParameterError('param_name');
  79
  80         self::assertStringContainsString($expected, (string) $response->getBody());
  81         self::assertSame(StatusCodeInterface::STATUS_BAD_REQUEST, $response->getStatusCode());
  82
  83         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
  84     }
  85
  86     public function testHtmlResponse(): void
  87     {
  88         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
  89
  90         $_SERVER['SCRIPT_NAME'] = 'index.php';
  91         Current::$server = 0;
  92         Current::$message = null;
  93
  94         $responseRenderer = ResponseRenderer::getInstance();
  95         $responseRenderer->setAjax(false);
  96         $responseRenderer->addHTML('<div>TEST</div>');
  97
  98         $response = $responseRenderer->response();
  99
 100         self::assertSame(StatusCodeInterface::STATUS_OK, $response->getStatusCode());
 101         self::assertSame('text/html; charset=utf-8', $response->getHeaderLine('Content-Type'));
 102         $header = $responseRenderer->getHeader();
 103         self::assertSame(
 104             (new Template(new Config()))->render('base', [
 105                 'header' => [
 106                     'lang' => 'en',
 107                     'allow_third_party_framing' => false,
 108                     'base_dir' => '',
 109                     'theme_path' => '',
 110                     'server' => 0,
 111                     'title' => 'phpMyAdmin',
 112                     'scripts' => $header->getScripts()->getDisplay(),
 113                     'body_id' => '',
 114                     'navigation' => '',
 115                     'custom_header' => '',
 116                     'load_user_preferences' => '',
 117                     'show_hint' => true,
 118                     'is_warnings_enabled' => true,
 119                     'is_menu_enabled' => true,
 120                     'is_logged_in' => true,
 121                     'menu' => '',
 122                     'console' => $header->getConsole()->getDisplay(),
 123                     'messages' => '',
 124                     'theme_color_mode' => 'light',
 125                     'theme_color_modes' => ['light'],
 126                     'theme_id' => '',
 127                     'current_user' => ['pma_test', 'localhost'],
 128                     'is_mariadb' => false,
 129                 ],
 130                 'content' => '<div>TEST</div>',
 131                 'footer' => [
 132                     'is_minimal' => false,
 133                     'self_url' => 'index.php?route=%2F&server=0&lang=en',
 134                     'error_messages' => '',
 135                     'scripts' => <<<'HTML'
 136
 137                         <script data-cfasync="false">
 138                         // <![CDATA[
 139                         window.Console.debugSqlInfo = 'false';
 140
 141                         // ]]>
 142                         </script>
 143
 144                         HTML,
 145                     'is_demo' => false,
 146                     'git_revision_info' => [],
 147                     'footer' => '',
 148                 ],
 149             ]),
 150             (string) $response->getBody(),
 151         );
 152
 153         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
 154     }
 155
 156     public function testJsonResponse(): void
 157     {
 158         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
 159
 160         $_SERVER['SCRIPT_NAME'] = 'index.php';
 161         Current::$server = 0;
 162         Current::$message = null;
 163
 164         $responseRenderer = ResponseRenderer::getInstance();
 165         $responseRenderer->setAjax(true);
 166         $responseRenderer->addJSON('message', 'test message');
 167         $responseRenderer->addJSON('test', 'test');
 168
 169         $response = $responseRenderer->response();
 170
 171         self::assertSame(StatusCodeInterface::STATUS_OK, $response->getStatusCode());
 172         self::assertSame('application/json; charset=UTF-8', $response->getHeaderLine('Content-Type'));
 173         $body = (string) $response->getBody();
 174         self::assertJson($body);
 175         $header = $responseRenderer->getHeader();
 176         self::assertEquals(
 177             [
 178                 'message' => 'test message',
 179                 'test' => 'test',
 180                 'success' => true,
 181                 'title' => '<title>phpMyAdmin</title>',
 182                 'menu' => $header->getMenu()->getDisplay(),
 183                 'scripts' => $header->getScripts()->getFiles(),
 184                 'selflink' => 'index.php?route=%2F&server=0&lang=en',
 185                 'displayMessage' => '',
 186                 'debug' => "'false'",
 187                 'promptPhpErrors' => false,
 188                 'reloadQuerywindow' => ['db' => '', 'table' => '', 'sql_query' => ''],
 189                 'params' => $header->getJsParams(),
 190             ],
 191             json_decode($body, true),
 192         );
 193
 194         (new ReflectionProperty(ResponseRenderer::class, 'instance'))->setValue(null, null);
 195     }
 196 }