Skip to content

SONiC CBF MAPs Yang #9116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 6, 2021
Merged

SONiC CBF MAPs Yang #9116

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b9cc150
SONiC CBF MAPs Yang
Oct 29, 2021
121ceff
Updated sample config
Nov 2, 2021
c27d392
Fix sonic-yang-mgmt
TACappleman Nov 5, 2021
bb0d9c8
Changed Xlate functions to handle general Type 1 lists
Dec 2, 2021
6f192dc
Small update correcting code comments
Dec 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 24 additions & 22 deletions src/sonic-yang-mgmt/sonic_yang_ext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@
from xmltodict import parse
from glob import glob

qos_maps_model = ['DSCP_TO_TC_MAP_LIST',
'DOT1P_TO_TC_MAP_LIST',
'TC_TO_PRIORITY_GROUP_MAP_LIST',
'TC_TO_QUEUE_MAP_LIST',
'MAP_PFC_PRIORITY_TO_QUEUE_LIST',
'PFC_PRIORITY_TO_PRIORITY_GROUP_MAP_LIST']
Type_1_list_maps_model = ['DSCP_TO_TC_MAP_LIST',
'DOT1P_TO_TC_MAP_LIST',
'TC_TO_PRIORITY_GROUP_MAP_LIST',
'TC_TO_QUEUE_MAP_LIST',
'MAP_PFC_PRIORITY_TO_QUEUE_LIST',
'PFC_PRIORITY_TO_PRIORITY_GROUP_MAP_LIST',
'DSCP_TO_FC_MAP_LIST',
'EXP_TO_FC_MAP_LIST']

"""
This is the Exception thrown out of all public function of this class.
Expand Down Expand Up @@ -413,15 +415,15 @@ def _yangConvert(val):
return vValue

"""
Xlate a Qos Maps list
Xlate a Type 1 map list
This function will xlate from a dict in config DB to a Yang JSON list
using yang model. Output will be go in self.xlateJson

Note: Exceptions from this function are collected in exceptionList and
are displayed only when an entry is not xlated properly from ConfigDB
to sonic_yang.json.

QOS MAPS Yang has inner list, which is diffrent from config DB.
Type 1 map Yang has inner list, which is diffrent from config DB.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type 1 Lists has inner list, which is different from generic lists in config DB.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will update, thanks

Each field value in config db should be converted to inner list with
key and value.
Example:
Expand Down Expand Up @@ -465,7 +467,7 @@ def _yangConvert(val):
}
}
"""
def _xlateQosMapList(self, model, yang, config, table, exceptionList):
def _xlateType1MapList(self, model, yang, config, table, exceptionList):

#create a dict to map each key under primary key with a dict yang model.
#This is done to improve performance of mapping from values of TABLEs in
Expand Down Expand Up @@ -524,12 +526,12 @@ def _xlateQosMapList(self, model, yang, config, table, exceptionList):
to sonic_yang.json.
"""
def _xlateList(self, model, yang, config, table, exceptionList):
#Qos Map lists needs special handling because of inner yang list and
#config db format.
if model['@name'] in qos_maps_model:
self.sysLog(msg="_xlateQosMapList: {}".format(model['@name']))
self._xlateQosMapList(model, yang,config, table, exceptionList)

# Type 1 lists need special handling because of inner yang list and
# config db format.
if model['@name'] in Type_1_list_maps_model:
self.sysLog(msg="_xlateType1MapList: {}".format(model['@name']))
self._xlateType1MapList(model, yang, config, table, exceptionList)
return

#create a dict to map each key under primary key with a dict yang model.
Expand Down Expand Up @@ -744,7 +746,7 @@ def _revYangConvert(val):

"""
Rev xlate from <TABLE>_LIST to table in config DB
QOS MAP Yang has inner list, each inner list key:val should
Type 1 MAPs Yang has inner list, each inner list key:val should
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type 1 Maps Lists or Type 1 Lists

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will update, thanks

be mapped to field:value in Config DB.
Example:

Expand Down Expand Up @@ -788,14 +790,14 @@ def _revYangConvert(val):
}
"""

