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
|
"""Test transport."""
import asyncio
from unittest import mock
import pytest
from pymodbus.transport import (
CommType,
ModbusProtocol,
)
COMM_TYPES = [
CommType.TCP,
CommType.TLS,
CommType.UDP,
CommType.SERIAL,
]
class TestTransportProtocol1:
"""Test transport module."""
@staticmethod
@pytest.fixture(name="use_port")
def get_port_in_class(base_ports):
"""Return next port."""
base_ports[__class__.__name__] += 1
return base_ports[__class__.__name__]
@pytest.mark.parametrize("use_comm_type", COMM_TYPES)
async def test_init_client(self, client):
"""Test init client."""
assert not client.is_server
@pytest.mark.parametrize("use_comm_type", COMM_TYPES)
async def test_init_server(self, server):
"""Test init server."""
assert not server.active_connections
assert server.is_server
@pytest.mark.parametrize("use_comm_type", COMM_TYPES)
async def test_init_client_id(self, client):
"""Test init client id."""
assert client.unique_id == str(id(client))
async def test_init_source_addr(self, use_clc):
"""Test callbacks."""
use_clc.source_address = ("localhost", 112)
ModbusProtocol(use_clc, True)
async def test_init_source_addr_none(self, use_clc):
"""Test callbacks."""
use_clc.source_address = None
ModbusProtocol(use_clc, True)
async def test_loop_connect(self, client, dummy_protocol):
"""Test properties."""
client.call_create = mock.AsyncMock(return_value=(dummy_protocol(), None))
assert await client.connect()
async def test_loop_listen(self, server, dummy_protocol):
"""Test properties."""
server.call_create = mock.AsyncMock(return_value=(dummy_protocol(), None))
server.loop = asyncio.get_running_loop()
assert await server.listen()
assert server.loop
async def test_connect_ok(self, client, dummy_protocol):
"""Test properties."""
client.call_create = mock.AsyncMock(return_value=(dummy_protocol(), None))
assert await client.connect()
async def test_connect_not_ok(self, client, dummy_protocol):
"""Test properties."""
client.call_create = mock.AsyncMock(return_value=(dummy_protocol(), None))
client.call_create.side_effect = asyncio.TimeoutError("test")
assert not await client.connect()
async def test_listen_ok(self, server, dummy_protocol):
"""Test listen_tcp()."""
server.call_create = mock.AsyncMock(return_value=(dummy_protocol(), None))
assert await server.listen()
async def test_listen_not_ok(self, server, dummy_protocol):
"""Test listen_tcp()."""
server.call_create = mock.AsyncMock(return_value=(dummy_protocol(), None))
server.call_create.side_effect = OSError("testing")
assert not await server.listen()
async def test_connection_made(self, client, use_clc, dummy_protocol):
"""Test connection_made()."""
client.connection_made(dummy_protocol())
assert client.transport
assert not client.recv_buffer
assert not client.reconnect_task
assert client.reconnect_delay_current == use_clc.reconnect_delay
client.callback_connected.assert_called_once()
async def test_connection_lost(self, client, dummy_protocol):
"""Test connection_lost()."""
client.connection_lost(RuntimeError("not implemented"))
client.connection_made(dummy_protocol())
client.connection_lost(RuntimeError("not implemented"))
assert not client.transport
assert not client.recv_buffer
assert client.reconnect_task
client.callback_disconnected.assert_called_once()
client.close()
assert not client.reconnect_task
assert not client.reconnect_delay_current
async def test_data_received_rest(self, client):
"""Test data_received."""
client.callback_data = mock.MagicMock(return_value=2)
client.data_received(b"123456")
client.callback_data.assert_called_once()
assert client.recv_buffer == b"3456"
client.data_received(b"789")
assert client.recv_buffer == b"56789"
async def test_data_received_all(self, client):
"""Test data_received."""
test_data = b"123"
client.callback_data = mock.MagicMock(return_value=len(test_data))
client.data_received(test_data)
assert not client.recv_buffer
async def test_datagram(self, client):
"""Test datagram_received()."""
client.callback_data = mock.MagicMock()
client.datagram_received(b"abc", "127.0.0.1")
client.callback_data.assert_called_once()
async def test_callback_connected(self, use_clc):
"""Test callbacks."""
client = ModbusProtocol(use_clc, False)
client.callback_connected()
async def test_callback_disconnected(self, use_clc):
"""Test callbacks."""
client = ModbusProtocol(use_clc, False)
client.callback_disconnected(Exception("test"))
async def test_callback_data(self, use_clc):
"""Test callbacks."""
client = ModbusProtocol(use_clc, False)
client.callback_data(b"abcd")
async def test_handle_local_echo(self, client):
"""Test send()."""
client.comm_params.handle_local_echo = True
client.transport = mock.Mock()
test_data = b"abc"
client.send(test_data)
client.data_received(test_data)
assert not client.recv_buffer
client.data_received(test_data)
assert client.recv_buffer == test_data
assert not client.sent_buffer
async def test_handle_local_echo_udp(self, client):
"""Test send()."""
client.comm_params.handle_local_echo = True
client.transport = mock.Mock()
test_data = b"abc"
client.send(test_data)
client.datagram_received(test_data, ("127.0.0.1", 502))
assert not client.recv_buffer
assert not client.sent_buffer
client.datagram_received(test_data, ("127.0.0.1", 502))
assert client.recv_buffer == test_data
assert not client.sent_buffer
async def test_handle_local_echo_none(self, client):
"""Test send()."""
client.comm_params.handle_local_echo = True
client.transport = mock.Mock()
test_data = b"abc"
client.send(b"no echo")
client.datagram_received(test_data, ("127.0.0.1", 502))
assert client.recv_buffer == test_data
assert not client.sent_buffer
async def test_handle_local_echo_partial(self, client):
"""Test send()."""
client.comm_params.handle_local_echo = True
client.transport = mock.Mock()
client.send(b"partial")
client.datagram_received(b"par", ("127.0.0.1", 502))
client.datagram_received(b"tialresponse", ("127.0.0.1", 502))
assert client.recv_buffer == b"response"
assert not client.sent_buffer
async def test_handle_no_transport(self, client):
"""Test send()."""
client.transport = None
client.send(b"partial")
assert not client.sent_buffer
class TestTransportProtocol2:
"""Test transport module."""
@staticmethod
@pytest.fixture(name="use_port")
def get_port_in_class(base_ports):
"""Return next port."""
base_ports[__class__.__name__] += 1
return base_ports[__class__.__name__]
async def test_eof_received(self, client):
"""Test eof_received."""
client.eof_received()
async def test_error_received(self, client):
"""Test error_received."""
client.error_received(Exception("test call"))
async def test_send(self, client):
"""Test send()."""
client.transport = mock.Mock()
client.send(b"abc")
async def test_send_udp(self, client):
"""Test send()."""
client.transport = mock.Mock()
client.comm_params.comm_type = CommType.UDP
client.send(b"abc", addr=("localhost", 502))
async def test_send_udp_no_addr(self, client):
"""Test send()."""
client.transport = mock.Mock()
client.comm_params.comm_type = CommType.UDP
client.send(b"abc")
async def test_close_connection(self, server, dummy_protocol):
"""Test close()."""
prot = dummy_protocol()
prot.close = mock.MagicMock()
server.connection_made(prot)
server.recv_buffer = b"abc"
server.reconnect_task = mock.MagicMock()
server.close()
prot.close.assert_called_once()
assert not server.recv_buffer
async def test_close_listen(self, server, dummy_protocol):
"""Test close()."""
prot = dummy_protocol()
prot.close = mock.MagicMock()
await server.listen()
server.active_connections = {"a": prot}
server.close()
server.close()
assert not server.active_connections
async def test_close2(self, server, client, dummy_protocol):
"""Test close()."""
prot = dummy_protocol()
prot.abort = mock.Mock()
prot.close = mock.Mock()
client.connection_made(prot)
client.recv_buffer = b"abc"
client.reconnect_task = mock.MagicMock()
client.listener = server
server.active_connections = {client.unique_id: dummy_protocol}
client.close()
assert not server.active_connections
async def test_reset_delay(self, client, use_clc):
"""Test reset_delay()."""
client.reconnect_delay_current += 5.17
client.reset_delay()
assert client.reconnect_delay_current == use_clc.reconnect_delay
async def test_is_active(self, client):
"""Test is_active()."""
assert not client.is_active()
client.connection_made(mock.Mock())
assert client.is_active()
client.close()
async def test_create_nullmodem(self, client, server):
"""Test create_nullmodem."""
assert not await client.connect()
await server.listen()
assert await client.connect()
client.close()
server.close()
async def test_handle_new_connection(self, client, server):
"""Test handle_new_connection()."""
server.handle_new_connection()
client.handle_new_connection()
async def test_do_reconnect(self, client):
"""Test do_reconnect()."""
client.comm_params.reconnect_delay = 0.01
client.connect = mock.AsyncMock(side_effect=[False, True])
await client.do_reconnect()
assert client.reconnect_delay_current == client.comm_params.reconnect_delay * 2
assert not client.reconnect_task
client.connect.side_effect = asyncio.CancelledError("stop loop")
await client.do_reconnect()
assert client.reconnect_delay_current == client.comm_params.reconnect_delay
assert not client.reconnect_task
async def test_with_magic(self, client):
"""Test magic."""
client.close = mock.MagicMock()
async with client:
pass
client.close.assert_called_once()
async def test_str_magic(self, use_clc, client):
"""Test magic."""
assert str(client) == f"DummyProtocol({use_clc.comm_name})"
def test_generate_ssl_cert(self, use_clc):
"""Test ssl generation."""
with mock.patch("pymodbus.transport.transport.ssl.SSLContext"):
sslctx = use_clc.generate_ssl(True, "cert_file", "key_file")
assert sslctx
def test_generate_ssl_ctx(self, use_clc):
"""Test ssl generation."""
test_value = "test igen"
assert test_value == use_clc.generate_ssl(
True, "cert_file", "key_file", sslctx=test_value
)
def test_generate_ssl_client(self, use_clc):
"""Test ssl generation."""
test_value = "test igen"
assert test_value == use_clc.generate_ssl(
False, "cert_file", "key_file", sslctx=test_value
)
def test_generate_ssl_no_file(self, use_clc):
"""Test ssl generation."""
assert use_clc.generate_ssl(True, None, None)
@pytest.mark.parametrize("use_host", ["socket://localhost:5005", "/dev/tty"])
@pytest.mark.parametrize("use_comm_type", [CommType.SERIAL])
async def test_init_serial(self, use_cls):
"""Test server serial with socket."""
ModbusProtocol(use_cls, True)
@pytest.mark.parametrize("use_host", ["socket://localhost:5006"])
@pytest.mark.parametrize("use_comm_type", [CommType.SERIAL])
async def test_init_create_serial(self, use_cls):
"""Test server serial with socket."""
protocol = ModbusProtocol(use_cls, True)
await protocol.listen()
@pytest.mark.parametrize("use_host", ["localhost"])
@pytest.mark.parametrize("use_comm_type", [CommType.UDP])
@pytest.mark.parametrize("is_server", [True, False])
async def test_init_udp(self, is_server, use_cls, use_clc):
"""Test server/client udp."""
if is_server:
ModbusProtocol(use_cls, True)
else:
ModbusProtocol(use_clc, False)
|
