Migrated admin_validation doctests. Thanks to Sebastian Hillig.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@13883 bcc190cf-cafb-0310-a4f2-bffc1f526a37

tests/regressiontests/admin_validation/models.py

@@ -45,220 +45,3 @@ class Book(models.Model):
 class AuthorsBooks(models.Model):
     author = models.ForeignKey(Author)
     book = models.ForeignKey(Book)
-
-
-__test__ = {'API_TESTS':"""
-
->>> from django import forms
->>> from django.contrib import admin
->>> from django.contrib.admin.validation import validate, validate_inline
-
-# Regression test for #8027: custom ModelForms with fields/fieldsets
-
->>> class SongForm(forms.ModelForm):
-...     pass
-
->>> class ValidFields(admin.ModelAdmin):
-...     form = SongForm
-...     fields = ['title']
-
->>> class InvalidFields(admin.ModelAdmin):
-...     form = SongForm
-...     fields = ['spam']
-
->>> validate(ValidFields, Song)
->>> validate(InvalidFields, Song)
-Traceback (most recent call last):
-    ...
-ImproperlyConfigured: 'InvalidFields.fields' refers to field 'spam' that is missing from the form.
-
-# Tests for basic validation of 'exclude' option values (#12689)
-
->>> class ExcludedFields1(admin.ModelAdmin):
-...     exclude = ('foo')
-
->>> validate(ExcludedFields1, Book)
-Traceback (most recent call last):
-    ...
-ImproperlyConfigured: 'ExcludedFields1.exclude' must be a list or tuple.
-
->>> class ExcludedFields2(admin.ModelAdmin):
-...     exclude = ('name', 'name')
-
->>> validate(ExcludedFields2, Book)
-Traceback (most recent call last):
-    ...
-ImproperlyConfigured: There are duplicate field(s) in ExcludedFields2.exclude
-
->>> class ExcludedFieldsInline(admin.TabularInline):
-...     model = Song
-...     exclude = ('foo')
-
->>> class ExcludedFieldsAlbumAdmin(admin.ModelAdmin):
-...     model = Album
-...     inlines = [ExcludedFieldsInline]
-
->>> validate(ExcludedFieldsAlbumAdmin, Album)
-Traceback (most recent call last):
-    ...
-ImproperlyConfigured: 'ExcludedFieldsInline.exclude' must be a list or tuple.
-
-# Regression test for #9932 - exclude in InlineModelAdmin
-# should not contain the ForeignKey field used in ModelAdmin.model
-
->>> class SongInline(admin.StackedInline):
-...     model = Song
-...     exclude = ['album']
-
->>> class AlbumAdmin(admin.ModelAdmin):
-...     model = Album
-...     inlines = [SongInline]
-
->>> validate(AlbumAdmin, Album)
-Traceback (most recent call last):
-    ...
-ImproperlyConfigured: SongInline cannot exclude the field 'album' - this is the foreign key to the parent model Album.
-
-# Regression test for #11709 - when testing for fk excluding (when exclude is
-# given) make sure fk_name is honored or things blow up when there is more
-# than one fk to the parent model.
-
->>> class TwoAlbumFKAndAnEInline(admin.TabularInline):
-...     model = TwoAlbumFKAndAnE
-...     exclude = ("e",)
-...     fk_name = "album1"
-
->>> validate_inline(TwoAlbumFKAndAnEInline, None, Album)
-
-# Ensure inlines validate that they can be used correctly.
-
->>> class TwoAlbumFKAndAnEInline(admin.TabularInline):
-...     model = TwoAlbumFKAndAnE
-
->>> validate_inline(TwoAlbumFKAndAnEInline, None, Album)
-Traceback (most recent call last):
-    ...
-Exception: <class 'regressiontests.admin_validation.models.TwoAlbumFKAndAnE'> has more than 1 ForeignKey to <class 'regressiontests.admin_validation.models.Album'>
-
->>> class TwoAlbumFKAndAnEInline(admin.TabularInline):
-...     model = TwoAlbumFKAndAnE
-...     fk_name = "album1"
-
->>> validate_inline(TwoAlbumFKAndAnEInline, None, Album)
-
->>> class SongAdmin(admin.ModelAdmin):
-...     readonly_fields = ("title",)
-
->>> validate(SongAdmin, Song)
-
->>> def my_function(obj):
-...     # does nothing
-...     pass
->>> class SongAdmin(admin.ModelAdmin):
-...     readonly_fields = (my_function,)
-
->>> validate(SongAdmin, Song)
-
->>> class SongAdmin(admin.ModelAdmin):
-...     readonly_fields = ("readonly_method_on_modeladmin",)
-...
-...     def readonly_method_on_modeladmin(self, obj):
-...         # does nothing
-...         pass
-
->>> validate(SongAdmin, Song)
-
->>> class SongAdmin(admin.ModelAdmin):
-...     readonly_fields = ("readonly_method_on_model",)
-
->>> validate(SongAdmin, Song)
-
->>> class SongAdmin(admin.ModelAdmin):
-...     readonly_fields = ("title", "nonexistant")
-
->>> validate(SongAdmin, Song)
-Traceback (most recent call last):
-    ...
-ImproperlyConfigured: SongAdmin.readonly_fields[1], 'nonexistant' is not a callable or an attribute of 'SongAdmin' or found in the model 'Song'.
-
->>> class SongAdmin(admin.ModelAdmin):
-...     readonly_fields = ("title", "awesome_song")
-...     fields = ("album", "title", "awesome_song")
-
->>> validate(SongAdmin, Song)
-Traceback (most recent call last):
-    ...
-ImproperlyConfigured: SongAdmin.readonly_fields[1], 'awesome_song' is not a callable or an attribute of 'SongAdmin' or found in the model 'Song'.
-
->>> class SongAdmin(SongAdmin):
-...     def awesome_song(self, instance):
-...         if instance.title == "Born to Run":
-...             return "Best Ever!"
-...         return "Status unknown."
-
->>> validate(SongAdmin, Song)
-
->>> class SongAdmin(admin.ModelAdmin):
-...     readonly_fields = (lambda obj: "test",)
-
->>> validate(SongAdmin, Song)
-
-# Regression test for #12203/#12237 - Fail more gracefully when a M2M field that
-# specifies the 'through' option is included in the 'fields' or the 'fieldsets'
-# ModelAdmin options.
-
->>> class BookAdmin(admin.ModelAdmin):
-...     fields = ['authors']
-
->>> validate(BookAdmin, Book)
-Traceback (most recent call last):
-    ...
-ImproperlyConfigured: 'BookAdmin.fields' can't include the ManyToManyField field 'authors' because 'authors' manually specifies a 'through' model.
-
->>> class FieldsetBookAdmin(admin.ModelAdmin):
-...     fieldsets = (
-...         ('Header 1', {'fields': ('name',)}),
-...         ('Header 2', {'fields': ('authors',)}),
-...     )
-
->>> validate(FieldsetBookAdmin, Book)
-Traceback (most recent call last):
-   ...
-ImproperlyConfigured: 'FieldsetBookAdmin.fieldsets[1][1]['fields']' can't include the ManyToManyField field 'authors' because 'authors' manually specifies a 'through' model.
-
->>> class NestedFieldsetAdmin(admin.ModelAdmin):
-...    fieldsets = (
-...        ('Main', {'fields': ('price', ('name', 'subtitle'))}),
-...    )
-
->>> validate(NestedFieldsetAdmin, Book)
-
-# Regression test for #12209 -- If the explicitly provided through model
-# is specified as a string, the admin should still be able use
-# Model.m2m_field.through
-
->>> class AuthorsInline(admin.TabularInline):
-...     model = Book.authors.through
-
->>> class BookAdmin(admin.ModelAdmin):
-...     inlines = [AuthorsInline]
-
-# If the through model is still a string (and hasn't been resolved to a model)
-# the validation will fail.
->>> validate(BookAdmin, Book)
-
-# Regression for ensuring ModelAdmin.fields can contain non-model fields
-# that broke with r11737
-
->>> class SongForm(forms.ModelForm):
-...     extra_data = forms.CharField()
-...     class Meta:
-...         model = Song
-
->>> class FieldsOnFormOnlyAdmin(admin.ModelAdmin):
-...     form = SongForm
-...     fields = ['title', 'extra_data']
-
->>> validate(FieldsOnFormOnlyAdmin, Song)
-
-"""}

