def __init__(self, extra_config=None):
self.outgoing_message_queue = Queue()
if extra_config is None:
extra_config = {}
# make up a config.
tempdir = mkdtemp()
# reset the config every time
sys.modules.pop('errbot.config-template', None)
__import__('errbot.config-template')
config = ShallowConfig()
config.__dict__.update(sys.modules['errbot.config-template'].__dict__)
bot_config_defaults(config)
# It injects itself as a plugin. Changed the name to be sure we distinguish it.
self.name = 'DummyBackendRealName'
config.BOT_DATA_DIR = tempdir
config.BOT_LOG_FILE = tempdir + sep + 'log.txt'
config.BOT_PLUGIN_INDEXES = tempdir + sep + 'repos.json'
config.BOT_EXTRA_PLUGIN_DIR = []
config.BOT_LOG_LEVEL = logging.DEBUG
config.BOT_IDENTITY = {'username': '******'}
config.BOT_ASYNC = False
config.BOT_PREFIX = '!'
config.CHATROOM_FN = 'blah'
# Writeout the made up repos file
with open(config.BOT_PLUGIN_INDEXES, "w") as index_file:
index_file.write(SIMPLE_JSON_PLUGINS_INDEX)
for key in extra_config:
setattr(config, key, extra_config[key])
super().__init__(config)
self.bot_identifier = self.build_identifier('err')
self.md = text() # We just want simple text for testing purposes
# setup a memory based storage
spm = BackendPluginManager(config, 'errbot.storage', 'Memory', StoragePluginBase, CORE_STORAGE)
storage_plugin = spm.load_plugin()
# setup the plugin_manager just internally
botplugins_dir = os.path.join(config.BOT_DATA_DIR, PLUGINS_SUBDIR)
if not os.path.exists(botplugins_dir):
os.makedirs(botplugins_dir, mode=0o755)
# get it back from where we publish it.
repo_index_paths = (os.path.join(os.path.dirname(__file__), '..', 'docs', '_extra', 'repos.json'),)
repo_manager = BotRepoManager(storage_plugin,
botplugins_dir,
repo_index_paths)
self.attach_storage_plugin(storage_plugin)
self.attach_repo_manager(repo_manager)
self.attach_plugin_manager(BotPluginManager(storage_plugin,
config.BOT_EXTRA_PLUGIN_DIR,
config.AUTOINSTALL_DEPS,
getattr(config, 'CORE_PLUGINS', None),
lambda name, clazz: clazz(self, name),
getattr(config, 'PLUGINS_CALLBACK_ORDER', (None, ))))
self.inject_commands_from(self)
self.inject_command_filters_from(ACLS(self))
def get_storage_plugin(config):
"""
Find and load the storage plugin
:param config: the bot configuration.
:return: the storage plugin
"""
storage_name = getattr(config, 'STORAGE', 'Shelf')
extra_storage_plugins_dir = getattr(config, 'BOT_EXTRA_STORAGE_PLUGINS_DIR', None)
spm = BackendPluginManager(config, 'errbot.storage', storage_name, StoragePluginBase,
CORE_STORAGE, extra_storage_plugins_dir)
log.info(f'Found Storage plugin: {spm.plugin_info.name}.')
return spm.load_plugin()
def get_storage_plugin(config):
"""
Find and load the storage plugin
:param config: the bot configuration.
:return: the storage plugin
"""
storage_name = getattr(config, 'STORAGE', 'Shelf')
extra_storage_plugins_dir = getattr(config, 'BOT_EXTRA_STORAGE_PLUGINS_DIR', None)
spm = BackendPluginManager(config, 'errbot.storage', storage_name, StoragePluginBase,
CORE_STORAGE, extra_storage_plugins_dir)
log.info(f'Found Storage plugin: {spm.plugin_info.name}.')
return spm.load_plugin()
def get_storage_plugin(config: object) -> Callable:
"""
Find and load the storage plugin
:param config: the bot configuration.
:return: the storage plugin
"""
storage_name = getattr(config, "STORAGE", "Shelf")
extra_storage_plugins_dir = getattr(config, "BOT_EXTRA_STORAGE_PLUGINS_DIR", None)
spm = BackendPluginManager(
config,
"errbot.storage",
storage_name,
StoragePluginBase,
CORE_STORAGE,
extra_storage_plugins_dir,
)
log.info(f"Found Storage plugin: {spm.plugin_info.name}.")
return spm.load_plugin()
def test_storage():
key = 'test'
__import__('errbot.config-template')
config = ShallowConfig()
config.__dict__.update(sys.modules['errbot.config-template'].__dict__)
bot_config_defaults(config)
spm = BackendPluginManager(config, 'errbot.storage', 'Memory', StoragePluginBase, CORE_STORAGE)
storage_plugin = spm.load_plugin()
persistent_object = StoreMixin()
persistent_object.open_storage(storage_plugin, 'test')
persistent_object[key] = 'à value'
assert persistent_object[key] == 'à value'
assert key in persistent_object
del persistent_object[key]
assert key not in persistent_object
assert len(persistent_object) == 0
def test_storage():
key = "test"
__import__("errbot.config-template")
config = ShallowConfig()
config.__dict__.update(sys.modules["errbot.config-template"].__dict__)
bot_config_defaults(config)
spm = BackendPluginManager(config, "errbot.storage", "Memory",
StoragePluginBase, CORE_STORAGE)
storage_plugin = spm.load_plugin()
persistent_object = StoreMixin()
persistent_object.open_storage(storage_plugin, "test")
persistent_object[key] = "à value"
assert persistent_object[key] == "à value"
assert key in persistent_object
del persistent_object[key]
assert key not in persistent_object
assert len(persistent_object) == 0
def test_storage():
key = 'test'
__import__('errbot.config-template')
config = ShallowConfig()
config.__dict__.update(sys.modules['errbot.config-template'].__dict__)
bot_config_defaults(config)
spm = BackendPluginManager(config, 'errbot.storage', 'Memory',
StoragePluginBase, CORE_STORAGE)
storage_plugin = spm.load_plugin()
persistent_object = StoreMixin()
persistent_object.open_storage(storage_plugin, 'test')
persistent_object[key] = 'à value'
assert persistent_object[key] == 'à value'
assert key in persistent_object
del persistent_object[key]
assert key not in persistent_object
assert len(persistent_object) == 0
def setup_bot(backend_name: str, logger, config, restore=None) -> ErrBot:
# from here the environment is supposed to be set (daemon / non daemon,
# config.py in the python path )
bot_config_defaults(config)
if hasattr(config, 'BOT_LOG_FORMATTER'):
format_logs(formatter=config.BOT_LOG_FORMATTER)
else:
format_logs(theme_color=config.TEXT_COLOR_THEME)
if config.BOT_LOG_FILE:
hdlr = logging.FileHandler(config.BOT_LOG_FILE)
hdlr.setFormatter(
logging.Formatter(
"%(asctime)s %(levelname)-8s %(name)-25s %(message)s"))
logger.addHandler(hdlr)
if hasattr(config, 'BOT_LOG_SENTRY') and config.BOT_LOG_SENTRY:
try:
from raven.handlers.logging import SentryHandler
except ImportError:
log.exception(
"You have BOT_LOG_SENTRY enabled, but I couldn't import modules "
"needed for Sentry integration. Did you install raven? "
"(See http://raven.readthedocs.org/en/latest/install/index.html "
"for installation instructions)")
exit(-1)
try:
if hasattr(config, 'SENTRY_TRANSPORT') and isinstance(
config.SENTRY_TRANSPORT, tuple):
mod = importlib.import_module(config.SENTRY_TRANSPORT[1])
transport = getattr(mod, config.SENTRY_TRANSPORT[0])
sentryhandler = SentryHandler(config.SENTRY_DSN,
level=config.SENTRY_LOGLEVEL,
transport=transport)
else:
sentryhandler = SentryHandler(config.SENTRY_DSN,
level=config.SENTRY_LOGLEVEL)
logger.addHandler(sentryhandler)
except ImportError:
log.exception(
f'Unable to import selected SENTRY_TRANSPORT - {config.SENTRY_TRANSPORT}'
)
exit(-1)
logger.setLevel(config.BOT_LOG_LEVEL)
storage_plugin = get_storage_plugin(config)
# init the botplugin manager
botplugins_dir = path.join(config.BOT_DATA_DIR, PLUGINS_SUBDIR)
if not path.exists(botplugins_dir):
makedirs(botplugins_dir, mode=0o755)
plugin_indexes = getattr(config, 'BOT_PLUGIN_INDEXES',
(PLUGIN_DEFAULT_INDEX, ))
if isinstance(plugin_indexes, str):
plugin_indexes = (plugin_indexes, )
backendpm = BackendPluginManager(
config, 'errbot.backends', backend_name, ErrBot, CORE_BACKENDS,
getattr(config, 'BOT_EXTRA_BACKEND_DIR', []))
log.info(f'Found Backend plugin: {backendpm.plugin_info.name}')
repo_manager = BotRepoManager(storage_plugin, botplugins_dir,
plugin_indexes)
try:
bot = backendpm.load_plugin()
botpm = BotPluginManager(
storage_plugin,
config.BOT_EXTRA_PLUGIN_DIR, config.AUTOINSTALL_DEPS,
getattr(config, 'CORE_PLUGINS',
None), lambda name, clazz: clazz(bot, name),
getattr(config, 'PLUGINS_CALLBACK_ORDER', (None, )))
bot.attach_storage_plugin(storage_plugin)
bot.attach_repo_manager(repo_manager)
bot.attach_plugin_manager(botpm)
bot.initialize_backend_storage()
# restore the bot from the restore script
if restore:
# Prepare the context for the restore script
if 'repos' in bot:
log.fatal('You cannot restore onto a non empty bot.')
sys.exit(-1)
log.info(f'**** RESTORING the bot from {restore}')
restore_bot_from_backup(restore, bot=bot, log=log)
print('Restore complete. You can restart the bot normally')
sys.exit(0)
errors = bot.plugin_manager.update_plugin_places(
repo_manager.get_all_repos_paths())
if errors:
log.error('Some plugins failed to load:\n' +
'\n'.join(errors.values()))
bot._plugin_errors_during_startup = "\n".join(errors.values())
return bot
except Exception:
log.exception("Unable to load or configure the backend.")
exit(-1)
def __init__(self, extra_config=None):
self.outgoing_message_queue = Queue()
if extra_config is None:
extra_config = {}
# make up a config.
tempdir = mkdtemp()
# reset the config every time
sys.modules.pop("errbot.config-template", None)
__import__("errbot.config-template")
config = ShallowConfig()
config.__dict__.update(sys.modules["errbot.config-template"].__dict__)
bot_config_defaults(config)
# It injects itself as a plugin. Changed the name to be sure we distinguish it.
self.name = "DummyBackendRealName"
config.BOT_DATA_DIR = tempdir
config.BOT_LOG_FILE = tempdir + sep + "log.txt"
config.BOT_PLUGIN_INDEXES = tempdir + sep + "repos.json"
config.BOT_EXTRA_PLUGIN_DIR = []
config.BOT_LOG_LEVEL = logging.DEBUG
config.BOT_IDENTITY = {"username": "******"}
config.BOT_ASYNC = False
config.BOT_PREFIX = "!"
config.CHATROOM_FN = "blah"
# Writeout the made up repos file
with open(config.BOT_PLUGIN_INDEXES, "w") as index_file:
index_file.write(SIMPLE_JSON_PLUGINS_INDEX)
for key in extra_config:
setattr(config, key, extra_config[key])
super().__init__(config)
self.bot_identifier = self.build_identifier("err")
self.md = text() # We just want simple text for testing purposes
# setup a memory based storage
spm = BackendPluginManager(config, "errbot.storage", "Memory",
StoragePluginBase, CORE_STORAGE)
storage_plugin = spm.load_plugin()
# setup the plugin_manager just internally
botplugins_dir = os.path.join(config.BOT_DATA_DIR, PLUGINS_SUBDIR)
if not os.path.exists(botplugins_dir):
os.makedirs(botplugins_dir, mode=0o755)
# get it back from where we publish it.
repo_index_paths = (os.path.join(os.path.dirname(__file__), "..",
"docs", "_extra", "repos.json"), )
repo_manager = BotRepoManager(storage_plugin, botplugins_dir,
repo_index_paths)
self.attach_storage_plugin(storage_plugin)
self.attach_repo_manager(repo_manager)
self.attach_plugin_manager(
BotPluginManager(
storage_plugin,
config.BOT_EXTRA_PLUGIN_DIR,
config.AUTOINSTALL_DEPS,
getattr(config, "CORE_PLUGINS", None),
lambda name, clazz: clazz(self, name),
getattr(config, "PLUGINS_CALLBACK_ORDER", (None, )),
))
self.inject_commands_from(self)
self.inject_command_filters_from(ACLS(self))
def setup_bot(backend_name: str, logger, config, restore=None) -> ErrBot:
# from here the environment is supposed to be set (daemon / non daemon,
# config.py in the python path )
bot_config_defaults(config)
if hasattr(config, "BOT_LOG_FORMATTER"):
format_logs(formatter=config.BOT_LOG_FORMATTER)
else:
format_logs(theme_color=config.TEXT_COLOR_THEME)
if hasattr(config, "BOT_LOG_FILE") and config.BOT_LOG_FILE:
hdlr = logging.FileHandler(config.BOT_LOG_FILE)
hdlr.setFormatter(
logging.Formatter(
"%(asctime)s %(levelname)-8s %(name)-25s %(message)s"))
logger.addHandler(hdlr)
if hasattr(config, "BOT_LOG_SENTRY") and config.BOT_LOG_SENTRY:
sentry_integrations = []
try:
import sentry_sdk
from sentry_sdk.integrations.logging import LoggingIntegration
except ImportError:
log.exception(
"You have BOT_LOG_SENTRY enabled, but I couldn't import modules "
"needed for Sentry integration. Did you install sentry-sdk? "
"(See https://docs.sentry.io/platforms/python for installation instructions)"
)
exit(-1)
sentry_logging = LoggingIntegration(
level=config.SENTRY_LOGLEVEL, event_level=config.SENTRY_EVENTLEVEL)
sentry_integrations.append(sentry_logging)
if hasattr(config,
"BOT_LOG_SENTRY_FLASK") and config.BOT_LOG_SENTRY_FLASK:
try:
from sentry_sdk.integrations.flask import FlaskIntegration
except ImportError:
log.exception(
"You have BOT_LOG_SENTRY enabled, but I couldn't import modules "
"needed for Sentry integration. Did you install sentry-sdk[flask]? "
"(See https://docs.sentry.io/platforms/python/flask for installation instructions)"
)
exit(-1)
sentry_integrations.append(FlaskIntegration())
try:
if hasattr(config, "SENTRY_TRANSPORT") and isinstance(
config.SENTRY_TRANSPORT, tuple):
mod = importlib.import_module(config.SENTRY_TRANSPORT[1])
transport = getattr(mod, config.SENTRY_TRANSPORT[0])
sentry_sdk.init(
dsn=config.SENTRY_DSN,
integrations=sentry_integrations,
transport=transport,
)
else:
sentry_sdk.init(dsn=config.SENTRY_DSN,
integrations=sentry_integrations)
except ImportError:
log.exception(
f"Unable to import selected SENTRY_TRANSPORT - {config.SENTRY_TRANSPORT}"
)
exit(-1)
logger.setLevel(config.BOT_LOG_LEVEL)
storage_plugin = get_storage_plugin(config)
# init the botplugin manager
botplugins_dir = path.join(config.BOT_DATA_DIR, PLUGINS_SUBDIR)
if not path.exists(botplugins_dir):
makedirs(botplugins_dir, mode=0o755)
plugin_indexes = getattr(config, "BOT_PLUGIN_INDEXES",
(PLUGIN_DEFAULT_INDEX, ))
if isinstance(plugin_indexes, str):
plugin_indexes = (plugin_indexes, )
# Extra backend is expected to be a list type, convert string to list.
extra_backend = getattr(config, "BOT_EXTRA_BACKEND_DIR", [])
if isinstance(extra_backend, str):
extra_backend = [extra_backend]
backendpm = BackendPluginManager(config, "errbot.backends", backend_name,
ErrBot, CORE_BACKENDS, extra_backend)
log.info(f"Found Backend plugin: {backendpm.plugin_info.name}")
repo_manager = BotRepoManager(storage_plugin, botplugins_dir,
plugin_indexes)
try:
bot = backendpm.load_plugin()
botpm = BotPluginManager(
storage_plugin,
config.BOT_EXTRA_PLUGIN_DIR,
config.AUTOINSTALL_DEPS,
getattr(config, "CORE_PLUGINS", None),
lambda name, clazz: clazz(bot, name),
getattr(config, "PLUGINS_CALLBACK_ORDER", (None, )),
)
bot.attach_storage_plugin(storage_plugin)
bot.attach_repo_manager(repo_manager)
bot.attach_plugin_manager(botpm)
bot.initialize_backend_storage()
# restore the bot from the restore script
if restore:
# Prepare the context for the restore script
if "repos" in bot:
log.fatal("You cannot restore onto a non empty bot.")
sys.exit(-1)
log.info(f"**** RESTORING the bot from {restore}")
restore_bot_from_backup(restore, bot=bot, log=log)
print("Restore complete. You can restart the bot normally")
sys.exit(0)
errors = bot.plugin_manager.update_plugin_places(
repo_manager.get_all_repos_paths())
if errors:
startup_errors = "\n".join(errors.values())
log.error("Some plugins failed to load:\n%s", startup_errors)
bot._plugin_errors_during_startup = startup_errors
return bot
except Exception:
log.exception("Unable to load or configure the backend.")
exit(-1)
def test_builtins(backend_name):
bpm = BackendPluginManager({}, 'errbot.backends', backend_name, ErrBot,
CORE_BACKENDS)
assert bpm.plugin_info.name == backend_name
def setup_bot(backend_name: str, logger, config, restore=None) -> ErrBot:
# from here the environment is supposed to be set (daemon / non daemon,
# config.py in the python path )
bot_config_defaults(config)
if hasattr(config, 'BOT_LOG_FORMATTER'):
format_logs(formatter=config.BOT_LOG_FORMATTER)
else:
format_logs(theme_color=config.TEXT_COLOR_THEME)
if config.BOT_LOG_FILE:
hdlr = logging.FileHandler(config.BOT_LOG_FILE)
hdlr.setFormatter(logging.Formatter("%(asctime)s %(levelname)-8s %(name)-25s %(message)s"))
logger.addHandler(hdlr)
if hasattr(config, 'BOT_LOG_SENTRY') and config.BOT_LOG_SENTRY:
try:
from raven.handlers.logging import SentryHandler
except ImportError:
log.exception(
"You have BOT_LOG_SENTRY enabled, but I couldn't import modules "
"needed for Sentry integration. Did you install raven? "
"(See http://raven.readthedocs.org/en/latest/install/index.html "
"for installation instructions)"
)
exit(-1)
try:
if hasattr(config, 'SENTRY_TRANSPORT') and isinstance(config.SENTRY_TRANSPORT, tuple):
mod = importlib.import_module(config.SENTRY_TRANSPORT[1])
transport = getattr(mod, config.SENTRY_TRANSPORT[0])
sentryhandler = SentryHandler(config.SENTRY_DSN,
level=config.SENTRY_LOGLEVEL,
transport=transport)
else:
sentryhandler = SentryHandler(config.SENTRY_DSN, level=config.SENTRY_LOGLEVEL)
logger.addHandler(sentryhandler)
except ImportError:
log.exception(f'Unable to import selected SENTRY_TRANSPORT - {config.SENTRY_TRANSPORT}')
exit(-1)
logger.setLevel(config.BOT_LOG_LEVEL)
storage_plugin = get_storage_plugin(config)
# init the botplugin manager
botplugins_dir = path.join(config.BOT_DATA_DIR, PLUGINS_SUBDIR)
if not path.exists(botplugins_dir):
makedirs(botplugins_dir, mode=0o755)
plugin_indexes = getattr(config, 'BOT_PLUGIN_INDEXES', (PLUGIN_DEFAULT_INDEX,))
if isinstance(plugin_indexes, str):
plugin_indexes = (plugin_indexes, )
backendpm = BackendPluginManager(config, 'errbot.backends', backend_name,
ErrBot, CORE_BACKENDS, getattr(config, 'BOT_EXTRA_BACKEND_DIR', []))
log.info(f'Found Backend plugin: {backendpm.plugin_info.name}')
repo_manager = BotRepoManager(storage_plugin,
botplugins_dir,
plugin_indexes)
try:
bot = backendpm.load_plugin()
botpm = BotPluginManager(storage_plugin,
config.BOT_EXTRA_PLUGIN_DIR,
config.AUTOINSTALL_DEPS,
getattr(config, 'CORE_PLUGINS', None),
lambda name, clazz: clazz(bot, name),
getattr(config, 'PLUGINS_CALLBACK_ORDER', (None, )))
bot.attach_storage_plugin(storage_plugin)
bot.attach_repo_manager(repo_manager)
bot.attach_plugin_manager(botpm)
bot.initialize_backend_storage()
# restore the bot from the restore script
if restore:
# Prepare the context for the restore script
if 'repos' in bot:
log.fatal('You cannot restore onto a non empty bot.')
sys.exit(-1)
log.info(f'**** RESTORING the bot from {restore}')
restore_bot_from_backup(restore, bot=bot, log=log)
print('Restore complete. You can restart the bot normally')
sys.exit(0)
errors = bot.plugin_manager.update_plugin_places(repo_manager.get_all_repos_paths())
if errors:
log.error('Some plugins failed to load:\n' + '\n'.join(errors.values()))
bot._plugin_errors_during_startup = "\n".join(errors.values())
return bot
except Exception:
log.exception("Unable to load or configure the backend.")
exit(-1)
