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
|
from collections import namedtuple, deque
import os
import threading
import time
import uuid
import struct
import sys
import pytest
import mock
from kazoo.exceptions import ConnectionLoss
from kazoo.protocol.serialization import (
Connect,
int_struct,
write_string,
)
from kazoo.protocol.states import KazooState
from kazoo.protocol.connection import _CONNECTION_DROP
from kazoo.testing import KazooTestCase
from kazoo.tests.util import wait
from kazoo.tests.util import TRAVIS_ZK_VERSION
class Delete(namedtuple('Delete', 'path version')):
type = 2
def serialize(self):
b = bytearray()
b.extend(write_string(self.path))
b.extend(int_struct.pack(self.version))
return b
@classmethod
def deserialize(self, bytes, offset):
raise ValueError("oh my")
class TestConnectionHandler(KazooTestCase):
def test_bad_deserialization(self):
async_object = self.client.handler.async_result()
self.client._queue.append(
(Delete(self.client.chroot, -1), async_object)
)
self.client._connection._write_sock.send(b'\0')
with pytest.raises(ValueError):
async_object.get()
def test_with_bad_sessionid(self):
ev = threading.Event()
def expired(state):
if state == KazooState.CONNECTED:
ev.set()
password = os.urandom(16)
client = self._get_client(client_id=(82838284824, password))
client.add_listener(expired)
client.start()
try:
ev.wait(15)
assert ev.is_set()
finally:
client.stop()
def test_connection_read_timeout(self):
client = self.client
ev = threading.Event()
path = "/" + uuid.uuid4().hex
handler = client.handler
_select = handler.select
_socket = client._connection._socket
def delayed_select(*args, **kwargs):
result = _select(*args, **kwargs)
if len(args[0]) == 1 and _socket in args[0]:
# for any socket read, simulate a timeout
return [], [], []
return result
def back(state):
if state == KazooState.CONNECTED:
ev.set()
client.add_listener(back)
client.create(path, b"1")
try:
handler.select = delayed_select
with pytest.raises(ConnectionLoss):
client.get(path)
finally:
handler.select = _select
# the client reconnects automatically
ev.wait(5)
assert ev.is_set()
assert client.get(path)[0] == b"1"
def test_connection_write_timeout(self):
client = self.client
ev = threading.Event()
path = "/" + uuid.uuid4().hex
handler = client.handler
_select = handler.select
_socket = client._connection._socket
def delayed_select(*args, **kwargs):
result = _select(*args, **kwargs)
if _socket in args[1]:
# for any socket write, simulate a timeout
return [], [], []
return result
def back(state):
if state == KazooState.CONNECTED:
ev.set()
client.add_listener(back)
try:
handler.select = delayed_select
with pytest.raises(ConnectionLoss):
client.create(path)
finally:
handler.select = _select
# the client reconnects automatically
ev.wait(5)
assert ev.is_set()
assert client.exists(path) is None
def test_connection_deserialize_fail(self):
client = self.client
ev = threading.Event()
path = "/" + uuid.uuid4().hex
handler = client.handler
_select = handler.select
_socket = client._connection._socket
def delayed_select(*args, **kwargs):
result = _select(*args, **kwargs)
if _socket in args[1]:
# for any socket write, simulate a timeout
return [], [], []
return result
def back(state):
if state == KazooState.CONNECTED:
ev.set()
client.add_listener(back)
deserialize_ev = threading.Event()
def bad_deserialize(_bytes, offset):
deserialize_ev.set()
raise struct.error()
# force the connection to die but, on reconnect, cause the
# server response to be non-deserializable. ensure that the client
# continues to retry. This partially reproduces a rare bug seen
# in production.
with mock.patch.object(Connect, 'deserialize') as mock_deserialize:
mock_deserialize.side_effect = bad_deserialize
try:
handler.select = delayed_select
with pytest.raises(ConnectionLoss):
client.create(path)
finally:
handler.select = _select
# the client reconnects automatically but the first attempt will
# hit a deserialize failure. wait for that.
deserialize_ev.wait(5)
assert deserialize_ev.is_set()
# this time should succeed
ev.wait(5)
assert ev.is_set()
assert client.exists(path) is None
def test_connection_close(self):
with pytest.raises(Exception):
self.client.close()
self.client.stop()
self.client.close()
# should be able to restart
self.client.start()
def test_connection_sock(self):
client = self.client
read_sock = client._connection._read_sock
write_sock = client._connection._write_sock
assert read_sock is not None
assert write_sock is not None
# stop client and socket should not yet be closed
client.stop()
assert read_sock is not None
assert write_sock is not None
read_sock.getsockname()
write_sock.getsockname()
# close client, and sockets should be closed
client.close()
# Todo check socket closing
# start client back up. should get a new, valid socket
client.start()
read_sock = client._connection._read_sock
write_sock = client._connection._write_sock
assert read_sock is not None
assert write_sock is not None
read_sock.getsockname()
write_sock.getsockname()
def test_dirty_sock(self):
client = self.client
read_sock = client._connection._read_sock
write_sock = client._connection._write_sock
# add a stray byte to the socket and ensure that doesn't
# blow up client. simulates case where some error leaves
# a byte in the socket which doesn't correspond to the
# request queue.
write_sock.send(b'\0')
# eventually this byte should disappear from socket
wait(lambda: client.handler.select([read_sock], [], [], 0)[0] == [])
class TestConnectionDrop(KazooTestCase):
def test_connection_dropped(self):
ev = threading.Event()
def back(state):
if state == KazooState.CONNECTED:
ev.set()
# create a node with a large value and stop the ZK node
path = "/" + uuid.uuid4().hex
self.client.create(path)
self.client.add_listener(back)
result = self.client.set_async(path, b'a' * 1000 * 1024)
self.client._call(_CONNECTION_DROP, None)
with pytest.raises(ConnectionLoss):
result.get()
# we have a working connection to a new node
ev.wait(30)
assert ev.is_set()
class TestReadOnlyMode(KazooTestCase):
def setUp(self):
self.setup_zookeeper(read_only=True)
skip = False
if TRAVIS_ZK_VERSION and TRAVIS_ZK_VERSION < (3, 4):
skip = True
elif TRAVIS_ZK_VERSION and TRAVIS_ZK_VERSION >= (3, 4):
skip = False
else:
ver = self.client.server_version()
if ver[1] < 4:
skip = True
if skip:
pytest.skip("Must use Zookeeper 3.4 or above")
def tearDown(self):
self.client.stop()
def test_read_only(self):
from kazoo.exceptions import NotReadOnlyCallError
from kazoo.protocol.states import KeeperState
client = self.client
states = []
ev = threading.Event()
@client.add_listener
def listen(state):
states.append(state)
if client.client_state == KeeperState.CONNECTED_RO:
ev.set()
try:
self.cluster[1].stop()
self.cluster[2].stop()
ev.wait(6)
assert ev.is_set()
assert client.client_state == KeeperState.CONNECTED_RO
# Test read only command
assert client.get_children('/') == []
# Test error with write command
with pytest.raises(NotReadOnlyCallError):
client.create('/fred')
# Wait for a ping
time.sleep(15)
finally:
client.remove_listener(listen)
self.cluster[1].run()
self.cluster[2].run()
class TestUnorderedXids(KazooTestCase):
def setUp(self):
super(TestUnorderedXids, self).setUp()
self.connection = self.client._connection
self.connection_routine = self.connection._connection_routine
self._pending = self.client._pending
self.client._pending = _naughty_deque()
def tearDown(self):
self.client._pending = self._pending
super(TestUnorderedXids, self).tearDown()
def _get_client(self, **kwargs):
# overrides for patching zk_loop
c = KazooTestCase._get_client(self, **kwargs)
self._zk_loop = c._connection.zk_loop
self._zk_loop_errors = []
c._connection.zk_loop = self._zk_loop_func
return c
def _zk_loop_func(self, *args, **kwargs):
# patched zk_loop which will catch and collect all RuntimeError
try:
self._zk_loop(*args, **kwargs)
except RuntimeError as e:
self._zk_loop_errors.append(e)
def test_xids_mismatch(self):
from kazoo.protocol.states import KeeperState
ev = threading.Event()
error_stack = []
@self.client.add_listener
def listen(state):
if self.client.client_state == KeeperState.CLOSED:
ev.set()
def log_exception(*args):
error_stack.append((args, sys.exc_info()))
self.connection.logger.exception = log_exception
ev.clear()
with pytest.raises(RuntimeError):
self.client.get_children('/')
ev.wait()
assert self.client.connected is False
assert self.client.state == 'LOST'
assert self.client.client_state == KeeperState.CLOSED
args, exc_info = error_stack[-1]
assert args == ('Unhandled exception in connection loop',)
assert exc_info[0] == RuntimeError
self.client.handler.sleep_func(0.2)
assert not self.connection_routine.is_alive()
assert len(self._zk_loop_errors) == 1
assert self._zk_loop_errors[0] == exc_info[1]
class _naughty_deque(deque):
def append(self, s):
request, async_object, xid = s
return deque.append(self, (request, async_object, xid + 1)) # +1s
|