django-rest-framework/rest_framework/tests/relations_pk.py

421 lines
17 KiB
Python
Raw Normal View History

2013-01-02 22:06:02 +04:00
from __future__ import unicode_literals
2012-11-02 23:11:40 +04:00
from django.test import TestCase
from rest_framework import serializers
from rest_framework.tests.models import ManyToManyTarget, ManyToManySource, ForeignKeyTarget, ForeignKeySource, NullableForeignKeySource, OneToOneTarget, NullableOneToOneSource
from rest_framework.compat import six
2012-11-02 23:11:40 +04:00
2012-11-03 00:53:33 +04:00
class ManyToManyTargetSerializer(serializers.ModelSerializer):
2013-02-07 13:14:58 +04:00
sources = serializers.PrimaryKeyRelatedField(many=True)
2012-11-02 23:11:40 +04:00
class Meta:
2012-11-03 00:53:33 +04:00
model = ManyToManyTarget
2012-11-02 23:11:40 +04:00
2012-11-03 00:53:33 +04:00
class ManyToManySourceSerializer(serializers.ModelSerializer):
2012-11-02 23:11:40 +04:00
class Meta:
2012-11-03 00:53:33 +04:00
model = ManyToManySource
class ForeignKeyTargetSerializer(serializers.ModelSerializer):
2013-02-07 13:14:58 +04:00
sources = serializers.PrimaryKeyRelatedField(many=True)
2012-11-03 00:53:33 +04:00
class Meta:
model = ForeignKeyTarget
class ForeignKeySourceSerializer(serializers.ModelSerializer):
class Meta:
model = ForeignKeySource
2012-11-02 23:11:40 +04:00
2012-12-08 01:32:39 +04:00
class NullableForeignKeySourceSerializer(serializers.ModelSerializer):
class Meta:
model = NullableForeignKeySource
# OneToOne
class NullableOneToOneTargetSerializer(serializers.ModelSerializer):
nullable_source = serializers.PrimaryKeyRelatedField()
class Meta:
model = OneToOneTarget
2012-11-02 23:11:40 +04:00
# TODO: Add test that .data cannot be accessed prior to .is_valid
2012-12-08 01:32:39 +04:00
class PKManyToManyTests(TestCase):
2012-11-02 23:11:40 +04:00
def setUp(self):
for idx in range(1, 4):
2012-11-03 00:53:33 +04:00
target = ManyToManyTarget(name='target-%d' % idx)
2012-11-02 23:11:40 +04:00
target.save()
2012-11-03 00:53:33 +04:00
source = ManyToManySource(name='source-%d' % idx)
2012-11-02 23:11:40 +04:00
source.save()
2012-11-03 00:53:33 +04:00
for target in ManyToManyTarget.objects.all():
2012-11-02 23:11:40 +04:00
source.targets.add(target)
def test_many_to_many_retrieve(self):
2012-11-03 00:53:33 +04:00
queryset = ManyToManySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ManyToManySourceSerializer(queryset, many=True)
2012-11-02 23:11:40 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'targets': [1]},
{'id': 2, 'name': 'source-2', 'targets': [1, 2]},
{'id': 3, 'name': 'source-3', 'targets': [1, 2, 3]}
2012-11-02 23:11:40 +04:00
]
self.assertEquals(serializer.data, expected)
def test_reverse_many_to_many_retrieve(self):
2012-11-03 00:53:33 +04:00
queryset = ManyToManyTarget.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ManyToManyTargetSerializer(queryset, many=True)
2012-11-02 23:11:40 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'target-1', 'sources': [1, 2, 3]},
{'id': 2, 'name': 'target-2', 'sources': [2, 3]},
{'id': 3, 'name': 'target-3', 'sources': [3]}
2012-11-02 23:11:40 +04:00
]
self.assertEquals(serializer.data, expected)
def test_many_to_many_update(self):
2013-01-02 22:06:02 +04:00
data = {'id': 1, 'name': 'source-1', 'targets': [1, 2, 3]}
2012-11-03 00:53:33 +04:00
instance = ManyToManySource.objects.get(pk=1)
serializer = ManyToManySourceSerializer(instance, data=data)
2012-11-02 23:11:40 +04:00
self.assertTrue(serializer.is_valid())
2012-11-03 00:53:33 +04:00
serializer.save()
self.assertEquals(serializer.data, data)
2012-11-02 23:11:40 +04:00
# Ensure source 1 is updated, and everything else is as expected
2012-11-03 00:53:33 +04:00
queryset = ManyToManySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ManyToManySourceSerializer(queryset, many=True)
2012-11-02 23:11:40 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'targets': [1, 2, 3]},
{'id': 2, 'name': 'source-2', 'targets': [1, 2]},
{'id': 3, 'name': 'source-3', 'targets': [1, 2, 3]}
2012-11-02 23:11:40 +04:00
]
self.assertEquals(serializer.data, expected)
def test_reverse_many_to_many_update(self):
2013-01-02 22:06:02 +04:00
data = {'id': 1, 'name': 'target-1', 'sources': [1]}
2012-11-03 00:53:33 +04:00
instance = ManyToManyTarget.objects.get(pk=1)
serializer = ManyToManyTargetSerializer(instance, data=data)
2012-11-02 23:11:40 +04:00
self.assertTrue(serializer.is_valid())
2012-11-03 00:53:33 +04:00
serializer.save()
self.assertEquals(serializer.data, data)
2012-11-02 23:11:40 +04:00
# Ensure target 1 is updated, and everything else is as expected
2012-11-03 00:53:33 +04:00
queryset = ManyToManyTarget.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ManyToManyTargetSerializer(queryset, many=True)
2012-11-02 23:11:40 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'target-1', 'sources': [1]},
{'id': 2, 'name': 'target-2', 'sources': [2, 3]},
{'id': 3, 'name': 'target-3', 'sources': [3]}
2012-11-02 23:11:40 +04:00
]
self.assertEquals(serializer.data, expected)
2012-11-03 00:53:33 +04:00
2012-12-08 16:29:35 +04:00
def test_many_to_many_create(self):
2013-01-02 22:06:02 +04:00
data = {'id': 4, 'name': 'source-4', 'targets': [1, 3]}
2012-12-08 16:29:35 +04:00
serializer = ManyToManySourceSerializer(data=data)
self.assertTrue(serializer.is_valid())
obj = serializer.save()
self.assertEquals(serializer.data, data)
2013-01-02 22:06:02 +04:00
self.assertEqual(obj.name, 'source-4')
2012-12-08 16:29:35 +04:00
# Ensure source 4 is added, and everything else is as expected
queryset = ManyToManySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ManyToManySourceSerializer(queryset, many=True)
2012-12-08 16:29:35 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'targets': [1]},
{'id': 2, 'name': 'source-2', 'targets': [1, 2]},
{'id': 3, 'name': 'source-3', 'targets': [1, 2, 3]},
{'id': 4, 'name': 'source-4', 'targets': [1, 3]},
2012-12-08 16:29:35 +04:00
]
self.assertEquals(serializer.data, expected)
def test_reverse_many_to_many_create(self):
2013-01-02 22:06:02 +04:00
data = {'id': 4, 'name': 'target-4', 'sources': [1, 3]}
serializer = ManyToManyTargetSerializer(data=data)
self.assertTrue(serializer.is_valid())
obj = serializer.save()
self.assertEquals(serializer.data, data)
2013-01-02 22:06:02 +04:00
self.assertEqual(obj.name, 'target-4')
# Ensure target 4 is added, and everything else is as expected
queryset = ManyToManyTarget.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ManyToManyTargetSerializer(queryset, many=True)
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'target-1', 'sources': [1, 2, 3]},
{'id': 2, 'name': 'target-2', 'sources': [2, 3]},
{'id': 3, 'name': 'target-3', 'sources': [3]},
{'id': 4, 'name': 'target-4', 'sources': [1, 3]}
]
self.assertEquals(serializer.data, expected)
2012-11-03 00:53:33 +04:00
2012-11-13 15:47:32 +04:00
2012-12-08 01:32:39 +04:00
class PKForeignKeyTests(TestCase):
2012-11-03 00:53:33 +04:00
def setUp(self):
target = ForeignKeyTarget(name='target-1')
target.save()
new_target = ForeignKeyTarget(name='target-2')
new_target.save()
for idx in range(1, 4):
source = ForeignKeySource(name='source-%d' % idx, target=target)
source.save()
def test_foreign_key_retrieve(self):
queryset = ForeignKeySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ForeignKeySourceSerializer(queryset, many=True)
2012-11-03 00:53:33 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'target': 1},
{'id': 2, 'name': 'source-2', 'target': 1},
{'id': 3, 'name': 'source-3', 'target': 1}
2012-11-03 00:53:33 +04:00
]
self.assertEquals(serializer.data, expected)
def test_reverse_foreign_key_retrieve(self):
queryset = ForeignKeyTarget.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ForeignKeyTargetSerializer(queryset, many=True)
2012-11-03 00:53:33 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'target-1', 'sources': [1, 2, 3]},
{'id': 2, 'name': 'target-2', 'sources': []},
2012-11-03 00:53:33 +04:00
]
self.assertEquals(serializer.data, expected)
def test_foreign_key_update(self):
2013-01-02 22:06:02 +04:00
data = {'id': 1, 'name': 'source-1', 'target': 2}
2012-11-03 00:53:33 +04:00
instance = ForeignKeySource.objects.get(pk=1)
serializer = ForeignKeySourceSerializer(instance, data=data)
2012-11-03 00:53:33 +04:00
self.assertTrue(serializer.is_valid())
self.assertEquals(serializer.data, data)
serializer.save()
2012-12-08 01:32:39 +04:00
# Ensure source 1 is updated, and everything else is as expected
2012-11-03 00:53:33 +04:00
queryset = ForeignKeySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ForeignKeySourceSerializer(queryset, many=True)
2012-11-03 00:53:33 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'target': 2},
{'id': 2, 'name': 'source-2', 'target': 1},
{'id': 3, 'name': 'source-3', 'target': 1}
2012-12-08 01:32:39 +04:00
]
self.assertEquals(serializer.data, expected)
def test_foreign_key_update_incorrect_type(self):
2013-02-01 18:03:28 +04:00
data = {'id': 1, 'name': 'source-1', 'target': 'foo'}
instance = ForeignKeySource.objects.get(pk=1)
serializer = ForeignKeySourceSerializer(instance, data=data)
self.assertFalse(serializer.is_valid())
self.assertEquals(serializer.errors, {'target': ['Incorrect type. Expected pk value, received %s.' % six.text_type.__name__]})
2012-12-29 22:26:47 +04:00
def test_reverse_foreign_key_update(self):
2013-01-02 22:06:02 +04:00
data = {'id': 2, 'name': 'target-2', 'sources': [1, 3]}
2012-12-29 22:26:47 +04:00
instance = ForeignKeyTarget.objects.get(pk=2)
serializer = ForeignKeyTargetSerializer(instance, data=data)
self.assertTrue(serializer.is_valid())
# We shouldn't have saved anything to the db yet since save
# hasn't been called.
queryset = ForeignKeyTarget.objects.all()
2013-02-13 00:07:35 +04:00
new_serializer = ForeignKeyTargetSerializer(queryset, many=True)
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'target-1', 'sources': [1, 2, 3]},
{'id': 2, 'name': 'target-2', 'sources': []},
]
self.assertEquals(new_serializer.data, expected)
2012-12-29 22:26:47 +04:00
serializer.save()
self.assertEquals(serializer.data, data)
2012-12-29 22:26:47 +04:00
# Ensure target 2 is update, and everything else is as expected
queryset = ForeignKeyTarget.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ForeignKeyTargetSerializer(queryset, many=True)
2012-12-29 22:26:47 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'target-1', 'sources': [2]},
{'id': 2, 'name': 'target-2', 'sources': [1, 3]},
2012-12-29 22:26:47 +04:00
]
self.assertEquals(serializer.data, expected)
2012-12-29 19:51:32 +04:00
def test_foreign_key_create(self):
2013-01-02 22:06:02 +04:00
data = {'id': 4, 'name': 'source-4', 'target': 2}
2012-12-29 19:51:32 +04:00
serializer = ForeignKeySourceSerializer(data=data)
self.assertTrue(serializer.is_valid())
obj = serializer.save()
self.assertEquals(serializer.data, data)
2013-01-02 22:06:02 +04:00
self.assertEqual(obj.name, 'source-4')
2012-12-29 19:51:32 +04:00
# Ensure source 4 is added, and everything else is as expected
2012-12-29 19:51:32 +04:00
queryset = ForeignKeySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ForeignKeySourceSerializer(queryset, many=True)
2012-12-29 19:51:32 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'target': 1},
{'id': 2, 'name': 'source-2', 'target': 1},
{'id': 3, 'name': 'source-3', 'target': 1},
{'id': 4, 'name': 'source-4', 'target': 2},
2012-12-29 19:51:32 +04:00
]
self.assertEquals(serializer.data, expected)
2012-12-29 20:51:41 +04:00
def test_reverse_foreign_key_create(self):
2013-01-02 22:06:02 +04:00
data = {'id': 3, 'name': 'target-3', 'sources': [1, 3]}
2012-12-29 20:51:41 +04:00
serializer = ForeignKeyTargetSerializer(data=data)
self.assertTrue(serializer.is_valid())
obj = serializer.save()
self.assertEquals(serializer.data, data)
2013-01-02 22:06:02 +04:00
self.assertEqual(obj.name, 'target-3')
2012-12-29 20:51:41 +04:00
# Ensure target 3 is added, and everything else is as expected
2012-12-29 20:51:41 +04:00
queryset = ForeignKeyTarget.objects.all()
2013-02-13 00:07:35 +04:00
serializer = ForeignKeyTargetSerializer(queryset, many=True)
2012-12-29 20:51:41 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'target-1', 'sources': [2]},
{'id': 2, 'name': 'target-2', 'sources': []},
{'id': 3, 'name': 'target-3', 'sources': [1, 3]},
2012-12-29 20:51:41 +04:00
]
self.assertEquals(serializer.data, expected)
2012-12-29 19:51:32 +04:00
2012-12-08 01:32:39 +04:00
def test_foreign_key_update_with_invalid_null(self):
2013-01-02 22:06:02 +04:00
data = {'id': 1, 'name': 'source-1', 'target': None}
2012-12-08 01:32:39 +04:00
instance = ForeignKeySource.objects.get(pk=1)
serializer = ForeignKeySourceSerializer(instance, data=data)
self.assertFalse(serializer.is_valid())
self.assertEquals(serializer.errors, {'target': ['This field is required.']})
2012-12-08 01:32:39 +04:00
class PKNullableForeignKeyTests(TestCase):
def setUp(self):
target = ForeignKeyTarget(name='target-1')
target.save()
for idx in range(1, 4):
if idx == 3:
target = None
2012-12-08 01:32:39 +04:00
source = NullableForeignKeySource(name='source-%d' % idx, target=target)
source.save()
def test_foreign_key_retrieve_with_null(self):
queryset = NullableForeignKeySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = NullableForeignKeySourceSerializer(queryset, many=True)
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'target': 1},
{'id': 2, 'name': 'source-2', 'target': 1},
{'id': 3, 'name': 'source-3', 'target': None},
]
self.assertEquals(serializer.data, expected)
2012-12-08 16:48:27 +04:00
def test_foreign_key_create_with_valid_null(self):
2013-01-02 22:06:02 +04:00
data = {'id': 4, 'name': 'source-4', 'target': None}
2012-12-08 16:48:27 +04:00
serializer = NullableForeignKeySourceSerializer(data=data)
self.assertTrue(serializer.is_valid())
obj = serializer.save()
self.assertEquals(serializer.data, data)
2013-01-02 22:06:02 +04:00
self.assertEqual(obj.name, 'source-4')
2012-12-08 16:48:27 +04:00
# Ensure source 4 is created, and everything else is as expected
queryset = NullableForeignKeySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = NullableForeignKeySourceSerializer(queryset, many=True)
2012-12-08 16:48:27 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'target': 1},
{'id': 2, 'name': 'source-2', 'target': 1},
{'id': 3, 'name': 'source-3', 'target': None},
{'id': 4, 'name': 'source-4', 'target': None}
2012-12-08 16:48:27 +04:00
]
self.assertEquals(serializer.data, expected)
def test_foreign_key_create_with_valid_emptystring(self):
"""
The emptystring should be interpreted as null in the context
of relationships.
"""
2013-01-02 22:06:02 +04:00
data = {'id': 4, 'name': 'source-4', 'target': ''}
expected_data = {'id': 4, 'name': 'source-4', 'target': None}
2012-12-08 16:48:27 +04:00
serializer = NullableForeignKeySourceSerializer(data=data)
self.assertTrue(serializer.is_valid())
obj = serializer.save()
self.assertEquals(serializer.data, expected_data)
2013-01-02 22:06:02 +04:00
self.assertEqual(obj.name, 'source-4')
2012-12-08 16:48:27 +04:00
# Ensure source 4 is created, and everything else is as expected
queryset = NullableForeignKeySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = NullableForeignKeySourceSerializer(queryset, many=True)
2012-12-08 16:48:27 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'target': 1},
{'id': 2, 'name': 'source-2', 'target': 1},
{'id': 3, 'name': 'source-3', 'target': None},
{'id': 4, 'name': 'source-4', 'target': None}
2012-12-08 16:48:27 +04:00
]
self.assertEquals(serializer.data, expected)
2012-12-08 01:32:39 +04:00
def test_foreign_key_update_with_valid_null(self):
2013-01-02 22:06:02 +04:00
data = {'id': 1, 'name': 'source-1', 'target': None}
2012-12-08 01:32:39 +04:00
instance = NullableForeignKeySource.objects.get(pk=1)
serializer = NullableForeignKeySourceSerializer(instance, data=data)
self.assertTrue(serializer.is_valid())
self.assertEquals(serializer.data, data)
serializer.save()
2012-12-08 16:48:27 +04:00
# Ensure source 1 is updated, and everything else is as expected
queryset = NullableForeignKeySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = NullableForeignKeySourceSerializer(queryset, many=True)
2012-12-08 16:48:27 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'target': None},
{'id': 2, 'name': 'source-2', 'target': 1},
{'id': 3, 'name': 'source-3', 'target': None}
2012-12-08 16:48:27 +04:00
]
self.assertEquals(serializer.data, expected)
def test_foreign_key_update_with_valid_emptystring(self):
"""
The emptystring should be interpreted as null in the context
of relationships.
"""
2013-01-02 22:06:02 +04:00
data = {'id': 1, 'name': 'source-1', 'target': ''}
expected_data = {'id': 1, 'name': 'source-1', 'target': None}
2012-12-08 16:48:27 +04:00
instance = NullableForeignKeySource.objects.get(pk=1)
serializer = NullableForeignKeySourceSerializer(instance, data=data)
self.assertTrue(serializer.is_valid())
self.assertEquals(serializer.data, expected_data)
serializer.save()
2012-12-08 01:32:39 +04:00
# Ensure source 1 is updated, and everything else is as expected
queryset = NullableForeignKeySource.objects.all()
2013-02-13 00:07:35 +04:00
serializer = NullableForeignKeySourceSerializer(queryset, many=True)
2012-12-08 01:32:39 +04:00
expected = [
2013-01-02 22:06:02 +04:00
{'id': 1, 'name': 'source-1', 'target': None},
{'id': 2, 'name': 'source-2', 'target': 1},
{'id': 3, 'name': 'source-3', 'target': None}
2012-11-03 00:53:33 +04:00
]
self.assertEquals(serializer.data, expected)
# reverse foreign keys MUST be read_only
# In the general case they do not provide .remove() or .clear()
# and cannot be arbitrarily set.
# def test_reverse_foreign_key_update(self):
2013-01-02 22:06:02 +04:00
# data = {'id': 1, 'name': 'target-1', 'sources': [1]}
2012-11-03 00:53:33 +04:00
# instance = ForeignKeyTarget.objects.get(pk=1)
# serializer = ForeignKeyTargetSerializer(instance, data=data)
2012-11-03 00:53:33 +04:00
# self.assertTrue(serializer.is_valid())
# self.assertEquals(serializer.data, data)
# serializer.save()
# # Ensure target 1 is updated, and everything else is as expected
# queryset = ForeignKeyTarget.objects.all()
2013-02-13 00:07:35 +04:00
# serializer = ForeignKeyTargetSerializer(queryset, many=True)
2012-11-03 00:53:33 +04:00
# expected = [
2013-01-02 22:06:02 +04:00
# {'id': 1, 'name': 'target-1', 'sources': [1]},
# {'id': 2, 'name': 'target-2', 'sources': []},
2012-11-03 00:53:33 +04:00
# ]
# self.assertEquals(serializer.data, expected)
class PKNullableOneToOneTests(TestCase):
def setUp(self):
target = OneToOneTarget(name='target-1')
target.save()
new_target = OneToOneTarget(name='target-2')
new_target.save()
source = NullableOneToOneSource(name='source-1', target=target)
source.save()
def test_reverse_foreign_key_retrieve_with_null(self):
queryset = OneToOneTarget.objects.all()
2013-02-13 00:07:35 +04:00
serializer = NullableOneToOneTargetSerializer(queryset, many=True)
expected = [
2013-02-01 18:03:28 +04:00
{'id': 1, 'name': 'target-1', 'nullable_source': 1},
{'id': 2, 'name': 'target-2', 'nullable_source': None},
]
self.assertEquals(serializer.data, expected)