File: test_functions.py

package info (click to toggle)
python-umodbus 1.0.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 456 kB
  • sloc: python: 1,944; makefile: 166; sh: 5
file content (353 lines) | stat: -rw-r--r-- 11,018 bytes parent folder | download
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
import struct
import pytest

try:
    # Mock has been added to stdlib in Python 3.3.
    from unittest.mock import MagicMock, call
except ImportError:
    from mock import MagicMock, call

from umodbus.route import Map
from umodbus.exceptions import (IllegalFunctionError, IllegalDataAddressError,
                                IllegalDataValueError,
                                ServerDeviceFailureError, AcknowledgeError,
                                ServerDeviceBusyError, MemoryParityError,
                                GatewayPathUnavailableError,
                                GatewayTargetDeviceFailedToRespondError)
from umodbus.functions import (create_function_from_response_pdu,
                               create_function_from_request_pdu, ReadCoils,
                               ReadDiscreteInputs, ReadHoldingRegisters,
                               ReadInputRegisters, WriteSingleCoil,
                               WriteSingleRegister, WriteMultipleCoils,
                               WriteMultipleRegisters)


@pytest.fixture
def read_coils():
    instance = ReadCoils()
    instance.starting_address = 100
    instance.quantity = 3

    return instance


@pytest.fixture
def read_discrete_inputs():
    instance = ReadDiscreteInputs()
    instance.starting_address = 0
    instance.quantity = 2

    return instance


@pytest.fixture
def read_holding_registers():
    instance = ReadHoldingRegisters()
    instance.starting_address = 100
    instance.quantity = 4

    return instance


@pytest.fixture
def read_input_registers():
    instance = ReadInputRegisters()
    instance.starting_address = 50
    instance.quantity = 2

    return instance


@pytest.fixture
def write_single_coil():
    instance = WriteSingleCoil()
    instance.address = 100
    instance.value = 1

    return instance


@pytest.fixture
def write_single_register():
    instance = WriteSingleRegister()
    instance.address = 200
    instance.value = 18

    return instance


@pytest.fixture
def write_multiple_coils():
    instance = WriteMultipleCoils()
    instance.starting_address = 100
    instance.values = [1, 0]

    return instance


@pytest.fixture
def write_multiple_registers():
    instance = WriteMultipleRegisters()
    instance.starting_address = 50
    instance.values = [1337, 15, 128]

    return instance


@pytest.fixture
def route_map():
    return Map()


@pytest.mark.parametrize('pdu,cls', [
    (b'\x01\x00d\x00\x03', ReadCoils),
    (b'\x02\x00d\x00\x03', ReadDiscreteInputs),
    (b'\x03\x00d\x00\x03', ReadHoldingRegisters),
    (b'\x04\x00d\x00\x03', ReadInputRegisters),
    (b'\x05\x00d\x00\x00', WriteSingleCoil),
    (b'\x06\x00d\x00\x00', WriteSingleRegister),
    (b'\x0f\x00d\x00\x03\x01\x04', WriteMultipleCoils),
    (b'\x10\x00d\x00\x01\x02\x00\x04', WriteMultipleRegisters),
])
def test_create_function_from_request_pdu(pdu, cls):
    assert isinstance(create_function_from_request_pdu(pdu), cls)


@pytest.mark.parametrize('error_code, exception_class', [
    (1, IllegalFunctionError),
    (2, IllegalDataAddressError),
    (3, IllegalDataValueError),
    (4, ServerDeviceFailureError),
    (5, AcknowledgeError),
    (6, ServerDeviceBusyError),
    (8, MemoryParityError),
    (10, GatewayPathUnavailableError),
    (11, GatewayTargetDeviceFailedToRespondError),
])
def test_create_from_response_pdu_raising_exception(error_code,
                                                    exception_class):
    """ Test if correct exception is raied when response PDU contains error
    response.
    """
    resp_pdu = struct.pack('>BB', 81, error_code)

    with pytest.raises(exception_class):
        create_function_from_response_pdu(resp_pdu)


def test_create_function_from_request_pdu_raising_illegal_function_error():
    """ Calling function with PDU containing invalid function code should result
    in an IllegalFunctionError.
    """
    with pytest.raises(IllegalFunctionError):
        create_function_from_request_pdu(b'\x00')


def test_read_coils_class_attributes():
    assert ReadCoils.function_code == 1
    assert ReadCoils.max_quantity == 2000


def test_read_coils_with_invalid_attributes(read_coils):
    with pytest.raises(IllegalDataValueError):
        read_coils.quantity = 2001


def test_read_coils_request_pdu(read_coils):
    instance = ReadCoils.create_from_request_pdu(read_coils.request_pdu)
    assert instance.starting_address == 100
    assert instance.quantity == 3


def test_read_coils_response_pdu(read_coils):
    response_pdu = read_coils.create_response_pdu([0, 1, 1])
    instance = ReadCoils.create_from_response_pdu(response_pdu, read_coils.request_pdu)  # NOQA

    assert instance.data == [0, 1, 1]


def test_read_discrete_inputs_class_attributes():
    assert ReadDiscreteInputs.function_code == 2
    assert ReadDiscreteInputs.max_quantity == 2000


def test_read_discrete_inputs_with_invalid_attributes(read_discrete_inputs):
    with pytest.raises(IllegalDataValueError):
        read_discrete_inputs.quantity = 2001


def test_read_discrete_inputs_request_pdu(read_discrete_inputs):
    instance = ReadDiscreteInputs.create_from_request_pdu(read_discrete_inputs.request_pdu)  # NOQA
    assert instance.starting_address == 0
    assert instance.quantity == 2


