starlingx/ptp-notification-armada-app
Code Issues Proposed changes

Handle old NMEA serial port name format

Browse Source 
During an upgrade, or due a missconfiguration the ts2phc NMEA port
can be configured in the old name format, tty_GNSS_xxxx_x. Handling
the old name format to avoid crashes an ptp-notification missbehavior.

A new unit test case was created to cover this case.

Test plan:
PASS: Verify helm chart and container build
PASS: Verify ptp-notification deployment using old configuration.
PASS: Verify ptp-notification deployment and basic operation
using new configuration.
PASS: Verify unit tests.

Story: 2011056
Task: 51051

Change-Id: I5bc28cb04241684de52834e9819e8401677f05dd
Signed-off-by: Andre Mauricio Zelak <andre.zelak@windriver.com>
This commit is contained in:
Andre Mauricio Zelak 2024-09-19 21:22:50 -03:00
parent b8fa66daa5
commit a63f4d31a2
3 changed files with 44 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
notificationservice-base-v2/docker/ptptrackingfunction/trackingfunctionsdk/common/helpers/cgu_handler.py
View File

@ -1,5 +1,5 @@
# #
# Copyright (c) 2022-2023 Wind River Systems, Inc. # Copyright (c) 2022-2024 Wind River Systems, Inc.
# #
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# #
@ -65,16 +65,17 @@ class CguHandler:
def get_cgu_path_from_pci_addr(self): def get_cgu_path_from_pci_addr(self):
# Search for a cgu file using the given pci address # Search for a cgu file using the given pci address
cgu_path = "/ice/ice/" + self.pci_addr + "/cgu" if self.pci_addr:
if os.path.exists(cgu_path): cgu_path = "/ice/ice/" + self.pci_addr + "/cgu"
LOG.debug("PCI address %s has cgu path %s" % if os.path.exists(cgu_path):
(self.pci_addr, cgu_path)) LOG.debug("PCI address %s has cgu path %s" %
self.cgu_path = cgu_path (self.pci_addr, cgu_path))
return self.cgu_path = cgu_path
else: return
LOG.error("Could not find cgu path for PCI address %s" % else:
self.pci_addr) LOG.error("Could not find cgu path for PCI address %s" %
raise FileNotFoundError self.pci_addr)
raise FileNotFoundError
def read_cgu(self): def read_cgu(self):
# Read a given cgu path and return the output in a parseable structure # Read a given cgu path and return the output in a parseable structure

8
notificationservice-base-v2/docker/ptptrackingfunction/trackingfunctionsdk/tests/test_cgu_handler.py
View File

@ -1,5 +1,5 @@
# #
# Copyright (c) 2022-2023 Wind River Systems, Inc. # Copyright (c) 2022-2024 Wind River Systems, Inc.
# #
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# #
@ -15,6 +15,7 @@ class CguHandlerTests(unittest.TestCase):
testCguHandler = CguHandler(testpath + "test_input_files/ts2phc_valid.conf") testCguHandler = CguHandler(testpath + "test_input_files/ts2phc_valid.conf")
missingCguHandler = CguHandler("./no_such_file.conf") missingCguHandler = CguHandler("./no_such_file.conf")
invalidCguHandler = CguHandler(testpath + "test_input_files/ts2phc_invalid.conf") invalidCguHandler = CguHandler(testpath + "test_input_files/ts2phc_invalid.conf")
oldConfigCguHandler = CguHandler(testpath + "test_input_files/ts2phc_old.conf")
def test_get_gnss_nmea_serialport(self): def test_get_gnss_nmea_serialport(self):
# Test success path # Test success path
@ -57,6 +58,11 @@ class CguHandlerTests(unittest.TestCase):
self.testCguHandler.get_cgu_path_from_pci_addr() self.testCguHandler.get_cgu_path_from_pci_addr()
self.assertEqual(self.testCguHandler.cgu_path, "/ice/ice/0000:18:00.0/cgu") self.assertEqual(self.testCguHandler.cgu_path, "/ice/ice/0000:18:00.0/cgu")
self.oldConfigCguHandler.get_gnss_nmea_serialport_from_ts2phc_config()
self.oldConfigCguHandler.convert_nmea_serialport_to_pci_addr()
self.oldConfigCguHandler.get_cgu_path_from_pci_addr()
self.assertEqual(self.oldConfigCguHandler.cgu_path, None)
mock_path.exists.return_value = False mock_path.exists.return_value = False
with self.assertRaises(FileNotFoundError): with self.assertRaises(FileNotFoundError):
self.testCguHandler.get_cgu_path_from_pci_addr() self.testCguHandler.get_cgu_path_from_pci_addr()

25
notificationservice-base-v2/docker/ptptrackingfunction/trackingfunctionsdk/tests/test_input_files/ts2phc_old.conf Normal file
View File

@ -0,0 +1,25 @@
[global]
##
## Default Data Set
##
leapfile /usr/share/zoneinfo/leap-seconds.list
logging_level 7
ts2phc.nmea_serialport /dev/tty_GNSS_5100_0
ts2phc.pulsewidth 100000000
[ens1f0]
##
## Associated interface: oam0
##
ts2phc.extts_polarity rising
[ens2f0]
##
## Associated interface: data0
##
ts2phc.extts_polarity rising