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
|
#!/usr/bin/env python3
# Copyright (c) Facebook, Inc. and its affiliates.
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
from collections import OrderedDict
from unittest.mock import patch, Mock, call
from fbtftp.netascii import NetasciiReader
import socket
import time
import unittest
from fbtftp.base_handler import BaseHandler, StringResponseData
from fbtftp import constants
class MockSocketListener:
def __init__(self, network_queue, peer):
self._network_queue = network_queue
self._peer = peer
def recvfrom(self, blocksize):
return self._network_queue.pop(0), self._peer
class MockHandler(BaseHandler):
def __init__(
self, server_addr, peer, path, options, stats_callback, network_queue=()
):
self.response = StringResponseData("foo")
super().__init__(server_addr, peer, path, options, stats_callback)
self.network_queue = network_queue
self.peer = peer
self._listener = MockSocketListener(network_queue, peer)
self._listener.sendto = Mock()
self._listener.close = Mock()
self._listener.settimeout = Mock()
def get_response_data(self):
""" returns a mock ResponseData object"""
self._response_data = Mock()
self._response_data.read = self.response.read
self._response_data.size = self.response.size
return self._response_data
class testSessionHandler(unittest.TestCase):
def setUp(self):
self.options = OrderedDict(
[
("default_timeout", 10),
("retries", 2),
("mode", "netascii"),
("blksize", 1492),
("tsize", 0),
("timeout", 99),
]
)
self.server_addr = ("127.0.0.1", 1234)
self.peer = ("127.0.0.1", 5678)
self.handler = MockHandler(
server_addr=self.server_addr,
peer=self.peer,
path="want/bacon/file",
options=self.options,
stats_callback=self.stats_callback,
)
def stats_callback(self):
pass
def init(self, universe=4):
if universe == 4:
server_addr = ("127.0.0.1", 1234)
peer = ("127.0.0.1", 5678)
else:
server_addr = ("::1", 1234)
peer = ("::1", 5678)
handler = BaseHandler(
server_addr=server_addr,
peer=peer,
path="want/bacon/file",
options=self.options,
stats_callback=self.stats_callback,
)
self.assertEqual(handler._timeout, 10)
self.assertEqual(handler._server_addr, server_addr)
# make sure expire_ts is in the future
self.assertGreater(handler._expire_ts, time.time())
self.assertEqual(handler._retries, 2)
self.assertEqual(handler._block_size, constants.DEFAULT_BLKSIZE)
self.assertEqual(handler._last_block_sent, 0)
self.assertEqual(handler._retransmits, 0)
self.assertEqual(handler._current_block, None)
self.assertEqual(handler._should_stop, False)
self.assertEqual(handler._path, "want/bacon/file")
self.assertEqual(handler._options, self.options)
self.assertEqual(handler._stats_callback, self.stats_callback)
self.assertEqual(handler._peer, peer)
self.assertIsInstance(handler._get_listener(), socket.socket)
if universe == 6:
self.assertEqual(handler._get_listener().family, socket.AF_INET6)
else:
self.assertEqual(handler._get_listener().family, socket.AF_INET)
def testInitV6(self):
self.init(universe=6)
def testInitV4(self):
self.init(universe=4)
def testResponseDataException(self):
server_addr = ("127.0.0.1", 1234)
peer = ("127.0.0.1", 5678)
with patch.object(MockHandler, "get_response_data") as mock:
mock.side_effect = Exception("boom!")
handler = MockHandler(
server_addr=server_addr,
peer=peer,
path="want/bacon/file",
options=self.options,
stats_callback=self.stats_callback,
)
self.assertEqual(
handler._stats.error, {"error_message": "boom!", "error_code": 0}
)
def testParseOptionsNetascii(self):
self.handler._response_data = StringResponseData("foo\nbar\n")
self.handler._parse_options()
self.assertEqual(
self.handler._stats.options_in,
{"mode": "netascii", "blksize": 1492, "tsize": 0, "timeout": 99},
)
self.assertIsInstance(self.handler._response_data, NetasciiReader)
self.assertEqual(self.handler._stats.blksize, 1492)
# options acked by the server don't include the mode
expected_opts_to_ack = self.options
del expected_opts_to_ack["mode"]
# tsize include the number of bytes in the response
expected_opts_to_ack["tsize"] = str(self.handler._response_data.size())
self.assertEqual(self.handler._stats.options, expected_opts_to_ack)
self.assertEqual(self.handler._stats.options_acked, expected_opts_to_ack)
self.assertEqual(self.handler._tsize, int(expected_opts_to_ack["tsize"]))
def testParseOptionsBadMode(self):
options = {
"default_timeout": 10,
"retries": 2,
"mode": "IamBadAndIShoudlFeelBad",
"blksize": 1492,
"tsize": 0,
"timeout": 99,
}
self.handler = MockHandler(
server_addr=self.server_addr,
peer=self.peer,
path="want/bacon/file",
options=options,
stats_callback=Mock(),
)
self.handler._close = Mock()
self.handler._parse_options()
self.handler._close.assert_called_with()
self.assertEqual(
self.handler._stats.error["error_code"], constants.ERR_ILLEGAL_OPERATION
)
self.assertTrue(
self.handler._stats.error["error_message"].startswith("Unknown mode:")
)
self.handler._get_listener().sendto.assert_called_with(
# \x00\x05 == OPCODE_ERROR
# \x00\x04 == ERR_ILLEGAL_OPERATION
b"\x00\x05\x00\x04Unknown mode: 'IamBadAndIShoudlFeelBad'\x00",
("127.0.0.1", 5678),
)
def testClose(self):
options = {
"default_timeout": 10,
"retries": 2,
"mode": "IamBadAndIShoudlFeelBad",
"blksize": 1492,
"tsize": 0,
"timeout": 99,
}
self.handler = MockHandler(
server_addr=self.server_addr,
peer=self.peer,
path="want/bacon/file",
options=options,
stats_callback=Mock(),
)
self.handler._retransmits = 100
self.handler._close(True)
self.assertEqual(self.handler._retransmits, 100)
self.handler._stats_callback.assert_called_with(self.handler._stats)
self.handler._get_listener().close.assert_called_with()
self.handler._response_data.close.assert_called_with()
self.handler._on_close = Mock()
self.handler._on_close.side_effect = Exception("boom!")
self.handler._close(True)
def testRun(self):
# mock methods
self.handler._close = Mock()
self.handler._transmit_error = Mock()
self.handler._parse_options = Mock()
self.handler._transmit_oack = Mock()
self.handler._transmit_data = Mock()
self.handler._next_block = Mock()
self.handler._stats.error = {"error_message": "boom!", "error_code": 0}
self.handler.run()
self.handler._close.assert_called_with()
self.handler._transmit_error.assert_called_with()
self.handler._stats.error = {}
self.handler._should_stop = True
self.handler.run()
self.handler._parse_options.assert_called_with()
self.handler._transmit_oack.assert_called_with()
self.handler._options = {}
self.handler.run()
self.handler._next_block.assert_called_with()
self.handler._transmit_data.assert_called_with()
def testRunOne(self):
self.handler.on_new_data = Mock()
self.handler._handle_timeout = Mock()
self.handler._expire_ts = time.time() + 1000
self.handler.run_once()
self.handler.on_new_data.assert_called_with()
self.handler._expire_ts = time.time() - 1000
self.handler.run_once()
self.handler.on_new_data.assert_called_with()
self.handler._handle_timeout.assert_called_with()
def testOnNewDataHandleAck(self):
self.handler = MockHandler(
server_addr=self.server_addr,
peer=self.peer,
path="want/bacon/file",
options=self.options,
stats_callback=self.stats_callback,
# client acknolwedges DATA block 1, we expect to send DATA block 2
network_queue=[b"\x00\x04\x00\x01"],
)
self.handler._last_block_sent = 1
self.handler.on_new_data()
self.handler._get_listener().settimeout.assert_has_calls(
[call(self.handler._timeout), call(None)]
)
# data response sohuld look like this:
#
# 2 bytes 2 bytes n bytes
# ---------------------------------------
# | Opcode = 3 | Block # | Data |
# ---------------------------------------
self.handler._get_listener().sendto.assert_called_with(
# client acknolwedges DATA block 1, we expect to send DATA block 2
b"\x00\x03\x00\x02foo",
("127.0.0.1", 5678),
)
def testOnNewDataTimeout(self):
self.handler._get_listener().recvfrom = Mock(side_effect=socket.timeout())
self.handler.on_new_data()
self.assertFalse(self.handler._should_stop)
self.assertEqual(self.handler._stats.error, {})
def testOnNewDataDifferentPeer(self):
self.handler._get_listener().recvfrom = Mock(
return_value=(b"data", ("1.2.3.4", "9999"))
)
self.handler.on_new_data()
self.assertTrue(self.handler._should_stop)
def testOnNewDataOpCodeError(self):
error = b"\x00\x05\x00\x04some_error\x00"
self.handler._get_listener().recvfrom = Mock(return_value=(error, self.peer))
self.handler.on_new_data()
self.assertTrue(self.handler._should_stop)
self.handler._get_listener().sendto.assert_called_with(error, self.peer)
def testOnNewDataNoAck(self):
self.handler._get_listener().recvfrom = Mock(
return_value=(b"\x00\x02\x00\x04", self.peer)
)
self.handler.on_new_data()
self.assertTrue(self.handler._should_stop)
self.assertEqual(
self.handler._stats.error,
{
"error_code": constants.ERR_ILLEGAL_OPERATION,
"error_message": "I only do reads, really",
},
)
def testHandleUnexpectedAck(self):
self.handler._last_block_sent = 1
self.handler._reset_timeout = Mock()
self.handler._next_block = Mock()
self.handler._handle_ack(2)
self.handler._reset_timeout.assert_not_called()
def testHandleTimeout(self):
self.handler._retries = 3
self.handler._retransmits = 2
self.handler._transmit_data = Mock()
self.handler._handle_timeout()
self.assertEqual(self.handler._retransmits, 3)
self.handler._transmit_data.assert_called_with()
self.assertEqual(self.handler._stats.error, {})
self.handler._retries = 1
self.handler._retransmits = 2
self.handler._handle_timeout()
self.assertEqual(
self.handler._stats.error,
{
"error_code": constants.ERR_UNDEFINED,
"error_message": "timeout after 2 retransmits.",
},
)
self.assertTrue(self.handler._should_stop)
def testNextBlock(self):
class MockResponse:
def __init__(self, dataiter):
self._dataiter = dataiter
def read(self, size=0):
try:
return next(self._dataiter)
except StopIteration:
return None
# single-packet file
self.handler._last_block_sent = 0
self.handler._block_size = 1400
self.handler._response_data = StringResponseData("bacon")
self.handler._next_block()
self.assertEqual(self.handler._current_block, b"bacon")
self.assertEqual(self.handler._last_block_sent, 1)
# multi-packet file
self.handler._last_block_sent = 0
self.handler._block_size = 1400
self.handler._response_data = StringResponseData("bacon" * 281)
self.handler._next_block()
self.assertEqual(self.handler._current_block, b"bacon" * 280)
self.assertEqual(self.handler._last_block_sent, 1)
self.handler._next_block()
self.assertEqual(self.handler._current_block, b"bacon")
self.assertEqual(self.handler._last_block_sent, 2)
# partial read
data = MockResponse(iter("bacon"))
self.handler._last_block_sent = 0
self.handler._block_size = 1400
self.handler._response_data.read = data.read
self.handler._next_block()
self.assertEqual(self.handler._current_block, "bacon")
self.assertEqual(self.handler._last_block_sent, 1)
self.handler._last_block_sent = constants.MAX_BLOCK_NUMBER + 1
self.handler._next_block()
self.assertEqual(self.handler._last_block_sent, 0)
self.handler._response_data.read = Mock(side_effect=Exception("boom!"))
self.handler._next_block()
self.assertEqual(
self.handler._stats.error,
{
"error_code": constants.ERR_UNDEFINED,
"error_message": "Error while reading from source",
},
)
self.assertTrue(self.handler._should_stop)
def testTransmitData(self):
# we have tested sending data so here we should just test the edge case
# where there is no more data to send
self.handler._current_block = b""
self.handler._transmit_data()
self.handler._handle_ack(0)
self.assertTrue(self.handler._should_stop)
def testTransmitOACK(self):
self.handler._options = {"opt1": "value1"}
self.handler._get_listener().sendto = Mock()
self.handler._stats.packets_sent = 1
self.handler._transmit_oack()
self.assertEqual(self.handler._stats.packets_sent, 2)
self.handler._get_listener().sendto.assert_called_with(
# OACK code == 6
b"\x00\x06opt1\x00value1\x00",
("127.0.0.1", 5678),
)
|
