summaryrefslogtreecommitdiff
path: root/parts/django/tests/modeltests/serializers
diff options
context:
space:
mode:
Diffstat (limited to 'parts/django/tests/modeltests/serializers')
-rw-r--r--parts/django/tests/modeltests/serializers/__init__.py0
-rw-r--r--parts/django/tests/modeltests/serializers/models.py117
-rw-r--r--parts/django/tests/modeltests/serializers/tests.py417
3 files changed, 534 insertions, 0 deletions
diff --git a/parts/django/tests/modeltests/serializers/__init__.py b/parts/django/tests/modeltests/serializers/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/parts/django/tests/modeltests/serializers/__init__.py
diff --git a/parts/django/tests/modeltests/serializers/models.py b/parts/django/tests/modeltests/serializers/models.py
new file mode 100644
index 0000000..c12e73f
--- /dev/null
+++ b/parts/django/tests/modeltests/serializers/models.py
@@ -0,0 +1,117 @@
+# -*- coding: utf-8 -*-
+"""
+42. Serialization
+
+``django.core.serializers`` provides interfaces to converting Django
+``QuerySet`` objects to and from "flat" data (i.e. strings).
+"""
+
+from decimal import Decimal
+from django.db import models
+
+class Category(models.Model):
+ name = models.CharField(max_length=20)
+
+ class Meta:
+ ordering = ('name',)
+
+ def __unicode__(self):
+ return self.name
+
+
+class Author(models.Model):
+ name = models.CharField(max_length=20)
+
+ class Meta:
+ ordering = ('name',)
+
+ def __unicode__(self):
+ return self.name
+
+
+class Article(models.Model):
+ author = models.ForeignKey(Author)
+ headline = models.CharField(max_length=50)
+ pub_date = models.DateTimeField()
+ categories = models.ManyToManyField(Category)
+
+ class Meta:
+ ordering = ('pub_date',)
+
+ def __unicode__(self):
+ return self.headline
+
+
+class AuthorProfile(models.Model):
+ author = models.OneToOneField(Author, primary_key=True)
+ date_of_birth = models.DateField()
+
+ def __unicode__(self):
+ return u"Profile of %s" % self.author
+
+
+class Actor(models.Model):
+ name = models.CharField(max_length=20, primary_key=True)
+
+ class Meta:
+ ordering = ('name',)
+
+ def __unicode__(self):
+ return self.name
+
+
+class Movie(models.Model):
+ actor = models.ForeignKey(Actor)
+ title = models.CharField(max_length=50)
+ price = models.DecimalField(max_digits=6, decimal_places=2, default=Decimal('0.00'))
+
+ class Meta:
+ ordering = ('title',)
+
+ def __unicode__(self):
+ return self.title
+
+
+class Score(models.Model):
+ score = models.FloatField()
+
+
+class Team(object):
+ def __init__(self, title):
+ self.title = title
+
+ def __unicode__(self):
+ raise NotImplementedError("Not so simple")
+
+ def __str__(self):
+ raise NotImplementedError("Not so simple")
+
+ def to_string(self):
+ return "%s" % self.title
+
+
+class TeamField(models.CharField):
+ __metaclass__ = models.SubfieldBase
+
+ def __init__(self):
+ super(TeamField, self).__init__(max_length=100)
+
+ def get_db_prep_save(self, value):
+ return unicode(value.title)
+
+ def to_python(self, value):
+ if isinstance(value, Team):
+ return value
+ return Team(value)
+
+ def value_to_string(self, obj):
+ return self._get_val_from_obj(obj).to_string()
+
+
+class Player(models.Model):
+ name = models.CharField(max_length=50)
+ rank = models.IntegerField()
+ team = TeamField()
+
+ def __unicode__(self):
+ return u'%s (%d) playing for %s' % (self.name, self.rank, self.team.to_string())
diff --git a/parts/django/tests/modeltests/serializers/tests.py b/parts/django/tests/modeltests/serializers/tests.py
new file mode 100644
index 0000000..9b648a8
--- /dev/null
+++ b/parts/django/tests/modeltests/serializers/tests.py
@@ -0,0 +1,417 @@
+# -*- coding: utf-8 -*-
+from datetime import datetime
+from StringIO import StringIO
+from xml.dom import minidom
+
+from django.core import serializers
+from django.db import transaction
+from django.test import TestCase, TransactionTestCase, Approximate
+from django.utils import simplejson
+
+from models import Category, Author, Article, AuthorProfile, Actor, \
+ Movie, Score, Player, Team
+
+class SerializersTestBase(object):
+ @staticmethod
+ def _comparison_value(value):
+ return value
+
+ def setUp(self):
+ sports = Category.objects.create(name="Sports")
+ music = Category.objects.create(name="Music")
+ op_ed = Category.objects.create(name="Op-Ed")
+
+ self.joe = Author.objects.create(name="Joe")
+ self.jane = Author.objects.create(name="Jane")
+
+ self.a1 = Article(
+ author=self.jane,
+ headline="Poker has no place on ESPN",
+ pub_date=datetime(2006, 6, 16, 11, 00)
+ )
+ self.a1.save()
+ self.a1.categories = [sports, op_ed]
+
+ self.a2 = Article(
+ author=self.joe,
+ headline="Time to reform copyright",
+ pub_date=datetime(2006, 6, 16, 13, 00, 11, 345)
+ )
+ self.a2.save()
+ self.a2.categories = [music, op_ed]
+
+ def test_serialize(self):
+ """Tests that basic serialization works."""
+ serial_str = serializers.serialize(self.serializer_name,
+ Article.objects.all())
+ self.assertTrue(self._validate_output(serial_str))
+
+ def test_serializer_roundtrip(self):
+ """Tests that serialized content can be deserialized."""
+ serial_str = serializers.serialize(self.serializer_name,
+ Article.objects.all())
+ models = list(serializers.deserialize(self.serializer_name, serial_str))
+ self.assertEqual(len(models), 2)
+
+ def test_altering_serialized_output(self):
+ """
+ Tests the ability to create new objects by
+ modifying serialized content.
+ """
+ old_headline = "Poker has no place on ESPN"
+ new_headline = "Poker has no place on television"
+ serial_str = serializers.serialize(self.serializer_name,
+ Article.objects.all())
+ serial_str = serial_str.replace(old_headline, new_headline)
+ models = list(serializers.deserialize(self.serializer_name, serial_str))
+
+ # Prior to saving, old headline is in place
+ self.assertTrue(Article.objects.filter(headline=old_headline))
+ self.assertFalse(Article.objects.filter(headline=new_headline))
+
+ for model in models:
+ model.save()
+
+ # After saving, new headline is in place
+ self.assertTrue(Article.objects.filter(headline=new_headline))
+ self.assertFalse(Article.objects.filter(headline=old_headline))
+
+ def test_one_to_one_as_pk(self):
+ """
+ Tests that if you use your own primary key field
+ (such as a OneToOneField), it doesn't appear in the
+ serialized field list - it replaces the pk identifier.
+ """
+ profile = AuthorProfile(author=self.joe,
+ date_of_birth=datetime(1970,1,1))
+ profile.save()
+ serial_str = serializers.serialize(self.serializer_name,
+ AuthorProfile.objects.all())
+ self.assertFalse(self._get_field_values(serial_str, 'author'))
+
+ for obj in serializers.deserialize(self.serializer_name, serial_str):
+ self.assertEqual(obj.object.pk, self._comparison_value(self.joe.pk))
+
+ def test_serialize_field_subset(self):
+ """Tests that output can be restricted to a subset of fields"""
+ valid_fields = ('headline','pub_date')
+ invalid_fields = ("author", "categories")
+ serial_str = serializers.serialize(self.serializer_name,
+ Article.objects.all(),
+ fields=valid_fields)
+ for field_name in invalid_fields:
+ self.assertFalse(self._get_field_values(serial_str, field_name))
+
+ for field_name in valid_fields:
+ self.assertTrue(self._get_field_values(serial_str, field_name))
+
+ def test_serialize_unicode(self):
+ """Tests that unicode makes the roundtrip intact"""
+ actor_name = u"Za\u017c\u00f3\u0142\u0107"
+ movie_title = u'G\u0119\u015bl\u0105 ja\u017a\u0144'
+ ac = Actor(name=actor_name)
+ mv = Movie(title=movie_title, actor=ac)
+ ac.save()
+ mv.save()
+
+ serial_str = serializers.serialize(self.serializer_name, [mv])
+ self.assertEqual(self._get_field_values(serial_str, "title")[0], movie_title)
+ self.assertEqual(self._get_field_values(serial_str, "actor")[0], actor_name)
+
+ obj_list = list(serializers.deserialize(self.serializer_name, serial_str))
+ mv_obj = obj_list[0].object
+ self.assertEqual(mv_obj.title, movie_title)
+
+ def test_serialize_with_null_pk(self):
+ """
+ Tests that serialized data with no primary key results
+ in a model instance with no id
+ """
+ category = Category(name="Reference")
+ serial_str = serializers.serialize(self.serializer_name, [category])
+ pk_value = self._get_pk_values(serial_str)[0]
+ self.assertFalse(pk_value)
+
+ cat_obj = list(serializers.deserialize(self.serializer_name,
+ serial_str))[0].object
+ self.assertEqual(cat_obj.id, None)
+
+ def test_float_serialization(self):
+ """Tests that float values serialize and deserialize intact"""
+ sc = Score(score=3.4)
+ sc.save()
+ serial_str = serializers.serialize(self.serializer_name, [sc])
+ deserial_objs = list(serializers.deserialize(self.serializer_name,
+ serial_str))
+ self.assertEqual(deserial_objs[0].object.score, Approximate(3.4, places=1))
+
+ def test_custom_field_serialization(self):
+ """Tests that custom fields serialize and deserialize intact"""
+ team_str = "Spartak Moskva"
+ player = Player()
+ player.name = "Soslan Djanaev"
+ player.rank = 1
+ player.team = Team(team_str)
+ player.save()
+ serial_str = serializers.serialize(self.serializer_name,
+ Player.objects.all())
+ team = self._get_field_values(serial_str, "team")
+ self.assertTrue(team)
+ self.assertEqual(team[0], team_str)
+
+ deserial_objs = list(serializers.deserialize(self.serializer_name, serial_str))
+ self.assertEqual(deserial_objs[0].object.team.to_string(),
+ player.team.to_string())
+
+ def test_pre_1000ad_date(self):
+ """Tests that year values before 1000AD are properly formatted"""
+ # Regression for #12524 -- dates before 1000AD get prefixed
+ # 0's on the year
+ a = Article.objects.create(
+ author = self.jane,
+ headline = "Nobody remembers the early years",
+ pub_date = datetime(1, 2, 3, 4, 5, 6))
+
+ serial_str = serializers.serialize(self.serializer_name, [a])
+ date_values = self._get_field_values(serial_str, "pub_date")
+ self.assertEquals(date_values[0], "0001-02-03 04:05:06")
+
+ def test_pkless_serialized_strings(self):
+ """
+ Tests that serialized strings without PKs
+ can be turned into models
+ """
+ deserial_objs = list(serializers.deserialize(self.serializer_name,
+ self.pkless_str))
+ for obj in deserial_objs:
+ self.assertFalse(obj.object.id)
+ obj.save()
+ self.assertEqual(Category.objects.all().count(), 4)
+
+
+class SerializersTransactionTestBase(object):
+ def test_forward_refs(self):
+ """
+ Tests that objects ids can be referenced before they are
+ defined in the serialization data.
+ """
+ # The deserialization process needs to be contained
+ # within a transaction in order to test forward reference
+ # handling.
+ transaction.enter_transaction_management()
+ transaction.managed(True)
+ objs = serializers.deserialize(self.serializer_name, self.fwd_ref_str)
+ for obj in objs:
+ obj.save()
+ transaction.commit()
+ transaction.leave_transaction_management()
+
+ for model_cls in (Category, Author, Article):
+ self.assertEqual(model_cls.objects.all().count(), 1)
+ art_obj = Article.objects.all()[0]
+ self.assertEqual(art_obj.categories.all().count(), 1)
+ self.assertEqual(art_obj.author.name, "Agnes")
+
+
+class XmlSerializerTestCase(SerializersTestBase, TestCase):
+ serializer_name = "xml"
+ pkless_str = """<?xml version="1.0" encoding="utf-8"?>
+<django-objects version="1.0">
+ <object model="serializers.category">
+ <field type="CharField" name="name">Reference</field>
+ </object>
+</django-objects>"""
+
+ @staticmethod
+ def _comparison_value(value):
+ # The XML serializer handles everything as strings, so comparisons
+ # need to be performed on the stringified value
+ return unicode(value)
+
+ @staticmethod
+ def _validate_output(serial_str):
+ try:
+ minidom.parseString(serial_str)
+ except Exception:
+ return False
+ else:
+ return True
+
+ @staticmethod
+ def _get_pk_values(serial_str):
+ ret_list = []
+ dom = minidom.parseString(serial_str)
+ fields = dom.getElementsByTagName("object")
+ for field in fields:
+ ret_list.append(field.getAttribute("pk"))
+ return ret_list
+
+ @staticmethod
+ def _get_field_values(serial_str, field_name):
+ ret_list = []
+ dom = minidom.parseString(serial_str)
+ fields = dom.getElementsByTagName("field")
+ for field in fields:
+ if field.getAttribute("name") == field_name:
+ temp = []
+ for child in field.childNodes:
+ temp.append(child.nodeValue)
+ ret_list.append("".join(temp))
+ return ret_list
+
+class XmlSerializerTransactionTestCase(SerializersTransactionTestBase, TransactionTestCase):
+ serializer_name = "xml"
+ fwd_ref_str = """<?xml version="1.0" encoding="utf-8"?>
+<django-objects version="1.0">
+ <object pk="1" model="serializers.article">
+ <field to="serializers.author" name="author" rel="ManyToOneRel">1</field>
+ <field type="CharField" name="headline">Forward references pose no problem</field>
+ <field type="DateTimeField" name="pub_date">2006-06-16 15:00:00</field>
+ <field to="serializers.category" name="categories" rel="ManyToManyRel">
+ <object pk="1"></object>
+ </field>
+ </object>
+ <object pk="1" model="serializers.author">
+ <field type="CharField" name="name">Agnes</field>
+ </object>
+ <object pk="1" model="serializers.category">
+ <field type="CharField" name="name">Reference</field></object>
+</django-objects>"""
+
+
+class JsonSerializerTestCase(SerializersTestBase, TestCase):
+ serializer_name = "json"
+ pkless_str = """[{"pk": null, "model": "serializers.category", "fields": {"name": "Reference"}}]"""
+
+ @staticmethod
+ def _validate_output(serial_str):
+ try:
+ simplejson.loads(serial_str)
+ except Exception:
+ return False
+ else:
+ return True
+
+ @staticmethod
+ def _get_pk_values(serial_str):
+ ret_list = []
+ serial_list = simplejson.loads(serial_str)
+ for obj_dict in serial_list:
+ ret_list.append(obj_dict["pk"])
+ return ret_list
+
+ @staticmethod
+ def _get_field_values(serial_str, field_name):
+ ret_list = []
+ serial_list = simplejson.loads(serial_str)
+ for obj_dict in serial_list:
+ if field_name in obj_dict["fields"]:
+ ret_list.append(obj_dict["fields"][field_name])
+ return ret_list
+
+class JsonSerializerTransactionTestCase(SerializersTransactionTestBase, TransactionTestCase):
+ serializer_name = "json"
+ fwd_ref_str = """[
+ {
+ "pk": 1,
+ "model": "serializers.article",
+ "fields": {
+ "headline": "Forward references pose no problem",
+ "pub_date": "2006-06-16 15:00:00",
+ "categories": [1],
+ "author": 1
+ }
+ },
+ {
+ "pk": 1,
+ "model": "serializers.category",
+ "fields": {
+ "name": "Reference"
+ }
+ },
+ {
+ "pk": 1,
+ "model": "serializers.author",
+ "fields": {
+ "name": "Agnes"
+ }
+ }]"""
+
+try:
+ import yaml
+except ImportError:
+ pass
+else:
+ class YamlSerializerTestCase(SerializersTestBase, TestCase):
+ serializer_name = "yaml"
+ fwd_ref_str = """- fields:
+ headline: Forward references pose no problem
+ pub_date: 2006-06-16 15:00:00
+ categories: [1]
+ author: 1
+ pk: 1
+ model: serializers.article
+- fields:
+ name: Reference
+ pk: 1
+ model: serializers.category
+- fields:
+ name: Agnes
+ pk: 1
+ model: serializers.author"""
+
+ pkless_str = """- fields:
+ name: Reference
+ pk: null
+ model: serializers.category"""
+
+ @staticmethod
+ def _validate_output(serial_str):
+ try:
+ yaml.load(StringIO(serial_str))
+ except Exception:
+ return False
+ else:
+ return True
+
+ @staticmethod
+ def _get_pk_values(serial_str):
+ ret_list = []
+ stream = StringIO(serial_str)
+ for obj_dict in yaml.load(stream):
+ ret_list.append(obj_dict["pk"])
+ return ret_list
+
+ @staticmethod
+ def _get_field_values(serial_str, field_name):
+ ret_list = []
+ stream = StringIO(serial_str)
+ for obj_dict in yaml.load(stream):
+ if "fields" in obj_dict and field_name in obj_dict["fields"]:
+ field_value = obj_dict["fields"][field_name]
+ # yaml.load will return non-string objects for some
+ # of the fields we are interested in, this ensures that
+ # everything comes back as a string
+ if isinstance(field_value, basestring):
+ ret_list.append(field_value)
+ else:
+ ret_list.append(str(field_value))
+ return ret_list
+
+ class YamlSerializerTransactionTestCase(SerializersTransactionTestBase, TransactionTestCase):
+ serializer_name = "yaml"
+ fwd_ref_str = """- fields:
+ headline: Forward references pose no problem
+ pub_date: 2006-06-16 15:00:00
+ categories: [1]
+ author: 1
+ pk: 1
+ model: serializers.article
+- fields:
+ name: Reference
+ pk: 1
+ model: serializers.category
+- fields:
+ name: Agnes
+ pk: 1
+ model: serializers.author"""