[GCU] Add PFC_WD RDMA validator (sonic-net#2810)

Backport previous PR https://github.com/sonic-net/sonic-utilities/pull/2619/files to 202205

Author: isabelmsft

generic_config_updater/change_applier.py

@@ -9,7 +9,7 @@
 from .gu_common import genericUpdaterLogging
 
 SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
-UPDATER_CONF_FILE = f"{SCRIPT_DIR}/generic_config_updater.conf.json"
+UPDATER_CONF_FILE = f"{SCRIPT_DIR}/gcu_services_validator.conf.json"
 logger = genericUpdaterLogging.get_logger(title="Change Applier")
 
 print_to_console = False

generic_config_updater/field_operation_validators.py

@@ -0,0 +1,26 @@
+from sonic_py_common import device_info
+import re
+
+def rdma_config_update_validator():
+    version_info = device_info.get_sonic_version_info()
+    build_version = version_info.get('build_version')
+    asic_type = version_info.get('asic_type')
+
+    if (asic_type != 'mellanox' and asic_type != 'broadcom' and asic_type != 'cisco-8000'):
+        return False
+
+    version_substrings = build_version.split('.')
+    branch_version = None
+
+    for substring in version_substrings:
+        if substring.isdigit() and re.match(r'^\d{8}$', substring):
+            branch_version = substring
+            break
+
+    if branch_version is None:
+        return False
+
+    if asic_type == 'cisco-8000':
+        return branch_version >= "20201200"
+    else:
+        return branch_version >= "20181100"

generic_config_updater/gcu_field_operation_validators.conf.json

@@ -0,0 +1,20 @@
+{
+    "README": [
+        "field_operation_validators provides, module & method name as ",
+        "    <module name>.<method name>",
+        "NOTE: module name could have '.'",
+        " ",
+        "The last element separated by  '.' is considered as ",
+        "method name",
+        "",
+        "e.g. 'show.acl.test_acl'",
+        "",
+        "field_operation_validators for a given table defines a list of validators that all must pass for modification to the specified field and table to be allowed",
+        ""
+    ],
+    "tables": {
+        "PFC_WD": {
+            "field_operation_validators": [ "generic_config_updater.field_operation_validators.rdma_config_update_validator" ]
+        }
+    }
+}

generic_config_updater/generic_config_updater.conf.json renamed to generic_config_updater/gcu_services_validator.conf.json

@@ -1,17 +1,21 @@
 import json
 import jsonpatch
+import importlib
 from jsonpointer import JsonPointer
 import sonic_yang
 import sonic_yang_ext
 import subprocess
 import yang as ly
 import copy
 import re
+import os
 from sonic_py_common import logger
 from enum import Enum
 
 YANG_DIR = "/usr/local/yang-models"
 SYSLOG_IDENTIFIER = "GenericConfigUpdater"
+SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
+GCU_FIELD_OP_CONF_FILE = f"{SCRIPT_DIR}/gcu_field_operation_validators.conf.json"
 
 class GenericConfigUpdaterError(Exception):
     pass
@@ -157,6 +161,37 @@ def validate_field_operation(self, old_config, target_config):
                 if any(op['op'] == operation and field == op['path'] for op in patch):
                     raise IllegalPatchOperationError("Given patch operation is invalid. Operation: {} is illegal on field: {}".format(operation, field))
 
+        def _invoke_validating_function(cmd):
+            # cmd is in the format as <package/module name>.<method name>
+            method_name = cmd.split(".")[-1]
+            module_name = ".".join(cmd.split(".")[0:-1])
+            if module_name != "generic_config_updater.field_operation_validators" or "validator" not in method_name:
+                raise GenericConfigUpdaterError("Attempting to call invalid method {} in module {}. Module must be generic_config_updater.field_operation_validators, and method must be a defined validator".format(method_name, module_name))
+            module = importlib.import_module(module_name, package=None)
+            method_to_call = getattr(module, method_name)
+            return method_to_call()
+
+        if os.path.exists(GCU_FIELD_OP_CONF_FILE):
+            with open(GCU_FIELD_OP_CONF_FILE, "r") as s:
+                gcu_field_operation_conf = json.load(s)
+        else:
+            raise GenericConfigUpdaterError("GCU field operation validators config file not found") 
+
+        for element in patch:
+            path = element["path"]
+            match = re.search(r'\/([^\/]+)(\/|$)', path) # This matches the table name in the path, eg if path if /PFC_WD/GLOBAL, the match would be PFC_WD
+            if match is not None:
+                table = match.group(1)
+            else:
+                raise GenericConfigUpdaterError("Invalid jsonpatch path: {}".format(path))
+            validating_functions= set()
+            tables = gcu_field_operation_conf["tables"]
+            validating_functions.update(tables.get(table, {}).get("field_operation_validators", []))
+
+            for function in validating_functions:
+                if not _invoke_validating_function(function):
+                    raise IllegalPatchOperationError("Modification of {} table is illegal- validating function {} returned False".format(table, function))
+
     def validate_lanes(self, config_db):
         if "PORT" not in config_db:
             return True, None

generic_config_updater/gu_common.py

@@ -63,7 +63,7 @@
         'sonic_cli_gen',
     ],
     package_data={
-        'generic_config_updater': ['generic_config_updater.conf.json'],
+        'generic_config_updater': ['gcu_services_validator.conf.json', 'gcu_field_operation_validators.conf.json'],
         'show': ['aliases.ini'],
         'sonic_installer': ['aliases.ini'],
         'tests': ['acl_input/*',

setup.py

@@ -3,8 +3,10 @@
 import jsonpatch
 import sonic_yang
 import unittest
-from unittest.mock import MagicMock, Mock, patch
+import mock
 
+from unittest.mock import MagicMock, Mock
+from mock import patch
 from .gutest_helpers import create_side_effect_dict, Files
 import generic_config_updater.gu_common as gu_common
 
@@ -69,17 +71,25 @@ def setUp(self):
         self.config_wrapper_mock = gu_common.ConfigWrapper()
         self.config_wrapper_mock.get_config_db_as_json=MagicMock(return_value=Files.CONFIG_DB_AS_JSON)
 
-    def test_validate_field_operation_legal(self):
+    @patch("sonic_py_common.device_info.get_sonic_version_info", mock.Mock(return_value={"asic_type": "mellanox", "build_version": "SONiC.20181131"}))
+    def test_validate_field_operation_legal__pfcwd(self):
         old_config = {"PFC_WD": {"GLOBAL": {"POLL_INTERVAL": "60"}}}
         target_config = {"PFC_WD": {"GLOBAL": {"POLL_INTERVAL": "40"}}}
         config_wrapper = gu_common.ConfigWrapper()
         config_wrapper.validate_field_operation(old_config, target_config)
-    
-    def test_validate_field_operation_illegal(self):
-        old_config = {"PFC_WD": {"GLOBAL": {"POLL_INTERVAL": 60}}}
+        
+    def test_validate_field_operation_illegal__pfcwd(self):
+        old_config = {"PFC_WD": {"GLOBAL": {"POLL_INTERVAL": "60"}}}
         target_config = {"PFC_WD": {"GLOBAL": {}}}
         config_wrapper = gu_common.ConfigWrapper()
         self.assertRaises(gu_common.IllegalPatchOperationError, config_wrapper.validate_field_operation, old_config, target_config)
+    
+    @patch("sonic_py_common.device_info.get_sonic_version_info", mock.Mock(return_value={"asic_type": "invalid-asic", "build_version": "SONiC.20181131"}))
+    def test_validate_field_modification_illegal__pfcwd(self):
+        old_config = {"PFC_WD": {"GLOBAL": {"POLL_INTERVAL": "60"}}}
+        target_config = {"PFC_WD": {"GLOBAL": {"POLL_INTERVAL": "80"}}}
+        config_wrapper = gu_common.ConfigWrapper()
+        self.assertRaises(gu_common.IllegalPatchOperationError, config_wrapper.validate_field_operation, old_config, target_config)
 
     def test_ctor__default_values_set(self):
         config_wrapper = gu_common.ConfigWrapper()