def test_read_discrete_inputs_response_pdu(read_discrete_inputs):
    response_pdu = read_discrete_inputs.create_response_pdu([1, 0])
    instance = ReadDiscreteInputs.create_from_response_pdu(response_pdu, read_discrete_inputs.request_pdu)  # NOQA

    assert instance.data == [1, 0]


def test_read_holding_registers_class_attributes():
    assert ReadHoldingRegisters.function_code == 3
    assert ReadHoldingRegisters.max_quantity == 125


def test_read_holding_registers_with_invalid_attributes(read_holding_registers):  # NOQA
    with pytest.raises(IllegalDataValueError):
        read_holding_registers.quantity = 126


def test_read_holding_registers_request_pdu(read_holding_registers):
    instance = ReadHoldingRegisters.create_from_request_pdu(read_holding_registers.request_pdu)  # NOQA

    assert instance.starting_address == 100
    assert instance.quantity == 4


def test_read_holding_registers_response_pdu(read_holding_registers):
    response_pdu =\
        read_holding_registers.create_response_pdu([1337, 17, 21, 18])

    instance = ReadHoldingRegisters.create_from_response_pdu(response_pdu, read_holding_registers.request_pdu)  # NOQA

    assert instance.data == [1337, 17, 21, 18]


def test_read_input_registers_class_attributes():
    assert ReadInputRegisters.function_code == 4
    assert ReadInputRegisters.max_quantity == 125


def test_read_input_registers_with_invalid_attributes(read_input_registers):  # NOQA
    with pytest.raises(IllegalDataValueError):
        read_input_registers.quantity = 126


def test_read_input_registers_request_pdu(read_input_registers):
    instance = ReadInputRegisters.create_from_request_pdu(read_input_registers.request_pdu)  # NOQA

    assert instance.starting_address == 50
    assert instance.quantity == 2


def test_read_input_registers_response_pdu(read_input_registers):
    response_pdu = read_input_registers.create_response_pdu([994, 1100])
    instance = ReadInputRegisters.create_from_response_pdu(response_pdu, read_input_registers.request_pdu)  # NOQA

    assert instance.data == [994, 1100]


def test_write_single_coil_class_attributes():
    assert WriteSingleCoil.function_code == 5


def test_write_single_coil_with_invalid_attributes(write_single_coil):
    with pytest.raises(IllegalDataValueError):
        write_single_coil.value = 5


def test_write_single_coil_request_pdu(write_single_coil):
    instance = WriteSingleCoil.create_from_request_pdu(write_single_coil.request_pdu)  # NOQA

    assert instance.address == 100
    assert instance.value == 1


def test_write_single_coil_response_pdu(write_single_coil):
    response_pdu = write_single_coil.create_response_pdu()
    instance = WriteSingleCoil.create_from_response_pdu(response_pdu)

    assert instance.address == 100
    assert instance.data == 1


def test_write_single_registers_class_attributes():
    assert WriteSingleRegister.function_code == 6


def test_write_single_register_with_invalid_attributes(write_single_register):
    with pytest.raises(IllegalDataValueError):
        write_single_register.value = -1


def test_write_single_register_request_pdu(write_single_register):
    instance = WriteSingleRegister.create_from_request_pdu(write_single_register.request_pdu)  # NOQA

    assert instance.address == 200
    assert instance.value == 18


def test_write_single_register_response_pdu(write_single_register):
    response_pdu = write_single_register.create_response_pdu()
    instance = WriteSingleRegister.create_from_response_pdu(response_pdu)

    assert instance.address == 200
    assert instance.data == 18


def test_write_multiple_coils_class_attributes():
    WriteMultipleCoils.function_code == 15


def test_write_multiple_coils_invalid_attributes(write_multiple_coils):
    with pytest.raises(IllegalDataValueError):
        write_multiple_coils.values = []

    with pytest.raises(IllegalDataValueError):
        write_multiple_coils.values = [5]


def test_write_multiple_coils_request_pdu(write_multiple_coils):
    instance = WriteMultipleCoils.create_from_request_pdu(write_multiple_coils.request_pdu)  # NOQA

    assert instance.starting_address == 100
    assert instance.values == [1, 0]


def test_write_multiple_coils_response_pdu(write_multiple_coils):
    response_pdu = write_multiple_coils.create_response_pdu()
    instance = WriteMultipleCoils.create_from_response_pdu(response_pdu)

    assert instance.starting_address == 100
    assert instance.data == 2


def test_write_multiple_registers_class_attributes():
    WriteMultipleRegisters.function_code == 16


def test_write_multiple_registers_invalid_attributes(write_multiple_registers):
    with pytest.raises(IllegalDataValueError):
        write_multiple_registers.values = []

    with pytest.raises(IllegalDataValueError):
        write_multiple_registers.values = [-1]


def test_write_multiple_registers_request_pdu(write_multiple_registers):
    instance = WriteMultipleRegisters.create_from_request_pdu(write_multiple_registers.request_pdu)  # NOQA

    assert instance.starting_address == 50
    assert instance.values == [1337, 15, 128]


def test_write_multiple_registers_response_pdu(write_multiple_registers):
    response_pdu = write_multiple_registers.create_response_pdu()
    instance = WriteMultipleRegisters.create_from_response_pdu(response_pdu)

    assert instance.starting_address == 50
    assert instance.data == 3


def test_create_function_from_response_pdu():
    read_coils = ReadCoils()
    read_coils.starting_address = 1
    read_coils.quantity = 9

    req_pdu = read_coils.request_pdu
    resp_pdu = struct.pack('>BBB', 1, 1, 3)

    assert isinstance(create_function_from_response_pdu(resp_pdu, req_pdu),
                      ReadCoils)