annotate markup/tests/core.py @ 27:b8456279c444

* Fix the boilerplate in the Python source files. * Some more docstrings and cosmetic fixes.
author cmlenz
date Wed, 28 Jun 2006 09:28:09 +0000
parents eca77129518a
children 822089ae65ce
rev   line source
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
1 # -*- coding: utf-8 -*-
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
2 #
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
3 # Copyright (C) 2006 Christopher Lenz
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
4 # All rights reserved.
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
5 #
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
6 # This software is licensed as described in the file COPYING, which
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
7 # you should have received as part of this distribution. The terms
27
b8456279c444 * Fix the boilerplate in the Python source files.
cmlenz
parents: 21
diff changeset
8 # are also available at http://markup.cmlenz.net/wiki/License.
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
9 #
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
10 # This software consists of voluntary contributions made by many
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
11 # individuals. For the exact contribution history, see the revision
27
b8456279c444 * Fix the boilerplate in the Python source files.
cmlenz
parents: 21
diff changeset
12 # history and logs, available at http://markup.cmlenz.net/log/.
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
13
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
14 import doctest
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
15 import unittest
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
16
18
4cbebb15a834 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents: 1
diff changeset
17 from markup.core import *
21
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents: 18
diff changeset
18 from markup.input import ParseError
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
19
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
20
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
21 class MarkupTestCase(unittest.TestCase):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
22
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
23 def test_escape(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
24 markup = escape('<b>"&"</b>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
25 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
26 self.assertEquals('&lt;b&gt;&#34;&amp;&#34;&lt;/b&gt;', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
27
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
28 def test_escape_noquotes(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
29 markup = escape('<b>"&"</b>', quotes=False)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
30 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
31 self.assertEquals('&lt;b&gt;"&amp;"&lt;/b&gt;', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
32
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
33 def test_unescape_markup(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
34 string = '<b>"&"</b>'
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
35 markup = Markup.escape(string)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
36 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
37 self.assertEquals(string, unescape(markup))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
38
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
39 def test_add_str(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
40 markup = Markup('<b>foo</b>') + '<br/>'
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
41 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
42 self.assertEquals('<b>foo</b>&lt;br/&gt;', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
43
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
44 def test_add_markup(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
45 markup = Markup('<b>foo</b>') + Markup('<br/>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
46 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
47 self.assertEquals('<b>foo</b><br/>', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
48
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
49 def test_add_reverse(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
50 markup = 'foo' + Markup('<b>bar</b>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
51 assert isinstance(markup, unicode)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
52 self.assertEquals('foo<b>bar</b>', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
53
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
54 def test_mod(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
55 markup = Markup('<b>%s</b>') % '&'
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
56 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
57 self.assertEquals('<b>&amp;</b>', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
58
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
59 def test_mod_multi(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
60 markup = Markup('<b>%s</b> %s') % ('&', 'boo')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
61 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
62 self.assertEquals('<b>&amp;</b> boo', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
63
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
64 def test_mul(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
65 markup = Markup('<b>foo</b>') * 2
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
66 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
67 self.assertEquals('<b>foo</b><b>foo</b>', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
68
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
69 def test_join(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
70 markup = Markup('<br />').join(['foo', '<bar />', Markup('<baz />')])
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
71 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
72 self.assertEquals('foo<br />&lt;bar /&gt;<br /><baz />', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
73
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
74 def test_stripentities_all(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
75 markup = Markup('&amp; &#106;').stripentities()
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
76 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
77 self.assertEquals('& j', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
78
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
79 def test_stripentities_keepxml(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
80 markup = Markup('<a href="#">fo<br />o</a>').striptags()
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
81 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
82 self.assertEquals('foo', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
83
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
84 def test_striptags_empty(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
85 markup = Markup('<br />').striptags()
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
86 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
87 self.assertEquals('', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
88
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
89 def test_striptags_mid(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
90 markup = Markup('<a href="#">fo<br />o</a>').striptags()
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
91 assert isinstance(markup, Markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
92 self.assertEquals('foo', markup)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
93
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
94 def test_sanitize_unchanged(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
95 markup = Markup('<a href="#">fo<br />o</a>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
96 self.assertEquals('<a href="#">fo<br/>o</a>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
97
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
98 def test_sanitize_escape_text(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
99 markup = Markup('<a href="#">fo&amp;</a>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
100 self.assertEquals('<a href="#">fo&amp;</a>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
101 markup = Markup('<a href="#">&lt;foo&gt;</a>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
102 self.assertEquals('<a href="#">&lt;foo&gt;</a>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
103
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
104 def test_sanitize_entityref_text(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
105 markup = Markup('<a href="#">fo&ouml;</a>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
106 self.assertEquals(u'<a href="#">foƶ</a>', unicode(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
107
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
108 def test_sanitize_escape_attr(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
109 markup = Markup('<div title="&lt;foo&gt;"></div>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
110 self.assertEquals('<div title="&lt;foo&gt;"/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
111
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
112 def test_sanitize_close_empty_tag(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
113 markup = Markup('<a href="#">fo<br>o</a>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
114 self.assertEquals('<a href="#">fo<br/>o</a>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
115
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
116 def test_sanitize_invalid_entity(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
117 markup = Markup('&junk;')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
118 self.assertEquals('&amp;junk;', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
119
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
120 def test_sanitize_remove_script_elem(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
121 markup = Markup('<script>alert("Foo")</script>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
122 self.assertEquals('', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
123 markup = Markup('<SCRIPT SRC="http://example.com/"></SCRIPT>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
124 self.assertEquals('', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
125 markup = Markup('<SCR\0IPT>alert("foo")</SCR\0IPT>')
21
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents: 18
diff changeset
126 self.assertRaises(ParseError, markup.sanitize().render)
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
127 markup = Markup('<SCRIPT&XYZ SRC="http://example.com/"></SCRIPT>')
21
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents: 18
diff changeset
128 self.assertRaises(ParseError, markup.sanitize().render)
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
129
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
130 def test_sanitize_remove_onclick_attr(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
131 markup = Markup('<div onclick=\'alert("foo")\' />')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
132 self.assertEquals('<div/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
133
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
134 def test_sanitize_remove_style_scripts(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
135 # Inline style with url() using javascript: scheme
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
136 markup = Markup('<DIV STYLE=\'background: url(javascript:alert("foo"))\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
137 self.assertEquals('<div/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
138 # Inline style with url() using javascript: scheme, using control char
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
139 markup = Markup('<DIV STYLE=\'background: url(&#1;javascript:alert("foo"))\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
140 self.assertEquals('<div/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
141 # Inline style with url() using javascript: scheme, in quotes
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
142 markup = Markup('<DIV STYLE=\'background: url("javascript:alert(foo)")\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
143 self.assertEquals('<div/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
144 # IE expressions in CSS not allowed
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
145 markup = Markup('<DIV STYLE=\'width: expression(alert("foo"));\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
146 self.assertEquals('<div/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
147 markup = Markup('<DIV STYLE=\'background: url(javascript:alert("foo"));'
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
148 'color: #fff\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
149 self.assertEquals('<div style="color: #fff"/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
150
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
151 def test_sanitize_remove_src_javascript(self):
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
152 markup = Markup('<img src=\'javascript:alert("foo")\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
153 self.assertEquals('<img/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
154 # Case-insensitive protocol matching
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
155 markup = Markup('<IMG SRC=\'JaVaScRiPt:alert("foo")\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
156 self.assertEquals('<img/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
157 # Grave accents (not parsed)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
158 markup = Markup('<IMG SRC=`javascript:alert("RSnake says, \'foo\'")`>')
21
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents: 18
diff changeset
159 self.assertRaises(ParseError, markup.sanitize().render)
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
160 # Protocol encoded using UTF-8 numeric entities
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
161 markup = Markup('<IMG SRC=\'&#106;&#97;&#118;&#97;&#115;&#99;&#114;&#105;'
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
162 '&#112;&#116;&#58;alert("foo")\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
163 self.assertEquals('<img/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
164 # Protocol encoded using UTF-8 numeric entities without a semicolon
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
165 # (which is allowed because the max number of digits is used)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
166 markup = Markup('<IMG SRC=\'&#0000106&#0000097&#0000118&#0000097'
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
167 '&#0000115&#0000099&#0000114&#0000105&#0000112&#0000116'
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
168 '&#0000058alert("foo")\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
169 self.assertEquals('<img/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
170 # Protocol encoded using UTF-8 numeric hex entities without a semicolon
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
171 # (which is allowed because the max number of digits is used)
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
172 markup = Markup('<IMG SRC=\'&#x6A&#x61&#x76&#x61&#x73&#x63&#x72&#x69'
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
173 '&#x70&#x74&#x3A;alert("foo")\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
174 self.assertEquals('<img/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
175 # Embedded tab character in protocol
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
176 markup = Markup('<IMG SRC=\'jav\tascript:alert("foo");\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
177 self.assertEquals('<img/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
178 # Embedded tab character in protocol, but encoded this time
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
179 markup = Markup('<IMG SRC=\'jav&#x09;ascript:alert("foo");\'>')
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
180 self.assertEquals('<img/>', str(markup.sanitize()))
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
181
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
182
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
183 def suite():
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
184 suite = unittest.TestSuite()
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
185 suite.addTest(unittest.makeSuite(MarkupTestCase, 'test'))
18
4cbebb15a834 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents: 1
diff changeset
186 suite.addTest(doctest.DocTestSuite(Markup.__module__))
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
187 return suite
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
188
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
189 if __name__ == '__main__':
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
190 unittest.main(defaultTest='suite')
Copyright (C) 2012-2017 Edgewall Software