Introduce sonic-py-common package

.gitignore

@@ -32,10 +32,16 @@ installer/x86_64/platforms/
 src/sonic-config-engine/**/*.pyc
 src/sonic-config-engine/build
 src/sonic-config-engine/sonic_config_engine.egg-info
+
 src/sonic-daemon-base/**/*.pyc
 src/sonic-daemon-base/build
 src/sonic-daemon-base/sonic_daemon_base.egg-info
 
+src/sonic-py-common/**/*.pyc
+src/sonic-py-common/build
+src/sonic-py-common/dist
+src/sonic-py-common/sonic_py_common.egg-info
+
 # Misc. files
 asic_config_checksum
 files/Aboot/boot0

files/build_templates/sonic_debian_extension.j2

@@ -163,6 +163,12 @@ sudo cp {{daemon_base_py2_wheel_path}} $FILESYSTEM_ROOT/$DAEMON_BASE_PY2_WHEEL_N
 sudo https_proxy=$https_proxy LANG=C chroot $FILESYSTEM_ROOT pip install $DAEMON_BASE_PY2_WHEEL_NAME
 sudo rm -rf $FILESYSTEM_ROOT/$DAEMON_BASE_PY2_WHEEL_NAME
 
+# Install sonic-py-common Python 2 package
+SONIC_PY_COMMON_PY2_WHEEL_NAME=$(basename {{sonic_py_common_py2_wheel_path}})
+sudo cp {{sonic_py_common_py2_wheel_path}} $FILESYSTEM_ROOT/$SONIC_PY_COMMON_PY2_WHEEL_NAME
+sudo https_proxy=$https_proxy LANG=C chroot $FILESYSTEM_ROOT pip install $SONIC_PY_COMMON_PY2_WHEEL_NAME
+sudo rm -rf $FILESYSTEM_ROOT/$SONIC_PY_COMMON_PY2_WHEEL_NAME
+
 # Install built Python Click package (and its dependencies via 'apt-get -y install -f')
 # Do this before installing sonic-utilities so that it doesn't attempt to install
 # an older version as part of its dependencies

platform/mellanox/mlnx-platform-api.mk

@@ -3,7 +3,7 @@
 SONIC_PLATFORM_API_PY2 = mlnx_platform_api-1.0-py2-none-any.whl
 $(SONIC_PLATFORM_API_PY2)_SRC_PATH = $(PLATFORM_PATH)/mlnx-platform-api
 $(SONIC_PLATFORM_API_PY2)_PYTHON_VERSION = 2
-$(SONIC_PLATFORM_API_PY2)_DEPENDS = $(SONIC_PLATFORM_COMMON_PY2) $(SONIC_DAEMON_BASE_PY2) $(SONIC_CONFIG_ENGINE)
+$(SONIC_PLATFORM_API_PY2)_DEPENDS = $(SONIC_PY_COMMON_PY2) $(SONIC_PLATFORM_COMMON_PY2) $(SONIC_DAEMON_BASE_PY2) $(SONIC_CONFIG_ENGINE)
 SONIC_PYTHON_WHEELS += $(SONIC_PLATFORM_API_PY2)
 
 export mlnx_platform_api_py2_wheel_path="$(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_PLATFORM_API_PY2))"

rules/docker-platform-monitor.mk

@@ -13,6 +13,7 @@ endif
 $(DOCKER_PLATFORM_MONITOR)_PYTHON_DEBS += $(SONIC_LEDD) $(SONIC_XCVRD) $(SONIC_PSUD) $(SONIC_SYSEEPROMD) $(SONIC_THERMALCTLD)
 $(DOCKER_PLATFORM_MONITOR)_PYTHON_WHEELS += $(SONIC_PLATFORM_COMMON_PY2)
 $(DOCKER_PLATFORM_MONITOR)_PYTHON_WHEELS += $(SWSSSDK_PY2)
+$(DOCKER_PLATFORM_MONITOR)_PYTHON_WHEELS += $(SONIC_PY_COMMON_PY2)
 $(DOCKER_PLATFORM_MONITOR)_PYTHON_WHEELS += $(SONIC_PLATFORM_API_PY2)
 $(DOCKER_PLATFORM_MONITOR)_PYTHON_WHEELS += $(SONIC_DAEMON_BASE_PY2)
 

