Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/zerver/tests/test_templates.py

131 lines
5.0 KiB
Python
Raw Normal View History

tests: Mock patch print() in test_custom_markdown_include_extension. This is to avoid spam in test-backend output.
2020-07-22 21:02:31 +02:00
from unittest.mock import MagicMock, call, patch
Do shallow testing of backend templates. Just render the templates without the actual workflow to see if they don't return a 500 error; this lets us catch various classes of template bugs automatically. Fixes #784.
2016-05-24 14:06:34 +02:00
from django.template.loader import get_template
test_templates: Add a verbose error messages for rendering failures. If a template fails to render in test_templates because of a missing context variable, we should better explain the reason for the failure.
2019-08-10 18:24:59 +02:00
bugdown: Trigger test failure for invalid Markdown include statements. This commit adds a custom Markdown include extension which is identical to the original except when a macro file can't be found, it raises a custom JsonableError exception, which we can catch and then trigger an appropriate test failure. Fixes: #10947
2018-12-23 00:13:57 +01:00
from zerver.lib.exceptions import InvalidMarkdownIncludeStatement
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-11 00:54:34 +02:00
from zerver.lib.test_classes import ZulipTestCase
Do shallow testing of backend templates. Just render the templates without the actual workflow to see if they don't return a 500 error; this lets us catch various classes of template bugs automatically. Fixes #784.
2016-05-24 14:06:34 +02:00
tests: Renamed AuthedTestCase to ZulipTestCase.
2016-08-23 02:08:42 +02:00
class TemplateTestCase(ZulipTestCase):
zerver/tests: Use python 3 syntax for typing in most files.
2017-11-05 10:51:25 +01:00
def test_markdown_in_template(self) -> None:
Add TERMS_OF_SERVICE setting. This new setting allows the server administrator to add a custom Terms of Service page by supplying the path to a markdown file. Also adds a test.
2016-05-11 19:01:53 +02:00
template = get_template("tests/test_markdown.html")
context = {
python: Use trailing commas consistently. Automatically generated by the following script, based on the output of lint with flake8-comma: import re import sys last_filename = None last_row = None lines = [] for msg in sys.stdin: m = re.match( r"\x1b\[35mflake8 \|\x1b\[0m \x1b\[1;31m(.+):(\d+):(\d+): (\w+)", msg ) if m: filename, row_str, col_str, err = m.groups() row, col = int(row_str), int(col_str) if filename == last_filename: assert last_row != row else: if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) with open(filename) as f: lines = f.readlines() last_filename = filename last_row = row line = lines[row - 1] if err in ["C812", "C815"]: lines[row - 1] = line[: col - 1] + "," + line[col - 1 :] elif err in ["C819"]: assert line[col - 2] == "," lines[row - 1] = line[: col - 2] + line[col - 1 :].lstrip(" ") if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-10 05:23:40 +02:00
'markdown_test_file': "zerver/tests/markdown/test_markdown.md",
Add TERMS_OF_SERVICE setting. This new setting allows the server administrator to add a custom Terms of Service page by supplying the path to a markdown file. Also adds a test.
2016-05-11 19:01:53 +02:00
}
content = template.render(context)
content_sans_whitespace = content.replace(" ", "").replace('\n', '')
self.assertEqual(content_sans_whitespace,
render_markdown_path: Add anchors for table-of-contents.
2016-11-09 21:52:42 +01:00
'header<h1id="hello">Hello!</h1><p>Thisissome<em>boldtext</em>.</p>footer')
Move Zulip's TOS to TERMS_OF_SERVICE markdown file. This reimplements zulip.com/terms using the new markdown system.
2016-05-11 19:29:29 +02:00
markdown: Add extension for creating tabbed sections on /help and /api.
2018-09-07 00:09:51 +02:00
def test_markdown_tabbed_sections_extension(self) -> None:
template = get_template("tests/test_markdown.html")
context = {
python: Use trailing commas consistently. Automatically generated by the following script, based on the output of lint with flake8-comma: import re import sys last_filename = None last_row = None lines = [] for msg in sys.stdin: m = re.match( r"\x1b\[35mflake8 \|\x1b\[0m \x1b\[1;31m(.+):(\d+):(\d+): (\w+)", msg ) if m: filename, row_str, col_str, err = m.groups() row, col = int(row_str), int(col_str) if filename == last_filename: assert last_row != row else: if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) with open(filename) as f: lines = f.readlines() last_filename = filename last_row = row line = lines[row - 1] if err in ["C812", "C815"]: lines[row - 1] = line[: col - 1] + "," + line[col - 1 :] elif err in ["C819"]: assert line[col - 2] == "," lines[row - 1] = line[: col - 2] + line[col - 1 :].lstrip(" ") if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-10 05:23:40 +02:00
'markdown_test_file': "zerver/tests/markdown/test_tabbed_sections.md",
markdown: Add extension for creating tabbed sections on /help and /api.
2018-09-07 00:09:51 +02:00
}
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>
help: Add tab styling to untabbed instructions as well. This changes the border-radius to 6px for the tabbed display, which is not in line with the current Zulip style for border-radius (4px). However 6px really looks a lot better for this (possibly because it's a bigger box than most of our other boxes?)
2019-02-08 04:55:50 +01:00
<div class="code-section has-tabs" markdown="1">
markdown: Add extension for creating tabbed sections on /help and /api.
2018-09-07 00:09:51 +02:00
<ul class="nav">
docs: Make tabbed sections accessible from keyboard. Part of #15948.
2020-07-29 12:54:39 +02:00
<li data-language="ios" tabindex="0">iOS</li>
<li data-language="desktop-web" tabindex="0">Desktop/Web</li>
markdown: Add extension for creating tabbed sections on /help and /api.
2018-09-07 00:09:51 +02:00
</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>
help: Add tab styling to untabbed instructions as well. This changes the border-radius to 6px for the tabbed display, which is not in line with the current Zulip style for border-radius (4px). However 6px really looks a lot better for this (possibly because it's a bigger box than most of our other boxes?)
2019-02-08 04:55:50 +01:00
<div class="code-section has-tabs" markdown="1">
markdown: Add extension for creating tabbed sections on /help and /api.
2018-09-07 00:09:51 +02:00
<ul class="nav">
docs: Make tabbed sections accessible from keyboard. Part of #15948.
2020-07-29 12:54:39 +02:00
<li data-language="desktop-web" tabindex="0">Desktop/Web</li>
<li data-language="android" tabindex="0">Android</li>
markdown: Add extension for creating tabbed sections on /help and /api.
2018-09-07 00:09:51 +02:00
</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>
help: Add tab styling to untabbed instructions as well. This changes the border-radius to 6px for the tabbed display, which is not in line with the current Zulip style for border-radius (4px). However 6px really looks a lot better for this (possibly because it's a bigger box than most of our other boxes?)
2019-02-08 04:55:50 +01:00
<h2 id="heading-3">Heading 3</h2>
<p>
<div class="code-section no-tabs" markdown="1">
<ul class="nav">
docs: Make tabbed sections accessible from keyboard. Part of #15948.
2020-07-29 12:54:39 +02:00
<li data-language="null_tab" tabindex="0">None</li>
help: Add tab styling to untabbed instructions as well. This changes the border-radius to 6px for the tabbed display, which is not in line with the current Zulip style for border-radius (4px). However 6px really looks a lot better for this (possibly because it's a bigger box than most of our other boxes?)
2019-02-08 04:55:50 +01:00
</ul>
<div class="blocks">
<div data-language="null_tab" markdown="1"></p>
<p>Instructions for all platforms</p>
<p></div>
</div>
</div>
</p>
markdown: Add extension for creating tabbed sections on /help and /api.
2018-09-07 00:09:51 +02:00
footer
"""
expected_html_sans_whitespace = expected_html.replace(" ", "").replace('\n', '')
self.assertEqual(content_sans_whitespace,
expected_html_sans_whitespace)
markdown: Render nested multi-line code blocks correctly. This commit adds a Markdown tree-processor extension that renders multi-line code blocks that are nested inside lists with the formatting. Note that the code block could be nested inside multiple list levels and would still get rendered correctly. Tim: This fixes the need for unpleasant workarounds like f5bfa4e793fa38e8649a43eac88d8053a29f04cd and makes nested code blocks in our documentation look exactly how users would expect them to.
2018-07-07 22:14:30 +02:00
def test_markdown_nested_code_blocks(self) -> None:
template = get_template("tests/test_markdown.html")
context = {
python: Use trailing commas consistently. Automatically generated by the following script, based on the output of lint with flake8-comma: import re import sys last_filename = None last_row = None lines = [] for msg in sys.stdin: m = re.match( r"\x1b\[35mflake8 \|\x1b\[0m \x1b\[1;31m(.+):(\d+):(\d+): (\w+)", msg ) if m: filename, row_str, col_str, err = m.groups() row, col = int(row_str), int(col_str) if filename == last_filename: assert last_row != row else: if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) with open(filename) as f: lines = f.readlines() last_filename = filename last_row = row line = lines[row - 1] if err in ["C812", "C815"]: lines[row - 1] = line[: col - 1] + "," + line[col - 1 :] elif err in ["C819"]: assert line[col - 2] == "," lines[row - 1] = line[: col - 2] + line[col - 1 :].lstrip(" ") if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-10 05:23:40 +02:00
'markdown_test_file': "zerver/tests/markdown/test_nested_code_blocks.md",
markdown: Render nested multi-line code blocks correctly. This commit adds a Markdown tree-processor extension that renders multi-line code blocks that are nested inside lists with the formatting. Note that the code block could be nested inside multiple list levels and would still get rendered correctly. Tim: This fixes the need for unpleasant workarounds like f5bfa4e793fa38e8649a43eac88d8053a29f04cd and makes nested code blocks in our documentation look exactly how users would expect them to.
2018-07-07 22:14:30 +02:00
}
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>'
requirements: Upgrade Python-Markdown from 3.1.1 to 3.2.1. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-18 03:17:21 +02:00
'<divclass="codehilite"><pre><span></span><code>'
'non-indentedcodeblockwithmultiplelines</code></pre></div>footer')
markdown: Render nested multi-line code blocks correctly. This commit adds a Markdown tree-processor extension that renders multi-line code blocks that are nested inside lists with the formatting. Note that the code block could be nested inside multiple list levels and would still get rendered correctly. Tim: This fixes the need for unpleasant workarounds like f5bfa4e793fa38e8649a43eac88d8053a29f04cd and makes nested code blocks in our documentation look exactly how users would expect them to.
2018-07-07 22:14:30 +02:00
self.assertEqual(content_sans_whitespace, expected)
tests: Mock patch print() in test_custom_markdown_include_extension. This is to avoid spam in test-backend output.
2020-07-22 21:02:31 +02:00
@patch('builtins.print')
def test_custom_markdown_include_extension(self, mock_print: MagicMock) -> None:
bugdown: Trigger test failure for invalid Markdown include statements. This commit adds a custom Markdown include extension which is identical to the original except when a macro file can't be found, it raises a custom JsonableError exception, which we can catch and then trigger an appropriate test failure. Fixes: #10947
2018-12-23 00:13:57 +01:00
template = get_template("tests/test_markdown.html")
context = {
python: Use trailing commas consistently. Automatically generated by the following script, based on the output of lint with flake8-comma: import re import sys last_filename = None last_row = None lines = [] for msg in sys.stdin: m = re.match( r"\x1b\[35mflake8 \|\x1b\[0m \x1b\[1;31m(.+):(\d+):(\d+): (\w+)", msg ) if m: filename, row_str, col_str, err = m.groups() row, col = int(row_str), int(col_str) if filename == last_filename: assert last_row != row else: if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) with open(filename) as f: lines = f.readlines() last_filename = filename last_row = row line = lines[row - 1] if err in ["C812", "C815"]: lines[row - 1] = line[: col - 1] + "," + line[col - 1 :] elif err in ["C819"]: assert line[col - 2] == "," lines[row - 1] = line[: col - 2] + line[col - 1 :].lstrip(" ") if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-10 05:23:40 +02:00
'markdown_test_file': "zerver/tests/markdown/test_custom_include_extension.md",
bugdown: Trigger test failure for invalid Markdown include statements. This commit adds a custom Markdown include extension which is identical to the original except when a macro file can't be found, it raises a custom JsonableError exception, which we can catch and then trigger an appropriate test failure. Fixes: #10947
2018-12-23 00:13:57 +01:00
}
docs: Capitalize Markdown consistently. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 01:47:49 +02:00
with self.assertRaisesRegex(InvalidMarkdownIncludeStatement, "Invalid Markdown include statement"):
bugdown: Trigger test failure for invalid Markdown include statements. This commit adds a custom Markdown include extension which is identical to the original except when a macro file can't be found, it raises a custom JsonableError exception, which we can catch and then trigger an appropriate test failure. Fixes: #10947
2018-12-23 00:13:57 +01:00
template.render(context)
tests: Mock patch print() in test_custom_markdown_include_extension. This is to avoid spam in test-backend output.
2020-07-22 21:02:31 +02:00
self.assertEqual(mock_print.mock_calls, [
call("Warning: could not find file templates/zerver/help/include/nonexistent-macro.md. Error: [Errno 2] No such file or directory: 'templates/zerver/help/include/nonexistent-macro.md'")
])
bugdown: Trigger test failure for invalid Markdown include statements. This commit adds a custom Markdown include extension which is identical to the original except when a macro file can't be found, it raises a custom JsonableError exception, which we can catch and then trigger an appropriate test failure. Fixes: #10947
2018-12-23 00:13:57 +01:00
def test_custom_markdown_include_extension_empty_macro(self) -> None:
template = get_template("tests/test_markdown.html")
context = {
python: Use trailing commas consistently. Automatically generated by the following script, based on the output of lint with flake8-comma: import re import sys last_filename = None last_row = None lines = [] for msg in sys.stdin: m = re.match( r"\x1b\[35mflake8 \|\x1b\[0m \x1b\[1;31m(.+):(\d+):(\d+): (\w+)", msg ) if m: filename, row_str, col_str, err = m.groups() row, col = int(row_str), int(col_str) if filename == last_filename: assert last_row != row else: if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) with open(filename) as f: lines = f.readlines() last_filename = filename last_row = row line = lines[row - 1] if err in ["C812", "C815"]: lines[row - 1] = line[: col - 1] + "," + line[col - 1 :] elif err in ["C819"]: assert line[col - 2] == "," lines[row - 1] = line[: col - 2] + line[col - 1 :].lstrip(" ") if last_filename is not None: with open(last_filename, "w") as f: f.writelines(lines) Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-10 05:23:40 +02:00
'markdown_test_file': "zerver/tests/markdown/test_custom_include_extension_empty.md",
bugdown: Trigger test failure for invalid Markdown include statements. This commit adds a custom Markdown include extension which is identical to the original except when a macro file can't be found, it raises a custom JsonableError exception, which we can catch and then trigger an appropriate test failure. Fixes: #10947
2018-12-23 00:13:57 +01:00
}
content = template.render(context)
content_sans_whitespace = content.replace(" ", "").replace('\n', '')
expected = 'headerfooter'
self.assertEqual(content_sans_whitespace, expected)