Skip to content

Commit

Permalink
[config_mgmt.py]: Separate class for Dy Port BreakOut and support ext… (
Browse files Browse the repository at this point in the history 
#26)

* [config_mgmt.py]: Separate class for Dy Port BreakOut and support extra config tables listing.

Changes:
1.) Added a new class for ConfigMgmtDPB, which is derived from ConfigMgmt.
2.) Support to list extra tables in config.
3.) Search keys in config. This is need to list port related config in extra tables.
4.) Separate loadData function in ConfigMgmt class.

Signed-off-by: Praveen Chaudhary [email protected]

* [config/config_mgmt.py]: Fixing indentation.

Signed-off-by: Praveen Chaudhary [email protected]

* [config/config_mgmt.py]: Use loadData functions, which handles allowTablesWithOutYang too.

Signed-off-by: Praveen Chaudhary [email protected]
  • Loading branch information
Praveen Chaudhary authored Jun 30, 2020
1 parent bff35ff commit c2e4eac
Show file tree
Hide file tree
Showing 2 changed files with 169 additions and 69 deletions.
193 changes: 135 additions & 58 deletions config/config_mgmt.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,17 @@
# Class to handle config managment for SONIC, this class will use PLY to verify
# config for the commands which are capable of change in config DB.

class configMgmt():
class ConfigMgmt():

def __init__(self, source="configDB", debug=False, allowExtraTables=True):
def __init__(self, source="configDB", debug=False, allowTablesWithOutYang=True):

try:
self.configdbJsonIn = None
self.configdbJsonOut = None
self.allowExtraTables = allowExtraTables
self.oidKey = 'ASIC_STATE:SAI_OBJECT_TYPE_PORT:oid:0x'
self.allowTablesWithOutYang = allowTablesWithOutYang

# logging vars
self.SYSLOG_IDENTIFIER = "configMgmt"
self.SYSLOG_IDENTIFIER = "ConfigMgmt"
self.DEBUG = debug

self.sy = sonic_yang.sonic_yang(YANG_DIR, debug=debug)
Expand All @@ -60,17 +59,53 @@ def __init__(self, source="configDB", debug=False, allowExtraTables=True):
else:
self.readConfigDBJson(source)
# this will crop config, xlate and load.
self.sy.load_data(self.configdbJsonIn, self.allowExtraTables)
self.loadData(self.configdbJsonIn)

except Exception as e:
print(e)
raise(Exception('configMgmt Class creation failed'))
raise(Exception('ConfigMgmt Class creation failed'))

return

def __del__(self):
pass

"""
Return tables loaded in config for which YANG model does not exist.
"""
def tablesWithOutYang(self):

return self.sy.tablesWithOutYang

"""
Explicit function to load config data in Yang Data Tree
"""
def loadData(self, configdbJson):
self.sy.load_data(configdbJson)
# Raise if tables without YANG models are not allowed but exist.
if not self.allowTablesWithOutYang and len(self.sy.tablesWithOutYang):
raise Exception('Config has tables without YANG models')

return

"""
Validate current Data Tree
"""
def validateConfigData(self):

try:
self.sy.validate_data_tree()
except Exception as e:
self.sysLog(msg='Data Validation Failed')
return False

print('Data Validation successful')
self.sysLog(msg='Data Validation successful')
return True

"""
syslog Support
"""
def sysLog(self, debug=syslog.LOG_INFO, msg=None):

# log debug only if enabled
Expand Down Expand Up @@ -126,6 +161,30 @@ def writeConfigDB(self, jDiff):

return

# End of Class ConfigMgmt

"""
Config MGMT class for Dynamic Port Breakout(DPB).
This is derived from ConfigMgmt.
"""
class ConfigMgmtDPB(ConfigMgmt):

def __init__(self, source="configDB", debug=False, allowTablesWithOutYang=True):

try:
ConfigMgmt.__init__(self, source=source, debug=debug, \
allowTablesWithOutYang=allowTablesWithOutYang)
self.oidKey = 'ASIC_STATE:SAI_OBJECT_TYPE_PORT:oid:0x'

except Exception as e:
print(e)
raise(Exception('ConfigMgmtDPB Class creation failed'))

return

def __del__(self):
pass

"""
Check if a key exists in ASIC DB or not.
"""
Expand Down Expand Up @@ -359,7 +418,7 @@ def addPorts(self, ports=list(), portJson=dict(), loadDefConfig=True):

