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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
from builtins import str
from builtins import object
import logging
import os
import subprocess
import tempfile
import datetime
import time
import sys
from biomaj_process.process_client import ProcessServiceClient
class Process(object):
'''
Define a process to execute
'''
def __init__(self, name, exe, args, desc=None, proc_type=None, expand=True, bank_env=None, log_dir=None):
'''
Define one process
:param name: name of the process (descriptive)
:type name: str
:param exe: path to the executable (relative to process.dir or full path)
:type exe: str
:param args: arguments
:type args: str
:param desc: process description
:type desc: str
:param proc_type: types of data generated by process
:type proc_type: str
:param expand: allow shell expansion on command line
:type expand: bool
:param bank_env: environnement variables to set
:type bank_env: list
:param log_dir: directroy to place process stdout and stderr
:type log_dir: str
'''
# Replace env vars in args
if args:
for key, value in bank_env.items():
if value is not None:
args = args.replace('${' + key + '}', value)
self.name = name
self.exe = exe
self.desc = desc
if args is not None:
self.args = args.split()
else:
self.args = []
self.bank_env = bank_env
self.type = proc_type
self.expand = expand
self.log_dir = log_dir
if log_dir is not None:
self.output_file = os.path.join(log_dir, name + '.out')
self.error_file = os.path.join(log_dir, name + '.err')
else:
self.output_file = name + '.out'
self.error_file = name + '.err'
self.types = ''
self.format = ''
self.tags = ''
self.files = ''
self.exitcode = -1
self.exec_time = 0
self.proc_type = proc_type
self.trace_id = None
self.parent_id = None
def set_trace(self, trace_id, parent_id):
'''
Set span info for zipkin integration, optional
'''
self.trace_id = trace_id
self.parent_id = parent_id
def run(self, simulate=False):
'''
Execute process
:param simulate: does not execute process
:type simulate: bool
:return: exit code of process
'''
args = [self.exe] + self.args
logging.debug('PROCESS:EXEC:' + str(self.args))
err = False
if not simulate:
logging.info('PROCESS:RUN:' + self.name)
with open(self.output_file, 'w') as fout:
with open(self.error_file, 'w') as ferr:
start_time = datetime.datetime.now()
start_time = time.mktime(start_time.timetuple())
if self.expand:
args = " ".join(args)
proc = subprocess.Popen(args, stdout=fout, stderr=ferr, env=self.bank_env, shell=True)
else:
proc = subprocess.Popen(args, stdout=fout, stderr=ferr, env=self.bank_env, shell=False)
proc.wait()
end_time = datetime.datetime.now()
end_time = time.mktime(end_time.timetuple())
self.exec_time = end_time - start_time
self.exitcode = proc.returncode
if proc.returncode == 0:
err = True
else:
logging.error('PROCESS:ERROR:' + self.name)
fout.flush()
ferr.flush()
else:
err = True
logging.info('PROCESS:EXEC:' + self.name + ':' + str(err))
return err
class RemoteProcess(Process):
def __init__(self, name, exe, args, desc=None, proc_type=None, docker=None, docker_sudo=False, expand=True, bank_env=None, log_dir=None, rabbit_mq=None, rabbit_mq_port=5672, rabbit_mq_user=None, rabbit_mq_password=None, rabbit_mq_virtualhost=None, proxy=None, bank=None):
Process.__init__(self, name, exe, args, desc, proc_type, expand, bank_env, log_dir)
self.proxy = proxy
self.rabbit_mq = rabbit_mq
self.rabbit_mq_port = rabbit_mq_port
self.rabbit_mq_user = rabbit_mq_user
self.rabbit_mq_password = rabbit_mq_password
self.rabbit_mq_virtualhost = rabbit_mq_virtualhost
self.bank = bank
self.trace_id = None
self.parent_id = None
self.docker = docker
self.docker_sudo = docker_sudo
# Process.__init__(self, name, exe, args, desc, proc_type, expand, bank_env, log_dir)
# (self, name, exe, args, desc=None, proc_type=None, expand=True, bank_env=None, log_dir=None)
def run(self, simulate=False):
psc = ProcessServiceClient(self.rabbit_mq, self.rabbit_mq_port, self.rabbit_mq_virtualhost, self.rabbit_mq_user, self.rabbit_mq_password)
try:
session = psc.create_session(self.bank, self.proxy)
except Exception as e:
logging.exception('Process:RemoteProcess:Session:Create:Error:' + str(e))
return False
from biomaj_process.message import procmessage_pb2
biomaj_process = procmessage_pb2.Operation()
biomaj_process.type = 1
process = procmessage_pb2.Process()
process.bank = self.bank
process.session = session
process.log_dir = self.log_dir
process.exe = self.exe
for arg in self.args:
process.args.append(arg)
for envvar in list(self.bank_env.keys()):
proc_env_var = process.env_vars.add()
proc_env_var.name = envvar
proc_env_var.value = self.bank_env[envvar]
process.shell_expand = self.expand
process.name = self.name
process.description = str(self.desc)
process.proc_type = str(self.proc_type)
if self.docker:
process.is_docker = True
docker_info = procmessage_pb2.Process.Docker()
docker_info.image = self.docker
docker_info.use_sudo = self.docker_sudo
process.docker.MergeFrom(docker_info)
biomaj_process.process.MergeFrom(process)
if self.trace_id:
trace = procmessage_pb2.Operation.Trace()
trace.trace_id = self.trace_id
trace.span_id = self.parent_id
biomaj_process.trace.MergeFrom(trace)
psc.execute_process(biomaj_process)
exitcode = 0
try:
(exitcode, info) = psc.wait_for_process()
except Exception as e:
logging.exception('Error during process execution: ' + str(e))
exitcode = 1
psc.clean()
if exitcode > 0:
return False
else:
return True
class DockerProcess(Process):
def __init__(self, name, exe, args, desc=None, proc_type=None, docker=None, expand=True, bank_env=None, log_dir=None, use_sudo=True, docker_url=None, run_as_root=False):
Process.__init__(self, name, exe, args, desc, proc_type, expand, bank_env, log_dir)
self.docker = docker
self.docker_url = docker_url
self.use_sudo = use_sudo
self.run_as_root = run_as_root
def run(self, simulate=False):
'''
Execute process in docker container
:param simulate: does not execute process
:type simulate: bool
:return: exit code of process
'''
use_sudo = ''
docker_url = ''
if self.docker_url:
docker_url = '-H ' + self.docker_url
if self.use_sudo:
use_sudo = 'sudo'
release_dir = self.bank_env['datadir'] + '/' + self.bank_env['dirversion'] + '/' + self.bank_env['localrelease']
env = ''
depends = []
if self.bank_env:
for key, value in self.bank_env.items():
env += ' -e "{0}={1}"'.format(key, value)
# Bank dependency production directory
if key.endswith('source'):
depends.append(value)
# docker run with data.dir env as shared volume
# forwarded env variables
container_data_dir = self.bank_env['datadir'] + '/' + self.bank_env['dirversion']
host_data_dir = container_data_dir
if 'BIOMAJ_HOST_DATA_DIR' in os.environ and os.environ['BIOMAJ_HOST_DATA_DIR'] and not os.environ['BIOMAJ_HOST_DATA_DIR'].startswith('local'):
host_data_dir = os.environ['BIOMAJ_HOST_DATA_DIR'] + '/' + self.bank_env['dirversion']
depends_vol = ''
for vol in depends:
depends_vol += '-v %s:%s:ro' % (vol, vol)
if not self.run_as_root:
cmd = '''uid={uid}
gid={gid}
{sudo} docker {docker_url} pull {container_id}
{sudo} docker {docker_url} run --rm -w {bank_dir} {depends_vol} -v {host_data_dir}:{container_data_dir} {env} {container_id} \
bash -c "groupadd --gid {gid} {group_biomaj} && useradd --uid {uid} --gid {gid} {user_biomaj}; \
{exe} {args}; \
chown -R {uid}:{gid} {bank_dir}"'''.format(
uid=os.getuid(),
gid=os.getgid(),
host_data_dir=host_data_dir,
container_data_dir=container_data_dir,
env=env,
container_id=self.docker,
group_biomaj='biomaj',
user_biomaj='biomaj',
exe=self.exe,
args=' '.join(self.args),
bank_dir=release_dir,
sudo=use_sudo,
docker_url=docker_url,
depends_vol=depends_vol
)
else:
cmd = '''
{sudo} docker {docker_url} pull {container_id}
{sudo} docker {docker_url} run --rm -w {bank_dir} {depends_vol} -v {host_data_dir}:{container_data_dir} {env} {container_id} \
{exe} {args} \
'''.format(
host_data_dir=host_data_dir,
container_data_dir=container_data_dir,
env=env,
container_id=self.docker,
exe=self.exe,
args=' '.join(self.args),
bank_dir=release_dir,
sudo=use_sudo,
docker_url=docker_url,
depends_vol=depends_vol
)
(handler, tmpfile) = tempfile.mkstemp('biomaj')
if sys.version_info[0] < 3:
os.write(handler, cmd)
else:
os.write(handler, bytes(cmd, 'UTF-8'))
os.close(handler)
os.chmod(tmpfile, 0o755)
args = [tmpfile]
logging.debug('PROCESS:EXEC:Docker:' + str(self.args))
logging.debug('PROCESS:EXEC:Docker:Tmpfile:' + tmpfile)
err = False
if not simulate:
logging.info('PROCESS:RUN:Docker:' + self.docker + ':' + self.name)
with open(self.output_file, 'w') as fout:
with open(self.error_file, 'w') as ferr:
start_time = datetime.datetime.now()
start_time = time.mktime(start_time.timetuple())
if self.expand:
args = " ".join(args)
proc = subprocess.Popen(args, stdout=fout, stderr=ferr, env=self.bank_env, shell=True)
else:
proc = subprocess.Popen(args, stdout=fout, stderr=ferr, env=self.bank_env, shell=False)
proc.wait()
end_time = datetime.datetime.now()
end_time = time.mktime(end_time.timetuple())
self.exec_time = end_time - start_time
self.exitcode = proc.returncode
if proc.returncode == 0:
err = True
else:
logging.error('PROCESS:ERROR:' + self.name)
fout.flush()
ferr.flush()
else:
err = True
logging.info('PROCESS:EXEC:' + self.name + ':' + str(err))
os.remove(tmpfile)
return err
class DrmaaProcess(Process):
def __init__(self, name, exe, args, desc=None, proc_type=None, native=None, expand=True, bank_env=None, log_dir=None):
Process.__init__(self, name, exe, args, desc, proc_type, expand, bank_env, log_dir)
self.native = native
def run(self, simulate=False):
'''
Execute process
:param simulate: does not execute process
:type simulate: bool
:return: exit code of process
'''
# args = [self.exe] + self.args
logging.debug('PROCESS:EXEC:' + str(self.args))
err = False
if not simulate:
logging.info('Run process ' + self.name)
# Execute on DRMAA
try:
import drmaa
with drmaa.Session() as s:
jt = s.createJobTemplate()
jt.remoteCommand = self.exe
jt.args = self.args
jt.joinFiles = False
jt.workingDirectory = os.path.dirname(os.path.realpath(self.output_file))
jt.jobEnvironment = self.bank_env
if self.native:
jt.nativeSpecification = " " + self.native + " "
jt.outputPath = ':' + self.output_file
jt.errorPath = ':' + self.error_file
jobid = s.runJob(jt)
retval = s.wait(jobid, drmaa.Session.TIMEOUT_WAIT_FOREVER)
if retval.hasExited > 0:
err = True
else:
logging.error('PROCESS:ERROR:' + self.name)
s.deleteJobTemplate(jt)
except Exception as e:
logging.error('Drmaa process error: ' + str(e))
return False
else:
err = True
logging.info('PROCESS:EXEC:' + self.name + ':' + str(err))
return err
|