trx_toolkit/data_dump.py: fix return value of parse_msg()

Jenkins build #2516 has uncovered a problem in DATADumpFile.parse_msg():

  ======================================================================
  FAIL: test_parse_empty (test_data_dump.DATADump_Test)
  ----------------------------------------------------------------------
  Traceback (most recent call last):
    File "/build/src/target/trx_toolkit/test_data_dump.py",
         line 138, in test_parse_empty
      self.assertEqual(msg, False)
  AssertionError: None != False

I did a quick investigation, and figured out that this failure
happens when trying to call parse_msg() with idx == 0, because
DATADumpFile._seek2msg() basically does nothing in this case
and thus always returns True. The None itself comes from
DATADumpFile._parse_msg().

Let's ensure that DATADumpFile.parse_msg() always returns None,
even if DATADumpFile._seek2msg() fails. Also, update the unit
test, so we always test a wide range of 'idx' values.

Change-Id: Ifcfa9c5208636a0f9309f5ba8e47d282dc6a03f4
This commit is contained in:
Vadim Yanitskiy 2020-05-22 18:13:51 +07:00
parent 4f677e6ba8
commit 0a6e083e8a
2 changed files with 6 additions and 6 deletions

View File

@ -158,14 +158,14 @@ class DATADumpFile(DATADump):
# Parses a particular message defined by index idx
# Return value:
# a parsed message in case of success,
# or None in case of EOF or header parsing error,
# or False in case of message parsing error or out of range.
# or None in case of EOF, out of range, or header parsing error,
# or False in case of message parsing error.
def parse_msg(self, idx):
# Move descriptor to the beginning of requested message
rc = self._seek2msg(idx)
if not rc:
log.error("Couldn't find requested message")
return False
return None
# Attempt to parse a message
return self._parse_msg()

View File

@ -133,9 +133,9 @@ class DATADump_Test(unittest.TestCase):
def test_parse_empty(self):
with self.assertLogs(level = 'ERROR'):
idx = random.randrange(100)
msg = self._ddf.parse_msg(idx)
self.assertEqual(msg, False)
for idx in range(100):
msg = self._ddf.parse_msg(idx)
self.assertEqual(msg, None)
def test_parse_all_empty(self):
msg_list = self._ddf.parse_all()