Ticket #11830: save_model_validation_error.diff

tests/regressiontests/admin_views/fixtures/admin-views-save-model.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+<django-objects version="1.0">
+    <object pk="100" model="auth.user">
+        <field type="CharField" name="username">super</field>
+        <field type="CharField" name="first_name">Super</field>
+        <field type="CharField" name="last_name">User</field>
+        <field type="CharField" name="email">super@example.com</field>
+        <field type="CharField" name="password">sha1$995a3$6011485ea3834267d719b4c801409b8b1ddd0158</field>
+        <field type="BooleanField" name="is_staff">True</field>
+        <field type="BooleanField" name="is_active">True</field>
+        <field type="BooleanField" name="is_superuser">True</field>
+        <field type="DateTimeField" name="last_login">2007-05-30 13:20:10</field>
+        <field type="DateTimeField" name="date_joined">2007-05-30 13:20:10</field>
+        <field to="auth.group" name="groups" rel="ManyToManyRel"></field>
+        <field to="auth.permission" name="user_permissions" rel="ManyToManyRel"></field>
+    </object>
+    <object pk="1" model="admin_views.organization">
+        <field type="CharField" name="name">Django foundation</field>
+    </object>
+    <object pk="2" model="admin_views.organization">
+        <field type="CharField" name="name">Python foundation</field>
+    </object>
+    <object pk="3" model="admin_views.organization">
+        <field type="CharField" name="name">Zope foundation</field>
+    </object>
+    <object pk="4" model="admin_views.organization">
+        <field type="CharField" name="name">Parrot foundation</field>
+    </object>
+    <object pk="1" model="admin_views.dilbert">
+        <field type="CharField" name="name">Dilbert</field>
+    </object>
+    <object pk="1" model="admin_views.role">
+        <field type="CharField" name="name">Programmer</field>
+        <field to="admin_views.organization" name="organization" rel="ManyToOneRel">1</field>
+        <field to="admin_views.dilbert" name="dilbert" rel="ManyToOneRel">1</field>
+    </object>
+    <object pk="2" model="admin_views.role">
+        <field type="CharField" name="name">Coffee drinker</field>
+        <field to="admin_views.organization" name="organization" rel="ManyToOneRel">1</field>
+        <field to="admin_views.dilbert" name="dilbert" rel="ManyToOneRel">1</field>
+    </object>
+    <object pk="3" model="admin_views.role">
+        <field type="CharField" name="name">Programmer</field>
+        <field to="admin_views.organization" name="organization" rel="ManyToOneRel">2</field>
+        <field to="admin_views.dilbert" name="dilbert" rel="ManyToOneRel">1</field>
+    </object>
+    <object pk="4" model="admin_views.role">
+        <field type="CharField" name="name">Coffee drinker</field>
+        <field to="admin_views.organization" name="organization" rel="ManyToOneRel">2</field>
+        <field to="admin_views.dilbert" name="dilbert" rel="ManyToOneRel">1</field>
+    </object>
+    <object pk="5" model="admin_views.role">
+        <field type="CharField" name="name">Coffee drinker</field>
+        <field to="admin_views.organization" name="organization" rel="ManyToOneRel">3</field>
+        <field to="admin_views.dilbert" name="dilbert" rel="ManyToOneRel">1</field>
+    </object>
+    <object pk="6" model="admin_views.role">
+        <field type="CharField" name="name">Programmer</field>
+        <field to="admin_views.organization" name="organization" rel="ManyToOneRel">3</field>
+        <field to="admin_views.dilbert" name="dilbert" rel="ManyToOneRel">1</field>
+    </object>
+    <object pk="7" model="admin_views.role">
+        <field type="CharField" name="name">Coffee drinker</field>
+        <field to="admin_views.organization" name="organization" rel="ManyToOneRel">4</field>
+        <field to="admin_views.dilbert" name="dilbert" rel="ManyToOneRel">1</field>
+    </object>
+    <object pk="8" model="admin_views.role">
+        <field type="CharField" name="name">Programmer</field>
+        <field to="admin_views.organization" name="organization" rel="ManyToOneRel">4</field>
+        <field to="admin_views.dilbert" name="dilbert" rel="ManyToOneRel">1</field>
+    </object>
+</django-objects>

