def start_backend(backend, host=None, port=None,
adaptor=ControllerAdaptor_Backend_JSON,
byef=None):
conf = config.get_conf('beah-backend')
host = host or conf.get('DEFAULT', 'INTERFACE')
port = port or conf.get('DEFAULT', 'PORT')
if os.name == 'posix':
socket = conf.get('DEFAULT', 'SOCKET')
# 0. check SOCKET_OPT (socket given on command line)
if parse_bool(conf.get('DEFAULT', 'SOCKET_OPT')) and socket != '':
port = ''
# 1. check INTERFACE - if not empty nor localhost: must use TCP
if not localhost_(host):
socket = ''
# 2. check PORT_OPT (port given on command line)
if parse_bool(conf.get('DEFAULT', 'PORT_OPT')) and port != '':
socket = ''
else:
socket = ''
backend_factory = BackendFactory(backend, adaptor, byef)
if socket != '':
return reactor.connectUNIX(socket, backend_factory)
elif port and host:
return reactor.connectTCP(host, int(port), backend_factory)
elif port:
if not parse_bool(conf.get('DEFAULT', 'IPV6_DISABLED')):
return connect_loopback(int(port),
backend_factory)
else:
return connect_loopback(int(port),
backend_factory,
ipv6_disabled=True)
else:
raise EnvironmentError('Either socket or port must be configured.')
def start_forwarder_backend():
if parse_bool(config.get_conf('beah-backend').get('DEFAULT', 'DEVEL')):
print_this = log_this(lambda s: log.debug(s), log_on=True)
make_class_verbose(ForwarderBackend, print_this)
make_class_verbose(_RemoteBackend, print_this)
backend = ForwarderBackend()
# Start a default TCP client:
start_backend(backend)
return backend
def start_forwarder_backend():
if parse_bool(config.get_conf('beah-backend').get('DEFAULT', 'DEVEL')):
print_this = log_this(lambda s: log.debug(s), log_on=True)
make_class_verbose(ForwarderBackend, print_this)
make_class_verbose(_RemoteBackend, print_this)
backend = ForwarderBackend()
# Start a default TCP client:
start_backend(backend)
return backend
def log_handler(log_file_name=None):
conf = config.get_conf('beah-backend')
if not log_file_name:
if conf.has_option('DEFAULT', 'LOG_FILE'):
log_file_name = conf.get('DEFAULT', 'LOG_FILE')
else:
log_file_name = conf.get('DEFAULT', 'NAME') + '.log'
lp = conf.get('DEFAULT', 'LOG_PATH') or "/var/log"
log = logging.getLogger('backend')
twisted_logging(log, level=logging.WARNING)
make_log_handler(log, lp, log_file_name, syslog=True,
console=parse_bool(conf.get('DEFAULT', 'CONSOLE_LOG')))
log.setLevel(str2log_level(conf.get('DEFAULT', 'LOG')))
return log
def start_watchdog_backend(conf):
'''Starts a watchdog backend with specified configuration.'''
log = logging.getLogger('backend')
if parse_bool(conf.get('DEFAULT', 'DEVEL')):
print_this = log_this(log.debug, log_on=True)
make_class_verbose(WatchdogBackend, print_this)
make_class_verbose(Task, print_this)
handlers = dict(DEFAULT_HANDLERS)
load_plugins(WATCHDOG_ENTRYPOINT, handlers)
backend = WatchdogBackend(conf=conf, log=log, handlers=handlers)
query_interval = int(conf.get('DEFAULT', 'QUERY_WATCHDOG'))
if query_interval > 0:
watchdogs_request = LoopingCall(backend.query_watchdogs)
watchdogs_request.start(query_interval, now=False)
#pylint: disable=E1101
reactor.addSystemEventTrigger('before', 'shutdown', watchdogs_request.stop)
# Start a default TCP client:
backend.initialize()
start_backend(backend)
def start_task(conf, task, host=None, port=None,
adaptor=twadaptors.ControllerAdaptor_Task_JSON, socket=None,
):
factory = TaskFactory(task, adaptor)
if os.name == 'posix':
socket = socket or conf.get('TASK', 'SOCKET')
if socket != '':
return reactor.connectUNIX(socket, factory)
host = host or conf.get('TASK', 'INTERFACE')
port = port or int(conf.get('TASK', 'PORT'))
if port and host:
return reactor.connectTCP(host, int(port), factory)
elif port:
if not parse_bool(conf.get('DEFAULT', 'IPV6_DISABLED')):
return connect_loopback(int(port), factory)
else:
return connect_loopback(int(port), factory,
ipv6_disabled=True)
raise EnvironmentError('Either socket or port must be given.')
def start_watchdog_backend(conf):
'''Starts a watchdog backend with specified configuration.'''
log = logging.getLogger('backend')
if parse_bool(conf.get('DEFAULT', 'DEVEL')):
print_this = log_this(log.debug, log_on=True)
make_class_verbose(WatchdogBackend, print_this)
make_class_verbose(Task, print_this)
handlers = dict(DEFAULT_HANDLERS)
load_plugins(WATCHDOG_ENTRYPOINT, handlers)
backend = WatchdogBackend(conf=conf, log=log, handlers=handlers)
query_interval = int(conf.get('DEFAULT', 'QUERY_WATCHDOG'))
if query_interval > 0:
watchdogs_request = LoopingCall(backend.query_watchdogs)
watchdogs_request.start(query_interval, now=False)
#pylint: disable=E1101
reactor.addSystemEventTrigger('before', 'shutdown',
watchdogs_request.stop)
# Start a default TCP client:
backend.initialize()
start_backend(backend)
def start_task(
conf,
task,
host=None,
port=None,
adaptor=twadaptors.ControllerAdaptor_Task_JSON,
socket=None,
):
factory = TaskFactory(task, adaptor)
if os.name == 'posix':
socket = socket or conf.get('TASK', 'SOCKET')
if socket != '':
return reactor.connectUNIX(socket, factory)
host = host or conf.get('TASK', 'INTERFACE')
port = port or int(conf.get('TASK', 'PORT'))
if port and host:
return reactor.connectTCP(host, int(port), factory)
elif port:
if not parse_bool(conf.get('DEFAULT', 'IPV6_DISABLED')):
return connect_loopback(int(port), factory)
else:
return connect_loopback(int(port), factory, ipv6_disabled=True)
raise EnvironmentError('Either socket or port must be given.')
def start_server(conf=None, backend_host=None, backend_port=None,
backend_adaptor=BackendAdaptor_JSON,
task_host=None, task_port=None,
task_adaptor=TaskAdaptor_JSON, spawn=None):
# CONFIG:
if not conf:
config.beah_conf()
conf = config.get_conf('beah')
# LOGGING:
twisted_logging(log, level=logging.WARNING)
log.setLevel(str2log_level(conf.get('CONTROLLER', 'LOG')))
# Create a directory for runtime
# FIXME: should try to create a temp path if following fails:
ensuredir(conf.get('CONTROLLER', 'VAR_ROOT'))
# Create a directory for logging and check permissions
lp = conf.get('CONTROLLER', 'LOG_PATH')
make_log_handler(log, lp, conf.get('CONTROLLER', 'LOG_FILE_NAME'),
syslog=True, console=conf.get('CONTROLLER', 'CONSOLE_LOG', False))
if parse_bool(config.get_conf('beah').get('CONTROLLER', 'DEVEL')):
print_this = log_this(log.debug, True)
make_class_verbose(Controller, print_this)
make_class_verbose(MasterTask, print_this)
# RUN:
backend_host = backend_host or conf.get('BACKEND', 'INTERFACE')
backend_port = backend_port or conf.get('BACKEND', 'PORT')
task_host = task_host or conf.get('TASK', 'INTERFACE')
task_port = task_port or int(conf.get('TASK', 'PORT'))
if os.name == 'posix':
if backend_port != '':
backend_port = int(backend_port)
backend_socket = conf.get('BACKEND', 'SOCKET')
if task_port != '':
task_port = int(task_port)
task_socket = conf.get('TASK', 'SOCKET')
else:
backend_port = int(backend_port)
backend_socket = ''
task_port = int(task_port)
task_socket = ''
runtime = runtimes.ShelveRuntime(conf.get('CONTROLLER', 'RUNTIME_FILE_NAME'))
runtime.vars = runtimes.TypeDict(runtime, 'vars')
runtime.tasks = runtimes.TypeDict(runtime, 'tasks')
controller = Controller(spawn or Spawn(task_host, task_port, socket=task_socket), runtime=runtime)
def on_killed():
if not controller.backends:
reactor.stop()
return
reactor.callLater(2, reactor.stop)
controller.on_killed = on_killed
log.info("################################")
log.info("# Starting a Controller... #")
log.info("################################")
backend_listener = BackendListener(controller, backend_adaptor)
if backend_port != '':
if backend_host == 'localhost':
listening = listen_loopback_tcp(backend_port, backend_listener)
elif backend_host:
listening = reactor.listenTCP(backend_port, backend_listener, interface=backend_host)
else:
listening = listen_all_tcp(backend_port,
backend_listener,
ipv6_disabled=parse_bool(conf.get('DEFAULT', 'IPV6_DISABLED')))
log.info("Controller: BackendListener listening on %s port %s",
listening.getHost().host, listening.getHost().port)
if backend_socket:
if os.path.exists(backend_socket):
# clean-up after e.g. system crash:
log.warning("Controller: BackendListener cleaning %s", backend_socket)
os.remove(backend_socket)
log.info("Controller: BackendListener listening on %s", backend_socket)
reactor.listenUNIX(backend_socket, backend_listener)
task_listener = TaskListener(controller, task_adaptor)
if task_port != '':
if task_host == 'localhost':
listening = listen_loopback_tcp(task_port, task_listener)
elif task_host:
listening = reactor.listenTCP(task_port, task_listener, interface=task_host)
else:
listening = listen_all_tcp(task_port,
task_listener,
ipv6_disabled=parse_bool(conf.get('DEFAULT', 'IPV6_DISABLED')))
log.info("Controller: TaskListener listening on %s port %s",
listening.getHost().host, listening.getHost().port)
if task_socket:
if os.path.exists(task_socket):
# clean-up after e.g. system crash:
log.warning("Controller: TaskListener cleaning %s", task_socket)
os.remove(task_socket)
log.info("Controller: TaskListener listening on %s", task_socket)
reactor.listenUNIX(task_socket, task_listener)
return controller
def __init__(self, task_path, env):
self.process = None
self.listener = None
self.task_path = task_path
self.__done = False
self.__waits_for = []
# FIXME: is inheriting the whole environment desirable?
if env is not USE_DEFAULT:
self.env = dict(env)
else:
self.env = dict(os.environ)
# FIXME: Any other env.variables to set?
# FIXME: What values should be used here?
# - some values could be received from LC when task is scheduled, but
# it would create a dependency!
# - let's use fake values, and let the Backend translate it (if
# supported)
# - e.g. JOBID, RECIPESETID, RECIPEID are not interesting at all
# - use task_id for RECIPESETID, and BE (or LC eventually) should
# be able to find about the rest...
taskid = "J%(JOBID)s-S%(RECIPESETID)s-R%(RECIPEID)s-T%(TASKID)s" % self.env
# FIXME! use tempfile and upload log when process ends.
log = logging.getLogger('rhts_task')
twmisc.twisted_logging(log, level=logging.WARNING)
ll = self.env.get('BEAH_TASK_LOG', "warning")
log.setLevel(str2log_level(ll))
make_log_handler(log,
LOG_PATH,
"rhts_task_%s.log" % (taskid, ),
syslog=True,
console=self.env.get('BEAH_TASK_CONSOLE', False))
# parse task's metadata:
try:
from rhts import testinfo
ti = testinfo.parse_file(os.path.join(self.env['TESTPATH'],
'testinfo.desc'),
raise_errors=False)
except:
log.error("Error in tasks metadata: %s" % format_exc())
ti = None
if ti is not None:
for k, v in getattr(ti, 'environment', {}).iteritems():
self.env.setdefault(k, v)
for o in getattr(ti, 'options', []):
opt_lower = o.lower()
if opt_lower[0] == '-':
opt_lower = opt_lower[1:]
value = ''
else:
value = 'yes'
if opt_lower.startswith('compatible'):
self.env.setdefault('RHTS_OPTION_COMPATIBLE', value)
elif opt_lower.startswith('compatservice'):
self.env.setdefault('RHTS_OPTION_COMPAT_SERVICE', value)
elif opt_lower.startswith('strongeravc'):
self.env.setdefault('RHTS_OPTION_STRONGER_AVC', value)
# update log level if necessary:
ll2 = self.env.get('BEAH_TASK_LOG', ll)
if ll2 != ll:
log.setLevel(str2log_level(ll2))
# No point in storing everything in one big file. Use one file per task
rt = runtimes.ShelveRuntime(RUNTIME_PATHNAME_TEMPLATE % taskid)
self.__files = runtimes.TypeDict(rt, 'files')
# FIXME: use configurable range of ports.
self.variables = runtimes.TypeDict(rt, 'variables')
port = self.variables.setdefault(
'port', int(self.env.get('RHTS_PORT', random.randint(7080, 7099))))
self.variables.setdefault('nohup', False)
self.variables.setdefault('has_result', False)
self.env.setdefault(
'DIGEST_METHOD', 'no_digest'
) # use no digests by default... Seems waste of time on localhost.
self.env.setdefault('TESTORDER', '123') # FIXME: More sensible default
# update defaults:
for k, v in self.ENV_DEFAULTS.iteritems():
self.env.setdefault(k, v)
# provide sensible defaults for selected system env.variables:
self.env.setdefault('HOME', '/root')
self.env.setdefault('LANG', 'en_US.UTF-8')
# FIXME: should any checks go here?
# e.g. does Makefile PURPOSE exist? try running `make testinfo.desc`? ...
self.controller = ControllerLink(self)
stdio.StandardIO(self.controller)
self.task = RHTSTask(self)
self.server = RHTSServer(self)
# If IPv6 has not been disabled, attempt to listen on IPv6
# otherwise fall back to IPv4
def listen_tcp(interface):
return reactor.listenTCP(port, self.server, interface=interface)
conf = beah.config.get_conf('beah')
if not parse_bool(conf.get('DEFAULT', 'IPV6_DISABLED')):
try:
listen_tcp('::1')
self.env['RESULT_SERVER'] = '[::1]:%s' % port
except CannotListenError:
listen_tcp('127.0.0.1')
self.env['RESULT_SERVER'] = '127.0.0.1:%s' % port
else:
listen_tcp('127.0.0.1')
self.env['RESULT_SERVER'] = '127.0.0.1:%s' % port
# save env:
env_file = ENV_PATHNAME_TEMPLATE % taskid
self.env['RHTS_ENV'] = env_file
jsonenv.export_env(env_file, self.env)
# Execute rhts-test-runner.sh
self.server_started()
def __init__(self, task_path, env):
self.process = None
self.listener = None
self.task_path = task_path
self.__done = False
self.__waits_for = []
# FIXME: is inheriting the whole environment desirable?
if env is not USE_DEFAULT:
self.env = dict(env)
else:
self.env = dict(os.environ)
# FIXME: Any other env.variables to set?
# FIXME: What values should be used here?
# - some values could be received from LC when task is scheduled, but
# it would create a dependency!
# - let's use fake values, and let the Backend translate it (if
# supported)
# - e.g. JOBID, RECIPESETID, RECIPEID are not interesting at all
# - use task_id for RECIPESETID, and BE (or LC eventually) should
# be able to find about the rest...
taskid = "J%(JOBID)s-S%(RECIPESETID)s-R%(RECIPEID)s-T%(TASKID)s" % self.env
# FIXME! use tempfile and upload log when process ends.
log = logging.getLogger('rhts_task')
twmisc.twisted_logging(log, level=logging.WARNING)
ll = self.env.get('BEAH_TASK_LOG', "warning")
log.setLevel(str2log_level(ll))
make_log_handler(log, LOG_PATH, "rhts_task_%s.log" % (taskid,),
syslog=True,
console=self.env.get('BEAH_TASK_CONSOLE', False))
# parse task's metadata:
try:
from rhts import testinfo
ti = testinfo.parse_file(os.path.join(self.env['TESTPATH'], 'testinfo.desc'), raise_errors=False)
except:
log.error("Error in tasks metadata: %s" % format_exc())
ti = None
if ti is not None:
for k,v in getattr(ti, 'environment', {}).iteritems():
self.env.setdefault(k, v)
for o in getattr(ti, 'options', []):
opt_lower = o.lower()
if opt_lower[0] == '-':
opt_lower = opt_lower[1:]
value = ''
else:
value = 'yes'
if opt_lower.startswith('compatible'):
self.env.setdefault('RHTS_OPTION_COMPATIBLE', value)
elif opt_lower.startswith('compatservice'):
self.env.setdefault('RHTS_OPTION_COMPAT_SERVICE', value)
elif opt_lower.startswith('strongeravc'):
self.env.setdefault('RHTS_OPTION_STRONGER_AVC', value)
# update log level if necessary:
ll2 = self.env.get('BEAH_TASK_LOG', ll)
if ll2 != ll:
log.setLevel(str2log_level(ll2))
# No point in storing everything in one big file. Use one file per task
rt = runtimes.ShelveRuntime(RUNTIME_PATHNAME_TEMPLATE % taskid)
self.__files = runtimes.TypeDict(rt, 'files')
# FIXME: use configurable range of ports.
self.variables = runtimes.TypeDict(rt, 'variables')
port = self.variables.setdefault('port', int(self.env.get('RHTS_PORT', random.randint(7080, 7099))))
self.variables.setdefault('nohup', False)
self.variables.setdefault('has_result', False)
self.env.setdefault('DIGEST_METHOD', 'no_digest') # use no digests by default... Seems waste of time on localhost.
self.env.setdefault('TESTORDER', '123') # FIXME: More sensible default
# update defaults:
for k, v in self.ENV_DEFAULTS.iteritems():
self.env.setdefault(k, v)
# provide sensible defaults for selected system env.variables:
self.env.setdefault('HOME', '/root')
self.env.setdefault('LANG', 'en_US.UTF-8')
# FIXME: should any checks go here?
# e.g. does Makefile PURPOSE exist? try running `make testinfo.desc`? ...
self.controller = ControllerLink(self)
stdio.StandardIO(self.controller)
self.task = RHTSTask(self)
self.server = RHTSServer(self)
# If IPv6 has not been disabled, attempt to listen on IPv6
# otherwise fall back to IPv4
def listen_tcp(interface):
return reactor.listenTCP(port, self.server,
interface=interface)
conf = beah.config.get_conf('beah')
if not parse_bool(conf.get('DEFAULT', 'IPV6_DISABLED')):
try:
listen_tcp('::1')
self.env['RESULT_SERVER'] = '[::1]:%s' % port
except CannotListenError:
listen_tcp('127.0.0.1')
self.env['RESULT_SERVER'] = '127.0.0.1:%s' % port
else:
listen_tcp('127.0.0.1')
self.env['RESULT_SERVER'] = '127.0.0.1:%s' % port
# save env:
env_file = ENV_PATHNAME_TEMPLATE % taskid
self.env['RHTS_ENV'] = env_file
jsonenv.export_env(env_file, self.env)
# Execute rhts-test-runner.sh
self.server_started()
def start_server(conf=None,
backend_host=None,
backend_port=None,
backend_adaptor=BackendAdaptor_JSON,
task_host=None,
task_port=None,
task_adaptor=TaskAdaptor_JSON,
spawn=None):
# CONFIG:
if not conf:
config.beah_conf()
conf = config.get_conf('beah')
# LOGGING:
twisted_logging(log, level=logging.WARNING)
log.setLevel(str2log_level(conf.get('CONTROLLER', 'LOG')))
# Create a directory for runtime
# FIXME: should try to create a temp path if following fails:
ensuredir(conf.get('CONTROLLER', 'VAR_ROOT'))
# Create a directory for logging and check permissions
lp = conf.get('CONTROLLER', 'LOG_PATH')
make_log_handler(log,
lp,
conf.get('CONTROLLER', 'LOG_FILE_NAME'),
syslog=True,
console=conf.get('CONTROLLER', 'CONSOLE_LOG', False))
if parse_bool(config.get_conf('beah').get('CONTROLLER', 'DEVEL')):
print_this = log_this(log.debug, True)
make_class_verbose(Controller, print_this)
make_class_verbose(MasterTask, print_this)
# RUN:
backend_host = backend_host or conf.get('BACKEND', 'INTERFACE')
backend_port = backend_port or conf.get('BACKEND', 'PORT')
task_host = task_host or conf.get('TASK', 'INTERFACE')
task_port = task_port or int(conf.get('TASK', 'PORT'))
if os.name == 'posix':
if backend_port != '':
backend_port = int(backend_port)
backend_socket = conf.get('BACKEND', 'SOCKET')
if task_port != '':
task_port = int(task_port)
task_socket = conf.get('TASK', 'SOCKET')
else:
backend_port = int(backend_port)
backend_socket = ''
task_port = int(task_port)
task_socket = ''
runtime = runtimes.ShelveRuntime(
conf.get('CONTROLLER', 'RUNTIME_FILE_NAME'))
runtime.vars = runtimes.TypeDict(runtime, 'vars')
runtime.tasks = runtimes.TypeDict(runtime, 'tasks')
controller = Controller(spawn
or Spawn(task_host, task_port, socket=task_socket),
runtime=runtime)
def on_killed():
if not controller.backends:
reactor.stop()
return
reactor.callLater(2, reactor.stop)
controller.on_killed = on_killed
log.info("################################")
log.info("# Starting a Controller... #")
log.info("################################")
backend_listener = BackendListener(controller, backend_adaptor)
if backend_port != '':
if backend_host == 'localhost':
listening = listen_loopback_tcp(backend_port, backend_listener)
elif backend_host:
listening = reactor.listenTCP(backend_port,
backend_listener,
interface=backend_host)
else:
listening = listen_all_tcp(backend_port,
backend_listener,
ipv6_disabled=parse_bool(
conf.get('DEFAULT',
'IPV6_DISABLED')))
log.info("Controller: BackendListener listening on %s port %s",
listening.getHost().host,
listening.getHost().port)
if backend_socket:
if os.path.exists(backend_socket):
# clean-up after e.g. system crash:
log.warning("Controller: BackendListener cleaning %s",
backend_socket)
os.remove(backend_socket)
log.info("Controller: BackendListener listening on %s", backend_socket)
reactor.listenUNIX(backend_socket, backend_listener)
task_listener = TaskListener(controller, task_adaptor)
if task_port != '':
if task_host == 'localhost':
listening = listen_loopback_tcp(task_port, task_listener)
elif task_host:
listening = reactor.listenTCP(task_port,
task_listener,
interface=task_host)
else:
listening = listen_all_tcp(task_port,
task_listener,
ipv6_disabled=parse_bool(
conf.get('DEFAULT',
'IPV6_DISABLED')))
log.info("Controller: TaskListener listening on %s port %s",
listening.getHost().host,
listening.getHost().port)
if task_socket:
if os.path.exists(task_socket):
# clean-up after e.g. system crash:
log.warning("Controller: TaskListener cleaning %s", task_socket)
os.remove(task_socket)
log.info("Controller: TaskListener listening on %s", task_socket)
reactor.listenUNIX(task_socket, task_listener)
return controller
def test_parse_bool(arg):
return parse_bool(arg) and True or False
def test_parse_bool(arg):
return parse_bool(arg) and True or False
