Skip to content

[cvl] Enforce mandatory field validation for OP_CREATE operations #212

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

Open
Sumalatha-G-ML wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[cvl] Enforce mandatory field validation for OP_CREATE operations #212

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 48 additions & 0 deletions cvl/cvl_api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,13 @@ func (c *CVL) ValidateEditConfig(cfgData []cmn.CVLEditConfigData) (cvlErr CVLErr
return cvlErrObj, CVL_SYNTAX_ERROR
}

//Check mandatory fields for OP_CREATE (Fixes issue #2283)
//Enforce YANG "mandatory true" constraint during CREATE operations
yangListName := getRedisTblToYangList(tbl, key)
if cvlErrObj := c.checkMandatoryFieldsForCreate(cfgData[i], yangListName, tbl, key); cvlErrObj.ErrCode != CVL_SUCCESS {
return cvlErrObj, cvlErrObj.ErrCode
}

case cmn.OP_UPDATE:
//Get the existing data from Redis to cache, so that final
//validation can be done after merging this dependent data
Expand Down Expand Up @@ -604,6 +611,47 @@ func (c *CVL) ValidateEditConfig(cfgData []cmn.CVLEditConfigData) (cvlErr CVLErr
return cvlErrObj, CVL_SUCCESS
}

// checkMandatoryFieldsForCreate checks if all mandatory fields are present during OP_CREATE
// This function enforces YANG "mandatory true" constraint for CREATE operations
// Fixes issue: https://github.com/sonic-net/SONiC/issues/2283
func (c *CVL) checkMandatoryFieldsForCreate(cfgData cmn.CVLEditConfigData, yangListName, tbl, key string) CVLErrorInfo {
var cvlErrObj CVLErrorInfo
cvlErrObj.ErrCode = CVL_SUCCESS

// Get YANG schema information for this table
listInfo, exists := modelInfo.tableInfo[tbl]
if !exists {
CVL_LOG(INFO_DEBUG, "No YANG model found for table %s, skipping mandatory check", tbl)
return cvlErrObj
}

// Iterate through all leaf nodes in the YANG model
for fieldName, fieldInfo := range listInfo.mapLeaf {
// Check if this is a mandatory field
if fieldInfo.yangEntry != nil && fieldInfo.yangEntry.Mandatory {
// Check if the mandatory field is present in the data
if _, exists := cfgData.Data[fieldName]; !exists {
// Mandatory field is missing
CVL_LOG(WARNING, "Mandatory field '%s' missing for CREATE operation on table %s, key %s",
fieldName, tbl, key)

cvlErrObj.ErrCode = CVL_SEMANTIC_ERROR
cvlErrObj.TableName = tbl
cvlErrObj.Keys = splitKeyComponents(tbl, key)
cvlErrObj.Field = fieldName
cvlErrObj.Msg = fmt.Sprintf("Mandatory field '%s' is missing", fieldName)
cvlErrObj.CVLErrDetails = cvlErrorMap[cvlErrObj.ErrCode]
cvlErrObj.ErrAppTag = "missing-mandatory-field"
cvlErrObj.ConstraintErrMsg = cvlErrObj.Msg

return cvlErrObj
}
}
}

return cvlErrObj
}

func (c *CVL) markCfgDataValidated(cfgData *cmn.CVLEditConfigData, tbl, key string) {
if cfgData.VType != cmn.VALIDATE_NONE {
for k := range c.requestCache[tbl][key] {
Expand Down
Loading