Merge pull request #16412 from edx/pwnage101/settings_validation_refactor_PLAT-1776
move settings validation out of startup.py
This commit is contained in:
Troy Sankey
14
openedx/core/djangoapps/common_initialization/apps.py
Normal file
14
openedx/core/djangoapps/common_initialization/apps.py
Normal file
@@ -0,0 +1,14 @@
|
||||
"""
|
||||
Common initialization app for the LMS and CMS
|
||||
"""
|
||||
|
||||
from django.apps import AppConfig
|
||||
|
||||
|
||||
class CommonInitializationConfig(AppConfig):
|
||||
name = 'openedx.core.djangoapps.common_initialization'
|
||||
verbose_name = 'Common Initialization'
|
||||
|
||||
def ready(self):
|
||||
# Common settings validations for the LMS and CMS.
|
||||
from . import checks
|
||||
49
openedx/core/djangoapps/common_initialization/checks.py
Normal file
49
openedx/core/djangoapps/common_initialization/checks.py
Normal file
@@ -0,0 +1,49 @@
|
||||
"""
|
||||
Common settings validations for the LMS and CMS.
|
||||
|
||||
Only populate this module with general settings validators which do not fit in
|
||||
other, more specific djangoapps. Usually, settings which are widely used
|
||||
across the entire LMS or CMS can be validated here.
|
||||
"""
|
||||
from django.conf import settings
|
||||
from django.core.checks import Error, Tags, register
|
||||
|
||||
|
||||
@register(Tags.compatibility)
|
||||
def validate_lms_root_url_setting(app_configs, **kwargs):
|
||||
"""
|
||||
Validates the LMS_ROOT_URL setting.
|
||||
"""
|
||||
errors = []
|
||||
if not getattr(settings, 'LMS_ROOT_URL', None):
|
||||
errors.append(
|
||||
Error(
|
||||
'LMS_ROOT_URL is not defined.',
|
||||
id='common.djangoapps.common_initialization.E001',
|
||||
)
|
||||
)
|
||||
return errors
|
||||
|
||||
|
||||
@register(Tags.compatibility)
|
||||
def validate_marketing_site_setting(app_configs, **kwargs):
|
||||
"""
|
||||
Validates marketing site related settings.
|
||||
"""
|
||||
errors = []
|
||||
if settings.FEATURES.get('ENABLE_MKTG_SITE'):
|
||||
if not hasattr(settings, 'MKTG_URLS'):
|
||||
errors.append(
|
||||
Error(
|
||||
'ENABLE_MKTG_SITE is True, but MKTG_URLS is not defined.',
|
||||
id='common.djangoapps.common_initialization.E002',
|
||||
)
|
||||
)
|
||||
if not settings.MKTG_URLS.get('ROOT'):
|
||||
errors.append(
|
||||
Error(
|
||||
'There is no ROOT defined in MKTG_URLS.',
|
||||
id='common.djangoapps.common_initialization.E003',
|
||||
)
|
||||
)
|
||||
return errors
|
||||
@@ -1,83 +1,11 @@
|
||||
|
||||
import os
|
||||
import six
|
||||
from django.apps import AppConfig
|
||||
from django.conf import settings
|
||||
from django.core.checks import Error, Tags, register
|
||||
|
||||
|
||||
class ThemingConfig(AppConfig):
|
||||
name = 'openedx.core.djangoapps.theming'
|
||||
verbose_name = "Theming"
|
||||
|
||||
|
||||
@register(Tags.compatibility)
|
||||
def check_comprehensive_theme_settings(app_configs, **kwargs):
|
||||
"""
|
||||
Checks the comprehensive theming theme directory settings.
|
||||
|
||||
Raises compatibility Errors upon:
|
||||
- COMPREHENSIVE_THEME_DIRS is not a list
|
||||
- theme dir path is not a string
|
||||
- theme dir path is not an absolute path
|
||||
- path specified in COMPREHENSIVE_THEME_DIRS does not exist
|
||||
|
||||
Returns:
|
||||
List of any Errors.
|
||||
"""
|
||||
if not getattr(settings, "ENABLE_COMPREHENSIVE_THEMING"):
|
||||
# Only perform checks when comprehensive theming is enabled.
|
||||
return []
|
||||
|
||||
errors = []
|
||||
|
||||
# COMPREHENSIVE_THEME_DIR is no longer supported - support has been removed.
|
||||
if hasattr(settings, "COMPREHENSIVE_THEME_DIR"):
|
||||
theme_dir = settings.COMPREHENSIVE_THEME_DIR
|
||||
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIR setting has been removed in favor of COMPREHENSIVE_THEME_DIRS.",
|
||||
hint='Transfer the COMPREHENSIVE_THEME_DIR value to COMPREHENSIVE_THEME_DIRS.',
|
||||
obj=theme_dir,
|
||||
id='openedx.core.djangoapps.theming.E001',
|
||||
)
|
||||
)
|
||||
|
||||
if hasattr(settings, "COMPREHENSIVE_THEME_DIRS"):
|
||||
theme_dirs = settings.COMPREHENSIVE_THEME_DIRS
|
||||
|
||||
if not isinstance(theme_dirs, list):
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIRS must be a list.",
|
||||
obj=theme_dirs,
|
||||
id='openedx.core.djangoapps.theming.E004',
|
||||
)
|
||||
)
|
||||
if not all([isinstance(theme_dir, six.string_types) for theme_dir in theme_dirs]):
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIRS must contain only strings.",
|
||||
obj=theme_dirs,
|
||||
id='openedx.core.djangoapps.theming.E005',
|
||||
)
|
||||
)
|
||||
if not all([theme_dir.startswith("/") for theme_dir in theme_dirs]):
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIRS must contain only absolute paths to themes dirs.",
|
||||
obj=theme_dirs,
|
||||
id='openedx.core.djangoapps.theming.E006',
|
||||
)
|
||||
)
|
||||
if not all([os.path.isdir(theme_dir) for theme_dir in theme_dirs]):
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIRS must contain valid paths.",
|
||||
obj=theme_dirs,
|
||||
id='openedx.core.djangoapps.theming.E007',
|
||||
)
|
||||
)
|
||||
|
||||
return errors
|
||||
def ready(self):
|
||||
# settings validations related to theming.
|
||||
from . import checks
|
||||
|
||||
79
openedx/core/djangoapps/theming/checks.py
Normal file
79
openedx/core/djangoapps/theming/checks.py
Normal file
@@ -0,0 +1,79 @@
|
||||
"""
|
||||
Settings validations for the theming app
|
||||
"""
|
||||
import os
|
||||
import six
|
||||
from django.conf import settings
|
||||
from django.core.checks import Error, Tags, register
|
||||
|
||||
|
||||
@register(Tags.compatibility)
|
||||
def check_comprehensive_theme_settings(app_configs, **kwargs):
|
||||
"""
|
||||
Checks the comprehensive theming theme directory settings.
|
||||
|
||||
Raises compatibility Errors upon:
|
||||
- COMPREHENSIVE_THEME_DIRS is not a list
|
||||
- theme dir path is not a string
|
||||
- theme dir path is not an absolute path
|
||||
- path specified in COMPREHENSIVE_THEME_DIRS does not exist
|
||||
|
||||
Returns:
|
||||
List of any Errors.
|
||||
"""
|
||||
if not getattr(settings, "ENABLE_COMPREHENSIVE_THEMING"):
|
||||
# Only perform checks when comprehensive theming is enabled.
|
||||
return []
|
||||
|
||||
errors = []
|
||||
|
||||
# COMPREHENSIVE_THEME_DIR is no longer supported - support has been removed.
|
||||
if hasattr(settings, "COMPREHENSIVE_THEME_DIR"):
|
||||
theme_dir = settings.COMPREHENSIVE_THEME_DIR
|
||||
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIR setting has been removed in favor of COMPREHENSIVE_THEME_DIRS.",
|
||||
hint='Transfer the COMPREHENSIVE_THEME_DIR value to COMPREHENSIVE_THEME_DIRS.',
|
||||
obj=theme_dir,
|
||||
id='openedx.core.djangoapps.theming.E001',
|
||||
)
|
||||
)
|
||||
|
||||
if hasattr(settings, "COMPREHENSIVE_THEME_DIRS"):
|
||||
theme_dirs = settings.COMPREHENSIVE_THEME_DIRS
|
||||
|
||||
if not isinstance(theme_dirs, list):
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIRS must be a list.",
|
||||
obj=theme_dirs,
|
||||
id='openedx.core.djangoapps.theming.E004',
|
||||
)
|
||||
)
|
||||
if not all([isinstance(theme_dir, six.string_types) for theme_dir in theme_dirs]):
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIRS must contain only strings.",
|
||||
obj=theme_dirs,
|
||||
id='openedx.core.djangoapps.theming.E005',
|
||||
)
|
||||
)
|
||||
if not all([theme_dir.startswith("/") for theme_dir in theme_dirs]):
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIRS must contain only absolute paths to themes dirs.",
|
||||
obj=theme_dirs,
|
||||
id='openedx.core.djangoapps.theming.E006',
|
||||
)
|
||||
)
|
||||
if not all([os.path.isdir(theme_dir) for theme_dir in theme_dirs]):
|
||||
errors.append(
|
||||
Error(
|
||||
"COMPREHENSIVE_THEME_DIRS must contain valid paths.",
|
||||
obj=theme_dirs,
|
||||
id='openedx.core.djangoapps.theming.E007',
|
||||
)
|
||||
)
|
||||
|
||||
return errors
|
||||
Reference in New Issue
Block a user