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
|
#!/usr/bin/env python
import unittest
from pymodbus.compat import IS_PYTHON3
if IS_PYTHON3: # Python 3
from unittest.mock import patch, Mock, MagicMock
else: # Python 2
from mock import patch, Mock, MagicMock
import socket
import serial
from pymodbus.client.sync import ModbusTcpClient, ModbusUdpClient
from pymodbus.client.sync import ModbusSerialClient, BaseModbusClient
from pymodbus.exceptions import ConnectionException, NotImplementedException
from pymodbus.exceptions import ParameterException
from pymodbus.transaction import ModbusAsciiFramer, ModbusRtuFramer
from pymodbus.transaction import ModbusBinaryFramer
# ---------------------------------------------------------------------------#
# Mock Classes
# ---------------------------------------------------------------------------#
class mockSocket(object):
timeout = 2
def close(self): return True
def recv(self, size): return b'\x00' * size
def read(self, size): return b'\x00' * size
def send(self, msg): return len(msg)
def write(self, msg): return len(msg)
def recvfrom(self, size): return [b'\x00' * size]
def sendto(self, msg, *args): return len(msg)
def setblocking(self, flag): return None
def in_waiting(self): return None
# ---------------------------------------------------------------------------#
# Fixture
# ---------------------------------------------------------------------------#
class SynchronousClientTest(unittest.TestCase):
'''
This is the unittest for the pymodbus.client.sync module
'''
# -----------------------------------------------------------------------#
# Test Base Client
# -----------------------------------------------------------------------#
def testBaseModbusClient(self):
''' Test the base class for all the clients '''
client = BaseModbusClient(None)
client.transaction = None
self.assertRaises(NotImplementedException, lambda: client.connect())
self.assertRaises(NotImplementedException, lambda: client._send(None))
self.assertRaises(NotImplementedException, lambda: client._recv(None))
self.assertRaises(NotImplementedException, lambda: client.__enter__())
self.assertRaises(NotImplementedException, lambda: client.execute())
self.assertRaises(NotImplementedException, lambda: client.is_socket_open())
self.assertEqual("Null Transport", str(client))
client.close()
client.__exit__(0, 0, 0)
# a successful execute
client.connect = lambda: True
client.transaction = Mock(**{'execute.return_value': True})
self.assertEqual(client, client.__enter__())
self.assertTrue(client.execute())
# a unsuccessful connect
client.connect = lambda: False
self.assertRaises(ConnectionException, lambda: client.__enter__())
self.assertRaises(ConnectionException, lambda: client.execute())
# -----------------------------------------------------------------------#
# Test UDP Client
# -----------------------------------------------------------------------#
def testSyncUdpClientInstantiation(self):
client = ModbusUdpClient()
self.assertNotEqual(client, None)
def testBasicSyncUdpClient(self):
''' Test the basic methods for the udp sync client'''
# receive/send
client = ModbusUdpClient()
client.socket = mockSocket()
self.assertEqual(0, client._send(None))
self.assertEqual(1, client._send(b'\x00'))
self.assertEqual(b'\x00', client._recv(1))
# connect/disconnect
self.assertTrue(client.connect())
client.close()
# already closed socket
client.socket = False
client.close()
self.assertEqual("ModbusUdpClient(127.0.0.1:502)", str(client))
def testUdpClientAddressFamily(self):
''' Test the Udp client get address family method'''
client = ModbusUdpClient()
self.assertEqual(socket.AF_INET,
client._get_address_family('127.0.0.1'))
self.assertEqual(socket.AF_INET6, client._get_address_family('::1'))
def testUdpClientConnect(self):
''' Test the Udp client connection method'''
with patch.object(socket, 'socket') as mock_method:
class DummySocket(object):
def settimeout(self, *a, **kwa):
pass
mock_method.return_value = DummySocket()
client = ModbusUdpClient()
self.assertTrue(client.connect())
with patch.object(socket, 'socket') as mock_method:
mock_method.side_effect = socket.error()
client = ModbusUdpClient()
self.assertFalse(client.connect())
def testUdpClientSend(self):
''' Test the udp client send method'''
client = ModbusUdpClient()
self.assertRaises(ConnectionException, lambda: client._send(None))
client.socket = mockSocket()
self.assertEqual(0, client._send(None))
self.assertEqual(4, client._send('1234'))
def testUdpClientRecv(self):
''' Test the udp client receive method'''
client = ModbusUdpClient()
self.assertRaises(ConnectionException, lambda: client._recv(1024))
client.socket = mockSocket()
self.assertEqual(b'', client._recv(0))
self.assertEqual(b'\x00' * 4, client._recv(4))
def testUdpClientRepr(self):
client = ModbusUdpClient()
rep = "<{} at {} socket={}, ipaddr={}, port={}, timeout={}>".format(
client.__class__.__name__, hex(id(client)), client.socket,
client.host, client.port, client.timeout
)
self.assertEqual(repr(client), rep)
# -----------------------------------------------------------------------#
# Test TCP Client
# -----------------------------------------------------------------------#
def testSyncTcpClientInstantiation(self):
client = ModbusTcpClient()
self.assertNotEqual(client, None)
@patch('pymodbus.client.sync.select')
def testBasicSyncTcpClient(self, mock_select):
''' Test the basic methods for the tcp sync client'''
# receive/send
mock_select.select.return_value = [True]
client = ModbusTcpClient()
client.socket = mockSocket()
self.assertEqual(0, client._send(None))
self.assertEqual(1, client._send(b'\x00'))
self.assertEqual(b'\x00', client._recv(1))
# connect/disconnect
self.assertTrue(client.connect())
client.close()
# already closed socket
client.socket = False
client.close()
self.assertEqual("ModbusTcpClient(127.0.0.1:502)", str(client))
def testTcpClientConnect(self):
''' Test the tcp client connection method'''
with patch.object(socket, 'create_connection') as mock_method:
mock_method.return_value = object()
client = ModbusTcpClient()
self.assertTrue(client.connect())
with patch.object(socket, 'create_connection') as mock_method:
mock_method.side_effect = socket.error()
client = ModbusTcpClient()
self.assertFalse(client.connect())
def testTcpClientSend(self):
''' Test the tcp client send method'''
client = ModbusTcpClient()
self.assertRaises(ConnectionException, lambda: client._send(None))
client.socket = mockSocket()
self.assertEqual(0, client._send(None))
self.assertEqual(4, client._send('1234'))
@patch('pymodbus.client.sync.select')
def testTcpClientRecv(self, mock_select):
''' Test the tcp client receive method'''
mock_select.select.return_value = [True]
client = ModbusTcpClient()
self.assertRaises(ConnectionException, lambda: client._recv(1024))
client.socket = mockSocket()
self.assertEqual(b'', client._recv(0))
self.assertEqual(b'\x00' * 4, client._recv(4))
mock_socket = MagicMock()
mock_socket.recv.side_effect = iter([b'\x00', b'\x01', b'\x02'])
client.socket = mock_socket
client.timeout = 1
self.assertEqual(b'\x00\x01\x02', client._recv(3))
mock_socket.recv.side_effect = iter([b'\x00', b'\x01', b'\x02'])
self.assertEqual(b'\x00\x01', client._recv(2))
mock_select.select.return_value = [False]
self.assertEqual(b'', client._recv(2))
client.socket = mockSocket()
mock_select.select.return_value = [True]
self.assertIn(b'\x00', client._recv(None))
def testSerialClientRpr(self):
client = ModbusTcpClient()
rep = "<{} at {} socket={}, ipaddr={}, port={}, timeout={}>".format(
client.__class__.__name__, hex(id(client)), client.socket,
client.host, client.port, client.timeout
)
self.assertEqual(repr(client), rep)
# -----------------------------------------------------------------------#
# Test Serial Client
# -----------------------------------------------------------------------#
def testSyncSerialClientInstantiation(self):
client = ModbusSerialClient()
self.assertNotEqual(client, None)
self.assertTrue(isinstance(ModbusSerialClient(method='ascii').framer,
ModbusAsciiFramer))
self.assertTrue(isinstance(ModbusSerialClient(method='rtu').framer,
ModbusRtuFramer))
self.assertTrue(isinstance(ModbusSerialClient(method='binary').framer,
ModbusBinaryFramer))
self.assertRaises(ParameterException,
lambda: ModbusSerialClient(method='something'))
def testSyncSerialRTUClientTimeouts(self):
client = ModbusSerialClient(method="rtu", baudrate=9600)
assert client.silent_interval == round((3.5 * 11 / 9600), 6)
client = ModbusSerialClient(method="rtu", baudrate=38400)
assert client.silent_interval == round((1.75 / 1000), 6)
@patch("serial.Serial")
def testBasicSyncSerialClient(self, mock_serial):
''' Test the basic methods for the serial sync client'''
# receive/send
mock_serial.in_waiting = 0
mock_serial.write = lambda x: len(x)
mock_serial.read = lambda size: b'\x00' * size
client = ModbusSerialClient()
client.socket = mock_serial
client.state = 0
self.assertEqual(0, client._send(None))
client.state = 0
self.assertEqual(1, client._send(b'\x00'))
self.assertEqual(b'\x00', client._recv(1))
# connect/disconnect
self.assertTrue(client.connect())
client.close()
# already closed socket
client.socket = False
client.close()
self.assertEqual('ModbusSerialClient(ascii baud[19200])', str(client))
def testSerialClientConnect(self):
''' Test the serial client connection method'''
with patch.object(serial, 'Serial') as mock_method:
mock_method.return_value = object()
client = ModbusSerialClient()
self.assertTrue(client.connect())
with patch.object(serial, 'Serial') as mock_method:
mock_method.side_effect = serial.SerialException()
client = ModbusSerialClient()
self.assertFalse(client.connect())
@patch("serial.Serial")
def testSerialClientSend(self, mock_serial):
''' Test the serial client send method'''
mock_serial.in_waiting = None
mock_serial.write = lambda x: len(x)
client = ModbusSerialClient()
self.assertRaises(ConnectionException, lambda: client._send(None))
# client.connect()
client.socket = mock_serial
client.state = 0
self.assertEqual(0, client._send(None))
client.state = 0
self.assertEqual(4, client._send('1234'))
@patch("serial.Serial")
def testSerialClientCleanupBufferBeforeSend(self, mock_serial):
''' Test the serial client send method'''
mock_serial.in_waiting = 4
mock_serial.read = lambda x: b'1' * x
mock_serial.write = lambda x: len(x)
client = ModbusSerialClient()
self.assertRaises(ConnectionException, lambda: client._send(None))
# client.connect()
client.socket = mock_serial
client.state = 0
self.assertEqual(0, client._send(None))
client.state = 0
self.assertEqual(4, client._send('1234'))
def testSerialClientRecv(self):
''' Test the serial client receive method'''
client = ModbusSerialClient()
self.assertRaises(ConnectionException, lambda: client._recv(1024))
client.socket = mockSocket()
self.assertEqual(b'', client._recv(0))
self.assertEqual(b'\x00' * 4, client._recv(4))
client.socket = MagicMock()
client.socket.read.return_value = b''
self.assertEqual(b'', client._recv(None))
client.socket.timeout = 0
self.assertEqual(b'', client._recv(0))
def testSerialClientRepr(self):
client = ModbusSerialClient()
rep = "<{} at {} socket={}, method={}, timeout={}>".format(
client.__class__.__name__, hex(id(client)), client.socket,
client.method, client.timeout
)
self.assertEqual(repr(client), rep)
# ---------------------------------------------------------------------------#
# Main
# ---------------------------------------------------------------------------#
if __name__ == "__main__":
unittest.main()
|
