Merge pull request #6188 from edx/jarv/config-refactor-wip

moving defaults for yaml config out of common.py

cms/envs/yaml_config.py

+"""
+This is the default template for our main set of AWS servers.
+
+Before importing this settings file the following MUST be
+defined in the environment:
+
+    * SERVICE_VARIANT - can be either "lms" or "cms"
+    * CONFIG_ROOT - the directory where the application
+                    yaml config files are located
+
+"""
+
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import, undefined-variable, used-before-assignment
+
+import yaml
+
+from .common import *
+from logsettings import get_logger_config
+from util.config_parse import convert_tokens
+import os
+
+from path import path
+from dealer.git import git
+from xmodule.modulestore.modulestore_settings import convert_module_store_setting_if_needed
+
+# https://stackoverflow.com/questions/2890146/how-to-force-pyyaml-to-load-strings-as-unicode-objects
+from yaml import Loader, SafeLoader
+
+
+def construct_yaml_str(self, node):
+    """
+    Override the default string handling function
+    to always return unicode objects
+    """
+    return self.construct_scalar(node)
+Loader.add_constructor(u'tag:yaml.org,2002:str', construct_yaml_str)
+SafeLoader.add_constructor(u'tag:yaml.org,2002:str', construct_yaml_str)
+
+# SERVICE_VARIANT specifies name of the variant used, which decides what YAML
+# configuration files are read during startup.
+SERVICE_VARIANT = os.environ.get('SERVICE_VARIANT', None)
+
+# CONFIG_ROOT specifies the directory where the YAML configuration
+# files are expected to be found. If not specified, use the project
+# directory.
+CONFIG_ROOT = path(os.environ.get('CONFIG_ROOT', ENV_ROOT))
+
+# CONFIG_PREFIX specifies the prefix of the YAML configuration files,
+# based on the service variant. If no variant is use, don't use a
+# prefix.
+CONFIG_PREFIX = SERVICE_VARIANT + "." if SERVICE_VARIANT else ""
+
+##############################################################
+#
+# DEFAULT SETTINGS FOR PRODUCTION
+#
+# These are defaults common for all production deployments
+#
+
+DEBUG = False
+TEMPLATE_DEBUG = False
+
+EMAIL_BACKEND = 'django_ses.SESBackend'
+SESSION_ENGINE = 'django.contrib.sessions.backends.cache'
+DEFAULT_FILE_STORAGE = 'storages.backends.s3boto.S3BotoStorage'
+
+##############################################################
+#
+# DEFAULT SETTINGS FOR CELERY
+#
+
+# Don't use a connection pool, since connections are dropped by ELB.
+BROKER_POOL_LIMIT = 0
+BROKER_CONNECTION_TIMEOUT = 1
+
+# For the Result Store, use the django cache named 'celery'
+CELERY_RESULT_BACKEND = 'cache'
+CELERY_CACHE_BACKEND = 'celery'
+
+# When the broker is behind an ELB, use a heartbeat to refresh the
+# connection and to detect if it has been dropped.
+BROKER_HEARTBEAT = 10.0
+BROKER_HEARTBEAT_CHECKRATE = 2
+
+# Each worker should only fetch one message at a time
+CELERYD_PREFETCH_MULTIPLIER = 1
+
+# Skip djcelery migrations, since we don't use the database as the broker
+SOUTH_MIGRATION_MODULES = {
+    'djcelery': 'ignore',
+}
+
+# Rename the exchange and queues for each variant
+
+QUEUE_VARIANT = CONFIG_PREFIX.lower()
+
+CELERY_DEFAULT_EXCHANGE = 'edx.{0}core'.format(QUEUE_VARIANT)
+
+HIGH_PRIORITY_QUEUE = 'edx.{0}core.high'.format(QUEUE_VARIANT)
+DEFAULT_PRIORITY_QUEUE = 'edx.{0}core.default'.format(QUEUE_VARIANT)
+LOW_PRIORITY_QUEUE = 'edx.{0}core.low'.format(QUEUE_VARIANT)
+
+CELERY_DEFAULT_QUEUE = DEFAULT_PRIORITY_QUEUE
+CELERY_DEFAULT_ROUTING_KEY = DEFAULT_PRIORITY_QUEUE
+
+CELERY_QUEUES = {
+    HIGH_PRIORITY_QUEUE: {},
+    LOW_PRIORITY_QUEUE: {},
+    DEFAULT_PRIORITY_QUEUE: {}
+}
+
+CELERY_ALWAYS_EAGER = False
+GIT_REPO_EXPORT_DIR = '/edx/var/edxapp/export_course_repos'
+SESSION_INACTIVITY_TIMEOUT_IN_SECONDS = None
+EMAIL_FILE_PATH = None
+STATIC_URL_BASE = None
+STATIC_ROOT_BASE = None
+SESSION_COOKIE_NAME = None
+ADDL_INSTALLED_APPS = []
+AUTH_USE_CAS = False
+CAS_ATTRIBUTE_CALLBACK = None
+MICROSITE_ROOT_DIR = ''
+SEGMENT_IO = False
+DATADOG = {}
+ADDL_INSTALLED_APPS = []
+LOCAL_LOGLEVEL = 'INFO'
+##############################################################
+#
+# ENV TOKEN IMPORT
+#
+# Currently non-secure and secure settings are managed
+# in two yaml files. This section imports the non-secure
+# settings and modifies them in code if necessary.
+#
+
+with open(CONFIG_ROOT / CONFIG_PREFIX + "env.yaml") as env_file:
+    ENV_TOKENS = yaml.load(env_file)
+
+ENV_TOKENS = convert_tokens(ENV_TOKENS)
+
+##########################################
+# Merge settings from common.py
+#
+# Before the tokens are imported directly
+# into settings some dictionary settings
+# need to be merged from common.py
+
+ENV_FEATURES = ENV_TOKENS.get('FEATURES', ENV_TOKENS.get('MITX_FEATURES', {}))
+for feature, value in ENV_FEATURES.items():
+    FEATURES[feature] = value
+
+# Delete keys from ENV_TOKENS so that when it's imported
+# into settings it doesn't override what was set above
+if 'FEATURES' in ENV_TOKENS:
+    del ENV_TOKENS['FEATURES']
+
+vars().update(ENV_TOKENS)
+
+##########################################
+# Manipulate imported settings with code
+#
+# For historical reasons some settings need
+# to be modified in code.  For example
+# conversions to other data structures that
+# cannot be represented in YAML.
+
+if STATIC_URL_BASE:
+    # collectstatic will fail if STATIC_URL is a unicode string
+    STATIC_URL = STATIC_URL_BASE.encode('ascii')
+    if not STATIC_URL.endswith("/"):
+        STATIC_URL += "/"
+    STATIC_URL += git.revision + "/"
+
+if STATIC_ROOT_BASE:
+    STATIC_ROOT = path(STATIC_ROOT_BASE) / git.revision
+
+
+# Cache used for location mapping -- called many times with the same key/value
+# in a given request.
+if 'loc_cache' not in CACHES:
+    CACHES['loc_cache'] = {
+        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+        'LOCATION': 'edx_location_mem_cache',
+    }
+
+
+# allow for environments to specify what cookie name our login subsystem should use
+# this is to fix a bug regarding simultaneous logins between edx.org and edge.edx.org which can
+# happen with some browsers (e.g. Firefox)
+if SESSION_COOKIE_NAME:
+    # NOTE, there's a bug in Django (http://bugs.python.org/issue18012) which necessitates this being a str()
+    SESSION_COOKIE_NAME = str(SESSION_COOKIE_NAME)
+
+
+# Additional installed apps
+for app in ADDL_INSTALLED_APPS:
+    INSTALLED_APPS += (app,)
+
+
+LOGGING = get_logger_config(LOG_DIR,
+                            local_loglevel=LOCAL_LOGLEVEL,
+                            logging_env=LOGGING_ENV,
+                            debug=False,
+                            service_variant=SERVICE_VARIANT)
+
+if AUTH_USE_CAS:
+    AUTHENTICATION_BACKENDS = (
+        'django.contrib.auth.backends.ModelBackend',
+        'django_cas.backends.CASBackend',
+    )
+    INSTALLED_APPS += ('django_cas',)
+    MIDDLEWARE_CLASSES += ('django_cas.middleware.CASMiddleware',)
+    if CAS_ATTRIBUTE_CALLBACK:
+        import importlib
+        CAS_USER_DETAILS_RESOLVER = getattr(
+            importlib.import_module(CAS_ATTRIBUTE_CALLBACK['module']),
+            CAS_ATTRIBUTE_CALLBACK['function']
+        )
+
+MICROSITE_ROOT_DIR = path(MICROSITE_ROOT_DIR)
+
+##############################################################
+#
+# AUTH TOKEN IMPORT
+#
+
+with open(CONFIG_ROOT / CONFIG_PREFIX + "auth.yaml") as auth_file:
+    AUTH_TOKENS = yaml.load(auth_file)
+
+AUTH_TOKENS = convert_tokens(AUTH_TOKENS)
+
+vars().update(AUTH_TOKENS)
+
+##########################################
+# Manipulate imported settings with code
+#
+
+if SEGMENT_IO_KEY:
+    FEATURES['SEGMENT_IO'] = SEGMENT_IO
+
+if AWS_ACCESS_KEY_ID == "":
+    AWS_ACCESS_KEY_ID = None
+
+if AWS_SECRET_ACCESS_KEY == "":
+    AWS_SECRET_ACCESS_KEY = None
+
+MODULESTORE = convert_module_store_setting_if_needed(MODULESTORE)
+
+# TODO: deprecated (compatibility with previous settings)
+if 'DATADOG_API' in AUTH_TOKENS:
+    DATADOG['api_key'] = AUTH_TOKENS['DATADOG_API']
+
+BROKER_URL = "{0}://{1}:{2}@{3}/{4}".format(CELERY_BROKER_TRANSPORT,
+                                            CELERY_BROKER_USER,
+                                            CELERY_BROKER_PASSWORD,
+                                            CELERY_BROKER_HOSTNAME,
+                                            CELERY_BROKER_VHOST)

