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
|
#!/usr/bin/env python
from pymodbus.compat import IS_PYTHON3
import unittest
if IS_PYTHON3: # Python 3
from unittest.mock import patch, Mock, MagicMock
else: # Python 2
from mock import patch, Mock, MagicMock
from pymodbus.device import ModbusDeviceIdentification
from pymodbus.server.asynchronous import ModbusTcpProtocol, ModbusUdpProtocol
from pymodbus.server.asynchronous import ModbusServerFactory
from pymodbus.server.asynchronous import (
StartTcpServer, StartUdpServer, StartSerialServer, StopServer,
_is_main_thread
)
from pymodbus.compat import byte2int
from pymodbus.transaction import ModbusSocketFramer
from pymodbus.exceptions import NoSuchSlaveException, ModbusIOException
import sys
#---------------------------------------------------------------------------#
# Fixture
#---------------------------------------------------------------------------#
import platform
from distutils.version import LooseVersion
IS_DARWIN = platform.system().lower() == "darwin"
OSX_SIERRA = LooseVersion("10.12")
if IS_DARWIN:
IS_HIGH_SIERRA_OR_ABOVE = LooseVersion(platform.mac_ver()[0])
SERIAL_PORT = '/dev/ptyp0' if not IS_HIGH_SIERRA_OR_ABOVE else '/dev/ttyp0'
else:
IS_HIGH_SIERRA_OR_ABOVE = False
SERIAL_PORT = "/dev/ptmx"
class AsynchronousServerTest(unittest.TestCase):
'''
This is the unittest for the pymodbus.server.asynchronous module
'''
#-----------------------------------------------------------------------#
# Setup/TearDown
#-----------------------------------------------------------------------#
def setUp(self):
'''
Initializes the test environment
'''
values = dict((i, '') for i in range(10))
identity = ModbusDeviceIdentification(info=values)
def tearDown(self):
''' Cleans up the test environment '''
pass
#-----------------------------------------------------------------------#
# Test ModbusTcpProtocol
#-----------------------------------------------------------------------#
def testTcpServerStartup(self):
''' Test that the modbus tcp asynchronous server starts correctly '''
with patch('twisted.internet.reactor') as mock_reactor:
if IS_PYTHON3:
console = False
call_count = 1
else:
console = True
call_count = 2
StartTcpServer(context=None, console=console)
self.assertEqual(mock_reactor.listenTCP.call_count, call_count)
self.assertEqual(mock_reactor.run.call_count, 1)
def testConnectionMade(self):
protocol = ModbusTcpProtocol()
protocol.transport = MagicMock()
protocol.factory = MagicMock()
protocol.factory.framer = ModbusSocketFramer
protocol.connectionMade()
self.assertIsInstance(protocol.framer, ModbusSocketFramer)
def testConnectionLost(self):
protocol = ModbusTcpProtocol()
protocol.connectionLost("What ever reason")
def testDataReceived(self):
protocol = ModbusTcpProtocol()
# mock_data = "Hellow world!"
mock_data = b"\x00\x01\x12\x34\x00\x04\xff\x02\x12\x34"
protocol.factory = MagicMock()
protocol.factory.control.ListenOnly = False
protocol.factory.store.slaves = MagicMock()
protocol.factory.store.single = True
protocol.factory.store.slaves.return_value = [byte2int(mock_data[6])]
protocol.framer = protocol._execute = MagicMock()
protocol.dataReceived(mock_data)
self.assertTrue(protocol.framer.processIncomingPacket.called)
# test datareceived returns None
protocol.factory.control.ListenOnly = False
self.assertEqual(protocol.dataReceived(mock_data), None)
def testTcpExecuteSuccess(self):
protocol = ModbusTcpProtocol()
protocol.store = MagicMock()
request = MagicMock()
protocol._send = MagicMock()
# tst if _send being called
protocol._execute(request)
self.assertTrue(protocol._send.called)
def testTcpExecuteFailure(self):
protocol = ModbusTcpProtocol()
protocol.factory = MagicMock()
protocol.factory.store = MagicMock()
protocol.store = MagicMock()
protocol.factory.ignore_missing_slaves = False
request = MagicMock()
protocol._send = MagicMock()
# CASE-1: test NoSuchSlaveException exceptions
request.execute.side_effect = NoSuchSlaveException()
self.assertRaises(
NoSuchSlaveException, protocol._execute(request)
)
self.assertTrue(request.doException.called)
# CASE-2: NoSuchSlaveException with ignore_missing_slaves = true
protocol.ignore_missing_slaves = True
request.execute.side_effect = NoSuchSlaveException()
self.assertEqual(protocol._execute(request), None)
# test other exceptions
request.execute.side_effect = ModbusIOException()
self.assertRaises(
ModbusIOException, protocol._execute(request)
)
self.assertTrue(protocol._send.called)
def testSendTcp(self):
class MockMsg(object):
def __init__(self, msg, resp=False):
self.should_respond = resp
self.msg = msg
mock_msg = b"\x00\x01\x12\x34\x00\x04\xff\x02\x12\x34"
protocol = ModbusTcpProtocol()
mock_data = MockMsg(resp=True, msg=mock_msg)
protocol.control = MagicMock()
protocol.framer = MagicMock()
protocol.factory = MagicMock()
protocol.framer.buildPacket = MagicMock(return_value=mock_msg)
protocol.transport= MagicMock()
protocol._send(mock_data)
self.assertTrue(protocol.framer.buildPacket.called)
self.assertTrue(protocol.transport.write.called)
mock_data =MockMsg(resp=False, msg="helloworld")
self.assertEqual(protocol._send(mock_data), None)
#-----------------------------------------------------------------------#
# Test ModbusServerFactory
#-----------------------------------------------------------------------#
def testModbusServerFactory(self):
''' Test the base class for all the clients '''
factory = ModbusServerFactory(store=None)
self.assertEqual(factory.control.Identity.VendorName, '')
identity = ModbusDeviceIdentification(info={0x00: 'VendorName'})
factory = ModbusServerFactory(store=None, identity=identity)
self.assertEqual(factory.control.Identity.VendorName, 'VendorName')
#-----------------------------------------------------------------------#
# Test ModbusUdpProtocol
#-----------------------------------------------------------------------#
def testUdpServerInitialize(self):
protocol = ModbusUdpProtocol(store=None)
self.assertEqual(protocol.control.Identity.VendorName, '')
identity = ModbusDeviceIdentification(info={0x00: 'VendorName'})
protocol = ModbusUdpProtocol(store=None, identity=identity)
self.assertEqual(protocol.control.Identity.VendorName, 'VendorName')
def testUdpServerStartup(self):
''' Test that the modbus udp asynchronous server starts correctly '''
with patch('twisted.internet.reactor') as mock_reactor:
StartUdpServer(context=None)
self.assertEqual(mock_reactor.listenUDP.call_count, 1)
self.assertEqual(mock_reactor.run.call_count, 1)
@patch("twisted.internet.serialport.SerialPort")
def testSerialServerStartup(self, mock_sp):
''' Test that the modbus serial asynchronous server starts correctly '''
with patch('twisted.internet.reactor') as mock_reactor:
StartSerialServer(context=None, port=SERIAL_PORT)
self.assertEqual(mock_reactor.run.call_count, 1)
@patch("twisted.internet.serialport.SerialPort")
def testStopServerFromMainThread(self, mock_sp):
"""
Stop asynchronous server
:return:
"""
with patch('twisted.internet.reactor') as mock_reactor:
StartSerialServer(context=None, port=SERIAL_PORT)
self.assertEqual(mock_reactor.run.call_count, 1)
StopServer()
self.assertEqual(mock_reactor.stop.call_count, 1)
@patch("twisted.internet.serialport.SerialPort")
def testStopServerFromThread(self, mock_sp):
"""
Stop asynchronous server from child thread
:return:
"""
from threading import Thread
import time
with patch('twisted.internet.reactor') as mock_reactor:
StartSerialServer(context=None, port=SERIAL_PORT)
self.assertEqual(mock_reactor.run.call_count, 1)
t = Thread(target=StopServer)
t.start()
time.sleep(2)
self.assertEqual(mock_reactor.callFromThread.call_count, 1)
def testDatagramReceived(self):
mock_data = b"\x00\x01\x12\x34\x00\x04\xff\x02\x12\x34"
mock_addr = 0x01
protocol = ModbusUdpProtocol(store=None)
protocol.framer.processIncomingPacket = MagicMock()
protocol.control.ListenOnly = False
protocol._execute = MagicMock()
protocol.datagramReceived(mock_data, mock_addr)
self.assertTrue(protocol.framer.processIncomingPacket.called)
def testSendUdp(self):
protocol = ModbusUdpProtocol(store=None)
mock_data = b"\x00\x01\x12\x34\x00\x04\xff\x02\x12\x34"
mock_addr = 0x01
protocol.control = MagicMock()
protocol.framer = MagicMock()
protocol.framer.buildPacket = MagicMock(return_value=mock_data)
protocol.transport= MagicMock()
protocol._send(mock_data, mock_addr)
self.assertTrue(protocol.framer.buildPacket.called)
self.assertTrue(protocol.transport.write.called)
def testUdpExecuteSuccess(self):
protocol = ModbusUdpProtocol(store=None)
mock_addr = 0x01
protocol.store = MagicMock()
request = MagicMock()
protocol._send = MagicMock()
# tst if _send being called
protocol._execute(request, mock_addr)
self.assertTrue(protocol._send.called)
def testUdpExecuteFailure(self):
protocol = ModbusUdpProtocol(store=None)
mock_addr = 0x01
protocol.store = MagicMock()
request = MagicMock()
protocol._send = MagicMock()
# CASE-1: test NoSuchSlaveException exceptions
request.execute.side_effect = NoSuchSlaveException()
self.assertRaises(
NoSuchSlaveException, protocol._execute(request, mock_addr)
)
self.assertTrue(request.doException.called)
# CASE-2: NoSuchSlaveException with ignore_missing_slaves = true
protocol.ignore_missing_slaves = True
request.execute.side_effect = NoSuchSlaveException()
self.assertEqual(protocol._execute(request, mock_addr), None)
# test other exceptions
request.execute.side_effect = ModbusIOException()
self.assertRaises(
ModbusIOException, protocol._execute(request, mock_addr)
)
self.assertTrue(protocol._send.called)
def testStopServer(self):
from twisted.internet import reactor
reactor.stop = MagicMock()
StopServer()
self.assertTrue(reactor.stop.called)
def testIsMainThread(self):
import threading
self.assertTrue(_is_main_thread())
# --------------------------------------------------------------------------- #
# Main
# --------------------------------------------------------------------------- #
if __name__ == "__main__":
unittest.main()
|
