1 # Copyright (c) 2019 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
16 Parsing of the specification YAML file.
21 from yaml import load, YAMLError
22 from pprint import pformat
24 from errors import PresentationError
25 from utils import get_last_successful_build_number
26 from utils import get_last_completed_build_number
29 class Specification(object):
30 """Specification of Presentation and analytics layer.
32 - based on specification specified in the specification YAML file
33 - presentation and analytics layer is model driven
36 # Tags are used in specification YAML file and replaced while the file is
41 def __init__(self, cfg_file):
44 :param cfg_file: File handler for the specification YAML file.
45 :type cfg_file: BinaryIO
47 self._cfg_file = cfg_file
50 self._specification = {"environment": dict(),
51 "configuration": dict(),
61 def specification(self):
62 """Getter - specification.
64 :returns: Specification.
67 return self._specification
70 def environment(self):
71 """Getter - environment.
73 :returns: Environment specification.
76 return self._specification["environment"]
79 def configuration(self):
80 """Getter - configuration.
82 :returns: Configuration of PAL.
85 return self._specification["configuration"]
89 """Getter - static content.
91 :returns: Static content specification.
94 return self._specification["static"]
100 :returns: Mapping of the old names of test cases to the new (actual)
104 return self._specification["configuration"]["mapping"]
108 """Getter - Ignore list.
110 :returns: List of ignored test cases.
113 return self._specification["configuration"]["ignore"]
117 """Getter - Alerting.
119 :returns: Specification of alerts.
122 return self._specification["configuration"]["alerting"]
126 """Getter - specification - inputs.
132 return self._specification["input"]
136 """Getter - builds defined in specification.
138 :returns: Builds defined in the specification.
141 return self.input["builds"]
145 """Getter - specification - output formats and versions to be generated.
147 - versions: full, ...
149 :returns: Outputs to be generated.
152 return self._specification["output"]
156 """Getter - tables to be generated.
158 :returns: List of specifications of tables to be generated.
161 return self._specification["tables"]
165 """Getter - plots to be generated.
167 :returns: List of specifications of plots to be generated.
170 return self._specification["plots"]
174 """Getter - files to be generated.
176 :returns: List of specifications of files to be generated.
179 return self._specification["files"]
183 """Getter - Continuous Performance Trending and Analysis to be
186 :returns: List of specifications of Continuous Performance Trending and
187 Analysis to be generated.
190 return self._specification["cpta"]
192 def set_input_state(self, job, build_nr, state):
193 """Set the state of input
202 for build in self._specification["input"]["builds"][job]:
203 if build["build"] == build_nr:
204 build["status"] = state
207 raise PresentationError("Build '{}' is not defined for job '{}'"
208 " in specification file.".
209 format(build_nr, job))
211 raise PresentationError("Job '{}' and build '{}' is not defined in "
212 "specification file.".format(job, build_nr))
214 def set_input_file_name(self, job, build_nr, file_name):
215 """Set the state of input
224 for build in self._specification["input"]["builds"][job]:
225 if build["build"] == build_nr:
226 build["file-name"] = file_name
229 raise PresentationError("Build '{}' is not defined for job '{}'"
230 " in specification file.".
231 format(build_nr, job))
233 raise PresentationError("Job '{}' and build '{}' is not defined in "
234 "specification file.".format(job, build_nr))
236 def _get_build_number(self, job, build_type):
237 """Get the number of the job defined by its name:
238 - lastSuccessfulBuild
241 :param job: Job name.
242 :param build_type: Build type:
243 - lastSuccessfulBuild
246 :raises PresentationError: If it is not possible to get the build
248 :returns: The build number.
252 # defined as a range <start, end>
253 if build_type == "lastSuccessfulBuild":
254 # defined as a range <start, lastSuccessfulBuild>
255 ret_code, build_nr, _ = get_last_successful_build_number(
256 self.environment["urls"]["URL[JENKINS,CSIT]"], job)
257 elif build_type == "lastCompletedBuild":
258 # defined as a range <start, lastCompletedBuild>
259 ret_code, build_nr, _ = get_last_completed_build_number(
260 self.environment["urls"]["URL[JENKINS,CSIT]"], job)
262 raise PresentationError("Not supported build type: '{0}'".
265 raise PresentationError("Not possible to get the number of the "
268 build_nr = int(build_nr)
270 except ValueError as err:
271 raise PresentationError("Not possible to get the number of the "
272 "build number.\nReason: {0}".format(err))
274 def _get_type_index(self, item_type):
275 """Get index of item type (environment, input, output, ...) in
276 specification YAML file.
278 :param item_type: Item type: Top level items in specification YAML file,
279 e.g.: environment, input, output.
281 :returns: Index of the given item type.
286 for item in self._cfg_yaml:
287 if item["type"] == item_type:
292 def _find_tag(self, text):
293 """Find the first tag in the given text. The tag is enclosed by the
294 TAG_OPENER and TAG_CLOSER.
296 :param text: Text to be searched.
298 :returns: The tag, or None if not found.
302 start = text.index(self.TAG_OPENER)
303 end = text.index(self.TAG_CLOSER, start + 1) + 1
304 return text[start:end]
308 def _replace_tags(self, data, src_data=None):
309 """Replace tag(s) in the data by their values.
311 :param data: The data where the tags will be replaced by their values.
312 :param src_data: Data where the tags are defined. It is dictionary where
313 the key is the tag and the value is the tag value. If not given, 'data'
315 :type data: str or dict
317 :returns: Data with the tags replaced.
319 :raises: PresentationError if it is not possible to replace the tag or
320 the data is not the supported data type (str, dict).
326 if isinstance(data, str):
327 tag = self._find_tag(data)
329 data = data.replace(tag, src_data[tag[1:-1]])
331 elif isinstance(data, dict):
333 for key, value in data.items():
334 tag = self._find_tag(value)
337 data[key] = value.replace(tag, src_data[tag[1:-1]])
340 raise PresentationError("Not possible to replace the "
341 "tag '{}'".format(tag))
343 self._replace_tags(data, src_data)
345 raise PresentationError("Replace tags: Not supported data type.")
349 def _parse_env(self):
350 """Parse environment specification in the specification YAML file.
353 logging.info("Parsing specification file: environment ...")
355 idx = self._get_type_index("environment")
360 self._specification["environment"]["configuration"] = \
361 self._cfg_yaml[idx]["configuration"]
363 self._specification["environment"]["configuration"] = None
366 self._specification["environment"]["paths"] = \
367 self._replace_tags(self._cfg_yaml[idx]["paths"])
369 self._specification["environment"]["paths"] = None
372 self._specification["environment"]["urls"] = \
373 self._cfg_yaml[idx]["urls"]
375 self._specification["environment"]["urls"] = None
378 self._specification["environment"]["make-dirs"] = \
379 self._cfg_yaml[idx]["make-dirs"]
381 self._specification["environment"]["make-dirs"] = None
384 self._specification["environment"]["remove-dirs"] = \
385 self._cfg_yaml[idx]["remove-dirs"]
387 self._specification["environment"]["remove-dirs"] = None
390 self._specification["environment"]["build-dirs"] = \
391 self._cfg_yaml[idx]["build-dirs"]
393 self._specification["environment"]["build-dirs"] = None
396 self._specification["environment"]["testbeds"] = \
397 self._cfg_yaml[idx]["testbeds"]
399 self._specification["environment"]["testbeds"] = None
401 logging.info("Done.")
403 def _parse_configuration(self):
404 """Parse configuration of PAL in the specification YAML file.
407 logging.info("Parsing specification file: configuration ...")
409 idx = self._get_type_index("configuration")
411 logging.warning("No configuration information in the specification "
416 self._specification["configuration"] = self._cfg_yaml[idx]
419 raise PresentationError("No configuration defined.")
421 # Data sets: Replace ranges by lists
422 for set_name, data_set in self.configuration["data-sets"].items():
423 if not isinstance(data_set, dict):
425 for job, builds in data_set.items():
427 if isinstance(builds, dict):
428 build_nr = builds.get("end", None)
430 build_nr = int(build_nr)
432 # defined as a range <start, build_type>
433 build_nr = self._get_build_number(job, build_nr)
434 builds = [x for x in range(builds["start"], build_nr+1)]
435 self.configuration["data-sets"][set_name][job] = builds
437 # Data sets: add sub-sets to sets (only one level):
438 for set_name, data_set in self.configuration["data-sets"].items():
439 if isinstance(data_set, list):
441 for item in data_set:
443 for key, val in self.configuration["data-sets"][item].\
447 raise PresentationError(
448 "Data set {0} is not defined in "
449 "the configuration section.".format(item))
450 self.configuration["data-sets"][set_name] = new_set
454 mapping_file_name = self._specification["configuration"].\
455 get("mapping-file", None)
456 if mapping_file_name:
457 logging.debug("Mapping file: '{0}'".format(mapping_file_name))
459 with open(mapping_file_name, 'r') as mfile:
460 mapping = load(mfile)
461 logging.debug("Loaded mapping table:\n{0}".format(mapping))
462 except (YAMLError, IOError) as err:
463 raise PresentationError(
464 msg="An error occurred while parsing the mapping file "
465 "'{0}'.".format(mapping_file_name),
467 # Make sure everything is lowercase
469 self._specification["configuration"]["mapping"] = \
470 {key.lower(): val.lower() for key, val in mapping.iteritems()}
472 self._specification["configuration"]["mapping"] = dict()
476 ignore_list_name = self._specification["configuration"].\
477 get("ignore-list", None)
479 logging.debug("Ignore list file: '{0}'".format(ignore_list_name))
481 with open(ignore_list_name, 'r') as ifile:
483 logging.debug("Loaded ignore list:\n{0}".format(ignore))
484 except (YAMLError, IOError) as err:
485 raise PresentationError(
486 msg="An error occurred while parsing the ignore list file "
487 "'{0}'.".format(ignore_list_name),
489 # Make sure everything is lowercase
491 self._specification["configuration"]["ignore"] = \
492 [item.lower() for item in ignore]
494 self._specification["configuration"]["ignore"] = list()
496 logging.info("Done.")
498 def _parse_input(self):
499 """Parse input specification in the specification YAML file.
501 :raises: PresentationError if there are no data to process.
504 logging.info("Parsing specification file: input ...")
506 idx = self._get_type_index("input")
508 raise PresentationError("No data to process.")
511 for key, value in self._cfg_yaml[idx]["general"].items():
512 self._specification["input"][key] = value
513 self._specification["input"]["builds"] = dict()
515 for job, builds in self._cfg_yaml[idx]["builds"].items():
517 if isinstance(builds, dict):
518 build_nr = builds.get("end", None)
520 build_nr = int(build_nr)
522 # defined as a range <start, build_type>
523 build_nr = self._get_build_number(job, build_nr)
524 builds = [x for x in range(builds["start"], build_nr+1)]
525 self._specification["input"]["builds"][job] = list()
527 self._specification["input"]["builds"][job]. \
528 append({"build": build, "status": None})
531 logging.warning("No build is defined for the job '{}'. "
532 "Trying to continue without it.".
535 raise PresentationError("No data to process.")
537 logging.info("Done.")
539 def _parse_output(self):
540 """Parse output specification in the specification YAML file.
542 :raises: PresentationError if there is no output defined.
545 logging.info("Parsing specification file: output ...")
547 idx = self._get_type_index("output")
549 raise PresentationError("No output defined.")
552 self._specification["output"] = self._cfg_yaml[idx]
553 except (KeyError, IndexError):
554 raise PresentationError("No output defined.")
556 logging.info("Done.")
558 def _parse_static(self):
559 """Parse specification of the static content in the specification YAML
563 logging.info("Parsing specification file: static content ...")
565 idx = self._get_type_index("static")
567 logging.warning("No static content specified.")
569 for key, value in self._cfg_yaml[idx].items():
570 if isinstance(value, str):
572 self._cfg_yaml[idx][key] = self._replace_tags(
573 value, self._specification["environment"]["paths"])
577 self._specification["static"] = self._cfg_yaml[idx]
579 logging.info("Done.")
581 def _parse_elements(self):
582 """Parse elements (tables, plots) specification in the specification
586 logging.info("Parsing specification file: elements ...")
589 for element in self._cfg_yaml:
591 element["output-file"] = self._replace_tags(
592 element["output-file"],
593 self._specification["environment"]["paths"])
598 element["input-file"] = self._replace_tags(
599 element["input-file"],
600 self._specification["environment"]["paths"])
604 # add data sets to the elements:
605 if isinstance(element.get("data", None), str):
606 data_set = element["data"]
608 element["data"] = self.configuration["data-sets"][data_set]
610 raise PresentationError("Data set {0} is not defined in "
611 "the configuration section.".
614 if element["type"] == "table":
615 logging.info(" {:3d} Processing a table ...".format(count))
617 element["template"] = self._replace_tags(
619 self._specification["environment"]["paths"])
625 for item in ("reference", "compare"):
626 if element.get(item, None):
627 data_set = element[item].get("data", None)
628 if isinstance(data_set, str):
629 element[item]["data"] = \
630 self.configuration["data-sets"][data_set]
632 if element.get("history", None):
633 for i in range(len(element["history"])):
634 data_set = element["history"][i].get("data", None)
635 if isinstance(data_set, str):
636 element["history"][i]["data"] = \
637 self.configuration["data-sets"][data_set]
640 raise PresentationError("Wrong data set used in {0}.".
641 format(element.get("title", "")))
643 self._specification["tables"].append(element)
646 elif element["type"] == "plot":
647 logging.info(" {:3d} Processing a plot ...".format(count))
649 # Add layout to the plots:
650 layout = element["layout"].get("layout", None)
651 if layout is not None:
652 element["layout"].pop("layout")
654 for key, val in (self.configuration["plot-layouts"]
656 element["layout"][key] = val
658 raise PresentationError("Layout {0} is not defined in "
659 "the configuration section.".
661 self._specification["plots"].append(element)
664 elif element["type"] == "file":
665 logging.info(" {:3d} Processing a file ...".format(count))
667 element["dir-tables"] = self._replace_tags(
668 element["dir-tables"],
669 self._specification["environment"]["paths"])
672 self._specification["files"].append(element)
675 elif element["type"] == "cpta":
676 logging.info(" {:3d} Processing Continuous Performance "
677 "Trending and Analysis ...".format(count))
679 for plot in element["plots"]:
680 # Add layout to the plots:
681 layout = plot.get("layout", None)
682 if layout is not None:
685 self.configuration["plot-layouts"][layout]
687 raise PresentationError(
688 "Layout {0} is not defined in the "
689 "configuration section.".format(layout))
691 if isinstance(plot.get("data", None), str):
692 data_set = plot["data"]
695 self.configuration["data-sets"][data_set]
697 raise PresentationError(
698 "Data set {0} is not defined in "
699 "the configuration section.".
701 self._specification["cpta"] = element
704 logging.info("Done.")
706 def read_specification(self):
707 """Parse specification in the specification YAML file.
709 :raises: PresentationError if an error occurred while parsing the
713 self._cfg_yaml = load(self._cfg_file)
714 except YAMLError as err:
715 raise PresentationError(msg="An error occurred while parsing the "
716 "specification file.",
720 self._parse_configuration()
724 self._parse_elements()
726 logging.debug("Specification: \n{}".
727 format(pformat(self._specification)))