autouse function scoped fixture that cleares django.contrib.sites.models.SITE_CACHE #323 (#323)

Author: peterlauri

docs/changelog.rst

@@ -9,6 +9,9 @@ Features
 * Added new function scoped fixture ``mailoutbox`` that gives access to
   djangos ``mail.outbox``. The will clean/empty the ``mail.outbox`` to
   assure that no old mails are still in the outbox.
+* If ``django.contrib.sites`` is in your INSTALLED_APPS, Site cache will
+  be cleared for each test to avoid hitting the cache and cause wrong Site
+  object to be returned by ``Site.objects.get_current()``.
 
 Compatibility
 ^^^^^^^^^^^^^

docs/helpers.rst

@@ -239,3 +239,18 @@ Example
         assert m.from_email == 'from@example.com'
         assert list(m.to) == ['to@example.com']
 
+
+Environment autouse fixtures
+----------------------------
+
+pytest-django provides some pytest fixtures that are of autouse
+nature. They provide functionality to assure a clean environment
+during tests.
+
+
+Clearing of site cache
+~~~~~~~~~~~~~~~~~~~~~~
+
+If ``django.contrib.sites`` is in your INSTALLED_APPS, Site cache will
+be cleared for each test to avoid hitting the cache and cause wrong Site
+object to be returned by ``Site.objects.get_current()``.

pytest_django/plugin.py

@@ -539,6 +539,20 @@ def _template_string_if_invalid_marker(request):
             else:
                 dj_settings.TEMPLATE_STRING_IF_INVALID.fail = False
 
+
+@pytest.fixture(autouse=True, scope='function')
+def _django_clear_site_cache():
+    """Clears ``django.contrib.sites.models.SITE_CACHE`` to avoid
+    unexpected behavior with cached site objects.
+    """
+
+    if django_settings_is_configured():
+        from django.conf import settings as dj_settings
+
+        if 'django.contrib.sites' in dj_settings.INSTALLED_APPS:
+            from django.contrib.sites.models import Site
+            Site.objects.clear_cache()
+
 # ############### Helper Functions ################
 
 

tests/test_environment.py

@@ -3,9 +3,12 @@
 import os
 
 import pytest
+from django.contrib.sites.models import Site
+from django.contrib.sites import models as site_models
 from django.core import mail
 from django.db import connection
 from django.test import TestCase
+from pytest_django.lazy_django import get_django_version
 
 from pytest_django_test.app.models import Item
 
@@ -215,3 +218,26 @@ def test_more_verbose_with_vv_and_reusedb(self, testdir):
             "*PASSED*"])
         assert ("*Destroying test database for alias 'default' ('*')...*"
                 not in result.stdout.str())
+
+
+@pytest.mark.skipif(
+    get_django_version() < (1, 8),
+    reason='Django 1.7 requires settings.SITE_ID to be set, so this test is invalid'
+)
+@pytest.mark.django_db
+@pytest.mark.parametrize('site_name', ['site1', 'site2'])
+def test_clear_site_cache(site_name, rf, monkeypatch):
+    request = rf.get('/')
+    monkeypatch.setattr(request, 'get_host', lambda: 'foo.com')
+    Site.objects.create(domain='foo.com', name=site_name)
+    assert Site.objects.get_current(request=request).name == site_name
+
+
+@pytest.mark.django_db
+@pytest.mark.parametrize('site_name', ['site1', 'site2'])
+def test_clear_site_cache_check_site_cache_size(site_name, settings):
+    assert len(site_models.SITE_CACHE) == 0
+    site = Site.objects.create(domain='foo.com', name=site_name)
+    settings.SITE_ID = site.id
+    assert Site.objects.get_current() == site
+    assert len(site_models.SITE_CACHE) == 1