debian-koji/koji/util.py

281 lines
8.7 KiB
Python

# Copyright (c) 2005-2010 Red Hat
#
# Koji is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation;
# version 2.1 of the License.
#
# This software is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this software; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import calendar
import re
import time
import koji
import os
import os.path
import stat
try:
from hashlib import md5 as md5_constructor
except ImportError:
from md5 import new as md5_constructor
try:
from hashlib import sha1 as sha1_constructor
except ImportError:
from sha import new as sha1_constructor
def _changelogDate(cldate):
return time.strftime('%a %b %d %Y', time.strptime(koji.formatTime(cldate), '%Y-%m-%d %H:%M:%S'))
def formatChangelog(entries):
"""Format a list of changelog entries (dicts)
into a string representation."""
result = ''
for entry in entries:
result += """* %s %s
%s
""" % (_changelogDate(entry['date']), entry['author'].encode("utf-8"),
entry['text'].encode("utf-8"))
return result
DATE_RE = re.compile(r'(\d+)-(\d+)-(\d+)')
TIME_RE = re.compile(r'(\d+):(\d+):(\d+)')
def parseTime(val):
"""
Parse a string time in either "YYYY-MM-DD HH24:MI:SS" or "YYYY-MM-DD"
format into floating-point seconds since the epoch. If the time portion
is not specified, it will be padded with zeros. The string time is treated
as UTC. If the time string cannot be parsed into a valid date, None will be
returned.
"""
result = DATE_RE.search(val)
if not result:
return None
else:
date = [int(r) for r in result.groups()]
time = [0, 0, 0]
rest = val[result.end():].strip()
result = TIME_RE.search(rest)
if result:
time = [int(r) for r in result.groups()]
return calendar.timegm(date + time + [0, 0, 0])
def checkForBuilds(session, tag, builds, event, latest=False):
"""Check that the builds existed in tag at the time of the event.
If latest=True, check that the builds are the latest in tag."""
for build in builds:
if latest:
tagged_list = session.getLatestBuilds(tag, event=event, package=build['name'])
else:
tagged_list = session.listTagged(tag, event=event, package=build['name'], inherit=True)
for tagged in tagged_list:
if tagged['version'] == build['version'] and tagged['release'] == build['release']:
break
else:
return False
return True
def duration(start):
"""Return the duration between start and now in MM:SS format"""
elapsed = time.time() - start
mins = int(elapsed / 60)
secs = int(elapsed % 60)
return '%s:%02i' % (mins, secs)
def printList(l):
"""Print the contents of the list comma-separated"""
if len(l) == 0:
return ''
elif len(l) == 1:
return l[0]
elif len(l) == 2:
return ' and '.join(l)
else:
ret = ', '.join(l[:-1])
ret += ', and '
ret += l[-1]
return ret
def dslice(dict, keys, strict=True):
"""Returns a new dictionary containing only the specified keys"""
ret = {}
for key in keys:
if strict or dict.has_key(key):
#for strict we skip the has_key check and let the dict generate the KeyError
ret[key] = dict[key]
return ret
class LazyValue(object):
"""Used to represent a value that is generated by a function call at access time
"""
def __init__(self, func, args, kwargs=None, cache=False):
if kwargs is None:
kwargs = {}
self.func = func
self.args = args
self.kwargs = kwargs
self.cache = cache
def get(self):
if hasattr(self, '_value'):
return self._value
value = self.func(*self.args, **self.kwargs)
if self.cache:
self._value = value
return value
def lazy_eval(value):
if isinstance(value, LazyValue):
return value.get()
return value
class LazyDict(dict):
"""A container for lazy data
fields can refer to function calls, which can optionally be cached
"""
def __getitem__(self, key):
return lazy_eval(super(LazyDict, self).__getitem__(key))
def lazyset(self, key, func, args, kwargs=None, cache=False):
self[key] = LazyValue(func, args, kwargs=kwargs, cache=cache)
def get(self, *args, **kwargs):
return lazy_eval(super(LazyDict, self).get(*args, **kwargs))
def copy(self):
return LazyDict(self)
def values(self):
return [lazy_eval(val) for val in super(LazyDict, self).values()]
def items(self):
return [(key, lazy_eval(val)) for key, val in super(LazyDict, self).items()]
def itervalues(self):
for val in super(LazyDict, self).itervalues():
yield lazy_eval(val)
def iteritems(self):
for key, val in super(LazyDict, self).iteritems():
yield key, lazy_eval(val)
def pop(self, key, *args, **kwargs):
return lazy_eval(super(LazyDict, self).pop(key, *args, **kwargs))
def popitem(self):
key, val = super(LazyDict, self).popitem()
return key, lazy_eval(val)
def rmtree(path):
"""Delete a directory tree without crossing fs boundaries"""
st = os.lstat(path)
if not stat.S_ISDIR(st.st_mode):
raise koji.GenericError, "Not a directory: %s" % path
dev = st.st_dev
dirlist = []
for dirpath, dirnames, filenames in os.walk(path):
dirlist.append(dirpath)
newdirs = []
dirsyms = []
for fn in dirnames:
path = os.path.join(dirpath, fn)
st = os.lstat(path)
if st.st_dev != dev:
# don't cross fs boundary
continue
if stat.S_ISLNK(st.st_mode):
#os.walk includes symlinks to dirs here
dirsyms.append(fn)
continue
newdirs.append(fn)
#only walk our filtered dirs
dirnames[:] = newdirs
for fn in filenames + dirsyms:
path = os.path.join(dirpath, fn)
st = os.lstat(path)
if st.st_dev != dev:
#shouldn't happen, but just to be safe...
continue
os.unlink(path)
dirlist.reverse()
for dirpath in dirlist:
if os.listdir(dirpath):
# dir not empty. could happen if a mount was present
continue
os.rmdir(dirpath)
def eventFromOpts(session, opts):
"""Determine event id from standard cli options
Standard options are:
event: an event id (int)
ts: an event timestamp (int)
repo: pull event from given repo
"""
event_id = getattr(opts, 'event')
if event_id:
return session.getEvent(event_id)
ts = getattr(opts, 'ts')
if ts:
return session.getLastEvent(before=ts)
repo = getattr(opts, 'repo')
if repo:
rinfo = session.repoInfo(repo)
if rinfo:
return {'id' : rinfo['create_event'],
'ts' : rinfo['create_ts'] }
return None
def filedigestAlgo(hdr):
"""
Get the file digest algorithm used in hdr.
If there is no algorithm flag in the header,
default to md5. If the flag contains an unknown,
non-None value, return 'unknown'.
"""
# need to use the header ID hard-coded into Koji so we're not dependent on the
# version of rpm installed on the hub
digest_algo_id = hdr[koji.RPM_TAG_FILEDIGESTALGO]
if not digest_algo_id:
# certain versions of rpm return an empty list instead of None
# for missing header fields
digest_algo_id = None
digest_algo = koji.RPM_FILEDIGESTALGO_IDS.get(digest_algo_id, 'unknown')
return digest_algo.lower()
def parseStatus(rv, prefix):
if isinstance(prefix, list) or isinstance(prefix, tuple):
prefix = ' '.join(prefix)
if os.WIFSIGNALED(rv):
return '%s was killed by signal %i' % (prefix, os.WTERMSIG(rv))
elif os.WIFEXITED(rv):
return '%s exited with status %i' % (prefix, os.WEXITSTATUS(rv))
else:
return '%s terminated for unknown reasons' % prefix
def isSuccess(rv):
"""Return True if rv indicates successful completion
(exited with status 0), False otherwise."""
if os.WIFEXITED(rv) and os.WEXITSTATUS(rv) == 0:
return True
else:
return False