fix: registered status_reason hook for link liveness

CHANGELOG.rst

@@ -10,6 +10,10 @@ Added
 =====
 - ``LIVENESS_MIN_HELLOS_UP = 2`` is now supported on settings to configure the number of minimum liveness hellos expected before considering ``up``. This is to contribute to stability before considering it ``up``. If ``LIVENESS_MIN_HELLOS_UP = 1`` then it means the old behavior where a single hello received on both ends would transition to ``up``.
 
+Fixed
+=====
+- Registered ``status_reason`` hook for link liveness
+
 [2024.1.0] - 2024-07-23
 ***********************
 

main.py

@@ -47,6 +47,9 @@ def setup(self):
         self.liveness_manager = LivenessManager(self.controller)
         Link.register_status_func(f"{self.napp_id}_liveness",
                                   LivenessManager.link_status_hook_liveness)
+        status_reason_func = LivenessManager.link_status_reason_hook_liveness
+        Link.register_status_reason_func(f"{self.napp_id}_liveness",
+                                         status_reason_func)
         self.table_group = {"base": 0}
 
     @staticmethod

managers/liveness.py

@@ -124,6 +124,13 @@ def link_status_hook_liveness(cls, link) -> Optional[EntityStatus]:
             return EntityStatus.DOWN
         return None
 
+    @classmethod
+    def link_status_reason_hook_liveness(cls, link) -> frozenset[str]:
+        """Link status reason hook liveness."""
+        if cls.link_status_hook_liveness(link) == EntityStatus.DOWN:
+            return frozenset({"liveness"})
+        return frozenset()
+
     def is_enabled(self, *interfaces) -> bool:
         """Check if liveness is enabled on an interface."""
         for interface in interfaces:

tests/unit/test_liveness_manager.py

@@ -188,6 +188,19 @@ def test_link_status_hook_liveness(self, liveness_manager) -> None:
         status = liveness_manager.link_status_hook_liveness(mock_link)
         assert status is None
 
+    def test_link_status_reason_hook_liveness(self, liveness_manager) -> None:
+        """Test link_status_reason_hook_liveness."""
+        mock_link = MagicMock()
+        mock_link.is_active.return_value = True
+        mock_link.is_enabled.return_value = True
+        mock_link.metadata = {"liveness_status": "down"}
+        status = liveness_manager.link_status_reason_hook_liveness(mock_link)
+        assert status == frozenset({"liveness"})
+
+        mock_link.metadata = {"liveness_status": "up"}
+        status = liveness_manager.link_status_reason_hook_liveness(mock_link)
+        assert status == frozenset()
+
     def test_try_to_publish_lsm_event(
         self, liveness_manager, intf_one, intf_two
     ) -> None: