syncevolution/test/resources.py

152 lines
4.7 KiB
Python
Executable File

#!/usr/bin/python3 -u
"""
Allocates resources from a lock directory with flock and/or a make jobserver while running
some command.
"""
import time
import os
import re
import subprocess
import fcntl
import signal
from optparse import OptionParser
usage = "usage: %prog [options] [--] command arg1 arg2 ..."
parser = OptionParser(usage=usage)
parser.add_option("-r", "--resource",
dest="resources",
action="append",
help="Name of a resource which gets locked while running the command.")
parser.add_option("-j", "--jobs",
default=1,
type='int',
action="store",
help="Number of jobs to allocate from job server. Ignored if not running under a job server.")
(options, args) = parser.parse_args()
def log(format, *args):
now = time.time()
print(time.asctime(time.gmtime(now)), 'UTC', '(+ %.1fs / %.1fs)' % (now - log.latest, now - log.start), format % args)
log.latest = now
log.start = time.time()
log.latest = log.start
# As a first step, lock one resource named like the
# test before running the test.
gobject = None
if options.resources:
# Support mapping of resource "foo" to "bar" with RESOURCES_FOO=bar.
resources = []
for name in options.resources:
replacement = os.environ.get('RESOURCES_%s' % name.upper(), None)
if replacement is not None:
resources.extend(replacement.split(','))
else:
resources.append(name)
if resources != options.resources:
log('replaced resource set %s with %s based on RESOURCES_* env vars', options.resources, resources)
if resources:
log('=== locking resource(s) %s ===', resources)
lockdir = os.environ.get('RESOURCES_DIR', None)
if lockdir is None:
log('RESOURCES_DIR env var not set')
exit(1)
for resource in resources:
log('locking resource %s' % resource)
start = time.time()
# If the resource doesn't exist, we don't need to lock it.
path = os.path.join(lockdir, resource)
if os.path.exists(path):
f = open(path, "w")
fcntl.lockf(f, fcntl.LOCK_EX)
end = time.time()
log('locked resource %s, delay %ds' % (resource, end - start))
else:
log('resource %s needs no lock' % resource)
class Jobserver:
'''Allocates the given number of job slots from the "make -j"
jobserver, then runs the command and finally returns the slots.
See http://mad-scientist.net/make/jobserver.html'''
def __init__(self):
self.havejobserver = False
self.allocated = 0
# MAKEFLAGS= --jobserver-fds=3,4 -j
flags = os.environ.get('MAKEFLAGS', '')
m = re.search(r'--jobserver-fds=(\d+),(\d+)', flags)
if m:
self.receiveslots = int(m.group(1))
self.returnslots = int(m.group(2))
self.blocked = {}
self.havejobserver = True
log('using jobserver')
else:
log('not using jobserver')
def active(self):
return self.havejobserver
def alloc(self, numjobs = 1):
if not self.havejobserver:
return
n = 0
self._block()
try:
while n < numjobs:
os.read(self.receiveslots, 1)
n += 1
self.allocated += n
n = 0
except:
os.write(self.returnslots, b' ' * n)
raise
finally:
self._unblock()
def free(self, numjobs = 1):
if not self.havejobserver:
return
try:
self.allocated -= numjobs
os.write(self.returnslots, b' ' * numjobs)
finally:
self._unblock()
def _block(self):
'''Block signals if not already done.'''
if not self.blocked:
for sig in [ signal.SIGINT, signal.SIGTERM ]:
self.blocked[sig] = signal.signal(sig, signal.SIG_IGN)
def _unblock(self):
'''Unblock signals if blocked and we currently own no slots.'''
if self.blocked and not self.allocated:
for sig, handler in self.blocked.items():
signal.signal(sig, handler)
self.blocked = {}
jobserver = Jobserver()
jobs = 0
if jobserver.active() and options.jobs:
log('=== allocating %d job slot(s) ===', options.jobs)
jobserver.alloc(options.jobs)
log('=== allocated %d job slot(s) ===', options.jobs)
jobs = options.jobs
try:
subprocess.check_call(args)
finally:
log('=== cleaning up ===')
# Return job tokens.
if jobs:
jobserver.free(jobs)
# We don't need to unlock the resources. Quitting will do
# that automatically.