| 1 |
from django.contrib import admin |
| 2 |
from django.contrib.admin.decorators import register |
| 3 |
from django.contrib.admin.exceptions import AlreadyRegistered, NotRegistered |
| 4 |
from django.contrib.admin.sites import site |
| 5 |
from django.core.exceptions import ImproperlyConfigured |
| 6 |
from django.test import SimpleTestCase |
| 7 |
|
| 8 |
from .models import Guest, Location, Person, Place, Traveler |
| 9 |
|
| 10 |
|
| 11 |
class NameAdmin(admin.ModelAdmin): |
| 12 |
list_display = ["name"] |
| 13 |
save_on_top = True |
| 14 |
|
| 15 |
|
| 16 |
class CustomSite(admin.AdminSite): |
| 17 |
pass |
| 18 |
|
| 19 |
|
| 20 |
class TestRegistration(SimpleTestCase): |
| 21 |
def setUp(self): |
| 22 |
self.site = admin.AdminSite() |
| 23 |
|
| 24 |
def test_bare_registration(self): |
| 25 |
self.site.register(Person) |
| 26 |
self.assertIsInstance(self.site.get_model_admin(Person), admin.ModelAdmin) |
| 27 |
self.site.unregister(Person) |
| 28 |
self.assertEqual(self.site._registry, {}) |
| 29 |
|
| 30 |
def test_registration_with_model_admin(self): |
| 31 |
self.site.register(Person, NameAdmin) |
| 32 |
self.assertIsInstance(self.site.get_model_admin(Person), NameAdmin) |
| 33 |
self.site.unregister(Person) |
| 34 |
self.assertEqual(self.site._registry, {}) |
| 35 |
|
| 36 |
def test_prevent_double_registration(self): |
| 37 |
self.site.register(Person) |
| 38 |
msg = "The model Person is already registered in app 'admin_registration'." |
| 39 |
with self.assertRaisesMessage(AlreadyRegistered, msg): |
| 40 |
self.site.register(Person) |
| 41 |
|
| 42 |
def test_prevent_double_registration_for_custom_admin(self): |
| 43 |
class PersonAdmin(admin.ModelAdmin): |
| 44 |
pass |
| 45 |
|
| 46 |
self.site.register(Person, PersonAdmin) |
| 47 |
msg = ( |
| 48 |
"The model Person is already registered with " |
| 49 |
"'admin_registration.PersonAdmin'." |
| 50 |
) |
| 51 |
with self.assertRaisesMessage(AlreadyRegistered, msg): |
| 52 |
self.site.register(Person, PersonAdmin) |
| 53 |
|
| 54 |
def test_unregister_unregistered_model(self): |
| 55 |
msg = "The model Person is not registered" |
| 56 |
with self.assertRaisesMessage(NotRegistered, msg): |
| 57 |
self.site.unregister(Person) |
| 58 |
|
| 59 |
def test_registration_with_star_star_options(self): |
| 60 |
self.site.register(Person, search_fields=["name"]) |
| 61 |
self.assertEqual(self.site.get_model_admin(Person).search_fields, ["name"]) |
| 62 |
|
| 63 |
def test_get_model_admin_unregister_model(self): |
| 64 |
msg = "The model Person is not registered." |
| 65 |
with self.assertRaisesMessage(NotRegistered, msg): |
| 66 |
self.site.get_model_admin(Person) |
| 67 |
|
| 68 |
def test_star_star_overrides(self): |
| 69 |
self.site.register( |
| 70 |
Person, NameAdmin, search_fields=["name"], list_display=["__str__"] |
| 71 |
) |
| 72 |
person_admin = self.site.get_model_admin(Person) |
| 73 |
self.assertEqual(person_admin.search_fields, ["name"]) |
| 74 |
self.assertEqual(person_admin.list_display, ["__str__"]) |
| 75 |
self.assertIs(person_admin.save_on_top, True) |
| 76 |
|
| 77 |
def test_iterable_registration(self): |
| 78 |
self.site.register([Person, Place], search_fields=["name"]) |
| 79 |
self.assertIsInstance(self.site.get_model_admin(Person), admin.ModelAdmin) |
| 80 |
self.assertEqual(self.site.get_model_admin(Person).search_fields, ["name"]) |
| 81 |
self.assertIsInstance(self.site.get_model_admin(Place), admin.ModelAdmin) |
| 82 |
self.assertEqual(self.site.get_model_admin(Place).search_fields, ["name"]) |
| 83 |
self.site.unregister([Person, Place]) |
| 84 |
self.assertEqual(self.site._registry, {}) |
| 85 |
|
| 86 |
def test_abstract_model(self): |
| 87 |
""" |
| 88 |
Exception is raised when trying to register an abstract model. |
| 89 |
Refs #12004. |
| 90 |
""" |
| 91 |
msg = "The model Location is abstract, so it cannot be registered with admin." |
| 92 |
with self.assertRaisesMessage(ImproperlyConfigured, msg): |
| 93 |
self.site.register(Location) |
| 94 |
|
| 95 |
def test_composite_pk_model(self): |
| 96 |
msg = ( |
| 97 |
"The model Guest has a composite primary key, so it cannot be registered " |
| 98 |
"with admin." |
| 99 |
) |
| 100 |
with self.assertRaisesMessage(ImproperlyConfigured, msg): |
| 101 |
self.site.register(Guest) |
| 102 |
|
| 103 |
def test_is_registered_model(self): |
| 104 |
"Checks for registered models should return true." |
| 105 |
self.site.register(Person) |
| 106 |
self.assertTrue(self.site.is_registered(Person)) |
| 107 |
|
| 108 |
def test_is_registered_not_registered_model(self): |
| 109 |
"Checks for unregistered models should return false." |
| 110 |
self.assertFalse(self.site.is_registered(Person)) |
| 111 |
|
| 112 |
|
| 113 |
class TestRegistrationDecorator(SimpleTestCase): |
| 114 |
""" |
| 115 |
Tests the register decorator in admin.decorators |
| 116 |
|
| 117 |
For clarity: |
| 118 |
|
| 119 |
@register(Person) |
| 120 |
class AuthorAdmin(ModelAdmin): |
| 121 |
pass |
| 122 |
|
| 123 |
is functionally equal to (the way it is written in these tests): |
| 124 |
|
| 125 |
AuthorAdmin = register(Person)(AuthorAdmin) |
| 126 |
""" |
| 127 |
|
| 128 |
def setUp(self): |
| 129 |
self.default_site = site |
| 130 |
self.custom_site = CustomSite() |
| 131 |
|
| 132 |
def test_basic_registration(self): |
| 133 |
register(Person)(NameAdmin) |
| 134 |
self.assertIsInstance( |
| 135 |
self.default_site.get_model_admin(Person), admin.ModelAdmin |
| 136 |
) |
| 137 |
self.default_site.unregister(Person) |
| 138 |
|
| 139 |
def test_custom_site_registration(self): |
| 140 |
register(Person, site=self.custom_site)(NameAdmin) |
| 141 |
self.assertIsInstance( |
| 142 |
self.custom_site.get_model_admin(Person), admin.ModelAdmin |
| 143 |
) |
| 144 |
|
| 145 |
def test_multiple_registration(self): |
| 146 |
register(Traveler, Place)(NameAdmin) |
| 147 |
self.assertIsInstance( |
| 148 |
self.default_site.get_model_admin(Traveler), admin.ModelAdmin |
| 149 |
) |
| 150 |
self.default_site.unregister(Traveler) |
| 151 |
self.assertIsInstance( |
| 152 |
self.default_site.get_model_admin(Place), admin.ModelAdmin |
| 153 |
) |
| 154 |
self.default_site.unregister(Place) |
| 155 |
|
| 156 |
def test_wrapped_class_not_a_model_admin(self): |
| 157 |
with self.assertRaisesMessage( |
| 158 |
ValueError, "Wrapped class must subclass ModelAdmin." |
| 159 |
): |
| 160 |
register(Person)(CustomSite) |
| 161 |
|
| 162 |
def test_custom_site_not_an_admin_site(self): |
| 163 |
with self.assertRaisesMessage(ValueError, "site must subclass AdminSite"): |
| 164 |
register(Person, site=Traveler)(NameAdmin) |
| 165 |
|
| 166 |
def test_empty_models_list_registration_fails(self): |
| 167 |
with self.assertRaisesMessage( |
| 168 |
ValueError, "At least one model must be passed to register." |
| 169 |
): |
| 170 |
register()(NameAdmin) |