1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
|
"""
Useful testing utilities.
This module is considered public API.
"""
import time
import socket
from pymemcache.exceptions import MemcacheClientError, MemcacheIllegalInputError
from pymemcache.serde import LegacyWrappingSerde
from pymemcache.client.base import check_key_helper
class MockMemcacheClient:
"""
A (partial) in-memory mock for Clients.
"""
def __init__(
self,
server=None,
serde=None,
serializer=None,
deserializer=None,
connect_timeout=None,
timeout=None,
no_delay=False,
ignore_exc=False,
socket_module=None,
default_noreply=True,
allow_unicode_keys=False,
encoding="ascii",
tls_context=None,
):
self._contents = {}
self.serde = serde or LegacyWrappingSerde(serializer, deserializer)
self.allow_unicode_keys = allow_unicode_keys
# Unused, but present for interface compatibility
self.server = server
self.connect_timeout = connect_timeout
self.timeout = timeout
self.no_delay = no_delay
self.ignore_exc = ignore_exc
self.socket_module = socket
self.sock = None
self.encoding = encoding
self.tls_context = tls_context
def check_key(self, key):
"""Checks key and add key_prefix."""
return check_key_helper(key, allow_unicode_keys=self.allow_unicode_keys)
def clear(self):
"""Method used to clear/reset mock cache"""
self._contents.clear()
def get(self, key, default=None):
key = self.check_key(key)
if key not in self._contents:
return default
expire, value, flags = self._contents[key]
if expire and expire < time.time():
del self._contents[key]
return default
return self.serde.deserialize(key, value, flags)
def get_many(self, keys):
out = {}
for key in keys:
value = self.get(key)
if value is not None:
out[key] = value
return out
get_multi = get_many
def set(self, key, value, expire=0, noreply=True, flags=None):
key = self.check_key(key)
if isinstance(value, str) and not isinstance(value, bytes):
try:
value = value.encode(self.encoding)
except (UnicodeEncodeError, UnicodeDecodeError):
raise MemcacheIllegalInputError
value, flags = self.serde.serialize(key, value)
if expire:
expire += time.time()
self._contents[key] = expire, value, flags
return True
def set_many(self, values, expire=0, noreply=True, flags=None):
result = []
for key, value in values.items():
ret = self.set(key, value, expire, noreply, flags=flags)
if not ret:
result.append(key)
return [] if noreply else result
set_multi = set_many
def incr(self, key, value, noreply=False):
current = self.get(key)
present = current is not None
if present:
self.set(key, current + value, noreply=noreply)
return None if noreply or not present else current + value
def decr(self, key, value, noreply=False):
current = self.get(key)
present = current is not None
if present:
self.set(key, current - value, noreply=noreply)
return None if noreply or not present else current - value
def add(self, key, value, expire=0, noreply=True, flags=None):
current = self.get(key)
present = current is not None
if not present:
self.set(key, value, expire, noreply, flags=flags)
return noreply or not present
def delete(self, key, noreply=True):
key = self.check_key(key)
current = self._contents.pop(key, None)
present = current is not None
return noreply or present
def delete_many(self, keys, noreply=True):
for key in keys:
self.delete(key, noreply)
return True
def prepend(self, key, value, expire=0, noreply=True, flags=None):
current = self.get(key)
if current is not None:
if isinstance(value, str) and not isinstance(value, bytes):
try:
value = value.encode(self.encoding)
except (UnicodeEncodeError, UnicodeDecodeError):
raise MemcacheIllegalInputError
self.set(key, value + current, expire, noreply, flags=flags)
return True
def append(self, key, value, expire=0, noreply=True, flags=None):
current = self.get(key)
if current is not None:
if isinstance(value, str) and not isinstance(value, bytes):
try:
value = value.encode(self.encoding)
except (UnicodeEncodeError, UnicodeDecodeError):
raise MemcacheIllegalInputError
self.set(key, current + value, expire, noreply, flags=flags)
return True
delete_multi = delete_many
def stats(self, *_args):
# I make no claim that these values make any sense, but the format
# of the output is the same as for pymemcache.client.Client.stats()
return {
"version": "MockMemcacheClient",
"rusage_user": 1.0,
"rusage_system": 1.0,
"hash_is_expanding": False,
"slab_reassign_running": False,
"inter": "in-memory",
"evictions": False,
"growth_factor": 1.0,
"stat_key_prefix": "",
"umask": 0o644,
"detail_enabled": False,
"cas_enabled": False,
"auth_enabled_sasl": False,
"maxconns_fast": False,
"slab_reassign": False,
"slab_automove": False,
}
def replace(self, key, value, expire=0, noreply=True, flags=None):
current = self.get(key)
present = current is not None
if present:
self.set(key, value, expire, noreply, flags=flags)
return noreply or present
def cas(self, key, value, cas, expire=0, noreply=False, flags=None):
raise MemcacheClientError("CAS is not enabled for this instance")
def touch(self, key, expire=0, noreply=True):
current = self.get(key)
present = current is not None
if present:
self.set(key, current, expire, noreply=noreply)
return True if noreply or present else False
def cache_memlimit(self, memlimit):
return True
def version(self):
return "MockMemcacheClient"
def flush_all(self, delay=0, noreply=True):
self.clear()
return noreply or self._contents == {}
def quit(self):
pass
def close(self):
pass
|