summaryrefslogtreecommitdiff
path: root/tests/utils_tests/test_html.py
diff options
context:
space:
mode:
authordjango-bot <ops@djangoproject.com>2022-02-03 20:24:19 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-02-07 20:37:05 +0100
commit9c19aff7c7561e3a82978a272ecdaad40dda5c00 (patch)
treef0506b668a013d0063e5fba3dbf4863b466713ba /tests/utils_tests/test_html.py
parentf68fa8b45dfac545cfc4111d4e52804c86db68d3 (diff)
Refs #33476 -- Reformatted code with Black.
Diffstat (limited to 'tests/utils_tests/test_html.py')
-rw-r--r--tests/utils_tests/test_html.py223
1 files changed, 133 insertions, 90 deletions
diff --git a/tests/utils_tests/test_html.py b/tests/utils_tests/test_html.py
index 63644daf61..c38a16de40 100644
--- a/tests/utils_tests/test_html.py
+++ b/tests/utils_tests/test_html.py
@@ -4,14 +4,22 @@ from datetime import datetime
from django.test import SimpleTestCase
from django.utils.functional import lazystr
from django.utils.html import (
- conditional_escape, escape, escapejs, format_html, html_safe, json_script,
- linebreaks, smart_urlquote, strip_spaces_between_tags, strip_tags, urlize,
+ conditional_escape,
+ escape,
+ escapejs,
+ format_html,
+ html_safe,
+ json_script,
+ linebreaks,
+ smart_urlquote,
+ strip_spaces_between_tags,
+ strip_tags,
+ urlize,
)
from django.utils.safestring import mark_safe
class TestUtilsHtml(SimpleTestCase):
-
def check_output(self, function, value, output=None):
"""
function(value) equals output. If output is None, function(value)
@@ -23,11 +31,11 @@ class TestUtilsHtml(SimpleTestCase):
def test_escape(self):
items = (
- ('&', '&amp;'),
- ('<', '&lt;'),
- ('>', '&gt;'),
- ('"', '&quot;'),
- ("'", '&#x27;'),
+ ("&", "&amp;"),
+ ("<", "&lt;"),
+ (">", "&gt;"),
+ ('"', "&quot;"),
+ ("'", "&#x27;"),
)
# Substitution patterns for testing the above items.
patterns = ("%s", "asdf%sfdsa", "%s1", "1%sb")
@@ -36,11 +44,13 @@ class TestUtilsHtml(SimpleTestCase):
for pattern in patterns:
with self.subTest(value=value, output=output, pattern=pattern):
self.check_output(escape, pattern % value, pattern % output)
- self.check_output(escape, lazystr(pattern % value), pattern % output)
+ self.check_output(
+ escape, lazystr(pattern % value), pattern % output
+ )
# Check repeated values.
self.check_output(escape, value * 2, output * 2)
# Verify it doesn't double replace &.
- self.check_output(escape, '<&', '&lt;&amp;')
+ self.check_output(escape, "<&", "&lt;&amp;")
def test_format_html(self):
self.assertEqual(
@@ -51,14 +61,20 @@ class TestUtilsHtml(SimpleTestCase):
third="< dangerous again",
fourth=mark_safe("<i>safe again</i>"),
),
- "&lt; Dangerous &gt; <b>safe</b> &lt; dangerous again <i>safe again</i>"
+ "&lt; Dangerous &gt; <b>safe</b> &lt; dangerous again <i>safe again</i>",
)
def test_linebreaks(self):
items = (
("para1\n\npara2\r\rpara3", "<p>para1</p>\n\n<p>para2</p>\n\n<p>para3</p>"),
- ("para1\nsub1\rsub2\n\npara2", "<p>para1<br>sub1<br>sub2</p>\n\n<p>para2</p>"),
- ("para1\r\n\r\npara2\rsub1\r\rpara4", "<p>para1</p>\n\n<p>para2<br>sub1</p>\n\n<p>para4</p>"),
+ (
+ "para1\nsub1\rsub2\n\npara2",
+ "<p>para1<br>sub1<br>sub2</p>\n\n<p>para2</p>",
+ ),
+ (
+ "para1\r\n\r\npara2\rsub1\r\rpara4",
+ "<p>para1</p>\n\n<p>para2<br>sub1</p>\n\n<p>para4</p>",
+ ),
("para1\tmore\n\npara2", "<p>para1\tmore</p>\n\n<p>para2</p>"),
)
for value, output in items:
@@ -68,30 +84,34 @@ class TestUtilsHtml(SimpleTestCase):
def test_strip_tags(self):
items = (
- ('<p>See: &#39;&eacute; is an apostrophe followed by e acute</p>',
- 'See: &#39;&eacute; is an apostrophe followed by e acute'),
- ('<p>See: &#x27;&eacute; is an apostrophe followed by e acute</p>',
- 'See: &#x27;&eacute; is an apostrophe followed by e acute'),
- ('<adf>a', 'a'),
- ('</adf>a', 'a'),
- ('<asdf><asdf>e', 'e'),
- ('hi, <f x', 'hi, <f x'),
- ('234<235, right?', '234<235, right?'),
- ('a4<a5 right?', 'a4<a5 right?'),
- ('b7>b2!', 'b7>b2!'),
- ('</fe', '</fe'),
- ('<x>b<y>', 'b'),
- ('a<p onclick="alert(\'<test>\')">b</p>c', 'abc'),
- ('a<p a >b</p>c', 'abc'),
- ('d<a:b c:d>e</p>f', 'def'),
- ('<strong>foo</strong><a href="http://example.com">bar</a>', 'foobar'),
+ (
+ "<p>See: &#39;&eacute; is an apostrophe followed by e acute</p>",
+ "See: &#39;&eacute; is an apostrophe followed by e acute",
+ ),
+ (
+ "<p>See: &#x27;&eacute; is an apostrophe followed by e acute</p>",
+ "See: &#x27;&eacute; is an apostrophe followed by e acute",
+ ),
+ ("<adf>a", "a"),
+ ("</adf>a", "a"),
+ ("<asdf><asdf>e", "e"),
+ ("hi, <f x", "hi, <f x"),
+ ("234<235, right?", "234<235, right?"),
+ ("a4<a5 right?", "a4<a5 right?"),
+ ("b7>b2!", "b7>b2!"),
+ ("</fe", "</fe"),
+ ("<x>b<y>", "b"),
+ ("a<p onclick=\"alert('<test>')\">b</p>c", "abc"),
+ ("a<p a >b</p>c", "abc"),
+ ("d<a:b c:d>e</p>f", "def"),
+ ('<strong>foo</strong><a href="http://example.com">bar</a>', "foobar"),
# caused infinite loop on Pythons not patched with
# https://bugs.python.org/issue20288
- ('&gotcha&#;<>', '&gotcha&#;<>'),
- ('<sc<!-- -->ript>test<<!-- -->/script>', 'ript>test'),
- ('<script>alert()</script>&h', 'alert()h'),
- ('><!' + ('&' * 16000) + 'D', '><!' + ('&' * 16000) + 'D'),
- ('X<<<<br>br>br>br>X', 'XX'),
+ ("&gotcha&#;<>", "&gotcha&#;<>"),
+ ("<sc<!-- -->ript>test<<!-- -->/script>", "ript>test"),
+ ("<script>alert()</script>&h", "alert()h"),
+ ("><!" + ("&" * 16000) + "D", "><!" + ("&" * 16000) + "D"),
+ ("X<<<<br>br>br>br>X", "XX"),
)
for value, output in items:
with self.subTest(value=value, output=output):
@@ -100,9 +120,9 @@ class TestUtilsHtml(SimpleTestCase):
def test_strip_tags_files(self):
# Test with more lengthy content (also catching performance regressions)
- for filename in ('strip_tags1.html', 'strip_tags2.txt'):
+ for filename in ("strip_tags1.html", "strip_tags2.txt"):
with self.subTest(filename=filename):
- path = os.path.join(os.path.dirname(__file__), 'files', filename)
+ path = os.path.join(os.path.dirname(__file__), "files", filename)
with open(path) as fp:
content = fp.read()
start = datetime.now()
@@ -110,11 +130,11 @@ class TestUtilsHtml(SimpleTestCase):
elapsed = datetime.now() - start
self.assertEqual(elapsed.seconds, 0)
self.assertIn("Please try again.", stripped)
- self.assertNotIn('<', stripped)
+ self.assertNotIn("<", stripped)
def test_strip_spaces_between_tags(self):
# Strings that should come out untouched.
- items = (' <adf>', '<adf> ', ' </adf> ', ' <f> x</f>')
+ items = (" <adf>", "<adf> ", " </adf> ", " <f> x</f>")
for value in items:
with self.subTest(value=value):
self.check_output(strip_spaces_between_tags, value)
@@ -122,9 +142,9 @@ class TestUtilsHtml(SimpleTestCase):
# Strings that have spaces to strip.
items = (
- ('<d> </d>', '<d></d>'),
- ('<p>hello </p>\n<p> world</p>', '<p>hello </p><p> world</p>'),
- ('\n<p>\t</p>\n<p> </p>\n', '\n<p></p><p></p>\n'),
+ ("<d> </d>", "<d></d>"),
+ ("<p>hello </p>\n<p> world</p>", "<p>hello </p><p> world</p>"),
+ ("\n<p>\t</p>\n<p> </p>\n", "\n<p></p><p></p>\n"),
)
for value, output in items:
with self.subTest(value=value, output=output):
@@ -133,18 +153,24 @@ class TestUtilsHtml(SimpleTestCase):
def test_escapejs(self):
items = (
- ('"double quotes" and \'single quotes\'', '\\u0022double quotes\\u0022 and \\u0027single quotes\\u0027'),
- (r'\ : backslashes, too', '\\u005C : backslashes, too'),
(
- 'and lots of whitespace: \r\n\t\v\f\b',
- 'and lots of whitespace: \\u000D\\u000A\\u0009\\u000B\\u000C\\u0008'
+ "\"double quotes\" and 'single quotes'",
+ "\\u0022double quotes\\u0022 and \\u0027single quotes\\u0027",
+ ),
+ (r"\ : backslashes, too", "\\u005C : backslashes, too"),
+ (
+ "and lots of whitespace: \r\n\t\v\f\b",
+ "and lots of whitespace: \\u000D\\u000A\\u0009\\u000B\\u000C\\u0008",
+ ),
+ (
+ r"<script>and this</script>",
+ "\\u003Cscript\\u003Eand this\\u003C/script\\u003E",
),
- (r'<script>and this</script>', '\\u003Cscript\\u003Eand this\\u003C/script\\u003E'),
(
- 'paragraph separator:\u2029and line separator:\u2028',
- 'paragraph separator:\\u2029and line separator:\\u2028'
+ "paragraph separator:\u2029and line separator:\u2028",
+ "paragraph separator:\\u2029and line separator:\\u2028",
),
- ('`', '\\u0060'),
+ ("`", "\\u0060"),
)
for value, output in items:
with self.subTest(value=value, output=output):
@@ -154,46 +180,61 @@ class TestUtilsHtml(SimpleTestCase):
def test_json_script(self):
tests = (
# "<", ">" and "&" are quoted inside JSON strings
- (('&<>', '<script id="test_id" type="application/json">"\\u0026\\u003C\\u003E"</script>')),
+ (
+ (
+ "&<>",
+ '<script id="test_id" type="application/json">"\\u0026\\u003C\\u003E"</script>',
+ )
+ ),
# "<", ">" and "&" are quoted inside JSON objects
(
- {'a': '<script>test&ing</script>'},
+ {"a": "<script>test&ing</script>"},
'<script id="test_id" type="application/json">'
- '{"a": "\\u003Cscript\\u003Etest\\u0026ing\\u003C/script\\u003E"}</script>'
+ '{"a": "\\u003Cscript\\u003Etest\\u0026ing\\u003C/script\\u003E"}</script>',
),
# Lazy strings are quoted
- (lazystr('&<>'), '<script id="test_id" type="application/json">"\\u0026\\u003C\\u003E"</script>'),
(
- {'a': lazystr('<script>test&ing</script>')},
+ lazystr("&<>"),
+ '<script id="test_id" type="application/json">"\\u0026\\u003C\\u003E"</script>',
+ ),
+ (
+ {"a": lazystr("<script>test&ing</script>")},
'<script id="test_id" type="application/json">'
- '{"a": "\\u003Cscript\\u003Etest\\u0026ing\\u003C/script\\u003E"}</script>'
+ '{"a": "\\u003Cscript\\u003Etest\\u0026ing\\u003C/script\\u003E"}</script>',
),
)
for arg, expected in tests:
with self.subTest(arg=arg):
- self.assertEqual(json_script(arg, 'test_id'), expected)
+ self.assertEqual(json_script(arg, "test_id"), expected)
def test_json_script_without_id(self):
self.assertHTMLEqual(
- json_script({'key': 'value'}),
+ json_script({"key": "value"}),
'<script type="application/json">{"key": "value"}</script>',
)
def test_smart_urlquote(self):
items = (
- ('http://öäü.com/', 'http://xn--4ca9at.com/'),
- ('http://öäü.com/öäü/', 'http://xn--4ca9at.com/%C3%B6%C3%A4%C3%BC/'),
+ ("http://öäü.com/", "http://xn--4ca9at.com/"),
+ ("http://öäü.com/öäü/", "http://xn--4ca9at.com/%C3%B6%C3%A4%C3%BC/"),
# Everything unsafe is quoted, !*'();:@&=+$,/?#[]~ is considered
# safe as per RFC.
- ('http://example.com/path/öäü/', 'http://example.com/path/%C3%B6%C3%A4%C3%BC/'),
- ('http://example.com/%C3%B6/ä/', 'http://example.com/%C3%B6/%C3%A4/'),
- ('http://example.com/?x=1&y=2+3&z=', 'http://example.com/?x=1&y=2+3&z='),
- ('http://example.com/?x=<>"\'', 'http://example.com/?x=%3C%3E%22%27'),
- ('http://example.com/?q=http://example.com/?x=1%26q=django',
- 'http://example.com/?q=http%3A%2F%2Fexample.com%2F%3Fx%3D1%26q%3Ddjango'),
- ('http://example.com/?q=http%3A%2F%2Fexample.com%2F%3Fx%3D1%26q%3Ddjango',
- 'http://example.com/?q=http%3A%2F%2Fexample.com%2F%3Fx%3D1%26q%3Ddjango'),
- ('http://.www.f oo.bar/', 'http://.www.f%20oo.bar/'),
+ (
+ "http://example.com/path/öäü/",
+ "http://example.com/path/%C3%B6%C3%A4%C3%BC/",
+ ),
+ ("http://example.com/%C3%B6/ä/", "http://example.com/%C3%B6/%C3%A4/"),
+ ("http://example.com/?x=1&y=2+3&z=", "http://example.com/?x=1&y=2+3&z="),
+ ("http://example.com/?x=<>\"'", "http://example.com/?x=%3C%3E%22%27"),
+ (
+ "http://example.com/?q=http://example.com/?x=1%26q=django",
+ "http://example.com/?q=http%3A%2F%2Fexample.com%2F%3Fx%3D1%26q%3Ddjango",
+ ),
+ (
+ "http://example.com/?q=http%3A%2F%2Fexample.com%2F%3Fx%3D1%26q%3Ddjango",
+ "http://example.com/?q=http%3A%2F%2Fexample.com%2F%3Fx%3D1%26q%3Ddjango",
+ ),
+ ("http://.www.f oo.bar/", "http://.www.f%20oo.bar/"),
)
# IDNs are properly quoted
for value, output in items:
@@ -201,8 +242,8 @@ class TestUtilsHtml(SimpleTestCase):
self.assertEqual(smart_urlquote(value), output)
def test_conditional_escape(self):
- s = '<h1>interop</h1>'
- self.assertEqual(conditional_escape(s), '&lt;h1&gt;interop&lt;/h1&gt;')
+ s = "<h1>interop</h1>"
+ self.assertEqual(conditional_escape(s), "&lt;h1&gt;interop&lt;/h1&gt;")
self.assertEqual(conditional_escape(mark_safe(s)), s)
self.assertEqual(conditional_escape(lazystr(mark_safe(s))), s)
@@ -213,24 +254,24 @@ class TestUtilsHtml(SimpleTestCase):
return "<h1>I'm a html class!</h1>"
html_obj = HtmlClass()
- self.assertTrue(hasattr(HtmlClass, '__html__'))
- self.assertTrue(hasattr(html_obj, '__html__'))
+ self.assertTrue(hasattr(HtmlClass, "__html__"))
+ self.assertTrue(hasattr(html_obj, "__html__"))
self.assertEqual(str(html_obj), html_obj.__html__())
def test_html_safe_subclass(self):
class BaseClass:
def __html__(self):
# defines __html__ on its own
- return 'some html content'
+ return "some html content"
def __str__(self):
- return 'some non html content'
+ return "some non html content"
@html_safe
class Subclass(BaseClass):
def __str__(self):
# overrides __str__ and is marked as html_safe
- return 'some html safe content'
+ return "some html safe content"
subclass_obj = Subclass()
self.assertEqual(str(subclass_obj), subclass_obj.__html__())
@@ -238,6 +279,7 @@ class TestUtilsHtml(SimpleTestCase):
def test_html_safe_defines_html_error(self):
msg = "can't apply @html_safe to HtmlClass because it defines __html__()."
with self.assertRaisesMessage(ValueError, msg):
+
@html_safe
class HtmlClass:
def __html__(self):
@@ -246,6 +288,7 @@ class TestUtilsHtml(SimpleTestCase):
def test_html_safe_doesnt_define_str(self):
msg = "can't apply @html_safe to HtmlClass because it doesn't define __str__()."
with self.assertRaisesMessage(ValueError, msg):
+
@html_safe
class HtmlClass:
pass
@@ -253,18 +296,18 @@ class TestUtilsHtml(SimpleTestCase):
def test_urlize(self):
tests = (
(
- 'Search for google.com/?q=! and see.',
- 'Search for <a href="http://google.com/?q=">google.com/?q=</a>! and see.'
+ "Search for google.com/?q=! and see.",
+ 'Search for <a href="http://google.com/?q=">google.com/?q=</a>! and see.',
),
(
- 'Search for google.com/?q=1&lt! and see.',
- 'Search for <a href="http://google.com/?q=1%3C">google.com/?q=1&lt</a>! and see.'
+ "Search for google.com/?q=1&lt! and see.",
+ 'Search for <a href="http://google.com/?q=1%3C">google.com/?q=1&lt</a>! and see.',
),
(
- lazystr('Search for google.com/?q=!'),
- 'Search for <a href="http://google.com/?q=">google.com/?q=</a>!'
+ lazystr("Search for google.com/?q=!"),
+ 'Search for <a href="http://google.com/?q=">google.com/?q=</a>!',
),
- ('foo@example.com', '<a href="mailto:foo@example.com">foo@example.com</a>'),
+ ("foo@example.com", '<a href="mailto:foo@example.com">foo@example.com</a>'),
)
for value, output in tests:
with self.subTest(value=value):
@@ -272,13 +315,13 @@ class TestUtilsHtml(SimpleTestCase):
def test_urlize_unchanged_inputs(self):
tests = (
- ('a' + '@a' * 50000) + 'a', # simple_email_re catastrophic test
- ('a' + '.' * 1000000) + 'a', # trailing_punctuation catastrophic test
- 'foo@',
- '@foo.com',
- 'foo@.example.com',
- 'foo@localhost',
- 'foo@localhost.',
+ ("a" + "@a" * 50000) + "a", # simple_email_re catastrophic test
+ ("a" + "." * 1000000) + "a", # trailing_punctuation catastrophic test
+ "foo@",
+ "@foo.com",
+ "foo@.example.com",
+ "foo@localhost",
+ "foo@localhost.",
)
for value in tests:
with self.subTest(value=value):