-# 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:
import multiprocessing
import os
import re
+import resource
import pandas as pd
import logging
from collections import OrderedDict
from string import replace
from os import remove
+from os.path import join
+from datetime import datetime as dt
+from datetime import timedelta
+from json import loads
from jumpavg.AvgStdevMetadataFactory import AvgStdevMetadataFactory
from input_data_files import download_and_unzip_data_file
from utils import Worker
+# Separator used in file names
+SEPARATOR = "__"
+
+
class ExecutionChecker(ResultVisitor):
"""Class to traverse through the test suite structure.
"parent": "Name of the parent of the test",
"doc": "Test documentation",
"msg": "Test message",
- "vat-history": "DUT1 and DUT2 VAT History",
+ "conf-history": "DUT1 and DUT2 VAT History",
"show-run": "Show Run",
"tags": ["tag 1", "tag 2", "tag n"],
"type": "NDRPDR",
}
},
"lossTolerance": "lossTolerance", # Only type: "PDR"
- "vat-history": "DUT1 and DUT2 VAT History"
+ "conf-history": "DUT1 and DUT2 VAT History"
"show-run": "Show Run"
},
"ID" {
"doc": "Test documentation"
"msg": "Test message"
"tags": ["tag 1", "tag 2", "tag n"],
- "vat-history": "DUT1 and DUT2 VAT History"
+ "conf-history": "DUT1 and DUT2 VAT History"
"show-run": "Show Run"
"status": "PASS" | "FAIL"
},
# TODO: Remove when definitely no NDRPDRDISC tests are used:
REGEX_RATE = re.compile(r'^[\D\d]*FINAL_RATE:\s(\d+\.\d+)\s(\w+)')
+ REGEX_PLR_RATE = re.compile(r'PLRsearch lower bound::\s(\d+.\d+).*\n'
+ r'PLRsearch upper bound::\s(\d+.\d+)')
+
REGEX_NDRPDR_RATE = re.compile(r'NDR_LOWER:\s(\d+.\d+).*\n.*\n'
r'NDR_UPPER:\s(\d+.\d+).*\n'
r'PDR_LOWER:\s(\d+.\d+).*\n.*\n'
REGEX_TOLERANCE = re.compile(r'^[\D\d]*LOSS_ACCEPTANCE:\s(\d*\.\d*)\s'
r'[\D\d]*')
- REGEX_VERSION_VPP = re.compile(r"(return STDOUT Version:\s*)(.*)")
+ REGEX_VERSION_VPP = re.compile(r"(return STDOUT Version:\s*|"
+ r"VPP Version:\s*|VPP version:\s*)(.*)")
REGEX_VERSION_DPDK = re.compile(r"(return STDOUT testpmd)([\d\D\n]*)"
r"(RTE Version: 'DPDK )(.*)(')")
REGEX_TC_NUMBER = re.compile(r'tc[0-9]{2}-')
- def __init__(self, metadata):
+ def __init__(self, metadata, mapping, ignore):
"""Initialisation.
:param metadata: Key-value pairs to be included in "metadata" part of
- JSON structure.
+ JSON structure.
+ :param mapping: Mapping of the old names of test cases to the new
+ (actual) one.
+ :param ignore: List of TCs to be ignored.
:type metadata: dict
+ :type mapping: dict
+ :type ignore: list
"""
# Type of message to parse out from the test messages
# Timestamp
self._timestamp = None
+ # Testbed. The testbed is identified by TG node IP address.
+ self._testbed = None
+
+ # Mapping of TCs long names
+ self._mapping = mapping
+
+ # Ignore list
+ self._ignore = ignore
+
# Number of VAT History messages found:
# 0 - no message
# 1 - VAT History of DUT1
# 2 - VAT History of DUT2
self._lookup_kw_nr = 0
- self._vat_history_lookup_nr = 0
+ self._conf_history_lookup_nr = 0
# Number of Show Running messages found
# 0 - no message
"vpp-version": self._get_vpp_version,
"dpdk-version": self._get_dpdk_version,
"teardown-vat-history": self._get_vat_history,
- "test-show-runtime": self._get_show_run
+ "teardown-papi-history": self._get_papi_history,
+ "test-show-runtime": self._get_show_run,
+ "testbed": self._get_testbed
}
@property
"""
return self._data
+ def _get_testbed(self, msg):
+ """Called when extraction of testbed IP is required.
+ The testbed is identified by TG node IP address.
+
+ :param msg: Message to process.
+ :type msg: Message
+ :returns: Nothing.
+ """
+
+ if msg.message.count("Arguments:"):
+ message = str(msg.message).replace(' ', '').replace('\n', '').\
+ replace("'", '"').replace('b"', '"').\
+ replace("honeycom", "honeycomb")
+ message = loads(message[11:-1])
+ try:
+ self._testbed = message["TG"]["host"]
+ except (KeyError, ValueError):
+ pass
+ finally:
+ self._data["metadata"]["testbed"] = self._testbed
+ self._msg_type = None
+
def _get_vpp_version(self, msg):
"""Called when extraction of VPP version is required.
:returns: Nothing.
"""
- if msg.message.count("return STDOUT Version:"):
+ if msg.message.count("return STDOUT Version:") or \
+ msg.message.count("VPP Version:") or \
+ msg.message.count("VPP version:"):
self._version = str(re.search(self.REGEX_VERSION_VPP, msg.message).
group(2))
self._data["metadata"]["version"] = self._version
:returns: Nothing.
"""
if msg.message.count("VAT command history:"):
- self._vat_history_lookup_nr += 1
- if self._vat_history_lookup_nr == 1:
- self._data["tests"][self._test_ID]["vat-history"] = str()
+ self._conf_history_lookup_nr += 1
+ if self._conf_history_lookup_nr == 1:
+ self._data["tests"][self._test_ID]["conf-history"] = str()
else:
self._msg_type = None
text = re.sub("[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3} "
replace("\n\n", "\n").replace('\n', ' |br| ').\
replace('\r', '').replace('"', "'")
- self._data["tests"][self._test_ID]["vat-history"] += " |br| "
- self._data["tests"][self._test_ID]["vat-history"] += \
- "**DUT" + str(self._vat_history_lookup_nr) + ":** " + text
+ self._data["tests"][self._test_ID]["conf-history"] += " |br| "
+ self._data["tests"][self._test_ID]["conf-history"] += \
+ "**DUT" + str(self._conf_history_lookup_nr) + ":** " + text
+
+ def _get_papi_history(self, msg):
+ """Called when extraction of PAPI command history is required.
+
+ :param msg: Message to process.
+ :type msg: Message
+ :returns: Nothing.
+ """
+ if msg.message.count("PAPI command history:"):
+ self._conf_history_lookup_nr += 1
+ if self._conf_history_lookup_nr == 1:
+ self._data["tests"][self._test_ID]["conf-history"] = str()
+ else:
+ self._msg_type = None
+ text = re.sub("[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3} "
+ "PAPI command history:", "", msg.message, count=1). \
+ replace("\n\n", "\n").replace('\n', ' |br| ').\
+ replace('\r', '').replace('"', "'")
+
+ self._data["tests"][self._test_ID]["conf-history"] += " |br| "
+ self._data["tests"][self._test_ID]["conf-history"] += \
+ "**DUT" + str(self._conf_history_lookup_nr) + ":** " + text
def _get_show_run(self, msg):
"""Called when extraction of VPP operational data (output of CLI command
:type msg: Message
:returns: Nothing.
"""
- if msg.message.count("return STDOUT Thread "):
+ if msg.message.count("Thread 0 vpp_main"):
self._show_run_lookup_nr += 1
if self._lookup_kw_nr == 1 and self._show_run_lookup_nr == 1:
self._data["tests"][self._test_ID]["show-run"] = str()
return throughput, status
+ def _get_plr_throughput(self, msg):
+ """Get PLRsearch lower bound and PLRsearch upper bound from the test
+ message.
+
+ :param msg: The test message to be parsed.
+ :type msg: str
+ :returns: Parsed data as a dict and the status (PASS/FAIL).
+ :rtype: tuple(dict, str)
+ """
+
+ throughput = {
+ "LOWER": -1.0,
+ "UPPER": -1.0
+ }
+ status = "FAIL"
+ groups = re.search(self.REGEX_PLR_RATE, msg)
+
+ if groups is not None:
+ try:
+ throughput["LOWER"] = float(groups.group(1))
+ throughput["UPPER"] = float(groups.group(2))
+ status = "PASS"
+ except (IndexError, ValueError):
+ pass
+
+ return throughput, status
+
def _get_ndrpdr_latency(self, msg):
"""Get LATENCY from the test message.
:returns: Nothing.
"""
+ longname_orig = test.longname.lower()
+
+ # Check the ignore list
+ if longname_orig in self._ignore:
+ return
+
tags = [str(tag) for tag in test.tags]
test_result = dict()
- test_result["name"] = test.name.lower()
+
+ # Change the TC long name and name if defined in the mapping table
+ longname = self._mapping.get(longname_orig, None)
+ if longname is not None:
+ name = longname.split('.')[-1]
+ logging.debug("{0}\n{1}\n{2}\n{3}".format(
+ self._data["metadata"], longname_orig, longname, name))
+ else:
+ longname = longname_orig
+ name = test.name.lower()
+
+ # Remove TC number from the TC long name (backward compatibility):
+ self._test_ID = re.sub(self.REGEX_TC_NUMBER, "", longname)
# Remove TC number from the TC name (not needed):
- test_result["name"] = re.sub(self.REGEX_TC_NUMBER, "",
- test.name.lower())
+ test_result["name"] = re.sub(self.REGEX_TC_NUMBER, "", name)
+
test_result["parent"] = test.parent.name.lower()
test_result["tags"] = tags
doc_str = test.doc.replace('"', "'").replace('\n', ' '). \
replace('\r', '').replace('"', "'")
test_result["type"] = "FUNC"
test_result["status"] = test.status
- # Remove TC number from the TC long name (backward compatibility):
- self._test_ID = re.sub(self.REGEX_TC_NUMBER, "", test.longname.lower())
if "PERFTEST" in tags:
# Replace info about cores (e.g. -1c-) with the info about threads
else:
test_result["status"] = "FAIL"
self._data["tests"][self._test_ID] = test_result
- logging.error("The test '{0}' has no or more than one "
+ logging.debug("The test '{0}' has no or more than one "
"multi-threading tags.".format(self._test_ID))
+ logging.debug("Tags: {0}".format(test_result["tags"]))
return
if test.status == "PASS" and ("NDRPDRDISC" in tags or
"NDRPDR" in tags or
+ "SOAK" in tags or
"TCP" in tags or
"MRR" in tags or
"BMRR" in tags):
test_result["type"] = "PDR"
elif "NDRPDR" in tags:
test_result["type"] = "NDRPDR"
+ elif "SOAK" in tags:
+ test_result["type"] = "SOAK"
elif "TCP" in tags:
test_result["type"] = "TCP"
elif "MRR" in tags:
test_result["latency"], test_result["status"] = \
self._get_ndrpdr_latency(test.message)
+ elif test_result["type"] in ("SOAK", ):
+ test_result["throughput"], test_result["status"] = \
+ self._get_plr_throughput(test.message)
+
elif test_result["type"] in ("TCP", ):
groups = re.search(self.REGEX_TCP, test.message)
test_result["result"] = int(groups.group(2))
items_str = groups.group(1)
items_float = [float(item.strip()) for item
in items_str.split(",")]
- test_result["result"]["receive-rate"] = \
- AvgStdevMetadataFactory.from_data(items_float)
+ metadata = AvgStdevMetadataFactory.from_data(items_float)
+ # Next two lines have been introduced in CSIT-1179,
+ # to be removed in CSIT-1180.
+ metadata.size = 1
+ metadata.stdev = 0.0
+ test_result["result"]["receive-rate"] = metadata
else:
groups = re.search(self.REGEX_MRR, test.message)
test_result["result"]["receive-rate"] = \
if setup_kw.name.count("Show Vpp Version On All Duts") \
and not self._version:
self._msg_type = "vpp-version"
-
- elif setup_kw.name.count("Setup performance global Variables") \
+ elif setup_kw.name.count("Set Global Variable") \
and not self._timestamp:
self._msg_type = "timestamp"
+ elif setup_kw.name.count("Setup Framework") and not self._testbed:
+ self._msg_type = "testbed"
else:
return
setup_kw.messages.visit(self)
"""
if teardown_kw.name.count("Show Vat History On All Duts"):
- self._vat_history_lookup_nr = 0
+ self._conf_history_lookup_nr = 0
self._msg_type = "teardown-vat-history"
teardown_kw.messages.visit(self)
+ elif teardown_kw.name.count("Show Papi History On All Duts"):
+ self._conf_history_lookup_nr = 0
+ self._msg_type = "teardown-papi-history"
+ teardown_kw.messages.visit(self)
def end_teardown_kw(self, teardown_kw):
"""Called when keyword ends. Default implementation does nothing.
return self.data[job][build]["tests"]
- @staticmethod
- def _parse_tests(job, build, log):
+ def _parse_tests(self, job, build, log):
"""Process data from robot output.xml file and return JSON structured
data.
log.append(("ERROR", "Error occurred while parsing output.xml: "
"{0}".format(err)))
return None
- checker = ExecutionChecker(metadata)
+ checker = ExecutionChecker(metadata, self._cfg.mapping,
+ self._cfg.ignore)
result.visit(checker)
return checker.data
- def _download_and_parse_build(self, pid, data_queue, job, build, repeat):
+ def _download_and_parse_build(self, job, build, repeat, pid=10000):
"""Download and parse the input data file.
:param pid: PID of the process executing this method.
- :param data_queue: Shared memory between processes. Queue which keeps
- the result data. This data is then read by the main process and used
- in further processing.
:param job: Name of the Jenkins job which generated the processed input
file.
:param build: Information about the Jenkins build which generated the
:param repeat: Repeat the download specified number of times if not
successful.
:type pid: int
- :type data_queue: multiprocessing.Manager().Queue()
:type job: str
:type build: dict
:type repeat: int
logs = list()
- logging.info(" Processing the job/build: {0}: {1}".
- format(job, build["build"]))
-
logs.append(("INFO", " Processing the job/build: {0}: {1}".
format(job, build["build"])))
"'{build}', or it is damaged. Skipped.".
format(job=job, build=build["build"])))
if success:
- logs.append(("INFO", " Processing data from the build '{0}' ...".
+ logs.append(("INFO", " Processing data from the build '{0}' ...".
format(build["build"])))
- data = InputData._parse_tests(job, build, logs)
+ data = self._parse_tests(job, build, logs)
if data is None:
logs.append(("ERROR", "Input data file from the job '{job}', "
"build '{build}' is damaged. Skipped.".
remove(build["file-name"])
except OSError as err:
logs.append(("ERROR", "Cannot remove the file '{0}': {1}".
- format(build["file-name"], err)))
+ format(build["file-name"], repr(err))))
+
+ # If the time-period is defined in the specification file, remove all
+ # files which are outside the time period.
+ timeperiod = self._cfg.input.get("time-period", None)
+ if timeperiod and data:
+ now = dt.utcnow()
+ timeperiod = timedelta(int(timeperiod))
+ metadata = data.get("metadata", None)
+ if metadata:
+ generated = metadata.get("generated", None)
+ if generated:
+ generated = dt.strptime(generated, "%Y%m%d %H:%M")
+ if (now - generated) > timeperiod:
+ # Remove the data and the file:
+ state = "removed"
+ data = None
+ logs.append(
+ ("INFO",
+ " The build {job}/{build} is outdated, will be "
+ "removed".format(job=job, build=build["build"])))
+ file_name = self._cfg.input["file-name"]
+ full_name = join(
+ self._cfg.environment["paths"]["DIR[WORKING,DATA]"],
+ "{job}{sep}{build}{sep}{name}".format(
+ job=job,
+ sep=SEPARATOR,
+ build=build["build"],
+ name=file_name))
+ try:
+ remove(full_name)
+ logs.append(("INFO",
+ " The file {name} has been removed".
+ format(name=full_name)))
+ except OSError as err:
+ logs.append(("ERROR",
+ "Cannot remove the file '{0}': {1}".
+ format(full_name, repr(err))))
logs.append(("INFO", " Done."))
- result = {
- "data": data,
- "state": state,
- "job": job,
- "build": build,
- "logs": logs
- }
- data_queue.put(result)
+ for level, line in logs:
+ if level == "INFO":
+ logging.info(line)
+ elif level == "ERROR":
+ logging.error(line)
+ elif level == "DEBUG":
+ logging.debug(line)
+ elif level == "CRITICAL":
+ logging.critical(line)
+ elif level == "WARNING":
+ logging.warning(line)
+
+ return {"data": data, "state": state, "job": job, "build": build}
def download_and_parse_data(self, repeat=1):
"""Download the input data files, parse input data from input files and
logging.info("Downloading and parsing input files ...")
- work_queue = multiprocessing.JoinableQueue()
- manager = multiprocessing.Manager()
- data_queue = manager.Queue()
- cpus = multiprocessing.cpu_count()
-
- workers = list()
- for cpu in range(cpus):
- worker = Worker(work_queue,
- data_queue,
- self._download_and_parse_build)
- worker.daemon = True
- worker.start()
- workers.append(worker)
- os.system("taskset -p -c {0} {1} > /dev/null 2>&1".
- format(cpu, worker.pid))
-
for job, builds in self._cfg.builds.items():
for build in builds:
- work_queue.put((job, build, repeat))
- work_queue.join()
+ result = self._download_and_parse_build(job, build, repeat)
+ build_nr = result["build"]["build"]
- logging.info("Done.")
+ if result["data"]:
+ data = result["data"]
+ build_data = pd.Series({
+ "metadata": pd.Series(
+ data["metadata"].values(),
+ index=data["metadata"].keys()),
+ "suites": pd.Series(data["suites"].values(),
+ index=data["suites"].keys()),
+ "tests": pd.Series(data["tests"].values(),
+ index=data["tests"].keys())})
+
+ if self._input_data.get(job, None) is None:
+ self._input_data[job] = pd.Series()
+ self._input_data[job][str(build_nr)] = build_data
+
+ self._cfg.set_input_file_name(
+ job, build_nr, result["build"]["file-name"])
+
+ self._cfg.set_input_state(job, build_nr, result["state"])
- while not data_queue.empty():
- result = data_queue.get()
-
- job = result["job"]
- build_nr = result["build"]["build"]
-
- if result["data"]:
- data = result["data"]
- build_data = pd.Series({
- "metadata": pd.Series(data["metadata"].values(),
- index=data["metadata"].keys()),
- "suites": pd.Series(data["suites"].values(),
- index=data["suites"].keys()),
- "tests": pd.Series(data["tests"].values(),
- index=data["tests"].keys())})
-
- if self._input_data.get(job, None) is None:
- self._input_data[job] = pd.Series()
- self._input_data[job][str(build_nr)] = build_data
-
- self._cfg.set_input_file_name(job, build_nr,
- result["build"]["file-name"])
-
- self._cfg.set_input_state(job, build_nr, result["state"])
-
- for item in result["logs"]:
- if item[0] == "INFO":
- logging.info(item[1])
- elif item[0] == "ERROR":
- logging.error(item[1])
- elif item[0] == "DEBUG":
- logging.debug(item[1])
- elif item[0] == "CRITICAL":
- logging.critical(item[1])
- elif item[0] == "WARNING":
- logging.warning(item[1])
-
- del data_queue
-
- # Terminate all workers
- for worker in workers:
- worker.terminate()
- worker.join()
+ logging.info("Memory allocation: {0}kB".format(
+ resource.getrusage(resource.RUSAGE_SELF).ru_maxrss))
logging.info("Done.")