-# Copyright (c) 2017 Cisco and/or its affiliates.
+# Copyright (c) 2021 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 re
-import gzip
import logging
+import gzip
-from os import rename, remove
-from os.path import join, getsize
-from shutil import move
+from os import rename, mkdir
+from os.path import join
+from http.client import responses, HTTPException
from zipfile import ZipFile, is_zipfile, BadZipfile
-from httplib import responses
-from requests import get, codes, RequestException, Timeout, TooManyRedirects, \
- HTTPError, ConnectionError
+import requests
+
+from requests.adapters import HTTPAdapter, Retry
+from requests.exceptions import RequestException
+from requests import codes
-from errors import PresentationError
+from urllib3.exceptions import HTTPError
# 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_data_files(spec):
- """Download all data specified in the specification file in the section
- type: input --> builds.
-
- :param spec: Specification.
- :type spec: Specification
- :raises: PresentationError if there is no url defined for the job.
+def _download_file(url, file_name, arch=False, verify=True, repeat=1):
+ """Download a file with input data.
+
+ :param url: URL to the file to download.
+ :param file_name: Name of file to download.
+ :param arch: If True, also .gz file is downloaded.
+ :param verify: If true, verify the certificate.
+ :param repeat: The number of attempts to download the file.
+ :type url: str
+ :type file_name: str
+ :type arch: bool
+ :type verify: bool
+ :type repeat: int
+ :returns: True if the download was successful, otherwise False.
+ :rtype: bool
"""
- for job, builds in spec.builds.items():
- for build in builds:
- 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:
- logging.error("Not supported file format.")
- continue
- elif job.startswith("hc2vpp-"):
- url = spec.environment["urls"]["URL[JENKINS,HC]"]
- 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)
- 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))
- logging.info(
- "Downloading the file '{0}' to '{1}' ...".format(url, new_name))
-
- status = "failed"
- try:
- response = get(url, stream=True)
- code = response.status_code
- # temporary workaround, remove when output.log.xml is not needed
- if code != codes["OK"] and \
- spec.input["file-name"].endswith(".gz"):
- url = '.'.join(url.split('.')[:-1]) + ".log.gz"
- response = get(url, stream=True)
- code = response.status_code
-
- if code != codes["OK"]:
- logging.warning(
- "Jenkins: {0}: {1}.".format(code, responses[code]))
- logging.info("Trying to download from Nexus:")
- spec.set_input_state(job, build["build"], "not found")
- if code == codes["not_found"]:
- release = re.search(REGEX_RELEASE, job).group(2)
- nexus_file_name = "{job}{sep}{build}{sep}{name}".\
- format(job=job, sep=SEPARATOR, build=build["build"],
- name=file_name)
- url = "{url}/rls{release}/{dir}/{file}".\
- format(url=spec.environment["urls"]["URL[NEXUS]"],
- release=release,
- dir=spec.environment["urls"]["DIR[NEXUS]"],
- file=nexus_file_name)
- logging.info("Downloading the file '{0}' to '{1}' ...".
- format(url, new_name))
- response = get(url, stream=True)
- code = response.status_code
- if code != codes["OK"]:
- logging.error(
- "Nexus: {0}: {1}".format(code, responses[code]))
- spec.set_input_state(
- job, build["build"], "not found")
- continue
-
- file_handle = open(new_name, "wb")
+ 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
+ while repeat:
+ repeat -= 1
+ session = None
+ try:
+ logging.info(f" Connecting to {url} ...")
+ session = requests_retry_session()
+ response = session.get(url, stream=True, verify=verify)
+ code = response.status_code
+ logging.info(f" {code}: {responses[code]}")
+
+ if code != codes[u"OK"]:
+ if session:
+ session.close()
+ return False, file_name
+
+ dst_file_name = file_name.replace(u".gz", u"")
+ logging.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)
- file_handle.close()
-
- if spec.input["file-name"].endswith(".zip"):
- expected_length = None
- try:
- expected_length = int(response.
- headers["Content-Length"])
- logging.debug(" Expected file size: {0}B".
- format(expected_length))
- except KeyError:
- logging.debug(" No information about expected size.")
-
- real_length = getsize(new_name)
- logging.debug(" Downloaded size: {0}B".format(real_length))
-
- if expected_length:
- if real_length == expected_length:
- status = "downloaded"
- logging.info("{0}: {1}".format(code,
- responses[code]))
- else:
- logging.error("The file size differs from the "
- "expected size.")
- else:
- status = "downloaded"
- logging.info("{0}: {1}".format(code, responses[code]))
-
- elif spec.input["file-name"].endswith(".gz"):
- rename(new_name, new_name[:-3])
- with open(new_name[:-3], 'r') as xml_file:
- with gzip.open(new_name, 'wb') as gz_file:
- gz_file.write(xml_file.read())
- new_name = new_name[:-3]
- status = "downloaded"
- logging.info("{0}: {1}".format(code, responses[code]))
-
- except ConnectionError as err:
- logging.error("Not possible to connect to '{0}'.".format(url))
- logging.debug(err)
- except HTTPError as err:
- logging.error("Invalid HTTP response from '{0}'.".format(url))
- logging.debug(err)
- except TooManyRedirects as err:
- logging.error("Request exceeded the configured number "
- "of maximum re-directions.")
- logging.debug(err)
- except Timeout as err:
- logging.error("Request timed out.")
- logging.debug(err)
- except RequestException as err:
- logging.error("Unexpected HTTP request exception.")
- logging.debug(err)
- except (IOError, ValueError, KeyError) as err:
- logging.error("Download failed.")
- logging.debug("Reason: {0}".format(err))
-
- spec.set_input_state(job, build["build"], status)
- spec.set_input_file_name(job, build["build"], new_name)
-
- if status == "failed":
- logging.info("Removing the file '{0}'".format(new_name))
- try:
- remove(new_name)
- except OSError as err:
- logging.warning(str(err))
- spec.set_input_file_name(job, build["build"], None)
-
- unzip_files(spec)
-
-
-def unzip_files(spec):
- """Unzip downloaded zip files
-
- :param spec: Specification.
+
+ if arch and u".gz" in file_name:
+ if session:
+ session.close()
+ logging.info(f" Downloading the file {url} to {file_name}")
+ session = requests_retry_session()
+ response = session.get(url, stream=True, verify=verify)
+ if response.status_code == codes[u"OK"]:
+ with open(file_name, u"wb") as file_handle:
+ file_handle.write(response.raw.read())
+ else:
+ logging.error(
+ f"Not possible to download the file "
+ f"{url} to {file_name}"
+ )
+
+ success = True
+ repeat = 0
+ except (HTTPException, HTTPError) as err:
+ logging.error(f"Connection broken:\n{repr(err)}")
+ except RequestException as err:
+ logging.error(f"HTTP Request exception:\n{repr(err)}")
+ except (IOError, ValueError, KeyError) as err:
+ logging.error(f"Download failed.\n{repr(err)}")
+ finally:
+ if session:
+ session.close()
+ return success, file_name
+
+
+def _unzip_file(spec, build, pid):
+ """Unzip downloaded source file.
+
+ :param spec: Specification read form the specification file.
+ :param build: Information about the build.
:type spec: Specification
- :raises: PresentationError if the zip file does not exist or it is not a
- zip file.
+ :type build: dict
+ :returns: True if the download was successful, otherwise False.
+ :rtype: bool
"""
- if spec.is_debug:
- data_file = spec.debug["extract"]
- else:
- data_file = spec.input["extract"]
-
- for job, builds in spec.builds.items():
- for build in builds:
- if build["status"] == "failed" or build["status"] == "not found":
- continue
- try:
- status = "failed"
- directory = spec.environment["paths"]["DIR[WORKING,DATA]"]
- file_name = join(build["file-name"])
-
- if build["status"] == "downloaded":
- logging.info("Unziping: '{0}' from '{1}'.".
- format(data_file, file_name))
- new_name = "{0}{1}{2}".format(file_name.rsplit('.')[-2],
- SEPARATOR,
- data_file.split("/")[-1])
- try:
- if is_zipfile(file_name):
- with ZipFile(file_name, 'r') as zip_file:
- zip_file.extract(data_file, directory)
- logging.info("Moving {0} to {1} ...".
- format(join(directory, data_file),
- directory))
- move(join(directory, data_file), directory)
- logging.info("Renaming the file '{0}' to '{1}'".
- format(join(directory,
- data_file.split("/")[-1]),
- new_name))
- rename(join(directory, data_file.split("/")[-1]),
- new_name)
- spec.set_input_file_name(job, build["build"],
- new_name)
- status = "unzipped"
- spec.set_input_state(job, build["build"], status)
- except (BadZipfile, RuntimeError) as err:
- logging.error("Failed to unzip the file '{0}': {1}.".
- format(file_name, str(err)))
- except OSError as err:
- logging.error("Failed to rename the file '{0}': {1}.".
- format(data_file, str(err)))
- finally:
- if status == "failed":
- spec.set_input_file_name(job, build["build"], None)
- else:
- raise PresentationError("The file '{0}' does not exist or "
- "it is not a zip file".
- format(file_name))
+ file_name = build[u"file-name"]
+ data_file = "robot-plugin/output.xml"
+ directory = spec.environment[u"paths"][u"DIR[WORKING,DATA]"]
+ tmp_dir = join(directory, str(pid))
+ try:
+ mkdir(tmp_dir)
+ except OSError:
+ pass
+ new_name = \
+ f"{file_name.rsplit(u'.')[-2]}{SEPARATOR}{data_file.split(u'/')[-1]}"
+
+ logging.info(f" Unzipping: {data_file} from {file_name}.")
+ try:
+ with ZipFile(file_name, u'r') as zip_file:
+ zip_file.extract(data_file, tmp_dir)
+ logging.info(
+ f" Renaming the file {join(tmp_dir, data_file)} to {new_name}"
+ )
+ rename(join(tmp_dir, data_file), new_name)
+ build[u"file-name"] = new_name
+ return True
+ except (BadZipfile, RuntimeError) as err:
+ logging.error(f"Failed to unzip the file {file_name}: {repr(err)}.")
+ return False
+ except OSError as err:
+ logging.error(f"Failed to rename the file {data_file}: {repr(err)}.")
+ return False
+
+
+def _download_xml(source, job, build, w_dir, arch):
+ """
+
+ :param source:
+ :param job:
+ :param build:
+ :param w_dir: Path to working directory
+ :param arch:
+ :return:
+ """
+
+ file_name = source.get(u"file-name", u"")
+ new_name = join(
+ w_dir,
+ f"{job}{SEPARATOR}{build[u'build']}{SEPARATOR}{file_name}"
+ )
+ url = u"{0}/{1}".format(
+ source.get(u"url", u""),
+ source.get(u"path", u"").format(
+ job=job, build=build[u'build'], filename=file_name
+ )
+ )
+ logging.info(f" Trying to download {url}")
+ success, downloaded_name = _download_file(
+ url, new_name, arch=arch, verify=(u"nginx" not in url), repeat=3
+ )
+ return success, downloaded_name
+
+
+def _download_xml_docs(source, job, build, w_dir, arch):
+ """
- spec.set_input_state(job, build["build"], status)
+ :param source:
+ :param job:
+ :param build:
+ :param w_dir: Path to working directory
+ :param arch:
+ :return:
+ """
+
+ file_name = source.get(u"file-name", u"")
+ release = re.search(REGEX_RELEASE, job).group(2)
+ for rls in (release, u"master"):
+ try:
+ rls = f"rls{int(rls)}"
+ except ValueError:
+ pass # It is master
+ url = (
+ f"{source.get(u'url', u'')}/"
+ f"{rls}/"
+ f"{source.get(u'path', u'')}/"
+ f"{job}{SEPARATOR}{build[u'build']}{SEPARATOR}{file_name}"
+ )
+ new_name = join(
+ w_dir,
+ f"{job}{SEPARATOR}{build[u'build']}{SEPARATOR}{file_name}"
+ )
+
+ logging.info(f" Trying to download {url}")
+
+ success, downloaded_name = _download_file(url, new_name, arch=arch)
+ if success:
+ if file_name.endswith(u".gz"):
+ with gzip.open(downloaded_name[:-3], u"rb") as gzip_file:
+ file_content = gzip_file.read()
+ with open(downloaded_name[:-3], u"wb") as xml_file:
+ xml_file.write(file_content)
+ break
+
+ return success, downloaded_name
+
+
+def download_and_unzip_data_file(spec, job, build, pid):
+ """Download and unzip a source file.
+
+ :param spec: Specification read form the specification file.
+ :param job: Name of the Jenkins job.
+ :param build: Information about the build.
+ :param pid: PID of the process executing this method.
+ :type spec: Specification
+ :type job: str
+ :type build: dict
+ :type pid: int
+ :returns: True if the download was successful, otherwise False.
+ :rtype: bool
+ """
- except KeyError:
- pass
+ download = {
+ "xml": _download_xml,
+ "xml-docs": _download_xml_docs
+ }
+
+ success = False
+ downloaded_name = u""
+ arch = bool(spec.environment.get(u"archive-inputs", True))
+
+ for source in spec.environment.get(u"data-sources", tuple()):
+ if not source.get(u"enabled", False):
+ continue
+ download_type = source.get(u"type", None)
+ if not download_type:
+ continue
+ success, downloaded_name = download[download_type](
+ source,
+ job,
+ build,
+ spec.environment[u"paths"][u"DIR[WORKING,DATA]"],
+ arch
+ )
+ if success:
+ source[u"successful-downloads"] += 1
+ build[u"source"] = source[u"type"]
+ break
+
+ # TODO: Remove when only .gz is used.
+ if success and downloaded_name.endswith(u".zip"):
+ if not is_zipfile(downloaded_name):
+ logging.error(f"Zip file {downloaded_name} is corrupted.")
+ success = False
+
+ if success:
+ if downloaded_name.endswith(u".gz"):
+ build[u"file-name"] = downloaded_name[:-3]
+ # TODO: Remove when only .gz is used.
+ elif downloaded_name.endswith(u".zip"):
+ build[u"file-name"] = downloaded_name
+ success = _unzip_file(spec, build, pid)
+
+ return success
Code Review / csit.git / blobdiff