X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Ftools%2Fpresentation%2Finput_data_files.py;h=b1bb8cd20ffe056c612d48146130bf7dfe29e05d;hb=30be9d1618fda861b5691ebadeac54f3477ac6d8;hp=a1ab2432a65d024a46047865dc2ac1e75fddb798;hpb=803610d9ca0c1afd345db4d2858d4aa93a5233ed;p=csit.git diff --git a/resources/tools/presentation/input_data_files.py b/resources/tools/presentation/input_data_files.py index a1ab2432a6..b1bb8cd20f 100644 --- a/resources/tools/presentation/input_data_files.py +++ b/resources/tools/presentation/input_data_files.py @@ -16,82 +16,137 @@ Download all data. """ import re +import logging from os import rename, mkdir from os.path import join +from http.client import responses from zipfile import ZipFile, is_zipfile, BadZipfile -from httplib import responses -from requests import get, codes, RequestException, Timeout, TooManyRedirects, \ - HTTPError, ConnectionError -from errors import PresentationError -from utils import execute_command +import requests + +from requests.adapters import HTTPAdapter, Retry +from requests.exceptions import RequestException +from requests import codes + +from pal_errors import PresentationError + # Chunk size used for file download CHUNK_SIZE = 512 # Separator used in file names -SEPARATOR = "__" +SEPARATOR = u"__" REGEX_RELEASE = re.compile(r'(\D*)(\d{4}|master)(\D*)') -def _download_file(url, file_name, log): +def _download_file(url, file_name, log, arch=False): """Download a file with input data. :param url: URL to the file to download. :param file_name: Name of file to download. :param log: List of log messages. + :param arch: If True, also .gz file is downloaded :type url: str :type file_name: str :type log: list of tuples (severity, msg) + :type arch: bool :returns: True if the download was successful, otherwise False. :rtype: bool """ + def requests_retry_session(retries=3, + backoff_factor=0.3, + status_forcelist=(500, 502, 504)): + """ + + :param retries: Total number of retries to allow. + :param backoff_factor: A backoff factor to apply between attempts after + the second try. + :param status_forcelist: A set of integer HTTP status codes that are + forced to retry. + :type retries: int + :type backoff_factor: float + :type status_forcelist: iterable + :returns: Session object. + :rtype: requests.Session + """ + + retry = Retry( + total=retries, + read=retries, + connect=retries, + backoff_factor=backoff_factor, + status_forcelist=status_forcelist, + ) + adapter = HTTPAdapter(max_retries=retry) + session = requests.Session() + session.mount(u"http://", adapter) + session.mount(u"https://", adapter) + return session + success = False + session = None try: - log.append(("INFO", " Connecting to '{0}' ...".format(url))) - - response = get(url, stream=True) + log.append((u"INFO", f" Connecting to {url} ...")) + session = requests_retry_session() + response = session.get(url, stream=True) code = response.status_code + log.append((u"INFO", f" {code}: {responses[code]}")) + + if code != codes[u"OK"]: + if session: + session.close() + url = url.replace(u"_info", u"") + log.append((u"INFO", f" Connecting to {url} ...")) + session = requests_retry_session() + response = session.get(url, stream=True) + code = response.status_code + log.append((u"INFO", f" {code}: {responses[code]}")) + if code != codes[u"OK"]: + return False, file_name + file_name = file_name.replace(u"_info", u"") + + dst_file_name = file_name.replace(u".gz", u"") + log.append( + (u"INFO", f" Downloading the file {url} to {dst_file_name} ...") + ) + with open(dst_file_name, u"wb") as file_handle: + for chunk in response.iter_content(chunk_size=CHUNK_SIZE): + if chunk: + file_handle.write(chunk) + + if arch and u".gz" in file_name: + if session: + session.close() + log.append( + (u"INFO", f" Downloading the file {url} to {file_name} ...") + ) + session = requests_retry_session() + response = session.get(url, stream=True) + if response.status_code == codes[u"OK"]: + with open(file_name, u"wb") as file_handle: + file_handle.write(response.raw.read()) + else: + log.append( + (u"ERROR", f"Not possible to download the file {url} to " + f"{file_name} ...") + ) - log.append(("INFO", " {0}: {1}".format(code, responses[code]))) - - if code != codes["OK"]: - return False - - log.append(("INFO", " Downloading the file '{0}' to '{1}' ...". - format(url, file_name))) - - file_handle = open(file_name, "wb") - for chunk in response.iter_content(chunk_size=CHUNK_SIZE): - if chunk: - file_handle.write(chunk) - file_handle.close() success = True - except ConnectionError as err: - log.append(("ERROR", "Not possible to connect to '{0}'.".format(url))) - log.append(("DEBUG", str(err))) - except HTTPError as err: - log.append(("ERROR", "Invalid HTTP response from '{0}'.".format(url))) - log.append(("DEBUG", str(err))) - except TooManyRedirects as err: - log.append(("ERROR", "Request exceeded the configured number " - "of maximum re-directions.")) - log.append(("DEBUG", str(err))) - except Timeout as err: - log.append(("ERROR", "Request timed out.")) - log.append(("DEBUG", str(err))) except RequestException as err: - log.append(("ERROR", "Unexpected HTTP request exception.")) - log.append(("DEBUG", str(err))) + log.append( + (u"ERROR", f"HTTP Request exception:\n{repr(err)}") + ) except (IOError, ValueError, KeyError) as err: - log.append(("ERROR", "Download failed.")) - log.append(("DEBUG", str(err))) + log.append((u"ERROR", f"Download failed.\n{repr(err)}")) + finally: + if session: + session.close() - log.append(("INFO", " Download finished.")) - return success + log.append((u"INFO", u" Download finished.")) + return success, file_name def _unzip_file(spec, build, pid, log): @@ -107,35 +162,41 @@ def _unzip_file(spec, build, pid, log): :rtype: bool """ - data_file = spec.input["extract"] - file_name = build["file-name"] - directory = spec.environment["paths"]["DIR[WORKING,DATA]"] + file_name = build[u"file-name"] + if u".zip" in file_name: + data_file = spec.input[u"zip-extract"] + else: + data_file = spec.input[u"extract"] + + directory = spec.environment[u"paths"][u"DIR[WORKING,DATA]"] tmp_dir = join(directory, str(pid)) try: mkdir(tmp_dir) except OSError: pass - new_name = "{0}{1}{2}".format(file_name.rsplit('.')[-2], - SEPARATOR, - data_file.split("/")[-1]) + new_name = \ + f"{file_name.rsplit(u'.')[-2]}{SEPARATOR}{data_file.split(u'/')[-1]}" - log.append(("INFO", " Unzipping: '{0}' from '{1}'.". - format(data_file, file_name))) + log.append((u"INFO", f" Unzipping: {data_file} from {file_name}.")) try: - with ZipFile(file_name, 'r') as zip_file: + with ZipFile(file_name, u'r') as zip_file: zip_file.extract(data_file, tmp_dir) - log.append(("INFO", " Renaming the file '{0}' to '{1}'". - format(join(tmp_dir, data_file), new_name))) + log.append( + (u"INFO", f" Renaming the file {join(tmp_dir, data_file)} to " + f"{new_name}") + ) rename(join(tmp_dir, data_file), new_name) - build["file-name"] = new_name + build[u"file-name"] = new_name return True except (BadZipfile, RuntimeError) as err: - log.append(("ERROR", "Failed to unzip the file '{0}': {1}.". - format(file_name, str(err)))) + log.append( + (u"ERROR", f"Failed to unzip the file {file_name}: {repr(err)}.") + ) return False except OSError as err: - log.append(("ERROR", "Failed to rename the file '{0}': {1}.". - format(data_file, str(err)))) + log.append( + (u"ERROR", f"Failed to rename the file {data_file}: {repr(err)}.") + ) return False @@ -156,79 +217,114 @@ def download_and_unzip_data_file(spec, job, build, pid, log): :rtype: bool """ - if job.startswith("csit-"): - if spec.input["file-name"].endswith(".zip"): - url = spec.environment["urls"]["URL[JENKINS,CSIT]"] - elif spec.input["file-name"].endswith(".gz"): - url = spec.environment["urls"]["URL[NEXUS,LOG]"] - else: - log.append(("ERROR", "Not supported file format.")) - return False - elif job.startswith("hc2vpp-"): - url = spec.environment["urls"]["URL[JENKINS,HC]"] - elif job.startswith("intel-dnv-"): - url = spec.environment["urls"]["URL[VIRL,DNV]"] - else: - raise PresentationError("No url defined for the job '{}'.". - format(job)) - file_name = spec.input["file-name"] - full_name = spec.input["download-path"]. \ - format(job=job, build=build["build"], filename=file_name) - if not job.startswith("intel-dnv-"): - url = "{0}/{1}".format(url, full_name) - new_name = join(spec.environment["paths"]["DIR[WORKING,DATA]"], - "{job}{sep}{build}{sep}{name}". - format(job=job, sep=SEPARATOR, build=build["build"], - name=file_name)) - - # Download the file from the defined source (Jenkins, logs.fd.io): - success = _download_file(url, new_name, log) - - if success and new_name.endswith(".zip"): - if not is_zipfile(new_name): - success = False + # Try to download .gz from logs.fd.io + + file_name = spec.input[u"file-name"] + url = u"{0}/{1}".format( + spec.environment[u'urls'][u'URL[NEXUS,LOG]'], + spec.input[u'download-path'].format( + job=job, build=build[u'build'], filename=file_name + ) + ) + new_name = join( + spec.environment[u"paths"][u"DIR[WORKING,DATA]"], + f"{job}{SEPARATOR}{build[u'build']}{SEPARATOR}{file_name}" + ) + + logging.info(f"Trying to download {url}") + + arch = bool(spec.configuration.get(u"archive-inputs", True)) + success, downloaded_name = _download_file(url, new_name, log, arch=arch) + + if not success: + + # Try to download .gz from docs.fd.io + + file_name = spec.input[u"file-name"] + url = u"{0}/{1}".format( + spec.environment[u"urls"][u"URL[NEXUS,DOC]"], + spec.input[u"download-path"].format( + job=job, build=build[u"build"], filename=file_name + ) + ) + new_name = join( + spec.environment[u"paths"][u"DIR[WORKING,DATA]"], + f"{job}{SEPARATOR}{build[u'build']}{SEPARATOR}{file_name}" + ) + + logging.info(f"Downloading {url}") + + success, downloaded_name = _download_file(url, new_name, log, arch=arch) - # If not successful, download from docs.fd.io: if not success: - log.append(("INFO", " Trying to download from https://docs.fd.io:")) + + # Try to download .zip from docs.fd.io + + file_name = spec.input[u"zip-file-name"] + new_name = join( + spec.environment[u"paths"][u"DIR[WORKING,DATA]"], + f"{job}{SEPARATOR}{build[u'build']}{SEPARATOR}{file_name}" + ) release = re.search(REGEX_RELEASE, job).group(2) - for rls in (release, "master"): - nexus_file_name = "{job}{sep}{build}{sep}{name}". \ - format(job=job, sep=SEPARATOR, build=build["build"], - name=file_name) + for rls in (release, u"master"): + nexus_file_name = \ + f"{job}{SEPARATOR}{build[u'build']}{SEPARATOR}{file_name}" try: - rls = "rls{0}".format(int(rls)) + rls = f"rls{int(rls)}" except ValueError: + # It is master pass - url = "{url}/{release}/{dir}/{file}". \ - format(url=spec.environment["urls"]["URL[NEXUS]"], - release=rls, - dir=spec.environment["urls"]["DIR[NEXUS]"], - file=nexus_file_name) - success = _download_file(url, new_name, log) + url = ( + f"{spec.environment[u'urls'][u'URL[NEXUS,DOC]']}/" + f"{rls}/" + f"{spec.environment[u'urls'][u'DIR[NEXUS,DOC]']}/" + f"{nexus_file_name}" + ) + + logging.info(f"Downloading {url}") + + success, downloaded_name = _download_file(url, new_name, log) if success: break - if success: - build["file-name"] = new_name - else: - return False + if not success: - if spec.input["file-name"].endswith(".gz"): - if "docs.fd.io" in url: - execute_command("gzip --decompress --keep --force {0}". - format(new_name)) - else: - rename(new_name, new_name[:-3]) - execute_command("gzip --keep {0}".format(new_name[:-3])) - build["file-name"] = new_name[:-3] + # Try to download .zip from jenkins.fd.io - if new_name.endswith(".zip"): - if is_zipfile(new_name): - return _unzip_file(spec, build, pid, log) + file_name = spec.input[u"zip-file-name"] + download_path = spec.input[u"zip-download-path"] + if job.startswith(u"csit-"): + url = spec.environment[u"urls"][u"URL[JENKINS,CSIT]"] + elif job.startswith(u"hc2vpp-"): + url = spec.environment[u"urls"][u"URL[JENKINS,HC]"] else: - log.append(("ERROR", - "Zip file '{0}' is corrupted.".format(new_name))) - return False - else: - return True + raise PresentationError(f"No url defined for the job {job}.") + + full_name = download_path.format( + job=job, build=build[u"build"], filename=file_name + ) + url = u"{0}/{1}".format(url, full_name) + new_name = join( + spec.environment[u"paths"][u"DIR[WORKING,DATA]"], + f"{job}{SEPARATOR}{build[u'build']}{SEPARATOR}{file_name}" + ) + + logging.info(f"Downloading {url}") + + success, downloaded_name = _download_file(url, new_name, log) + + if success and downloaded_name.endswith(u".zip"): + if not is_zipfile(downloaded_name): + log.append((u"ERROR", f"Zip file {new_name} is corrupted.")) + success = False + + if success: + build[u"file-name"] = downloaded_name + + if file_name.endswith(u".gz"): + build[u"file-name"] = downloaded_name[:-3] + + if downloaded_name.endswith(u".zip"): + success = _unzip_file(spec, build, pid, log) + + return success