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

140 lines
5.8 KiB
Python
Raw Normal View History

Lint for duplicate ids in templates. In this commit we enhance our current template linter to detect duplicate ids and report them during lint checks. html_branches.py was topped up with a new function build_id_dict for the purpose. Also the get_tag_info function in same file was updated to parse ids and classes more robustly in cases of template variables. split_for_id_and_class function was added to serve this purpose. Unit tests for both the functions were created under tests/test_html_branches. Also a directory under tests called test_template_data was created to hold templates for testing under newly created functionality. check_templates was modified to print to console any duplicates detected. showell reviewed my commit and helped me out. Fixes #2950.
2017-01-06 15:11:15 +01:00
import os
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
import unittest
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
import tools.lib.template_parser
from tools.lib.html_branches import (
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
build_id_dict,
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
get_tag_info,
html_branches,
html_tag_tree,
Lint for duplicate ids in templates. In this commit we enhance our current template linter to detect duplicate ids and report them during lint checks. html_branches.py was topped up with a new function build_id_dict for the purpose. Also the get_tag_info function in same file was updated to parse ids and classes more robustly in cases of template variables. split_for_id_and_class function was added to serve this purpose. Unit tests for both the functions were created under tests/test_html_branches. Also a directory under tests called test_template_data was created to hold templates for testing under newly created functionality. check_templates was modified to print to console any duplicates detected. showell reviewed my commit and helped me out. Fixes #2950.
2017-01-06 15:11:15 +01:00
split_for_id_and_class,
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
)
tools: Fix regressions in tools/tests/test_html_branches.py
2017-01-18 22:04:32 +01:00
ZULIP_PATH = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
TEST_TEMPLATES_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "test_template_data")
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
class TestHtmlBranches(unittest.TestCase):
tools/tests: Use Python 3 syntax for typing.
2017-12-13 06:45:46 +01:00
def test_get_tag_info(self) -> None:
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
html = """
<p id="test" class="test1 test2">foo</p>
"""
start_tag, end_tag = tools.lib.template_parser.tokenize(html)
start_tag_info = get_tag_info(start_tag)
end_tag_info = get_tag_info(end_tag)
self.assertEqual(start_tag_info.text(), 'p.test1.test2#test')
self.assertEqual(end_tag_info.text(), 'p')
tools/tests: Use Python 3 syntax for typing.
2017-12-13 06:45:46 +01:00
def test_html_tag_tree(self) -> None:
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
html = """
<!-- test -->
<!DOCTYPE html>
<html>
<!-- test -->
<head>
<title>Test</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="style.css" />
</head>
<body>
check-templates: Be stricter about singleton tags. We now forbid tags of the form `<foo ... />` in most places, and we also forbid it even for several void tags. We make exceptions for tags that are already formatted in two different ways in our codebase. This is mostly svg tags, plus these common cases: - br - hr - img - input It would be nice to lock down a convention for these, even though the HTML specification is unopinionated on these. We'll probably want to stay flexible for svg tags, since they are sometimes copy/pasted from other sources (although it's probably rare enough for them that we can tolerate just doing minor edits as needed).
2020-04-18 11:38:31 +02:00
<p>Hello<br>world!</p>
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
<p>Goodbye<!-- test -->world!</p>
</body>
</html>
<!-- test -->
"""
tree = html_tag_tree(html)
html_branches: Fix strict_optional errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-05 02:59:37 +02:00
assert tree.children[0].token is not None
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
self.assertEqual(tree.children[0].token.kind, 'html_start')
self.assertEqual(tree.children[0].token.tag, 'html')
html_branches: Fix strict_optional errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-05 02:59:37 +02:00
assert tree.children[0].children[0].token is not None
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
self.assertEqual(tree.children[0].children[0].token.kind, 'html_start')
self.assertEqual(tree.children[0].children[0].token.tag, 'head')
html_branches: Fix strict_optional errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-05 02:59:37 +02:00
assert tree.children[0].children[0].children[0].token is not None
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
self.assertEqual(tree.children[0].children[0].children[0].token.kind, 'html_start')
self.assertEqual(tree.children[0].children[0].children[0].token.tag, 'title')
html_branches: Fix strict_optional errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-05 02:59:37 +02:00
assert tree.children[0].children[1].token is not None
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
self.assertEqual(tree.children[0].children[1].token.kind, 'html_start')
self.assertEqual(tree.children[0].children[1].token.tag, 'body')
html_branches: Fix strict_optional errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-05 02:59:37 +02:00
assert tree.children[0].children[1].children[0].token is not None
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
self.assertEqual(tree.children[0].children[1].children[0].token.kind, 'html_start')
self.assertEqual(tree.children[0].children[1].children[0].token.tag, 'p')
html_branches: Fix strict_optional errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-05 02:59:37 +02:00
assert tree.children[0].children[1].children[0].children[0].token is not None
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
self.assertEqual(tree.children[0].children[1].children[0].children[0].token.kind, 'html_singleton')
self.assertEqual(tree.children[0].children[1].children[0].children[0].token.tag, 'br')
html_branches: Fix strict_optional errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-05 02:59:37 +02:00
assert tree.children[0].children[1].children[1].token is not None
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
self.assertEqual(tree.children[0].children[1].children[1].token.kind, 'html_start')
self.assertEqual(tree.children[0].children[1].children[1].token.tag, 'p')
tools/tests: Use Python 3 syntax for typing.
2017-12-13 06:45:46 +01:00
def test_html_branches(self) -> None:
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
html = """
<!-- test -->
<!DOCTYPE html>
<html>
<!-- test -->
<head>
<title>Test</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="style.css" />
</head>
<body>
check-templates: Be stricter about singleton tags. We now forbid tags of the form `<foo ... />` in most places, and we also forbid it even for several void tags. We make exceptions for tags that are already formatted in two different ways in our codebase. This is mostly svg tags, plus these common cases: - br - hr - img - input It would be nice to lock down a convention for these, even though the HTML specification is unopinionated on these. We'll probably want to stay flexible for svg tags, since they are sometimes copy/pasted from other sources (although it's probably rare enough for them that we can tolerate just doing minor edits as needed).
2020-04-18 11:38:31 +02:00
<p>Hello<br>world!</p>
Factor out HtmlTreeBranch and related code from template parser. This code is not directly related to the template parser, so it can safely live in its own file. The only significant change to the code is to the signature of `html_branches` so that it can be called without requiring a file. Since it's only used in html_grep, that has been updated to reflect this change. Fixes: #1774.
2016-09-11 20:23:29 +02:00
<p>Goodbye<!-- test -->world!</p>
</body>
</html>
<!-- test -->
"""
branches = html_branches(html)
self.assertEqual(branches[0].text(), 'html head title')
self.assertEqual(branches[1].text(), 'html body p br')
self.assertEqual(branches[2].text(), 'html body p')
self.assertEqual(branches[0].staircase_text(), '\n html\n head\n title\n')
self.assertEqual(branches[1].staircase_text(), '\n html\n body\n p\n br\n')
self.assertEqual(branches[2].staircase_text(), '\n html\n body\n p\n')
Lint for duplicate ids in templates. In this commit we enhance our current template linter to detect duplicate ids and report them during lint checks. html_branches.py was topped up with a new function build_id_dict for the purpose. Also the get_tag_info function in same file was updated to parse ids and classes more robustly in cases of template variables. split_for_id_and_class function was added to serve this purpose. Unit tests for both the functions were created under tests/test_html_branches. Also a directory under tests called test_template_data was created to hold templates for testing under newly created functionality. check_templates was modified to print to console any duplicates detected. showell reviewed my commit and helped me out. Fixes #2950.
2017-01-06 15:11:15 +01:00
tools/tests: Use Python 3 syntax for typing.
2017-12-13 06:45:46 +01:00
def test_build_id_dict(self) -> None:
Lint for duplicate ids in templates. In this commit we enhance our current template linter to detect duplicate ids and report them during lint checks. html_branches.py was topped up with a new function build_id_dict for the purpose. Also the get_tag_info function in same file was updated to parse ids and classes more robustly in cases of template variables. split_for_id_and_class function was added to serve this purpose. Unit tests for both the functions were created under tests/test_html_branches. Also a directory under tests called test_template_data was created to hold templates for testing under newly created functionality. check_templates was modified to print to console any duplicates detected. showell reviewed my commit and helped me out. Fixes #2950.
2017-01-06 15:11:15 +01:00
templates = ["test_template1.html", "test_template2.html"]
templates = [os.path.join(TEST_TEMPLATES_DIR, fn) for fn in templates]
template_id_dict = build_id_dict(templates)
tools: Fix regressions in tools/tests/test_html_branches.py
2017-01-18 22:04:32 +01:00
self.assertEqual(set(template_id_dict.keys()), {'below_navbar', 'hello_{{ message }}', 'intro'})
Lint for duplicate ids in templates. In this commit we enhance our current template linter to detect duplicate ids and report them during lint checks. html_branches.py was topped up with a new function build_id_dict for the purpose. Also the get_tag_info function in same file was updated to parse ids and classes more robustly in cases of template variables. split_for_id_and_class function was added to serve this purpose. Unit tests for both the functions were created under tests/test_html_branches. Also a directory under tests called test_template_data was created to hold templates for testing under newly created functionality. check_templates was modified to print to console any duplicates detected. showell reviewed my commit and helped me out. Fixes #2950.
2017-01-06 15:11:15 +01:00
self.assertEqual(template_id_dict['hello_{{ message }}'], [
python: Convert percent formatting to Python 3.6 f-strings. Generated by pyupgrade --py36-plus. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-10 06:41:04 +02:00
f'Line 12:{ZULIP_PATH}/tools/tests/test_template_data/test_template1.html',
f'Line 12:{ZULIP_PATH}/tools/tests/test_template_data/test_template2.html'])
Lint for duplicate ids in templates. In this commit we enhance our current template linter to detect duplicate ids and report them during lint checks. html_branches.py was topped up with a new function build_id_dict for the purpose. Also the get_tag_info function in same file was updated to parse ids and classes more robustly in cases of template variables. split_for_id_and_class function was added to serve this purpose. Unit tests for both the functions were created under tests/test_html_branches. Also a directory under tests called test_template_data was created to hold templates for testing under newly created functionality. check_templates was modified to print to console any duplicates detected. showell reviewed my commit and helped me out. Fixes #2950.
2017-01-06 15:11:15 +01:00
self.assertEqual(template_id_dict['intro'], [
python: Convert percent formatting to Python 3.6 f-strings. Generated by pyupgrade --py36-plus. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-10 06:41:04 +02:00
f'Line 10:{ZULIP_PATH}/tools/tests/test_template_data/test_template1.html',
f'Line 11:{ZULIP_PATH}/tools/tests/test_template_data/test_template1.html',
f'Line 11:{ZULIP_PATH}/tools/tests/test_template_data/test_template2.html'])
tools: Fix regressions in tools/tests/test_html_branches.py
2017-01-18 22:04:32 +01:00
self.assertEqual(template_id_dict['below_navbar'], [
python: Convert percent formatting to Python 3.6 f-strings. Generated by pyupgrade --py36-plus. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-10 06:41:04 +02:00
f'Line 10:{ZULIP_PATH}/tools/tests/test_template_data/test_template2.html'])
Lint for duplicate ids in templates. In this commit we enhance our current template linter to detect duplicate ids and report them during lint checks. html_branches.py was topped up with a new function build_id_dict for the purpose. Also the get_tag_info function in same file was updated to parse ids and classes more robustly in cases of template variables. split_for_id_and_class function was added to serve this purpose. Unit tests for both the functions were created under tests/test_html_branches. Also a directory under tests called test_template_data was created to hold templates for testing under newly created functionality. check_templates was modified to print to console any duplicates detected. showell reviewed my commit and helped me out. Fixes #2950.
2017-01-06 15:11:15 +01:00
tools/tests: Use Python 3 syntax for typing.
2017-12-13 06:45:46 +01:00
def test_split_for_id_and_class(self) -> None:
Lint for duplicate ids in templates. In this commit we enhance our current template linter to detect duplicate ids and report them during lint checks. html_branches.py was topped up with a new function build_id_dict for the purpose. Also the get_tag_info function in same file was updated to parse ids and classes more robustly in cases of template variables. split_for_id_and_class function was added to serve this purpose. Unit tests for both the functions were created under tests/test_html_branches. Also a directory under tests called test_template_data was created to hold templates for testing under newly created functionality. check_templates was modified to print to console any duplicates detected. showell reviewed my commit and helped me out. Fixes #2950.
2017-01-06 15:11:15 +01:00
id1 = "{{ red|blue }}"
id2 = "search_box_{{ page }}"
class1 = "chat_box message"
class2 = "stream_{{ topic }}"
class3 = "foo {{ a|b|c }} bar"
self.assertEqual(split_for_id_and_class(id1), ['{{ red|blue }}'])
self.assertEqual(split_for_id_and_class(id2), ['search_box_{{ page }}'])
self.assertEqual(split_for_id_and_class(class1), ['chat_box', 'message'])
self.assertEqual(split_for_id_and_class(class2), ['stream_{{ topic }}'])
self.assertEqual(split_for_id_and_class(class3), ['foo', '{{ a|b|c }}', 'bar'])