2007-07-16 17:36:10 +08:00
# -*- coding: utf-8 -*-
2006-08-27 21:59:47 +08:00
# Unit tests for cache framework
# Uses whatever cache backend is set in the test settings file.
2008-08-02 13:56:57 +08:00
import os
import shutil
import tempfile
2007-12-05 02:03:56 +08:00
import time
2010-09-13 02:45:26 +08:00
import warnings
2008-08-02 13:56:57 +08:00
2009-03-11 21:27:03 +08:00
from django . conf import settings
from django . core import management
2010-12-21 23:19:19 +08:00
from django . core . cache import get_cache , DEFAULT_CACHE_ALIAS
2010-09-13 02:45:26 +08:00
from django . core . cache . backends . base import InvalidCacheBackendError , CacheKeyWarning
2009-04-02 02:19:32 +08:00
from django . http import HttpResponse , HttpRequest
2010-02-24 04:45:28 +08:00
from django . middleware . cache import FetchFromCacheMiddleware , UpdateCacheMiddleware
2010-11-11 23:06:20 +08:00
from django . test . utils import get_warnings_state , restore_warnings_state
2010-02-24 04:45:28 +08:00
from django . utils import translation
2010-10-11 20:55:17 +08:00
from django . utils import unittest
2009-04-02 02:19:32 +08:00
from django . utils . cache import patch_vary_headers , get_cache_key , learn_cache_key
2008-08-02 13:56:57 +08:00
from django . utils . hashcompat import md5_constructor
2009-10-29 22:32:01 +08:00
from regressiontests . cache . models import Poll , expensive_calculation
2007-11-19 11:12:19 +08:00
2007-07-15 14:24:54 +08:00
# functions/classes for complex data type tests
2006-08-27 21:59:47 +08:00
def f ( ) :
return 42
class C :
def m ( n ) :
return 24
2009-03-11 21:27:03 +08:00
class DummyCacheTests ( unittest . TestCase ) :
# The Dummy cache backend doesn't really behave like a test backend,
# so it has different test requirements.
2008-10-11 05:41:12 +08:00
def setUp ( self ) :
2010-12-21 23:19:19 +08:00
self . cache = get_cache ( ' django.core.cache.backends.dummy.DummyCache ' )
2009-03-11 21:27:03 +08:00
def test_simple ( self ) :
" Dummy cache backend ignores cache set calls "
self . cache . set ( " key " , " value " )
self . assertEqual ( self . cache . get ( " key " ) , None )
def test_add ( self ) :
" Add doesn ' t do anything in dummy cache backend "
self . cache . add ( " addkey1 " , " value " )
result = self . cache . add ( " addkey1 " , " newvalue " )
self . assertEqual ( result , True )
self . assertEqual ( self . cache . get ( " addkey1 " ) , None )
def test_non_existent ( self ) :
" Non-existent keys aren ' t found in the dummy cache backend "
self . assertEqual ( self . cache . get ( " does_not_exist " ) , None )
self . assertEqual ( self . cache . get ( " does_not_exist " , " bang! " ) , " bang! " )
def test_get_many ( self ) :
" get_many returns nothing for the dummy cache backend "
self . cache . set ( ' a ' , ' a ' )
self . cache . set ( ' b ' , ' b ' )
self . cache . set ( ' c ' , ' c ' )
self . cache . set ( ' d ' , ' d ' )
self . assertEqual ( self . cache . get_many ( [ ' a ' , ' c ' , ' d ' ] ) , { } )
self . assertEqual ( self . cache . get_many ( [ ' a ' , ' b ' , ' e ' ] ) , { } )
def test_delete ( self ) :
" Cache deletion is transparently ignored on the dummy cache backend "
self . cache . set ( " key1 " , " spam " )
self . cache . set ( " key2 " , " eggs " )
self . assertEqual ( self . cache . get ( " key1 " ) , None )
self . cache . delete ( " key1 " )
self . assertEqual ( self . cache . get ( " key1 " ) , None )
self . assertEqual ( self . cache . get ( " key2 " ) , None )
def test_has_key ( self ) :
" The has_key method doesn ' t ever return True for the dummy cache backend "
self . cache . set ( " hello1 " , " goodbye1 " )
self . assertEqual ( self . cache . has_key ( " hello1 " ) , False )
self . assertEqual ( self . cache . has_key ( " goodbye1 " ) , False )
def test_in ( self ) :
" The in operator doesn ' t ever return True for the dummy cache backend "
self . cache . set ( " hello2 " , " goodbye2 " )
self . assertEqual ( " hello2 " in self . cache , False )
self . assertEqual ( " goodbye2 " in self . cache , False )
def test_incr ( self ) :
" Dummy cache values can ' t be incremented "
self . cache . set ( ' answer ' , 42 )
self . assertRaises ( ValueError , self . cache . incr , ' answer ' )
self . assertRaises ( ValueError , self . cache . incr , ' does_not_exist ' )
def test_decr ( self ) :
" Dummy cache values can ' t be decremented "
self . cache . set ( ' answer ' , 42 )
self . assertRaises ( ValueError , self . cache . decr , ' answer ' )
self . assertRaises ( ValueError , self . cache . decr , ' does_not_exist ' )
def test_data_types ( self ) :
" All data types are ignored equally by the dummy cache "
stuff = {
' string ' : ' this is a string ' ,
' int ' : 42 ,
' list ' : [ 1 , 2 , 3 , 4 ] ,
' tuple ' : ( 1 , 2 , 3 , 4 ) ,
' dict ' : { ' A ' : 1 , ' B ' : 2 } ,
' function ' : f ,
' class ' : C ,
}
self . cache . set ( " stuff " , stuff )
self . assertEqual ( self . cache . get ( " stuff " ) , None )
def test_expiration ( self ) :
" Expiration has no effect on the dummy cache "
self . cache . set ( ' expire1 ' , ' very quickly ' , 1 )
self . cache . set ( ' expire2 ' , ' very quickly ' , 1 )
self . cache . set ( ' expire3 ' , ' very quickly ' , 1 )
time . sleep ( 2 )
self . assertEqual ( self . cache . get ( " expire1 " ) , None )
self . cache . add ( " expire2 " , " newvalue " )
self . assertEqual ( self . cache . get ( " expire2 " ) , None )
self . assertEqual ( self . cache . has_key ( " expire3 " ) , False )
def test_unicode ( self ) :
" Unicode values are ignored by the dummy cache "
stuff = {
u ' ascii ' : u ' ascii_value ' ,
u ' unicode_ascii ' : u ' Iñtërnâtiônàlizætiøn1 ' ,
u ' Iñtërnâtiônàlizætiøn ' : u ' Iñtërnâtiônàlizætiøn2 ' ,
u ' ascii ' : { u ' x ' : 1 }
}
for ( key , value ) in stuff . items ( ) :
self . cache . set ( key , value )
self . assertEqual ( self . cache . get ( key ) , None )
2010-01-27 16:21:35 +08:00
def test_set_many ( self ) :
" set_many does nothing for the dummy cache backend "
self . cache . set_many ( { ' a ' : 1 , ' b ' : 2 } )
def test_delete_many ( self ) :
" delete_many does nothing for the dummy cache backend "
self . cache . delete_many ( [ ' a ' , ' b ' ] )
def test_clear ( self ) :
" clear does nothing for the dummy cache backend "
self . cache . clear ( )
2010-11-19 23:39:35 +08:00
def test_incr_version ( self ) :
" Dummy cache versions can ' t be incremented "
self . cache . set ( ' answer ' , 42 )
self . assertRaises ( ValueError , self . cache . incr_version , ' answer ' )
self . assertRaises ( ValueError , self . cache . incr_version , ' does_not_exist ' )
def test_decr_version ( self ) :
" Dummy cache versions can ' t be decremented "
self . cache . set ( ' answer ' , 42 )
self . assertRaises ( ValueError , self . cache . decr_version , ' answer ' )
self . assertRaises ( ValueError , self . cache . decr_version , ' does_not_exist ' )
2009-03-11 21:27:03 +08:00
class BaseCacheTests ( object ) :
# A common set of tests to apply to all cache backends
2010-01-27 16:21:35 +08:00
2006-08-27 21:59:47 +08:00
def test_simple ( self ) :
2009-03-11 21:27:03 +08:00
# Simple cache set/get works
2008-10-11 05:41:12 +08:00
self . cache . set ( " key " , " value " )
self . assertEqual ( self . cache . get ( " key " ) , " value " )
2006-08-27 21:59:47 +08:00
2007-10-20 23:16:34 +08:00
def test_add ( self ) :
2009-03-11 21:27:03 +08:00
# A key can be added to a cache
2008-10-11 05:41:12 +08:00
self . cache . add ( " addkey1 " , " value " )
result = self . cache . add ( " addkey1 " , " newvalue " )
2008-08-10 11:52:21 +08:00
self . assertEqual ( result , False )
2008-10-11 05:41:12 +08:00
self . assertEqual ( self . cache . get ( " addkey1 " ) , " value " )
2008-08-02 13:56:57 +08:00
2010-11-19 23:39:35 +08:00
def test_prefix ( self ) :
# Test for same cache key conflicts between shared backend
self . cache . set ( ' somekey ' , ' value ' )
# should not be set in the prefixed cache
self . assertFalse ( self . prefix_cache . has_key ( ' somekey ' ) )
self . prefix_cache . set ( ' somekey ' , ' value2 ' )
self . assertEqual ( self . cache . get ( ' somekey ' ) , ' value ' )
self . assertEqual ( self . prefix_cache . get ( ' somekey ' ) , ' value2 ' )
2006-08-27 21:59:47 +08:00
def test_non_existent ( self ) :
2009-03-11 21:27:03 +08:00
# Non-existent cache keys return as None/default
2006-08-27 21:59:47 +08:00
# get with non-existent keys
2008-10-11 05:41:12 +08:00
self . assertEqual ( self . cache . get ( " does_not_exist " ) , None )
self . assertEqual ( self . cache . get ( " does_not_exist " , " bang! " ) , " bang! " )
2006-08-27 21:59:47 +08:00
def test_get_many ( self ) :
2009-03-11 21:27:03 +08:00
# Multiple cache keys can be returned using get_many
2008-10-11 05:41:12 +08:00
self . cache . set ( ' a ' , ' a ' )
self . cache . set ( ' b ' , ' b ' )
self . cache . set ( ' c ' , ' c ' )
self . cache . set ( ' d ' , ' d ' )
self . assertEqual ( self . cache . get_many ( [ ' a ' , ' c ' , ' d ' ] ) , { ' a ' : ' a ' , ' c ' : ' c ' , ' d ' : ' d ' } )
self . assertEqual ( self . cache . get_many ( [ ' a ' , ' b ' , ' e ' ] ) , { ' a ' : ' a ' , ' b ' : ' b ' } )
2006-08-27 21:59:47 +08:00
def test_delete ( self ) :
2009-03-11 21:27:03 +08:00
# Cache keys can be deleted
2008-10-11 05:41:12 +08:00
self . cache . set ( " key1 " , " spam " )
self . cache . set ( " key2 " , " eggs " )
self . assertEqual ( self . cache . get ( " key1 " ) , " spam " )
self . cache . delete ( " key1 " )
self . assertEqual ( self . cache . get ( " key1 " ) , None )
self . assertEqual ( self . cache . get ( " key2 " ) , " eggs " )
2006-08-27 21:59:47 +08:00
def test_has_key ( self ) :
2009-03-11 21:27:03 +08:00
# The cache can be inspected for cache keys
2008-10-11 05:41:12 +08:00
self . cache . set ( " hello1 " , " goodbye1 " )
self . assertEqual ( self . cache . has_key ( " hello1 " ) , True )
self . assertEqual ( self . cache . has_key ( " goodbye1 " ) , False )
2006-08-27 21:59:47 +08:00
2007-07-15 14:24:54 +08:00
def test_in ( self ) :
2009-03-11 21:27:03 +08:00
# The in operator can be used to inspet cache contents
2008-10-11 05:41:12 +08:00
self . cache . set ( " hello2 " , " goodbye2 " )
self . assertEqual ( " hello2 " in self . cache , True )
self . assertEqual ( " goodbye2 " in self . cache , False )
2007-05-08 12:13:46 +08:00
2009-03-11 21:27:03 +08:00
def test_incr ( self ) :
# Cache values can be incremented
self . cache . set ( ' answer ' , 41 )
self . assertEqual ( self . cache . incr ( ' answer ' ) , 42 )
self . assertEqual ( self . cache . get ( ' answer ' ) , 42 )
self . assertEqual ( self . cache . incr ( ' answer ' , 10 ) , 52 )
self . assertEqual ( self . cache . get ( ' answer ' ) , 52 )
self . assertRaises ( ValueError , self . cache . incr , ' does_not_exist ' )
def test_decr ( self ) :
# Cache values can be decremented
self . cache . set ( ' answer ' , 43 )
self . assertEqual ( self . cache . decr ( ' answer ' ) , 42 )
self . assertEqual ( self . cache . get ( ' answer ' ) , 42 )
self . assertEqual ( self . cache . decr ( ' answer ' , 10 ) , 32 )
self . assertEqual ( self . cache . get ( ' answer ' ) , 32 )
self . assertRaises ( ValueError , self . cache . decr , ' does_not_exist ' )
2006-08-27 21:59:47 +08:00
def test_data_types ( self ) :
2009-03-11 21:27:03 +08:00
# Many different data types can be cached
2006-08-27 21:59:47 +08:00
stuff = {
' string ' : ' this is a string ' ,
' int ' : 42 ,
' list ' : [ 1 , 2 , 3 , 4 ] ,
' tuple ' : ( 1 , 2 , 3 , 4 ) ,
' dict ' : { ' A ' : 1 , ' B ' : 2 } ,
' function ' : f ,
' class ' : C ,
}
2008-10-11 05:41:12 +08:00
self . cache . set ( " stuff " , stuff )
self . assertEqual ( self . cache . get ( " stuff " ) , stuff )
2007-07-15 14:24:54 +08:00
2009-10-29 22:32:01 +08:00
def test_cache_read_for_model_instance ( self ) :
# Don't want fields with callable as default to be called on cache read
expensive_calculation . num_runs = 0
Poll . objects . all ( ) . delete ( )
my_poll = Poll . objects . create ( question = " Well? " )
self . assertEqual ( Poll . objects . count ( ) , 1 )
pub_date = my_poll . pub_date
self . cache . set ( ' question ' , my_poll )
cached_poll = self . cache . get ( ' question ' )
self . assertEqual ( cached_poll . pub_date , pub_date )
# We only want the default expensive calculation run once
self . assertEqual ( expensive_calculation . num_runs , 1 )
def test_cache_write_for_model_instance_with_deferred ( self ) :
# Don't want fields with callable as default to be called on cache write
expensive_calculation . num_runs = 0
Poll . objects . all ( ) . delete ( )
my_poll = Poll . objects . create ( question = " What? " )
self . assertEqual ( expensive_calculation . num_runs , 1 )
defer_qs = Poll . objects . all ( ) . defer ( ' question ' )
self . assertEqual ( defer_qs . count ( ) , 1 )
self . assertEqual ( expensive_calculation . num_runs , 1 )
self . cache . set ( ' deferred_queryset ' , defer_qs )
# cache set should not re-evaluate default functions
self . assertEqual ( expensive_calculation . num_runs , 1 )
def test_cache_read_for_model_instance_with_deferred ( self ) :
# Don't want fields with callable as default to be called on cache read
expensive_calculation . num_runs = 0
Poll . objects . all ( ) . delete ( )
my_poll = Poll . objects . create ( question = " What? " )
self . assertEqual ( expensive_calculation . num_runs , 1 )
defer_qs = Poll . objects . all ( ) . defer ( ' question ' )
self . assertEqual ( defer_qs . count ( ) , 1 )
self . cache . set ( ' deferred_queryset ' , defer_qs )
self . assertEqual ( expensive_calculation . num_runs , 1 )
runs_before_cache_read = expensive_calculation . num_runs
cached_polls = self . cache . get ( ' deferred_queryset ' )
# We only want the default expensive calculation run on creation and set
self . assertEqual ( expensive_calculation . num_runs , runs_before_cache_read )
2006-08-27 21:59:47 +08:00
def test_expiration ( self ) :
2009-03-11 21:27:03 +08:00
# Cache values can be set to expire
2008-10-11 05:41:12 +08:00
self . cache . set ( ' expire1 ' , ' very quickly ' , 1 )
self . cache . set ( ' expire2 ' , ' very quickly ' , 1 )
self . cache . set ( ' expire3 ' , ' very quickly ' , 1 )
2007-12-05 02:03:56 +08:00
2008-08-02 13:56:57 +08:00
time . sleep ( 2 )
2008-10-11 05:41:12 +08:00
self . assertEqual ( self . cache . get ( " expire1 " ) , None )
2008-08-02 13:56:57 +08:00
2008-10-11 05:41:12 +08:00
self . cache . add ( " expire2 " , " newvalue " )
self . assertEqual ( self . cache . get ( " expire2 " ) , " newvalue " )
self . assertEqual ( self . cache . has_key ( " expire3 " ) , False )
2006-08-27 21:59:47 +08:00
2007-07-16 17:36:10 +08:00
def test_unicode ( self ) :
2009-03-11 21:27:03 +08:00
# Unicode values can be cached
2007-07-16 17:36:10 +08:00
stuff = {
u ' ascii ' : u ' ascii_value ' ,
u ' unicode_ascii ' : u ' Iñtërnâtiônàlizætiøn1 ' ,
u ' Iñtërnâtiônàlizætiøn ' : u ' Iñtërnâtiônàlizætiøn2 ' ,
u ' ascii ' : { u ' x ' : 1 }
}
for ( key , value ) in stuff . items ( ) :
2008-10-11 05:41:12 +08:00
self . cache . set ( key , value )
self . assertEqual ( self . cache . get ( key ) , value )
2007-07-16 17:36:10 +08:00
2010-03-02 04:11:24 +08:00
def test_binary_string ( self ) :
# Binary strings should be cachable
from zlib import compress , decompress
value = ' value_to_be_compressed '
compressed_value = compress ( value )
self . cache . set ( ' binary1 ' , compressed_value )
compressed_result = self . cache . get ( ' binary1 ' )
self . assertEqual ( compressed_value , compressed_result )
self . assertEqual ( value , decompress ( compressed_result ) )
2010-01-27 16:21:35 +08:00
def test_set_many ( self ) :
# Multiple keys can be set using set_many
self . cache . set_many ( { " key1 " : " spam " , " key2 " : " eggs " } )
self . assertEqual ( self . cache . get ( " key1 " ) , " spam " )
self . assertEqual ( self . cache . get ( " key2 " ) , " eggs " )
def test_set_many_expiration ( self ) :
# set_many takes a second ``timeout`` parameter
self . cache . set_many ( { " key1 " : " spam " , " key2 " : " eggs " } , 1 )
time . sleep ( 2 )
self . assertEqual ( self . cache . get ( " key1 " ) , None )
self . assertEqual ( self . cache . get ( " key2 " ) , None )
def test_delete_many ( self ) :
# Multiple keys can be deleted using delete_many
self . cache . set ( " key1 " , " spam " )
self . cache . set ( " key2 " , " eggs " )
self . cache . set ( " key3 " , " ham " )
self . cache . delete_many ( [ " key1 " , " key2 " ] )
self . assertEqual ( self . cache . get ( " key1 " ) , None )
self . assertEqual ( self . cache . get ( " key2 " ) , None )
self . assertEqual ( self . cache . get ( " key3 " ) , " ham " )
def test_clear ( self ) :
# The cache can be emptied using clear
self . cache . set ( " key1 " , " spam " )
self . cache . set ( " key2 " , " eggs " )
self . cache . clear ( )
self . assertEqual ( self . cache . get ( " key1 " ) , None )
self . assertEqual ( self . cache . get ( " key2 " ) , None )
2010-02-11 20:06:26 +08:00
def test_long_timeout ( self ) :
'''
Using a timeout greater than 30 days makes memcached think
it is an absolute expiration timestamp instead of a relative
offset . Test that we honour this convention . Refs #12399.
'''
self . cache . set ( ' key1 ' , ' eggs ' , 60 * 60 * 24 * 30 + 1 ) #30 days + 1 second
self . assertEqual ( self . cache . get ( ' key1 ' ) , ' eggs ' )
self . cache . add ( ' key2 ' , ' ham ' , 60 * 60 * 24 * 30 + 1 )
self . assertEqual ( self . cache . get ( ' key2 ' ) , ' ham ' )
self . cache . set_many ( { ' key3 ' : ' sausage ' , ' key4 ' : ' lobster bisque ' } , 60 * 60 * 24 * 30 + 1 )
self . assertEqual ( self . cache . get ( ' key3 ' ) , ' sausage ' )
self . assertEqual ( self . cache . get ( ' key4 ' ) , ' lobster bisque ' )
2010-08-31 08:44:46 +08:00
def perform_cull_test ( self , initial_count , final_count ) :
""" This is implemented as a utility method, because only some of the backends
implement culling . The culling algorithm also varies slightly , so the final
number of entries will vary between backends """
# Create initial cache key entries. This will overflow the cache, causing a cull
for i in range ( 1 , initial_count ) :
self . cache . set ( ' cull %d ' % i , ' value ' , 1000 )
count = 0
# Count how many keys are left in the cache.
for i in range ( 1 , initial_count ) :
if self . cache . has_key ( ' cull %d ' % i ) :
count = count + 1
self . assertEqual ( count , final_count )
2010-09-13 02:45:26 +08:00
def test_invalid_keys ( self ) :
"""
All the builtin backends ( except memcached , see below ) should warn on
keys that would be refused by memcached . This encourages portable
caching code without making it too difficult to use production backends
with more liberal key rules . Refs #6447.
"""
2010-11-19 23:39:35 +08:00
# mimic custom ``make_key`` method being defined since the default will
# never show the below warnings
def func ( key , * args ) :
return key
old_func = self . cache . key_func
self . cache . key_func = func
2010-09-13 02:45:26 +08:00
# On Python 2.6+ we could use the catch_warnings context
# manager to test this warning nicely. Since we can't do that
# yet, the cleanest option is to temporarily ask for
# CacheKeyWarning to be raised as an exception.
2010-11-11 23:06:20 +08:00
_warnings_state = get_warnings_state ( )
2010-09-13 02:45:26 +08:00
warnings . simplefilter ( " error " , CacheKeyWarning )
2010-11-11 23:06:20 +08:00
try :
# memcached does not allow whitespace or control characters in keys
self . assertRaises ( CacheKeyWarning , self . cache . set , ' key with spaces ' , ' value ' )
# memcached limits key length to 250
self . assertRaises ( CacheKeyWarning , self . cache . set , ' a ' * 251 , ' value ' )
finally :
restore_warnings_state ( _warnings_state )
2010-11-19 23:39:35 +08:00
self . cache . key_func = old_func
def test_cache_versioning_get_set ( self ) :
# set, using default version = 1
self . cache . set ( ' answer1 ' , 42 )
self . assertEqual ( self . cache . get ( ' answer1 ' ) , 42 )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 1 ) , 42 )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 2 ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer1 ' ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer1 ' , version = 1 ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer1 ' , version = 2 ) , None )
# set, default version = 1, but manually override version = 2
self . cache . set ( ' answer2 ' , 42 , version = 2 )
self . assertEqual ( self . cache . get ( ' answer2 ' ) , None )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 2 ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 1 ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 2 ) , 42 )
# v2 set, using default version = 2
self . v2_cache . set ( ' answer3 ' , 42 )
self . assertEqual ( self . cache . get ( ' answer3 ' ) , None )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 2 ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer3 ' ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer3 ' , version = 1 ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer3 ' , version = 2 ) , 42 )
# v2 set, default version = 2, but manually override version = 1
self . v2_cache . set ( ' answer4 ' , 42 , version = 1 )
self . assertEqual ( self . cache . get ( ' answer4 ' ) , 42 )
self . assertEqual ( self . cache . get ( ' answer4 ' , version = 1 ) , 42 )
self . assertEqual ( self . cache . get ( ' answer4 ' , version = 2 ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer4 ' ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer4 ' , version = 1 ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer4 ' , version = 2 ) , None )
def test_cache_versioning_add ( self ) :
# add, default version = 1, but manually override version = 2
self . cache . add ( ' answer1 ' , 42 , version = 2 )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 2 ) , 42 )
self . cache . add ( ' answer1 ' , 37 , version = 2 )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 2 ) , 42 )
self . cache . add ( ' answer1 ' , 37 , version = 1 )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 2 ) , 42 )
# v2 add, using default version = 2
self . v2_cache . add ( ' answer2 ' , 42 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 2 ) , 42 )
self . v2_cache . add ( ' answer2 ' , 37 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 2 ) , 42 )
self . v2_cache . add ( ' answer2 ' , 37 , version = 1 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 2 ) , 42 )
# v2 add, default version = 2, but manually override version = 1
self . v2_cache . add ( ' answer3 ' , 42 , version = 1 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 1 ) , 42 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 2 ) , None )
self . v2_cache . add ( ' answer3 ' , 37 , version = 1 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 1 ) , 42 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 2 ) , None )
self . v2_cache . add ( ' answer3 ' , 37 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 1 ) , 42 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 2 ) , 37 )
def test_cache_versioning_has_key ( self ) :
self . cache . set ( ' answer1 ' , 42 )
# has_key
self . assertTrue ( self . cache . has_key ( ' answer1 ' ) )
self . assertTrue ( self . cache . has_key ( ' answer1 ' , version = 1 ) )
self . assertFalse ( self . cache . has_key ( ' answer1 ' , version = 2 ) )
self . assertFalse ( self . v2_cache . has_key ( ' answer1 ' ) )
self . assertTrue ( self . v2_cache . has_key ( ' answer1 ' , version = 1 ) )
self . assertFalse ( self . v2_cache . has_key ( ' answer1 ' , version = 2 ) )
def test_cache_versioning_delete ( self ) :
self . cache . set ( ' answer1 ' , 37 , version = 1 )
self . cache . set ( ' answer1 ' , 42 , version = 2 )
self . cache . delete ( ' answer1 ' )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 2 ) , 42 )
self . cache . set ( ' answer2 ' , 37 , version = 1 )
self . cache . set ( ' answer2 ' , 42 , version = 2 )
self . cache . delete ( ' answer2 ' , version = 2 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 2 ) , None )
self . cache . set ( ' answer3 ' , 37 , version = 1 )
self . cache . set ( ' answer3 ' , 42 , version = 2 )
self . v2_cache . delete ( ' answer3 ' )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 2 ) , None )
self . cache . set ( ' answer4 ' , 37 , version = 1 )
self . cache . set ( ' answer4 ' , 42 , version = 2 )
self . v2_cache . delete ( ' answer4 ' , version = 1 )
self . assertEqual ( self . cache . get ( ' answer4 ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer4 ' , version = 2 ) , 42 )
def test_cache_versioning_incr_decr ( self ) :
self . cache . set ( ' answer1 ' , 37 , version = 1 )
self . cache . set ( ' answer1 ' , 42 , version = 2 )
self . cache . incr ( ' answer1 ' )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 1 ) , 38 )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 2 ) , 42 )
self . cache . decr ( ' answer1 ' )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer1 ' , version = 2 ) , 42 )
self . cache . set ( ' answer2 ' , 37 , version = 1 )
self . cache . set ( ' answer2 ' , 42 , version = 2 )
self . cache . incr ( ' answer2 ' , version = 2 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 2 ) , 43 )
self . cache . decr ( ' answer2 ' , version = 2 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer2 ' , version = 2 ) , 42 )
self . cache . set ( ' answer3 ' , 37 , version = 1 )
self . cache . set ( ' answer3 ' , 42 , version = 2 )
self . v2_cache . incr ( ' answer3 ' )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 2 ) , 43 )
self . v2_cache . decr ( ' answer3 ' )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer3 ' , version = 2 ) , 42 )
self . cache . set ( ' answer4 ' , 37 , version = 1 )
self . cache . set ( ' answer4 ' , 42 , version = 2 )
self . v2_cache . incr ( ' answer4 ' , version = 1 )
self . assertEqual ( self . cache . get ( ' answer4 ' , version = 1 ) , 38 )
self . assertEqual ( self . cache . get ( ' answer4 ' , version = 2 ) , 42 )
self . v2_cache . decr ( ' answer4 ' , version = 1 )
self . assertEqual ( self . cache . get ( ' answer4 ' , version = 1 ) , 37 )
self . assertEqual ( self . cache . get ( ' answer4 ' , version = 2 ) , 42 )
def test_cache_versioning_get_set_many ( self ) :
# set, using default version = 1
self . cache . set_many ( { ' ford1 ' : 37 , ' arthur1 ' : 42 } )
self . assertEqual ( self . cache . get_many ( [ ' ford1 ' , ' arthur1 ' ] ) ,
{ ' ford1 ' : 37 , ' arthur1 ' : 42 } )
self . assertEqual ( self . cache . get_many ( [ ' ford1 ' , ' arthur1 ' ] , version = 1 ) ,
{ ' ford1 ' : 37 , ' arthur1 ' : 42 } )
self . assertEqual ( self . cache . get_many ( [ ' ford1 ' , ' arthur1 ' ] , version = 2 ) , { } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford1 ' , ' arthur1 ' ] ) , { } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford1 ' , ' arthur1 ' ] , version = 1 ) ,
{ ' ford1 ' : 37 , ' arthur1 ' : 42 } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford1 ' , ' arthur1 ' ] , version = 2 ) , { } )
# set, default version = 1, but manually override version = 2
self . cache . set_many ( { ' ford2 ' : 37 , ' arthur2 ' : 42 } , version = 2 )
self . assertEqual ( self . cache . get_many ( [ ' ford2 ' , ' arthur2 ' ] ) , { } )
self . assertEqual ( self . cache . get_many ( [ ' ford2 ' , ' arthur2 ' ] , version = 1 ) , { } )
self . assertEqual ( self . cache . get_many ( [ ' ford2 ' , ' arthur2 ' ] , version = 2 ) ,
{ ' ford2 ' : 37 , ' arthur2 ' : 42 } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford2 ' , ' arthur2 ' ] ) ,
{ ' ford2 ' : 37 , ' arthur2 ' : 42 } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford2 ' , ' arthur2 ' ] , version = 1 ) , { } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford2 ' , ' arthur2 ' ] , version = 2 ) ,
{ ' ford2 ' : 37 , ' arthur2 ' : 42 } )
# v2 set, using default version = 2
self . v2_cache . set_many ( { ' ford3 ' : 37 , ' arthur3 ' : 42 } )
self . assertEqual ( self . cache . get_many ( [ ' ford3 ' , ' arthur3 ' ] ) , { } )
self . assertEqual ( self . cache . get_many ( [ ' ford3 ' , ' arthur3 ' ] , version = 1 ) , { } )
self . assertEqual ( self . cache . get_many ( [ ' ford3 ' , ' arthur3 ' ] , version = 2 ) ,
{ ' ford3 ' : 37 , ' arthur3 ' : 42 } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford3 ' , ' arthur3 ' ] ) ,
{ ' ford3 ' : 37 , ' arthur3 ' : 42 } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford3 ' , ' arthur3 ' ] , version = 1 ) , { } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford3 ' , ' arthur3 ' ] , version = 2 ) ,
{ ' ford3 ' : 37 , ' arthur3 ' : 42 } )
# v2 set, default version = 2, but manually override version = 1
self . v2_cache . set_many ( { ' ford4 ' : 37 , ' arthur4 ' : 42 } , version = 1 )
self . assertEqual ( self . cache . get_many ( [ ' ford4 ' , ' arthur4 ' ] ) ,
{ ' ford4 ' : 37 , ' arthur4 ' : 42 } )
self . assertEqual ( self . cache . get_many ( [ ' ford4 ' , ' arthur4 ' ] , version = 1 ) ,
{ ' ford4 ' : 37 , ' arthur4 ' : 42 } )
self . assertEqual ( self . cache . get_many ( [ ' ford4 ' , ' arthur4 ' ] , version = 2 ) , { } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford4 ' , ' arthur4 ' ] ) , { } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford4 ' , ' arthur4 ' ] , version = 1 ) ,
{ ' ford4 ' : 37 , ' arthur4 ' : 42 } )
self . assertEqual ( self . v2_cache . get_many ( [ ' ford4 ' , ' arthur4 ' ] , version = 2 ) , { } )
def test_incr_version ( self ) :
self . cache . set ( ' answer ' , 42 , version = 2 )
self . assertEqual ( self . cache . get ( ' answer ' ) , None )
self . assertEqual ( self . cache . get ( ' answer ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer ' , version = 2 ) , 42 )
self . assertEqual ( self . cache . get ( ' answer ' , version = 3 ) , None )
self . assertEqual ( self . cache . incr_version ( ' answer ' , version = 2 ) , 3 )
self . assertEqual ( self . cache . get ( ' answer ' ) , None )
self . assertEqual ( self . cache . get ( ' answer ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer ' , version = 2 ) , None )
self . assertEqual ( self . cache . get ( ' answer ' , version = 3 ) , 42 )
self . v2_cache . set ( ' answer2 ' , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 1 ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 2 ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 3 ) , None )
self . assertEqual ( self . v2_cache . incr_version ( ' answer2 ' ) , 3 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 1 ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 2 ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 3 ) , 42 )
self . assertRaises ( ValueError , self . cache . incr_version , ' does_not_exist ' )
def test_decr_version ( self ) :
self . cache . set ( ' answer ' , 42 , version = 2 )
self . assertEqual ( self . cache . get ( ' answer ' ) , None )
self . assertEqual ( self . cache . get ( ' answer ' , version = 1 ) , None )
self . assertEqual ( self . cache . get ( ' answer ' , version = 2 ) , 42 )
self . assertEqual ( self . cache . decr_version ( ' answer ' , version = 2 ) , 1 )
self . assertEqual ( self . cache . get ( ' answer ' ) , 42 )
self . assertEqual ( self . cache . get ( ' answer ' , version = 1 ) , 42 )
self . assertEqual ( self . cache . get ( ' answer ' , version = 2 ) , None )
self . v2_cache . set ( ' answer2 ' , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 1 ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 2 ) , 42 )
self . assertEqual ( self . v2_cache . decr_version ( ' answer2 ' ) , 1 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' ) , None )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 1 ) , 42 )
self . assertEqual ( self . v2_cache . get ( ' answer2 ' , version = 2 ) , None )
self . assertRaises ( ValueError , self . cache . decr_version , ' does_not_exist ' , version = 2 )
def test_custom_key_func ( self ) :
# Two caches with different key functions aren't visible to each other
self . cache . set ( ' answer1 ' , 42 )
self . assertEqual ( self . cache . get ( ' answer1 ' ) , 42 )
self . assertEqual ( self . custom_key_cache . get ( ' answer1 ' ) , None )
self . assertEqual ( self . custom_key_cache2 . get ( ' answer1 ' ) , None )
self . custom_key_cache . set ( ' answer2 ' , 42 )
self . assertEqual ( self . cache . get ( ' answer2 ' ) , None )
self . assertEqual ( self . custom_key_cache . get ( ' answer2 ' ) , 42 )
self . assertEqual ( self . custom_key_cache2 . get ( ' answer2 ' ) , 42 )
def custom_key_func ( key , key_prefix , version ) :
" A customized cache key function "
return ' CUSTOM- ' + ' - ' . join ( [ key_prefix , str ( version ) , key ] )
2010-09-13 02:45:26 +08:00
2009-03-11 21:27:03 +08:00
class DBCacheTests ( unittest . TestCase , BaseCacheTests ) :
def setUp ( self ) :
2010-02-11 20:21:46 +08:00
# Spaces are used in the table name to ensure quoting/escaping is working
self . _table_name = ' test cache table '
management . call_command ( ' createcachetable ' , self . _table_name , verbosity = 0 , interactive = False )
2010-12-21 23:19:19 +08:00
self . cache = get_cache ( ' django.core.cache.backends.db.DatabaseCache ' , LOCATION = self . _table_name , OPTIONS = { ' MAX_ENTRIES ' : 30 } )
self . prefix_cache = get_cache ( ' django.core.cache.backends.db.DatabaseCache ' , LOCATION = self . _table_name , KEY_PREFIX = ' cacheprefix ' )
self . v2_cache = get_cache ( ' django.core.cache.backends.db.DatabaseCache ' , LOCATION = self . _table_name , VERSION = 2 )
self . custom_key_cache = get_cache ( ' django.core.cache.backends.db.DatabaseCache ' , LOCATION = self . _table_name , KEY_FUNCTION = custom_key_func )
self . custom_key_cache2 = get_cache ( ' django.core.cache.backends.db.DatabaseCache ' , LOCATION = self . _table_name , KEY_FUNCTION = ' regressiontests.cache.tests.custom_key_func ' )
2009-03-11 21:27:03 +08:00
def tearDown ( self ) :
from django . db import connection
cursor = connection . cursor ( )
2010-02-11 20:21:46 +08:00
cursor . execute ( ' DROP TABLE %s ' % connection . ops . quote_name ( self . _table_name ) )
2009-03-11 21:27:03 +08:00
2010-08-31 08:44:46 +08:00
def test_cull ( self ) :
self . perform_cull_test ( 50 , 29 )
2010-11-02 13:55:08 +08:00
def test_zero_cull ( self ) :
2010-12-21 23:19:19 +08:00
self . cache = get_cache ( ' django.core.cache.backends.db.DatabaseCache ' , LOCATION = self . _table_name , OPTIONS = { ' MAX_ENTRIES ' : 30 , ' CULL_FREQUENCY ' : 0 } )
self . perform_cull_test ( 50 , 18 )
def test_old_initialization ( self ) :
2010-11-02 13:55:08 +08:00
self . cache = get_cache ( ' db:// %s ?max_entries=30&cull_frequency=0 ' % self . _table_name )
self . perform_cull_test ( 50 , 18 )
2009-03-11 21:27:03 +08:00
class LocMemCacheTests ( unittest . TestCase , BaseCacheTests ) :
def setUp ( self ) :
2010-12-21 23:19:19 +08:00
self . cache = get_cache ( ' django.core.cache.backends.locmem.LocMemCache ' , OPTIONS = { ' MAX_ENTRIES ' : 30 } )
self . prefix_cache = get_cache ( ' django.core.cache.backends.locmem.LocMemCache ' , KEY_PREFIX = ' cacheprefix ' )
self . v2_cache = get_cache ( ' django.core.cache.backends.locmem.LocMemCache ' , VERSION = 2 )
self . custom_key_cache = get_cache ( ' django.core.cache.backends.locmem.LocMemCache ' , OPTIONS = { ' MAX_ENTRIES ' : 30 } , KEY_FUNCTION = custom_key_func )
self . custom_key_cache2 = get_cache ( ' django.core.cache.backends.locmem.LocMemCache ' , OPTIONS = { ' MAX_ENTRIES ' : 30 } , KEY_FUNCTION = ' regressiontests.cache.tests.custom_key_func ' )
2010-11-19 23:39:35 +08:00
# LocMem requires a hack to make the other caches
# share a data store with the 'normal' cache.
self . prefix_cache . _cache = self . cache . _cache
self . prefix_cache . _expire_info = self . cache . _expire_info
self . v2_cache . _cache = self . cache . _cache
self . v2_cache . _expire_info = self . cache . _expire_info
self . custom_key_cache . _cache = self . cache . _cache
self . custom_key_cache . _expire_info = self . cache . _expire_info
self . custom_key_cache2 . _cache = self . cache . _cache
self . custom_key_cache2 . _expire_info = self . cache . _expire_info
2010-08-31 08:44:46 +08:00
2010-12-21 23:19:19 +08:00
def tearDown ( self ) :
self . cache . clear ( )
2010-08-31 08:44:46 +08:00
def test_cull ( self ) :
self . perform_cull_test ( 50 , 29 )
2009-03-11 21:27:03 +08:00
2010-11-02 13:55:08 +08:00
def test_zero_cull ( self ) :
2010-12-21 23:19:19 +08:00
self . cache = get_cache ( ' django.core.cache.backends.locmem.LocMemCache ' , OPTIONS = { ' MAX_ENTRIES ' : 30 , ' CULL_FREQUENCY ' : 0 } )
self . perform_cull_test ( 50 , 19 )
def test_old_initialization ( self ) :
2010-11-02 13:55:08 +08:00
self . cache = get_cache ( ' locmem://?max_entries=30&cull_frequency=0 ' )
self . perform_cull_test ( 50 , 19 )
2009-03-11 21:27:03 +08:00
# memcached backend isn't guaranteed to be available.
# To check the memcached backend, the test settings file will
2010-12-21 23:19:19 +08:00
# need to contain a cache backend setting that points at
2009-03-11 21:27:03 +08:00
# your memcache server.
2010-11-02 13:55:08 +08:00
class MemcachedCacheTests ( unittest . TestCase , BaseCacheTests ) :
def setUp ( self ) :
2010-12-21 23:19:19 +08:00
name = settings . CACHES [ DEFAULT_CACHE_ALIAS ] [ ' LOCATION ' ]
self . cache = get_cache ( ' django.core.cache.backends.memcached.MemcachedCache ' , LOCATION = name )
self . prefix_cache = get_cache ( ' django.core.cache.backends.memcached.MemcachedCache ' , LOCATION = name , KEY_PREFIX = ' cacheprefix ' )
self . v2_cache = get_cache ( ' django.core.cache.backends.memcached.MemcachedCache ' , LOCATION = name , VERSION = 2 )
self . custom_key_cache = get_cache ( ' django.core.cache.backends.memcached.MemcachedCache ' , LOCATION = name , KEY_FUNCTION = custom_key_func )
self . custom_key_cache2 = get_cache ( ' django.core.cache.backends.memcached.MemcachedCache ' , LOCATION = name , KEY_FUNCTION = ' regressiontests.cache.tests.custom_key_func ' )
2010-11-19 23:39:35 +08:00
def tearDown ( self ) :
self . cache . clear ( )
2010-11-02 13:55:08 +08:00
def test_invalid_keys ( self ) :
"""
On memcached , we don ' t introduce a duplicate key validation
step ( for speed reasons ) , we just let the memcached API
library raise its own exception on bad keys . Refs #6447.
In order to be memcached - API - library agnostic , we only assert
that a generic exception of some kind is raised .
2010-09-13 02:45:26 +08:00
2010-11-02 13:55:08 +08:00
"""
# memcached does not allow whitespace or control characters in keys
self . assertRaises ( Exception , self . cache . set , ' key with spaces ' , ' value ' )
# memcached limits key length to 250
self . assertRaises ( Exception , self . cache . set , ' a ' * 251 , ' value ' )
2010-11-19 23:39:35 +08:00
2010-12-21 23:19:19 +08:00
MemcachedCacheTests = unittest . skipUnless ( settings . CACHES [ DEFAULT_CACHE_ALIAS ] [ ' BACKEND ' ] . startswith ( ' django.core.cache.backends.memcached. ' ) , " memcached not available " ) ( MemcachedCacheTests )
2010-09-13 02:45:26 +08:00
2009-03-11 21:27:03 +08:00
class FileBasedCacheTests ( unittest . TestCase , BaseCacheTests ) :
2007-12-05 02:03:56 +08:00
"""
Specific test cases for the file - based cache .
"""
def setUp ( self ) :
2008-10-11 05:41:12 +08:00
self . dirname = tempfile . mkdtemp ( )
2010-12-21 23:19:19 +08:00
self . cache = get_cache ( ' django.core.cache.backends.filebased.FileBasedCache ' , LOCATION = self . dirname , OPTIONS = { ' MAX_ENTRIES ' : 30 } )
self . prefix_cache = get_cache ( ' django.core.cache.backends.filebased.FileBasedCache ' , LOCATION = self . dirname , KEY_PREFIX = ' cacheprefix ' )
self . v2_cache = get_cache ( ' django.core.cache.backends.filebased.FileBasedCache ' , LOCATION = self . dirname , VERSION = 2 )
self . custom_key_cache = get_cache ( ' django.core.cache.backends.filebased.FileBasedCache ' , LOCATION = self . dirname , KEY_FUNCTION = custom_key_func )
self . custom_key_cache2 = get_cache ( ' django.core.cache.backends.filebased.FileBasedCache ' , LOCATION = self . dirname , KEY_FUNCTION = ' regressiontests.cache.tests.custom_key_func ' )
2010-11-19 23:39:35 +08:00
def tearDown ( self ) :
self . cache . clear ( )
2008-08-02 13:56:57 +08:00
2007-12-05 02:03:56 +08:00
def test_hashing ( self ) :
""" Test that keys are hashed into subdirectories correctly """
self . cache . set ( " foo " , " bar " )
2010-11-19 23:39:35 +08:00
key = self . cache . make_key ( " foo " )
keyhash = md5_constructor ( key ) . hexdigest ( )
2007-12-05 02:03:56 +08:00
keypath = os . path . join ( self . dirname , keyhash [ : 2 ] , keyhash [ 2 : 4 ] , keyhash [ 4 : ] )
self . assert_ ( os . path . exists ( keypath ) )
2008-08-02 13:56:57 +08:00
2007-12-05 02:03:56 +08:00
def test_subdirectory_removal ( self ) :
"""
Make sure that the created subdirectories are correctly removed when empty .
"""
self . cache . set ( " foo " , " bar " )
2010-11-19 23:39:35 +08:00
key = self . cache . make_key ( " foo " )
keyhash = md5_constructor ( key ) . hexdigest ( )
2007-12-05 02:03:56 +08:00
keypath = os . path . join ( self . dirname , keyhash [ : 2 ] , keyhash [ 2 : 4 ] , keyhash [ 4 : ] )
self . assert_ ( os . path . exists ( keypath ) )
self . cache . delete ( " foo " )
self . assert_ ( not os . path . exists ( keypath ) )
self . assert_ ( not os . path . exists ( os . path . dirname ( keypath ) ) )
self . assert_ ( not os . path . exists ( os . path . dirname ( os . path . dirname ( keypath ) ) ) )
2007-11-19 11:12:19 +08:00
2010-08-31 08:44:46 +08:00
def test_cull ( self ) :
2010-11-19 23:39:35 +08:00
self . perform_cull_test ( 50 , 29 )
2010-08-31 08:44:46 +08:00
2010-12-21 23:19:19 +08:00
def test_old_initialization ( self ) :
self . cache = get_cache ( ' file:// %s ?max_entries=30 ' % self . dirname )
self . perform_cull_test ( 50 , 29 )
2010-09-13 02:45:26 +08:00
class CustomCacheKeyValidationTests ( unittest . TestCase ) :
"""
Tests for the ability to mixin a custom ` ` validate_key ` ` method to
a custom cache backend that otherwise inherits from a builtin
backend , and override the default key validation . Refs #6447.
"""
def test_custom_key_validation ( self ) :
cache = get_cache ( ' regressiontests.cache.liberal_backend:// ' )
# this key is both longer than 250 characters, and has spaces
key = ' some key with spaces ' * 15
val = ' a value '
cache . set ( key , val )
self . assertEqual ( cache . get ( key ) , val )
2007-11-19 11:12:19 +08:00
class CacheUtils ( unittest . TestCase ) :
""" TestCase for django.utils.cache functions. """
2008-08-02 13:56:57 +08:00
2009-04-02 02:19:32 +08:00
def setUp ( self ) :
self . path = ' /cache/test/ '
2010-11-19 23:39:35 +08:00
self . old_cache_middleware_key_prefix = settings . CACHE_MIDDLEWARE_KEY_PREFIX
self . old_cache_middleware_seconds = settings . CACHE_MIDDLEWARE_SECONDS
2010-02-24 04:45:28 +08:00
self . orig_use_i18n = settings . USE_I18N
2009-04-02 02:19:32 +08:00
settings . CACHE_MIDDLEWARE_KEY_PREFIX = ' settingsprefix '
settings . CACHE_MIDDLEWARE_SECONDS = 1
2010-02-24 04:45:28 +08:00
settings . USE_I18N = False
2009-04-02 02:19:32 +08:00
def tearDown ( self ) :
2010-11-19 23:39:35 +08:00
settings . CACHE_MIDDLEWARE_KEY_PREFIX = self . old_cache_middleware_key_prefix
settings . CACHE_MIDDLEWARE_SECONDS = self . old_cache_middleware_seconds
2010-02-24 04:45:28 +08:00
settings . USE_I18N = self . orig_use_i18n
2009-04-02 02:19:32 +08:00
2010-10-29 09:31:15 +08:00
def _get_request ( self , path , method = ' GET ' ) :
2009-04-02 02:19:32 +08:00
request = HttpRequest ( )
request . META = {
' SERVER_NAME ' : ' testserver ' ,
' SERVER_PORT ' : 80 ,
}
2010-10-29 09:31:15 +08:00
request . method = method
2009-04-02 02:19:32 +08:00
request . path = request . path_info = " /cache/ %s " % path
return request
2007-11-19 11:12:19 +08:00
def test_patch_vary_headers ( self ) :
2008-08-02 13:56:57 +08:00
headers = (
2007-11-19 11:12:19 +08:00
# Initial vary, new headers, resulting vary.
( None , ( ' Accept-Encoding ' , ) , ' Accept-Encoding ' ) ,
( ' Accept-Encoding ' , ( ' accept-encoding ' , ) , ' Accept-Encoding ' ) ,
( ' Accept-Encoding ' , ( ' ACCEPT-ENCODING ' , ) , ' Accept-Encoding ' ) ,
( ' Cookie ' , ( ' Accept-Encoding ' , ) , ' Cookie, Accept-Encoding ' ) ,
( ' Cookie, Accept-Encoding ' , ( ' Accept-Encoding ' , ) , ' Cookie, Accept-Encoding ' ) ,
( ' Cookie, Accept-Encoding ' , ( ' Accept-Encoding ' , ' cookie ' ) , ' Cookie, Accept-Encoding ' ) ,
( None , ( ' Accept-Encoding ' , ' COOKIE ' ) , ' Accept-Encoding, COOKIE ' ) ,
( ' Cookie, Accept-Encoding ' , ( ' Accept-Encoding ' , ' cookie ' ) , ' Cookie, Accept-Encoding ' ) ,
( ' Cookie , Accept-Encoding ' , ( ' Accept-Encoding ' , ' cookie ' ) , ' Cookie, Accept-Encoding ' ) ,
)
for initial_vary , newheaders , resulting_vary in headers :
response = HttpResponse ( )
if initial_vary is not None :
response [ ' Vary ' ] = initial_vary
patch_vary_headers ( response , newheaders )
self . assertEqual ( response [ ' Vary ' ] , resulting_vary )
2009-04-02 02:19:32 +08:00
def test_get_cache_key ( self ) :
request = self . _get_request ( self . path )
response = HttpResponse ( )
key_prefix = ' localprefix '
# Expect None if no headers have been set yet.
self . assertEqual ( get_cache_key ( request ) , None )
# Set headers to an empty list.
learn_cache_key ( request , response )
2010-10-29 09:31:15 +08:00
self . assertEqual ( get_cache_key ( request ) , ' views.decorators.cache.cache_page.settingsprefix.GET.a8c87a3d8c44853d7f79474f7ffe4ad5.d41d8cd98f00b204e9800998ecf8427e ' )
2009-04-02 02:19:32 +08:00
# Verify that a specified key_prefix is taken in to account.
learn_cache_key ( request , response , key_prefix = key_prefix )
2010-10-29 09:31:15 +08:00
self . assertEqual ( get_cache_key ( request , key_prefix = key_prefix ) , ' views.decorators.cache.cache_page.localprefix.GET.a8c87a3d8c44853d7f79474f7ffe4ad5.d41d8cd98f00b204e9800998ecf8427e ' )
2009-04-02 02:19:32 +08:00
def test_learn_cache_key ( self ) :
2010-10-29 09:31:15 +08:00
request = self . _get_request ( self . path , ' HEAD ' )
2009-04-02 02:19:32 +08:00
response = HttpResponse ( )
response [ ' Vary ' ] = ' Pony '
# Make sure that the Vary header is added to the key hash
learn_cache_key ( request , response )
2010-10-29 09:31:15 +08:00
self . assertEqual ( get_cache_key ( request ) , ' views.decorators.cache.cache_page.settingsprefix.HEAD.a8c87a3d8c44853d7f79474f7ffe4ad5.d41d8cd98f00b204e9800998ecf8427e ' )
2010-11-19 23:39:35 +08:00
class PrefixedCacheUtils ( CacheUtils ) :
def setUp ( self ) :
super ( PrefixedCacheUtils , self ) . setUp ( )
2010-12-21 23:19:19 +08:00
self . old_cache_key_prefix = settings . CACHES [ ' default ' ] . get ( ' KEY_PREFIX ' , None )
settings . CACHES [ ' default ' ] [ ' KEY_PREFIX ' ] = ' cacheprefix '
2010-11-19 23:39:35 +08:00
def tearDown ( self ) :
super ( PrefixedCacheUtils , self ) . tearDown ( )
2010-12-21 23:19:19 +08:00
if self . old_cache_key_prefix is None :
del settings . CACHES [ ' default ' ] [ ' KEY_PREFIX ' ]
else :
settings . CACHES [ ' default ' ] [ ' KEY_PREFIX ' ] = self . old_cache_key_prefix
2010-11-19 23:39:35 +08:00
2010-10-29 09:31:15 +08:00
class CacheHEADTest ( unittest . TestCase ) :
def setUp ( self ) :
self . orig_cache_middleware_seconds = settings . CACHE_MIDDLEWARE_SECONDS
self . orig_cache_middleware_key_prefix = settings . CACHE_MIDDLEWARE_KEY_PREFIX
2010-12-21 23:19:19 +08:00
self . orig_caches = settings . CACHES
2010-10-29 09:31:15 +08:00
settings . CACHE_MIDDLEWARE_SECONDS = 60
settings . CACHE_MIDDLEWARE_KEY_PREFIX = ' test '
2010-12-21 23:19:19 +08:00
settings . CACHES = {
' default ' : {
' BACKEND ' : ' django.core.cache.backends.locmem.LocMemCache '
}
}
2010-10-29 09:31:15 +08:00
self . path = ' /cache/test/ '
def tearDown ( self ) :
settings . CACHE_MIDDLEWARE_SECONDS = self . orig_cache_middleware_seconds
settings . CACHE_MIDDLEWARE_KEY_PREFIX = self . orig_cache_middleware_key_prefix
2010-12-21 23:19:19 +08:00
settings . CACHES = self . orig_caches
2010-10-29 09:31:15 +08:00
def _get_request ( self , method ) :
request = HttpRequest ( )
request . META = {
' SERVER_NAME ' : ' testserver ' ,
' SERVER_PORT ' : 80 ,
}
request . method = method
request . path = request . path_info = self . path
return request
def _get_request_cache ( self , method ) :
request = self . _get_request ( method )
request . _cache_update_cache = True
return request
def _set_cache ( self , request , msg ) :
response = HttpResponse ( )
response . content = msg
return UpdateCacheMiddleware ( ) . process_response ( request , response )
def test_head_caches_correctly ( self ) :
test_content = ' test content '
request = self . _get_request_cache ( ' HEAD ' )
self . _set_cache ( request , test_content )
request = self . _get_request ( ' HEAD ' )
get_cache_data = FetchFromCacheMiddleware ( ) . process_request ( request )
self . assertNotEqual ( get_cache_data , None )
self . assertEqual ( test_content , get_cache_data . content )
def test_head_with_cached_get ( self ) :
test_content = ' test content '
request = self . _get_request_cache ( ' GET ' )
self . _set_cache ( request , test_content )
request = self . _get_request ( ' HEAD ' )
get_cache_data = FetchFromCacheMiddleware ( ) . process_request ( request )
self . assertNotEqual ( get_cache_data , None )
self . assertEqual ( test_content , get_cache_data . content )
2007-11-19 11:12:19 +08:00
2010-02-24 04:45:28 +08:00
class CacheI18nTest ( unittest . TestCase ) :
def setUp ( self ) :
self . orig_cache_middleware_seconds = settings . CACHE_MIDDLEWARE_SECONDS
self . orig_cache_middleware_key_prefix = settings . CACHE_MIDDLEWARE_KEY_PREFIX
2010-12-21 23:19:19 +08:00
self . orig_caches = settings . CACHES
2010-02-24 04:45:28 +08:00
self . orig_use_i18n = settings . USE_I18N
self . orig_languages = settings . LANGUAGES
settings . LANGUAGES = (
( ' en ' , ' English ' ) ,
( ' es ' , ' Spanish ' ) ,
)
settings . CACHE_MIDDLEWARE_KEY_PREFIX = ' settingsprefix '
self . path = ' /cache/test/ '
def tearDown ( self ) :
settings . CACHE_MIDDLEWARE_SECONDS = self . orig_cache_middleware_seconds
settings . CACHE_MIDDLEWARE_KEY_PREFIX = self . orig_cache_middleware_key_prefix
2010-12-21 23:19:19 +08:00
settings . CACHES = self . orig_caches
2010-02-24 04:45:28 +08:00
settings . USE_I18N = self . orig_use_i18n
settings . LANGUAGES = self . orig_languages
translation . deactivate ( )
def _get_request ( self ) :
request = HttpRequest ( )
request . META = {
' SERVER_NAME ' : ' testserver ' ,
' SERVER_PORT ' : 80 ,
}
request . path = request . path_info = self . path
return request
def _get_request_cache ( self ) :
request = HttpRequest ( )
request . META = {
' SERVER_NAME ' : ' testserver ' ,
' SERVER_PORT ' : 80 ,
}
request . path = request . path_info = self . path
request . _cache_update_cache = True
request . method = ' GET '
request . session = { }
return request
def test_cache_key_i18n ( self ) :
settings . USE_I18N = True
request = self . _get_request ( )
lang = translation . get_language ( )
response = HttpResponse ( )
key = learn_cache_key ( request , response )
self . assertTrue ( key . endswith ( lang ) , " Cache keys should include the language name when i18n is active " )
key2 = get_cache_key ( request )
self . assertEqual ( key , key2 )
def test_cache_key_no_i18n ( self ) :
settings . USE_I18N = False
request = self . _get_request ( )
lang = translation . get_language ( )
response = HttpResponse ( )
key = learn_cache_key ( request , response )
self . assertFalse ( key . endswith ( lang ) , " Cache keys shouldn ' t include the language name when i18n is inactive " )
def test_middleware ( self ) :
def set_cache ( request , lang , msg ) :
translation . activate ( lang )
response = HttpResponse ( )
response . content = msg
return UpdateCacheMiddleware ( ) . process_response ( request , response )
settings . CACHE_MIDDLEWARE_SECONDS = 60
2010-12-21 23:19:19 +08:00
settings . CACHE_MIDDLEWARE_KEY_PREFIX = " test "
settings . CACHES = {
' default ' : {
' BACKEND ' : ' django.core.cache.backends.locmem.LocMemCache '
}
}
2010-12-13 06:57:17 +08:00
settings . USE_ETAGS = True
2010-02-24 04:45:28 +08:00
settings . USE_I18N = True
en_message = " Hello world! "
es_message = " Hola mundo! "
request = self . _get_request_cache ( )
set_cache ( request , ' en ' , en_message )
get_cache_data = FetchFromCacheMiddleware ( ) . process_request ( request )
# Check that we can recover the cache
self . assertNotEqual ( get_cache_data . content , None )
self . assertEqual ( en_message , get_cache_data . content )
2010-12-13 06:57:17 +08:00
# Check that we use etags
self . assertTrue ( get_cache_data . has_header ( ' ETag ' ) )
# Check that we can disable etags
settings . USE_ETAGS = False
request . _cache_update_cache = True
set_cache ( request , ' en ' , en_message )
get_cache_data = FetchFromCacheMiddleware ( ) . process_request ( request )
self . assertFalse ( get_cache_data . has_header ( ' ETag ' ) )
2010-02-24 04:45:28 +08:00
# change the session language and set content
request = self . _get_request_cache ( )
set_cache ( request , ' es ' , es_message )
# change again the language
translation . activate ( ' en ' )
# retrieve the content from cache
get_cache_data = FetchFromCacheMiddleware ( ) . process_request ( request )
self . assertEqual ( get_cache_data . content , en_message )
# change again the language
translation . activate ( ' es ' )
get_cache_data = FetchFromCacheMiddleware ( ) . process_request ( request )
self . assertEqual ( get_cache_data . content , es_message )
2010-11-19 23:39:35 +08:00
class PrefixedCacheI18nTest ( CacheI18nTest ) :
def setUp ( self ) :
super ( PrefixedCacheI18nTest , self ) . setUp ( )
2010-12-21 23:19:19 +08:00
self . old_cache_key_prefix = settings . CACHES [ ' default ' ] . get ( ' KEY_PREFIX ' , None )
settings . CACHES [ ' default ' ] [ ' KEY_PREFIX ' ] = ' cacheprefix '
2010-11-19 23:39:35 +08:00
def tearDown ( self ) :
super ( PrefixedCacheI18nTest , self ) . tearDown ( )
2010-12-21 23:19:19 +08:00
if self . old_cache_key_prefix is not None :
del settings . CACHES [ ' default ' ] [ ' KEY_PREFIX ' ]
else :
settings . CACHES [ ' default ' ] [ ' KEY_PREFIX ' ] = self . old_cache_key_prefix
2010-11-19 23:39:35 +08:00
2006-08-27 21:59:47 +08:00
if __name__ == ' __main__ ' :
2007-07-16 17:36:10 +08:00
unittest . main ( )