1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
from __future__ import unicode_literals
import json
from django.test import TestCase
from django.core import serializers
from django.utils.encoding import smart_text
from markupfield.markup import DEFAULT_MARKUP_TYPES
from markupfield.fields import MarkupField, Markup
from markupfield.widgets import MarkupTextarea, AdminMarkupTextareaWidget
from markupfield.tests.models import Post, Article, Concrete
from django.forms.models import modelform_factory
ArticleForm = modelform_factory(Article, fields=('normal_field', 'normal_field_markup_type',
'markup_choices_field',
'markup_choices_field_markup_type',
'default_field', 'default_field_markup_type',
'markdown_field'))
class MarkupFieldTestCase(TestCase):
def setUp(self):
self.xss_str = "<script>alert('xss');</script>"
self.mp = Post(title='example markdown post', body='**markdown**',
body_markup_type='markdown')
self.mp.save()
self.rp = Post(title='example restructuredtext post', body='*ReST*',
body_markup_type='ReST')
self.rp.save()
self.xss_post = Post(title='example xss post', body=self.xss_str,
body_markup_type='markdown', comment=self.xss_str)
self.xss_post.save()
self.plain_str = ('<span style="color: red">plain</span> post\n\n'
'http://example.com')
self.pp = Post(title='example plain post', body=self.plain_str,
body_markup_type='plain', comment=self.plain_str,
comment_markup_type='plain')
self.pp.save()
def test_verbose_name(self):
self.assertEqual(self.mp._meta.get_field('body').verbose_name,
'body of post')
def test_markup_body(self):
self.assertEqual(self.mp.body.raw, '**markdown**')
self.assertEqual(self.mp.body.rendered,
'<p><strong>markdown</strong></p>')
self.assertEqual(self.mp.body.markup_type, 'markdown')
def test_markup_unicode(self):
u = smart_text(self.rp.body.rendered)
self.assertEqual(u, '<p><em>ReST</em></p>\n')
def test_from_database(self):
""" Test that data loads back from the database correctly and 'post'
has the right type."""
p1 = Post.objects.get(pk=self.mp.pk)
self.assertTrue(isinstance(p1.body, Markup))
self.assertEqual(smart_text(p1.body),
'<p><strong>markdown</strong></p>')
## Assignment ##
def test_body_assignment(self):
self.rp.body = '**ReST**'
self.rp.save()
self.assertEqual(smart_text(self.rp.body),
'<p><strong>ReST</strong></p>\n')
def test_raw_assignment(self):
self.rp.body.raw = '*ReST*'
self.rp.save()
self.assertEqual(smart_text(self.rp.body), '<p><em>ReST</em></p>\n')
def test_rendered_assignment(self):
def f():
self.rp.body.rendered = 'this should fail'
self.assertRaises(AttributeError, f)
def test_body_type_assignment(self):
self.rp.body.markup_type = 'markdown'
self.rp.save()
self.assertEqual(self.rp.body.markup_type, 'markdown')
self.assertEqual(smart_text(self.rp.body), '<p><em>ReST</em></p>')
## Serialization ##
def test_serialize_to_json(self):
stream = serializers.serialize('json', Post.objects.all())
# Load the data back into Python so that a failed comparison gives a
# better diff output.
actual = json.loads(stream)
expected = [
{"pk": 1, "model": "tests.post",
"fields": {"body": "**markdown**",
"comment": "",
"_comment_rendered": "",
"_body_rendered": "<p><strong>markdown</strong></p>",
"title": "example markdown post",
"comment_markup_type": "markdown",
"body_markup_type": "markdown"}},
{"pk": 2, "model": "tests.post",
"fields": {"body": "*ReST*",
"comment": "",
"_comment_rendered": "",
"_body_rendered": "<p><em>ReST</em></p>\n",
"title": "example restructuredtext post",
"comment_markup_type": "markdown",
"body_markup_type": "ReST"}},
{"pk": 3, "model": "tests.post",
"fields": {"body": "<script>alert(\'xss\');</script>",
"comment": "<script>alert(\'xss\');</script>",
"_comment_rendered": (
"<p><script>alert("
"'xss');</script></p>"),
"_body_rendered": "<script>alert(\'xss\');</script>",
"title": "example xss post",
"comment_markup_type": "markdown",
"body_markup_type": "markdown"}},
{"pk": 4, "model": "tests.post",
"fields": {"body": ('<span style="color: red">plain</span> '
'post\n\nhttp://example.com'),
"comment": ('<span style="color: red">plain</span> '
'post\n\nhttp://example.com'),
"_comment_rendered": (
'<p>&lt;span style=&quot;color: red'
'&quot;&gt;plain&lt;/span&gt; '
'post</p>\n\n<p>http://example.com</p>'),
"_body_rendered": ('<p><span style="color: '
'red">plain</span> '
'post</p>\n\n<p>http://example.com'
'</p>'),
"title": "example plain post",
"comment_markup_type": "plain",
"body_markup_type": "plain"}},
]
self.assertEqual(expected, actual)
def test_deserialize_json(self):
stream = serializers.serialize('json', Post.objects.all())
obj = list(serializers.deserialize('json', stream))[0]
self.assertEqual(obj.object, self.mp)
def test_value_to_string(self):
"""
Ensure field converts to string during _meta access
Other libraries (Django REST framework, etc) go directly to the
field layer to serialize, which can cause a "unicode object has no
property called 'raw'" error. This tests the bugfix.
"""
obj = self.rp
field = self.rp._meta.get_field_by_name('body')[0]
self.assertNotEqual(field.value_to_string(obj), u'') # expected
self.assertEqual(field.value_to_string(None), u'') # edge case
## Other ##
def test_escape_html(self):
# the rendered string has been escaped
self.assertEqual(self.xss_post.comment.raw, self.xss_str)
self.assertEqual(
smart_text(self.xss_post.comment.rendered),
'<p><script>alert('xss');</script></p>')
def test_escape_html_false(self):
# both strings here are the xss_str, no escaping was done
self.assertEqual(self.xss_post.body.raw, self.xss_str)
self.assertEqual(smart_text(self.xss_post.body.rendered), self.xss_str)
def test_inheritance(self):
# test that concrete correctly got the added fields
concrete_fields = [f.name for f in Concrete._meta.fields]
self.assertEqual(concrete_fields, ['id', 'content',
'content_markup_type',
'_content_rendered'])
def test_markup_type_validation(self):
self.assertRaises(ValueError, MarkupField, 'verbose name',
'markup_field', 'bad_markup_type')
def test_default_markup_types(self):
for markup_type in DEFAULT_MARKUP_TYPES:
rendered = markup_type[1]('test')
self.assertTrue(hasattr(rendered, '__str__'))
def test_plain_markup_urlize(self):
for key, func in DEFAULT_MARKUP_TYPES:
if key != 'plain':
continue
txt1 = 'http://example.com some text'
txt2 = 'Some http://example.com text'
txt3 = 'Some text http://example.com'
txt4 = 'http://example.com. some text'
txt5 = 'Some http://example.com. text'
txt6 = 'Some text http://example.com.'
txt7 = '.http://example.com some text'
txt8 = 'Some .http://example.com text'
txt9 = 'Some text .http://example.com'
self.assertEqual(
func(txt1),
'<p><a href="http://example.com">http://example.com</a> some text</p>')
self.assertEqual(
func(txt2),
'<p>Some <a href="http://example.com">http://example.com</a> text</p>')
self.assertEqual(
func(txt3),
'<p>Some text <a href="http://example.com">http://example.com</a></p>')
self.assertEqual(
func(txt4),
'<p><a href="http://example.com">http://example.com</a>. some text</p>')
self.assertEqual(
func(txt5),
'<p>Some <a href="http://example.com">http://example.com</a>. text</p>')
self.assertEqual(
func(txt6),
'<p>Some text <a href="http://example.com">http://example.com</a>.</p>')
self.assertEqual(func(txt7), '<p>.http://example.com some text</p>')
self.assertEqual(func(txt8), '<p>Some .http://example.com text</p>')
self.assertEqual(func(txt9), '<p>Some text .http://example.com</p>')
break
class MarkupWidgetTests(TestCase):
def test_markuptextarea_used(self):
self.assertTrue(isinstance(MarkupField().formfield().widget,
MarkupTextarea))
self.assertTrue(isinstance(ArticleForm()['normal_field'].field.widget,
MarkupTextarea))
def test_markuptextarea_render(self):
a = Article(normal_field='**normal**',
normal_field_markup_type='markdown',
default_field='**default**',
markdown_field='**markdown**',
markup_choices_field_markup_type='nomarkup')
a.save()
af = ArticleForm(instance=a)
self.assertHTMLEqual(
smart_text(af['normal_field']),
'<textarea id="id_normal_field" rows="10" cols="40" '
'name="normal_field">**normal**</textarea>'
)
def test_no_markup_type_field_if_set(self):
"""ensure that a field with non-editable markup_type set does not
have a _markup_type field"""
self.assertTrue('markdown_field_markup_type' not in
ArticleForm().fields.keys())
def test_markup_type_choices(self):
self.assertEqual(
ArticleForm().fields['normal_field_markup_type'].choices,
[('', '--'), ('markdown', 'markdown'), ('ReST', 'ReST'),
('plain', 'plain')])
self.assertEqual(
ArticleForm().fields['markup_choices_field_markup_type'].choices,
[('', '--'), ('pandamarkup', 'pandamarkup'),
('nomarkup', 'nomarkup')])
def test_default_markup_type(self):
self.assertTrue(
ArticleForm().fields['normal_field_markup_type'].initial is None)
self.assertEqual(
ArticleForm().fields['default_field_markup_type'].initial,
'markdown')
def test_model_admin_field(self):
# borrows from regressiontests/admin_widgets/tests.py
from django.contrib import admin
ma = admin.ModelAdmin(Post, admin.site)
self.assertTrue(isinstance(ma.formfield_for_dbfield(
Post._meta.get_field('body')).widget, AdminMarkupTextareaWidget))
|
