ebd05be2c4
* *: deduplicate boilerplate for importing related models Signed-off-by: Jens Langhammer <jens@goauthentik.io> * also auto-import .checks Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix error during prometheus metrics from #8435 Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io>
110 lines
3.7 KiB
Python
110 lines
3.7 KiB
Python
"""authentik Blueprints app"""
|
|
|
|
from importlib import import_module
|
|
from inspect import ismethod
|
|
|
|
from django.apps import AppConfig
|
|
from django.db import DatabaseError, InternalError, ProgrammingError
|
|
from structlog.stdlib import BoundLogger, get_logger
|
|
|
|
|
|
class ManagedAppConfig(AppConfig):
|
|
"""Basic reconciliation logic for apps"""
|
|
|
|
logger: BoundLogger
|
|
|
|
RECONCILE_GLOBAL_PREFIX: str = "reconcile_global_"
|
|
RECONCILE_TENANT_PREFIX: str = "reconcile_tenant_"
|
|
|
|
def __init__(self, app_name: str, *args, **kwargs) -> None:
|
|
super().__init__(app_name, *args, **kwargs)
|
|
self.logger = get_logger().bind(app_name=app_name)
|
|
|
|
def ready(self) -> None:
|
|
self.import_related()
|
|
self.reconcile_global()
|
|
self.reconcile_tenant()
|
|
return super().ready()
|
|
|
|
def import_related(self):
|
|
"""Automatically import related modules which rely on just being imported
|
|
to register themselves (mainly django signals and celery tasks)"""
|
|
|
|
def import_relative(rel_module: str):
|
|
try:
|
|
module_name = f"{self.name}.{rel_module}"
|
|
import_module(module_name)
|
|
self.logger.info("Imported related module", module=module_name)
|
|
except ModuleNotFoundError:
|
|
pass
|
|
|
|
import_relative("checks")
|
|
import_relative("tasks")
|
|
import_relative("signals")
|
|
|
|
def import_module(self, path: str):
|
|
"""Load module"""
|
|
import_module(path)
|
|
|
|
def _reconcile(self, prefix: str) -> None:
|
|
for meth_name in dir(self):
|
|
meth = getattr(self, meth_name)
|
|
if not ismethod(meth):
|
|
continue
|
|
if not meth_name.startswith(prefix):
|
|
continue
|
|
name = meth_name.replace(prefix, "")
|
|
try:
|
|
self.logger.debug("Starting reconciler", name=name)
|
|
meth()
|
|
self.logger.debug("Successfully reconciled", name=name)
|
|
except (DatabaseError, ProgrammingError, InternalError) as exc:
|
|
self.logger.warning("Failed to run reconcile", name=name, exc=exc)
|
|
|
|
def reconcile_tenant(self) -> None:
|
|
"""reconcile ourselves for tenanted methods"""
|
|
from authentik.tenants.models import Tenant
|
|
|
|
try:
|
|
tenants = list(Tenant.objects.filter(ready=True))
|
|
except (DatabaseError, ProgrammingError, InternalError) as exc:
|
|
self.logger.debug("Failed to get tenants to run reconcile", exc=exc)
|
|
return
|
|
for tenant in tenants:
|
|
with tenant:
|
|
self._reconcile(self.RECONCILE_TENANT_PREFIX)
|
|
|
|
def reconcile_global(self) -> None:
|
|
"""
|
|
reconcile ourselves for global methods.
|
|
Used for signals, tasks, etc. Database queries should not be made in here.
|
|
"""
|
|
from django_tenants.utils import get_public_schema_name, schema_context
|
|
|
|
with schema_context(get_public_schema_name()):
|
|
self._reconcile(self.RECONCILE_GLOBAL_PREFIX)
|
|
|
|
|
|
class AuthentikBlueprintsConfig(ManagedAppConfig):
|
|
"""authentik Blueprints app"""
|
|
|
|
name = "authentik.blueprints"
|
|
label = "authentik_blueprints"
|
|
verbose_name = "authentik Blueprints"
|
|
default = True
|
|
|
|
def reconcile_global_load_blueprints_v1_tasks(self):
|
|
"""Load v1 tasks"""
|
|
self.import_module("authentik.blueprints.v1.tasks")
|
|
|
|
def reconcile_tenant_blueprints_discovery(self):
|
|
"""Run blueprint discovery"""
|
|
from authentik.blueprints.v1.tasks import blueprints_discovery, clear_failed_blueprints
|
|
|
|
blueprints_discovery.delay()
|
|
clear_failed_blueprints.delay()
|
|
|
|
def import_models(self):
|
|
super().import_models()
|
|
self.import_module("authentik.blueprints.v1.meta.apply_blueprint")
|