rules/sonic-py-common.dep

@@ -0,0 +1,8 @@
+SPATH       := $($(SONIC_PY_COMMON_PY2)_SRC_PATH)
+DEP_FILES   := $(SONIC_COMMON_FILES_LIST) rules/sonic-py-common.mk rules/sonic-py-common.dep   
+DEP_FILES   += $(SONIC_COMMON_BASE_FILES_LIST)
+DEP_FILES   += $(shell git ls-files $(SPATH))
+
+$(SONIC_PY_COMMON_PY2)_CACHE_MODE  := GIT_CONTENT_SHA 
+$(SONIC_PY_COMMON_PY2)_DEP_FLAGS   := $(SONIC_COMMON_FLAGS_LIST)
+$(SONIC_PY_COMMON_PY2)_DEP_FILES   := $(DEP_FILES)

rules/sonic-py-common.mk

@@ -0,0 +1,7 @@
+# SONIC_PY_COMMON_PY2 package
+
+SONIC_PY_COMMON_PY2 = sonic_py_common-1.0-py2-none-any.whl
+$(SONIC_PY_COMMON_PY2)_SRC_PATH = $(SRC_PATH)/sonic-py-common
+$(SONIC_PY_COMMON_PY2)_DEPENDS += $(SWSSSDK_PY2)
+$(SONIC_PY_COMMON_PY2)_PYTHON_VERSION = 2
+SONIC_PYTHON_WHEELS += $(SONIC_PY_COMMON_PY2)

rules/sonic-thermalctld.mk

@@ -2,5 +2,5 @@
 
 SONIC_THERMALCTLD = python-sonic-thermalctld_1.0-1_all.deb
 $(SONIC_THERMALCTLD)_SRC_PATH = $(SRC_PATH)/sonic-platform-daemons/sonic-thermalctld
-$(SONIC_THERMALCTLD)_WHEEL_DEPENDS = $(SONIC_DAEMON_BASE_PY2)
+$(SONIC_THERMALCTLD)_WHEEL_DEPENDS = $(SONIC_PY_COMMON_PY2) $(SONIC_DAEMON_BASE_PY2)
 SONIC_PYTHON_STDEB_DEBS += $(SONIC_THERMALCTLD)

slave.mk

@@ -805,6 +805,7 @@ $(addprefix $(TARGET_PATH)/, $(SONIC_INSTALLERS)) : $(TARGET_PATH)/% : \
         $$(addprefix $(FILES_PATH)/,$$($$*_FILES)) \
 	$(if $(findstring y,$(ENABLE_ZTP)),$(addprefix $(IMAGE_DISTRO_DEBS_PATH)/,$(SONIC_ZTP))) \
         $(addprefix $(PYTHON_DEBS_PATH)/,$(SONIC_UTILS)) \
+        $(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_PY_COMMON_PY2)) \
         $(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_CONFIG_ENGINE)) \
         $(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_PLATFORM_COMMON_PY2)) \
         $(addprefix $(PYTHON_WHEELS_PATH)/,$(REDIS_DUMP_LOAD_PY2)) \
@@ -835,6 +836,7 @@ $(addprefix $(TARGET_PATH)/, $(SONIC_INSTALLERS)) : $(TARGET_PATH)/% : \
 	export installer_debs="$(addprefix $(IMAGE_DISTRO_DEBS_PATH)/,$($*_INSTALLS))"
 	export lazy_installer_debs="$(foreach deb, $($*_LAZY_INSTALLS),$(foreach device, $($(deb)_PLATFORM),$(addprefix $(device)@, $(IMAGE_DISTRO_DEBS_PATH)/$(deb))))"
 	export installer_images="$(addprefix $(TARGET_PATH)/,$($*_DOCKERS))"
+	export sonic_py_common_py2_wheel_path="$(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_PY_COMMON_PY2))"
 	export config_engine_wheel_path="$(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_CONFIG_ENGINE))"
 	export swsssdk_py2_wheel_path="$(addprefix $(PYTHON_WHEELS_PATH)/,$(SWSSSDK_PY2))"
 	export swsssdk_py3_wheel_path="$(addprefix $(PYTHON_WHEELS_PATH)/,$(SWSSSDK_PY3))"

