X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Ftools%2Fwrk%2Fwrk_traffic_profile_parser.py;h=f5534657055a1b49afee05aec5bd8db270b2c1bf;hb=39c81e3674295df82172ac8df1fe3c1184b1d896;hp=e1f8365345754bd1f551714e36a95f47011e7ce8;hpb=a95c54b7821596402e0aa7136cd7d1de71a5b187;p=csit.git diff --git a/resources/tools/wrk/wrk_traffic_profile_parser.py b/resources/tools/wrk/wrk_traffic_profile_parser.py index e1f8365345..f553465705 100644 --- a/resources/tools/wrk/wrk_traffic_profile_parser.py +++ b/resources/tools/wrk/wrk_traffic_profile_parser.py @@ -1,4 +1,4 @@ -# Copyright (c) 2018 Cisco and / or its affiliates. +# Copyright (c) 2019 Cisco and / or its affiliates. # Licensed under the Apache License, Version 2.0 (the "License"); you may not # use this file except in compliance with the License. You may obtain a copy # of the License at: @@ -20,22 +20,32 @@ See LLD for the structure of a wrk traffic profile. from os.path import isfile from pprint import pformat -from yaml import load, YAMLError +from yaml import safe_load, YAMLError from robot.api import logger from resources.tools.wrk.wrk_errors import WrkError -class WrkTrafficProfile(object): +class WrkTrafficProfile: """The wrk traffic profile. """ - MANDATORY_PARAMS = ("urls", - "first-cpu", - "cpus", - "duration", - "nr-of-threads", - "nr-of-connections") + MANDATORY_PARAMS = ( + u"urls", + u"first-cpu", + u"cpus", + u"duration", + u"nr-of-threads", + u"nr-of-connections" + ) + + INTEGER_PARAMS = ( + (u"cpus", 1), + (u"first-cpu", 0), + (u"duration", 1), + (u"nr-of-threads", 1), + (u"nr-of-connections", 1) + ) def __init__(self, profile_name): """Read the traffic profile from the yaml file. @@ -51,29 +61,34 @@ class WrkTrafficProfile(object): self.profile_name = profile_name try: - with open(self.profile_name, 'r') as profile_file: - self.traffic_profile = load(profile_file) + with open(self.profile_name, u"rt") as profile_file: + self.traffic_profile = safe_load(profile_file) except IOError as err: - raise WrkError(msg="An error occurred while opening the file '{0}'." - .format(self.profile_name), - details=str(err)) + raise WrkError( + msg=f"An error occurred while opening the file " + f"'{self.profile_name}'.", details=str(err) + ) except YAMLError as err: - raise WrkError(msg="An error occurred while parsing the traffic " - "profile '{0}'.".format(self.profile_name), - details=str(err)) + raise WrkError( + msg=f"An error occurred while parsing the traffic profile " + f"'{self.profile_name}'.", details=str(err) + ) self._validate_traffic_profile() if self.traffic_profile: - logger.debug("\nThe wrk traffic profile '{0}' is valid.\n". - format(self.profile_name)) - logger.debug("wrk traffic profile '{0}':".format(self.profile_name)) + logger.debug( + f"\nThe wrk traffic profile '{self.profile_name}' is valid.\n" + ) + logger.debug(f"wrk traffic profile '{self.profile_name}':") logger.debug(pformat(self.traffic_profile)) else: - logger.debug("\nThe wrk traffic profile '{0}' is invalid.\n". - format(self.profile_name)) - raise WrkError("\nThe wrk traffic profile '{0}' is invalid.\n". - format(self.profile_name)) + logger.debug( + f"\nThe wrk traffic profile '{self.profile_name}' is invalid.\n" + ) + raise WrkError( + f"\nThe wrk traffic profile '{self.profile_name}' is invalid.\n" + ) def __repr__(self): return pformat(self.traffic_profile) @@ -88,166 +103,159 @@ class WrkTrafficProfile(object): doc/wrk_lld.rst """ - logger.debug("\nValidating the wrk traffic profile '{0}'...\n". - format(self.profile_name)) + logger.debug( + f"\nValidating the wrk traffic profile '{self.profile_name}'...\n" + ) + if not (self._validate_mandatory_structure() + and self._validate_mandatory_values() + and self._validate_optional_values() + and self._validate_dependencies()): + self.traffic_profile = None + + def _validate_mandatory_structure(self): + """Validate presence of mandatory parameters in trafic profile dict + :returns: whether mandatory structure is followed by the profile + :rtype: bool + """ # Level 1: Check if the profile is a dictionary: if not isinstance(self.traffic_profile, dict): - logger.error("The wrk traffic profile must be a dictionary.") - self.traffic_profile = None - return + logger.error(u"The wrk traffic profile must be a dictionary.") + return False # Level 2: Check if all mandatory parameters are present: is_valid = True for param in self.MANDATORY_PARAMS: if self.traffic_profile.get(param, None) is None: - logger.error("The parameter '{0}' in mandatory.".format(param)) + logger.error(f"The parameter '{param}' in mandatory.") is_valid = False - if not is_valid: - self.traffic_profile = None - return + return is_valid + + def _validate_mandatory_values(self): + """Validate that mandatory profile values satisfy their constraints + :returns: whether mandatory values are acceptable + :rtype: bool + """ # Level 3: Mandatory params: Check if urls is a list: is_valid = True - if not isinstance(self.traffic_profile["urls"], list): - logger.error("The parameter 'urls' must be a list.") - is_valid = False - - # Level 3: Mandatory params: Check if cpus is a valid integer: - try: - cpus = int(self.traffic_profile["cpus"]) - if cpus < 1: - raise ValueError - self.traffic_profile["cpus"] = cpus - except ValueError: - logger.error("The parameter 'cpus' must be an integer greater than " - "1.") - is_valid = False - - # Level 3: Mandatory params: Check if first-cpu is a valid integer: - try: - first_cpu = int(self.traffic_profile["first-cpu"]) - if first_cpu < 0: - raise ValueError - self.traffic_profile["first-cpu"] = first_cpu - except ValueError: - logger.error("The parameter 'first-cpu' must be an integer greater " - "than 1.") - is_valid = False - - # Level 3: Mandatory params: Check if duration is a valid integer: - try: - duration = int(self.traffic_profile["duration"]) - if duration < 1: - raise ValueError - self.traffic_profile["duration"] = duration - except ValueError: - logger.error("The parameter 'duration' must be an integer " - "greater than 1.") + if not isinstance(self.traffic_profile[u"urls"], list): + logger.error(u"The parameter 'urls' must be a list.") is_valid = False - # Level 3: Mandatory params: Check if nr-of-threads is a valid integer: - try: - nr_of_threads = int(self.traffic_profile["nr-of-threads"]) - if nr_of_threads < 1: - raise ValueError - self.traffic_profile["nr-of-threads"] = nr_of_threads - except ValueError: - logger.error("The parameter 'nr-of-threads' must be an integer " - "greater than 1.") - is_valid = False + # Level 3: Mandatory params: Check if integers are not below minimum + for param, minimum in self.INTEGER_PARAMS: + if not self._validate_int_param(param, minimum): + is_valid = False + return is_valid - # Level 3: Mandatory params: Check if nr-of-connections is a valid - # integer: - try: - nr_of_connections = int(self.traffic_profile["nr-of-connections"]) - if nr_of_connections < 1: - raise ValueError - self.traffic_profile["nr-of-connections"] = nr_of_connections - except ValueError: - logger.error("The parameter 'nr-of-connections' must be an integer " - "greater than 1.") - is_valid = False + def _validate_optional_values(self): + """Validate values for optional parameters, if present + :returns: whether present optional values are acceptable + :rtype: bool + """ + is_valid = True # Level 4: Optional params: Check if script is present: - script = self.traffic_profile.get("script", None) + script = self.traffic_profile.get(u"script", None) if script is not None: if not isinstance(script, str): - logger.error("The path to LuaJIT script in invalid") + logger.error(u"The path to LuaJIT script in invalid") is_valid = False else: if not isfile(script): - logger.error("The file '{0}' in not present.". - format(script)) + logger.error(f"The file '{script}' does not exist.") is_valid = False else: - self.traffic_profile["script"] = None - logger.debug("The optional parameter 'LuaJIT script' is not " - "defined. No problem.") + self.traffic_profile[u"script"] = None + logger.debug( + u"The optional parameter 'LuaJIT script' is not defined. " + u"No problem." + ) # Level 4: Optional params: Check if header is present: - header = self.traffic_profile.get("header", None) - if header: - if not (isinstance(header, dict) or isinstance(header, str)): - logger.error("The parameter 'header' is not valid.") + header = self.traffic_profile.get(u"header", None) + if header is not None: + if isinstance(header, dict): + header = u", ".join( + f"{0}: {1}".format(*item) for item in header.items() + ) + self.traffic_profile[u"header"] = header + elif not isinstance(header, str): + logger.error(u"The parameter 'header' type is not valid.") + is_valid = False + + if not header: + logger.error(u"The parameter 'header' is defined but empty.") is_valid = False - else: - if isinstance(header, dict): - header_lst = list() - for key, val in header.items(): - header_lst.append("{0}: {1}".format(key, val)) - if header_lst: - self.traffic_profile["header"] = ", ".join(header_lst) - else: - logger.error("The parameter 'header' is defined but " - "empty.") - is_valid = False else: - self.traffic_profile["header"] = None - logger.debug("The optional parameter 'header' is not defined. " - "No problem.") + self.traffic_profile[u"header"] = None + logger.debug( + u"The optional parameter 'header' is not defined. No problem." + ) # Level 4: Optional params: Check if latency is present: - latency = self.traffic_profile.get("latency", None) + latency = self.traffic_profile.get(u"latency", None) if latency is not None: - try: - latency = bool(latency) - self.traffic_profile["latency"] = latency - except ValueError: - logger.error("The parameter 'latency' must be boolean.") + if not isinstance(latency, bool): + logger.error(u"The parameter 'latency' must be boolean.") is_valid = False else: - self.traffic_profile["latency"] = False - logger.debug("The optional parameter 'latency' is not defined. " - "No problem.") + self.traffic_profile[u"latency"] = False + logger.debug( + u"The optional parameter 'latency' is not defined. No problem." + ) # Level 4: Optional params: Check if timeout is present: - timeout = self.traffic_profile.get("timeout", None) - if timeout: - try: - timeout = int(timeout) - if timeout < 1: - raise ValueError - self.traffic_profile["timeout"] = timeout - except ValueError: - logger.error("The parameter 'timeout' must be integer greater " - "than 1.") + if u"timeout" in self.traffic_profile: + if not self._validate_int_param(u"timeout", 1): is_valid = False else: - self.traffic_profile["timeout"] = None - logger.debug("The optional parameter 'timeout' is not defined. " - "No problem.") + self.traffic_profile[u"timeout"] = None + logger.debug( + u"The optional parameter 'timeout' is not defined. No problem." + ) - if not is_valid: - self.traffic_profile = None - return + return is_valid + + def _validate_dependencies(self): + """Validate dependencies between parameters - # Level 5: Check dependencies between parameters: + :returns: whether dependencies between parameters are acceptable + :rtype: bool + """ # Level 5: Check urls and cpus: - if self.traffic_profile["cpus"] % len(self.traffic_profile["urls"]): - logger.error("The number of CPUs must be a multiplication of the " - "number of URLs.") - self.traffic_profile = None + if self.traffic_profile[u"cpus"] % len(self.traffic_profile[u"urls"]): + logger.error( + u"The number of CPUs must be a multiple of the number of URLs." + ) + return False + return True + + def _validate_int_param(self, param, minimum): + """Validate that an int parameter is set acceptably + If it is not an int already but a string, convert and store it as int. + + :param param: Name of a traffic profile parameter + :param minimum: The minimum value for the named parameter + :type param: str + :type minimum: int + :returns: whether param is set to an int of at least minimum value + :rtype: bool + """ + value = self._traffic_profile[param] + if isinstance(value, str): + if value.isdigit(): + value = int(value) + else: + value = minimum - 1 + if isinstance(value, int) and value >= minimum: + self.traffic_profile[param] = value + return True + logger.error( + f"The parameter '{param}' must be an integer and at least {minimum}" + ) + return False @property def profile_name(self):