def validateMinVersion(version, profile_entry):
"""
Checks for the minimum version of a resource's type
"""
rsvLogger.debug('Testing minVersion \n\t' + str((version, profile_entry)))
# If version doesn't contain version as is, try it as v#_#_#
profile_entry_split = profile_entry.split('.')
# get version from payload
if (re.match('#([a-zA-Z0-9_.-]*\.)+[a-zA-Z0-9_.-]*', version) is not None):
v_payload = rst.getNamespace(version).split('.', 1)[-1]
v_payload = v_payload.replace('v', '')
if ('_' in v_payload):
payload_split = v_payload.split('_')
else:
payload_split = v_payload.split('.')
else:
payload_split = version.split('.')
paramPass = True
for a, b in zip(profile_entry_split, payload_split):
b = 0 if b is None else b
a = 0 if a is None else a
if (b > a):
break
if (b < a):
paramPass = False
break
# use string comparison, given version numbering is accurate to regex
rsvLogger.debug('\tpass ' + str(paramPass))
return msgInterop('MinVersion', '{} ({})'.format(profile_entry, payload_split), '<=', version, paramPass),\
paramPass
def validateWriteRequirement(propObj, profile_entry, itemname):
"""
Validates if a property is WriteRequirement or not
"""
rsvLogger.debug('writeable \n\t' + str(profile_entry))
permission = 'Read'
expected = "OData.Permission/ReadWrite" if profile_entry else "Any"
if not config['WriteCheck']:
paramPass = True
return msgInterop('WriteRequirement', profile_entry, expected, permission, paramPass),\
paramPass
if profile_entry:
targetProp = findPropItemforString(propObj, itemname.replace('#', ''))
propAttr = None
if targetProp is not None:
propAttr = targetProp.propDict.get('OData.Permissions')
if propAttr is not None:
permission = propAttr.get('EnumMember', 'Read')
paramPass = permission \
== "OData.Permission/ReadWrite"
else:
paramPass = False
else:
paramPass = True
rsvLogger.debug('\tpass ' + str(paramPass))
return msgInterop('WriteRequirement', profile_entry, expected, permission, paramPass),\
paramPass
def validateMinCount(alist, length, annotation=0):
"""
Validates Mincount annotation
"""
rsvLogger.debug('Testing minCount \n\texpected:' + str(length) + ', val:' +
str(annotation))
paramPass = len(alist) >= length or annotation >= length
rsvLogger.debug('\tpass ' + str(paramPass))
return msgInterop('MinCount', length, '<=', annotation if annotation > len(alist) else len(alist), paramPass),\
paramPass
def validateInteropURI(r_obj, profile_entry):
"""
Checks for the minimum version of a resource's type
"""
rsvLogger.debug('Testing URI \n\t' + str((r_obj.uri, profile_entry)))
my_id, my_uri = r_obj.jsondata.get('Id'), r_obj.uri
paramPass = compareRedfishURI(profile_entry, my_uri, my_id)
return msgInterop('InteropURI', '{}'.format(profile_entry), 'Matches', my_uri, paramPass),\
paramPass
def validateSupportedValues(enumlist, annotation):
"""
Validates SupportedVals annotation
"""
rsvLogger.debug('Testing supportedValues \n\t:' + str(enumlist) +
', exists:' + str(annotation))
for item in enumlist:
paramPass = item in annotation
if not paramPass:
break
rsvLogger.debug('\tpass ' + str(paramPass))
return msgInterop('SupportedValues', enumlist, 'included in...', annotation, paramPass),\
paramPass
def validateMembers(members, profile_entry, annotation):
"""
Validate an profile_entry of Members and its count annotation
"""
rsvLogger.debug('Testing members \n\t' +
str((members, profile_entry, annotation)))
if not validateRequirement('Mandatory', members):
return False
if "MinCount" in profile_entry:
mincount, mincountpass = validateMinCount(members,
profile_entry["MinCount"],
annotation)
mincount.name = 'MembersMinCount'
return mincount, mincountpass
def checkConditionalRequirementResourceLevel(r_exists, profile_entry,
itemname):
"""
Returns boolean if profile_entry's conditional is true or false
"""
rsvLogger.debug('Evaluating conditionalRequirements')
if "SubordinateToResource" in profile_entry:
isSubordinate = False
rsvLogger.warn('SubordinateToResource not supported')
return isSubordinate
elif "CompareProperty" in profile_entry:
# find property in json payload by working backwards thru objects
# rf_payload tuple is designed just for this piece, since there is
# no parent in dictionaries
if "CompareType" not in profile_entry:
rsvLogger.error(
"Invalid Profile - CompareType is required for CompareProperty but not found"
)
raise ValueError('CompareType missing with CompareProperty')
if "CompareValues" not in profile_entry and profile_entry[
'CompareType'] not in ['Absent', 'Present']:
rsvLogger.error(
"Invalid Profile - CompareValues is required for CompareProperty but not found"
)
raise ValueError('CompareValues missing with CompareProperty')
if "CompareValues" in profile_entry and profile_entry[
'CompareType'] in ['Absent', 'Present']:
rsvLogger.warn(
"Invalid Profile - CompareValues is not required for CompareProperty Absent or Present "
)
# compatability with old version, deprecate with versioning
present = r_exists.get(profile_entry.get('CompareProperty'), False)
compareType = profile_entry.get("CompareType",
profile_entry.get("Comparison"))
# only supports absent and present
return checkComparison('DNE' if not present else '[Object]',
compareType, None)[1]
else:
rsvLogger.error("Invalid Profile - No conditional given")
raise ValueError('No conditional given for Comparison')
def validateRequirement(profile_entry,
rf_payload_item=None,
conditional=False,
parent_object_tuple=None):
"""
Validates Requirement profile_entry
By default, only the first parameter is necessary and will always Pass if none given
"""
propDoesNotExist = (rf_payload_item == 'DNE')
rsvLogger.debug('Testing ReadRequirement \n\texpected:' +
str(profile_entry) + ', exists: ' +
str(not propDoesNotExist))
# If we're not mandatory, pass automatically, else fail
# However, we have other entries "IfImplemented" and "Conditional"
# note: Mandatory is default!! if present in the profile. Make sure this is made sure.
original_profile_entry = profile_entry
if profile_entry == "IfPopulated":
my_status = 'Enabled'
if parent_object_tuple:
my_state = parent_object_tuple[0].get('Status')
my_status = my_state.get('State') if my_state else my_status
if my_status != 'Absent':
profile_entry = 'Mandatory'
else:
profile_entry = 'Recommended'
if profile_entry == "Conditional" and conditional:
profile_entry = "Mandatory"
if profile_entry == "IfImplemented":
rsvLogger.debug('\tItem cannot be tested for Implementation')
paramPass = not profile_entry == "Mandatory" or \
profile_entry == "Mandatory" and not propDoesNotExist
if profile_entry == "Recommended" and propDoesNotExist:
rsvLogger.info('\tItem is recommended but does not exist')
if config['WarnRecommended']:
rsvLogger.warn(
'\tItem is recommended but does not exist, escalating to WARN')
paramPass = sEnum.WARN
rsvLogger.debug('\tpass ' + str(paramPass))
return msgInterop('ReadRequirement', original_profile_entry, 'Must Exist' if profile_entry == "Mandatory" else 'Any', 'Exists' if not propDoesNotExist else 'DNE', paramPass),\
paramPass
def validateInteropResource(propResourceObj, interop_profile, rf_payload):
"""
Base function that validates a single Interop Resource by its profile_entry
"""
msgs = []
rsvLogger.info('### Validating an InteropResource')
rsvLogger.debug(str(interop_profile))
counts = Counter()
# rf_payload_tuple provides the chain of dicts containing dicts, needed for CompareProperty
rf_payload_tuple = (rf_payload, None)
if "MinVersion" in interop_profile:
msg, success = validateMinVersion(propResourceObj.typeobj.fulltype,
interop_profile['MinVersion'])
msgs.append(msg)
if "URIs" in interop_profile:
rsvLogger.info('Validating URIs')
msg, success = validateInteropURI(propResourceObj,
interop_profile['URIs'])
msgs.append(msg)
if "PropertyRequirements" in interop_profile:
# problem, unlisted in 0.9.9a
innerDict = interop_profile["PropertyRequirements"]
for item in innerDict:
vmsg, isvalid = isPropertyValid(item, propResourceObj)
if not isvalid:
msgs.append(vmsg)
vmsg.name = '{}.{}'.format(item, vmsg.name)
counts['errorProfileValidityError'] += 1
continue
rsvLogger.info(
'### Validating PropertyRequirements for {}'.format(item))
pmsgs, pcounts = validatePropertyRequirement(
propResourceObj, innerDict[item],
(rf_payload.get(item, 'DNE'), rf_payload_tuple), item)
counts.update(pcounts)
msgs.extend(pmsgs)
if "ActionRequirements" in interop_profile:
innerDict = interop_profile["ActionRequirements"]
actionsJson = rf_payload.get('Actions', {})
rf_payloadInnerTuple = (actionsJson, rf_payload_tuple)
for item in innerDict:
actionName = '#' + propResourceObj.typeobj.stype + '.' + item
amsgs, acounts = validateActionRequirement(
propResourceObj, innerDict[item],
(actionsJson.get(actionName, 'DNE'), rf_payloadInnerTuple),
actionName)
counts.update(acounts)
msgs.extend(amsgs)
if "CreateResource" in interop_profile:
rsvLogger.info('Skipping CreateResource')
pass
if "DeleteResource" in interop_profile:
rsvLogger.info('Skipping DeleteResource')
pass
if "UpdateResource" in interop_profile:
rsvLogger.info('Skipping UpdateResource')
pass
for item in msgs:
if item.success == sEnum.WARN:
counts['warn'] += 1
elif item.success == sEnum.PASS:
counts['pass'] += 1
elif item.success == sEnum.FAIL:
counts['fail.{}'.format(item.name)] += 1
counts['totaltests'] += 1
return msgs, counts
def validatePropertyRequirement(propResourceObj,
profile_entry,
rf_payload_tuple,
itemname,
chkCondition=False):
"""
Validate PropertyRequirements
"""
msgs = []
counts = Counter()
rf_payload_item, rf_payload = rf_payload_tuple
if profile_entry is None or len(profile_entry) == 0:
rsvLogger.debug('there are no requirements for this prop')
else:
rsvLogger.debug('propRequirement with value: ' +
str(rf_payload_item if
not isinstance(rf_payload_item, dict) else 'dict'))
# If we're working with a list, then consider MinCount, Comparisons, then execute on each item
# list based comparisons include AnyOf and AllOf
if isinstance(rf_payload_item, list):
rsvLogger.debug("inside of a list: " + itemname)
if "MinCount" in profile_entry:
msg, success = validateMinCount(
rf_payload_item, profile_entry["MinCount"],
rf_payload[0].get(itemname.split('.')[-1] + '@odata.count', 0))
if not success:
rsvLogger.error("MinCount failed")
msgs.append(msg)
msg.name = itemname + '.' + msg.name
for k, v in profile_entry.get('PropertyRequirements', {}).items():
# default to AnyOf if Comparison is not present but Values is
comparisonValue = v.get(
"Comparison", "AnyOf") if v.get("Values") is not None else None
if comparisonValue in ["AllOf", "AnyOf"]:
msg, success = (checkComparison(
[val.get(k, 'DNE') for val in rf_payload_item],
comparisonValue, v["Values"]))
msgs.append(msg)
msg.name = itemname + '.' + msg.name
cnt = 0
for item in rf_payload_item:
listmsgs, listcounts = validatePropertyRequirement(
propResourceObj, profile_entry, (item, rf_payload),
itemname + '#' + str(cnt))
counts.update(listcounts)
msgs.extend(listmsgs)
cnt += 1
else:
# consider requirement before anything else
# problem: if dne, skip?
# Read Requirement is default mandatory if not present
msg, success = validateRequirement(profile_entry.get(
'ReadRequirement', 'Mandatory'),
rf_payload_item,
parent_object_tuple=rf_payload)
msgs.append(msg)
msg.name = itemname + '.' + msg.name
if "WriteRequirement" in profile_entry:
msg, success = validateWriteRequirement(
propResourceObj, profile_entry["WriteRequirement"], itemname)
msgs.append(msg)
msg.name = itemname + '.' + msg.name
if not success:
rsvLogger.error("WriteRequirement failed")
if "ConditionalRequirements" in profile_entry:
innerList = profile_entry["ConditionalRequirements"]
for item in innerList:
try:
if checkConditionalRequirement(propResourceObj, item,
rf_payload_tuple, itemname):
rsvLogger.info("\tCondition DOES apply")
conditionalMsgs, conditionalCounts = validatePropertyRequirement(
propResourceObj,
item,
rf_payload_tuple,
itemname,
chkCondition=True)
counts.update(conditionalCounts)
for item in conditionalMsgs:
item.name = item.name.replace(
'.', '.Conditional.', 1)
msgs.extend(conditionalMsgs)
else:
rsvLogger.info("\tCondition does not apply")
except ValueError as e:
rsvLogger.info(
"\tCondition was skipped due to payload error")
counts['errorProfileComparisonError'] += 1
if "MinSupportValues" in profile_entry:
msg, success = validateSupportedValues(
profile_entry["MinSupportValues"], rf_payload[0].get(
itemname.split('.')[-1] + '@Redfish.AllowableValues', []))
msgs.append(msg)
msg.name = itemname + '.' + msg.name
if not success:
rsvLogger.error("MinSupportValues failed")
if "Comparison" in profile_entry and not chkCondition and\
profile_entry["Comparison"] not in ["AnyOf", "AllOf"]:
msg, success = checkComparison(rf_payload_item,
profile_entry["Comparison"],
profile_entry.get("Values", []))
msgs.append(msg)
msg.name = itemname + '.' + msg.name
if not success:
rsvLogger.error("Comparison failed")
if "PropertyRequirements" in profile_entry:
innerDict = profile_entry["PropertyRequirements"]
if isinstance(rf_payload_item, dict):
for item in innerDict:
rsvLogger.debug('inside complex ' + itemname + '.' + item)
complexMsgs, complexCounts = validatePropertyRequirement(
propResourceObj, innerDict[item],
(rf_payload_item.get(item, 'DNE'), rf_payload_tuple),
item)
msgs.extend(complexMsgs)
counts.update(complexCounts)
else:
rsvLogger.info(
'complex {} is missing or not a dictionary'.format(
itemname))
return msgs, counts
def checkConditionalRequirement(propResourceObj, profile_entry,
rf_payload_tuple, itemname):
"""
Returns boolean if profile_entry's conditional is true or false
"""
rsvLogger.debug('Evaluating conditionalRequirements')
if "SubordinateToResource" in profile_entry:
isSubordinate = False
# iterate through parents via resourceObj
# list must be reversed to work backwards
resourceParent = propResourceObj.parent
for expectedParent in reversed(profile_entry["SubordinateToResource"]):
if resourceParent is not None:
parentType = resourceParent.typeobj.stype
isSubordinate = parentType == expectedParent
rsvLogger.debug('\tsubordinance ' + str(parentType) + ' ' +
str(isSubordinate))
resourceParent = resourceParent.parent
else:
rsvLogger.debug('no parent')
isSubordinate = False
return isSubordinate
elif "CompareProperty" in profile_entry:
rf_payload_item, rf_payload = rf_payload_tuple
# find property in json payload by working backwards thru objects
# rf_payload tuple is designed just for this piece, since there is
# no parent in dictionaries
comparePropName = profile_entry["CompareProperty"]
if "CompareType" not in profile_entry:
rsvLogger.error(
"Invalid Profile - CompareType is required for CompareProperty but not found"
)
raise ValueError('CompareType missing with CompareProperty')
if "CompareValues" not in profile_entry and profile_entry[
'CompareType'] not in ['Absent', 'Present']:
rsvLogger.error(
"Invalid Profile - CompareValues is required for CompareProperty but not found"
)
raise ValueError('CompareValues missing with CompareProperty')
if "CompareValues" in profile_entry and profile_entry[
'CompareType'] in ['Absent', 'Present']:
rsvLogger.warn(
"Invalid Profile - CompareValues is not required for CompareProperty Absent or Present "
)
while (rf_payload_item is None or comparePropName
not in rf_payload_item) and rf_payload is not None:
rf_payload_item, rf_payload = rf_payload
if rf_payload_item is None:
rsvLogger.error(
'Could not acquire expected CompareProperty {}'.format(
comparePropName))
return False
compareProp = rf_payload_item.get(comparePropName, 'DNE')
# compatability with old version, deprecate with versioning
compareType = profile_entry.get("CompareType",
profile_entry.get("Comparison"))
return checkComparison(compareProp, compareType,
profile_entry.get("CompareValues", []))[1]
else:
rsvLogger.error("Invalid Profile - No conditional given")
raise ValueError('No conditional given for Comparison')
def checkComparison(val, compareType, target):
"""
Validate a given comparison option, given a value and a target set
"""
rsvLogger.verboseout('Testing a comparison \n\t' +
str((val, compareType, target)))
vallist = val if isinstance(val, list) else [val]
paramPass = False
if compareType is None:
rsvLogger.error('CompareType not available in payload')
if compareType == "AnyOf":
for item in vallist:
paramPass = item in target
if paramPass:
break
else:
continue
if compareType == "AllOf":
alltarget = set()
for item in vallist:
paramPass = item in target and item not in alltarget
if paramPass:
alltarget.add(item)
if len(alltarget) == len(target):
break
else:
continue
paramPass = len(alltarget) == len(target)
if compareType == "LinkToResource":
vallink = val.get('@odata.id')
success, rf_payload, code, elapsed = rst.callResourceURI(vallink)
if success:
ourType = rf_payload.get('@odata.type')
if ourType is not None:
SchemaType = rst.getType(ourType)
paramPass = SchemaType in target
else:
paramPass = False
else:
paramPass = False
if compareType == "Absent":
paramPass = val == 'DNE'
if compareType == "Present":
paramPass = val != 'DNE'
if isinstance(target, list):
if len(target) >= 1:
target = target[0]
else:
target = 'DNE'
if target != 'DNE':
if compareType == "Equal":
paramPass = val == target
if compareType == "NotEqual":
paramPass = val != target
if compareType == "GreaterThan":
paramPass = val > target
if compareType == "GreaterThanOrEqual":
paramPass = val >= target
if compareType == "LessThan":
paramPass = val < target
if compareType == "LessThanOrEqual":
paramPass = val <= target
rsvLogger.debug('\tpass ' + str(paramPass))
return msgInterop('Comparison', target, compareType, val, paramPass),\
paramPass
