/usr/lib/python2.7/dist-packages/jenkinsapi/api.py is in python-jenkinsapi 0.2.30-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | """
This module is a collection of helpful, high-level functions
for automating common tasks.
Many of these functions were designed to be exposed to the command-line,
hence they have simple string arguments.
"""
import os
import time
import logging
try:
from urllib import parse as urlparse
except ImportError:
# Python3
from urllib2 import urlparse
from jenkinsapi import constants
from jenkinsapi.jenkins import Jenkins
from jenkinsapi.artifact import Artifact
from jenkinsapi.custom_exceptions import ArtifactsMissing, TimeOut, BadURL
log = logging.getLogger(__name__)
def get_latest_test_results(jenkinsurl, jobname, username=None, password=None,
ssl_verify=True):
"""
A convenience function to fetch down the very latest test results
from a jenkins job.
"""
latestbuild = get_latest_build(jenkinsurl, jobname, username=username,
password=password, ssl_verify=ssl_verify)
res = latestbuild.get_resultset()
return res
def get_latest_build(jenkinsurl, jobname, username=None, password=None,
ssl_verify=True):
"""
A convenience function to fetch down the very latest test results
from a jenkins job.
"""
jenkinsci = Jenkins(jenkinsurl, username=username, password=password,
ssl_verify=ssl_verify)
job = jenkinsci[jobname]
return job.get_last_build()
def get_latest_complete_build(jenkinsurl, jobname,
username=None, password=None, ssl_verify=True):
"""
A convenience function to fetch down the very latest test results
from a jenkins job.
"""
jenkinsci = Jenkins(jenkinsurl, username=username, password=password,
ssl_verify=ssl_verify)
job = jenkinsci[jobname]
return job.get_last_completed_build()
def get_build(jenkinsurl, jobname, build_no, username=None, password=None,
ssl_verify=True):
"""
A convenience function to fetch down the test results
from a jenkins job by build number.
"""
jenkinsci = Jenkins(jenkinsurl, username=username, password=password,
ssl_verify=ssl_verify)
job = jenkinsci[jobname]
return job.get_build(build_no)
def get_artifacts(jenkinsurl, jobid=None, build_no=None,
username=None, password=None, ssl_verify=True):
"""
Find all the artifacts for the latest build of a job.
"""
jenkinsci = Jenkins(jenkinsurl, username=username, password=password,
ssl_verify=ssl_verify)
job = jenkinsci[jobid]
if build_no:
build = job.get_build(build_no)
else:
build = job.get_last_good_build()
artifacts = build.get_artifact_dict()
log.info(msg="Found %i artifacts in '%s'"
% (len(artifacts.keys()), build_no))
return artifacts
def search_artifacts(jenkinsurl, jobid, artifact_ids=None,
username=None, password=None, ssl_verify=True):
"""
Search the entire history of a jenkins job for a list of artifact names.
If same_build is true then ensure that all artifacts come from the
same build of the job
"""
if len(artifact_ids) == 0 or artifact_ids is None:
return []
jenkinsci = Jenkins(jenkinsurl, username=username, password=password,
ssl_verify=ssl_verify)
job = jenkinsci[jobid]
build_ids = job.get_build_ids()
for build_id in build_ids:
build = job.get_build(build_id)
artifacts = build.get_artifact_dict()
if set(artifact_ids).issubset(set(artifacts.keys())):
return dict((a, artifacts[a]) for a in artifact_ids)
missing_artifacts = set(artifact_ids) - set(artifacts.keys())
log.debug(msg="Artifacts %s missing from %s #%i"
% (", ".join(missing_artifacts), jobid, build_id))
# noinspection PyUnboundLocalVariable
raise ArtifactsMissing(missing_artifacts)
def grab_artifact(jenkinsurl, jobid, artifactid, targetdir,
username=None, password=None,
strict_validation=False, ssl_verify=True):
"""
Convenience method to find the latest good version of an artifact and
save it to a target directory.
Directory is made automatically if not exists.
"""
artifacts = get_artifacts(jenkinsurl, jobid,
username=username, password=password,
ssl_verify=ssl_verify)
artifact = artifacts[artifactid]
if not os.path.exists(targetdir):
os.makedirs(targetdir)
artifact.save_to_dir(targetdir, strict_validation)
def block_until_complete(jenkinsurl, jobs, maxwait=12000, interval=30,
raise_on_timeout=True, username=None, password=None,
ssl_verify=True):
"""
Wait until all of the jobs in the list are complete.
"""
assert maxwait > 0
assert maxwait > interval
assert interval > 0
obj_jenkins = Jenkins(jenkinsurl, username=username, password=password,
ssl_verify=ssl_verify)
obj_jobs = [obj_jenkins[jid] for jid in jobs]
for time_left in range(maxwait, 0, -interval):
still_running = [j for j in obj_jobs if j.is_queued_or_running()]
if not still_running:
return
str_still_running = ", ".join('"%s"' % str(a) for a in still_running)
log.warn(msg="Waiting for jobs %s to complete. Will wait another %is"
% (str_still_running, time_left))
time.sleep(interval)
if raise_on_timeout:
# noinspection PyUnboundLocalVariable
raise TimeOut("Waited too long for these jobs to complete: %s"
% str_still_running)
def get_view_from_url(url, username=None, password=None, ssl_verify=True):
"""
Factory method
"""
matched = constants.RE_SPLIT_VIEW_URL.search(url)
if not matched:
raise BadURL("Cannot parse URL %s" % url)
jenkinsurl, view_name = matched.groups()
jenkinsci = Jenkins(jenkinsurl, username=username, password=password,
ssl_verify=ssl_verify)
return jenkinsci.views[view_name]
def get_nested_view_from_url(url, username=None, password=None,
ssl_verify=True):
"""
Returns View based on provided URL. Convenient for nested views.
"""
matched = constants.RE_SPLIT_VIEW_URL.search(url)
if not matched:
raise BadURL("Cannot parse URL %s" % url)
jenkinsci = Jenkins(matched.group(0), username=username, password=password,
ssl_verify=ssl_verify)
return jenkinsci.get_view_by_url(url)
def install_artifacts(artifacts, dirstruct, installdir, basestaticurl,
strict_validation=False):
"""
Install the artifacts.
"""
assert basestaticurl.endswith("/"), "Basestaticurl should end with /"
installed = []
for reldir, artifactnames in dirstruct.items():
destdir = os.path.join(installdir, reldir)
if not os.path.exists(destdir):
log.warn(msg="Making install directory %s" % destdir)
os.makedirs(destdir)
else:
assert os.path.isdir(destdir)
for artifactname in artifactnames:
destpath = os.path.abspath(os.path.join(destdir, artifactname))
if artifactname in artifacts.keys():
# The artifact must be loaded from jenkins
theartifact = artifacts[artifactname]
else:
# It's probably a static file,
# we can get it from the static collection
staticurl = urlparse.urljoin(basestaticurl, artifactname)
theartifact = Artifact(artifactname, staticurl, None)
theartifact.save(destpath, strict_validation)
installed.append(destpath)
return installed
def search_artifact_by_regexp(jenkinsurl, jobid, artifactRegExp,
username=None, password=None, ssl_verify=True):
'''
Search the entire history of a hudson job for a build which has an
artifact whose name matches a supplied regular expression.
Return only that artifact.
@param jenkinsurl: The base URL of the jenkins server
@param jobid: The name of the job we are to search through
@param artifactRegExp: A compiled regular expression object
(not a re-string)
@param username: Jenkins login user name, optional
@param password: Jenkins login password, optional
'''
job = Jenkins(jenkinsurl, username=username, password=password,
ssl_verify=ssl_verify)
j = job[jobid]
build_ids = j.get_build_ids()
for build_id in build_ids:
build = j.get_build(build_id)
artifacts = build.get_artifact_dict()
try:
it = artifacts.iteritems()
except AttributeError:
# Python3
it = artifacts.items()
for name, art in it:
md_match = artifactRegExp.search(name)
if md_match:
return art
raise ArtifactsMissing()
|