def _revQosMapXlateList(self, model, yang, config, table):
def _revXlateType1MapList(self, model, yang, config, table):
# get keys from YANG model list itself
listKeys = model['key']['@value']
# create a dict to map each key under primary key with a dict yang model.
# This is done to improve performance of mapping from values of TABLEs in
# config DB to leaf in YANG LIST.

# Gather inner list key and value from model
# Gather inner list key and value from model
inner_clist = model.get('list')
if inner_clist:
inner_listKey = inner_clist['key']['@value']
Expand Down Expand Up @@ -824,10 +826,10 @@ def _revQosMapXlateList(self, model, yang, config, table):
Rev xlate from <TABLE>_LIST to table in config DB
"""
def _revXlateList(self, model, yang, config, table):
# special processing for QOS Map table.
if model['@name'] in qos_maps_model:
self._revQosMapXlateList(model, yang, config, table)

# special processing for Type 1 Map tables.
if model['@name'] in Type_1_list_maps_model:
self._revXlateType1MapList(model, yang, config, table)
return

# get keys from YANG model list itself
Expand Down
2 changes: 2 additions & 0 deletions src/sonic-yang-models/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@
'./yang-models/sonic-scheduler.yang',
'./yang-models/sonic-wred-profile.yang',
'./yang-models/sonic-queue.yang',
'./yang-models/sonic-dscp-fc-map.yang',
'./yang-models/sonic-exp-fc-map.yang',
'./yang-models/sonic-dscp-tc-map.yang',
'./yang-models/sonic-dot1p-tc-map.yang',
'./yang-models/sonic-tc-priority-group-map.yang',
Expand Down
24 changes: 23 additions & 1 deletion src/sonic-yang-models/tests/files/sample_config_db.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1188,7 +1188,29 @@
"scheduler": "TEST@1",
"wred_profile": "Wred1"
}
},
},

"DSCP_TO_FC_MAP": {
"Dscp_to_fc_map1": {
"1": "1",
"2": "2"
},
"Dscp_to_fc_map2": {
"3": "3",
"4": "4"
}
},

"EXP_TO_FC_MAP": {
"Exp_to_fc_map1": {
"1": "1",
"2": "2"
},
"Exp_to_fc_map2": {
"3": "3",
"4": "4"
}
},

"DSCP_TO_TC_MAP": {
"Dscp_to_tc_map1": {
Expand Down
24 changes: 24 additions & 0 deletions src/sonic-yang-models/tests/yang_model_tests/tests/cbfmaps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"DSCP_TO_FC_MAP_CREATE": {
"desc": "Configure a DSCP to Forwarding class map."
},
"DSCP_TO_FC_MAP_CREATE_INVALID_DSCP": {
"desc": "Configure a DSCP to Forwarding class map with invalid key.",
"eStr": "Invalid DSCP"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eStr should match to the error from Libyang. This may not pass. Do you see successful build of PKG.

Copy link
Contributor Author

@Cosmin-Jinga-MS Cosmin-Jinga-MS Dec 3, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

            list DSCP_TO_FC_MAP { //this is list inside list for storing mapping between two fields

                key "dscp";

                leaf dscp {
                    type string {
                        pattern "6[0-3]|[1-5][0-9]?|[0-9]?" {
                            error-message "Invalid DSCP";
                            error-app-tag dscp-invalid;
                        }
                    }
                }

Unless I misunderstood what you meant I think the error strings do match in this case.
Can you please expand on what I need to run to build PKG in order to check?(I'd expect it to be in order since the pipeline checks have passed)

},
"DSCP_TO_FC_MAP_CREATE_INVALID_FC": {
"desc": "Configure a DSCP to Forwarding class map with invalid value.",
"eStr": "Invalid Forwarding Class"
},
"EXP_TO_FC_MAP_CREATE": {
"desc": "Configure a EXP to Forwarding class map."
},
"EXP_TO_FC_MAP_CREATE_INVALID_EXP": {
"desc": "Configure a EXP to Forwarding class map with invalid key.",
"eStr": "Invalid EXP"
},
"EXP_TO_FC_MAP_CREATE_INVALID_FC": {
"desc": "Configure a EXP to Forwarding class map with invalid value.",
"eStr": "Invalid Forwarding Class"
}
}
159 changes: 159 additions & 0 deletions src/sonic-yang-models/tests/yang_model_tests/tests_config/cbfmaps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
{
"DSCP_TO_FC_MAP_CREATE": {
"sonic-dscp-fc-map:sonic-dscp-fc-map": {
"sonic-dscp-fc-map:DSCP_TO_FC_MAP": {
"DSCP_TO_FC_MAP_LIST": [
{
"name": "map1",
"DSCP_TO_FC_MAP": [
{
"dscp": "1",
"fc": "1"
},
{
"dscp":"2",
"fc":"2"
}
]
},
{
"name": "map2",
"DSCP_TO_FC_MAP": [
{
"dscp": "1",
"fc": "1"
},
{
"dscp":"2",
"fc":"2"
}
]
}
]
}
}
},

"DSCP_TO_FC_MAP_CREATE_INVALID_DSCP": {
"sonic-dscp-fc-map:sonic-dscp-fc-map": {
"sonic-dscp-fc-map:DSCP_TO_FC_MAP": {
"DSCP_TO_FC_MAP_LIST": [
{
"name": "map3",
"DSCP_TO_FC_MAP": [
{
"dscp": "64",
"fc": "1"
},
{
"dscp":"2",
"fc":"2"
}
]
}
]
}
}
},

"DSCP_TO_FC_MAP_CREATE_INVALID_FC": {
"sonic-dscp-fc-map:sonic-dscp-fc-map": {
"sonic-dscp-fc-map:DSCP_TO_FC_MAP": {
"DSCP_TO_FC_MAP_LIST": [
{
"name": "map3",
"DSCP_TO_FC_MAP": [
{
"dscp": "1",
"fc": "8"
},
{
"dscp":"2",
"fc":"2"
}
]
}
]
}
}
},

"EXP_TO_FC_MAP_CREATE": {
"sonic-exp-fc-map:sonic-exp-fc-map": {
"sonic-exp-fc-map:EXP_TO_FC_MAP": {
"EXP_TO_FC_MAP_LIST": [
{
"name": "map1",
"EXP_TO_FC_MAP": [
{
"exp": "1",
"fc": "1"
},
{
"exp":"2",
"fc":"2"
}
]
},
{
"name": "map2",
"EXP_TO_FC_MAP": [
{
"exp": "1",
"fc": "1"
},
{
"exp":"2",
"fc":"2"
}
]
}
]
}
}
},

"EXP_TO_FC_MAP_CREATE_INVALID_EXP": {
"sonic-exp-fc-map:sonic-exp-fc-map": {
"sonic-exp-fc-map:EXP_TO_FC_MAP": {
"EXP_TO_FC_MAP_LIST": [
{
"name": "map3",
"EXP_TO_FC_MAP": [
{
"exp": "8",
"fc": "1"
},
{
"exp":"2",
"fc":"2"
}
]
}
]
}
}
},

"EXP_TO_FC_MAP_CREATE_INVALID_FC": {
"sonic-exp-fc-map:sonic-exp-fc-map": {
"sonic-exp-fc-map:EXP_TO_FC_MAP": {
"EXP_TO_FC_MAP_LIST": [
{
"name": "map3",
"EXP_TO_FC_MAP": [
{
"exp": "1",
"fc": "8"
},
{
"exp":"2",
"fc":"2"
}
]
}
]
}
}
}
}
Loading