redfish-interop-validator 2.2.1__tar.gz → 2.2.3__tar.gz

{redfish_interop_validator-2.2.1/redfish_interop_validator.egg-info → redfish_interop_validator-2.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: redfish_interop_validator
-Version: 2.2.1
+Version: 2.2.3
 Summary: Redfish Interop Validator
 Home-page: https://github.com/DMTF/Redfish-Interop-Validator
 Author: DMTF, https://www.dmtf.org/standards/feedback

{redfish_interop_validator-2.2.1 → redfish_interop_validator-2.2.3}/redfish_interop_validator/RedfishInteropValidator.py

@@ -17,7 +17,7 @@ import redfish_interop_validator.traverseInterop as traverseInterop
 from redfish_interop_validator.profile import getProfiles, checkProfileAgainstSchema, hashProfile
 from redfish_interop_validator.validateResource import validateSingleURI, validateURITree
 
-tool_version = '2.2.1'
+tool_version = '2.2.3'
 
 # Set up the custom debug levels
 VERBOSE1 = logging.INFO - 1

{redfish_interop_validator-2.2.1 → redfish_interop_validator-2.2.3}/redfish_interop_validator/interop.py

@@ -247,6 +247,7 @@ def validateWriteRequirement(profile_entry, parent_object_payload, resource_head
     return msgInterop('WriteRequirement', profile_entry, expected_str, 'Writable' if is_writeable else 'Not Writable',
                       testResultEnum.PASS if is_writeable else result_not_supported), True
 
+
 def checkComparison(val, compareType, target):
     """
     Validate a given comparison option, given a value and a target set
@@ -278,6 +279,7 @@ def checkComparison(val, compareType, target):
             else:
                 continue
         paramPass = len(alltarget) == len(target)
+
     if compareType == "LinkToResource":
         if val == REDFISH_ABSENT:
             paramPass = False
@@ -299,7 +301,7 @@ def checkComparison(val, compareType, target):
     if compareType == "Present":
         paramPass = val != REDFISH_ABSENT
 
-    if isinstance(target, list):
+    if isinstance(target, list) and val != REDFISH_ABSENT:
         if compareType == "Equal":
             paramPass = val in target
         elif compareType == "NotEqual":
@@ -316,6 +318,10 @@ def checkComparison(val, compareType, target):
                     paramPass = val <= value
                 if paramPass is False:
                     break
+    elif compareType in ["Equal", "NotEqual", "GreaterThan", "GreaterThanOrEqual", "LessThan", "LessThanOrEqual"]:
+        if not isinstance(target, list):
+            my_logger.warn('CompareType {} requires a list of values'.format(compareType))
+
     my_logger.debug('\tpass ' + str(paramPass))
     return msgInterop('Comparison', target, compareType, val, paramPass),\
         paramPass
@@ -557,7 +563,8 @@ def validatePropertyRequirement(propResourceObj, profile_entry, rf_payload_tuple
         # problem: if dne, skip?
 
         # Read Requirement is default mandatory if not present
-        msg, success = validateRequirement(profile_entry.get('ReadRequirement', 'Mandatory'), redfish_value, parent_object_tuple=redfish_parent_payload)
+        requirement_entry = profile_entry.get('ReadRequirement', 'Mandatory')
+        msg, requirement_success = validateRequirement(requirement_entry, redfish_value, parent_object_tuple=redfish_parent_payload)
         msgs.append(msg)
         msg.name = item_name + '.' + msg.name
 
@@ -582,7 +589,12 @@ def validatePropertyRequirement(propResourceObj, profile_entry, rf_payload_tuple
             # Default to AnyOf
 
             my_compare = profile_entry.get("Comparison", "AnyOf")
-            msg, success = checkComparison(redfish_value, my_compare, profile_entry.get("Values", []))
+            my_values = profile_entry.get("Values", [])
+            # If absent and not comparing for absence...
+            if redfish_value == REDFISH_ABSENT and my_compare not in ['Absent', 'Present']:
+                msg, success = msgInterop('Comparison', my_values, my_compare, REDFISH_ABSENT, testResultEnum.NOT_TESTED), True
+            else:
+                msg, success = checkComparison(redfish_value, my_compare, my_values)
             msgs.append(msg)
             msg.name = item_name + '.' + msg.name
 
@@ -620,51 +632,96 @@ def validateActionRequirement(profile_entry, rf_payload_tuple, actionname):
     my_logger.verbose1('actionRequirement \n\tval: ' + str(rf_payload_item if not isinstance(
         rf_payload_item, dict) else 'dict') + ' ' + str(profile_entry))
 
+    action_readrequirement = profile_entry.get('ReadRequirement', "Mandatory")
+    actioninfo_requirement = profile_entry.get('ActionInfo', "None")
+
     if "ReadRequirement" in profile_entry:
         # problem: if dne, skip
-        msg, success = validateRequirement(profile_entry.get('ReadRequirement', "Mandatory"), rf_payload_item)
+        msg, success = validateRequirement(action_readrequirement, rf_payload_item)
         msgs.append(msg)
         msg.name = actionname + '.' + msg.name
         msg.success = testResultEnum.PASS if success else testResultEnum.FAIL
-
+    
     propDoesNotExist = (rf_payload_item == REDFISH_ABSENT)
     if propDoesNotExist:
         return msgs, counts
+
     if "@Redfish.ActionInfo" in rf_payload_item:
         vallink = rf_payload_item['@Redfish.ActionInfo']
         success, rf_payload_action, code, elapsed, _ = callResourceURI(vallink)
         if not success:
             rf_payload_action = None
 
+    if 'ActionInfo' in profile_entry and actioninfo_requirement in ["None"]:
+        # Create message if None is explicitly listed in the profile
+        msg = msgInterop('ActionInfo', 'None', '-', '-', testResultEnum.OK)
+        msg.name = actionname + '.' + msg.name
+        msgs.append(msg)
+
+    if actioninfo_requirement not in ["None"]:
+        if propDoesNotExist:
+            # not tested if action isn't present
+            msg = msgInterop('ActionInfo', actioninfo_requirement, '-', '-', testResultEnum.NOT_TESTED)
+
+        elif actioninfo_requirement == "Mandatory":
+            if rf_payload_action is None:
+                if "@Redfish.ActionInfo" in rf_payload_item:
+                    my_logger.error('Mandatory @Redfish.ActionInfo for {} listed on action but URI get was not successful'.format(actionname))
+                else:
+                    my_logger.error('@Redfish.ActionInfo for {} not listed, but is Mandatory'.format(actionname))
+                msg = msgInterop('ActionInfo', actioninfo_requirement, '-', '-', testResultEnum.FAIL)
+            else:
+                msg = msgInterop('ActionInfo', actioninfo_requirement, '-', '-', testResultEnum.PASS)
+
+        elif actioninfo_requirement == "Recommended":
+            if rf_payload_action is None:
+                if "@Redfish.ActionInfo" in rf_payload_item:
+                    my_logger.warn('Recommended @Redfish.ActionInfo for {} listed on action but URI get was not successful'.format(actionname))
+                    msg = msgInterop('ActionInfo', actioninfo_requirement, '-', '-', testResultEnum.WARN)
+                else:
+                    my_logger.info('Recommended @Redfish.ActionInfo for {} not listed'.format(actionname))
+                    msg = msgInterop('ActionInfo', actioninfo_requirement, '-', '-', testResultEnum.PASS)
+            else:
+                msg = msgInterop('ActionInfo', actioninfo_requirement, '-', '-', testResultEnum.PASS)
+
+        else:
+            my_logger.warn('Term "ActionInfo" has unknown value {}'.format(actioninfo_requirement))
+            msg = msgInterop('ActionInfo', actioninfo_requirement, '-', '-', testResultEnum.WARN)
+        msg.name = actionname + '.' + msg.name
+        msgs.append(msg)
+
     # problem: if dne, skip
     if "Parameters" in profile_entry:
-        innerDict = profile_entry["Parameters"]
+        parameter_dictionary = profile_entry["Parameters"]
         # problem: if dne, skip
         # assume mandatory
-        for k in innerDict:
-            item = innerDict[k]
+        for param in parameter_dictionary:
+            item = parameter_dictionary[param]
+            # Get Allowable Values for parameter
             values_array = None
+            # If our action info exists at all, prefer it
             if rf_payload_action is not None:
-                action_by_name = rf_payload_action['Parameters']
-                my_action = [x for x in action_by_name if x['Name'] == k]
-                if my_action:
-                    values_array = my_action[0].get('AllowableValues')
+                parameter_by_name = rf_payload_action['Parameters']
+                my_parameter = [x for x in parameter_by_name if x['Name'] == param]
+                if my_parameter:
+                    values_array = my_parameter[0].get('AllowableValues')
+            # Otherwise check for AllowableValues as additional property
             if values_array is None:
-                values_array = rf_payload_item.get(str(k) + '@Redfish.AllowableValues', REDFISH_ABSENT)
+                values_array = rf_payload_item.get(str(param) + '@Redfish.AllowableValues', REDFISH_ABSENT)
             if values_array == REDFISH_ABSENT:
-                my_logger.warning('\tNo such ActionInfo exists for this Action, and no AllowableValues exists.  Cannot validate the following parameters: {}'.format(k))
+                my_logger.warning('\tNo such ActionInfo exists for this Action, and no AllowableValues exists.  Cannot validate the following parameters: {}'.format(param))
                 msg = msgInterop('', item, '-', '-', testResultEnum.WARN)
-                msg.name = "{}.{}.{}".format(actionname, k, msg.name)
+                msg.name = "{}.{}.{}".format(actionname, param, msg.name)
                 msgs.append(msg)
             else:
                 msg, success = validateRequirement(item.get('ReadRequirement', "Mandatory"), values_array)
                 msgs.append(msg)
-                msg.name = "{}.{}.{}".format(actionname, k, msg.name)
+                msg.name = "{}.{}.{}".format(actionname, param, msg.name)
                 if "ParameterValues" in item:
                     msg, success = validateSupportedValues(
                             item["ParameterValues"], values_array)
                     msgs.append(msg)
-                    msg.name = "{}.{}.{}".format(actionname, k, msg.name)
+                    msg.name = "{}.{}.{}".format(actionname, param, msg.name)
                 if "RecommendedValues" in item:
                     msg, success = validateSupportedValues(
                             item["RecommendedValues"], values_array)
@@ -677,7 +734,7 @@ def validateActionRequirement(profile_entry, rf_payload_tuple, actionname):
                         msg.success = testResultEnum.PASS
 
                     msgs.append(msg)
-                    msg.name = "{}.{}.{}".format(actionname, k, msg.name)
+                    msg.name = "{}.{}.{}".format(actionname, param, msg.name)
     # consider requirement before anything else, what if action
     # if the action doesn't exist, you can't check parameters
     # if it doesn't exist, what should not be checked for action
@@ -724,17 +781,27 @@ def validateInteropResource(propResourceObj, interop_profile, rf_payload):
 
     if "UseCases" in interop_profile:
         for use_case in interop_profile['UseCases']:
-            entry_title = use_case.get("UseCaseTitle", "NoName").replace(' ','_')
-            my_logger.debug('UseCase {}'.format(entry_title))
+            entry_title = use_case.get("UseCaseTitle", "NoName").replace(' ', '_')
+            entry_type = use_case.get("UseCaseType", "Normal")
+            my_logger.debug('UseCase {} {}'.format(entry_title, entry_type))
 
             # Check if we have a valid UseCase
-            if 'URIs' not in use_case and 'UseCaseKeyProperty' not in use_case:
+            if 'URIs' not in use_case and 'UseCaseKeyProperty' not in use_case and entry_type != 'AbsentResource':
                 my_logger.error('UseCase does not have URIs or UseCaseKeyProperty...')
 
-            if 'UseCaseKeyProperty' in use_case:
+            if entry_type == 'AbsentResource':
+                my_status = rf_payload.get('Status')
+                if my_status:
+                    use_case_applies = my_status.get('State') == 'Absent'
+                else:
+                    use_case_applies = False
+                if 'URIs' in use_case:
+                    use_case_applies = use_case_applies and checkInteropURI(propResourceObj, use_case['URIs'])
+
+            elif 'UseCaseKeyProperty' in use_case:
                 entry_key, entry_comparison, entry_values = use_case['UseCaseKeyProperty'], use_case['UseCaseComparison'], use_case['UseCaseKeyValues']
 
-                _, use_case_applies = checkComparison(rf_payload.get(entry_key), entry_comparison, entry_values)
+                _, use_case_applies = checkComparison(rf_payload.get(entry_key, REDFISH_ABSENT), entry_comparison, entry_values)
 
                 # Check if URI applies to this usecase as well
                 if 'URIs' in use_case:
@@ -742,7 +809,7 @@ def validateInteropResource(propResourceObj, interop_profile, rf_payload):
 
             elif 'URIs' in use_case:
                 use_case_applies = checkInteropURI(propResourceObj, use_case['URIs'])
-            
+
             else:
                 use_case_applies = False
 

{redfish_interop_validator-2.2.1 → redfish_interop_validator-2.2.3}/redfish_interop_validator/validateResource.py

@@ -192,6 +192,9 @@ def validateSingleURI(URI, profile, uriName='', expectedType=None, expectedSchem
 
     for msg in results[uriName]['messages']:
         msg.parent_results = results
+        if msg.success == interop.testResultEnum.NOT_TESTED:
+            counts['notTested'] += 1
+
 
     return True, counts, results, (links, limited_links), resource_obj
 

{redfish_interop_validator-2.2.1 → redfish_interop_validator-2.2.3/redfish_interop_validator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: redfish_interop_validator
-Version: 2.2.1
+Version: 2.2.3
 Summary: Redfish Interop Validator
 Home-page: https://github.com/DMTF/Redfish-Interop-Validator
 Author: DMTF, https://www.dmtf.org/standards/feedback

{redfish_interop_validator-2.2.1 → redfish_interop_validator-2.2.3}/setup.py

@@ -11,7 +11,7 @@ with open("README.md", "r", "utf-8") as f:
 
 setup(
     name="redfish_interop_validator",
-    version="2.2.1",
+    version="2.2.3",
     description="Redfish Interop Validator",
     long_description=long_description,
     long_description_content_type="text/markdown",