MarkdownFormattingToHTMLTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\src\Refinery\String;

use ILIAS\Data\Factory;
use ILIAS\Refinery\String\Group;
use PHPUnit\Framework\TestCase;
use ILIAS\Language\Language;
use ILIAS\Refinery\Transformation;
use PHPUnit\Framework\Attributes\DataProvider;

class MarkdownFormattingToHTMLTest extends TestCase
{
    private Transformation $markdown;
    private Transformation $markdown_with_escaped_html;

    protected function setUp(): void
    {
        $language = $this->getMockBuilder(Language::class)
                         ->disableOriginalConstructor()
                         ->getMock();
        $group = new Group(new Factory(), $language);

        $this->markdown = $group->markdown(false)->toHTML();
        $this->markdown_with_escaped_html = $group->markdown()->toHTML();
    }

    public static function stringProvider(): array
    {
        return [
            ["lorem", "<p>lorem</p>\n"],
            ["lorem **ipsum**", "<p>lorem <strong>ipsum</strong></p>\n"],
            ["_lorem_ **ipsum**", "<p><em>lorem</em> <strong>ipsum</strong></p>\n"],
            ["# Headline", "<h1>Headline</h1>\n"],
            ["## Headline", "<h2>Headline</h2>\n"],
            ["### Headline", "<h3>Headline</h3>\n"],
            ["1. Lorem\n2. Ipsum", "<ol>\n<li>Lorem</li>\n<li>Ipsum</li>\n</ol>\n"],
            ["- Lorem\n- Ipsum", "<ul>\n<li>Lorem</li>\n<li>Ipsum</li>\n</ul>\n"],
            ["[Link Titel](https://www.ilias.de)", "<p><a href=\"https://www.ilias.de\">Link Titel</a></p>\n"],
        ];
    }

    #[DataProvider('stringProvider')]
    public function testTransformationToHTML(
        string $markdown_string,
        string $expected_html,
    ): void {
        $this->assertEquals($expected_html, $this->markdown->transform($markdown_string));
    }

    public function testHtmlInputIsRendered(): void
    {
        $markdown_with_html = "lorem **ipsum**\n<ul><li>phpunit</li></ul>";

        $expected = "<p>lorem <strong>ipsum</strong></p>\n<ul><li>phpunit</li></ul>\n";

        $this->assertSame($expected, $this->markdown->transform($markdown_with_html));
    }

    public function testUntrustedLinksAreRemoved(): void
    {
        $markdown_with_html = "lorem **ipsum**\n[xss](javascript:alert(1))";

        $expected = "<p>lorem <strong>ipsum</strong>\n<a>xss</a></p>\n";

        $this->assertSame($expected, $this->markdown->transform($markdown_with_html));
    }

    public function testHtmlInputIsEscapedIfDesired(): void
    {
        $markdown_with_html = "lorem **ipsum**\n<ul><li>phpunit</li></ul>";

        $expected = "<p>lorem <strong>ipsum</strong></p>\n&lt;ul&gt;&lt;li&gt;phpunit&lt;/li&gt;&lt;/ul&gt;\n";

        $this->assertSame($expected, $this->markdown_with_escaped_html->transform($markdown_with_html));
    }
}