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
|
import re
import unittest
from unittest.mock import Mock, sentinel
from mopidy_mpd import network
from tests import any_unicode
class LineProtocolTest(unittest.TestCase):
def setUp(self): # noqa: N802
self.mock = Mock(spec=network.LineProtocol)
self.mock.terminator = network.LineProtocol.terminator
self.mock.encoding = network.LineProtocol.encoding
self.mock.delimiter = network.LineProtocol.delimiter
self.mock.prevent_timeout = False
def prepare_on_receive_test(self, return_value=None):
self.mock.connection = Mock(spec=network.Connection)
self.mock.recv_buffer = b""
self.mock.parse_lines.return_value = return_value or []
def test_init_stores_values_in_attributes(self):
delimiter = re.compile(network.LineProtocol.terminator)
network.LineProtocol.__init__(self.mock, sentinel.connection)
assert sentinel.connection == self.mock.connection
assert b"" == self.mock.recv_buffer
assert delimiter == self.mock.delimiter
assert not self.mock.prevent_timeout
def test_init_compiles_delimiter(self):
self.mock.delimiter = "\r?\n"
delimiter = re.compile("\r?\n")
network.LineProtocol.__init__(self.mock, sentinel.connection)
assert delimiter == self.mock.delimiter
def test_on_receive_close_calls_stop(self):
self.prepare_on_receive_test()
network.LineProtocol.on_receive(self.mock, {"close": True})
self.mock.connection.stop.assert_called_once_with(any_unicode)
def test_on_receive_no_new_lines_adds_to_recv_buffer(self):
self.prepare_on_receive_test()
network.LineProtocol.on_receive(self.mock, {"received": b"data"})
assert b"data" == self.mock.recv_buffer
self.mock.parse_lines.assert_called_once_with()
assert 0 == self.mock.on_line_received.call_count
def test_on_receive_toggles_timeout(self):
self.prepare_on_receive_test()
network.LineProtocol.on_receive(self.mock, {"received": b"data"})
self.mock.connection.disable_timeout.assert_called_once_with()
self.mock.connection.enable_timeout.assert_called_once_with()
def test_on_receive_toggles_unless_prevent_timeout_is_set(self):
self.prepare_on_receive_test()
self.mock.prevent_timeout = True
network.LineProtocol.on_receive(self.mock, {"received": b"data"})
self.mock.connection.disable_timeout.assert_called_once_with()
assert 0 == self.mock.connection.enable_timeout.call_count
def test_on_receive_no_new_lines_calls_parse_lines(self):
self.prepare_on_receive_test()
network.LineProtocol.on_receive(self.mock, {"received": b"data"})
self.mock.parse_lines.assert_called_once_with()
assert 0 == self.mock.on_line_received.call_count
def test_on_receive_with_new_line_calls_decode(self):
self.prepare_on_receive_test([sentinel.line])
network.LineProtocol.on_receive(self.mock, {"received": b"data\n"})
self.mock.parse_lines.assert_called_once_with()
self.mock.decode.assert_called_once_with(sentinel.line)
def test_on_receive_with_new_line_calls_on_recieve(self):
self.prepare_on_receive_test([sentinel.line])
self.mock.decode.return_value = sentinel.decoded
network.LineProtocol.on_receive(self.mock, {"received": b"data\n"})
self.mock.on_line_received.assert_called_once_with(sentinel.decoded)
def test_on_receive_with_new_line_with_failed_decode(self):
self.prepare_on_receive_test([sentinel.line])
self.mock.decode.return_value = None
network.LineProtocol.on_receive(self.mock, {"received": b"data\n"})
assert 0 == self.mock.on_line_received.call_count
def test_on_receive_with_new_lines_calls_on_recieve(self):
self.prepare_on_receive_test(["line1", "line2"])
self.mock.decode.return_value = sentinel.decoded
network.LineProtocol.on_receive(
self.mock, {"received": b"line1\nline2\n"}
)
assert 2 == self.mock.on_line_received.call_count
def test_on_failure_calls_stop(self):
self.mock.connection = Mock(spec=network.Connection)
network.LineProtocol.on_failure(self.mock, None, None, None)
self.mock.connection.stop.assert_called_once_with("Actor failed.")
def prepare_parse_lines_test(self, recv_data=""):
self.mock.terminator = b"\n"
self.mock.delimiter = re.compile(rb"\n")
self.mock.recv_buffer = recv_data.encode()
def test_parse_lines_emtpy_buffer(self):
self.prepare_parse_lines_test()
lines = network.LineProtocol.parse_lines(self.mock)
with self.assertRaises(StopIteration):
next(lines)
def test_parse_lines_no_terminator(self):
self.prepare_parse_lines_test("data")
lines = network.LineProtocol.parse_lines(self.mock)
with self.assertRaises(StopIteration):
next(lines)
def test_parse_lines_terminator(self):
self.prepare_parse_lines_test("data\n")
lines = network.LineProtocol.parse_lines(self.mock)
assert b"data" == next(lines)
with self.assertRaises(StopIteration):
next(lines)
assert b"" == self.mock.recv_buffer
def test_parse_lines_terminator_with_carriage_return(self):
self.prepare_parse_lines_test("data\r\n")
self.mock.delimiter = re.compile(rb"\r?\n")
lines = network.LineProtocol.parse_lines(self.mock)
assert b"data" == next(lines)
with self.assertRaises(StopIteration):
next(lines)
assert b"" == self.mock.recv_buffer
def test_parse_lines_no_data_before_terminator(self):
self.prepare_parse_lines_test("\n")
lines = network.LineProtocol.parse_lines(self.mock)
assert b"" == next(lines)
with self.assertRaises(StopIteration):
next(lines)
assert b"" == self.mock.recv_buffer
def test_parse_lines_extra_data_after_terminator(self):
self.prepare_parse_lines_test("data1\ndata2")
lines = network.LineProtocol.parse_lines(self.mock)
assert b"data1" == next(lines)
with self.assertRaises(StopIteration):
next(lines)
assert b"data2" == self.mock.recv_buffer
def test_parse_lines_non_ascii(self):
self.prepare_parse_lines_test("æøå\n")
lines = network.LineProtocol.parse_lines(self.mock)
assert "æøå".encode() == next(lines)
with self.assertRaises(StopIteration):
next(lines)
assert b"" == self.mock.recv_buffer
def test_parse_lines_multiple_lines(self):
self.prepare_parse_lines_test("abc\ndef\nghi\njkl")
lines = network.LineProtocol.parse_lines(self.mock)
assert b"abc" == next(lines)
assert b"def" == next(lines)
assert b"ghi" == next(lines)
with self.assertRaises(StopIteration):
next(lines)
assert b"jkl" == self.mock.recv_buffer
def test_parse_lines_multiple_calls(self):
self.prepare_parse_lines_test("data1")
lines = network.LineProtocol.parse_lines(self.mock)
with self.assertRaises(StopIteration):
next(lines)
assert b"data1" == self.mock.recv_buffer
self.mock.recv_buffer += b"\ndata2"
lines = network.LineProtocol.parse_lines(self.mock)
assert b"data1" == next(lines)
with self.assertRaises(StopIteration):
next(lines)
assert b"data2" == self.mock.recv_buffer
def test_send_lines_called_with_no_lines(self):
self.mock.connection = Mock(spec=network.Connection)
network.LineProtocol.send_lines(self.mock, [])
assert 0 == self.mock.encode.call_count
assert 0 == self.mock.connection.queue_send.call_count
def test_send_lines_calls_join_lines(self):
self.mock.connection = Mock(spec=network.Connection)
self.mock.join_lines.return_value = "lines"
network.LineProtocol.send_lines(self.mock, ["line 1", "line 2"])
self.mock.join_lines.assert_called_once_with(["line 1", "line 2"])
def test_send_line_encodes_joined_lines_with_final_terminator(self):
self.mock.connection = Mock(spec=network.Connection)
self.mock.join_lines.return_value = "lines\n"
network.LineProtocol.send_lines(self.mock, ["line 1", "line 2"])
self.mock.encode.assert_called_once_with("lines\n")
def test_send_lines_sends_encoded_string(self):
self.mock.connection = Mock(spec=network.Connection)
self.mock.join_lines.return_value = "lines"
self.mock.encode.return_value = sentinel.data
network.LineProtocol.send_lines(self.mock, ["line 1", "line 2"])
self.mock.connection.queue_send.assert_called_once_with(sentinel.data)
def test_join_lines_returns_empty_string_for_no_lines(self):
assert "" == network.LineProtocol.join_lines(self.mock, [])
def test_join_lines_returns_joined_lines(self):
self.mock.decode.return_value = "\n"
assert "1\n2\n" == network.LineProtocol.join_lines(
self.mock, ["1", "2"]
)
def test_decode_calls_decode_on_string(self):
string = Mock()
network.LineProtocol.decode(self.mock, string)
string.decode.assert_called_once_with(self.mock.encoding)
def test_decode_plain_ascii(self):
result = network.LineProtocol.decode(self.mock, b"abc")
assert "abc" == result
assert str == type(result)
def test_decode_utf8(self):
result = network.LineProtocol.decode(self.mock, "æøå".encode())
assert "æøå" == result
assert str == type(result)
def test_decode_invalid_data(self):
string = Mock()
string.decode.side_effect = UnicodeError
network.LineProtocol.decode(self.mock, string)
self.mock.stop.assert_called_once_with()
def test_encode_calls_encode_on_string(self):
string = Mock()
network.LineProtocol.encode(self.mock, string)
string.encode.assert_called_once_with(self.mock.encoding)
def test_encode_plain_ascii(self):
result = network.LineProtocol.encode(self.mock, "abc")
assert b"abc" == result
assert bytes == type(result)
def test_encode_utf8(self):
result = network.LineProtocol.encode(self.mock, "æøå")
assert "æøå".encode() == result
assert bytes == type(result)
def test_encode_invalid_data(self):
string = Mock()
string.encode.side_effect = UnicodeError
network.LineProtocol.encode(self.mock, string)
self.mock.stop.assert_called_once_with()
def test_host_property(self):
mock = Mock(spec=network.Connection)
mock.host = sentinel.host
lineprotocol = network.LineProtocol(mock)
assert sentinel.host == lineprotocol.host
def test_port_property(self):
mock = Mock(spec=network.Connection)
mock.port = sentinel.port
lineprotocol = network.LineProtocol(mock)
assert sentinel.port == lineprotocol.port
|
