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
|
#!/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.twisted import (
ModbusClientProtocol, ModbusUdpClientProtocol, ModbusSerClientProtocol, ModbusTcpClientProtocol
)
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
#---------------------------------------------------------------------------#
class AsynchronousClientTest(unittest.TestCase):
'''
This is the unittest for the pymodbus.client.asynchronous module
'''
#-----------------------------------------------------------------------#
# Test Client Protocol
#-----------------------------------------------------------------------#
def testClientProtocolInit(self):
''' Test the client protocol initialize '''
protocol = ModbusClientProtocol()
self.assertEqual(0, len(list(protocol.transaction)))
self.assertFalse(protocol._connected)
self.assertTrue(isinstance(protocol.framer, ModbusSocketFramer))
framer = object()
protocol = ModbusClientProtocol(framer=framer)
self.assertEqual(0, len(list(protocol.transaction)))
self.assertFalse(protocol._connected)
self.assertTrue(framer is protocol.framer)
def testClientProtocolConnect(self):
''' Test the client protocol connect '''
decoder = object()
framer = ModbusSocketFramer(decoder)
protocol = ModbusClientProtocol(framer=framer)
self.assertFalse(protocol._connected)
protocol.connectionMade()
self.assertTrue(protocol._connected)
def testClientProtocolDisconnect(self):
''' Test the client protocol disconnect '''
protocol = ModbusClientProtocol()
protocol.connectionMade()
def handle_failure(failure):
self.assertTrue(isinstance(failure.value, ConnectionException))
d = protocol._buildResponse(0x00)
d.addErrback(handle_failure)
self.assertTrue(protocol._connected)
protocol.connectionLost('because')
self.assertFalse(protocol._connected)
def testClientProtocolDataReceived(self):
''' Test the client protocol data received '''
protocol = ModbusClientProtocol(ModbusSocketFramer(ClientDecoder()))
protocol.connectionMade()
out = []
data = b'\x00\x00\x12\x34\x00\x06\xff\x01\x01\x02\x00\x04'
# setup existing request
d = protocol._buildResponse(0x00)
d.addCallback(lambda v: out.append(v))
protocol.dataReceived(data)
self.assertTrue(isinstance(out[0], ReadCoilsResponse))
def testClientProtocolExecute(self):
''' Test the client protocol execute method '''
framer = ModbusSocketFramer(None)
protocol = ModbusClientProtocol(framer=framer)
protocol.connectionMade()
protocol.transport = Mock()
protocol.transport.write = Mock()
request = ReadCoilsRequest(1, 1)
d = protocol.execute(request)
tid = request.transaction_id
self.assertEqual(d, protocol.transaction.getTransaction(tid))
def testClientProtocolHandleResponse(self):
''' Test the client protocol handles responses '''
protocol = ModbusClientProtocol()
protocol.connectionMade()
out = []
reply = ReadCoilsRequest(1, 1)
reply.transaction_id = 0x00
# handle skipped cases
protocol._handleResponse(None)
protocol._handleResponse(reply)
# handle existing cases
d = protocol._buildResponse(0x00)
d.addCallback(lambda v: out.append(v))
protocol._handleResponse(reply)
self.assertEqual(out[0], reply)
def testClientProtocolBuildResponse(self):
''' Test the udp client protocol builds responses '''
protocol = ModbusClientProtocol()
self.assertEqual(0, len(list(protocol.transaction)))
def handle_failure(failure):
self.assertTrue(isinstance(failure.value, ConnectionException))
d = protocol._buildResponse(0x00)
d.addErrback(handle_failure)
self.assertEqual(0, len(list(protocol.transaction)))
protocol._connected = True
d = protocol._buildResponse(0x00)
self.assertEqual(1, len(list(protocol.transaction)))
#-----------------------------------------------------------------------#
# Test TCP Client Protocol
#-----------------------------------------------------------------------#
def testTcpClientProtocolInit(self):
''' Test the udp client protocol initialize '''
protocol = ModbusTcpClientProtocol()
self.assertEqual(0, len(list(protocol.transaction)))
self.assertTrue(isinstance(protocol.framer, ModbusSocketFramer))
framer = object()
protocol = ModbusClientProtocol(framer=framer)
self.assertTrue(framer is protocol.framer)
#-----------------------------------------------------------------------#
# Test Serial Client Protocol
#-----------------------------------------------------------------------#
def testSerialClientProtocolInit(self):
''' Test the udp client protocol initialize '''
protocol = ModbusSerClientProtocol()
self.assertEqual(0, len(list(protocol.transaction)))
self.assertTrue(isinstance(protocol.framer, ModbusRtuFramer))
framer = object()
protocol = ModbusClientProtocol(framer=framer)
self.assertTrue(framer is protocol.framer)
#-----------------------------------------------------------------------#
# Test Udp Client Protocol
#-----------------------------------------------------------------------#
def testUdpClientProtocolInit(self):
''' Test the udp client protocol initialize '''
protocol = ModbusUdpClientProtocol()
self.assertEqual(0, len(list(protocol.transaction)))
self.assertTrue(isinstance(protocol.framer, ModbusSocketFramer))
framer = object()
protocol = ModbusClientProtocol(framer=framer)
self.assertTrue(framer is protocol.framer)
def testUdpClientProtocolDataReceived(self):
''' Test the udp client protocol data received '''
protocol = ModbusUdpClientProtocol()
out = []
data = b'\x00\x00\x12\x34\x00\x06\xff\x01\x01\x02\x00\x04'
server = ('127.0.0.1', 12345)
# setup existing request
d = protocol._buildResponse(0x00)
d.addCallback(lambda v: out.append(v))
protocol.datagramReceived(data, server)
self.assertTrue(isinstance(out[0], ReadCoilsResponse))
def testUdpClientProtocolExecute(self):
''' Test the udp client protocol execute method '''
protocol = ModbusUdpClientProtocol()
protocol.transport = Mock()
protocol.transport.write = Mock()
request = ReadCoilsRequest(1, 1)
d = protocol.execute(request)
tid = request.transaction_id
self.assertEqual(d, protocol.transaction.getTransaction(tid))
def testUdpClientProtocolHandleResponse(self):
''' Test the udp client protocol handles responses '''
protocol = ModbusUdpClientProtocol()
out = []
reply = ReadCoilsRequest(1, 1)
reply.transaction_id = 0x00
# handle skipped cases
protocol._handleResponse(None)
protocol._handleResponse(reply)
# handle existing cases
d = protocol._buildResponse(0x00)
d.addCallback(lambda v: out.append(v))
protocol._handleResponse(reply)
self.assertEqual(out[0], reply)
def testUdpClientProtocolBuildResponse(self):
''' Test the udp client protocol builds responses '''
protocol = ModbusUdpClientProtocol()
self.assertEqual(0, len(list(protocol.transaction)))
d = protocol._buildResponse(0x00)
self.assertEqual(1, len(list(protocol.transaction)))
#-----------------------------------------------------------------------#
# 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()
|
