2 use Shaarli\Config\ConfigManager
;
5 * PluginMarkdownTest.php
8 require_once 'application/Utils.php';
9 require_once 'plugins/markdown/markdown.php';
12 * Class PluginMarkdownTest
13 * Unit test for the Markdown plugin
15 class PluginMarkdownTest
extends PHPUnit_Framework_TestCase
18 * @var ConfigManager instance.
25 public function setUp()
27 PluginManager
::$PLUGINS_PATH = 'plugins';
28 $this->conf
= new ConfigManager('tests/utils/config/configJson');
29 $this->conf
->set('security.allowed_protocols', ['ftp', 'magnet']);
33 * Test render_linklist hook.
34 * Only check that there is basic markdown rendering.
36 public function testMarkdownLinklist()
38 $markdown = '# My title' . PHP_EOL
. 'Very interesting content.';
42 'description' => $markdown,
47 $data = hook_markdown_render_linklist($data, $this->conf
);
48 $this->assertNotFalse(strpos($data['links'][0]['description'], '<h1>'));
49 $this->assertNotFalse(strpos($data['links'][0]['description'], '<p>'));
53 * Test render_feed hook.
55 public function testMarkdownFeed()
57 $markdown = '# My title' . PHP_EOL
. 'Very interesting content.';
58 $markdown .= '— <a href="http://domain.tld/?0oc_VQ" title="Permalien">Permalien</a>';
62 'description' => $markdown,
67 $data = hook_markdown_render_feed($data, $this->conf
);
68 $this->assertNotFalse(strpos($data['links'][0]['description'], '<h1>'));
69 $this->assertNotFalse(strpos($data['links'][0]['description'], '<p>'));
70 $this->assertStringEndsWith(
71 '— <a href="http://domain.tld/?0oc_VQ">Permalien</a></p></div>',
72 $data['links'][0]['description']
77 * Test render_daily hook.
78 * Only check that there is basic markdown rendering.
80 public function testMarkdownDaily()
82 $markdown = '# My title' . PHP_EOL
. 'Very interesting content.';
85 'linksToDisplay' => array(
88 'formatedDescription' => $markdown,
93 $data = hook_markdown_render_daily($data, $this->conf
);
94 $this->assertNotFalse(strpos($data['linksToDisplay'][0]['formatedDescription'], '<h1>'));
95 $this->assertNotFalse(strpos($data['linksToDisplay'][0]['formatedDescription'], '<p>'));
99 * Test reverse_text2clickable().
101 public function testReverseText2clickable()
103 $text = 'stuff http://hello.there/is=someone#here otherstuff';
104 $clickableText = text2clickable($text, '');
105 $reversedText = reverse_text2clickable($clickableText);
106 $this->assertEquals($text, $reversedText);
110 * Test reverse_nl2br().
112 public function testReverseNl2br()
114 $text = 'stuff' . PHP_EOL
. 'otherstuff';
115 $processedText = nl2br($text);
116 $reversedText = reverse_nl2br($processedText);
117 $this->assertEquals($text, $reversedText);
121 * Test reverse_space2nbsp().
123 public function testReverseSpace2nbsp()
125 $text = ' stuff' . PHP_EOL
. ' otherstuff and another';
126 $processedText = space2nbsp($text);
127 $reversedText = reverse_space2nbsp($processedText);
128 $this->assertEquals($text, $reversedText);
131 public function testReverseFeedPermalink()
133 $text = 'Description... ';
134 $text .= '— <a href="http://domain.tld/?0oc_VQ" title="Permalien">Permalien</a>';
135 $expected = 'Description... — [Permalien](http://domain.tld/?0oc_VQ)';
136 $processedText = reverse_feed_permalink($text);
138 $this->assertEquals($expected, $processedText);
141 public function testReverseLastFeedPermalink()
143 $text = 'Description... ';
144 $text .= '<br>— <a href="http://domain.tld/?0oc_VQ" title="Permalien">Permalien</a>';
146 $text .= '<br>— <a href="http://domain.tld/?0oc_VQ" title="Permalien">Permalien</a>';
147 $expected .= '<br>— [Permalien](http://domain.tld/?0oc_VQ)';
148 $processedText = reverse_feed_permalink($text);
150 $this->assertEquals($expected, $processedText);
153 public function testReverseNoFeedPermalink()
155 $text = 'Hello! Where are you from?';
157 $processedText = reverse_feed_permalink($text);
159 $this->assertEquals($expected, $processedText);
163 * Test sanitize_html().
165 public function testSanitizeHtml()
167 $input = '< script src="js.js"/>';
168 $input .= '< script attr>alert(\'xss\');</script>';
169 $input .= '<style> * { display: none }</style>';
170 $output = escape($input);
171 $input .= '<a href="#" onmouseHover="alert(\'xss\');" attr="tt">link</a>';
172 $output .= '<a href="#" attr="tt">link</a>';
173 $input .= '<a href="#" onmouseHover=alert(\'xss\'); attr="tt">link</a>';
174 $output .= '<a href="#" attr="tt">link</a>';
175 $this->assertEquals($output, sanitize_html($input));
176 // Do not touch escaped HTML.
177 $input = escape($input);
178 $this->assertEquals($input, sanitize_html($input));
182 * Test the no markdown tag.
184 public function testNoMarkdownTag()
186 $str = 'All _work_ and `no play` makes Jack a *dull* boy.';
188 'links' => array(array(
189 'description' => $str,
191 'taglist' => array(NO_MD_TAG
),
195 $processed = hook_markdown_render_linklist($data, $this->conf
);
196 $this->assertEquals($str, $processed['links'][0]['description']);
198 $processed = hook_markdown_render_feed($data, $this->conf
);
199 $this->assertEquals($str, $processed['links'][0]['description']);
203 'linksToDisplay' => array(
206 'formatedDescription' => $str,
208 'taglist' => array(),
213 $data = hook_markdown_render_daily($data, $this->conf
);
214 $this->assertEquals($str, $data['linksToDisplay'][0]['formatedDescription']);
218 * Test that a close value to nomarkdown is not understand as nomarkdown (previous value `.nomarkdown`).
220 public function testNoMarkdownNotExcactlyMatching()
222 $str = 'All _work_ and `no play` makes Jack a *dull* boy.';
224 'links' => array(array(
225 'description' => $str,
226 'tags' => '.' . NO_MD_TAG
,
227 'taglist' => array('.'. NO_MD_TAG
),
231 $data = hook_markdown_render_feed($data, $this->conf
);
232 $this->assertContains('<em>', $data['links'][0]['description']);
236 * Make sure that the generated HTML match the reference HTML file.
238 public function testMarkdownGlobalProcessDescription()
240 $md = file_get_contents('tests/plugins/resources/markdown.md');
241 $md = format_description($md);
242 $html = file_get_contents('tests/plugins/resources/markdown.html');
244 $data = process_markdown(
246 $this->conf
->get('security.markdown_escape', true),
247 $this->conf
->get('security.allowed_protocols')
249 $this->assertEquals($html, $data);
253 * Make sure that the HTML tags are escaped.
255 public function testMarkdownWithHtmlEscape()
257 $md = '**strong** <strong>strong</strong>';
258 $html = '<div class="markdown"><p><strong>strong</strong> <strong>strong</strong></p></div>';
262 'description' => $md,
266 $data = hook_markdown_render_linklist($data, $this->conf
);
267 $this->assertEquals($html, $data['links'][0]['description']);
271 * Make sure that the HTML tags aren't escaped with the setting set to false.
273 public function testMarkdownWithHtmlNoEscape()
275 $this->conf
->set('security.markdown_escape', false);
276 $md = '**strong** <strong>strong</strong>';
277 $html = '<div class="markdown"><p><strong>strong</strong> <strong>strong</strong></p></div>';
281 'description' => $md,
285 $data = hook_markdown_render_linklist($data, $this->conf
);
286 $this->assertEquals($html, $data['links'][0]['description']);