From d3e89f37d18145d8e1503151a60edce630932a37 Mon Sep 17 00:00:00 2001
From: gifrerenom <lluis.gifre@cttc.es>
Date: Thu, 23 Feb 2023 15:35:30 +0000
Subject: [PATCH] Pre-merge cleanup:

- Updated Netconf/OpenConfig descriptor files
- Normalized variable names in OpenConfigDriver
- Minor code cleanup
---
 hackfest/tfs-descriptors/device-all.json      |  8 +++---
 .../device-netconf-openconfig.json            |  2 +-
 hackfest/tfs-descriptors/old/device.json      |  6 ++---
 .../drivers/openconfig/OpenConfigDriver.py    | 26 +++++++++----------
 .../tests/Device_OpenConfig_Template.py       |  2 +-
 5 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/hackfest/tfs-descriptors/device-all.json b/hackfest/tfs-descriptors/device-all.json
index 8cb8e0314..36a93fe98 100644
--- a/hackfest/tfs-descriptors/device-all.json
+++ b/hackfest/tfs-descriptors/device-all.json
@@ -9,7 +9,7 @@
                 {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {
                     "username": "admin", "password": "admin",
                     "force_running": false, "hostkey_verify": false, "look_for_keys": false,
-                    "allow_agent": false, "delete_rule": true, "device_params": {"name": "default"},
+                    "allow_agent": false, "commit_per_rule": true, "device_params": {"name": "default"},
                     "manager_params": {"timeout" : 120}
                 }}}
             ]},
@@ -26,7 +26,7 @@
                 {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {
                     "username": "admin", "password": "admin",
                     "force_running": false, "hostkey_verify": false, "look_for_keys": false,
-                    "allow_agent": false, "delete_rule": true, "device_params": {"name": "default"},
+                    "allow_agent": false, "commit_per_rule": true, "device_params": {"name": "default"},
                     "manager_params": {"timeout" : 120}
                 }}}
             ]},
@@ -43,7 +43,7 @@
                 {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {
                     "username": "admin", "password": "admin",
                     "force_running": false, "hostkey_verify": false, "look_for_keys": false,
-                    "allow_agent": false, "delete_rule": true, "device_params": {"name": "default"},
+                    "allow_agent": false, "commit_per_rule": true, "device_params": {"name": "default"},
                     "manager_params": {"timeout" : 120}
                 }}}
             ]},
@@ -60,7 +60,7 @@
                 {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {
                     "username": "admin", "password": "admin",
                     "force_running": false, "hostkey_verify": false, "look_for_keys": false,
-                    "allow_agent": false, "delete_rule": true, "device_params": {"name": "default"},
+                    "allow_agent": false, "commit_per_rule": true, "device_params": {"name": "default"},
                     "manager_params": {"timeout" : 120}
                 }}}
             ]},
diff --git a/hackfest/tfs-descriptors/device-netconf-openconfig.json b/hackfest/tfs-descriptors/device-netconf-openconfig.json
index 7e01f037e..490e36efd 100644
--- a/hackfest/tfs-descriptors/device-netconf-openconfig.json
+++ b/hackfest/tfs-descriptors/device-netconf-openconfig.json
@@ -9,7 +9,7 @@
                 {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": {
                     "username": "admin", "password": "admin",
                     "force_running": false, "hostkey_verify": false, "look_for_keys": false,
-                    "allow_agent": false, "delete_rule": true, "device_params": {"name": "default"},
+                    "allow_agent": false, "commit_per_rule": true, "device_params": {"name": "default"},
                     "manager_params": {"timeout" : 15}
                 }}}
             ]},
diff --git a/hackfest/tfs-descriptors/old/device.json b/hackfest/tfs-descriptors/old/device.json
index 03736314d..abe529e72 100644
--- a/hackfest/tfs-descriptors/old/device.json
+++ b/hackfest/tfs-descriptors/old/device.json
@@ -27,7 +27,7 @@
             "device_config": {"config_rules": [
                 {"action": 1, "custom": {"resource_key": "_connect/address", "resource_value": "10.0.2.15"}},
                 {"action": 1, "custom": {"resource_key": "_connect/port", "resource_value": "8301"}},
-                {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": "{\"username\": \"admin\", \"password\": \"admin\", \"force_running\": true, \"hostkey_verify\": false, \"look_for_keys\": false, \"allow_agent\": true, \"delete_rule\": false, \"device_params\"  : {\"name\": \"default\"}, \"manager_params\" : {\"timeout\": 15}}"}}
+                {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": "{\"username\": \"admin\", \"password\": \"admin\", \"force_running\": true, \"hostkey_verify\": false, \"look_for_keys\": false, \"allow_agent\": true, \"commit_per_rule\": false, \"device_params\"  : {\"name\": \"default\"}, \"manager_params\" : {\"timeout\": 15}}"}}
             ]},
             "device_operational_status": 1,
             "device_drivers": [1],
