DebugUtilityTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\Utility;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Utility\DebugUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪DebugUtilityTest extends UnitTestCase
{
    protected function ‪tearDown(): void
    {
        parent::tearDown();
        ‪DebugUtility::usePlainTextOutput(true);
        ‪DebugUtility::useAnsiColor(true);
    }
 
    #[Test]
    public function ‪debugNotEncodesHtmlInputIfPlainText(): void
    {
        ‪DebugUtility::usePlainTextOutput(true);
        ‪DebugUtility::useAnsiColor(false);
 
        ob_start();
        ‪DebugUtility::debug('<script>alert(\'Hello world!\')</script>');
        ‪$output = ob_get_contents();
        ob_end_clean();
 
        self::assertStringContainsString(
            '<script>alert(\'Hello world!\')</script>',
            ‪$output
        );
    }
 
    #[Test]
    public function ‪debugEncodesHtmlInputIfNoPlainText(): void
    {
        ‪DebugUtility::usePlainTextOutput(false);
        ‪DebugUtility::useAnsiColor(false);
 
        ob_start();
        ‪DebugUtility::debug('<script>alert(\'Hello world!\')</script>');
        ‪$output = ob_get_contents();
        ob_end_clean();
 
        self::assertStringContainsString(
            '&lt;script&gt;alert(\'Hello world!\')&lt;/script&gt;',
            ‪$output
        );
    }
 
    public static function ‪convertVariableToStringReturnsVariableContentDataProvider(): array
    {
        $object = new \stdClass();
        $object->foo = 42;
        $object->bar = ['baz'];
 
        return [
            'Debug string' => [
                'Hello world!',
                '"Hello world!" (12 chars)',
            ],
            'Debug array' => [
                [
                    'foo',
                    'bar',
                    'baz' => [
                        42,
                    ],
                ],
                'array(3 items)' . PHP_EOL
                    . '   0 => "foo" (3 chars)' . PHP_EOL
                    . '   1 => "bar" (3 chars)' . PHP_EOL
                    . '   baz => array(1 item)' . PHP_EOL
                    . '      0 => 42 (integer)',
            ],
            'Debug object' => [
                $object,
                'stdClass prototype object' . PHP_EOL
                    . '   foo => public 42 (integer)' . PHP_EOL
                    . '   bar => public array(1 item)' . PHP_EOL
                    . '      0 => "baz" (3 chars)',
            ],
        ];
    }
 
    #[DataProvider('convertVariableToStringReturnsVariableContentDataProvider')]
    #[Test]
    public function ‪convertVariableToStringReturnsVariableContent($variable, string $expected): void
    {
        self::assertSame($expected, ‪DebugUtility::convertVariableToString($variable));
    }
}