forked from borgmatic-collective/borgmatic
63 lines
2.4 KiB
Python
63 lines
2.4 KiB
Python
import logging
|
|
|
|
from borgmatic.hooks import cronhub, cronitor, healthchecks, mysql, pagerduty, postgresql
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
HOOK_NAME_TO_MODULE = {
|
|
'healthchecks': healthchecks,
|
|
'cronitor': cronitor,
|
|
'cronhub': cronhub,
|
|
'pagerduty': pagerduty,
|
|
'postgresql_databases': postgresql,
|
|
'mysql_databases': mysql,
|
|
}
|
|
|
|
|
|
def call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs):
|
|
'''
|
|
Given the hooks configuration dict and a prefix to use in log entries, call the requested
|
|
function of the Python module corresponding to the given hook name. Supply that call with the
|
|
configuration for this hook, the log prefix, and any given args and kwargs. Return any return
|
|
value.
|
|
|
|
If the hook name is not present in the hooks configuration, then bail without calling anything.
|
|
|
|
Raise ValueError if the hook name is unknown.
|
|
Raise AttributeError if the function name is not found in the module.
|
|
Raise anything else that the called function raises.
|
|
'''
|
|
config = hooks.get(hook_name)
|
|
if not config:
|
|
logger.debug('{}: No {} hook configured.'.format(log_prefix, hook_name))
|
|
return
|
|
|
|
try:
|
|
module = HOOK_NAME_TO_MODULE[hook_name]
|
|
except KeyError:
|
|
raise ValueError('Unknown hook name: {}'.format(hook_name))
|
|
|
|
logger.debug('{}: Calling {} hook function {}'.format(log_prefix, hook_name, function_name))
|
|
return getattr(module, function_name)(config, log_prefix, *args, **kwargs)
|
|
|
|
|
|
def call_hooks(function_name, hooks, log_prefix, hook_names, *args, **kwargs):
|
|
'''
|
|
Given the hooks configuration dict and a prefix to use in log entries, call the requested
|
|
function of the Python module corresponding to each given hook name. Supply each call with the
|
|
configuration for that hook, the log prefix, and any given args and kwargs. Collect any return
|
|
values into a dict from hook name to return value.
|
|
|
|
If the hook name is not present in the hooks configuration, then don't call the function for it,
|
|
and omit it from the return values.
|
|
|
|
Raise ValueError if the hook name is unknown.
|
|
Raise AttributeError if the function name is not found in the module.
|
|
Raise anything else that a called function raises. An error stops calls to subsequent functions.
|
|
'''
|
|
return {
|
|
hook_name: call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs)
|
|
for hook_name in hook_names
|
|
if hooks.get(hook_name)
|
|
}
|