tests/regressiontests/admin_validation/tests.py

@@ -1,11 +1,30 @@
 from django.contrib import admin
-from django.contrib.admin.validation import validate
+from django import forms
+from django.contrib.admin.validation import validate, validate_inline, \
+                                            ImproperlyConfigured
 from django.test import TestCase
 
-from models import Song
+from models import Song, Book, Album, TwoAlbumFKAndAnE
 
+class SongForm(forms.ModelForm):
+    pass
+
+class ValidFields(admin.ModelAdmin):
+    form = SongForm
+    fields = ['title']
+
+class InvalidFields(admin.ModelAdmin):
+    form = SongForm
+    fields = ['spam']
 
 class ValidationTestCase(TestCase):
+    def assertRaisesMessage(self, exc, msg, func, *args, **kwargs):
+        try:
+            func(*args, **kwargs)
+        except Exception, e:
+            self.assertEqual(msg, str(e))
+            self.assertTrue(isinstance(e, exc), "Expected %s, got %s" % (exc, type(e)))
+
     def test_readonly_and_editable(self):
         class SongAdmin(admin.ModelAdmin):
             readonly_fields = ["original_release"]
@@ -14,5 +33,215 @@ class ValidationTestCase(TestCase):
                     "fields": ["title", "original_release"],
                 }),
             ]
