mirror of
https://github.com/Hopiu/django-cachalot.git
synced 2026-05-09 21:24:44 +00:00
165cdb6a00
* Remove system check for Django version * Closes #175 * Bump version and amend CHANGELOG * Update with GitHub action CI * Update README with Python and Django versions * Limit Django version to 3.2, inclusively. * Add note on Django constraints to README * Bump minor version * Justified by dropping support for dependency versions * Drop support for Django 2.0-2.1, Python 3.5 * Change CI badge in README to GitHub actions * Add support for Pymemcache for Django 3.2+ * Add Django 3.2 to test matrix * Fix MySQL test_explain * Allow filebased delta leniency in tests * Allow Subquery in finding more Subqueries (Fixes #156) * Reverts #157 with proper fix. The initial problem was due to `django.db.models.expressions.Subquery` allowing both QuerySet and sql.Query to be used. * Fixes Django 3.2 test_subquery and test_invalidate_subquery testing by also checking the lhs * Fix Django 2.2 Subquery having no query attr * Fix filebased test time delta * Fix test_invalidate_having due to new inner_query * The new inner_query replaces subquery for Django 3.2 where subquery is now a boolean. That's why I initially used that TypeError in _get_tables_from_sql. inner_query looks to be a sql.Query * Add PyMemcacheCache to supported cache backends Co-authored-by: Dominik George <nik@naturalnet.de>
394 lines
16 KiB
Python
394 lines
16 KiB
Python
import os
|
||
from time import time, sleep
|
||
from unittest import skipIf
|
||
|
||
from django.conf import settings
|
||
from django.contrib.auth.models import Permission, User
|
||
from django.core.cache import DEFAULT_CACHE_ALIAS, caches
|
||
from django.core.management import call_command
|
||
from django.db import connection, transaction, DEFAULT_DB_ALIAS
|
||
from django.template import engines
|
||
from django.test import TransactionTestCase
|
||
from jinja2.exceptions import TemplateSyntaxError
|
||
|
||
from ..api import *
|
||
from .models import Test
|
||
from .test_utils import TestUtilsMixin
|
||
|
||
|
||
class APITestCase(TestUtilsMixin, TransactionTestCase):
|
||
databases = set(settings.DATABASES.keys())
|
||
|
||
def setUp(self):
|
||
super(APITestCase, self).setUp()
|
||
self.t1 = Test.objects.create(name='test1')
|
||
self.cache_alias2 = next(alias for alias in settings.CACHES
|
||
if alias != DEFAULT_CACHE_ALIAS)
|
||
# For cachalot_disabled test
|
||
self.user = User.objects.create_user('user')
|
||
self.t1__permission = (Permission.objects.order_by('?')
|
||
.select_related('content_type')[0])
|
||
|
||
def test_invalidate_tables(self):
|
||
with self.assertNumQueries(1):
|
||
data1 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data1, ['test1'])
|
||
|
||
with self.settings(CACHALOT_INVALIDATE_RAW=False):
|
||
with connection.cursor() as cursor:
|
||
cursor.execute(
|
||
"INSERT INTO cachalot_test (name, public) "
|
||
"VALUES ('test2', %s);", [1 if self.is_sqlite else True])
|
||
|
||
with self.assertNumQueries(0):
|
||
data2 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data2, ['test1'])
|
||
|
||
invalidate('cachalot_test')
|
||
|
||
with self.assertNumQueries(1):
|
||
data3 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data3, ['test1', 'test2'])
|
||
|
||
def test_invalidate_models_lookups(self):
|
||
with self.assertNumQueries(1):
|
||
data1 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data1, ['test1'])
|
||
|
||
with self.settings(CACHALOT_INVALIDATE_RAW=False):
|
||
with connection.cursor() as cursor:
|
||
cursor.execute(
|
||
"INSERT INTO cachalot_test (name, public) "
|
||
"VALUES ('test2', %s);", [1 if self.is_sqlite else True])
|
||
|
||
with self.assertNumQueries(0):
|
||
data2 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data2, ['test1'])
|
||
|
||
invalidate('cachalot.Test')
|
||
|
||
with self.assertNumQueries(1):
|
||
data3 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data3, ['test1', 'test2'])
|
||
|
||
def test_invalidate_models(self):
|
||
with self.assertNumQueries(1):
|
||
data1 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data1, ['test1'])
|
||
|
||
with self.settings(CACHALOT_INVALIDATE_RAW=False):
|
||
with connection.cursor() as cursor:
|
||
cursor.execute(
|
||
"INSERT INTO cachalot_test (name, public) "
|
||
"VALUES ('test2', %s);", [1 if self.is_sqlite else True])
|
||
|
||
with self.assertNumQueries(0):
|
||
data2 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data2, ['test1'])
|
||
|
||
invalidate(Test)
|
||
|
||
with self.assertNumQueries(1):
|
||
data3 = list(Test.objects.values_list('name', flat=True))
|
||
self.assertListEqual(data3, ['test1', 'test2'])
|
||
|
||
def test_invalidate_all(self):
|
||
with self.assertNumQueries(1):
|
||
Test.objects.get()
|
||
|
||
with self.assertNumQueries(0):
|
||
Test.objects.get()
|
||
|
||
invalidate()
|
||
|
||
with self.assertNumQueries(1):
|
||
Test.objects.get()
|
||
|
||
def test_invalidate_all_in_atomic(self):
|
||
with transaction.atomic():
|
||
with self.assertNumQueries(1):
|
||
Test.objects.get()
|
||
|
||
with self.assertNumQueries(0):
|
||
Test.objects.get()
|
||
|
||
invalidate()
|
||
|
||
with self.assertNumQueries(1):
|
||
Test.objects.get()
|
||
|
||
with self.assertNumQueries(1):
|
||
Test.objects.get()
|
||
|
||
def test_get_last_invalidation(self):
|
||
invalidate()
|
||
timestamp = get_last_invalidation()
|
||
delta = 0.15 if os.environ.get("CACHE_BACKEND") == "filebased" else 0.1
|
||
self.assertAlmostEqual(timestamp, time(), delta=delta)
|
||
|
||
sleep(0.1)
|
||
|
||
invalidate('cachalot_test')
|
||
timestamp = get_last_invalidation('cachalot_test')
|
||
self.assertAlmostEqual(timestamp, time(), delta=delta)
|
||
same_timestamp = get_last_invalidation('cachalot.Test')
|
||
self.assertEqual(same_timestamp, timestamp)
|
||
same_timestamp = get_last_invalidation(Test)
|
||
self.assertEqual(same_timestamp, timestamp)
|
||
|
||
timestamp = get_last_invalidation('cachalot_testparent')
|
||
self.assertNotAlmostEqual(timestamp, time(), delta=0.1)
|
||
timestamp = get_last_invalidation('cachalot_testparent', 'cachalot_test')
|
||
self.assertAlmostEqual(timestamp, time(), delta=delta)
|
||
|
||
def test_get_last_invalidation_template_tag(self):
|
||
# Without arguments
|
||
original_timestamp = engines['django'].from_string(
|
||
"{{ timestamp }}"
|
||
).render({
|
||
'timestamp': get_last_invalidation(),
|
||
})
|
||
|
||
template = engines['django'].from_string("""
|
||
{% load cachalot %}
|
||
{% get_last_invalidation as timestamp %}
|
||
{{ timestamp }}
|
||
""")
|
||
timestamp = template.render().strip()
|
||
|
||
self.assertNotEqual(timestamp, '')
|
||
self.assertNotEqual(timestamp, '0.0')
|
||
self.assertAlmostEqual(float(timestamp), float(original_timestamp),
|
||
delta=0.1)
|
||
|
||
# With arguments
|
||
original_timestamp = engines['django'].from_string(
|
||
"{{ timestamp }}"
|
||
).render({
|
||
'timestamp': get_last_invalidation('auth.Group', 'cachalot_test'),
|
||
})
|
||
|
||
template = engines['django'].from_string("""
|
||
{% load cachalot %}
|
||
{% get_last_invalidation 'auth.Group' 'cachalot_test' as timestamp %}
|
||
{{ timestamp }}
|
||
""")
|
||
timestamp = template.render().strip()
|
||
|
||
self.assertNotEqual(timestamp, '')
|
||
self.assertNotEqual(timestamp, '0.0')
|
||
self.assertAlmostEqual(float(timestamp), float(original_timestamp),
|
||
delta=0.1)
|
||
|
||
# While using the `cache` template tag, with invalidation
|
||
template = engines['django'].from_string("""
|
||
{% load cachalot cache %}
|
||
{% get_last_invalidation 'auth.Group' 'cachalot_test' as timestamp %}
|
||
{% cache 10 cache_key_name timestamp %}
|
||
{{ content }}
|
||
{% endcache %}
|
||
""")
|
||
content = template.render({'content': 'something'}).strip()
|
||
self.assertEqual(content, 'something')
|
||
content = template.render({'content': 'anything'}).strip()
|
||
self.assertEqual(content, 'something')
|
||
invalidate('cachalot_test')
|
||
content = template.render({'content': 'yet another'}).strip()
|
||
self.assertEqual(content, 'yet another')
|
||
|
||
def test_get_last_invalidation_jinja2(self):
|
||
original_timestamp = engines['jinja2'].from_string(
|
||
"{{ timestamp }}"
|
||
).render({
|
||
'timestamp': get_last_invalidation('auth.Group', 'cachalot_test'),
|
||
})
|
||
template = engines['jinja2'].from_string(
|
||
"{{ get_last_invalidation('auth.Group', 'cachalot_test') }}")
|
||
timestamp = template.render({})
|
||
|
||
self.assertNotEqual(timestamp, '')
|
||
self.assertNotEqual(timestamp, '0.0')
|
||
self.assertAlmostEqual(float(timestamp), float(original_timestamp),
|
||
delta=0.1)
|
||
|
||
def test_cache_jinja2(self):
|
||
# Invalid arguments
|
||
with self.assertRaises(TemplateSyntaxError,
|
||
msg="'invalid' is not a valid keyword argument "
|
||
"for {% cache %}"):
|
||
engines['jinja2'].from_string("""
|
||
{% cache cache_key='anything', invalid='what?' %}{% endcache %}
|
||
""")
|
||
with self.assertRaises(ValueError, msg='You must set `cache_key` when '
|
||
'the template is not a file.'):
|
||
engines['jinja2'].from_string(
|
||
'{% cache %} broken {% endcache %}').render()
|
||
|
||
# With the minimum number of arguments
|
||
template = engines['jinja2'].from_string("""
|
||
{%- cache cache_key='first' -%}
|
||
{{ content1 }}
|
||
{%- endcache -%}
|
||
{%- cache cache_key='second' -%}
|
||
{{ content2 }}
|
||
{%- endcache -%}
|
||
""")
|
||
content = template.render({'content1': 'abc', 'content2': 'def'})
|
||
self.assertEqual(content, 'abcdef')
|
||
invalidate()
|
||
content = template.render({'content1': 'ghi', 'content2': 'jkl'})
|
||
self.assertEqual(content, 'abcdef')
|
||
|
||
# With the maximum number of arguments
|
||
template = engines['jinja2'].from_string("""
|
||
{%- cache get_last_invalidation('auth.Group', 'cachalot_test',
|
||
cache_alias=cache),
|
||
timeout=10, cache_key='cache_key_name', cache_alias=cache -%}
|
||
{{ content }}
|
||
{%- endcache -%}
|
||
""")
|
||
content = template.render({'content': 'something',
|
||
'cache': self.cache_alias2})
|
||
self.assertEqual(content, 'something')
|
||
content = template.render({'content': 'anything',
|
||
'cache': self.cache_alias2})
|
||
self.assertEqual(content, 'something')
|
||
invalidate('cachalot_test', cache_alias=DEFAULT_CACHE_ALIAS)
|
||
content = template.render({'content': 'yet another',
|
||
'cache': self.cache_alias2})
|
||
self.assertEqual(content, 'something')
|
||
invalidate('cachalot_test')
|
||
content = template.render({'content': 'will you change?',
|
||
'cache': self.cache_alias2})
|
||
self.assertEqual(content, 'will you change?')
|
||
caches[self.cache_alias2].clear()
|
||
content = template.render({'content': 'better!',
|
||
'cache': self.cache_alias2})
|
||
self.assertEqual(content, 'better!')
|
||
|
||
def test_cachalot_disabled_multiple_queries_ignoring_in_mem_cache(self):
|
||
"""
|
||
Test that when queries are given the `cachalot_disabled` context manager,
|
||
the queries will not be cached.
|
||
"""
|
||
with cachalot_disabled(True):
|
||
qs = Test.objects.all()
|
||
with self.assertNumQueries(1):
|
||
data1 = list(qs.all())
|
||
Test.objects.create(
|
||
name='test3', owner=self.user,
|
||
date='1789-07-14', datetime='1789-07-14T16:43:27',
|
||
permission=self.t1__permission)
|
||
with self.assertNumQueries(1):
|
||
data2 = list(qs.all())
|
||
self.assertNotEqual(data1, data2)
|
||
|
||
def test_query_cachalot_disabled_even_if_already_cached(self):
|
||
"""
|
||
Test that when a query is given the `cachalot_disabled` context manager,
|
||
the query outside of the context manager will be cached. Any duplicated
|
||
query will use the original query's cached result.
|
||
"""
|
||
qs = Test.objects.all()
|
||
self.assert_query_cached(qs)
|
||
with cachalot_disabled() and self.assertNumQueries(0):
|
||
list(qs.all())
|
||
|
||
def test_duplicate_query_execute_anyways(self):
|
||
"""After an object is created, a duplicate query should execute
|
||
rather than use the cached result.
|
||
"""
|
||
qs = Test.objects.all()
|
||
self.assert_query_cached(qs)
|
||
Test.objects.create(
|
||
name='test3', owner=self.user,
|
||
date='1789-07-14', datetime='1789-07-14T16:43:27',
|
||
permission=self.t1__permission)
|
||
with cachalot_disabled() and self.assertNumQueries(1):
|
||
list(qs.all())
|
||
|
||
|
||
class CommandTestCase(TransactionTestCase):
|
||
multi_db = True
|
||
databases = "__all__"
|
||
|
||
def setUp(self):
|
||
self.db_alias2 = next(alias for alias in settings.DATABASES
|
||
if alias != DEFAULT_DB_ALIAS)
|
||
|
||
self.cache_alias2 = next(alias for alias in settings.CACHES
|
||
if alias != DEFAULT_CACHE_ALIAS)
|
||
|
||
self.t1 = Test.objects.create(name='test1')
|
||
self.t2 = Test.objects.using(self.db_alias2).create(name='test2')
|
||
self.u = User.objects.create_user('test')
|
||
|
||
def test_invalidate_cachalot(self):
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
call_command('invalidate_cachalot', verbosity=0)
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
|
||
call_command('invalidate_cachalot', 'auth', verbosity=0)
|
||
with self.assertNumQueries(0):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
|
||
call_command('invalidate_cachalot', 'cachalot', verbosity=0)
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
|
||
call_command('invalidate_cachalot', 'cachalot.testchild', verbosity=0)
|
||
with self.assertNumQueries(0):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
|
||
call_command('invalidate_cachalot', 'cachalot.test', verbosity=0)
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(User.objects.all()), [self.u])
|
||
call_command('invalidate_cachalot', 'cachalot.test', 'auth.user',
|
||
verbosity=0)
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(User.objects.all()), [self.u])
|
||
|
||
@skipIf(len(settings.DATABASES) == 1,
|
||
'We can’t change the DB used since there’s only one configured')
|
||
def test_invalidate_cachalot_multi_db(self):
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
call_command('invalidate_cachalot', verbosity=0,
|
||
db_alias=self.db_alias2)
|
||
with self.assertNumQueries(0):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
|
||
with self.assertNumQueries(1, using=self.db_alias2):
|
||
self.assertListEqual(list(Test.objects.using(self.db_alias2)),
|
||
[self.t2])
|
||
call_command('invalidate_cachalot', verbosity=0,
|
||
db_alias=self.db_alias2)
|
||
with self.assertNumQueries(1, using=self.db_alias2):
|
||
self.assertListEqual(list(Test.objects.using(self.db_alias2)),
|
||
[self.t2])
|
||
|
||
@skipIf(len(settings.CACHES) == 1,
|
||
'We can’t change the cache used since there’s only one configured')
|
||
def test_invalidate_cachalot_multi_cache(self):
|
||
with self.assertNumQueries(1):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
call_command('invalidate_cachalot', verbosity=0,
|
||
cache_alias=self.cache_alias2)
|
||
with self.assertNumQueries(0):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
|
||
with self.assertNumQueries(1):
|
||
with self.settings(CACHALOT_CACHE=self.cache_alias2):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|
||
call_command('invalidate_cachalot', verbosity=0,
|
||
cache_alias=self.cache_alias2)
|
||
with self.assertNumQueries(1):
|
||
with self.settings(CACHALOT_CACHE=self.cache_alias2):
|
||
self.assertListEqual(list(Test.objects.all()), [self.t1])
|