# create a tree with merged config and validate, if validation is
# sucessful, then configdbJsonOut contains final and valid config.
self.sy.load_data(self.configdbJsonOut, self.allowExtraTables)
self.loadData(self.configdbJsonOut)
if self.validateConfigData()==False:
return configToLoad, False

Expand Down Expand Up @@ -449,65 +508,84 @@ def mergeItems(it1, it2):
return D1

"""
Create a defConfig for given Ports from Default Config File.
search Relevant Keys in Config using DFS, This function is mainly
used to search port related config in Default ConfigDbJson file.
In: Config to be searched
skeys: Keys to be searched in In Config i.e. search Keys.
Out: Contains the search result
"""
def getDefaultConfig(self, ports=list()):
def searchKeysInConfig(self, In, Out, skeys):

found = False
if isinstance(In, dict):
for key in In.keys():
#print("key:" + key)
for skey in skeys:
# pattern is very specific to current primary keys in
# config DB, may need to be updated later.
pattern = '^' + skey + '\|' + '|' + skey + '$' + \
'|' + '^' + skey + '$'
#print(pattern)
reg = re.compile(pattern)
#print(reg)
if reg.search(key):
# In primary key, only 1 match can be found, so return
# print("Added key:" + key)
Out[key] = In[key]
found = True
break
# Put the key in Out by default, if not added already.
# Remove later, if subelements does not contain any port.
if Out.get(key) is None:
Out[key] = type(In[key])()
if self.searchKeysInConfig(In[key], Out[key], skeys) == False:
del Out[key]
else:
found = True

"""
create Default Config using DFS for all ports
"""
def createDefConfig(In, Out, ports):

found = False
if isinstance(In, dict):
for key in In.keys():
#print("key:" + key)
for port in ports:
# pattern is very specific to current primary keys in
# config DB, may need to be updated later.
pattern = '^' + port + '\|' + '|' + port + '$' + \
'|' + '^' + port + '$'
#print(pattern)
reg = re.compile(pattern)
#print(reg)
if reg.search(key):
# In primary key, only 1 match can be found, so return
# print("Added key:" + key)
Out[key] = In[key]
found = True
break
# Put the key in Out by default, if not added already.
# Remove later, if subelements does not contain any port.
if Out.get(key) is None:
Out[key] = type(In[key])()
if createDefConfig(In[key], Out[key], ports) == False:
del Out[key]
else:
found = True
elif isinstance(In, list):
for skey in skeys:
if skey in In:
found = True
Out.append(skey)
#print("Added in list:" + port)

elif isinstance(In, list):
for port in ports:
if port in In:
found = True
Out.append(port)
#print("Added in list:" + port)
else:
# nothing for other keys
pass

else:
# nothing for other keys
pass
return found

"""
This function returns the relavant keys in Input Config.
For Example: All Ports related Config in Config DB.
"""
def configWithKeys(self, configIn=dict(), keys=list()):

configOut = dict()
try:
if len(configIn) and len(keys):
self.searchKeysInConfig(configIn, configOut, skeys=keys)
except Exception as e:
print("configWithKeys Failed, Error: {}".format(str(e)))
raise e

return configOut

return found
"""
Create a defConfig for given Ports from Default Config File.
"""
def getDefaultConfig(self, ports=list()):

# function code
try:
print("Generating default config for {}".format(ports))
defConfigIn = readJsonFile(DEFAULT_CONFIG_DB_JSON_FILE)
#print(defConfigIn)
defConfigOut = dict()
createDefConfig(defConfigIn, defConfigOut, ports)
self.searchKeysInConfig(defConfigIn, defConfigOut, skeys=ports)
except Exception as e:
print("Get Default Config Failed")
print(e)
print("getDefaultConfig Failed, Error: {}".format(str(e)))
raise e

return defConfigOut
Expand All @@ -520,13 +598,12 @@ def updateDiffConfigDB(self):
# Get the Diff
print('Generate Final Config to write in DB')
configDBdiff = self.diffJson()

# Process diff and create Config which can be updated in Config DB
configToLoad = self.createConfigToLoad(configDBdiff, \
self.configdbJsonIn, self.configdbJsonOut)

except Exception as e:
print("Update to Config DB Failed")
print("Config Diff Generation failed")
print(e)
raise e

Expand Down Expand Up @@ -657,7 +734,7 @@ def diffJson(self):
from jsondiff import diff
return diff(self.configdbJsonIn, self.configdbJsonOut, syntax='symmetric')