-        
         validate(SongAdmin, Song)
+
+    def test_custom_modelforms_with_fields_fieldsets(self):
+        """
+        # Regression test for #8027: custom ModelForms with fields/fieldsets
+        """
+        validate(ValidFields, Song)
+        self.assertRaisesMessage(ImproperlyConfigured,
+            "'InvalidFields.fields' refers to field 'spam' that is missing from the form.",
+            validate,
+            InvalidFields, Song)
+
+    def test_exclude_values(self):
+        """
+        Tests for basic validation of 'exclude' option values (#12689)
+        """
+        class ExcludedFields1(admin.ModelAdmin):
+            exclude = ('foo')
+        self.assertRaisesMessage(ImproperlyConfigured,
+            "'ExcludedFields1.exclude' must be a list or tuple.",
+            validate,
+            ExcludedFields1, Book)
+
+    def test_exclude_duplicate_values(self):
+        class ExcludedFields2(admin.ModelAdmin):
+            exclude = ('name', 'name')
+        self.assertRaisesMessage(ImproperlyConfigured,
+            "There are duplicate field(s) in ExcludedFields2.exclude",
+            validate,
+            ExcludedFields2, Book)
+
+    def test_exclude_in_inline(self):
+        class ExcludedFieldsInline(admin.TabularInline):
+            model = Song
+            exclude = ('foo')
+
+        class ExcludedFieldsAlbumAdmin(admin.ModelAdmin):
+            model = Album
+            inlines = [ExcludedFieldsInline]
+
+        self.assertRaisesMessage(ImproperlyConfigured,
+            "'ExcludedFieldsInline.exclude' must be a list or tuple.",
+            validate,
+            ExcludedFieldsAlbumAdmin, Album)
+
+    def test_exclude_inline_model_admin(self):
+        """
+        # Regression test for #9932 - exclude in InlineModelAdmin
+        # should not contain the ForeignKey field used in ModelAdmin.model
+        """
+        class SongInline(admin.StackedInline):
+            model = Song
+            exclude = ['album']
+
+        class AlbumAdmin(admin.ModelAdmin):
+            model = Album
+            inlines = [SongInline]
+
+        self.assertRaisesMessage(ImproperlyConfigured,
+            "SongInline cannot exclude the field 'album' - this is the foreign key to the parent model Album.",
+            validate,
+            AlbumAdmin, Album)
+
+    def test_fk_exclusion(self):
+        """
+        Regression test for #11709 - when testing for fk excluding (when exclude is
+        given) make sure fk_name is honored or things blow up when there is more
+        than one fk to the parent model.
+        """
+        class TwoAlbumFKAndAnEInline(admin.TabularInline):
+            model = TwoAlbumFKAndAnE
+            exclude = ("e",)
+            fk_name = "album1"
+        validate_inline(TwoAlbumFKAndAnEInline, None, Album)
+
+    def test_inline_self_validation(self):
+        class TwoAlbumFKAndAnEInline(admin.TabularInline):
+            model = TwoAlbumFKAndAnE
+
+        self.assertRaisesMessage(Exception,
+            "<class 'regressiontests.admin_validation.models.TwoAlbumFKAndAnE'> has more than 1 ForeignKey to <class 'regressiontests.admin_validation.models.Album'>",
+            validate_inline,
+            TwoAlbumFKAndAnEInline, None, Album)
+
+    def test_inline_with_specified(self):
+        class TwoAlbumFKAndAnEInline(admin.TabularInline):
+            model = TwoAlbumFKAndAnE
+            fk_name = "album1"
+        validate_inline(TwoAlbumFKAndAnEInline, None, Album)
+
+    def test_readonly(self):
+        class SongAdmin(admin.ModelAdmin):
+            readonly_fields = ("title",)
+
+        validate(SongAdmin, Song)
+
+    def test_readonly_on_method(self):
+        def my_function(obj):
+            pass
+
+        class SongAdmin(admin.ModelAdmin):
+            readonly_fields = (my_function,)
+
+        validate(SongAdmin, Song)
+
+    def test_readonly_on_modeladmin(self):
+        class SongAdmin(admin.ModelAdmin):
+            readonly_fields = ("readonly_method_on_modeladmin",)
+
+            def readonly_method_on_modeladmin(self, obj):
+                pass
+
+        validate(SongAdmin, Song)
+
+    def test_readonly_method_on_model(self):
+        class SongAdmin(admin.ModelAdmin):
+            readonly_fields = ("readonly_method_on_model",)
+
+        validate(SongAdmin, Song)
+
+    def test_nonexistant_field(self):
+        class SongAdmin(admin.ModelAdmin):
+            readonly_fields = ("title", "nonexistant")
+
+        self.assertRaisesMessage(ImproperlyConfigured,
+            "SongAdmin.readonly_fields[1], 'nonexistant' is not a callable or an attribute of 'SongAdmin' or found in the model 'Song'.",
+            validate,
+            SongAdmin, Song)
+
+    def test_extra(self):
+        class SongAdmin(admin.ModelAdmin):
+            def awesome_song(self, instance):
+                if instance.title == "Born to Run":
+                    return "Best Ever!"
+                return "Status unknown."
+        validate(SongAdmin, Song)
+
+    def test_readonly_lambda(self):
+        class SongAdmin(admin.ModelAdmin):
+            readonly_fields = (lambda obj: "test",)
+
+        validate(SongAdmin, Song)
+
+    def test_graceful_m2m_fail(self):
+        """
+        Regression test for #12203/#12237 - Fail more gracefully when a M2M field that
+        specifies the 'through' option is included in the 'fields' or the 'fieldsets'
+        ModelAdmin options.
+        """
+
+        class BookAdmin(admin.ModelAdmin):
+            fields = ['authors']
+
+        self.assertRaisesMessage(ImproperlyConfigured,
+            "'BookAdmin.fields' can't include the ManyToManyField field 'authors' because 'authors' manually specifies a 'through' model.",
+            validate,
+            BookAdmin, Book)
+
+    def test_cannon_include_through(self):
+        class FieldsetBookAdmin(admin.ModelAdmin):
+            fieldsets = (
+                ('Header 1', {'fields': ('name',)}),
+                ('Header 2', {'fields': ('authors',)}),
+            )
+        self.assertRaisesMessage(ImproperlyConfigured,
+            "'FieldsetBookAdmin.fieldsets[1][1]['fields']' can't include the ManyToManyField field 'authors' because 'authors' manually specifies a 'through' model.",
+            validate,
+            FieldsetBookAdmin, Book)
+
+    def test_nested_fieldsets(self):
+        class NestedFieldsetAdmin(admin.ModelAdmin):
+           fieldsets = (
+               ('Main', {'fields': ('price', ('name', 'subtitle'))}),
+           )
+        validate(NestedFieldsetAdmin, Book)
+
+    def test_explicit_through_override(self):
+        """
+        Regression test for #12209 -- If the explicitly provided through model
+        is specified as a string, the admin should still be able use
+        Model.m2m_field.through
+        """
+
+        class AuthorsInline(admin.TabularInline):
+            model = Book.authors.through
+
+        class BookAdmin(admin.ModelAdmin):
+            inlines = [AuthorsInline]
+
+        # If the through model is still a string (and hasn't been resolved to a model)
+        # the validation will fail.
+        validate(BookAdmin, Book)
+
+    def test_non_model_fields(self):
+        """
+        Regression for ensuring ModelAdmin.fields can contain non-model fields
+        that broke with r11737
+        """
+        class SongForm(forms.ModelForm):
+            extra_data = forms.CharField()
+            class Meta:
+                model = Song
+
+        class FieldsOnFormOnlyAdmin(admin.ModelAdmin):
+            form = SongForm
+            fields = ['title', 'extra_data']
+
+        validate(FieldsOnFormOnlyAdmin, Song)
+
+
+
+