Allow configuration of settings via config files.

Change-Id: I3ac35ef56453f5cc7ab0fd3ffc0816a9e89b7b55
This commit is contained in:
Florian Apolloner 2018-10-22 18:44:56 +02:00
parent 7c01333156
commit 05915224d7
9 changed files with 140 additions and 143 deletions

View File

@ -0,0 +1,3 @@
[ara]
debug = true
secret_key = dev

View File

@ -0,0 +1,5 @@
[ara]
debug = true
log_level = DEBUG
secret_key = integration
allowed_hosts = testserver

View File

@ -0,0 +1,2 @@
[ara]
secret_key = test

View File

@ -1,102 +1,83 @@
import logging
import os
import sys
from django.conf import global_settings
from django.utils.crypto import get_random_string
from envparse import env
from .utils import EverettEnviron
env = EverettEnviron(DEBUG=(bool, False))
BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
SECRET_KEY = env("SECRET_KEY")
def get_secret_key(secret_key):
if not secret_key:
return get_random_string(length=50)
return secret_key
DEBUG = env.bool("DEBUG", default=False)
SECRET_KEY = env('SECRET_KEY', preprocessor=get_secret_key, default=None)
DEBUG = env.bool('DJANGO_DEBUG', default=False)
ALLOWED_HOSTS = env('ALLOWED_HOSTS', cast=list, default=['localhost', '127.0.0.1', 'testserver'])
ALLOWED_HOSTS = env("ALLOWED_HOSTS", cast=list, default=[])
ADMINS = ()
INSTALLED_APPS = [
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'corsheaders',
'rest_framework',
'django_filters',
'ara.api',
'ara.server.apps.AraAdminConfig',
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.messages",
"django.contrib.staticfiles",
"corsheaders",
"rest_framework",
"django_filters",
"ara.api",
"ara.server.apps.AraAdminConfig",
]
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'corsheaders.middleware.CorsMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
"django.middleware.security.SecurityMiddleware",
"django.contrib.sessions.middleware.SessionMiddleware",
"corsheaders.middleware.CorsMiddleware",
"django.middleware.common.CommonMiddleware",
"django.middleware.csrf.CsrfViewMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.contrib.messages.middleware.MessageMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
]
# TODO: Only needed in dev?
CORS_ORIGIN_ALLOW_ALL = True
# Django built-in server and npm development server
CORS_ORIGIN_WHITELIST = (
'127.0.0.1:8000',
'localhost:3000',
)
CORS_ORIGIN_WHITELIST = ("127.0.0.1:8000", "localhost:3000")
ROOT_URLCONF = 'ara.server.urls'
ROOT_URLCONF = "ara.server.urls"
APPEND_SLASH = False
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
"BACKEND": "django.template.backends.django.DjangoTemplates",
"DIRS": [],
"APP_DIRS": True,
"OPTIONS": {
"context_processors": [
"django.template.context_processors.debug",
"django.template.context_processors.request",
"django.contrib.auth.context_processors.auth",
"django.contrib.messages.context_processors.messages",
]
},
},
}
]
WSGI_APPLICATION = 'ara.server.wsgi.application'
WSGI_APPLICATION = "ara.server.wsgi.application"
DATABASES = {
'default': {
'ENGINE': env('DATABASE_ENGINE', default='django.db.backends.sqlite3'),
'NAME': env('DATABASE_NAME', default=os.path.join(BASE_DIR, 'db.sqlite3')),
'USER': env('DATABASE_USER', default=None),
'PASSWORD': env('DATABASE_PASSWORD', default=None),
'HOST': env('DATABASE_HOST', default=None),
'PORT': env('DATABASE_PORT', default=None),
}
}
DATABASES = {"default": env.db(default="sqlite:///%s" % os.path.join(BASE_DIR, "db.sqlite3"))}
AUTH_PASSWORD_VALIDATORS = [
{'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', },
{'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', },
{'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', },
{'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', },
{"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"},
{"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
{"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
{"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
]
LANGUAGE_CODE = 'en-us'
LANGUAGE_CODE = "en-us"
TIME_ZONE = 'UTC'
TIME_ZONE = "UTC"
USE_I18N = True
@ -104,90 +85,53 @@ USE_L10N = True
USE_TZ = True
STATIC_URL = '/static/'
STATIC_URL = "/static/"
STATIC_ROOT = os.path.join(BASE_DIR, 'www', 'static')
STATIC_ROOT = os.path.join(BASE_DIR, "www", "static")
MEDIA_URL = '/media/'
MEDIA_URL = "/media/"
MEDIA_ROOT = os.path.join(BASE_DIR, 'www', 'media')
MEDIA_ROOT = os.path.join(BASE_DIR, "www", "media")
# fmt: off
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'normal': {
'format': '%(asctime)s %(levelname)s %(name)s: %(message)s'
"version": 1,
"disable_existing_loggers": False,
"formatters": {"normal": {"format": "%(asctime)s %(levelname)s %(name)s: %(message)s"}},
"handlers": {
"console": {
"class": "logging.StreamHandler",
"formatter": "normal",
"level": env("LOG_LEVEL", default="INFO"),
"stream": sys.stdout,
}
},
'handlers': {
'console': {
'class': 'logging.StreamHandler',
'formatter': 'normal',
'level': env('DJANGO_LOG_LEVEL', default='INFO'),
'stream': sys.stdout
"loggers": {
"ara": {
"handlers": ["console"],
"level": env("LOG_LEVEL", default="INFO"),
"propagate": 0
}
},
'loggers': {
'ara': {
'handlers': ['console'],
'level': env('DJANGO_LOG_LEVEL', default='INFO'),
'propagate': 0
}
"root": {
"handlers": ["console"],
"level": env("LOG_LEVEL", default="DEBUG")
},
'root': {
'handlers': ['console'],
'level': env('DJANGO_LOG_LEVEL', default='DEBUG'),
}
}
# fmt: on
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
'PAGE_SIZE': 1000,
'DEFAULT_FILTER_BACKENDS': (
'django_filters.rest_framework.DjangoFilterBackend',
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
"PAGE_SIZE": 1000,
"DEFAULT_FILTER_BACKENDS": ("django_filters.rest_framework.DjangoFilterBackend",),
"DEFAULT_RENDERER_CLASSES": (
"rest_framework.renderers.JSONRenderer",
"rest_framework.renderers.BrowsableAPIRenderer",
),
'DEFAULT_RENDERER_CLASSES': (
'rest_framework.renderers.JSONRenderer',
'rest_framework.renderers.BrowsableAPIRenderer',
"DEFAULT_PARSER_CLASSES": (
"rest_framework.parsers.JSONParser",
"rest_framework.parsers.FormParser",
"rest_framework.parsers.MultiPartParser",
),
'DEFAULT_PARSER_CLASSES': (
'rest_framework.parsers.JSONParser',
'rest_framework.parsers.FormParser',
'rest_framework.parsers.MultiPartParser',
),
'TEST_REQUEST_DEFAULT_FORMAT': 'json'
"TEST_REQUEST_DEFAULT_FORMAT": "json",
}
class DisableMigrations(object):
def __contains__(self, item):
return True
def __getitem__(self, item):
return None
TESTS_IN_PROGRESS = False
if 'test' in sys.argv[1:] or 'jenkins' in sys.argv[1:]:
logging.disable(logging.CRITICAL)
PASSWORD_HASHERS = (
'django.contrib.auth.hashers.MD5PasswordHasher',
)
DEBUG = False
TEMPLATE_DEBUG = False
TESTS_IN_PROGRESS = True
MIGRATION_MODULES = DisableMigrations()
if DEBUG:
EMAIL_BACKEND = os.getenv('EMAIL_BACKEND', 'django.core.mail.backends.console.EmailBackend')
else:
EMAIL_BACKEND = os.getenv('EMAIL_BACKEND', 'django.core.mail.backends.smtp.EmailBackend')
DEFAULT_FROM_EMAIL = os.getenv('DEFAULT_FROM_EMAIL', global_settings.DEFAULT_FROM_EMAIL)
EMAIL_HOST = os.getenv('EMAIL_HOST', 'localhost')
EMAIL_HOST_USER = os.getenv('EMAIL_HOST_USER', '')
EMAIL_HOST_PASSWORD = os.getenv('EMAIL_HOST_PASSWORD', '')
EMAIL_PORT = env.int('EMAIL_PORT', default=25)
EMAIL_SUBJECT_PREFIX = os.getenv('EMAIL_SUBJECT_PREFIX', '[Ara] ')
EMAIL_USE_TLS = env.bool('EMAIL_USE_TLS', default=False)
EMAIL_USE_SSL = env.bool('EMAIL_USE_SSL', default=False)

40
ara/server/utils.py Normal file
View File

@ -0,0 +1,40 @@
import os
import environ
from everett import ConfigurationError
from everett.manager import ConfigEnvFileEnv, ConfigIniEnv, ConfigManager, ConfigOSEnv
__all__ = ["EverettEnviron"]
class EnvironProxy:
def __init__(self, cfg):
self.cfg = cfg
def __contains__(self, key):
try:
self.cfg(key)
except ConfigurationError:
return False
return True
def __getitem__(self, key):
try:
return self.cfg(key)
except ConfigurationError as err:
raise KeyError("Missing key %r" % key) from err
class EverettEnviron(environ.Env):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.ENVIRON = EnvironProxy(
ConfigManager(
[
ConfigOSEnv(),
ConfigEnvFileEnv(".env"),
ConfigIniEnv([os.environ.get("ARA_CFG"), "~/.config/ara/server.cfg", "/etc/ara/server.cfg"]),
]
).with_namespace("ara")
)

View File

@ -3,6 +3,9 @@ import os
import sys
if __name__ == "__main__":
from ara import server
os.environ.setdefault("ARA_CFG", os.path.dirname(server.__file__) + "/configs/dev.cfg")
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ara.server.settings")
from django.core.management import execute_from_command_line

View File

@ -1,3 +1,3 @@
[tool.black]
line-length = 120
exclude = '(migrations|ara/server/settings.py)'
exclude = 'migrations'

View File

@ -4,5 +4,6 @@ Django>=2
djangorestframework
django-cors-headers
drf-extensions
envparse
django-filter
django-filter
django-environ
everett

View File

@ -22,14 +22,14 @@ commands = {toxinidir}/tests/linters.sh
[testenv:py3]
commands = python manage.py test ara
setenv =
ARA_CFG={toxinidir}/ara/server/configs/test.cfg
[testenv:runserver]
commands =
python manage.py migrate
python manage.py collectstatic --clear --no-input
python manage.py runserver
setenv =
DJANGO_DEBUG=1
# Temporary venv to help bootstrap integration
[testenv:ansible-integration]
@ -41,8 +41,7 @@ commands =
bash -c 'ANSIBLE_CALLBACK_PLUGINS=$(python -c "import os,ara.plugins; print(os.path.dirname(ara.plugins.__file__))")/callback ansible-playbook {toxinidir}/hacking/test-playbook.yml'
python {toxinidir}/hacking/validate.py
setenv =
DJANGO_DEBUG=1
DJANGO_LOG_LEVEL=DEBUG
ARA_CFG={toxinidir}/ara/server/configs/integration.cfg
whitelist_externals =
rm
bash