summaryrefslogtreecommitdiff
path: root/tests/generic_relations
diff options
context:
space:
mode:
authorFlorian Apolloner <florian@apolloner.eu>2013-02-26 09:53:47 +0100
committerFlorian Apolloner <florian@apolloner.eu>2013-02-26 14:36:57 +0100
commit89f40e36246100df6a11316c31a76712ebc6c501 (patch)
tree6e65639683ddaf2027908d1ecb1739e0e2ff853b /tests/generic_relations
parentb3d2ccb5bfbaf6e7fe1f98843baaa48c35a70950 (diff)
Merged regressiontests and modeltests into the test root.
Diffstat (limited to 'tests/generic_relations')
-rw-r--r--tests/generic_relations/__init__.py0
-rw-r--r--tests/generic_relations/models.py100
-rw-r--r--tests/generic_relations/tests.py261
3 files changed, 361 insertions, 0 deletions
diff --git a/tests/generic_relations/__init__.py b/tests/generic_relations/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/tests/generic_relations/__init__.py
diff --git a/tests/generic_relations/models.py b/tests/generic_relations/models.py
new file mode 100644
index 0000000000..18d7623971
--- /dev/null
+++ b/tests/generic_relations/models.py
@@ -0,0 +1,100 @@
+"""
+34. Generic relations
+
+Generic relations let an object have a foreign key to any object through a
+content-type/object-id field. A ``GenericForeignKey`` field can point to any
+object, be it animal, vegetable, or mineral.
+
+The canonical example is tags (although this example implementation is *far*
+from complete).
+"""
+
+from __future__ import unicode_literals
+
+from django.contrib.contenttypes import generic
+from django.contrib.contenttypes.models import ContentType
+from django.db import models
+from django.utils.encoding import python_2_unicode_compatible
+
+
+@python_2_unicode_compatible
+class TaggedItem(models.Model):
+ """A tag on an item."""
+ tag = models.SlugField()
+ content_type = models.ForeignKey(ContentType)
+ object_id = models.PositiveIntegerField()
+
+ content_object = generic.GenericForeignKey()
+
+ class Meta:
+ ordering = ["tag", "content_type__name"]
+
+ def __str__(self):
+ return self.tag
+
+class ValuableTaggedItem(TaggedItem):
+ value = models.PositiveIntegerField()
+
+@python_2_unicode_compatible
+class Comparison(models.Model):
+ """
+ A model that tests having multiple GenericForeignKeys
+ """
+ comparative = models.CharField(max_length=50)
+
+ content_type1 = models.ForeignKey(ContentType, related_name="comparative1_set")
+ object_id1 = models.PositiveIntegerField()
+
+ content_type2 = models.ForeignKey(ContentType, related_name="comparative2_set")
+ object_id2 = models.PositiveIntegerField()
+
+ first_obj = generic.GenericForeignKey(ct_field="content_type1", fk_field="object_id1")
+ other_obj = generic.GenericForeignKey(ct_field="content_type2", fk_field="object_id2")
+
+ def __str__(self):
+ return "%s is %s than %s" % (self.first_obj, self.comparative, self.other_obj)
+
+@python_2_unicode_compatible
+class Animal(models.Model):
+ common_name = models.CharField(max_length=150)
+ latin_name = models.CharField(max_length=150)
+
+ tags = generic.GenericRelation(TaggedItem)
+ comparisons = generic.GenericRelation(Comparison,
+ object_id_field="object_id1",
+ content_type_field="content_type1")
+
+ def __str__(self):
+ return self.common_name
+
+@python_2_unicode_compatible
+class Vegetable(models.Model):
+ name = models.CharField(max_length=150)
+ is_yucky = models.BooleanField(default=True)
+
+ tags = generic.GenericRelation(TaggedItem)
+
+ def __str__(self):
+ return self.name
+
+@python_2_unicode_compatible
+class Mineral(models.Model):
+ name = models.CharField(max_length=150)
+ hardness = models.PositiveSmallIntegerField()
+
+ # note the lack of an explicit GenericRelation here...
+
+ def __str__(self):
+ return self.name
+
+class GeckoManager(models.Manager):
+ def get_query_set(self):
+ return super(GeckoManager, self).get_query_set().filter(has_tail=True)
+
+class Gecko(models.Model):
+ has_tail = models.BooleanField()
+ objects = GeckoManager()
+
+# To test fix for #11263
+class Rock(Mineral):
+ tags = generic.GenericRelation(TaggedItem)
diff --git a/tests/generic_relations/tests.py b/tests/generic_relations/tests.py
new file mode 100644
index 0000000000..27b25185ea
--- /dev/null
+++ b/tests/generic_relations/tests.py
@@ -0,0 +1,261 @@
+from __future__ import absolute_import, unicode_literals
+
+from django import forms
+from django.contrib.contenttypes.generic import generic_inlineformset_factory
+from django.contrib.contenttypes.models import ContentType
+from django.test import TestCase
+
+from .models import (TaggedItem, ValuableTaggedItem, Comparison, Animal,
+ Vegetable, Mineral, Gecko, Rock)
+
+
+class GenericRelationsTests(TestCase):
+ def test_generic_relations(self):
+ # Create the world in 7 lines of code...
+ lion = Animal.objects.create(common_name="Lion", latin_name="Panthera leo")
+ platypus = Animal.objects.create(
+ common_name="Platypus", latin_name="Ornithorhynchus anatinus"
+ )
+ eggplant = Vegetable.objects.create(name="Eggplant", is_yucky=True)
+ bacon = Vegetable.objects.create(name="Bacon", is_yucky=False)
+ quartz = Mineral.objects.create(name="Quartz", hardness=7)
+
+ # Objects with declared GenericRelations can be tagged directly -- the
+ # API mimics the many-to-many API.
+ bacon.tags.create(tag="fatty")
+ bacon.tags.create(tag="salty")
+ lion.tags.create(tag="yellow")
+ lion.tags.create(tag="hairy")
+ platypus.tags.create(tag="fatty")
+ self.assertQuerysetEqual(lion.tags.all(), [
+ "<TaggedItem: hairy>",
+ "<TaggedItem: yellow>"
+ ])
+ self.assertQuerysetEqual(bacon.tags.all(), [
+ "<TaggedItem: fatty>",
+ "<TaggedItem: salty>"
+ ])
+
+ # You can easily access the content object like a foreign key.
+ t = TaggedItem.objects.get(tag="salty")
+ self.assertEqual(t.content_object, bacon)
+
+ # Recall that the Mineral class doesn't have an explicit GenericRelation
+ # defined. That's OK, because you can create TaggedItems explicitly.
+ tag1 = TaggedItem.objects.create(content_object=quartz, tag="shiny")
+ tag2 = TaggedItem.objects.create(content_object=quartz, tag="clearish")
+
+ # However, excluding GenericRelations means your lookups have to be a
+ # bit more explicit.
+ ctype = ContentType.objects.get_for_model(quartz)
+ q = TaggedItem.objects.filter(
+ content_type__pk=ctype.id, object_id=quartz.id
+ )
+ self.assertQuerysetEqual(q, [
+ "<TaggedItem: clearish>",
+ "<TaggedItem: shiny>"
+ ])
+
+ # You can set a generic foreign key in the way you'd expect.
+ tag1.content_object = platypus
+ tag1.save()
+ self.assertQuerysetEqual(platypus.tags.all(), [
+ "<TaggedItem: fatty>",
+ "<TaggedItem: shiny>"
+ ])
+ q = TaggedItem.objects.filter(
+ content_type__pk=ctype.id, object_id=quartz.id
+ )
+ self.assertQuerysetEqual(q, ["<TaggedItem: clearish>"])
+
+ # Queries across generic relations respect the content types. Even
+ # though there are two TaggedItems with a tag of "fatty", this query
+ # only pulls out the one with the content type related to Animals.
+ self.assertQuerysetEqual(Animal.objects.order_by('common_name'), [
+ "<Animal: Lion>",
+ "<Animal: Platypus>"
+ ])
+ self.assertQuerysetEqual(Animal.objects.filter(tags__tag='fatty'), [
+ "<Animal: Platypus>"
+ ])
+ self.assertQuerysetEqual(Animal.objects.exclude(tags__tag='fatty'), [
+ "<Animal: Lion>"
+ ])
+
+ # If you delete an object with an explicit Generic relation, the related
+ # objects are deleted when the source object is deleted.
+ # Original list of tags:
+ comp_func = lambda obj: (
+ obj.tag, obj.content_type.model_class(), obj.object_id
+ )
+
+ self.assertQuerysetEqual(TaggedItem.objects.all(), [
+ ('clearish', Mineral, quartz.pk),
+ ('fatty', Animal, platypus.pk),
+ ('fatty', Vegetable, bacon.pk),
+ ('hairy', Animal, lion.pk),
+ ('salty', Vegetable, bacon.pk),
+ ('shiny', Animal, platypus.pk),
+ ('yellow', Animal, lion.pk)
+ ],
+ comp_func
+ )
+ lion.delete()
+ self.assertQuerysetEqual(TaggedItem.objects.all(), [
+ ('clearish', Mineral, quartz.pk),
+ ('fatty', Animal, platypus.pk),
+ ('fatty', Vegetable, bacon.pk),
+ ('salty', Vegetable, bacon.pk),
+ ('shiny', Animal, platypus.pk)
+ ],
+ comp_func
+ )
+
+ # If Generic Relation is not explicitly defined, any related objects
+ # remain after deletion of the source object.
+ quartz_pk = quartz.pk
+ quartz.delete()
+ self.assertQuerysetEqual(TaggedItem.objects.all(), [
+ ('clearish', Mineral, quartz_pk),
+ ('fatty', Animal, platypus.pk),
+ ('fatty', Vegetable, bacon.pk),
+ ('salty', Vegetable, bacon.pk),
+ ('shiny', Animal, platypus.pk)
+ ],
+ comp_func
+ )
+ # If you delete a tag, the objects using the tag are unaffected
+ # (other than losing a tag)
+ tag = TaggedItem.objects.order_by("id")[0]
+ tag.delete()
+ self.assertQuerysetEqual(bacon.tags.all(), ["<TaggedItem: salty>"])
+ self.assertQuerysetEqual(TaggedItem.objects.all(), [
+ ('clearish', Mineral, quartz_pk),
+ ('fatty', Animal, platypus.pk),
+ ('salty', Vegetable, bacon.pk),
+ ('shiny', Animal, platypus.pk)
+ ],
+ comp_func
+ )
+ TaggedItem.objects.filter(tag='fatty').delete()
+ ctype = ContentType.objects.get_for_model(lion)
+ self.assertQuerysetEqual(Animal.objects.filter(tags__content_type=ctype), [
+ "<Animal: Platypus>"
+ ])
+
+
+ def test_multiple_gfk(self):
+ # Simple tests for multiple GenericForeignKeys
+ # only uses one model, since the above tests should be sufficient.
+ tiger = Animal.objects.create(common_name="tiger")
+ cheetah = Animal.objects.create(common_name="cheetah")
+ bear = Animal.objects.create(common_name="bear")
+
+ # Create directly
+ Comparison.objects.create(
+ first_obj=cheetah, other_obj=tiger, comparative="faster"
+ )
+ Comparison.objects.create(
+ first_obj=tiger, other_obj=cheetah, comparative="cooler"
+ )
+
+ # Create using GenericRelation
+ tiger.comparisons.create(other_obj=bear, comparative="cooler")
+ tiger.comparisons.create(other_obj=cheetah, comparative="stronger")
+ self.assertQuerysetEqual(cheetah.comparisons.all(), [
+ "<Comparison: cheetah is faster than tiger>"
+ ])
+
+ # Filtering works
+ self.assertQuerysetEqual(tiger.comparisons.filter(comparative="cooler"), [
+ "<Comparison: tiger is cooler than cheetah>",
+ "<Comparison: tiger is cooler than bear>",
+ ], ordered=False)
+
+ # Filtering and deleting works
+ subjective = ["cooler"]
+ tiger.comparisons.filter(comparative__in=subjective).delete()
+ self.assertQuerysetEqual(Comparison.objects.all(), [
+ "<Comparison: cheetah is faster than tiger>",
+ "<Comparison: tiger is stronger than cheetah>"
+ ], ordered=False)
+
+ # If we delete cheetah, Comparisons with cheetah as 'first_obj' will be
+ # deleted since Animal has an explicit GenericRelation to Comparison
+ # through first_obj. Comparisons with cheetah as 'other_obj' will not
+ # be deleted.
+ cheetah.delete()
+ self.assertQuerysetEqual(Comparison.objects.all(), [
+ "<Comparison: tiger is stronger than None>"
+ ])
+
+ def test_gfk_subclasses(self):
+ # GenericForeignKey should work with subclasses (see #8309)
+ quartz = Mineral.objects.create(name="Quartz", hardness=7)
+ valuedtag = ValuableTaggedItem.objects.create(
+ content_object=quartz, tag="shiny", value=10
+ )
+ self.assertEqual(valuedtag.content_object, quartz)
+
+ def test_generic_inline_formsets(self):
+ GenericFormSet = generic_inlineformset_factory(TaggedItem, extra=1)
+ formset = GenericFormSet()
+ self.assertHTMLEqual(''.join(form.as_p() for form in formset.forms), """<p><label for="id_generic_relations-taggeditem-content_type-object_id-0-tag">Tag:</label> <input id="id_generic_relations-taggeditem-content_type-object_id-0-tag" type="text" name="generic_relations-taggeditem-content_type-object_id-0-tag" maxlength="50" /></p>
+<p><label for="id_generic_relations-taggeditem-content_type-object_id-0-DELETE">Delete:</label> <input type="checkbox" name="generic_relations-taggeditem-content_type-object_id-0-DELETE" id="id_generic_relations-taggeditem-content_type-object_id-0-DELETE" /><input type="hidden" name="generic_relations-taggeditem-content_type-object_id-0-id" id="id_generic_relations-taggeditem-content_type-object_id-0-id" /></p>""")
+
+ formset = GenericFormSet(instance=Animal())
+ self.assertHTMLEqual(''.join(form.as_p() for form in formset.forms), """<p><label for="id_generic_relations-taggeditem-content_type-object_id-0-tag">Tag:</label> <input id="id_generic_relations-taggeditem-content_type-object_id-0-tag" type="text" name="generic_relations-taggeditem-content_type-object_id-0-tag" maxlength="50" /></p>
+<p><label for="id_generic_relations-taggeditem-content_type-object_id-0-DELETE">Delete:</label> <input type="checkbox" name="generic_relations-taggeditem-content_type-object_id-0-DELETE" id="id_generic_relations-taggeditem-content_type-object_id-0-DELETE" /><input type="hidden" name="generic_relations-taggeditem-content_type-object_id-0-id" id="id_generic_relations-taggeditem-content_type-object_id-0-id" /></p>""")
+
+ platypus = Animal.objects.create(
+ common_name="Platypus", latin_name="Ornithorhynchus anatinus"
+ )
+ platypus.tags.create(tag="shiny")
+ GenericFormSet = generic_inlineformset_factory(TaggedItem, extra=1)
+ formset = GenericFormSet(instance=platypus)
+ tagged_item_id = TaggedItem.objects.get(
+ tag='shiny', object_id=platypus.id
+ ).id
+ self.assertHTMLEqual(''.join(form.as_p() for form in formset.forms), """<p><label for="id_generic_relations-taggeditem-content_type-object_id-0-tag">Tag:</label> <input id="id_generic_relations-taggeditem-content_type-object_id-0-tag" type="text" name="generic_relations-taggeditem-content_type-object_id-0-tag" value="shiny" maxlength="50" /></p>
+<p><label for="id_generic_relations-taggeditem-content_type-object_id-0-DELETE">Delete:</label> <input type="checkbox" name="generic_relations-taggeditem-content_type-object_id-0-DELETE" id="id_generic_relations-taggeditem-content_type-object_id-0-DELETE" /><input type="hidden" name="generic_relations-taggeditem-content_type-object_id-0-id" value="%s" id="id_generic_relations-taggeditem-content_type-object_id-0-id" /></p><p><label for="id_generic_relations-taggeditem-content_type-object_id-1-tag">Tag:</label> <input id="id_generic_relations-taggeditem-content_type-object_id-1-tag" type="text" name="generic_relations-taggeditem-content_type-object_id-1-tag" maxlength="50" /></p>
+<p><label for="id_generic_relations-taggeditem-content_type-object_id-1-DELETE">Delete:</label> <input type="checkbox" name="generic_relations-taggeditem-content_type-object_id-1-DELETE" id="id_generic_relations-taggeditem-content_type-object_id-1-DELETE" /><input type="hidden" name="generic_relations-taggeditem-content_type-object_id-1-id" id="id_generic_relations-taggeditem-content_type-object_id-1-id" /></p>""" % tagged_item_id)
+
+ lion = Animal.objects.create(common_name="Lion", latin_name="Panthera leo")
+ formset = GenericFormSet(instance=lion, prefix='x')
+ self.assertHTMLEqual(''.join(form.as_p() for form in formset.forms), """<p><label for="id_x-0-tag">Tag:</label> <input id="id_x-0-tag" type="text" name="x-0-tag" maxlength="50" /></p>
+<p><label for="id_x-0-DELETE">Delete:</label> <input type="checkbox" name="x-0-DELETE" id="id_x-0-DELETE" /><input type="hidden" name="x-0-id" id="id_x-0-id" /></p>""")
+
+ def test_gfk_manager(self):
+ # GenericForeignKey should not use the default manager (which may filter objects) #16048
+ tailless = Gecko.objects.create(has_tail=False)
+ tag = TaggedItem.objects.create(content_object=tailless, tag="lizard")
+ self.assertEqual(tag.content_object, tailless)
+
+ def test_subclasses_with_gen_rel(self):
+ """
+ Test that concrete model subclasses with generic relations work
+ correctly (ticket 11263).
+ """
+ granite = Rock.objects.create(name='granite', hardness=5)
+ TaggedItem.objects.create(content_object=granite, tag="countertop")
+ self.assertEqual(Rock.objects.filter(tags__tag="countertop").count(), 1)
+
+
+class CustomWidget(forms.TextInput):
+ pass
+
+class TaggedItemForm(forms.ModelForm):
+ class Meta:
+ model = TaggedItem
+ widgets = {'tag': CustomWidget}
+
+class GenericInlineFormsetTest(TestCase):
+ """
+ Regression for #14572: Using base forms with widgets
+ defined in Meta should not raise errors.
+ """
+
+ def test_generic_inlineformset_factory(self):
+ Formset = generic_inlineformset_factory(TaggedItem, TaggedItemForm)
+ form = Formset().forms[0]
+ self.assertTrue(isinstance(form['tag'].field.widget, CustomWidget))