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
|
#!/usr/bin/env python
import unittest
from pymodbus.compat import IS_PYTHON3
if IS_PYTHON3:
from unittest.mock import patch, Mock
else: # Python 2
from mock import patch, Mock
from pymodbus.client.asynchronous.tornado import (BaseTornadoClient,
AsyncModbusSerialClient, AsyncModbusUDPClient, AsyncModbusTCPClient
)
from pymodbus.client.asynchronous import schedulers
from pymodbus.factory import ClientDecoder
from pymodbus.client.asynchronous.twisted import ModbusClientFactory
from pymodbus.exceptions import ConnectionException
from pymodbus.transaction import ModbusSocketFramer, ModbusRtuFramer
from pymodbus.bit_read_message import ReadCoilsRequest, ReadCoilsResponse
# ---------------------------------------------------------------------------#
# 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/ttyp0' if not IS_HIGH_SIERRA_OR_ABOVE else '/dev/ptyp0'
else:
IS_HIGH_SIERRA_OR_ABOVE = False
SERIAL_PORT = "/dev/ptmx"
class AsynchronousClientTest(unittest.TestCase):
"""
This is the unittest for the pymodbus.client.asynchronous module
"""
# -----------------------------------------------------------------------#
# Test Client client
# -----------------------------------------------------------------------#
def testBaseClientInit(self):
""" Test the client client initialize """
client = BaseTornadoClient()
self.assertTrue(client.port ==502)
self.assertTrue(client.host =="127.0.0.1")
self.assertEqual(0, len(list(client.transaction)))
self.assertFalse(client._connected)
self.assertTrue(client.io_loop is None)
self.assertTrue(isinstance(client.framer, ModbusSocketFramer))
framer = object()
client = BaseTornadoClient(framer=framer, ioloop=schedulers.IO_LOOP)
self.assertEqual(0, len(list(client.transaction)))
self.assertFalse(client._connected)
self.assertTrue(client.io_loop == schedulers.IO_LOOP)
self.assertTrue(framer is client.framer)
@unittest.skip("temporarily disabled")
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.IOStream")
def testBaseClientOn_receive(self, mock_iostream, mock_ioloop):
""" Test the BaseTornado client data received """
client = AsyncModbusTCPClient(port=5020)
client.connect()
out = []
data = b'\x00\x00\x12\x34\x00\x06\xff\x01\x01\x02\x00\x04'
# setup existing request
d = client._build_response(0x00)
d.add_done_callback(lambda v: out.append(v))
client.on_receive(data)
self.assertTrue(isinstance(out[0].result(), ReadCoilsResponse))
data = b''
out = []
d = client._build_response(0x01)
client.on_receive(data)
d.add_done_callback(lambda v: out.append(v))
self.assertFalse(out)
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.IOStream")
def testBaseClientExecute(self, mock_iostream, mock_ioloop):
""" Test the BaseTornado client execute method """
client = AsyncModbusTCPClient(port=5020)
client.connect()
client.stream = Mock()
client.stream.write = Mock()
request = ReadCoilsRequest(1, 1)
d = client.execute(request)
tid = request.transaction_id
self.assertEqual(d, client.transaction.getTransaction(tid))
@unittest.skip("temporarily disabled")
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.IOStream")
def testBaseClientHandleResponse(self, mock_iostream, mock_ioloop):
""" Test the BaseTornado client handles responses """
client = AsyncModbusTCPClient(port=5020)
client.connect()
out = []
reply = ReadCoilsRequest(1, 1)
reply.transaction_id = 0x00
# handle skipped cases
client._handle_response(None)
client._handle_response(reply)
# handle existing cases
d = client._build_response(0x00)
d.add_done_callback(lambda v: out.append(v))
client._handle_response(reply)
self.assertEqual(out[0].result(), reply)
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.IOStream")
def testBaseClientBuildResponse(self, mock_iostream, mock_ioloop):
""" Test the BaseTornado client client builds responses """
client = BaseTornadoClient()
self.assertEqual(0, len(list(client.transaction)))
def handle_failure(failure):
exc = failure.exception()
self.assertTrue(isinstance(exc, ConnectionException))
d = client._build_response(0x00)
d.add_done_callback(handle_failure)
self.assertEqual(0, len(list(client.transaction)))
client._connected = True
d = client._build_response(0x00)
self.assertEqual(1, len(list(client.transaction)))
# -----------------------------------------------------------------------#
# Test TCP Client client
# -----------------------------------------------------------------------#
def testTcpClientInit(self):
""" Test the tornado tcp client client initialize """
client = AsyncModbusTCPClient()
self.assertEqual(0, len(list(client.transaction)))
self.assertTrue(isinstance(client.framer, ModbusSocketFramer))
framer = object()
client = AsyncModbusTCPClient(framer=framer)
self.assertTrue(framer is client.framer)
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.IOStream")
def testTcpClientConnect(self, mock_iostream, mock_ioloop):
""" Test the tornado tcp client client connect """
client = AsyncModbusTCPClient(port=5020)
self.assertTrue(client.port, 5020)
self.assertFalse(client._connected)
client.connect()
self.assertTrue(client._connected)
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.IOStream")
def testTcpClientDisconnect(self, mock_iostream, mock_ioloop):
""" Test the tornado tcp client client disconnect """
client = AsyncModbusTCPClient(port=5020)
client.connect()
def handle_failure(failure):
self.assertTrue(isinstance(failure.exception(), ConnectionException))
d = client._build_response(0x00)
d.add_done_callback(handle_failure)
self.assertTrue(client._connected)
client.close()
self.assertFalse(client._connected)
# -----------------------------------------------------------------------#
# Test Serial Client client
# -----------------------------------------------------------------------#
def testSerialClientInit(self):
""" Test the tornado serial client client initialize """
client = AsyncModbusSerialClient(ioloop=schedulers.IO_LOOP, framer=ModbusRtuFramer(ClientDecoder()), port=SERIAL_PORT)
self.assertEqual(0, len(list(client.transaction)))
self.assertTrue(isinstance(client.framer, ModbusRtuFramer))
framer = object()
client = AsyncModbusSerialClient(framer=framer)
self.assertTrue(framer is client.framer)
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.SerialIOStream")
@patch("pymodbus.client.asynchronous.tornado.Serial")
def testSerialClientConnect(self, mock_serial, mock_seriostream, mock_ioloop):
""" Test the tornado serial client client connect """
client = AsyncModbusSerialClient(ioloop=schedulers.IO_LOOP,
framer=ModbusRtuFramer(
ClientDecoder()),
port=SERIAL_PORT)
self.assertTrue(client.port, SERIAL_PORT)
self.assertFalse(client._connected)
client.connect()
self.assertTrue(client._connected)
client.close()
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.SerialIOStream")
@patch("pymodbus.client.asynchronous.tornado.Serial")
def testSerialClientDisconnect(self, mock_serial, mock_seriostream, mock_ioloop):
""" Test the tornado serial client client disconnect """
client = AsyncModbusSerialClient(ioloop=schedulers.IO_LOOP,
framer=ModbusRtuFramer(
ClientDecoder()),
port=SERIAL_PORT)
client.connect()
self.assertTrue(client._connected)
def handle_failure(failure):
self.assertTrue(isinstance(failure.exception(), ConnectionException))
d = client._build_response(0x00)
d.add_done_callback(handle_failure)
client.close()
self.assertFalse(client._connected)
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.SerialIOStream")
@patch("pymodbus.client.asynchronous.tornado.Serial")
def testSerialClientExecute(self, mock_serial, mock_seriostream, mock_ioloop):
""" Test the tornado serial client client execute method """
client = AsyncModbusSerialClient(ioloop=schedulers.IO_LOOP,
framer=ModbusRtuFramer(
ClientDecoder()),
port=SERIAL_PORT)
client.connect()
client.stream = Mock()
client.stream.write = Mock()
request = ReadCoilsRequest(1, 1)
d = client.execute(request)
tid = request.transaction_id
self.assertEqual(d, client.transaction.getTransaction(tid))
@unittest.skip("temporarily disabled")
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.SerialIOStream")
@patch("pymodbus.client.asynchronous.tornado.Serial")
def testSerialClientHandleResponse(self, mock_serial, mock_seriostream, mock_ioloop):
""" Test the tornado serial client client handles responses """
client = AsyncModbusSerialClient(ioloop=schedulers.IO_LOOP,
framer=ModbusRtuFramer(
ClientDecoder()),
port=SERIAL_PORT)
client.connect()
out = []
reply = ReadCoilsRequest(1, 1)
reply.transaction_id = 0x00
# handle skipped cases
client._handle_response(None)
client._handle_response(reply)
# handle existing cases
d = client._build_response(0x00)
d.add_done_callback(lambda v: out.append(v))
client._handle_response(reply)
self.assertEqual(out[0].result(), reply)
@patch("pymodbus.client.asynchronous.tornado.IOLoop")
@patch("pymodbus.client.asynchronous.tornado.SerialIOStream")
@patch("pymodbus.client.asynchronous.tornado.Serial")
def testSerialClientBuildResponse(self, mock_serial, mock_seriostream, mock_ioloop):
""" Test the tornado serial client client builds responses """
client = AsyncModbusSerialClient(ioloop=schedulers.IO_LOOP,
framer=ModbusRtuFramer(
ClientDecoder()),
port=SERIAL_PORT)
self.assertEqual(0, len(list(client.transaction)))
def handle_failure(failure):
exc = failure.exception()
self.assertTrue(isinstance(exc, ConnectionException))
d = client._build_response(0x00)
d.add_done_callback(handle_failure)
self.assertEqual(0, len(list(client.transaction)))
client._connected = True
d = client._build_response(0x00)
self.assertEqual(1, len(list(client.transaction)))
# -----------------------------------------------------------------------#
# Test Udp Client client
# -----------------------------------------------------------------------#
def testUdpClientInit(self):
""" Test the udp client client initialize """
client = AsyncModbusUDPClient()
self.assertEqual(0, len(list(client.transaction)))
self.assertTrue(isinstance(client.framer, ModbusSocketFramer))
framer = object()
client = AsyncModbusUDPClient(framer=framer)
self.assertTrue(framer is client.framer)
# -----------------------------------------------------------------------#
# Test Client Factories
# -----------------------------------------------------------------------#
def testModbusClientFactory(self):
""" Test the base class for all the clients """
factory = ModbusClientFactory()
self.assertTrue(factory is not None)
# ---------------------------------------------------------------------------#
# Main
# ---------------------------------------------------------------------------#
if __name__ == "__main__":
unittest.main()
|