# end of config_mgmt class
# end of class ConfigMgmtDPB

"""
Test Functions:
Expand Down Expand Up @@ -774,7 +851,7 @@ def testRun_Delete_Add_Port(cmode, nmode, loadDef):
# TODO: Verify config in Config DB after writing to config DB.
print('Test Run Break Out Ports')
try:
cm = configMgmt('configDB', debug=True)
cm = ConfigMgmtDPB(source='configDB', debug=True)

delPorts = delPortDict[cmode]
addPorts = delPortDict[nmode]
Expand Down
45 changes: 34 additions & 11 deletions config/main.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
from swsssdk import ConfigDBConnector
from swsssdk import SonicV2Connector
from minigraph import parse_device_desc_xml
from config_mgmt import configMgmt
from config_mgmt import ConfigMgmt, ConfigMgmtDPB

import aaa
import mlnx
Expand Down Expand Up @@ -144,17 +144,37 @@ def _validate_interface_mode(ctx, BREAKOUT_CFG_FILE, interface_name, target_brko
sys.exit(0)
return True

def load_configMgmt(verbose):
def load_ConfigMgmt(verbose):
""" Load config for the commands which are capable of change in config DB. """
try:
# TODO: set allowExtraTables to False, i.e we should have yang models for
# each table in Config. [TODO: Create Yang model for each Table]
# cm = configMgmt(debug=verbose, allowExtraTables=False)
cm = configMgmt(debug=verbose, allowExtraTables=True)
cm = ConfigMgmtDPB(debug=verbose)
return cm
except Exception as e:
raise Exception("Failed to load the config. Error: {}".format(str(e)))

"""
Funtion to warn user about extra tables while Dynamic Port Breakout(DPB).
confirm: re-confirm from user to proceed.
Config Tables Without Yang model considered extra tables.
cm = instance of config MGMT class.
"""
def breakout_warnUser_extraTables(cm, final_delPorts, confirm=True):

try:
# check if any extra tables exist
eTables = cm.tablesWithOutYang()
if len(eTables):
# find relavent tables in extra tables, i.e. one which can have deleted
# ports
tables = cm.configWithKeys(configIn=eTables, keys=final_delPorts)
click.secho("Below Config can not be verified, It may cause harm "\
"to the system\n {}".format(json.dumps(tables, indent=2)))
click.confirm('Do you wish to Continue?', abort=True)
except Exception as e:
raise Exception("Failed in breakout_warnUser_extraTables. Error: {}".format(str(e)))

return

def breakout_Ports(cm, delPorts=list(), addPorts=list(), portJson=dict(), \
force=False, loadDefConfig=True, verbose=False):

Expand Down Expand Up @@ -755,7 +775,7 @@ def load(filename, yes, disable_validation):
# Verify config before config load
if not disable_validation:
try:
cm = configMgmt(source=filename)
cm = ConfigMgmt(source=filename)
if cm.validateConfigData()==False:
raise(Exception('Config Validation Failed'))
except Exception as e:
Expand Down Expand Up @@ -792,7 +812,7 @@ def reload(filename, yes, load_sysinfo, disable_validation):
# Verify config before stoping service
if not disable_validation:
try:
cm = configMgmt(source=filename)
cm = ConfigMgmt(source=filename)
if cm.validateConfigData()==False:
raise(Exception('Config Validation Failed'))
except Exception as e:
Expand Down Expand Up @@ -1809,11 +1829,14 @@ def breakout(ctx, interface_name, mode, verbose, force_remove_dependencies, load
# Start Interation with Dy Port BreakOut Config Mgmt
try:
""" Load config for the commands which are capable of change in config DB """
cm = load_configMgmt(verbose)
cm = load_ConfigMgmt(verbose)

""" Delete all ports if forced else print dependencies using configMgmt API """
""" Delete all ports if forced else print dependencies using ConfigMgmt API """
final_delPorts = [intf for intf in del_intf_dict.keys()]
""" Add ports with its attributes using configMgmt API """
""" Warn user if tables without yang models exist and have final_delPorts """
breakout_warnUser_extraTables(cm, final_delPorts, confirm=True)
# prompt
""" Add ports with its attributes using ConfigMgmt API """
final_addPorts = [intf for intf in port_dict.keys()]
portJson = dict(); portJson['PORT'] = port_dict
# breakout_Ports will abort operation on failure, So no need to check return
Expand Down

0 comments on commit c2e4eac

Please sign in to comment.