PTP-notification reports Locked when NIC cgu is holdover and ptp clockClass=7

[Cole Walker]

Brief Description
-----------------
When the GM ptp clock class is 7, ptp-notification should report holdover, but it currently reports locked.

Severity
--------
Provide the severity of the defect.
<Minor: System/Feature is usable with minor issue>

Steps to Reproduce
------------------
Configure ptp4l and ptp-notification
Set the clock class for ptp4l to 7

Expected Behavior
------------------
PTP-notification reports holdover for the duration of the holdover timer

Actual Behavior
----------------
ptp-notification reports locked indefinitely

Reproducibility
---------------
100%

System Configuration
--------------------
Any

Branch/Pull Time/Commit
-----------------------
Stx 6.0 and above

Last Pass
---------
No

Timestamp/Logs
--------------
Attach the logs for debugging (use attachments in Launchpad or for large collect files use: https://files.starlingx.kube.cengn.ca/)
Provide a snippet of logs here and the timestamp when issue was seen.
Please indicate the unique identifier in the logs to highlight the problem

Test Activity
-------------
Feature testing

Workaround
----------
Describe workaround if available

[OpenStack Infra (hudson-openstack)]

Change abandoned by "Cole Walker <email address hidden>" on branch: master
Review: https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/862962
Reason: After having to revert the commit with the original mistake:
https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/862897

I will abandon this and submit one review with the updated launchpad link and the corrections required here.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/863065

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/863065
Committed: https://opendev.org/starlingx/ptp-notification-armada-app/commit/b50b361d9fd3d02f02e1f9b62bf3a00a87141a57
Submitter: "Zuul (22348)"
Branch: master

commit b50b361d9fd3d02f02e1f9b62bf3a00a87141a57
Author: Cole Walker <email address hidden>
Date: Fri Oct 28 15:29:36 2022 -0400

    [PTP] No longer consider clockClass 7 and 135 as locked

    PTP-notification was treating clockClass values 7 and 135 as indicators
    of a locked status, which is incorrect as per ITU-T G.8275.1. This was
    resulting in ptp-notification delivering locked status to clients when
    it should instead be transitioning to holdover/freerun.

    Removed clockClass 7 and 135 from the list of valid locked clockClasses.
    PTP-notification is now able to properly transition states when these
    classes are observed.

    Test plan:
    PASS: Build and deploy image
    PASS: Verify correct state transitions when clockClass 6, 7, 135 are
    observed

    Partial-Bug: 1995014

    Signed-off-by: Cole Walker <email address hidden>
    Change-Id: If68df991c3d6555f09e19a0d11f2c71e077c2587

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: r/stx.6.0
Review: https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/862995

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/862995
Committed: https://opendev.org/starlingx/ptp-notification-armada-app/commit/b526c992f5e8e4e2317311ddc2ee177c3019085a
Submitter: "Zuul (22348)"
Branch: r/stx.6.0

commit b526c992f5e8e4e2317311ddc2ee177c3019085a
Author: Cole Walker <email address hidden>
Date: Fri Oct 28 15:29:36 2022 -0400

    [PTP] No longer consider clockClass 7 and 135 as locked

    PTP-notification was treating clockClass values 7 and 135 as indicators
    of a locked status, which is incorrect as per ITU-T G.8275.1. This was
    resulting in ptp-notification delivering locked status to clients when
    it should instead be transitioning to holdover/freerun.

    Removed clockClass 7 and 135 from the list of valid locked clockClasses.
    PTP-notification is now able to properly transition states when these
    classes are observed.

    This cherry-pick has been ported to r/stx6.0 which required altering the
    file paths from the original commit to fit the structure on this branch.

    Test plan:
    PASS: Build and deploy image
    PASS: Verify correct state transitions when clockClass 6, 7, 135 are
    observed

    Partial-Bug: 1995014

    Signed-off-by: Cole Walker <email address hidden>
    Change-Id: If68df991c3d6555f09e19a0d11f2c71e077c2587
    (cherry picked from commit b50b361d9fd3d02f02e1f9b62bf3a00a87141a57)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: r/stx.6.0
Review: https://review.opendev.org/c/starlingx/root/+/864064

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: r/stx.6.0
Review: https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/864136

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/864136
Committed: https://opendev.org/starlingx/ptp-notification-armada-app/commit/f9b7d9a20dce24470edca80a8d77db52bcb8bc58
Submitter: "Zuul (22348)"
Branch: r/stx.6.0

commit f9b7d9a20dce24470edca80a8d77db52bcb8bc58
Author: Cole Walker <email address hidden>
Date: Wed Nov 9 13:19:38 2022 -0500

    [PTP] Update notificationservice-base image version

    Update the notificationservice-base container image version to
    stx6.0-v1.0.7.

    Closes-bug: 1995014

    Signed-off-by: Cole Walker <email address hidden>
    Change-Id: I237029b59920d73c13a6872d5760427b30032a27

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/root/+/864064
Committed: https://opendev.org/starlingx/root/commit/3ad8181890e8c227716f4691f8a55573b11ce57e
Submitter: "Zuul (22348)"
Branch: r/stx.6.0

commit 3ad8181890e8c227716f4691f8a55573b11ce57e
Author: Cole Walker <email address hidden>
Date: Tue Nov 8 16:18:13 2022 -0500

    Update image tag for notificationservice-base image

    This commit updates the image tag for:

    notificationservice-base
    stx.6.0-v1.0.7

    Partial-bug: 1995014

    Signed-off-by: Cole Walker <email address hidden>
    Change-Id: I855e91dce3d926cddeafad5d47bca8f4e9ec942b

[Ghada Khalil (gkhalil)]

Marking as Fix Released. The image tagging in the main branch will be covered by the transition to Debian images tracked by: https://storyboard.openstack.org/#!/story/2009831