snmpagent: modify entities to include fans under fabric module (#349)

With Modular Chassis, fans need not be present just in the fan drawers, but also
in fabric modules. Currently, fan and sensor information of fabric modules is
not accessible via SNMP. This patch set fixes that problem.

- What I did

Essentially, make fans under fabric modules accessible in a way we currently
access fans under fan drawers.

- How I did it

Added a new cache updater, which keeps track of all the fans under fabric modules,
so that they can be queried via SNMP.

- How to verify it

SNMP walk of chassis should display the fan information, if any, present under fabric
modules.

Added a unit test and also tested these changes manually on Internal machines.

- Description for the changelog

Other PR's of interest for this change: sonic-net/sonic-platform-daemons#601, sonic-net/sonic-mgmt#17686.

Author: ymd-arista

src/sonic_ax_impl/mibs/__init__.py

@@ -96,6 +96,12 @@ def psu_info_table(psu_name):
 
     return "PSU_INFO" + TABLE_NAME_SEPARATOR_VBAR + psu_name
 
+def chassis_module_table(module_name):
+    """
+    :param module_name: module name
+    :return chassis module table entry for this module
+    """
+    return "CHASSIS_MODULE_TABLE" + TABLE_NAME_SEPARATOR_VBAR + module_name
 
 def physical_entity_info_table(name):
     """

src/sonic_ax_impl/mibs/ietf/physical_entity_sub_oid_generator.py

@@ -16,6 +16,7 @@
 2 - Management
 5 - Fan Drawer
 6 - PSU
+7 - Fabric Card
 Device Type describes below:
 01 - PS
 02 - Fan
@@ -53,6 +54,7 @@
 MODULE_TYPE_MGMT = 2 * MODULE_TYPE_MULTIPLE
 MODULE_TYPE_FAN_DRAWER = 5 * MODULE_TYPE_MULTIPLE
 MODULE_TYPE_PSU = 6 * MODULE_TYPE_MULTIPLE
+MODULE_TYPE_FABRIC_CARD = 7 * MODULE_TYPE_MULTIPLE
 MODULE_TYPE_PORT = 1000000000
 
 # Device Type Definition
@@ -120,6 +122,15 @@ def get_fan_drawer_sub_id(position):
     """
     return (MODULE_TYPE_FAN_DRAWER + position * MODULE_INDEX_MULTIPLE, )
 
+def get_fabric_card_sub_id(position):
+    """
+    Returns sub OID for fabric card. Sub OID is calculated as follows:
+    sub OID = MODULE_TYPE_FABRIC_CARD + position * MODULE_INDEX_MULTIPLE
+    :param position: fabric card position
+    :return: sub OID of the fabric card
+    """
+    return (MODULE_TYPE_FABRIC_CARD + position * MODULE_INDEX_MULTIPLE, )
+
 def get_fan_tachometers_sub_id(parent_id):
     """
     Returns sub OID for fan tachometers. Sub OID is calculated as follows:

src/sonic_ax_impl/mibs/ietf/rfc2737.py

@@ -18,6 +18,7 @@
 from .physical_entity_sub_oid_generator import get_fan_drawer_sub_id
 from .physical_entity_sub_oid_generator import get_fan_tachometers_sub_id
 from .physical_entity_sub_oid_generator import get_psu_sub_id
+from .physical_entity_sub_oid_generator import get_fabric_card_sub_id
 from .physical_entity_sub_oid_generator import get_psu_sensor_sub_id
 from .physical_entity_sub_oid_generator import get_transceiver_sub_id
 from .physical_entity_sub_oid_generator import get_transceiver_sensor_sub_id
@@ -928,6 +929,48 @@ def _update_psu_sensor_cache(self, psu_name, psu_sub_id, sensor_name):
         self.mib_updater.set_phy_contained_in(psu_current_sub_id, psu_sub_id)
         self.mib_updater.set_phy_fru(psu_current_sub_id, False)
 
+@physical_entity_updater()
+class FabricCardCacheUpdater(PhysicalEntityCacheUpdater):
+    KEY_PATTERN = mibs.chassis_module_table("FABRIC-CARD*")
+
+    def __init__(self, mib_updater):
+        super(FabricCardCacheUpdater, self).__init__(mib_updater)
+
+    def get_key_pattern(self):
+        return FabricCardCacheUpdater.KEY_PATTERN
+
+    def _update_entity_cache(self, fc_name):
+        fc_info = Namespace.dbs_get_all(self.mib_updater.statedb, mibs.STATE_DB,
+                                         mibs.chassis_module_table(fc_name))
+
+        if not fc_info:
+            return
+
+        model, presence, serial, replaceable = get_db_data(fc_info, FanDrawerInfoDB)
+        if presence.lower() != 'true':
+            self._remove_entity_cache(fc_name)
+            return
+
+        fc_relation_info = self.get_physical_relation_info(fc_name)
+        if fc_relation_info:
+            fc_position, fc_parent_name = get_db_data(fc_relation_info, PhysicalRelationInfoDB)
+            fc_position = int(fc_position)
+            fc_sub_id = get_fabric_card_sub_id(fc_position)
+            self._add_entity_related_oid(fc_name, fc_sub_id)
+            self.mib_updater.update_name_to_oid_map(fc_name, fc_sub_id)
+
+            # add fabric card to available OID list
+            self.mib_updater.add_sub_id(fc_sub_id)
+            self.mib_updater.set_phy_class(fc_sub_id, PhysicalClass.MODULE)
+            self.mib_updater.set_phy_descr(fc_sub_id, fc_name)
+            self.mib_updater.set_phy_name(fc_sub_id, fc_name)
+            self.mib_updater.set_phy_parent_relative_pos(fc_sub_id, fc_position)
+            self.mib_updater.set_phy_contained_in(fc_sub_id, fc_parent_name)
+            if model and not is_null_str(model):
+                self.mib_updater.set_phy_model_name(fc_sub_id, model)
+            if serial and not is_null_str(serial):
+                self.mib_updater.set_phy_serial_num(fc_sub_id, serial)
+            self.mib_updater.set_phy_fru(fc_sub_id, replaceable)
 
 @physical_entity_updater()
 class FanDrawerCacheUpdater(PhysicalEntityCacheUpdater):

src/sonic_ax_impl/mibs/ietf/rfc3433.py

@@ -14,6 +14,7 @@
 from .physical_entity_sub_oid_generator import get_transceiver_sensor_sub_id
 from .physical_entity_sub_oid_generator import get_fan_drawer_sub_id
 from .physical_entity_sub_oid_generator import get_fan_sub_id
+from .physical_entity_sub_oid_generator import get_fabric_card_sub_id
 from .physical_entity_sub_oid_generator import get_fan_tachometers_sub_id
 from .physical_entity_sub_oid_generator import get_psu_sub_id
 from .physical_entity_sub_oid_generator import get_psu_sensor_sub_id
@@ -23,6 +24,7 @@
 NOT_AVAILABLE = 'N/A'
 CHASSIS_NAME_SUB_STRING = 'chassis'
 PSU_NAME_SUB_STRING = 'PSU'
+FABRIC_CARD_NAME_SUB_STRING = 'FABRIC-CARD'
 RJ45_PORT_TYPE = 'RJ45'
 
 def is_null_empty_str(value):
@@ -536,6 +538,8 @@ def update_fan_sensor_data(self):
 
                     if PSU_NAME_SUB_STRING in fan_parent_name:
                         fan_parent_sub_id = get_psu_sub_id(fan_parent_position)
+                    elif FABRIC_CARD_NAME_SUB_STRING in fan_parent_name:
+                        fan_parent_sub_id = get_fabric_card_sub_id(fan_parent_position)
                     else:
                         fan_parent_sub_id = get_fan_drawer_sub_id(fan_parent_position)
                 else:

tests/test_rfc2737.py

@@ -4,7 +4,7 @@
 
 import pytest
 from sonic_ax_impl.mibs.ietf.rfc2737 import PhysicalTableMIBUpdater
-
+from sonic_ax_impl.mibs.ietf.rfc2737 import FabricCardCacheUpdater
 
 if sys.version_info.major == 3:
     from unittest import mock
@@ -30,13 +30,15 @@ def test_PhysicalTableMIBUpdater_exception_in_reinit_data_wont_block_reinit_iter
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FanDrawerCacheUpdater.reinit_data') as mocked_fan_drawer_reinit_data,
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FanCacheUpdater.reinit_data') as mocked_fan_cache_reinit_data,
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.ThermalCacheUpdater.reinit_data') as mocked_thermal_reinit_data,
+              mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FabricCardCacheUpdater.reinit_data') as mocked_fc_reinit_data,
               mock.patch('sonic_ax_impl.mibs.cancel_redis_pubsub') as mocked_cancel_redis_pubsub):
             updater.reinit_data()
             mocked_xcvr_reinit_data.assert_called()
             mocked_psu_reinit_data.assert_called()
             mocked_fan_drawer_reinit_data.assert_called()
             mocked_fan_cache_reinit_data.assert_called()
             mocked_thermal_reinit_data.assert_called()
+            mocked_fc_reinit_data.assert_called()
             mocked_cancel_redis_pubsub.assert_called()
         assert str(excinfo.value) == "[Exception('mocked error')]"
 
@@ -53,13 +55,15 @@ def test_PhysicalTableMIBUpdater_exception_in_reinit_data_wont_block_reinit_iter
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.PsuCacheUpdater.reinit_data') as mocked_psu_reinit_data,
               mock.patch(
                   'sonic_ax_impl.mibs.ietf.rfc2737.FanDrawerCacheUpdater.reinit_data') as mocked_fan_drawer_reinit_data,
+              mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FabricCardCacheUpdater.reinit_data') as mocked_fc_reinit_data,
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FanCacheUpdater.reinit_data') as mocked_fan_cache_reinit_data,
               mock.patch('sonic_ax_impl.mibs.cancel_redis_pubsub') as mocked_cancel_redis_pubsub):
             updater.reinit_data()
             mocked_xcvr_reinit_data.assert_called()
             mocked_psu_reinit_data.assert_called()
             mocked_fan_drawer_reinit_data.assert_called()
             mocked_fan_cache_reinit_data.assert_called()
+            mocked_fc_reinit_data.assert_called()
             mocked_thermal_reinit_data.assert_called()
             mocked_cancel_redis_pubsub.assert_called()
         assert str(excinfo.value) == "[Exception('mocked error')]"
@@ -79,13 +83,15 @@ def test_PhysicalTableMIBUpdater_runtime_exc_in_reinit_data_wont_block_reinit_it
                   'sonic_ax_impl.mibs.ietf.rfc2737.FanDrawerCacheUpdater.reinit_data') as mocked_fan_drawer_reinit_data,
               mock.patch(
                   'sonic_ax_impl.mibs.ietf.rfc2737.FanCacheUpdater.reinit_data') as mocked_fan_cache_reinit_data,
+              mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FabricCardCacheUpdater.reinit_data') as mocked_fc_reinit_data,
               mock.patch('sonic_ax_impl.mibs.cancel_redis_pubsub') as mocked_cancel_redis_pubsub):
             updater.reinit_data()
             mocked_thermal_reinit_data.assert_called()
             mocked_xcvr_reinit_data.assert_called()
             mocked_psu_reinit_data.assert_called()
             mocked_fan_drawer_reinit_data.assert_called()
             mocked_fan_cache_reinit_data.assert_called()
+            mocked_fc_reinit_data.assert_called()
             mocked_cancel_redis_pubsub.assert_called()
         assert str(excinfo.value) == "[RuntimeError('mocked runtime error')]"
 
@@ -102,13 +108,15 @@ def test_PhysicalTableMIBUpdater_runtime_exc_in_reinit_data_wont_block_reinit_it
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FanDrawerCacheUpdater.reinit_data') as mocked_fan_drawer_reinit_data,
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FanCacheUpdater.reinit_data') as mocked_fan_cache_reinit_data,
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.ThermalCacheUpdater.reinit_data') as mocked_thermal_reinit_data,
+              mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FabricCardCacheUpdater.reinit_data') as mocked_fc_reinit_data,
               mock.patch('sonic_ax_impl.mibs.cancel_redis_pubsub') as mocked_cancel_redis_pubsub):
             updater.reinit_data()
             mocked_xcvr_reinit_data.assert_called()
             mocked_psu_reinit_data.assert_called()
             mocked_fan_drawer_reinit_data.assert_called()
             mocked_fan_cache_reinit_data.assert_called()
             mocked_thermal_reinit_data.assert_called()
+            mocked_fc_reinit_data.assert_called()
             mocked_cancel_redis_pubsub.assert_called()
         assert str(exc_info.value) == "[RuntimeError('mocked runtime error')]"
 
@@ -127,12 +135,29 @@ def test_PhysicalTableMIBUpdater_multi_exception(self, mocked_xcvr_reinit_data,
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.PsuCacheUpdater.reinit_data') as mocked_psu_reinit_data,
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FanDrawerCacheUpdater.reinit_data') as mocked_fan_drawer_reinit_data,
               mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FanCacheUpdater.reinit_data') as mocked_fan_cache_reinit_data,
+              mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.FabricCardCacheUpdater.reinit_data') as mocked_fc_reinit_data,
               mock.patch('sonic_ax_impl.mibs.cancel_redis_pubsub') as mocked_cancel_redis_pubsub):
             updater.reinit_data()
             mocked_xcvr_reinit_data.assert_called()
             mocked_psu_reinit_data.assert_called()
             mocked_fan_drawer_reinit_data.assert_called()
             mocked_fan_cache_reinit_data.assert_called()
+            mocked_fc_reinit_data.assert_called()
             mocked_thermal_reinit_data.assert_called()
             mocked_cancel_redis_pubsub.assert_called()
         assert str(exc_info.value) == "[RuntimeError('mocked runtime error'), Exception('mocked error')]"
+
+
+class TestFabricCardCacheUpdater(TestCase):
+    @mock.patch('sonic_ax_impl.mibs.Namespace.dbs_get_all', mock.MagicMock(return_value=({"model": "Model000", "presence": "True", "serial" : "Serial000", "is_replaceable" : "False"})))
+    @mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.PhysicalEntityCacheUpdater.get_physical_relation_info', mock.MagicMock(return_value=({"position_in_parent" : 0, "parent_name" : "Chassis 1"})))
+    def test_update_entity_cache(self):
+        updater = PhysicalTableMIBUpdater()
+        fc_updater = FabricCardCacheUpdater(updater)
+        update_entity_cache = getattr(fc_updater, '_update_entity_cache')
+
+        with (mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.PhysicalTableMIBUpdater.set_phy_contained_in') as mocked_phy_contained_in,
+              mock.patch('sonic_ax_impl.mibs.ietf.rfc2737.PhysicalTableMIBUpdater.set_phy_fru') as mocked_set_phy_fru):
+            update_entity_cache('N/A')
+            mocked_phy_contained_in.assert_called()
+            mocked_set_phy_fru.assert_called()

tests/test_rfc3433.py

@@ -36,4 +36,15 @@ def test_PhysicalSensorTableMIBUpdater_re_init_redis_exception(self):
             updater.reinit_connection()
 
             # check re-init
-            connect_all_dbs.assert_called()
+            connect_all_dbs.assert_called()
+
+    @mock.patch('swsscommon.swsscommon.SonicV2Connector.get_all', mock.MagicMock(return_value=({"position_in_parent" : '0', "parent_name" : "FABRIC-CARD0"})))
+    def test_PhysicalSensorTableMIBUpdater_fabriccard_update_fan_sensor_data(self):
+        updater = PhysicalSensorTableMIBUpdater()
+        updater.fan_sensor = ['FABRIC_MODULE|FAN']
+
+        with mock.patch('sonic_ax_impl.mibs.ietf.rfc3433.get_fabric_card_sub_id') as mocked_get_fc_subid:
+            updater.update_fan_sensor_data()
+
+            # check fabric card subid function is called to get parent's sub id
+            mocked_get_fc_subid.assert_called()