Skip to content

Add more framer tests, solve a couple of framer problems. #2024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pymodbus/framer/binary_framer.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def checkFrame(self) -> bool:
self._header["len"] = end
self._header["uid"] = struct.unpack(">B", self._buffer[1:2])[0]
self._header["crc"] = struct.unpack(">H", self._buffer[end - 2 : end])[0]
data = self._buffer[start + 1 : end - 2]
data = self._buffer[1 : end - 2]
return checkCRC(data, self._header["crc"])
return False

Expand Down
15 changes: 8 additions & 7 deletions pymodbus/framer/rtu_framer.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ def getFrameStart(self, slaves, broadcast, skip_cur_frame):
# ----------------------------------------------------------------------- #
# Public Member Functions
# ----------------------------------------------------------------------- #
def frameProcessIncomingPacket(self, single, callback, slave, _tid=None, **kwargs):
def frameProcessIncomingPacket(self, _single, callback, slave, _tid=None, **kwargs):
"""Process new packet pattern."""
broadcast = not slave[0]
skip_cur_frame = False
Expand All @@ -218,12 +218,13 @@ def frameProcessIncomingPacket(self, single, callback, slave, _tid=None, **kwarg
self.resetFrame()
skip_cur_frame = True
continue
if not self._validate_slave_id(slave, single):
header_txt = self._header["uid"]
Log.debug("Not a valid slave id - {}, ignoring!!", header_txt)
self.resetFrame()
skip_cur_frame = True
continue
# handled in getFrameStart
# if not self._validate_slave_id(slave, single):
# header_txt = self._header["uid"]
# Log.debug("Not a valid slave id - {}, ignoring!!", header_txt)
# self.resetFrame()
# skip_cur_frame = True
# continue
self._process(callback)

def buildPacket(self, message):
Expand Down
39 changes: 27 additions & 12 deletions test/test_framers.py
Original file line number Diff line number Diff line change
Expand Up @@ -404,22 +404,32 @@ def test_build_packet(framer, message):
@pytest.mark.parametrize(
("framer", "message"),
[
(ModbusAsciiFramer, b':00010001000AF4\r\n',),
(ModbusBinaryFramer, b'{\x00\x01\x00\x01\x00\n\xec\x1c}',),
(ModbusRtuFramer, b"\x00\x01\x00\x01\x00\n\xec\x1c",),
(ModbusSocketFramer, b'\x00\x00\x00\x00\x00\x06\x00\x01\x00\x01\x00\n',),
(ModbusAsciiFramer, b':01010001000AF3\r\n',),
(ModbusBinaryFramer, b'A{\x01\x01\x00\x01\x00\n\xed\xcd}',),
(ModbusRtuFramer, b"\x01\x01\x03\x01\x00\n\xed\x89",),
(ModbusSocketFramer, b'\x00\x00\x00\x00\x00\x06\x01\x01\x00\x01\x00\n',),
]
)
def test_processincomingpacket(framer, message):
@pytest.mark.parametrize(("slave"), [0x01, 0x02])
def test_processincomingpacket_ok(framer, message, slave):
"""Test processIncomingPacket."""
test_framer = framer(ClientDecoder())
with mock.patch.object(
framer,
"_process",
wraps=test_framer._process, # pylint: disable=protected-access
), mock.patch.object(
test_framer, "resetFrame", wraps=test_framer.resetFrame
):
test_framer.processIncomingPacket(message, mock.Mock(), slave)


@pytest.mark.parametrize(
("framer", "message"),
[
(ModbusAsciiFramer, b':01270001000ACD\r\n',),
(ModbusBinaryFramer, b'{\x01\x1a\x00\x01\x00\n\x89\xcf}',),
(ModbusRtuFramer, b"\x01\x03\x03\x01\x00\n\x94\x49",),
(ModbusSocketFramer, b'\x00\x00\x00\x00\x00\x06\x01\x27\x00\x01\x00\n',),
]
)
def test_processincomingpacket_not_ok(framer, message):
"""Test processIncomingPacket."""
test_framer = framer(ClientDecoder())
with pytest.raises(ModbusIOException):
test_framer.processIncomingPacket(message, mock.Mock(), 0x01)

@pytest.mark.parametrize(
Expand All @@ -440,3 +450,8 @@ def test_decode_data(framer, message, expected):
decoded = test_framer.decode_data(message)
assert decoded["fcode"] == expected["fcode"]
assert decoded["slave"] == expected["slave"]

def test_binary_framer_preflight():
"""Test binary framer _preflight."""
test_framer = ModbusBinaryFramer(ClientDecoder())
assert test_framer._preflight(b'A{B}C') == b'A{{B}}C' # pylint: disable=protected-access