tests/src/Content/Text/MarkdownTest.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Test\src\Content\Text;
  23
  24 use Exception;
  25 use Friendica\Content\Text\Markdown;
  26 use Friendica\Test\MockedTest;
  27 use Friendica\Test\Util\AppMockTrait;
  28 use Friendica\Test\Util\VFSTrait;
  29
  30 class MarkdownTest extends MockedTest
  31 {
  32         use VFSTrait;
  33         use AppMockTrait;
  34
  35         protected function setUp(): void
  36         {
  37                 parent::setUp();
  38                 $this->setUpVfsDir();
  39                 $this->mockApp($this->root);
  40         }
  41
  42         public function dataMarkdown()
  43         {
  44                 $inputFiles = glob(__DIR__ . '/../../../datasets/content/text/markdown/*.md');
  45
  46                 $data = [];
  47
  48                 foreach ($inputFiles as $file) {
  49                         $data[str_replace('.md', '', $file)] = [
  50                                 'input'    => file_get_contents($file),
  51                                 'expected' => file_get_contents(str_replace('.md', '.html', $file))
  52                         ];
  53                 }
  54
  55                 return $data;
  56         }
  57
  58         /**
  59          * Test convert different input Markdown text into HTML
  60          *
  61          * @dataProvider dataMarkdown
  62          *
  63          * @param string $input    The Markdown text to test
  64          * @param string $expected The expected HTML output
  65          *
  66          * @throws Exception
  67          */
  68         public function testConvert(string $input, string $expected)
  69         {
  70                 $output = Markdown::convert($input);
  71
  72                 self::assertEquals($expected, $output);
  73         }
  74
  75         public function dataMarkdownText()
  76         {
  77                 return [
  78                         'bug-8358-double-decode' => [
  79                                 'expectedBBCode' => 'with the <sup> and </sup> tag',
  80                                 'markdown' => 'with the &lt;sup&gt; and &lt;/sup&gt; tag',
  81                         ],
  82                 ];
  83         }
  84
  85         /**
  86          * Test convert Markdown to BBCode
  87          *
  88          * @dataProvider dataMarkdownText
  89          *
  90          * @param string $expectedBBCode Expected BBCode output
  91          * @param string $html           Markdown text
  92          */
  93         public function testToBBCode(string $expectedBBCode, string $html)
  94         {
  95                 $actual = Markdown::toBBCode($html);
  96
  97                 self::assertEquals($expectedBBCode, $actual);
  98         }
  99 }