common/djangoapps/util/config_parse.py

+"""
+Helper functions for configuration parsing
+"""
+import collections
+
+
+def convert_tokens(tokens):
+    """
+    This function is called on the token
+    dictionary that is imported from a yaml file.
+    It returns a new dictionary where
+    all strings containing 'None' are converted
+    to a literal None due to a bug in Ansible
+    """
+
+    if tokens == 'None':
+        return None
+    elif isinstance(tokens, basestring) or (not isinstance(tokens, collections.Iterable)):
+        return tokens
+    elif isinstance(tokens, dict):
+        return {
+            convert_tokens(k): convert_tokens(v)
+            for k, v in tokens.items()
+        }
+    else:
+        return [convert_tokens(v) for v in tokens]

lms/envs/yaml_config.py

+"""
+This is the default settings files for all
+production servers.
+
+Before importing this settings file the following MUST be
+defined in the environment:
+
+    * SERVICE_VARIANT - can be either "lms" or "cms"
+    * CONFIG_ROOT - the directory where the application
+                    yaml config files are located
+"""
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import, undefined-variable, used-before-assignment
+
+import yaml
+
+from .common import *
+from logsettings import get_logger_config
+from util.config_parse import convert_tokens
+import os
+
+from path import path
+
+# https://stackoverflow.com/questions/2890146/how-to-force-pyyaml-to-load-strings-as-unicode-objects
+from yaml import Loader, SafeLoader
+
+
+def construct_yaml_str(self, node):
+    """
+    Override the default string handling function
+    to always return unicode objects
+    """
+    return self.construct_scalar(node)
+Loader.add_constructor(u'tag:yaml.org,2002:str', construct_yaml_str)
+SafeLoader.add_constructor(u'tag:yaml.org,2002:str', construct_yaml_str)
+
+# SERVICE_VARIANT specifies name of the variant used, which decides what YAML
+# configuration files are read during startup.
+SERVICE_VARIANT = os.environ.get('SERVICE_VARIANT', None)
+
+# CONFIG_ROOT specifies the directory where the YAML configuration
+# files are expected to be found. If not specified, use the project
+# directory.
+CONFIG_ROOT = path(os.environ.get('CONFIG_ROOT', ENV_ROOT))
+
+# CONFIG_PREFIX specifies the prefix of the YAML configuration files,
+# based on the service variant. If no variant is use, don't use a
+# prefix.
+CONFIG_PREFIX = SERVICE_VARIANT + "." if SERVICE_VARIANT else ""
+
+
+##############################################################
+#
+# DEFAULT SETTINGS FOR PRODUCTION
+#
+# These are defaults common for all production deployments
+#
+
+DEBUG = False
+TEMPLATE_DEBUG = False
+
+EMAIL_BACKEND = 'django_ses.SESBackend'
+SESSION_ENGINE = 'django.contrib.sessions.backends.cache'
+DEFAULT_FILE_STORAGE = 'storages.backends.s3boto.S3BotoStorage'
+
+# IMPORTANT: With this enabled, the server must always be behind a proxy that
+# strips the header HTTP_X_FORWARDED_PROTO from client requests. Otherwise,
+# a user can fool our server into thinking it was an https connection.
+# See
+# https://docs.djangoproject.com/en/dev/ref/settings/#secure-proxy-ssl-header
+# for other warnings.
+SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
+
+SESSION_COOKIE_NAME = None
+GIT_REPO_DIR = '/edx/var/edxapp/course_repos'
+MICROSITE_ROOT_DIR = ''
+CAS_SERVER_URL = None
+CAS_ATTRIBUTE_CALLBACK = None
+
+##### Defaults for OAUTH2 Provider ##############
+OAUTH_OIDC_ISSUER = None
+OAUTH_ENFORCE_SECURE = True
+OAUTH_ENFORCE_CLIENT_SECURE = True
+
+#### Course Registration Code length ####
+REGISTRATION_CODE_LENGTH = 8
+
+# SSL external authentication settings
+SSL_AUTH_EMAIL_DOMAIN = "MIT.EDU"
+SSL_AUTH_DN_FORMAT_STRING = "/C=US/ST=Massachusetts/O=Massachusetts Institute of Technology/OU=Client CA v1/CN={0}/emailAddress={1}"
+
+GIT_IMPORT_STATIC = True
+META_UNIVERSITIES = {}
+DATADOG = {}
+EMAIL_FILE_PATH = None
+SEGMENT_IO_LMS = False
+
+MONGODB_LOG = {}
+SESSION_INACTIVITY_TIMEOUT_IN_SECONDS = None
+ADDL_INSTALLED_APPS = []
+LOCAL_LOGLEVEL = 'INFO'
+
+##############################################################
+#
+# DEFAULT SETTINGS FOR CELERY
+#
+
+
+# Don't use a connection pool, since connections are dropped by ELB.
+BROKER_POOL_LIMIT = 0
+BROKER_CONNECTION_TIMEOUT = 1
+
+# For the Result Store, use the django cache named 'celery'
+CELERY_RESULT_BACKEND = 'cache'
+CELERY_CACHE_BACKEND = 'celery'
+
+# When the broker is behind an ELB, use a heartbeat to refresh the
+# connection and to detect if it has been dropped.
+BROKER_HEARTBEAT = 10.0
+BROKER_HEARTBEAT_CHECKRATE = 2
+
+# Each worker should only fetch one message at a time
+CELERYD_PREFETCH_MULTIPLIER = 1
+
+# Skip djcelery migrations, since we don't use the database as the broker
+SOUTH_MIGRATION_MODULES = {
+    'djcelery': 'ignore',
+}
+
+# Rename the exchange and queues for each variant
+
+QUEUE_VARIANT = CONFIG_PREFIX.lower()
+
+CELERY_DEFAULT_EXCHANGE = 'edx.{0}core'.format(QUEUE_VARIANT)
+
+HIGH_PRIORITY_QUEUE = 'edx.{0}core.high'.format(QUEUE_VARIANT)
+DEFAULT_PRIORITY_QUEUE = 'edx.{0}core.default'.format(QUEUE_VARIANT)
+LOW_PRIORITY_QUEUE = 'edx.{0}core.low'.format(QUEUE_VARIANT)
+HIGH_MEM_QUEUE = 'edx.{0}core.high_mem'.format(QUEUE_VARIANT)
+
+CELERY_DEFAULT_QUEUE = DEFAULT_PRIORITY_QUEUE
+CELERY_DEFAULT_ROUTING_KEY = DEFAULT_PRIORITY_QUEUE
+
+CELERY_QUEUES = {
+    HIGH_PRIORITY_QUEUE: {},
+    LOW_PRIORITY_QUEUE: {},
+    DEFAULT_PRIORITY_QUEUE: {},
+    HIGH_MEM_QUEUE: {},
+}
+
+# If we're a worker on the high_mem queue, set ourselves to die after processing
+# one request to avoid having memory leaks take down the worker server. This env
+# var is set in /etc/init/edx-workers.conf -- this should probably be replaced
+# with some celery API call to see what queue we started listening to, but I
+# don't know what that call is or if it's active at this point in the code.
+if os.environ.get('QUEUE') == 'high_mem':
+    CELERYD_MAX_TASKS_PER_CHILD = 1
+
+
+##############################################################
+#
+# ENV TOKEN IMPORT
+#
+# Currently non-secure and secure settings are managed
+# in two yaml files. This section imports the non-secure
+# settings and modifies them in code if necessary.
+#
+
+with open(CONFIG_ROOT / CONFIG_PREFIX + "env.yaml") as env_file:
+    ENV_TOKENS = yaml.load(env_file)
+
+# Works around an Ansible bug
+ENV_TOKENS = convert_tokens(ENV_TOKENS)
+
+##########################################
+# Merge settings from common.py
+#
+# Before the tokens are imported directly
+# into settings some dictionary settings
+# need to be merged from common.py
+
+ENV_FEATURES = ENV_TOKENS.get('FEATURES', ENV_TOKENS.get('MITX_FEATURES', {}))
+for feature, value in ENV_FEATURES.items():
+    FEATURES[feature] = value
+
+MKTG_URL_LINK_MAP.update(ENV_TOKENS.get('MKTG_URL_LINK_MAP', {}))
+
+# Delete keys from ENV_TOKENS so that when it's imported
+# into settings it doesn't override what was set above
+if 'FEATURES' in ENV_TOKENS:
+    del ENV_TOKENS['FEATURES']
+
+if 'MKTG_URL_LINK_MAP' in ENV_TOKENS:
+    del ENV_TOKENS['MKTG_URL_LINK_MAP']
+
+# Update the token dictionary directly into settings
+vars().update(ENV_TOKENS)
+
+##########################################
+# Manipulate imported settings with code
+#
+# For historical reasons some settings need
+# to be modified in code.  For example
+# conversions to other data structures that
+# cannot be represented in YAML.
+
+
+if SESSION_COOKIE_NAME:
+    # NOTE, there's a bug in Django (http://bugs.python.org/issue18012) which necessitates this being a str()
+    SESSION_COOKIE_NAME = str(SESSION_COOKIE_NAME)
+
+MICROSITE_ROOT_DIR = path(MICROSITE_ROOT_DIR)
+
+# Cache used for location mapping -- called many times with the same key/value
+# in a given request.
+if 'loc_cache' not in CACHES:
+    CACHES['loc_cache'] = {
+        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+        'LOCATION': 'edx_location_mem_cache',
+    }
+
+# We want Bulk Email running on the high-priority queue, so we define the
+# routing key that points to it.  At the moment, the name is the same.
+# We have to reset the value here, since we have changed the value of the queue name.
+BULK_EMAIL_ROUTING_KEY = HIGH_PRIORITY_QUEUE
+
+LANGUAGE_DICT = dict(LANGUAGES)
+
+# Additional installed apps
+for app in ADDL_INSTALLED_APPS:
+    INSTALLED_APPS += (app,)
+
+LOGGING = get_logger_config(LOG_DIR,
+                            logging_env=LOGGING_ENV,
+                            local_loglevel=LOCAL_LOGLEVEL,
+                            debug=False,
+                            service_variant=SERVICE_VARIANT)
+
+for name, value in ENV_TOKENS.get("CODE_JAIL", {}).items():
+    oldvalue = CODE_JAIL.get(name)
+    if isinstance(oldvalue, dict):
+        for subname, subvalue in value.items():
+            oldvalue[subname] = subvalue
+    else:
+        CODE_JAIL[name] = value
+
+
+if FEATURES.get('AUTH_USE_CAS'):
+    AUTHENTICATION_BACKENDS = (
+        'django.contrib.auth.backends.ModelBackend',
+        'django_cas.backends.CASBackend',
+    )
+    INSTALLED_APPS += ('django_cas',)
+    MIDDLEWARE_CLASSES += ('django_cas.middleware.CASMiddleware',)
+    if CAS_ATTRIBUTE_CALLBACK:
+        import importlib
+        CAS_USER_DETAILS_RESOLVER = getattr(
+            importlib.import_module(CAS_ATTRIBUTE_CALLBACK['module']),
+            CAS_ATTRIBUTE_CALLBACK['function']
+        )
+
+
+STATIC_ROOT = path(STATIC_ROOT_BASE)
+
+##############################################################
+#
+# AUTH TOKEN IMPORT
+#
+
+with open(CONFIG_ROOT / CONFIG_PREFIX + "auth.yaml") as auth_file:
+    AUTH_TOKENS = yaml.load(auth_file)
+
+# Works around an Ansible bug
+AUTH_TOKENS = convert_tokens(AUTH_TOKENS)
+
+vars().update(AUTH_TOKENS)
+
+##########################################
+# Manipulate imported settings with code
+#
+
+FEATURES['SEGMENT_IO_LMS'] = SEGMENT_IO_LMS
+
+if AWS_ACCESS_KEY_ID == "":
+    AWS_ACCESS_KEY_ID = None
+
+if AWS_SECRET_ACCESS_KEY == "":
+    AWS_SECRET_ACCESS_KEY = None
+
+# TODO: deprecated (compatibility with previous settings)
+if 'DATADOG_API' in AUTH_TOKENS:
+    DATADOG['api_key'] = AUTH_TOKENS['DATADOG_API']
+
+BROKER_URL = "{0}://{1}:{2}@{3}/{4}".format(CELERY_BROKER_TRANSPORT,
+                                            CELERY_BROKER_USER,
+                                            CELERY_BROKER_PASSWORD,
+                                            CELERY_BROKER_HOSTNAME,
+                                            CELERY_BROKER_VHOST)
+
+# Grades download
+GRADES_DOWNLOAD_ROUTING_KEY = HIGH_MEM_QUEUE