| 1 |
from xml.dom import minidom |
| 2 |
|
| 3 |
from django.core import serializers |
| 4 |
from django.core.serializers.xml_serializer import DTDForbidden |
| 5 |
from django.test import TestCase, TransactionTestCase |
| 6 |
|
| 7 |
from .tests import SerializersTestBase, SerializersTransactionTestBase |
| 8 |
|
| 9 |
|
| 10 |
class XmlSerializerTestCase(SerializersTestBase, TestCase): |
| 11 |
serializer_name = "xml" |
| 12 |
pkless_str = """<?xml version="1.0" encoding="utf-8"?> |
| 13 |
<django-objects version="1.0"> |
| 14 |
<object model="serializers.category"> |
| 15 |
<field type="CharField" name="name">Reference</field> |
| 16 |
</object> |
| 17 |
<object model="serializers.category"> |
| 18 |
<field type="CharField" name="name">Non-fiction</field> |
| 19 |
</object> |
| 20 |
</django-objects>""" |
| 21 |
mapping_ordering_str = """<?xml version="1.0" encoding="utf-8"?> |
| 22 |
<django-objects version="1.0"> |
| 23 |
<object model="serializers.article" pk="%(article_pk)s"> |
| 24 |
<field name="author" rel="ManyToOneRel" to="serializers.author">%(author_pk)s</field> |
| 25 |
<field name="headline" type="CharField">Poker has no place on ESPN</field> |
| 26 |
<field name="pub_date" type="DateTimeField">2006-06-16T11:00:00</field> |
| 27 |
<field name="categories" rel="ManyToManyRel" to="serializers.category"><object pk="%(first_category_pk)s"></object><object pk="%(second_category_pk)s"></object></field> |
| 28 |
<field name="meta_data" rel="ManyToManyRel" to="serializers.categorymetadata"></field> |
| 29 |
<field name="topics" rel="ManyToManyRel" to="serializers.topic"></field> |
| 30 |
</object> |
| 31 |
</django-objects>""" # NOQA |
| 32 |
|
| 33 |
@staticmethod |
| 34 |
def _validate_output(serial_str): |
| 35 |
try: |
| 36 |
minidom.parseString(serial_str) |
| 37 |
except Exception: |
| 38 |
return False |
| 39 |
else: |
| 40 |
return True |
| 41 |
|
| 42 |
@staticmethod |
| 43 |
def _get_pk_values(serial_str): |
| 44 |
ret_list = [] |
| 45 |
dom = minidom.parseString(serial_str) |
| 46 |
fields = dom.getElementsByTagName("object") |
| 47 |
for field in fields: |
| 48 |
ret_list.append(field.getAttribute("pk")) |
| 49 |
return ret_list |
| 50 |
|
| 51 |
@staticmethod |
| 52 |
def _get_field_values(serial_str, field_name): |
| 53 |
ret_list = [] |
| 54 |
dom = minidom.parseString(serial_str) |
| 55 |
fields = dom.getElementsByTagName("field") |
| 56 |
for field in fields: |
| 57 |
if field.getAttribute("name") == field_name: |
| 58 |
temp = [] |
| 59 |
for child in field.childNodes: |
| 60 |
temp.append(child.nodeValue) |
| 61 |
ret_list.append("".join(temp)) |
| 62 |
return ret_list |
| 63 |
|
| 64 |
def test_control_char_failure(self): |
| 65 |
""" |
| 66 |
Serializing control characters with XML should fail as those characters |
| 67 |
are not supported in the XML 1.0 standard (except HT, LF, CR). |
| 68 |
""" |
| 69 |
self.a1.headline = "This contains \u0001 control \u0011 chars" |
| 70 |
msg = "Article.headline (pk:%s) contains unserializable characters" % self.a1.pk |
| 71 |
with self.assertRaisesMessage(ValueError, msg): |
| 72 |
serializers.serialize(self.serializer_name, [self.a1]) |
| 73 |
self.a1.headline = "HT \u0009, LF \u000a, and CR \u000d are allowed" |
| 74 |
self.assertIn( |
| 75 |
"HT \t, LF \n, and CR \r are allowed", |
| 76 |
serializers.serialize(self.serializer_name, [self.a1]), |
| 77 |
) |
| 78 |
|
| 79 |
def test_no_dtd(self): |
| 80 |
""" |
| 81 |
The XML deserializer shouldn't allow a DTD. |
| 82 |
|
| 83 |
This is the most straightforward way to prevent all entity definitions |
| 84 |
and avoid both external entities and entity-expansion attacks. |
| 85 |
""" |
| 86 |
xml = ( |
| 87 |
'<?xml version="1.0" standalone="no"?>' |
| 88 |
'<!DOCTYPE example SYSTEM "http://example.com/example.dtd">' |
| 89 |
) |
| 90 |
with self.assertRaises(DTDForbidden): |
| 91 |
next(serializers.deserialize("xml", xml)) |
| 92 |
|
| 93 |
|
| 94 |
class XmlSerializerTransactionTestCase( |
| 95 |
SerializersTransactionTestBase, TransactionTestCase |
| 96 |
): |
| 97 |
serializer_name = "xml" |
| 98 |
fwd_ref_str = """<?xml version="1.0" encoding="utf-8"?> |
| 99 |
<django-objects version="1.0"> |
| 100 |
<object pk="1" model="serializers.article"> |
| 101 |
<field to="serializers.author" name="author" rel="ManyToOneRel">1</field> |
| 102 |
<field type="CharField" name="headline">Forward references pose no problem</field> |
| 103 |
<field type="DateTimeField" name="pub_date">2006-06-16T15:00:00</field> |
| 104 |
<field to="serializers.category" name="categories" rel="ManyToManyRel"> |
| 105 |
<object pk="1"></object> |
| 106 |
</field> |
| 107 |
<field to="serializers.categorymetadata" name="meta_data" rel="ManyToManyRel"></field> |
| 108 |
</object> |
| 109 |
<object pk="1" model="serializers.author"> |
| 110 |
<field type="CharField" name="name">Agnes</field> |
| 111 |
</object> |
| 112 |
<object pk="1" model="serializers.category"> |
| 113 |
<field type="CharField" name="name">Reference</field></object> |
| 114 |
</django-objects>""" # NOQA |