tests/regressiontests/admin_views/tests.py

@@ -11 +11 @@
 from django.contrib.admin.sites import LOGIN_FORM_KEY
 from django.contrib.admin.util import quote
 from django.contrib.admin.helpers import ACTION_CHECKBOX_NAME
+from django import forms
 from django.forms.util import ErrorList
 from django.utils import formats
 from django.utils.cache import get_max_age
@@ -23 +24 @@
     ExternalSubscriber, FooAccount, Gallery, ModelWithStringPrimaryKey, \
     Person, Persona, Picture, Podcast, Section, Subscriber, Vodcast, \
     Language, Collector, Widget, Grommet, DooHickey, FancyDoodad, Whatsit, \
-    Category, Post, Plot, FunkyTag
+    Category, Organization, Role, Post, Plot, FunkyTag
 
 
 class AdminViewBasicTest(TestCase):
@@ -1935 +1936 @@
         self.failUnlessEqual(get_max_age(response), None)
 
 
+
+
 class ReadonlyTest(TestCase):
     fixtures = ['admin-views-users.xml']
 
@@ -2022 +2025 @@
         self.assert_('password' not in adminform.form.errors)
         self.assertEquals(adminform.form.errors['password2'],
                           [u"The two password fields didn't match."])
+
+
+class SaveModelTest(TestCase):
+    fixtures = ['admin-views-save-model.xml']
+
+    def setUp(self):
+        self.client.login(username='super', password='secret')
+        self.post_data = {
+            "name": u"Django foundation",
+            # inline data
+            "role_set-TOTAL_FORMS": "6",
+            "role_set-INITIAL_FORMS": "2",
+            "role_set-MAX_NUM_FORMS": "0",
+            "role_set-0-id": "1",
+            "role_set-0-name": u"Programmer",
+            "role_set-0-organization": "1",
+            "role_set-0-dilbert": "1",
+            "role_set-1-id": "2",
+            "role_set-1-name": u"Coffee drinker",
+            "role_set-1-organization": "1",
+            "role_set-1-dilbert": "1",
+            "role_set-2-id": "",
+            "role_set-2-name": "",
+            "role_set-2-organization": "",
+            "role_set-2-dilbert": "",
+            "role_set-3-id": "",
+            "role_set-3-name": "",
+            "role_set-3-organization": "",
+            "role_set-3-dilbert": "",
+            "role_set-4-id": "",
+            "role_set-4-name": "",
+            "role_set-4-organization": "",
+            "role_set-4-dilbert": "",
+            "role_set-5-id": "",
+            "role_set-5-name": "",
+            "role_set-5-organization": "",
+            "role_set-5-dilbert": "",
+        }
+
+    def tearDown(self):
+        self.client.logout()
+
+    def test_model_save_method(self):
+        """
+        Test removing of related objects in the save method on the model.
+        """
+        org = Organization.objects.get(pk=1)
+        self.assertEqual(org.dilberts.count(), 2)
+
+        try:
+            response = self.client.post(
+                '/test_admin/admin/admin_views/organization/1/', self.post_data
+                )
+        except forms.ValidationError:
+            self.fail(u'The Model save method should be able to change related\
+ model instances without breaking the validation of ModelForms.')
+
+        self.assertEqual(org.dilberts.count(), 0)
+        self.assertEqual(response.status_code, 302) # redirect somewhere
+
+    def test_admin_save_model_method(self):
+        """
+        Test removing of related objects in the model_save method
+        in the ModelAdmin.
+        """
+        self.post_data['role_set-0-id'] = '3'
+        self.post_data['role_set-0-organization'] = '2'
+        self.post_data['role_set-1-id'] = '4'
+        self.post_data['role_set-1-organization'] = '2'
+        self.post_data['role_set-1-DELETE'] = 'on'
+
+        org = Organization.objects.get(pk=2)
+        self.assertEqual(org.dilberts.count(), 2)
+
+        try:
+            response = self.client.post(
+                '/test_admin/admin/admin_views/organization/2/', self.post_data
+                )
+        except forms.ValidationError:
+            self.fail(u'The ModelAdmin save_model method should be able to change related\
+ model instances without breaking the validation of ModelForms.')
+
+        self.assertEqual(org.dilberts.count(), 0)
+        self.assertEqual(response.status_code, 302) # redirect somewhere
+
+    def test_invalid_related_field_choice(self):
+        """
+        A test to ensure that the model is not changed when an
+        invalid role_set-x-id is posted.
+        """
+        self.post_data['role_set-0-id'] = '100' #Should not exist
+        self.post_data['role_set-0-organization'] = '3'
+        self.post_data['role_set-1-id'] = '6'
+        self.post_data['role_set-1-organization'] = '3'
+        self.post_data['role_set-1-DELETE'] = 'on'
+
+        org = Organization.objects.get(pk=3)
+        self.assertEqual(org.dilberts.count(), 2)
+
+        response = self.client.post(
+            '/test_admin/admin/admin_views/organization/3/', self.post_data
+        )
+
+        self.assertEqual(org.dilberts.count(), 2)
+        self.assertEqual(response.status_code, 200) 
+
+    def test_change_data(self):
+        """
+        A test to ensure that the model is not changed when an
+        invalid role_set-x-id is posted.
+        """
+        self.post_data['role_set-0-id'] = '7' #Should not exist
+        self.post_data['role_set-0-organization'] = '4'
+        self.post_data['role_set-1-id'] = '8'
+        self.post_data['role_set-1-name'] = 'Tea drinker'
+        self.post_data['role_set-1-organization'] = '4'
+
+
+        org = Organization.objects.get(pk=4)
+        self.assertEqual(org.dilberts.count(), 2)
+
+        response = self.client.post(
+            '/test_admin/admin/admin_views/organization/4/', self.post_data
+        )
+
+        role = Role.objects.get(pk=8)
+
+        # The form is the master
+        #self.assertEqual(
+        #    role.name, 'Tea drinker',
+        #    'The value in the form should override the value set by the model save method (or the ModelAdmin save_model method).')
+
+        # save_model or save is the master
+        self.assertEqual(
+            role.name, 'Water drinker',
+            'The value in the model save method (or the ModelAdmin save_model method) should override the value in the form.') 
+
+        self.assertEqual(org.dilberts.count(), 2)
+        self.assertEqual(response.status_code, 302) # redirect somewhere

