| 1 |
from django.apps import apps |
| 2 |
from django.apps.registry import Apps |
| 3 |
from django.conf import settings |
| 4 |
from django.contrib.sites import models |
| 5 |
from django.contrib.sites.checks import check_site_id |
| 6 |
from django.contrib.sites.management import create_default_site |
| 7 |
from django.contrib.sites.middleware import CurrentSiteMiddleware |
| 8 |
from django.contrib.sites.models import Site, clear_site_cache |
| 9 |
from django.contrib.sites.requests import RequestSite |
| 10 |
from django.contrib.sites.shortcuts import get_current_site |
| 11 |
from django.core import checks |
| 12 |
from django.core.exceptions import ObjectDoesNotExist, ValidationError |
| 13 |
from django.db.models.signals import post_migrate |
| 14 |
from django.http import HttpRequest, HttpResponse |
| 15 |
from django.test import SimpleTestCase, TestCase, modify_settings, override_settings |
| 16 |
from django.test.utils import captured_stdout |
| 17 |
|
| 18 |
|
| 19 |
@modify_settings(INSTALLED_APPS={"append": "django.contrib.sites"}) |
| 20 |
class SitesFrameworkTests(TestCase): |
| 21 |
databases = {"default", "other"} |
| 22 |
|
| 23 |
@classmethod |
| 24 |
def setUpTestData(cls): |
| 25 |
cls.site = Site(id=settings.SITE_ID, domain="example.com", name="example.com") |
| 26 |
cls.site.save() |
| 27 |
|
| 28 |
def setUp(self): |
| 29 |
Site.objects.clear_cache() |
| 30 |
self.addCleanup(Site.objects.clear_cache) |
| 31 |
|
| 32 |
def test_site_manager(self): |
| 33 |
# Make sure that get_current() does not return a deleted Site object. |
| 34 |
s = Site.objects.get_current() |
| 35 |
self.assertIsInstance(s, Site) |
| 36 |
s.delete() |
| 37 |
with self.assertRaises(ObjectDoesNotExist): |
| 38 |
Site.objects.get_current() |
| 39 |
|
| 40 |
def test_site_cache(self): |
| 41 |
# After updating a Site object (e.g. via the admin), we shouldn't return a |
| 42 |
# bogus value from the SITE_CACHE. |
| 43 |
site = Site.objects.get_current() |
| 44 |
self.assertEqual("example.com", site.name) |
| 45 |
s2 = Site.objects.get(id=settings.SITE_ID) |
| 46 |
s2.name = "Example site" |
| 47 |
s2.save() |
| 48 |
site = Site.objects.get_current() |
| 49 |
self.assertEqual("Example site", site.name) |
| 50 |
|
| 51 |
def test_delete_all_sites_clears_cache(self): |
| 52 |
# When all site objects are deleted the cache should also |
| 53 |
# be cleared and get_current() should raise a DoesNotExist. |
| 54 |
self.assertIsInstance(Site.objects.get_current(), Site) |
| 55 |
Site.objects.all().delete() |
| 56 |
with self.assertRaises(Site.DoesNotExist): |
| 57 |
Site.objects.get_current() |
| 58 |
|
| 59 |
@override_settings(ALLOWED_HOSTS=["example.com"]) |
| 60 |
def test_get_current_site(self): |
| 61 |
# The correct Site object is returned |
| 62 |
request = HttpRequest() |
| 63 |
request.META = { |
| 64 |
"SERVER_NAME": "example.com", |
| 65 |
"SERVER_PORT": "80", |
| 66 |
} |
| 67 |
site = get_current_site(request) |
| 68 |
self.assertIsInstance(site, Site) |
| 69 |
self.assertEqual(site.id, settings.SITE_ID) |
| 70 |
|
| 71 |
# An exception is raised if the sites framework is installed |
| 72 |
# but there is no matching Site |
| 73 |
site.delete() |
| 74 |
with self.assertRaises(ObjectDoesNotExist): |
| 75 |
get_current_site(request) |
| 76 |
|
| 77 |
# A RequestSite is returned if the sites framework is not installed |
| 78 |
with self.modify_settings(INSTALLED_APPS={"remove": "django.contrib.sites"}): |
| 79 |
site = get_current_site(request) |
| 80 |
self.assertIsInstance(site, RequestSite) |
| 81 |
self.assertEqual(site.name, "example.com") |
| 82 |
|
| 83 |
@override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com"]) |
| 84 |
def test_get_current_site_no_site_id(self): |
| 85 |
request = HttpRequest() |
| 86 |
request.META = { |
| 87 |
"SERVER_NAME": "example.com", |
| 88 |
"SERVER_PORT": "80", |
| 89 |
} |
| 90 |
del settings.SITE_ID |
| 91 |
site = get_current_site(request) |
| 92 |
self.assertEqual(site.name, "example.com") |
| 93 |
|
| 94 |
@override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com"]) |
| 95 |
def test_get_current_site_host_with_trailing_dot(self): |
| 96 |
""" |
| 97 |
The site is matched if the name in the request has a trailing dot. |
| 98 |
""" |
| 99 |
request = HttpRequest() |
| 100 |
request.META = { |
| 101 |
"SERVER_NAME": "example.com.", |
| 102 |
"SERVER_PORT": "80", |
| 103 |
} |
| 104 |
site = get_current_site(request) |
| 105 |
self.assertEqual(site.name, "example.com") |
| 106 |
|
| 107 |
@override_settings(SITE_ID=None, ALLOWED_HOSTS=["example.com", "example.net"]) |
| 108 |
def test_get_current_site_no_site_id_and_handle_port_fallback(self): |
| 109 |
request = HttpRequest() |
| 110 |
s1 = self.site |
| 111 |
s2 = Site.objects.create(domain="example.com:80", name="example.com:80") |
| 112 |
|
| 113 |
# Host header without port |
| 114 |
request.META = {"HTTP_HOST": "example.com"} |
| 115 |
site = get_current_site(request) |
| 116 |
self.assertEqual(site, s1) |
| 117 |
|
| 118 |
# Host header with port - match, no fallback without port |
| 119 |
request.META = {"HTTP_HOST": "example.com:80"} |
| 120 |
site = get_current_site(request) |
| 121 |
self.assertEqual(site, s2) |
| 122 |
|
| 123 |
# Host header with port - no match, fallback without port |
| 124 |
request.META = {"HTTP_HOST": "example.com:81"} |
| 125 |
site = get_current_site(request) |
| 126 |
self.assertEqual(site, s1) |
| 127 |
|
| 128 |
# Host header with non-matching domain |
| 129 |
request.META = {"HTTP_HOST": "example.net"} |
| 130 |
with self.assertRaises(ObjectDoesNotExist): |
| 131 |
get_current_site(request) |
| 132 |
|
| 133 |
# Ensure domain for RequestSite always matches host header |
| 134 |
with self.modify_settings(INSTALLED_APPS={"remove": "django.contrib.sites"}): |
| 135 |
request.META = {"HTTP_HOST": "example.com"} |
| 136 |
site = get_current_site(request) |
| 137 |
self.assertEqual(site.name, "example.com") |
| 138 |
|
| 139 |
request.META = {"HTTP_HOST": "example.com:80"} |
| 140 |
site = get_current_site(request) |
| 141 |
self.assertEqual(site.name, "example.com:80") |
| 142 |
|
| 143 |
def test_domain_name_with_whitespaces(self): |
| 144 |
# Regression for #17320 |
| 145 |
# Domain names are not allowed contain whitespace characters |
| 146 |
site = Site(name="test name", domain="test test") |
| 147 |
with self.assertRaises(ValidationError): |
| 148 |
site.full_clean() |
| 149 |
site.domain = "test\ttest" |
| 150 |
with self.assertRaises(ValidationError): |
| 151 |
site.full_clean() |
| 152 |
site.domain = "test\ntest" |
| 153 |
with self.assertRaises(ValidationError): |
| 154 |
site.full_clean() |
| 155 |
|
| 156 |
@override_settings(ALLOWED_HOSTS=["example.com"]) |
| 157 |
def test_clear_site_cache(self): |
| 158 |
request = HttpRequest() |
| 159 |
request.META = { |
| 160 |
"SERVER_NAME": "example.com", |
| 161 |
"SERVER_PORT": "80", |
| 162 |
} |
| 163 |
self.assertEqual(models.SITE_CACHE, {}) |
| 164 |
get_current_site(request) |
| 165 |
expected_cache = {self.site.id: self.site} |
| 166 |
self.assertEqual(models.SITE_CACHE, expected_cache) |
| 167 |
|
| 168 |
with self.settings(SITE_ID=None): |
| 169 |
get_current_site(request) |
| 170 |
|
| 171 |
expected_cache.update({self.site.domain: self.site}) |
| 172 |
self.assertEqual(models.SITE_CACHE, expected_cache) |
| 173 |
|
| 174 |
clear_site_cache(Site, instance=self.site, using="default") |
| 175 |
self.assertEqual(models.SITE_CACHE, {}) |
| 176 |
|
| 177 |
@override_settings(SITE_ID=None, ALLOWED_HOSTS=["example2.com"]) |
| 178 |
def test_clear_site_cache_domain(self): |
| 179 |
site = Site.objects.create(name="example2.com", domain="example2.com") |
| 180 |
request = HttpRequest() |
| 181 |
request.META = { |
| 182 |
"SERVER_NAME": "example2.com", |
| 183 |
"SERVER_PORT": "80", |
| 184 |
} |
| 185 |
get_current_site(request) # prime the models.SITE_CACHE |
| 186 |
expected_cache = {site.domain: site} |
| 187 |
self.assertEqual(models.SITE_CACHE, expected_cache) |
| 188 |
|
| 189 |
# Site exists in 'default' database so using='other' shouldn't clear. |
| 190 |
clear_site_cache(Site, instance=site, using="other") |
| 191 |
self.assertEqual(models.SITE_CACHE, expected_cache) |
| 192 |
# using='default' should clear. |
| 193 |
clear_site_cache(Site, instance=site, using="default") |
| 194 |
self.assertEqual(models.SITE_CACHE, {}) |
| 195 |
|
| 196 |
def test_unique_domain(self): |
| 197 |
site = Site(domain=self.site.domain) |
| 198 |
msg = "Site with this Domain name already exists." |
| 199 |
with self.assertRaisesMessage(ValidationError, msg): |
| 200 |
site.validate_unique() |
| 201 |
|
| 202 |
def test_site_natural_key(self): |
| 203 |
self.assertEqual(Site.objects.get_by_natural_key(self.site.domain), self.site) |
| 204 |
self.assertEqual(self.site.natural_key(), (self.site.domain,)) |
| 205 |
|
| 206 |
@override_settings(SITE_ID="1") |
| 207 |
def test_check_site_id(self): |
| 208 |
self.assertEqual( |
| 209 |
check_site_id(None), |
| 210 |
[ |
| 211 |
checks.Error( |
| 212 |
msg="The SITE_ID setting must be an integer", |
| 213 |
id="sites.E101", |
| 214 |
), |
| 215 |
], |
| 216 |
) |
| 217 |
|
| 218 |
def test_valid_site_id(self): |
| 219 |
for site_id in [1, None]: |
| 220 |
with self.subTest(site_id=site_id), self.settings(SITE_ID=site_id): |
| 221 |
self.assertEqual(check_site_id(None), []) |
| 222 |
|
| 223 |
|
| 224 |
@override_settings(ALLOWED_HOSTS=["example.com"]) |
| 225 |
class RequestSiteTests(SimpleTestCase): |
| 226 |
def setUp(self): |
| 227 |
request = HttpRequest() |
| 228 |
request.META = {"HTTP_HOST": "example.com"} |
| 229 |
self.site = RequestSite(request) |
| 230 |
|
| 231 |
def test_init_attributes(self): |
| 232 |
self.assertEqual(self.site.domain, "example.com") |
| 233 |
self.assertEqual(self.site.name, "example.com") |
| 234 |
|
| 235 |
def test_str(self): |
| 236 |
self.assertEqual(str(self.site), "example.com") |
| 237 |
|
| 238 |
def test_save(self): |
| 239 |
msg = "RequestSite cannot be saved." |
| 240 |
with self.assertRaisesMessage(NotImplementedError, msg): |
| 241 |
self.site.save() |
| 242 |
|
| 243 |
def test_delete(self): |
| 244 |
msg = "RequestSite cannot be deleted." |
| 245 |
with self.assertRaisesMessage(NotImplementedError, msg): |
| 246 |
self.site.delete() |
| 247 |
|
| 248 |
|
| 249 |
class JustOtherRouter: |
| 250 |
def allow_migrate(self, db, app_label, **hints): |
| 251 |
return db == "other" |
| 252 |
|
| 253 |
|
| 254 |
@modify_settings(INSTALLED_APPS={"append": "django.contrib.sites"}) |
| 255 |
class CreateDefaultSiteTests(TestCase): |
| 256 |
databases = {"default", "other"} |
| 257 |
|
| 258 |
@classmethod |
| 259 |
def setUpTestData(cls): |
| 260 |
# Delete the site created as part of the default migration process. |
| 261 |
Site.objects.all().delete() |
| 262 |
|
| 263 |
def setUp(self): |
| 264 |
self.app_config = apps.get_app_config("sites") |
| 265 |
|
| 266 |
def test_basic(self): |
| 267 |
""" |
| 268 |
#15346, #15573 - create_default_site() creates an example site only if |
| 269 |
none exist. |
| 270 |
""" |
| 271 |
with captured_stdout() as stdout: |
| 272 |
create_default_site(self.app_config) |
| 273 |
self.assertEqual(Site.objects.count(), 1) |
| 274 |
self.assertIn("Creating example.com", stdout.getvalue()) |
| 275 |
|
| 276 |
with captured_stdout() as stdout: |
| 277 |
create_default_site(self.app_config) |
| 278 |
self.assertEqual(Site.objects.count(), 1) |
| 279 |
self.assertEqual("", stdout.getvalue()) |
| 280 |
|
| 281 |
@override_settings(DATABASE_ROUTERS=[JustOtherRouter()]) |
| 282 |
def test_multi_db_with_router(self): |
| 283 |
""" |
| 284 |
#16353, #16828 - The default site creation should respect db routing. |
| 285 |
""" |
| 286 |
create_default_site(self.app_config, using="default", verbosity=0) |
| 287 |
create_default_site(self.app_config, using="other", verbosity=0) |
| 288 |
self.assertFalse(Site.objects.using("default").exists()) |
| 289 |
self.assertTrue(Site.objects.using("other").exists()) |
| 290 |
|
| 291 |
def test_multi_db(self): |
| 292 |
create_default_site(self.app_config, using="default", verbosity=0) |
| 293 |
create_default_site(self.app_config, using="other", verbosity=0) |
| 294 |
self.assertTrue(Site.objects.using("default").exists()) |
| 295 |
self.assertTrue(Site.objects.using("other").exists()) |
| 296 |
|
| 297 |
def test_save_another(self): |
| 298 |
""" |
| 299 |
#17415 - Another site can be created right after the default one. |
| 300 |
|
| 301 |
On some backends the sequence needs to be reset after saving with an |
| 302 |
explicit ID. There shouldn't be a sequence collisions by saving another |
| 303 |
site. This test is only meaningful with databases that use sequences |
| 304 |
for automatic primary keys such as PostgreSQL and Oracle. |
| 305 |
""" |
| 306 |
create_default_site(self.app_config, verbosity=0) |
| 307 |
Site(domain="example2.com", name="example2.com").save() |
| 308 |
|
| 309 |
def test_signal(self): |
| 310 |
""" |
| 311 |
#23641 - Sending the ``post_migrate`` signal triggers creation of the |
| 312 |
default site. |
| 313 |
""" |
| 314 |
post_migrate.send( |
| 315 |
sender=self.app_config, app_config=self.app_config, verbosity=0 |
| 316 |
) |
| 317 |
self.assertTrue(Site.objects.exists()) |
| 318 |
|
| 319 |
@override_settings(SITE_ID=35696) |
| 320 |
def test_custom_site_id(self): |
| 321 |
""" |
| 322 |
#23945 - The configured ``SITE_ID`` should be respected. |
| 323 |
""" |
| 324 |
create_default_site(self.app_config, verbosity=0) |
| 325 |
self.assertEqual(Site.objects.get().pk, 35696) |
| 326 |
|
| 327 |
@override_settings() # Restore original ``SITE_ID`` afterward. |
| 328 |
def test_no_site_id(self): |
| 329 |
""" |
| 330 |
#24488 - The pk should default to 1 if no ``SITE_ID`` is configured. |
| 331 |
""" |
| 332 |
del settings.SITE_ID |
| 333 |
create_default_site(self.app_config, verbosity=0) |
| 334 |
self.assertEqual(Site.objects.get().pk, 1) |
| 335 |
|
| 336 |
def test_unavailable_site_model(self): |
| 337 |
""" |
| 338 |
#24075 - A Site shouldn't be created if the model isn't available. |
| 339 |
""" |
| 340 |
apps = Apps() |
| 341 |
create_default_site(self.app_config, verbosity=0, apps=apps) |
| 342 |
self.assertFalse(Site.objects.exists()) |
| 343 |
|
| 344 |
|
| 345 |
class MiddlewareTest(TestCase): |
| 346 |
def test_request(self): |
| 347 |
def get_response(request): |
| 348 |
return HttpResponse(str(request.site.id)) |
| 349 |
|
| 350 |
response = CurrentSiteMiddleware(get_response)(HttpRequest()) |
| 351 |
self.assertContains(response, settings.SITE_ID) |