src/sonic-py-common/setup.py

@@ -0,0 +1,37 @@
+from setuptools import setup
+
+dependencies = [
+    'swsssdk>=2.0.1',
+]
+
+high_performance_deps = [
+    'swsssdk[high_perf]>=2.0.1',
+]
+
+setup(
+    name='sonic-py-common',
+    version='1.0',
+    description='Common Python libraries for SONiC',
+    license='Apache 2.0',
+    author='SONiC Team',
+    author_email='[email protected]',
+    url='https://github.com/Azure/SONiC',
+    maintainer='Joe LeVeque',
+    maintainer_email='[email protected]',
+    install_requires=dependencies,
+    extras_require={
+        'high_perf': high_performance_deps,
+    },
+    packages=[
+        'sonic_py_common',
+    ],
+    classifiers=[
+        'Intended Audience :: Developers',
+        'Operating System :: Linux',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python',
+    ],
+    keywords='SONiC sonic PYTHON python COMMON common',
+)
+

src/sonic-py-common/sonic_py_common/daemon_base.py

@@ -0,0 +1,80 @@
+import imp
+import signal
+import sys
+
+from . import device_info, logger
+
+#
+# Constants ====================================================================
+#
+REDIS_TIMEOUT_MSECS = 0
+
+EEPROM_MODULE_NAME = 'eeprom'
+EEPROM_CLASS_NAME = 'board'
+
+#
+# Helper functions =============================================================
+#
+
+def db_connect(db_name):
+    from swsscommon import swsscommon
+    return swsscommon.DBConnector(db_name, REDIS_TIMEOUT_MSECS, True)
+
+#
+# DaemonBase ===================================================================
+#
+
+class DaemonBase(logger.Logger):
+    def __init__(self, log_identifier):
+        super(DaemonBase, self).__init__(log_identifier, logger.FACILITY_DAEMON)
+
+        # Register our default signal handlers, unless the signal already has a
+        # handler registered, most likely from a subclass implementation
+        if not signal.getsignal(signal.SIGHUP):
+            signal.signal(signal.SIGHUP, self.signal_handler)
+        if not signal.getsignal(signal.SIGINT):
+            signal.signal(signal.SIGINT, self.signal_handler)
+        if not signal.getsignal(signal.SIGTERM):
+            signal.signal(signal.SIGTERM, self.signal_handler)
+
+    # Default signal handler; can be overridden by subclass
+    def signal_handler(self, sig, frame):
+        if sig == signal.SIGHUP:
+            log_info("DaemonBase: Caught SIGHUP - ignoring...")
+        elif sig == signal.SIGINT:
+            log_info("DaemonBase: Caught SIGINT - exiting...")
+            sys.exit(128 + sig)
+        elif sig == signal.SIGTERM:
+            log_info("DaemonBase: Caught SIGTERM - exiting...")
+            sys.exit(128 + sig)
+        else:
+            log_warning("DaemonBase: Caught unhandled signal '{}'".format(sig))
+
+    # Loads platform specific platform module from source
+    def load_platform_util(self, module_name, class_name):
+        platform_util = None
+
+        # Get path to platform and hwsku
+        (platform_path, hwsku_path) = device_info.get_path_to_platform_and_hwsku()
+
+        try:
+            module_file = "/".join([platform_path, "plugins", module_name + ".py"])
+            module = imp.load_source(module_name, module_file)
+        except IOError, e:
+            raise IOError("Failed to load platform module '%s': %s" % (module_name, str(e)))
+
+        try:
+            platform_util_class = getattr(module, class_name)
+            # board class of eeprom requires 4 paramerters, need special treatment here.
+            if module_name == EEPROM_MODULE_NAME and class_name == EEPROM_CLASS_NAME:
+                platform_util = platform_util_class('','','','')
+            else:
+                platform_util = platform_util_class()
+        except AttributeError, e:
+            raise AttributeError("Failed to instantiate '%s' class: %s" % (class_name, str(e)))
+
+        return platform_util
+
+    # Runs daemon
+    def run(self):
+        raise NotImplementedError()