# -*- coding: utf-8 -*- """ Test Cases Please see README.rst or DOCS.rst or http://bserve.webhop.org/wiki/django_polymorphic """ from django.conf import settings import sys from pprint import pprint from django import VERSION as django_VERSION from django.test import TestCase from django.db.models.query import QuerySet from django.db.models import Q,Count from django.db import models from django.contrib.contenttypes.models import ContentType from polymorphic import PolymorphicModel, PolymorphicManager, PolymorphicQuerySet from polymorphic import ShowFieldContent, ShowFieldType, ShowFieldTypeAndContent, get_version from polymorphic import translate_polymorphic_Q_object class PlainA(models.Model): field1 = models.CharField(max_length=10) class PlainB(PlainA): field2 = models.CharField(max_length=10) class PlainC(PlainB): field3 = models.CharField(max_length=10) class Model2A(ShowFieldType, PolymorphicModel): field1 = models.CharField(max_length=10) class Model2B(Model2A): field2 = models.CharField(max_length=10) class Model2C(Model2B): field3 = models.CharField(max_length=10) class Model2D(Model2C): field4 = models.CharField(max_length=10) class ModelExtraA(ShowFieldTypeAndContent, PolymorphicModel): field1 = models.CharField(max_length=10) class ModelExtraB(ModelExtraA): field2 = models.CharField(max_length=10) class ModelExtraC(ModelExtraB): field3 = models.CharField(max_length=10) class ModelExtraExternal(models.Model): topic = models.CharField(max_length=10) class ModelShow1(ShowFieldType,PolymorphicModel): field1 = models.CharField(max_length=10) m2m = models.ManyToManyField('self') class ModelShow2(ShowFieldContent, PolymorphicModel): field1 = models.CharField(max_length=10) m2m = models.ManyToManyField('self') class ModelShow3(ShowFieldTypeAndContent, PolymorphicModel): field1 = models.CharField(max_length=10) m2m = models.ManyToManyField('self') class ModelShow1_plain(PolymorphicModel): field1 = models.CharField(max_length=10) class ModelShow2_plain(ModelShow1_plain): field2 = models.CharField(max_length=10) class Base(ShowFieldType, PolymorphicModel): field_b = models.CharField(max_length=10) class ModelX(Base): field_x = models.CharField(max_length=10) class ModelY(Base): field_y = models.CharField(max_length=10) class Enhance_Plain(models.Model): field_p = models.CharField(max_length=10) class Enhance_Base(ShowFieldTypeAndContent, PolymorphicModel): field_b = models.CharField(max_length=10) class Enhance_Inherit(Enhance_Base, Enhance_Plain): field_i = models.CharField(max_length=10) class DiamondBase(models.Model): field_b = models.CharField(max_length=10) class DiamondX(DiamondBase): field_x = models.CharField(max_length=10) class DiamondY(DiamondBase): field_y = models.CharField(max_length=10) class DiamondXY(DiamondX, DiamondY): pass class RelationBase(ShowFieldTypeAndContent, PolymorphicModel): field_base = models.CharField(max_length=10) fk = models.ForeignKey('self', null=True) m2m = models.ManyToManyField('self') class RelationA(RelationBase): field_a = models.CharField(max_length=10) class RelationB(RelationBase): field_b = models.CharField(max_length=10) class RelationBC(RelationB): field_c = models.CharField(max_length=10) class RelatingModel(models.Model): many2many = models.ManyToManyField(Model2A) class One2OneRelatingModel(PolymorphicModel): one2one = models.OneToOneField(Model2A) field1 = models.CharField(max_length=10) class One2OneRelatingModelDerived(One2OneRelatingModel): field2 = models.CharField(max_length=10) class MyManager(PolymorphicManager): def get_query_set(self): return super(MyManager, self).get_query_set().order_by('-field1') class ModelWithMyManager(ShowFieldTypeAndContent, Model2A): objects = MyManager() field4 = models.CharField(max_length=10) class MROBase1(ShowFieldType, PolymorphicModel): objects = MyManager() field1 = models.CharField(max_length=10) # needed as MyManager uses it class MROBase2(MROBase1): pass # Django vanilla inheritance does not inherit MyManager as _default_manager here class MROBase3(models.Model): objects = PolymorphicManager() class MRODerived(MROBase2, MROBase3): pass class MgrInheritA(models.Model): mgrA = models.Manager() mgrA2 = models.Manager() field1 = models.CharField(max_length=10) class MgrInheritB(MgrInheritA): mgrB = models.Manager() field2 = models.CharField(max_length=10) class MgrInheritC(ShowFieldTypeAndContent, MgrInheritB): pass class BlogBase(ShowFieldTypeAndContent, PolymorphicModel): name = models.CharField(max_length=10) class BlogA(BlogBase): info = models.CharField(max_length=10) class BlogB(BlogBase): pass class BlogEntry(ShowFieldTypeAndContent, PolymorphicModel): blog = models.ForeignKey(BlogA) text = models.CharField(max_length=10) class BlogEntry_limit_choices_to(ShowFieldTypeAndContent, PolymorphicModel): blog = models.ForeignKey(BlogBase) text = models.CharField(max_length=10) class ModelFieldNameTest(ShowFieldType, PolymorphicModel): modelfieldnametest = models.CharField(max_length=10) class InitTestModel(ShowFieldType, PolymorphicModel): bar = models.CharField(max_length=100) def __init__(self, *args, **kwargs): kwargs['bar'] = self.x() super(InitTestModel, self).__init__(*args, **kwargs) class InitTestModelSubclass(InitTestModel): def x(self): return 'XYZ' # models from github issue class Top(PolymorphicModel): name = models.CharField(max_length=50) class Middle(Top): description = models.TextField() class Bottom(Middle): author = models.CharField(max_length=50) # UUID tests won't work with Django 1.1 if not (django_VERSION[0] <= 1 and django_VERSION[1] <= 1): try: from polymorphic.tools_for_tests import UUIDField except: pass if 'UUIDField' in globals(): import uuid class UUIDProject(ShowFieldTypeAndContent, PolymorphicModel): uuid_primary_key = UUIDField(primary_key = True) topic = models.CharField(max_length = 30) class UUIDArtProject(UUIDProject): artist = models.CharField(max_length = 30) class UUIDResearchProject(UUIDProject): supervisor = models.CharField(max_length = 30) class UUIDPlainA(models.Model): uuid_primary_key = UUIDField(primary_key = True) field1 = models.CharField(max_length=10) class UUIDPlainB(UUIDPlainA): field2 = models.CharField(max_length=10) class UUIDPlainC(UUIDPlainB): field3 = models.CharField(max_length=10) # test bad field name #class TestBadFieldModel(ShowFieldType, PolymorphicModel): # instance_of = models.CharField(max_length=10) # validation error: "polymorphic.relatednameclash: Accessor for field 'polymorphic_ctype' clashes # with related field 'ContentType.relatednameclash_set'." (reported by Andrew Ingram) # fixed with related_name class RelatedNameClash(ShowFieldType, PolymorphicModel): ctype = models.ForeignKey(ContentType, null=True, editable=False) class testclass(TestCase): def test_diamond_inheritance(self): # Django diamond problem o = DiamondXY.objects.create(field_b='b', field_x='x', field_y='y') print 'DiamondXY fields 1: field_b "%s", field_x "%s", field_y "%s"' % (o.field_b, o.field_x, o.field_y) o = DiamondXY.objects.get() print 'DiamondXY fields 2: field_b "%s", field_x "%s", field_y "%s"' % (o.field_b, o.field_x, o.field_y) if o.field_b != 'b': print print '# known django model inheritance diamond problem detected' def test_annotate_aggregate_order(self): # create a blog of type BlogA blog = BlogA.objects.create(name='B1', info='i1') # create two blog entries in BlogA entry1 = blog.blogentry_set.create(text='bla') entry2 = BlogEntry.objects.create(blog=blog, text='bla2') # create some blogs of type BlogB to make the BlogBase table data really polymorphic o = BlogB.objects.create(name='Bb1') o = BlogB.objects.create(name='Bb2') o = BlogB.objects.create(name='Bb3') qs = BlogBase.objects.annotate(entrycount=Count('BlogA___blogentry')) assert len(qs)==4 for o in qs: if o.name=='B1': assert o.entrycount == 2 else: assert o.entrycount == 0 x = BlogBase.objects.aggregate(entrycount=Count('BlogA___blogentry')) assert x['entrycount'] == 2 # create some more blogs for next test b2 = BlogA.objects.create(name='B2', info='i2') b2 = BlogA.objects.create(name='B3', info='i3') b2 = BlogA.objects.create(name='B4', info='i4') b2 = BlogA.objects.create(name='B5', info='i5') ### test ordering for field in all entries expected = ''' [ , , , , , , , ]''' x = '\n' + repr(BlogBase.objects.order_by('-name')) assert x == expected ### test ordering for field in one subclass only # MySQL and SQLite return this order expected1=''' [ , , , , , , , ]''' # PostgreSQL returns this order expected2=''' [ , , , , , , , ]''' x = '\n' + repr(BlogBase.objects.order_by('-BlogA___info')) assert x == expected1 or x == expected2 def test_limit_choices_to(self): "this is not really a testcase, as limit_choices_to only affects the Django admin" # create a blog of type BlogA blog_a = BlogA.objects.create(name='aa', info='aa') blog_b = BlogB.objects.create(name='bb') # create two blog entries entry1 = BlogEntry_limit_choices_to.objects.create(blog=blog_b, text='bla2') entry2 = BlogEntry_limit_choices_to.objects.create(blog=blog_b, text='bla2') def test_primary_key_custom_field_problem(self): "object retrieval problem occuring with some custom primary key fields (UUIDField as test case)" if not 'UUIDField' in globals(): return a=UUIDProject.objects.create(topic="John's gathering") b=UUIDArtProject.objects.create(topic="Sculpting with Tim", artist="T. Turner") c=UUIDResearchProject.objects.create(topic="Swallow Aerodynamics", supervisor="Dr. Winter") qs=UUIDProject.objects.all() ol=list(qs) a=qs[0] b=qs[1] c=qs[2] assert len(qs)==3 assert type(a.uuid_primary_key)==uuid.UUID and type(a.pk)==uuid.UUID res=repr(qs) import re res=re.sub(' "(.*?)..", topic',', topic',res) res_exp="""[ , , ]""" assert res==res_exp, res #if (a.pk!= uuid.UUID or c.pk!= uuid.UUID): # print # print '# known inconstency with custom primary key field detected (django problem?)' a=UUIDPlainA.objects.create(field1='A1') b=UUIDPlainB.objects.create(field1='B1', field2='B2') c=UUIDPlainC.objects.create(field1='C1', field2='C2', field3='C3') qs=UUIDPlainA.objects.all() if (a.pk!= uuid.UUID or c.pk!= uuid.UUID): print print '# known type inconstency with custom primary key field detected (django problem?)' def show_base_manager(model): print type(model._base_manager),model._base_manager.model __test__ = {"doctest": """ ####################################################### ### Tests >>> settings.DEBUG=True ### simple inheritance >>> o=Model2A.objects.create(field1='A1') >>> o=Model2B.objects.create(field1='B1', field2='B2') >>> o=Model2C.objects.create(field1='C1', field2='C2', field3='C3') >>> o=Model2D.objects.create(field1='D1', field2='D2', field3='D3', field4='D4') >>> Model2A.objects.all() [ , , , ] # manual get_real_instance() >>> o=Model2A.objects.non_polymorphic().get(field1='C1') >>> o.get_real_instance() # non_polymorphic() >>> qs=Model2A.objects.all().non_polymorphic() >>> qs [ , , , ] # get_real_instances() >>> qs.get_real_instances() [ , , , ] >>> l=list(qs) >>> Model2A.objects.get_real_instances(l) [ , , , ] # translate_polymorphic_Q_object >>> q=Model2A.translate_polymorphic_Q_object( Q(instance_of=Model2C) ) >>> Model2A.objects.filter(q) [ , ] ### test inheritance pointers & _base_managers >>> show_base_manager(PlainA) >>> show_base_manager(PlainB) >>> show_base_manager(PlainC) >>> show_base_manager(Model2A) >>> show_base_manager(Model2B) >>> show_base_manager(Model2C) >>> show_base_manager(One2OneRelatingModel) >>> show_base_manager(One2OneRelatingModelDerived) >>> o=Model2A.base_objects.get(field1='C1') >>> o.model2b >>> o=Model2B.base_objects.get(field1='C1') >>> o.model2c ### OneToOneField, test both directions for polymorphism >>> a=Model2A.base_objects.get(field1='C1') >>> b=One2OneRelatingModelDerived.objects.create(one2one=a, field1='f1', field2='f2') >>> b.one2one # this result is basically wrong, probably due to Django cacheing (we used base_objects), but should not be a problem >>> c=One2OneRelatingModelDerived.objects.get(field1='f1') >>> c.one2one >>> a.one2onerelatingmodel ### ShowFieldContent, ShowFieldType, ShowFieldTypeAndContent, also with annotate() >>> o=ModelShow1.objects.create(field1='abc') >>> o.m2m.add(o) ; o.save() >>> ModelShow1.objects.all() [ ] >>> o=ModelShow2.objects.create(field1='abc') >>> o.m2m.add(o) ; o.save() >>> ModelShow2.objects.all() [ ] >>> o=ModelShow3.objects.create(field1='abc') >>> o.m2m.add(o) ; o.save() >>> ModelShow3.objects.all() [ ] >>> ModelShow1.objects.all().annotate(Count('m2m')) [ ] >>> ModelShow2.objects.all().annotate(Count('m2m')) [ ] >>> ModelShow3.objects.all().annotate(Count('m2m')) [ ] # no pretty printing >>> o=ModelShow1_plain.objects.create(field1='abc') >>> o=ModelShow2_plain.objects.create(field1='abc', field2='def') >>> ModelShow1_plain.objects.all() [, ] ### extra() method >>> Model2A.objects.extra(where=['id IN (2, 3)']) [ , ] >>> Model2A.objects.extra(select={"select_test": "field1 = 'A1'"}, where=["field1 = 'A1' OR field1 = 'B1'"], order_by = ['-id'] ) [ , ] >>> o=ModelExtraA.objects.create(field1='A1') >>> o=ModelExtraB.objects.create(field1='B1', field2='B2') >>> o=ModelExtraC.objects.create(field1='C1', field2='C2', field3='C3') >>> o=ModelExtraExternal.objects.create(topic='extra1') >>> o=ModelExtraExternal.objects.create(topic='extra2') >>> o=ModelExtraExternal.objects.create(topic='extra3') >>> ModelExtraA.objects.extra(tables=["polymorphic_modelextraexternal"], select={"topic":"polymorphic_modelextraexternal.topic"}, where=["polymorphic_modelextraa.id = polymorphic_modelextraexternal.id"] ) [ , , ] ### class filtering, instance_of, not_instance_of >>> Model2A.objects.instance_of(Model2B) [ , , ] >>> Model2A.objects.filter(instance_of=Model2B) [ , , ] >>> Model2A.objects.filter(Q(instance_of=Model2B)) [ , , ] >>> Model2A.objects.not_instance_of(Model2B) [ ] ### polymorphic filtering >>> Model2A.objects.filter( Q( Model2B___field2 = 'B2' ) | Q( Model2C___field3 = 'C3' ) ) [ , ] ### get & delete >>> oa=Model2A.objects.get(id=2) >>> oa >>> oa.delete() >>> Model2A.objects.all() [ , , ] ### queryset combining >>> o=ModelX.objects.create(field_x='x') >>> o=ModelY.objects.create(field_y='y') >>> Base.objects.instance_of(ModelX) | Base.objects.instance_of(ModelY) [ , ] ### multiple inheritance, subclassing third party models (mix PolymorphicModel with models.Model) >>> o = Enhance_Base.objects.create(field_b='b-base') >>> o = Enhance_Inherit.objects.create(field_b='b-inherit', field_p='p', field_i='i') >>> Enhance_Base.objects.all() [ , ] ### ForeignKey, ManyToManyField >>> obase=RelationBase.objects.create(field_base='base') >>> oa=RelationA.objects.create(field_base='A1', field_a='A2', fk=obase) >>> ob=RelationB.objects.create(field_base='B1', field_b='B2', fk=oa) >>> oc=RelationBC.objects.create(field_base='C1', field_b='C2', field_c='C3', fk=oa) >>> oa.m2m.add(oa); oa.m2m.add(ob) >>> RelationBase.objects.all() [ , , , ] >>> oa=RelationBase.objects.get(id=2) >>> oa.fk >>> oa.relationbase_set.all() [ , ] >>> ob=RelationBase.objects.get(id=3) >>> ob.fk >>> oa=RelationA.objects.get() >>> oa.m2m.all() [ , ] ### user-defined manager >>> o=ModelWithMyManager.objects.create(field1='D1a', field4='D4a') >>> o=ModelWithMyManager.objects.create(field1='D1b', field4='D4b') >>> ModelWithMyManager.objects.all() [ , ] >>> type(ModelWithMyManager.objects) >>> type(ModelWithMyManager._default_manager) ### Manager Inheritance >>> type(MRODerived.objects) # MRO # check for correct default manager >>> type(MROBase1._default_manager) # Django vanilla inheritance does not inherit MyManager as _default_manager here >>> type(MROBase2._default_manager) ### fixed issue in PolymorphicModel.__getattribute__: field name same as model name >>> ModelFieldNameTest.objects.create(modelfieldnametest='1') ### fixed issue in PolymorphicModel.__getattribute__: # if subclass defined __init__ and accessed class members, __getattribute__ had a problem: "...has no attribute 'sub_and_superclass_dict'" #>>> o >>> o = InitTestModelSubclass.objects.create() >>> o.bar 'XYZ' ### Django model inheritance diamond problem, fails for Django 1.1 #>>> o=DiamondXY.objects.create(field_b='b', field_x='x', field_y='y') #>>> print 'DiamondXY fields 1: field_b "%s", field_x "%s", field_y "%s"' % (o.field_b, o.field_x, o.field_y) #DiamondXY fields 1: field_b "a", field_x "x", field_y "y" >>> settings.DEBUG=False """} class RegressionTests(TestCase): def test_for_query_result_incomplete_with_inheritance(self): """ https://github.com/bconstantin/django_polymorphic/issues/15 """ top = Top() top.save() middle = Middle() middle.save() bottom = Bottom() bottom.save() expected_queryset = [top, middle, bottom] self.assertQuerysetEqual(Top.objects.all(), [repr(r) for r in expected_queryset]) expected_queryset = [middle, bottom] self.assertQuerysetEqual(Middle.objects.all(), [repr(r) for r in expected_queryset]) expected_queryset = [bottom] self.assertQuerysetEqual(Bottom.objects.all(), [repr(r) for r in expected_queryset])