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
|
#!/usr/bin/env python
import unittest
from pymodbus.device import *
from pymodbus.events import ModbusEvent, RemoteReceiveEvent
from pymodbus.constants import DeviceInformation
#---------------------------------------------------------------------------#
# Fixture
#---------------------------------------------------------------------------#
class SimpleDataStoreTest(unittest.TestCase):
'''
This is the unittest for the pymodbus.device module
'''
#-----------------------------------------------------------------------#
# Setup/TearDown
#-----------------------------------------------------------------------#
def setUp(self):
self.info = {
0x00: 'Bashwork', # VendorName
0x01: 'PTM', # ProductCode
0x02: '1.0', # MajorMinorRevision
0x03: 'http://internets.com', # VendorUrl
0x04: 'pymodbus', # ProductName
0x05: 'bashwork', # ModelName
0x06: 'unittest', # UserApplicationName
0x07: 'x', # reserved
0x08: 'x', # reserved
0x10: 'reserved', # reserved
0x80: 'custom1', # device specific start
0x82: 'custom2', # device specific
0xFF: 'customlast', # device specific last
}
self.ident = ModbusDeviceIdentification(self.info)
self.control = ModbusControlBlock()
self.access = ModbusAccessControl()
self.control.reset()
def tearDown(self):
''' Cleans up the test environment '''
del self.ident
del self.control
del self.access
def testUpdateIdentity(self):
''' Test device identification reading '''
self.control.Identity.update(self.ident)
self.assertEqual(self.control.Identity.VendorName, 'Bashwork')
self.assertEqual(self.control.Identity.ProductCode, 'PTM')
self.assertEqual(self.control.Identity.MajorMinorRevision, '1.0')
self.assertEqual(self.control.Identity.VendorUrl, 'http://internets.com')
self.assertEqual(self.control.Identity.ProductName, 'pymodbus')
self.assertEqual(self.control.Identity.ModelName, 'bashwork')
self.assertEqual(self.control.Identity.UserApplicationName, 'unittest')
def testDeviceInformationFactory(self):
''' Test device identification reading '''
self.control.Identity.update(self.ident)
result = DeviceInformationFactory.get(self.control, DeviceInformation.Specific, 0x00)
self.assertEqual(result[0x00], 'Bashwork')
result = DeviceInformationFactory.get(self.control, DeviceInformation.Basic, 0x00)
self.assertEqual(result[0x00], 'Bashwork')
self.assertEqual(result[0x01], 'PTM')
self.assertEqual(result[0x02], '1.0')
result = DeviceInformationFactory.get(self.control, DeviceInformation.Regular, 0x00)
self.assertEqual(result[0x00], 'Bashwork')
self.assertEqual(result[0x01], 'PTM')
self.assertEqual(result[0x02], '1.0')
self.assertEqual(result[0x03], 'http://internets.com')
self.assertEqual(result[0x04], 'pymodbus')
self.assertEqual(result[0x05], 'bashwork')
self.assertEqual(result[0x06], 'unittest')
def testDeviceInformationFactoryLookup(self):
result = DeviceInformationFactory.get(self.control, DeviceInformation.Basic, 0x00)
self.assertEqual(sorted(result.keys()), [0x00, 0x01, 0x02])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Basic, 0x02)
self.assertEqual(sorted(result.keys()), [0x02])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Regular, 0x00)
self.assertEqual(sorted(result.keys()), [0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Regular, 0x01)
self.assertEqual(sorted(result.keys()), [0x01, 0x02, 0x03, 0x04, 0x05, 0x06])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Regular, 0x05)
self.assertEqual(sorted(result.keys()), [0x05, 0x06])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Extended, 0x00)
self.assertEqual(sorted(result.keys()), [0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x80, 0x82, 0xFF])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Extended, 0x02)
self.assertEqual(sorted(result.keys()), [0x02, 0x03, 0x04, 0x05, 0x06, 0x80, 0x82, 0xFF])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Extended, 0x06)
self.assertEqual(sorted(result.keys()), [0x06, 0x80, 0x82, 0xFF])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Extended, 0x80)
self.assertEqual(sorted(result.keys()), [0x80, 0x82, 0xFF])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Extended, 0x82)
self.assertEqual(sorted(result.keys()), [0x82, 0xFF])
result = DeviceInformationFactory.get(self.control, DeviceInformation.Extended, 0x81)
self.assertEqual(sorted(result.keys()), [0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x80, 0x82, 0xFF])
def testBasicCommands(self):
''' Test device identification reading '''
self.assertEqual(str(self.ident), "DeviceIdentity")
self.assertEqual(str(self.control), "ModbusControl")
def testModbusDeviceIdentificationGet(self):
''' Test device identification reading '''
self.assertEqual(self.ident[0x00], 'Bashwork')
self.assertEqual(self.ident[0x01], 'PTM')
self.assertEqual(self.ident[0x02], '1.0')
self.assertEqual(self.ident[0x03], 'http://internets.com')
self.assertEqual(self.ident[0x04], 'pymodbus')
self.assertEqual(self.ident[0x05], 'bashwork')
self.assertEqual(self.ident[0x06], 'unittest')
self.assertNotEqual(self.ident[0x07], 'x')
self.assertNotEqual(self.ident[0x08], 'x')
self.assertNotEqual(self.ident[0x10], 'reserved')
self.assertEqual(self.ident[0x54], '')
def testModbusDeviceIdentificationSummary(self):
''' Test device identification summary creation '''
summary = sorted(self.ident.summary().values())
expected = sorted(list(self.info.values())[:0x07]) # remove private
self.assertEqual(summary, expected)
def testModbusDeviceIdentificationSet(self):
''' Test a device identification writing '''
self.ident[0x07] = 'y'
self.ident[0x08] = 'y'
self.ident[0x10] = 'public'
self.ident[0x54] = 'testing'
self.assertNotEqual('y', self.ident[0x07])
self.assertNotEqual('y', self.ident[0x08])
self.assertEqual('public', self.ident[0x10])
self.assertEqual('testing', self.ident[0x54])
def testModbusControlBlockAsciiModes(self):
''' Test a server control block ascii mode '''
self.assertEqual(id(self.control), id(ModbusControlBlock()))
self.control.Mode = 'RTU'
self.assertEqual('RTU', self.control.Mode)
self.control.Mode = 'FAKE'
self.assertNotEqual('FAKE', self.control.Mode)
def testModbusControlBlockCounters(self):
''' Tests the MCB counters methods '''
self.assertEqual(0x0, self.control.Counter.BusMessage)
for _ in range(10):
self.control.Counter.BusMessage += 1
self.control.Counter.SlaveMessage += 1
self.assertEqual(10, self.control.Counter.BusMessage)
self.control.Counter.BusMessage = 0x00
self.assertEqual(0, self.control.Counter.BusMessage)
self.assertEqual(10, self.control.Counter.SlaveMessage)
self.control.Counter.reset()
self.assertEqual(0, self.control.Counter.SlaveMessage)
def testModbusControlBlockUpdate(self):
''' Tests the MCB counters upate methods '''
values = {'SlaveMessage':5, 'BusMessage':5}
self.control.Counter.BusMessage += 1
self.control.Counter.SlaveMessage += 1
self.control.Counter.update(values)
self.assertEqual(6, self.control.Counter.SlaveMessage)
self.assertEqual(6, self.control.Counter.BusMessage)
def testModbusControlBlockIterator(self):
''' Tests the MCB counters iterator '''
self.control.Counter.reset()
for _,count in self.control:
self.assertEqual(0, count)
def testModbusCountersHandlerIterator(self):
''' Tests the MCB counters iterator '''
self.control.Counter.reset()
for _,count in self.control.Counter:
self.assertEqual(0, count)
def testModbusControlBlockCounterSummary(self):
''' Tests retrieving the current counter summary '''
self.assertEqual(0x00, self.control.Counter.summary())
for _ in range(10):
self.control.Counter.BusMessage += 1
self.control.Counter.SlaveMessage += 1
self.control.Counter.SlaveNAK += 1
self.control.Counter.BusCharacterOverrun += 1
self.assertEqual(0xa9, self.control.Counter.summary())
self.control.Counter.reset()
self.assertEqual(0x00, self.control.Counter.summary())
def testModbusControlBlockListen(self):
''' Tests the MCB listen flag methods '''
self.control.ListenOnly = False
self.assertEqual(self.control.ListenOnly, False)
self.control.ListenOnly = not self.control.ListenOnly
self.assertEqual(self.control.ListenOnly, True)
def testModbusControlBlockDelimiter(self):
''' Tests the MCB delimiter setting methods '''
self.control.Delimiter = b'\r'
self.assertEqual(self.control.Delimiter, b'\r')
self.control.Delimiter = '='
self.assertEqual(self.control.Delimiter, b'=')
self.control.Delimiter = 61
self.assertEqual(self.control.Delimiter, b'=')
def testModbusControlBlockDiagnostic(self):
''' Tests the MCB delimiter setting methods '''
self.assertEqual([False] * 16, self.control.getDiagnosticRegister())
for i in [1,3,4,6]:
self.control.setDiagnostic({i:True});
self.assertEqual(True, self.control.getDiagnostic(1))
self.assertEqual(False, self.control.getDiagnostic(2))
actual = [False, True, False, True, True, False, True] + [False] * 9
self.assertEqual(actual, self.control.getDiagnosticRegister())
for i in range(16):
self.control.setDiagnostic({i:False});
def testModbusControlBlockInvalidDiagnostic(self):
''' Tests querying invalid MCB counters methods '''
self.assertEqual(None, self.control.getDiagnostic(-1))
self.assertEqual(None, self.control.getDiagnostic(17))
self.assertEqual(None, self.control.getDiagnostic(None))
self.assertEqual(None, self.control.getDiagnostic([1,2,3]))
def testAddRemoveSingleClients(self):
''' Test adding and removing a host '''
self.assertFalse(self.access.check("192.168.1.1"))
self.access.add("192.168.1.1")
self.assertTrue(self.access.check("192.168.1.1"))
self.access.add("192.168.1.1")
self.access.remove("192.168.1.1")
self.assertFalse(self.access.check("192.168.1.1"))
def testAddRemoveMultipleClients(self):
''' Test adding and removing a host '''
clients = ["192.168.1.1", "192.168.1.2", "192.168.1.3"]
self.access.add(clients)
for host in clients:
self.assertTrue(self.access.check(host))
self.access.remove(clients)
def testNetworkAccessListIterator(self):
''' Test adding and removing a host '''
clients = ["127.0.0.1", "192.168.1.1", "192.168.1.2", "192.168.1.3"]
self.access.add(clients)
for host in self.access:
self.assertTrue(host in clients)
for host in clients:
self.assertTrue(host in self.access)
def testClearingControlEvents(self):
''' Test adding and clearing modbus events '''
self.assertEqual(self.control.Events, [])
event = ModbusEvent()
self.control.addEvent(event)
self.assertEqual(self.control.Events, [event])
self.assertEqual(self.control.Counter.Event, 1)
self.control.clearEvents()
self.assertEqual(self.control.Events, [])
self.assertEqual(self.control.Counter.Event, 1)
def testRetrievingControlEvents(self):
''' Test adding and removing a host '''
self.assertEqual(self.control.Events, [])
event = RemoteReceiveEvent()
self.control.addEvent(event)
self.assertEqual(self.control.Events, [event])
packet = self.control.getEvents()
self.assertEqual(packet, b'\x40')
def testModbusPlusStatistics(self):
''' Test device identification reading '''
default = [0x0000] * 55
statistics = ModbusPlusStatistics()
self.assertEqual(default, statistics.encode())
statistics.reset()
self.assertEqual(default, statistics.encode())
self.assertEqual(default, self.control.Plus.encode())
def testModbusPlusStatisticsHelpers(self):
''' Test modbus plus statistics helper methods '''
statistics = ModbusPlusStatistics()
summary = [
[0],[0],[0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0],[0,0],[0],
[0,0,0,0,0,0,0,0],[0],[0],[0],[0],[0,0],[0],[0],[0],[0],
[0],[0],[0],[0,0],[0],[0],[0],[0],[0,0,0,0,0,0,0,0],[0],
[0,0,0,0,0,0,0,0],[0,0],[0],[0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0],[0],[0],[0,0],[0],[0],[0],[0],[0,0],
[0],[0],[0],[0],[0],[0,0],[0],[0,0,0,0,0,0,0,0]]
stats_summary = [x for x in statistics.summary()]
self.assertEqual(sorted(summary), sorted(stats_summary))
self.assertEqual(0x00, sum(sum(value[1]) for value in statistics))
#---------------------------------------------------------------------------#
# Main
#---------------------------------------------------------------------------#
if __name__ == "__main__":
unittest.main()
|
