mirror of
https://github.com/ZwareBear/awx.git
synced 2026-05-05 07:51:51 -05:00
6ebe45b1bd
* Add separate Django app for configuration: awx.conf. * Migrate from existing main.TowerSettings model to conf.Setting. * Add settings wrapper to allow get/set/del via django.conf.settings. * Update existing references to tower_settings to use django.conf.settings. * Add a settings registry to allow for each Django app to register configurable settings. * Support setting validation and conversion using Django REST Framework fields. * Add /api/v1/settings/ to display a list of setting categories. * Add /api/v1/settings/<slug>/ to display all settings in a category as a single object. * Allow PUT/PATCH to update setting singleton, DELETE to reset to defaults. * Add "all" category to display all settings across categories. * Add "changed" category to display only settings configured in the database. * Support per-user settings via "user" category (/api/v1/settings/user/). * Support defaults for user settings via "user-defaults" category (/api/v1/settings/user-defaults/). * Update serializer metadata to support category, category_slug and placeholder on OPTIONS responses. * Update serializer metadata to handle child fields of a list/dict. * Hide raw data form in browsable API for OPTIONS and DELETE. * Combine existing licensing code into single "TaskEnhancer" class. * Move license helper functions from awx.api.license into awx.conf.license. * Update /api/v1/config/ to read/verify/update license using TaskEnhancer and settings wrapper. * Add support for caching settings accessed via settings wrapper. * Invalidate cached settings when Setting model changes or is deleted. * Preload all database settings into cache on first access via settings wrapper. * Add support for read-only settings than can update their value depending on other settings. * Use setting_changed signal whenever a setting changes. * Register configurable authentication, jobs, system and ui settings. * Register configurable LDAP, RADIUS and social auth settings. * Add custom fields and validators for URL, LDAP, RADIUS and social auth settings. * Rewrite existing validator for Credential ssh_private_key to support validating private keys, certs or combinations of both. * Get all unit/functional tests working with above changes. * Add "migrate_to_database_settings" command to determine settings to be migrated into the database and comment them out when set in Python settings files. * Add support for migrating license key from file to database. * Remove database-configuable settings from local_settings.py example files. * Update setup role to no longer install files for database-configurable settings. f 94ff6ee More settings work. f af4c4e0 Even more db settings stuff. f 96ea9c0 More settings, attempt at singleton serializer for settings. f 937c760 More work on singleton/category views in API, add code to comment out settings in Python files, work on command to migrate settings to database. f 425b0d3 Minor fixes for sprint demo. f ea402a4 Add support for read-only settings, cleanup license engine, get license support working with DB settings. f ec289e4 Rename migration, minor fixmes, update setup role. f 603640b Rewrite key/cert validator, finish adding social auth fields, hook up signals for setting_changed, use None to imply a setting is not set. f 67d1b5a Get functional/unit tests passing. f 2919b62 Flake8 fixes. f e62f421 Add redbaron to requirements, get file to database migration working (except for license). f c564508 Add support for migrating license file. f 982f767 Add support for regex in social map fields.
70 lines
2.1 KiB
Python
70 lines
2.1 KiB
Python
# Python
|
|
import logging
|
|
|
|
# Django
|
|
from django.conf import settings
|
|
from django.core.cache import cache
|
|
from django.core.signals import setting_changed
|
|
from django.db.models.signals import post_save, pre_delete, post_delete
|
|
from django.dispatch import receiver
|
|
|
|
# Tower
|
|
import awx.main.signals
|
|
from awx.conf import settings_registry
|
|
from awx.conf.models import Setting
|
|
from awx.conf.serializers import SettingSerializer
|
|
|
|
logger = logging.getLogger('awx.conf.signals')
|
|
|
|
awx.main.signals.model_serializer_mapping[Setting] = SettingSerializer
|
|
|
|
__all__ = []
|
|
|
|
|
|
def handle_setting_change(key, for_delete=False):
|
|
# When a setting changes or is deleted, remove its value from cache along
|
|
# with any other settings that depend on it.
|
|
setting_keys = [key]
|
|
for dependent_key in settings_registry.get_dependent_settings(key):
|
|
# Note: Doesn't handle multiple levels of dependencies!
|
|
setting_keys.append(dependent_key)
|
|
cache_keys = set([Setting.get_cache_key(k) for k in setting_keys])
|
|
logger.debug('cache delete_many(%r)', cache_keys)
|
|
cache.delete_many(cache_keys)
|
|
|
|
# Send setting_changed signal with new value for each setting.
|
|
for setting_key in setting_keys:
|
|
setting_changed.send(
|
|
sender=Setting,
|
|
setting=setting_key,
|
|
value=getattr(settings, setting_key, None),
|
|
enter=not bool(for_delete),
|
|
)
|
|
|
|
|
|
@receiver(post_save, sender=Setting)
|
|
def on_post_save_setting(sender, **kwargs):
|
|
instance = kwargs['instance']
|
|
# Skip for user-specific settings.
|
|
if instance.user:
|
|
return
|
|
handle_setting_change(instance.key)
|
|
|
|
|
|
@receiver(pre_delete, sender=Setting)
|
|
def on_pre_delete_setting(sender, **kwargs):
|
|
instance = kwargs['instance']
|
|
# Skip for user-specific settings.
|
|
if instance.user:
|
|
return
|
|
# Save instance key (setting name) for post_delete.
|
|
instance._saved_key_ = instance.key
|
|
|
|
|
|
@receiver(post_delete, sender=Setting)
|
|
def on_post_delete_setting(sender, **kwargs):
|
|
instance = kwargs['instance']
|
|
key = getattr(instance, '_saved_key_', None)
|
|
if key:
|
|
handle_setting_change(key, True)
|