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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
|
from pymemcache.client.hash import HashClient
from pymemcache.client.base import Client, PooledClient
from pymemcache.exceptions import MemcacheError, MemcacheUnknownError
from pymemcache import pool
from .test_client import ClientTestMixin, MockSocket
import unittest
import os
import pytest
from unittest import mock
import socket
class TestHashClient(ClientTestMixin, unittest.TestCase):
def make_client_pool(self, hostname, mock_socket_values, serializer=None, **kwargs):
mock_client = Client(hostname, serializer=serializer, **kwargs)
mock_client.sock = MockSocket(mock_socket_values)
client = PooledClient(hostname, serializer=serializer)
client.client_pool = pool.ObjectPool(lambda: mock_client)
return mock_client
def make_client(self, *mock_socket_values, **kwargs):
current_port = 11012
client = HashClient([], **kwargs)
ip = "127.0.0.1"
for vals in mock_socket_values:
s = f"{ip}:{current_port}"
c = self.make_client_pool((ip, current_port), vals, **kwargs)
client.clients[s] = c
client.hasher.add_node(s)
current_port += 1
return client
def make_unix_client(self, sockets, *mock_socket_values, **kwargs):
client = HashClient([], **kwargs)
for socket_, vals in zip(sockets, mock_socket_values):
c = self.make_client_pool(socket_, vals, **kwargs)
client.clients[socket_] = c
client.hasher.add_node(socket_)
return client
def test_setup_client_without_pooling(self):
client_class = "pymemcache.client.hash.HashClient.client_class"
with mock.patch(client_class) as internal_client:
client = HashClient([], timeout=999, key_prefix="foo_bar_baz")
client.add_server(("127.0.0.1", "11211"))
assert internal_client.call_args[0][0] == ("127.0.0.1", "11211")
kwargs = internal_client.call_args[1]
assert kwargs["timeout"] == 999
assert kwargs["key_prefix"] == "foo_bar_baz"
def test_get_many_unix(self):
pid = os.getpid()
sockets = [
"/tmp/pymemcache.1.%d" % pid,
"/tmp/pymemcache.2.%d" % pid,
]
client = self.make_unix_client(
sockets,
*[
[
b"STORED\r\n",
b"VALUE key3 0 6\r\nvalue2\r\nEND\r\n",
],
[
b"STORED\r\n",
b"VALUE key1 0 6\r\nvalue1\r\nEND\r\n",
],
],
)
def get_clients(key):
if key == b"key3":
return client.clients["/tmp/pymemcache.1.%d" % pid]
else:
return client.clients["/tmp/pymemcache.2.%d" % pid]
client._get_client = get_clients
result = client.set(b"key1", b"value1", noreply=False)
result = client.set(b"key3", b"value2", noreply=False)
result = client.get_many([b"key1", b"key3"])
assert result == {b"key1": b"value1", b"key3": b"value2"}
def test_get_many_all_found(self):
client = self.make_client(
*[
[
b"STORED\r\n",
b"VALUE key3 0 6\r\nvalue2\r\nEND\r\n",
],
[
b"STORED\r\n",
b"VALUE key1 0 6\r\nvalue1\r\nEND\r\n",
],
]
)
def get_clients(key):
if key == b"key3":
return client.clients["127.0.0.1:11012"]
else:
return client.clients["127.0.0.1:11013"]
client._get_client = get_clients
result = client.set(b"key1", b"value1", noreply=False)
result = client.set(b"key3", b"value2", noreply=False)
result = client.get_many([b"key1", b"key3"])
assert result == {b"key1": b"value1", b"key3": b"value2"}
def test_get_many_some_found(self):
client = self.make_client(
*[
[
b"END\r\n",
],
[
b"STORED\r\n",
b"VALUE key1 0 6\r\nvalue1\r\nEND\r\n",
],
]
)
def get_clients(key):
if key == b"key3":
return client.clients["127.0.0.1:11012"]
else:
return client.clients["127.0.0.1:11013"]
client._get_client = get_clients
result = client.set(b"key1", b"value1", noreply=False)
result = client.get_many([b"key1", b"key3"])
assert result == {b"key1": b"value1"}
def test_get_many_bad_server_data(self):
client = self.make_client(
*[
[
b"STORED\r\n",
b"VAXLUE key3 0 6\r\nvalue2\r\nEND\r\n",
],
[
b"STORED\r\n",
b"VAXLUE key1 0 6\r\nvalue1\r\nEND\r\n",
],
]
)
def get_clients(key):
if key == b"key3":
return client.clients["127.0.0.1:11012"]
else:
return client.clients["127.0.0.1:11013"]
client._get_client = get_clients
with pytest.raises(MemcacheUnknownError):
client.set(b"key1", b"value1", noreply=False)
client.set(b"key3", b"value2", noreply=False)
client.get_many([b"key1", b"key3"])
def test_get_many_bad_server_data_ignore(self):
client = self.make_client(
*[
[
b"STORED\r\n",
b"VAXLUE key3 0 6\r\nvalue2\r\nEND\r\n",
],
[
b"STORED\r\n",
b"VAXLUE key1 0 6\r\nvalue1\r\nEND\r\n",
],
],
ignore_exc=True,
)
def get_clients(key):
if key == b"key3":
return client.clients["127.0.0.1:11012"]
else:
return client.clients["127.0.0.1:11013"]
client._get_client = get_clients
client.set(b"key1", b"value1", noreply=False)
client.set(b"key3", b"value2", noreply=False)
result = client.get_many([b"key1", b"key3"])
assert result == {}
def test_gets_many(self):
client = self.make_client(
*[
[
b"STORED\r\n",
b"VALUE key3 0 6 1\r\nvalue2\r\nEND\r\n",
],
[
b"STORED\r\n",
b"VALUE key1 0 6 1\r\nvalue1\r\nEND\r\n",
],
]
)
def get_clients(key):
if key == b"key3":
return client.clients["127.0.0.1:11012"]
else:
return client.clients["127.0.0.1:11013"]
client._get_client = get_clients
assert client.set(b"key1", b"value1", noreply=False) is True
assert client.set(b"key3", b"value2", noreply=False) is True
result = client.gets_many([b"key1", b"key3"])
assert result == {b"key1": (b"value1", b"1"), b"key3": (b"value2", b"1")}
def test_touch_not_found(self):
client = self.make_client([b"NOT_FOUND\r\n"])
result = client.touch(b"key", noreply=False)
assert result is False
def test_touch_no_expiry_found(self):
client = self.make_client([b"TOUCHED\r\n"])
result = client.touch(b"key", noreply=False)
assert result is True
def test_touch_with_expiry_found(self):
client = self.make_client([b"TOUCHED\r\n"])
result = client.touch(b"key", 1, noreply=False)
assert result is True
def test_close(self):
client = self.make_client([])
assert all(c.sock is not None for c in client.clients.values())
result = client.close()
assert result is None
assert all(c.sock is None for c in client.clients.values())
def test_quit(self):
client = self.make_client([])
assert all(c.sock is not None for c in client.clients.values())
result = client.quit()
assert result is None
assert all(c.sock is None for c in client.clients.values())
def test_no_servers_left(self):
from pymemcache.client.hash import HashClient
client = HashClient(
[], use_pooling=True, ignore_exc=True, timeout=1, connect_timeout=1
)
hashed_client = client._get_client("foo")
assert hashed_client is None
def test_no_servers_left_raise_exception(self):
from pymemcache.client.hash import HashClient
client = HashClient(
[], use_pooling=True, ignore_exc=False, timeout=1, connect_timeout=1
)
with pytest.raises(MemcacheError) as e:
client._get_client("foo")
assert str(e.value) == "All servers seem to be down right now"
def test_unavailable_servers_zero_retry_raise_exception(self):
from pymemcache.client.hash import HashClient
client = HashClient(
[("example.com", 11211)],
use_pooling=True,
ignore_exc=False,
retry_attempts=0,
timeout=1,
connect_timeout=1,
)
with pytest.raises(socket.error):
client.get("foo")
def test_no_servers_left_with_commands_return_default_value(self):
from pymemcache.client.hash import HashClient
client = HashClient(
[], use_pooling=True, ignore_exc=True, timeout=1, connect_timeout=1
)
result = client.get("foo")
assert result is None
result = client.get("foo", default="default")
assert result == "default"
result = client.set("foo", "bar")
assert result is False
def test_no_servers_left_return_positional_default(self):
from pymemcache.client.hash import HashClient
client = HashClient(
[], use_pooling=True, ignore_exc=True, timeout=1, connect_timeout=1
)
# Ensure compatibility with clients that pass the default as a
# positional argument
result = client.get("foo", "default")
assert result == "default"
def test_no_servers_left_with_set_many(self):
from pymemcache.client.hash import HashClient
client = HashClient(
[], use_pooling=True, ignore_exc=True, timeout=1, connect_timeout=1
)
result = client.set_many({"foo": "bar"})
assert result == ["foo"]
def test_no_servers_left_with_get_many(self):
from pymemcache.client.hash import HashClient
client = HashClient(
[], use_pooling=True, ignore_exc=True, timeout=1, connect_timeout=1
)
result = client.get_many(["foo", "bar"])
assert result == {}
def test_ignore_exec_set_many(self):
values = {"key1": "value1", "key2": "value2", "key3": "value3"}
with pytest.raises(MemcacheUnknownError):
client = self.make_client(
*[
[b"STORED\r\n", b"UNKNOWN\r\n", b"STORED\r\n"],
[b"STORED\r\n", b"UNKNOWN\r\n", b"STORED\r\n"],
]
)
client.set_many(values, noreply=False)
client = self.make_client(
*[
[b"STORED\r\n", b"UNKNOWN\r\n", b"STORED\r\n"],
],
ignore_exc=True,
)
result = client.set_many(values, noreply=False)
assert len(result) == 0
def test_noreply_set_many(self):
values = {"key1": "value1", "key2": "value2", "key3": "value3"}
client = self.make_client(
*[
[b"STORED\r\n", b"NOT_STORED\r\n", b"STORED\r\n"],
]
)
result = client.set_many(values, noreply=False)
assert len(result) == 1
client = self.make_client(
*[
[b"STORED\r\n", b"NOT_STORED\r\n", b"STORED\r\n"],
]
)
result = client.set_many(values, noreply=True)
assert result == []
def test_noreply_flush(self):
client = self.make_client()
client.flush_all(noreply=True)
def test_set_many_unix(self):
values = {"key1": "value1", "key2": "value2", "key3": "value3"}
pid = os.getpid()
sockets = ["/tmp/pymemcache.%d" % pid]
client = self.make_unix_client(
sockets,
*[
[b"STORED\r\n", b"NOT_STORED\r\n", b"STORED\r\n"],
],
)
result = client.set_many(values, noreply=False)
assert len(result) == 1
def test_server_encoding_pooled(self):
"""
test passed encoding from hash client to pooled clients
"""
encoding = "utf8"
from pymemcache.client.hash import HashClient
hash_client = HashClient(
[("example.com", 11211)], use_pooling=True, encoding=encoding
)
for client in hash_client.clients.values():
assert client.encoding == encoding
def test_server_encoding_client(self):
"""
test passed encoding from hash client to clients
"""
encoding = "utf8"
from pymemcache.client.hash import HashClient
hash_client = HashClient([("example.com", 11211)], encoding=encoding)
for client in hash_client.clients.values():
assert client.encoding == encoding
@mock.patch("pymemcache.client.hash.HashClient.client_class")
def test_dead_server_comes_back(self, client_patch):
client = HashClient([], dead_timeout=0, retry_attempts=0)
client.add_server(("127.0.0.1", 11211))
test_client = client_patch.return_value
test_client.server = ("127.0.0.1", 11211)
test_client.get.side_effect = socket.timeout()
with pytest.raises(socket.timeout):
client.get(b"key", noreply=False)
# Client gets removed because of socket timeout
assert ("127.0.0.1", 11211) in client._dead_clients
test_client.get.side_effect = lambda *_, **_kw: "Some value"
# Client should be retried and brought back
assert client.get(b"key") == "Some value"
assert ("127.0.0.1", 11211) not in client._dead_clients
@mock.patch("pymemcache.client.hash.HashClient.client_class")
def test_failed_is_retried(self, client_patch):
client = HashClient([], retry_attempts=1, retry_timeout=0)
client.add_server(("127.0.0.1", 11211))
assert client_patch.call_count == 1
test_client = client_patch.return_value
test_client.server = ("127.0.0.1", 11211)
test_client.get.side_effect = socket.timeout()
with pytest.raises(socket.timeout):
client.get(b"key", noreply=False)
test_client.get.side_effect = lambda *_, **_kw: "Some value"
assert client.get(b"key") == "Some value"
assert client_patch.call_count == 1
def test_custom_client(self):
class MyClient(Client):
pass
client = HashClient([])
client.client_class = MyClient
client.add_server(("host", 11211))
assert isinstance(client.clients["host:11211"], MyClient)
def test_custom_client_with_pooling(self):
class MyClient(Client):
pass
client = HashClient([], use_pooling=True)
client.client_class = MyClient
client.add_server(("host", 11211))
assert isinstance(client.clients["host:11211"], PooledClient)
pool = client.clients["host:11211"].client_pool
with pool.get_and_release(destroy_on_fail=True) as c:
assert isinstance(c, MyClient)
def test_mixed_inet_and_unix_sockets(self):
expected = {
f"/tmp/pymemcache.{os.getpid()}",
("127.0.0.1", 11211),
("::1", 11211),
}
client = HashClient(
[
f"/tmp/pymemcache.{os.getpid()}",
"127.0.0.1",
"127.0.0.1:11211",
"[::1]",
"[::1]:11211",
("127.0.0.1", 11211),
("::1", 11211),
]
)
assert expected == {c.server for c in client.clients.values()}
def test_legacy_add_remove_server_signature(self):
server = ("127.0.0.1", 11211)
client = HashClient([])
assert client.clients == {}
client.add_server(*server) # Unpack (host, port) tuple.
assert ("%s:%s" % server) in client.clients
client._mark_failed_server(server)
assert server in client._failed_clients
client.remove_server(*server) # Unpack (host, port) tuple.
assert server in client._dead_clients
assert server not in client._failed_clients
# Ensure that server is a string if passing port argument:
with pytest.raises(TypeError):
client.add_server(server, server[-1])
with pytest.raises(TypeError):
client.remove_server(server, server[-1])
# TODO: Test failover logic
|
