Implementation of a Monitoring Daemon for storage devices in SONiC switches (#433)

ashwnsri · web-flow · commit f41ecca2d03d · 2024-05-30T17:59:35.000-07:00
* Initial commit of ssdmond
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -56,6 +56,9 @@ parameters:
     - name: sensormond
       root_dir: sonic-sensormond
       python3: true
+    - name: stormond
+      root_dir: sonic-stormond
+      python3: true
 - name: artifactBranch
   type: string
   default: 'refs/heads/master'
diff --git a/sonic-stormond/pytest.ini b/sonic-stormond/pytest.ini
@@ -0,0 +1,2 @@
+[pytest]
+addopts = --cov=scripts --cov-report html --cov-report term --cov-report xml --junitxml=test-results.xml -vv
diff --git a/sonic-stormond/scripts/stormond b/sonic-stormond/scripts/stormond
diff --git a/sonic-stormond/setup.cfg b/sonic-stormond/setup.cfg
@@ -0,0 +1,2 @@
+[aliases]
+test=pytest
diff --git a/sonic-stormond/setup.py b/sonic-stormond/setup.py
@@ -0,0 +1,42 @@
+from setuptools import setup
+
+setup(
+    name='sonic-stormond',
+    version='1.0',
+    description='Storage Device Monitoring Daemon for SONiC',
+    license='Apache 2.0',
+    author='SONiC Team',
+    author_email='linuxnetdev@microsoft.com',
+    url='https://github.com/sonic-net/sonic-platform-daemons',
+    maintainer='Ashwin Srinivasan',
+    maintainer_email='assrinivasan@microsoft.com',
+    scripts=[
+        'scripts/stormond',
+    ],
+    setup_requires=[
+        'pytest-runner',
+        'wheel'
+    ],
+    install_requires=[
+        'enum34',
+        'sonic-py-common',
+    ],
+    tests_require=[
+        'mock>=2.0.0',
+        'pytest',
+        'pytest-cov',
+    ],
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: No Input/Output (Daemon)',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Information Technology',
+        'Intended Audience :: System Administrators',
+        'License :: OSI Approved :: Apache Software License',
+        'Natural Language :: English',
+        'Operating System :: POSIX :: Linux',
+        'Topic :: System :: Hardware',
+    ],
+    keywords='sonic SONiC ssd Ssd SSD ssdmond storage stormond storagemond',
+    test_suite='setup.get_test_suite'
+)
diff --git a/sonic-stormond/tests/__init__.py b/sonic-stormond/tests/__init__.py
diff --git a/sonic-stormond/tests/mock_swsscommon.py b/sonic-stormond/tests/mock_swsscommon.py
@@ -0,0 +1,63 @@
+'''
+    Mock implementation of swsscommon package for unit testing
+'''
+
+from swsssdk import ConfigDBConnector, SonicDBConfig, SonicV2Connector
+
+STATE_DB = ''
+
+
+class Table:
+    def __init__(self, db, table_name):
+        self.table_name = table_name
+        self.mock_dict = {}
+        self.mock_keys = ['sda']
+
+    def _del(self, key):
+        del self.mock_dict[key]
+        pass
+
+    def set(self, key, fvs):
+        self.mock_dict[key] = fvs.fv_dict
+        pass
+
+    def get(self, key):
+        if key in self.mock_dict:
+            return self.mock_dict[key]
+        return None
+
+    def get_size(self):
+        return (len(self.mock_dict))
+
+    def getKeys(self):
+        return self.mock_keys
+    
+    def hgetall(self):
+        return self.mock_dict
+
+
+class FieldValuePairs:
+    fv_dict = {}
+
+    def __init__(self, tuple_list):
+        if isinstance(tuple_list, list) and isinstance(tuple_list[0], tuple):
+            self.fv_dict = dict(tuple_list)
+
+    def __setitem__(self, key, kv_tuple):
+        self.fv_dict[kv_tuple[0]] = kv_tuple[1]
+
+    def __getitem__(self, key):
+        return self.fv_dict[key]
+
+    def __eq__(self, other):
+        if not isinstance(other, FieldValuePairs):
+            # don't attempt to compare against unrelated types
+            return NotImplemented
+
+        return self.fv_dict == other.fv_dict
+
+    def __repr__(self):
+        return repr(self.fv_dict)
+
+    def __str__(self):
+        return repr(self.fv_dict)
diff --git a/sonic-stormond/tests/mocked_libs/sonic_platform/__init__.py b/sonic-stormond/tests/mocked_libs/sonic_platform/__init__.py
@@ -0,0 +1,6 @@
+"""
+    Mock implementation of sonic_platform package for unit testing
+"""
+
+from . import pcie
+
diff --git a/sonic-stormond/tests/mocked_libs/sonic_platform/pcie.py b/sonic-stormond/tests/mocked_libs/sonic_platform/pcie.py
@@ -0,0 +1,13 @@
+"""
+    Mock implementation of sonic_platform package for unit testing
+"""
+
+from sonic_platform_base.pcie_base import PcieBase
+
+
+class Pcie(PcieBase):
+    def __init__(self):
+        self.platform_pcieutil = "/tmp/Pcie"
+    
+    def __str__(self):
+        return self.platform_pcieutil
diff --git a/sonic-stormond/tests/mocked_libs/sonic_platform_base/__init__.py b/sonic-stormond/tests/mocked_libs/sonic_platform_base/__init__.py
@@ -0,0 +1 @@
+
diff --git a/sonic-stormond/tests/mocked_libs/sonic_platform_base/sonic_storage/__init__.py b/sonic-stormond/tests/mocked_libs/sonic_platform_base/sonic_storage/__init__.py
diff --git a/sonic-stormond/tests/mocked_libs/sonic_platform_base/sonic_storage/storage_base.py b/sonic-stormond/tests/mocked_libs/sonic_platform_base/sonic_storage/storage_base.py
@@ -0,0 +1,102 @@
+#
+# storage_base.py
+#
+# Base class for implementing common SSD health features
+#
+
+
+class StorageBase(object):
+    """
+    Base class for interfacing with a SSD
+    """
+    def __init__(self, diskdev):
+        """
+        Constructor
+
+        Args:
+            diskdev: Linux device name to get parameters for
+        """
+        pass
+
+    def get_health(self):
+        """
+        Retrieves current disk health in percentages
+
+        Returns:
+            A float number of current ssd health
+            e.g. 83.5
+        """
+        raise NotImplementedError
+
+    def get_temperature(self):
+        """
+        Retrieves current disk temperature in Celsius
+
+        Returns:
+            A float number of current temperature in Celsius
+            e.g. 40.1
+        """
+        raise NotImplementedError
+
+    def get_model(self):
+        """
+        Retrieves model for the given disk device
+
+        Returns:
+            A string holding disk model as provided by the manufacturer
+        """
+        raise NotImplementedError
+
+    def get_firmware(self):
+        """
+        Retrieves firmware version for the given disk device
+
+        Returns:
+            A string holding disk firmware version as provided by the manufacturer
+        """
+        raise NotImplementedError
+
+    def get_serial(self):
+        """
+        Retrieves serial number for the given disk device
+
+        Returns:
+            A string holding disk serial number as provided by the manufacturer
+        """
+        raise NotImplementedError
+
+    def get_vendor_output(self):
+        """
+        Retrieves vendor specific data for the given disk device
+
+        Returns:
+            A string holding some vendor specific disk information
+        """
+        raise NotImplementedError
+
+    def get_disk_io_reads(self):
+        """
+        Retrieves the total number of Input/Output (I/O) reads done on a storage disk
+
+        Returns:
+            An integer value of the total number of I/O reads
+        """
+        raise NotImplementedError
+
+    def get_disk_io_writes(self):
+        """
+        Retrieves the total number of Input/Output (I/O) writes done on a storage disk
+
+        Returns:
+            An integer value of the total number of I/O writes
+        """
+        raise NotImplementedError
+
+    def get_reserved_blocks(self):
+        """
+        Retrieves the total number of reserved blocks in an storage disk
+
+        Returns:
+            An integer value of the total number of reserved blocks
+        """
+        raise NotImplementedError
diff --git a/sonic-stormond/tests/mocked_libs/sonic_platform_base/sonic_storage/storage_devices.py b/sonic-stormond/tests/mocked_libs/sonic_platform_base/sonic_storage/storage_devices.py
@@ -0,0 +1,12 @@
+
+BLKDEV_BASE_PATH = ''
+
+class StorageDevices:
+    def __init__(self):
+        self.devices = {'sda' : None}
+
+    def _get_storage_devices(self):
+        pass
+    
+    def _storage_device_object_factory(self, key):
+        pass
diff --git a/sonic-stormond/tests/mocked_libs/swsscommon/__init__.py b/sonic-stormond/tests/mocked_libs/swsscommon/__init__.py
@@ -0,0 +1,5 @@
+'''
+    Mock implementation of swsscommon package for unit testing
+'''
+
+from . import swsscommon
diff --git a/sonic-stormond/tests/mocked_libs/swsscommon/swsscommon.py b/sonic-stormond/tests/mocked_libs/swsscommon/swsscommon.py
@@ -0,0 +1,66 @@
+'''
+    Mock implementation of swsscommon package for unit testing
+'''
+
+STATE_DB = ''
+
+
+class Table:
+    def __init__(self, db, table_name):
+        self.table_name = table_name
+        self.mock_dict = {}
+
+    def _del(self, key):
+        del self.mock_dict[key]
+        pass
+
+    def set(self, key, fvs):
+        self.mock_dict[key] = fvs.fv_dict
+        pass
+
+    def get(self, key):
+        if key in self.mock_dict:
+            return self.mock_dict[key]
+        return None
+
+    def get_size(self):
+        return (len(self.mock_dict))
+
+    def getKeys(self):
+        return list(self.mock_dict.keys())
+
+
+class FieldValuePairs:
+    fv_dict = {}
+
+    def __init__(self, tuple_list):
+        if isinstance(tuple_list, list) and isinstance(tuple_list[0], tuple):
+            self.fv_dict = dict(tuple_list)
+
+    def __setitem__(self, key, kv_tuple):
+        self.fv_dict[kv_tuple[0]] = kv_tuple[1]
+
+    def __getitem__(self, key):
+        return self.fv_dict[key]
+
+    def __eq__(self, other):
+        if not isinstance(other, FieldValuePairs):
+            # don't attempt to compare against unrelated types
+            return NotImplemented
+
+        return self.fv_dict == other.fv_dict
+
+    def __repr__(self):
+        return repr(self.fv_dict)
+
+    def __str__(self):
+        return repr(self.fv_dict)
+
+class ConfigDBConnector:
+    pass
+
+class SonicDBConfig:
+    pass
+
+class SonicV2Connector:
+    pass
diff --git a/sonic-stormond/tests/test_DaemonStorage.py b/sonic-stormond/tests/test_DaemonStorage.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[pytest]`
	`2`	`+addopts = --cov=scripts --cov-report html --cov-report term --cov-report xml --junitxml=test-results.xml -vv`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +"""
 +    Mock implementation of sonic_platform package for unit testing
 +"""
++
 +from . import pcie
++