@@ -39,7 +39,7 @@
             "device_config": {"config_rules": [
                 {"action": 1, "custom": {"resource_key": "_connect/address", "resource_value": "10.0.2.15"}},
                 {"action": 1, "custom": {"resource_key": "_connect/port", "resource_value": "8302"}},
-                {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": "{\"username\": \"admin\", \"password\": \"admin\", \"force_running\": true, \"hostkey_verify\": false, \"look_for_keys\": false, \"allow_agent\": true, \"delete_rule\": false, \"device_params\"  : {\"name\": \"default\"}, \"manager_params\" : {\"timeout\": 15}}"}}
+                {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": "{\"username\": \"admin\", \"password\": \"admin\", \"force_running\": true, \"hostkey_verify\": false, \"look_for_keys\": false, \"allow_agent\": true, \"commit_per_rule\": false, \"device_params\"  : {\"name\": \"default\"}, \"manager_params\" : {\"timeout\": 15}}"}}
             ]},
             "device_operational_status": 1,
             "device_drivers": [1],
@@ -51,7 +51,7 @@
             "device_config": {"config_rules": [
                 {"action": 1, "custom": {"resource_key": "_connect/address", "resource_value": "10.0.2.15"}},
                 {"action": 1, "custom": {"resource_key": "_connect/port", "resource_value": "8303"}},
-                {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": "{\"username\": \"admin\", \"password\": \"admin\", \"force_running\": true, \"hostkey_verify\": false, \"look_for_keys\": false, \"allow_agent\": true, \"delete_rule\": false, \"device_params\"  : {\"name\": \"default\"}, \"manager_params\" : {\"timeout\": 15}}"}}
+                {"action": 1, "custom": {"resource_key": "_connect/settings", "resource_value": "{\"username\": \"admin\", \"password\": \"admin\", \"force_running\": true, \"hostkey_verify\": false, \"look_for_keys\": false, \"allow_agent\": true, \"commit_per_rule\": false, \"device_params\"  : {\"name\": \"default\"}, \"manager_params\" : {\"timeout\": 15}}"}}
             ]},
             "device_operational_status": 1,
             "device_drivers": [1],
diff --git a/src/device/service/drivers/openconfig/OpenConfigDriver.py b/src/device/service/drivers/openconfig/OpenConfigDriver.py
index bce977dc9..c633fb1a5 100644
--- a/src/device/service/drivers/openconfig/OpenConfigDriver.py
+++ b/src/device/service/drivers/openconfig/OpenConfigDriver.py
@@ -58,18 +58,18 @@ class NetconfSessionHandler:
         self.__connected = threading.Event()
         self.__address = address
         self.__port = int(port)
-        self.__username       = settings.get('username')
-        self.__password       = settings.get('password')
-        self.__vendor         = settings.get('vendor')
-        self.__key_filename   = settings.get('key_filename')
-        self.__hostkey_verify = settings.get('hostkey_verify', True)
-        self.__look_for_keys  = settings.get('look_for_keys', True)
-        self.__allow_agent    = settings.get('allow_agent', True)
-        self.__force_running  = settings.get('force_running', False)
-        self.__commit_per_rule  = settings.get('commit_rule', False)
-        self.__device_params  = settings.get('device_params', {})
-        self.__manager_params = settings.get('manager_params', {})
-        self.__nc_params      = settings.get('nc_params', {})
+        self.__username        = settings.get('username')
+        self.__password        = settings.get('password')
+        self.__vendor          = settings.get('vendor')
+        self.__key_filename    = settings.get('key_filename')
+        self.__hostkey_verify  = settings.get('hostkey_verify', True)
+        self.__look_for_keys   = settings.get('look_for_keys', True)
+        self.__allow_agent     = settings.get('allow_agent', True)
+        self.__force_running   = settings.get('force_running', False)
+        self.__commit_per_rule = settings.get('commit_per_rule', False)
+        self.__device_params   = settings.get('device_params', {})
+        self.__manager_params  = settings.get('manager_params', {})
+        self.__nc_params       = settings.get('nc_params', {})
         self.__manager : Manager   = None
         self.__candidate_supported = False
 
@@ -192,7 +192,7 @@ def do_sampling(
 
 def edit_config(
     netconf_handler : NetconfSessionHandler, logger : logging.Logger, resources : List[Tuple[str, Any]], delete=False,
-    commit_per_rule= False, target='running', default_operation='merge', test_option=None, error_option=None,
+    commit_per_rule=False, target='running', default_operation='merge', test_option=None, error_option=None,
     format='xml' # pylint: disable=redefined-builtin
 ):
     str_method = 'DeleteConfig' if delete else 'SetConfig'
diff --git a/src/device/tests/Device_OpenConfig_Template.py b/src/device/tests/Device_OpenConfig_Template.py
index 8ab453375..b9aae79a2 100644
--- a/src/device/tests/Device_OpenConfig_Template.py
+++ b/src/device/tests/Device_OpenConfig_Template.py
@@ -32,7 +32,7 @@ DEVICE_OC_CONNECT_RULES = json_device_connect_rules(DEVICE_OC_ADDRESS, DEVICE_OC
     'hostkey_verify' : True,
     'look_for_keys'  : True,
     'allow_agent'    : True,
-    'delete_rule'    : False,
+    'commit_per_rule': False,
     'device_params'  : {'name': 'default'},
     'manager_params' : {'timeout' : DEVICE_OC_TIMEOUT},
 })
-- 
GitLab