def _configure_settings(config):
"""
Callback for processing conditional or special purpose settings.
Any specially prepared settings will be handled here, such as loading
plugins, enabling social auth, etc.
This is intended to be called by `run_app` and should not be invoked
directly.
:param config:
A dictionary of `config_path`, `project`, `settings`
Example::
{
'project': 'nautobot',
'config_path': '/path/to/nautobot_config.py',
'settings': <LazySettings "nautobot_config">
}
"""
settings = config["settings"]
# Include the config path to the settings to align with builtin
# `settings.SETTINGS_MODULE`. Useful for debugging correct config path.
settings.SETTINGS_PATH = config["config_path"]
#
# Storage directories
#
if not os.path.exists(settings.GIT_ROOT):
os.makedirs(settings.GIT_ROOT)
if not os.path.exists(settings.JOBS_ROOT):
os.makedirs(settings.JOBS_ROOT)
if not os.path.exists(os.path.join(settings.JOBS_ROOT, "__init__.py")):
Path(os.path.join(settings.JOBS_ROOT, "__init__.py")).touch()
if not os.path.exists(settings.MEDIA_ROOT):
os.makedirs(settings.MEDIA_ROOT)
if not os.path.exists(os.path.join(settings.MEDIA_ROOT, "devicetype-images")):
os.makedirs(os.path.join(settings.MEDIA_ROOT, "devicetype-images"))
if not os.path.exists(os.path.join(settings.MEDIA_ROOT, "image-attachments")):
os.makedirs(os.path.join(settings.MEDIA_ROOT, "image-attachments"))
if not os.path.exists(settings.STATIC_ROOT):
os.makedirs(settings.STATIC_ROOT)
#
# Databases
#
# If metrics are enabled and postgres is the backend, set the driver to the
# one provided by django-prometheous.
if settings.METRICS_ENABLED and "postgres" in settings.DATABASES["default"]["ENGINE"]:
settings.DATABASES["default"]["ENGINE"] = "django_prometheus.db.backends.postgresql"
#
# Pagination
#
if settings.PAGINATE_COUNT not in settings.PER_PAGE_DEFAULTS:
settings.PER_PAGE_DEFAULTS.append(settings.PAGINATE_COUNT)
settings.PER_PAGE_DEFAULTS = sorted(settings.PER_PAGE_DEFAULTS)
#
# Media storage
#
if settings.STORAGE_BACKEND is not None:
settings.DEFAULT_FILE_STORAGE = settings.STORAGE_BACKEND
# django-storages
if settings.STORAGE_BACKEND.startswith("storages."):
try:
import storages.utils
except ModuleNotFoundError as e:
if getattr(e, "name") == "storages":
raise ImproperlyConfigured(
f"STORAGE_BACKEND is set to {settings.STORAGE_BACKEND} but django-storages is not present. It "
f"can be installed by running 'pip install django-storages'."
)
raise e
# Monkey-patch django-storages to fetch settings from STORAGE_CONFIG
def _setting(name, default=None):
if name in settings.STORAGE_CONFIG:
return settings.STORAGE_CONFIG[name]
return globals().get(name, default)
storages.utils.setting = _setting
#
# Plugins
#
# Process the plugins and manipulate the specified config settings that are
# passed in.
load_plugins(settings)
def _configure_settings(config):
"""
Callback for processing conditional or special purpose settings.
Any specially prepared settings will be handled here, such as loading
plugins, enabling social auth, etc.
This is intended to be called by `run_app` and should not be invoked
directly.
:param config:
A dictionary of `config_path`, `project`, `settings`
Example::
{
'project': 'nautobot',
'config_path': '/path/to/nautobot_config.py',
'settings': <LazySettings "nautobot_config">
}
"""
settings = config["settings"]
# Include the config path to the settings to align with builtin
# `settings.SETTINGS_MODULE`. Useful for debugging correct config path.
settings.SETTINGS_PATH = config["config_path"]
#
# Storage directories
#
if not os.path.exists(settings.GIT_ROOT):
os.makedirs(settings.GIT_ROOT)
if not os.path.exists(settings.JOBS_ROOT):
os.makedirs(settings.JOBS_ROOT)
if not os.path.exists(os.path.join(settings.JOBS_ROOT, "__init__.py")):
Path(os.path.join(settings.JOBS_ROOT, "__init__.py")).touch()
if not os.path.exists(settings.MEDIA_ROOT):
os.makedirs(settings.MEDIA_ROOT)
if not os.path.exists(
os.path.join(settings.MEDIA_ROOT, "devicetype-images")):
os.makedirs(os.path.join(settings.MEDIA_ROOT, "devicetype-images"))
if not os.path.exists(
os.path.join(settings.MEDIA_ROOT, "image-attachments")):
os.makedirs(os.path.join(settings.MEDIA_ROOT, "image-attachments"))
if not os.path.exists(settings.STATIC_ROOT):
os.makedirs(settings.STATIC_ROOT)
#
# Databases
#
# If metrics are enabled and postgres is the backend, set the driver to the
# one provided by django-prometheous.
if settings.METRICS_ENABLED and "postgres" in settings.DATABASES[
"default"]["ENGINE"]:
settings.DATABASES["default"][
"ENGINE"] = "django_prometheus.db.backends.postgresql"
#
# Pagination
#
if settings.PAGINATE_COUNT not in settings.PER_PAGE_DEFAULTS:
settings.PER_PAGE_DEFAULTS.append(settings.PAGINATE_COUNT)
settings.PER_PAGE_DEFAULTS = sorted(settings.PER_PAGE_DEFAULTS)
#
# Authentication
#
# FIXME(jathan): This is just here as an interim validation check, to be
# replaced in a future update when all other validations hard-coded here in
# settings are moved to use the Django system check framework.
if "nautobot.core.authentication.ObjectPermissionBackend" not in settings.AUTHENTICATION_BACKENDS:
raise ImproperlyConfigured(
"nautobot.core.authentication.ObjectPermissionBackend must be defined in "
"'AUTHENTICATION_BACKENDS'")
#
# Releases
#
# Validate update repo URL and timeout
if settings.RELEASE_CHECK_URL:
try:
URLValidator(settings.RELEASE_CHECK_URL)
except ValidationError:
raise ImproperlyConfigured(
"RELEASE_CHECK_URL must be a valid API URL. Example: "
"https://api.github.com/repos/nautobot/nautobot")
# FIXME(jathan): Why is this enforced here? This would be better enforced in the core.
# Enforce a minimum cache timeout for update checks
if settings.RELEASE_CHECK_TIMEOUT < 3600:
raise ImproperlyConfigured(
"RELEASE_CHECK_TIMEOUT has to be at least 3600 seconds (1 hour)")
#
# Media storage
#
if settings.STORAGE_BACKEND is not None:
settings.DEFAULT_FILE_STORAGE = settings.STORAGE_BACKEND
# django-storages
if settings.STORAGE_BACKEND.startswith("storages."):
try:
import storages.utils
except ModuleNotFoundError as e:
if getattr(e, "name") == "storages":
raise ImproperlyConfigured(
f"STORAGE_BACKEND is set to {settings.STORAGE_BACKEND} but django-storages is not present. It "
f"can be installed by running 'pip install django-storages'."
)
raise e
# Monkey-patch django-storages to fetch settings from STORAGE_CONFIG
def _setting(name, default=None):
if name in settings.STORAGE_CONFIG:
return settings.STORAGE_CONFIG[name]
return globals().get(name, default)
storages.utils.setting = _setting
if settings.STORAGE_CONFIG and settings.STORAGE_BACKEND is None:
warnings.warn(
"STORAGE_CONFIG has been set in settings but STORAGE_BACKEND is not defined. STORAGE_CONFIG will be "
"ignored.")
#
# SSO
#
# If social auth is toggled, inject the appropriate settings
if settings.SOCIAL_AUTH_ENABLED:
settings.INSTALLED_APPS.append("social_django")
settings.AUTHENTICATION_BACKENDS.insert(0, settings.SOCIAL_AUTH_MODULE)
backend_name = get_sso_backend_name(settings.SOCIAL_AUTH_MODULE)
settings.LOGIN_URL = "/{}login/{}/".format(settings.BASE_PATH,
backend_name)
#
# Plugins
#
# Process the plugins and manipulate the specified config settings that are
# passed in.
load_plugins(
settings.PLUGINS,
settings.INSTALLED_APPS,
settings.PLUGINS_CONFIG,
settings.VERSION,
settings.MIDDLEWARE,
settings.CACHEOPS,
)
def _configure_settings(config):
"""
Callback for processing conditional or special purpose settings.
Any specially prepared settings will be handled here, such as loading
plugins, enabling social auth, etc.
This is intended to be called by `run_app` and should not be invoked
directly.
:param config:
A dictionary of `config_path`, `project`, `settings`
Example::
{
'project': 'nautobot',
'config_path': '/path/to/nautobot_config.py',
'settings': <LazySettings "nautobot_config">
}
"""
settings = config["settings"]
# Include the config path to the settings to align with builtin
# `settings.SETTINGS_MODULE`. Useful for debugging correct config path.
settings.SETTINGS_PATH = config["config_path"]
#
# Storage directories
#
if not os.path.exists(settings.GIT_ROOT):
os.makedirs(settings.GIT_ROOT)
if not os.path.exists(settings.JOBS_ROOT):
os.makedirs(settings.JOBS_ROOT)
if not os.path.exists(os.path.join(settings.JOBS_ROOT, "__init__.py")):
Path(os.path.join(settings.JOBS_ROOT, "__init__.py")).touch()
if not os.path.exists(settings.MEDIA_ROOT):
os.makedirs(settings.MEDIA_ROOT)
if not os.path.exists(
os.path.join(settings.MEDIA_ROOT, "devicetype-images")):
os.makedirs(os.path.join(settings.MEDIA_ROOT, "devicetype-images"))
if not os.path.exists(
os.path.join(settings.MEDIA_ROOT, "image-attachments")):
os.makedirs(os.path.join(settings.MEDIA_ROOT, "image-attachments"))
if not os.path.exists(settings.STATIC_ROOT):
os.makedirs(settings.STATIC_ROOT)
#
# Databases
#
# If metrics are enabled and postgres is the backend, set the driver to the
# one provided by django-prometheus.
if settings.METRICS_ENABLED and "postgres" in settings.DATABASES[
"default"]["ENGINE"]:
settings.DATABASES["default"][
"ENGINE"] = "django_prometheus.db.backends.postgresql"
# Create secondary db connection for job logging. This still writes to the default db, but because it's a separate
# connection, it allows allows us to "escape" from transaction.atomic() and ensure that job log entries are saved
# to the database even when the rest of the job transaction is rolled back.
settings.DATABASES["job_logs"] = settings.DATABASES["default"].copy()
# When running unit tests, treat it as a mirror of the default test DB, not a separate test DB of its own
settings.DATABASES["job_logs"]["TEST"] = {"MIRROR": "default"}
#
# Media storage
#
if settings.STORAGE_BACKEND is not None:
settings.DEFAULT_FILE_STORAGE = settings.STORAGE_BACKEND
# django-storages
if settings.STORAGE_BACKEND.startswith("storages."):
try:
import storages.utils
except ModuleNotFoundError as e:
if getattr(e, "name") == "storages":
raise ImproperlyConfigured(
f"STORAGE_BACKEND is set to {settings.STORAGE_BACKEND} but django-storages is not present. It "
f"can be installed by running 'pip install django-storages'."
)
raise e
# Monkey-patch django-storages to fetch settings from STORAGE_CONFIG or fall back to settings
def _setting(name, default=None):
if name in settings.STORAGE_CONFIG:
return settings.STORAGE_CONFIG[name]
return getattr(settings, name, default)
storages.utils.setting = _setting
#
# Plugins
#
# Process the plugins and manipulate the specified config settings that are
# passed in.
load_plugins(settings)