mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 21:43:21 +00:00
cb2c96f736
This code was very useful when first implemented to help catch errors where our backend templates didn't render, but has been superceded by the success of our URL coverage testing (which ensures every URL supported by Zulip's urls.py is accessed by our tests, with a few exceptions) and other tests covering all of the emails Zulip sends. It has a significant maintenance cost because it's a bit hacky and involves generating fake context, so it makes sense to remove these. Any future coverage issues with templates should be addressed with a direct test that just accessing the relevant URL or sends the relevant email.
129 lines
4.6 KiB
Python
129 lines
4.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
from django.template.loader import get_template
|
|
|
|
from zerver.lib.exceptions import InvalidMarkdownIncludeStatement
|
|
from zerver.lib.test_classes import (
|
|
ZulipTestCase,
|
|
)
|
|
|
|
|
|
class TemplateTestCase(ZulipTestCase):
|
|
def test_markdown_in_template(self) -> None:
|
|
template = get_template("tests/test_markdown.html")
|
|
context = {
|
|
'markdown_test_file': "zerver/tests/markdown/test_markdown.md"
|
|
}
|
|
content = template.render(context)
|
|
|
|
content_sans_whitespace = content.replace(" ", "").replace('\n', '')
|
|
self.assertEqual(content_sans_whitespace,
|
|
'header<h1id="hello">Hello!</h1><p>Thisissome<em>boldtext</em>.</p>footer')
|
|
|
|
def test_markdown_tabbed_sections_extension(self) -> None:
|
|
template = get_template("tests/test_markdown.html")
|
|
context = {
|
|
'markdown_test_file': "zerver/tests/markdown/test_tabbed_sections.md"
|
|
}
|
|
content = template.render(context)
|
|
content_sans_whitespace = content.replace(" ", "").replace('\n', '')
|
|
|
|
# Note that the expected HTML has a lot of stray <p> tags. This is a
|
|
# consequence of how the Markdown renderer converts newlines to HTML
|
|
# and how elements are delimited by newlines and so forth. However,
|
|
# stray <p> tags are usually matched with closing tags by HTML renderers
|
|
# so this doesn't affect the final rendered UI in any visible way.
|
|
expected_html = """
|
|
header
|
|
|
|
<h1 id="heading">Heading</h1>
|
|
<p>
|
|
<div class="code-section has-tabs" markdown="1">
|
|
<ul class="nav">
|
|
<li data-language="ios">iOS</li>
|
|
<li data-language="desktop-web">Desktop/Web</li>
|
|
</ul>
|
|
<div class="blocks">
|
|
<div data-language="ios" markdown="1"></p>
|
|
<p>iOS instructions</p>
|
|
<p></div>
|
|
<div data-language="desktop-web" markdown="1"></p>
|
|
<p>Desktop/browser instructions</p>
|
|
<p></div>
|
|
</div>
|
|
</div>
|
|
</p>
|
|
|
|
<h2 id="heading-2">Heading 2</h2>
|
|
<p>
|
|
<div class="code-section has-tabs" markdown="1">
|
|
<ul class="nav">
|
|
<li data-language="desktop-web">Desktop/Web</li>
|
|
<li data-language="android">Android</li>
|
|
</ul>
|
|
<div class="blocks">
|
|
<div data-language="desktop-web" markdown="1"></p>
|
|
<p>Desktop/browser instructions</p>
|
|
<p></div>
|
|
<div data-language="android" markdown="1"></p>
|
|
<p>Android instructions</p>
|
|
<p></div>
|
|
</div>
|
|
</div>
|
|
</p>
|
|
|
|
<h2 id="heading-3">Heading 3</h2>
|
|
<p>
|
|
<div class="code-section no-tabs" markdown="1">
|
|
<ul class="nav">
|
|
<li data-language="null_tab">None</li>
|
|
</ul>
|
|
<div class="blocks">
|
|
<div data-language="null_tab" markdown="1"></p>
|
|
<p>Instructions for all platforms</p>
|
|
<p></div>
|
|
</div>
|
|
</div>
|
|
</p>
|
|
|
|
footer
|
|
"""
|
|
|
|
expected_html_sans_whitespace = expected_html.replace(" ", "").replace('\n', '')
|
|
self.assertEqual(content_sans_whitespace,
|
|
expected_html_sans_whitespace)
|
|
|
|
def test_markdown_nested_code_blocks(self) -> None:
|
|
template = get_template("tests/test_markdown.html")
|
|
context = {
|
|
'markdown_test_file': "zerver/tests/markdown/test_nested_code_blocks.md"
|
|
}
|
|
content = template.render(context)
|
|
|
|
content_sans_whitespace = content.replace(" ", "").replace('\n', '')
|
|
expected = ('header<h1id="this-is-a-heading">Thisisaheading.</h1><ol>'
|
|
'<li><p>Alistitemwithanindentedcodeblock:</p><divclass="codehilite">'
|
|
'<pre>indentedcodeblockwithmultiplelines</pre></div></li></ol>'
|
|
'<divclass="codehilite"><pre><span></span>'
|
|
'non-indentedcodeblockwithmultiplelines</pre></div>footer')
|
|
self.assertEqual(content_sans_whitespace, expected)
|
|
|
|
def test_custom_markdown_include_extension(self) -> None:
|
|
template = get_template("tests/test_markdown.html")
|
|
context = {
|
|
'markdown_test_file': "zerver/tests/markdown/test_custom_include_extension.md"
|
|
}
|
|
|
|
with self.assertRaisesRegex(InvalidMarkdownIncludeStatement, "Invalid markdown include statement"):
|
|
template.render(context)
|
|
|
|
def test_custom_markdown_include_extension_empty_macro(self) -> None:
|
|
template = get_template("tests/test_markdown.html")
|
|
context = {
|
|
'markdown_test_file': "zerver/tests/markdown/test_custom_include_extension_empty.md"
|
|
}
|
|
content = template.render(context)
|
|
content_sans_whitespace = content.replace(" ", "").replace('\n', '')
|
|
expected = 'headerfooter'
|
|
self.assertEqual(content_sans_whitespace, expected)
|