1 # Copyright (c) 2018 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._replace_tags(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
395 logging.info("Done.")
397 def _parse_configuration(self):
398 """Parse configuration of PAL in the specification YAML file.
401 logging.info("Parsing specification file: configuration ...")
403 idx = self._get_type_index("configuration")
405 logging.warning("No configuration information in the specification "
410 self._specification["configuration"] = self._cfg_yaml[idx]
413 raise PresentationError("No configuration defined.")
415 # Data sets: Replace ranges by lists
416 for set_name, data_set in self.configuration["data-sets"].items():
417 for job, builds in data_set.items():
419 if isinstance(builds, dict):
420 build_nr = builds.get("end", None)
422 build_nr = int(build_nr)
424 # defined as a range <start, build_type>
425 build_nr = self._get_build_number(job, build_nr)
426 builds = [x for x in range(builds["start"], build_nr+1)]
427 self.configuration["data-sets"][set_name][job] = builds
431 mapping_file_name = self._specification["configuration"].\
432 get("mapping-file", None)
433 if mapping_file_name:
434 logging.debug("Mapping file: '{0}'".format(mapping_file_name))
436 with open(mapping_file_name, 'r') as mfile:
437 mapping = load(mfile)
438 logging.debug("Loaded mapping table:\n{0}".format(mapping))
439 except (YAMLError, IOError) as err:
440 raise PresentationError(
441 msg="An error occurred while parsing the mapping file "
442 "'{0}'.".format(mapping_file_name),
444 # Make sure everything is lowercase
446 self._specification["configuration"]["mapping"] = \
447 {key.lower(): val.lower() for key, val in mapping.iteritems()}
449 self._specification["configuration"]["mapping"] = dict()
453 ignore_list_name = self._specification["configuration"].\
454 get("ignore-list", None)
456 logging.debug("Ignore list file: '{0}'".format(ignore_list_name))
458 with open(ignore_list_name, 'r') as ifile:
460 logging.debug("Loaded ignore list:\n{0}".format(ignore))
461 except (YAMLError, IOError) as err:
462 raise PresentationError(
463 msg="An error occurred while parsing the ignore list file "
464 "'{0}'.".format(ignore_list_name),
466 # Make sure everything is lowercase
468 self._specification["configuration"]["ignore"] = \
469 [item.lower() for item in ignore]
471 self._specification["configuration"]["ignore"] = list()
473 logging.info("Done.")
475 def _parse_input(self):
476 """Parse input specification in the specification YAML file.
478 :raises: PresentationError if there are no data to process.
481 logging.info("Parsing specification file: input ...")
483 idx = self._get_type_index("input")
485 raise PresentationError("No data to process.")
488 for key, value in self._cfg_yaml[idx]["general"].items():
489 self._specification["input"][key] = value
490 self._specification["input"]["builds"] = dict()
492 for job, builds in self._cfg_yaml[idx]["builds"].items():
494 if isinstance(builds, dict):
495 build_nr = builds.get("end", None)
497 build_nr = int(build_nr)
499 # defined as a range <start, build_type>
500 build_nr = self._get_build_number(job, build_nr)
501 builds = [x for x in range(builds["start"], build_nr+1)]
502 self._specification["input"]["builds"][job] = list()
504 self._specification["input"]["builds"][job]. \
505 append({"build": build, "status": None})
508 logging.warning("No build is defined for the job '{}'. "
509 "Trying to continue without it.".
512 raise PresentationError("No data to process.")
514 logging.info("Done.")
516 def _parse_output(self):
517 """Parse output specification in the specification YAML file.
519 :raises: PresentationError if there is no output defined.
522 logging.info("Parsing specification file: output ...")
524 idx = self._get_type_index("output")
526 raise PresentationError("No output defined.")
529 self._specification["output"] = self._cfg_yaml[idx]
530 except (KeyError, IndexError):
531 raise PresentationError("No output defined.")
533 logging.info("Done.")
535 def _parse_static(self):
536 """Parse specification of the static content in the specification YAML
540 logging.info("Parsing specification file: static content ...")
542 idx = self._get_type_index("static")
544 logging.warning("No static content specified.")
546 for key, value in self._cfg_yaml[idx].items():
547 if isinstance(value, str):
549 self._cfg_yaml[idx][key] = self._replace_tags(
550 value, self._specification["environment"]["paths"])
554 self._specification["static"] = self._cfg_yaml[idx]
556 logging.info("Done.")
558 def _parse_elements(self):
559 """Parse elements (tables, plots) specification in the specification
563 logging.info("Parsing specification file: elements ...")
566 for element in self._cfg_yaml:
568 element["output-file"] = self._replace_tags(
569 element["output-file"],
570 self._specification["environment"]["paths"])
575 element["input-file"] = self._replace_tags(
576 element["input-file"],
577 self._specification["environment"]["paths"])
581 # add data sets to the elements:
582 if isinstance(element.get("data", None), str):
583 data_set = element["data"]
585 element["data"] = self.configuration["data-sets"][data_set]
587 raise PresentationError("Data set {0} is not defined in "
588 "the configuration section.".
591 if element["type"] == "table":
592 logging.info(" {:3d} Processing a table ...".format(count))
594 element["template"] = self._replace_tags(
596 self._specification["environment"]["paths"])
599 self._specification["tables"].append(element)
602 elif element["type"] == "plot":
603 logging.info(" {:3d} Processing a plot ...".format(count))
605 # Add layout to the plots:
606 layout = element["layout"].get("layout", None)
607 if layout is not None:
608 element["layout"].pop("layout")
610 for key, val in (self.configuration["plot-layouts"]
612 element["layout"][key] = val
614 raise PresentationError("Layout {0} is not defined in "
615 "the configuration section.".
617 self._specification["plots"].append(element)
620 elif element["type"] == "file":
621 logging.info(" {:3d} Processing a file ...".format(count))
623 element["dir-tables"] = self._replace_tags(
624 element["dir-tables"],
625 self._specification["environment"]["paths"])
628 self._specification["files"].append(element)
631 elif element["type"] == "cpta":
632 logging.info(" {:3d} Processing Continuous Performance "
633 "Trending and Analysis ...".format(count))
635 for plot in element["plots"]:
636 # Add layout to the plots:
637 layout = plot.get("layout", None)
638 if layout is not None:
641 self.configuration["plot-layouts"][layout]
643 raise PresentationError(
644 "Layout {0} is not defined in the "
645 "configuration section.".format(layout))
647 if isinstance(plot.get("data", None), str):
648 data_set = plot["data"]
651 self.configuration["data-sets"][data_set]
653 raise PresentationError(
654 "Data set {0} is not defined in "
655 "the configuration section.".
657 self._specification["cpta"] = element
660 logging.info("Done.")
662 def read_specification(self):
663 """Parse specification in the specification YAML file.
665 :raises: PresentationError if an error occurred while parsing the
669 self._cfg_yaml = load(self._cfg_file)
670 except YAMLError as err:
671 raise PresentationError(msg="An error occurred while parsing the "
672 "specification file.",
676 self._parse_configuration()
680 self._parse_elements()
682 logging.debug("Specification: \n{}".
683 format(pformat(self._specification)))