tests/regressiontests/admin_views/models.py

@@ -500 +500 @@
     def get_changelist(self, request, **kwargs):
         return CustomChangeList
 
+
+class Organization(models.Model):
+    """
+    Test the save method
+    """
+    
+    name = models.CharField(max_length=255)
+    dilberts = models.ManyToManyField(
+        'Dilbert', through='Role', blank=True
+    )
+
+    def save(self, force_insert=False, force_update=False):
+        if self.pk == 1: # For test_model_save_method
+            self.dilberts.clear()
+        super(Organization, self).save(force_insert, force_update)
+
+class Role(models.Model):
+    name = models.CharField(max_length=255)
+    organization = models.ForeignKey('Organization')
+    dilbert = models.ForeignKey('Dilbert')
+        
+class Dilbert(models.Model):
+    name = models.CharField(max_length=255)
+
+class RoleInline(admin.TabularInline):
+    model = Role
+
+class OrganizationAdmin(admin.ModelAdmin):
+    """
+    Test the save_model method.
+    """
+    inlines = (RoleInline,)
+
+    def save_model(self, request, obj, form, change):
+        obj.save()
+        if obj.pk == 2: # For test_admin_save_model_method
+            role = Role.objects.get(pk=3)
+            role.delete()
+        if obj.pk == 4: # For test_change_data
+            role = Role.objects.get(pk=8)
+            role.name = 'Water drinker'
+            role.save()
+
+
 class Villain(models.Model):
     name = models.CharField(max_length=100)
 
@@ -565 +609 @@
     def __unicode__(self):
         return self.name
 
+
 admin.site.register(Article, ArticleAdmin)
 admin.site.register(CustomArticle, CustomArticleAdmin)
 admin.site.register(Section, save_as=True, inlines=[ArticleInline])
@@ -588 +633 @@
 admin.site.register(Recommender)
 admin.site.register(Collector, CollectorAdmin)
 admin.site.register(Category, CategoryAdmin)
+admin.site.register(Organization, OrganizationAdmin)
 admin.site.register(Post, PostAdmin)
 admin.site.register(Gadget, GadgetAdmin)
 admin.site.register(Villain)