51e6dde4e5
This commit fixes some errors introduced with the support for the authorization in Synergy. The files involved are: service.py and shell.py and related unit tests. Change-Id: I84587e48927307d85b9a3f96ea49154805da7bcd Sem-Ver: bugfix
457 lines
15 KiB
Python
457 lines
15 KiB
Python
import eventlet
|
|
import json
|
|
import logging
|
|
import logging.handlers
|
|
import os
|
|
import sys
|
|
|
|
from cgi import escape
|
|
from cgi import parse_qs
|
|
from pkg_resources import iter_entry_points
|
|
|
|
from oslo_config import cfg
|
|
|
|
from synergy.common import config
|
|
from synergy.common.manager import Manager
|
|
from synergy.common.serializer import SynergyEncoder
|
|
from synergy.common.service import Service
|
|
from synergy.common import utils
|
|
from synergy.common.wsgi import Server
|
|
from synergy.exception import AuthorizationError
|
|
from synergy.exception import SynergyError
|
|
|
|
|
|
__author__ = "Lisa Zangrando"
|
|
__email__ = "lisa.zangrando[AT]pd.infn.it"
|
|
__copyright__ = """Copyright (c) 2015 INFN - INDIGO-DataCloud
|
|
All Rights Reserved
|
|
|
|
Licensed under the Apache License, Version 2.0;
|
|
you may not use this file except in compliance with the
|
|
License. You may obtain a copy of the License at:
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing,
|
|
software distributed under the License is distributed on an
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
|
either express or implied.
|
|
See the License for the specific language governing
|
|
permissions and limitations under the License."""
|
|
|
|
CONF = cfg.CONF
|
|
LOG = None
|
|
MANAGER_ENTRY_POINT = "synergy.managers" # used to discover Synergy managers
|
|
|
|
|
|
def setLogger(name):
|
|
"""Configure the given logger with Synergy logging configuration.
|
|
|
|
Note:
|
|
This function should only be used when entering Synergy by the main()
|
|
function. Otherwise you may run into issues due to logging to protected
|
|
files.
|
|
"""
|
|
# create a logging format
|
|
formatter = logging.Formatter(CONF.Logger.formatter)
|
|
|
|
log_dir = os.path.dirname(CONF.Logger.filename)
|
|
if not os.path.exists(log_dir):
|
|
os.makedirs(log_dir)
|
|
|
|
# Add the log message handler to the logger
|
|
handler = logging.handlers.RotatingFileHandler(
|
|
CONF.Logger.filename,
|
|
maxBytes=CONF.Logger.maxBytes,
|
|
backupCount=CONF.Logger.backupCount)
|
|
|
|
handler.setFormatter(formatter)
|
|
|
|
# set logger level
|
|
logger = logging.getLogger(name)
|
|
|
|
if not len(logger.handlers):
|
|
try:
|
|
logger.setLevel(cfg.CONF.Logger.level)
|
|
except ValueError: # wrong level, we default to INFO
|
|
logger.setLevel(logging.INFO)
|
|
|
|
logger.propagate = False
|
|
logger.addHandler(handler)
|
|
|
|
|
|
class Synergy(Service):
|
|
"""Service object for binaries running on hosts.
|
|
|
|
A service takes a manager and enables rpc by listening to queues based
|
|
on topic. It also periodically runs tasks on the manager and reports
|
|
it state to the database services table.
|
|
"""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(Synergy, self).__init__("Synergy")
|
|
|
|
self.managers = {}
|
|
self.wsgi_server = None
|
|
self.auth_plugin = CONF.Authorization.plugin
|
|
|
|
if self.auth_plugin == "noauth":
|
|
LOG.info("the authorization is disabled!")
|
|
self.auth_plugin = None
|
|
else:
|
|
LOG.info("loading the auth_plugin %s" % self.auth_plugin)
|
|
self.auth_plugin = utils.instantiate_class(self.auth_plugin)
|
|
|
|
for entry in iter_entry_points(MANAGER_ENTRY_POINT):
|
|
LOG.info("loading the %s manager", entry.name)
|
|
|
|
try:
|
|
CONF.register_opts(config.manager_opts, group=entry.name)
|
|
|
|
manager_class = entry.load()
|
|
|
|
manager_obj = manager_class(*args, **kwargs)
|
|
manager_obj.setName(entry.name)
|
|
manager_obj.setAutoStart(CONF.get(entry.name).autostart)
|
|
manager_obj.setRate(CONF.get(entry.name).rate)
|
|
|
|
# Configure logging for manager
|
|
setLogger(manager_obj.__module__.rsplit('.', 1)[0])
|
|
setLogger(manager_obj.__module__)
|
|
|
|
self.managers[manager_obj.getName()] = manager_obj
|
|
|
|
CONF.register_opts(manager_obj.getOptions(), group=entry.name)
|
|
except cfg.Error as ex:
|
|
LOG.error("Exception has occured", exc_info=1)
|
|
|
|
LOG.error("manager %s instantiation error: %s"
|
|
% (entry.name, ex))
|
|
|
|
raise SynergyError("manager %s instantiation error: %s"
|
|
% (entry.name, ex))
|
|
|
|
for name, manager in self.managers.items():
|
|
manager.managers = self.managers
|
|
|
|
try:
|
|
LOG.info("initializing the %s manager" % (manager.getName()))
|
|
|
|
manager.setup()
|
|
|
|
LOG.info("manager %s initialized!" % (manager.getName()))
|
|
except NotImplementedError:
|
|
message = "manager %s instantiation error: setup() not " \
|
|
"implemented!" % name
|
|
|
|
LOG.error(message)
|
|
raise SynergyError(message)
|
|
except SynergyError as ex:
|
|
LOG.error("manager %s instantiation error: %s" % (name, ex))
|
|
self.managers[manager.getName()].setStatus("ERROR")
|
|
raise ex
|
|
|
|
self.saved_args, self.saved_kwargs = args, kwargs
|
|
|
|
def parseParameters(f):
|
|
def wrapper(self, *args, **kw):
|
|
if not args:
|
|
return f(self, *args, **kw)
|
|
|
|
context = args[0]
|
|
|
|
query = context.get("QUERY_STRING", None)
|
|
|
|
if query:
|
|
parameters = parse_qs(query)
|
|
|
|
for key in parameters:
|
|
value = escape(parameters[key][0])
|
|
value = value.replace("'", "\"")
|
|
|
|
try:
|
|
value = json.loads(value)
|
|
except ValueError:
|
|
pass
|
|
|
|
context[key] = value
|
|
|
|
return f(self, *args, **kw)
|
|
|
|
return wrapper
|
|
|
|
def checkParameters(parameters):
|
|
def check(f):
|
|
def wrapper(self, *args, **kw):
|
|
context = args[0]
|
|
start_response = args[1]
|
|
|
|
for parameter in parameters:
|
|
value = context.get(parameter, None)
|
|
|
|
if not value:
|
|
start_response("400 BAD REQUEST",
|
|
[("Content-Type", "text/plain")])
|
|
return ["parameter %s not found!" % parameter]
|
|
|
|
if parameter == "manager" and value not in self.managers:
|
|
start_response("404 NOT FOUND",
|
|
[("Content-Type", "text/plain")])
|
|
return ["manager %s not found!" % value]
|
|
|
|
return f(self, *args, **kw)
|
|
return wrapper
|
|
return check
|
|
|
|
def authorize(f):
|
|
def wrapper(self, *args, **kw):
|
|
if self.auth_plugin:
|
|
context = args[0]
|
|
context["managers"] = self.managers
|
|
|
|
try:
|
|
self.auth_plugin.authorize(context)
|
|
except AuthorizationError as ex:
|
|
args[1]("401 Unauthorized",
|
|
[("Content-Type", "text/plain")])
|
|
return ["%s" % ex.message]
|
|
|
|
return f(self, *args, **kw)
|
|
|
|
return wrapper
|
|
|
|
@authorize
|
|
def listManagers(self, environ, start_response):
|
|
result = []
|
|
|
|
for name, manager in self.managers.items():
|
|
m = Manager(name)
|
|
m.setStatus(manager.getStatus())
|
|
m.setRate(manager.getRate())
|
|
|
|
result.append(m)
|
|
|
|
start_response("200 OK", [("Content-Type", "text/html")])
|
|
return ["%s" % json.dumps(result, cls=SynergyEncoder)]
|
|
|
|
@parseParameters
|
|
@authorize
|
|
def getManagerStatus(self, environ, start_response):
|
|
manager_name = environ.get("manager", None)
|
|
|
|
manager_list = None
|
|
result = []
|
|
|
|
if manager_name:
|
|
if manager_name not in self.managers:
|
|
start_response("404 NOT FOUND",
|
|
[("Content-Type", "text/plain")])
|
|
return "manager %s not found!" % manager_name
|
|
|
|
manager_list = [manager_name]
|
|
else:
|
|
manager_list = self.managers.keys()
|
|
|
|
for manager_name in manager_list:
|
|
manager_name = escape(manager_name)
|
|
|
|
if manager_name in self.managers:
|
|
manager = self.managers[manager_name]
|
|
|
|
m = Manager(manager_name)
|
|
m.setStatus(manager.getStatus())
|
|
m.setRate(manager.getRate())
|
|
|
|
result.append(m)
|
|
|
|
start_response("200 OK", [("Content-Type", "text/html")])
|
|
return [json.dumps(result, cls=SynergyEncoder)]
|
|
|
|
@parseParameters
|
|
@checkParameters(["manager", "command"])
|
|
@authorize
|
|
def executeCommand(self, environ, start_response):
|
|
manager_name = environ["manager"]
|
|
manager = self.managers[manager_name]
|
|
manager_args = environ["args"]
|
|
command = environ["command"]
|
|
|
|
try:
|
|
result = manager.execute(command=command, **manager_args)
|
|
|
|
start_response("200 OK", [("Content-Type", "text/html")])
|
|
return [json.dumps(result, cls=SynergyEncoder)]
|
|
except NotImplementedError:
|
|
message = "execute() not implemented!"
|
|
|
|
LOG.error(message)
|
|
start_response("500 INTERNAL SERVER ERROR",
|
|
[("Content-Type", "text/plain")])
|
|
return [message]
|
|
|
|
except SynergyError as ex:
|
|
LOG.debug("execute command: error=%s" % ex)
|
|
|
|
start_response("422 Unprocessable Entity",
|
|
[("Content-Type", "text/plain")])
|
|
return ["%s" % ex.message]
|
|
|
|
@parseParameters
|
|
@checkParameters(["manager"])
|
|
@authorize
|
|
def startManager(self, environ, start_response):
|
|
manager_name = environ["manager"]
|
|
manager = self.managers[manager_name]
|
|
result = Manager(manager_name)
|
|
result.setRate(manager.getRate())
|
|
|
|
if manager.getStatus() == "ACTIVE":
|
|
LOG.info("starting the %s manager" % (manager_name))
|
|
|
|
manager.resume()
|
|
|
|
LOG.info("%s manager started! (rate=%s min)"
|
|
% (manager_name, manager.getRate()))
|
|
|
|
result.setStatus("RUNNING")
|
|
result.set("message", "started successfully")
|
|
elif manager.getStatus() == "RUNNING":
|
|
result.setStatus("RUNNING")
|
|
result.set("message", "WARN: already started")
|
|
elif manager.getStatus() == "ERROR":
|
|
result.setStatus("ERROR")
|
|
result.set("message", "wrong state")
|
|
|
|
start_response("200 OK", [("Content-Type", "text/html")])
|
|
return [json.dumps(result, cls=SynergyEncoder)]
|
|
|
|
@parseParameters
|
|
@checkParameters(["manager"])
|
|
@authorize
|
|
def stopManager(self, environ, start_response):
|
|
manager_name = environ["manager"]
|
|
manager = self.managers[manager_name]
|
|
result = Manager(manager_name)
|
|
result.setRate(manager.getRate())
|
|
|
|
if manager.getStatus() == "RUNNING":
|
|
LOG.info("stopping the %s manager" % (manager_name))
|
|
|
|
manager.pause()
|
|
|
|
LOG.info("%s manager stopped!" % (manager_name))
|
|
|
|
result.setStatus("ACTIVE")
|
|
result.set("message", "stopped successfully")
|
|
elif manager.getStatus() == "ACTIVE":
|
|
result.setStatus("ACTIVE")
|
|
result.set("message", "WARN: already stopped")
|
|
elif manager.getStatus() == "ERROR":
|
|
result.setStatus("ERROR")
|
|
result.set("message", "wrong state")
|
|
|
|
start_response("200 OK", [("Content-Type", "text/html")])
|
|
return [json.dumps(result, cls=SynergyEncoder)]
|
|
|
|
def start(self):
|
|
self.model_disconnected = False
|
|
|
|
for name, manager in self.managers.items():
|
|
if manager.getStatus() != "ERROR":
|
|
try:
|
|
LOG.info("starting the %s manager" % (name))
|
|
manager.start()
|
|
|
|
LOG.info("%s manager started! (rate=%s min, status=%s)"
|
|
% (name, manager.getRate(), manager.getStatus()))
|
|
except SynergyError as ex:
|
|
LOG.error("error occurred during the manager start %s"
|
|
% (ex))
|
|
manager.setStatus("ERROR")
|
|
raise ex
|
|
|
|
self.wsgi_server = Server(
|
|
name="WSGI server",
|
|
host_name=CONF.WSGI.host,
|
|
host_port=CONF.WSGI.port,
|
|
threads=CONF.WSGI.threads,
|
|
use_ssl=CONF.WSGI.use_ssl,
|
|
ssl_ca_file=CONF.WSGI.ssl_ca_file,
|
|
ssl_cert_file=CONF.WSGI.ssl_cert_file,
|
|
ssl_key_file=CONF.WSGI.ssl_key_file,
|
|
max_header_line=CONF.WSGI.max_header_line,
|
|
retry_until_window=CONF.WSGI.retry_until_window,
|
|
tcp_keepidle=CONF.WSGI.tcp_keepidle,
|
|
backlog=CONF.WSGI.backlog)
|
|
|
|
self.wsgi_server.register(r'synergy/list', self.listManagers)
|
|
self.wsgi_server.register(r'synergy/status', self.getManagerStatus)
|
|
self.wsgi_server.register(r'synergy/execute', self.executeCommand)
|
|
self.wsgi_server.register(r'synergy/start', self.startManager)
|
|
self.wsgi_server.register(r'synergy/stop', self.stopManager)
|
|
self.wsgi_server.start()
|
|
|
|
LOG.info("STARTED!")
|
|
self.wsgi_server.wait()
|
|
|
|
def kill(self):
|
|
"""Destroy the service object in the datastore."""
|
|
LOG.warn("killing service")
|
|
self.stop()
|
|
LOG.warn("Service killed")
|
|
|
|
def stop(self):
|
|
for name, manager in self.managers.items():
|
|
LOG.info("destroying the %s manager" % (name))
|
|
try:
|
|
manager.setStatus("DESTROYED")
|
|
manager.destroy()
|
|
# manager.join()
|
|
# LOG.info("%s manager destroyed" % (name))
|
|
except NotImplementedError:
|
|
message = "method destroy() not implemented by the " \
|
|
"%s manager" % manager.getName()
|
|
|
|
LOG.error(message)
|
|
|
|
except SynergyError as ex:
|
|
LOG.error("Exception has occured", exc_info=1)
|
|
|
|
manager.setStatus("ERROR")
|
|
LOG.error("error occurred during the manager destruction: %s"
|
|
% ex)
|
|
|
|
if self.wsgi_server:
|
|
self.wsgi_server.stop()
|
|
|
|
LOG.info("STOPPED!")
|
|
|
|
|
|
def main():
|
|
try:
|
|
eventlet.monkey_patch(os=False)
|
|
|
|
# the configuration will be into the cfg.CONF global data structure
|
|
config.parseArgs(args=sys.argv[1:],
|
|
default_config_files=["/etc/synergy/synergy.conf"])
|
|
|
|
if not cfg.CONF.config_file:
|
|
sys.exit("ERROR: Unable to find configuration file via the "
|
|
"default search paths (~/.synergy/, ~/, /etc/synergy/"
|
|
", /etc/) and the '--config-file' option!")
|
|
|
|
setLogger(name="synergy")
|
|
setLogger(name="oslo.messaging._drivers")
|
|
|
|
global LOG
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
LOG.info("Starting Synergy...")
|
|
|
|
server = Synergy()
|
|
server.start()
|
|
|
|
LOG.info("Synergy started")
|
|
except Exception as ex:
|
|
LOG.error("unrecoverable error: %s" % ex)
|