refactor and cleanup code

Author: zkayyali812

ansible_base/lib/dynamic_config/feature_flags/platform_flags.py renamed to ansible_base/feature_flags/feature_flags.py

@@ -3,7 +3,7 @@
 
 
 class DatabaseCondition(Condition):
-    """Condition that includes the FlagState database object"""
+    """Condition that includes the AAPFlags database object"""
 
     def __init__(self, condition, value, required=False, obj=None):
         super().__init__(condition, value, required=required)
@@ -13,8 +13,8 @@ def __init__(self, condition, value, required=False, obj=None):
 class AAPFlagSource(object):
 
     def get_queryset(self):
-        FlagState = apps.get_model('dab_feature_flags', 'AAPFlag')
-        return FlagState.objects.all()
+        aap_flags = apps.get_model('dab_feature_flags', 'AAPFlag')
+        return aap_flags.objects.all()
 
     def get_flags(self):
         flags = {}

ansible_base/lib/dynamic_config/feature_flags/flag_source.py renamed to ansible_base/feature_flags/flag_source.py

@@ -5,7 +5,7 @@
 from django.core.exceptions import ValidationError
 from flags.sources import get_flags
 
-from ansible_base.lib.dynamic_config.feature_flags.platform_flags import AAP_FEATURE_FLAGS
+from ansible_base.feature_flags.feature_flags import AAP_FEATURE_FLAGS
 
 logger = logging.getLogger('ansible_base.feature_flags.utils')
 
@@ -14,7 +14,7 @@ def get_django_flags():
     return get_flags()
 
 
-def create_initial_data(**kwargs):
+def create_initial_data(**kwargs):  # NOSONAR
     """
     Loads in platform feature flags when the server starts
     """
@@ -40,22 +40,22 @@ def load_feature_flags():
         """
         Loads in all feature flags into the database. Updates them if necessary.
         """
-        FeatureFlags = apps.get_model('dab_feature_flags', 'AAPFlag')
+        feature_flags_model = apps.get_model('dab_feature_flags', 'AAPFlag')
         for flag in AAP_FEATURE_FLAGS:
             try:
-                existing_flag = FeatureFlags.objects.filter(name=flag['name'], condition=flag['condition'])
+                existing_flag = feature_flags_model.objects.filter(name=flag['name'], condition=flag['condition'])
                 if existing_flag:
                     feature_flag = update_feature_flag(existing_flag.first(), flag)
                 else:
                     if hasattr(settings, flag['name']):
                         flag['value'] = getattr(settings, flag['name'])
-                    feature_flag = FeatureFlags(**flag)
+                    feature_flag = feature_flags_model(**flag)
                 feature_flag.full_clean()
                 feature_flag.save()
             except ValidationError as e:
                 # Ignore this error unless better way to bypass this
                 if e.messages[0] == 'Aap flag with this Name and Condition already exists.':
-                    pass
+                    logger.info(f"Feature flag: {flag['name']} already exists")
                 else:
                     error_msg = f"Invalid feature flag: {flag['name']}. Error: {e}"
                     logger.error(error_msg)
@@ -70,10 +70,11 @@ def delete_feature_flags():
             for _flag in AAP_FEATURE_FLAGS:
                 if flag.name == _flag['name'] and flag.condition == _flag['condition']:
                     found = True
-                    continue
+                    break
             if found:
                 continue
             if not found:
+                logger.info(f"Deleting feature flag: {flag.name} as it is no longer available as a platform flag")
                 flag.delete()
 
     delete_feature_flags()

ansible_base/feature_flags/utils.py

@@ -10,8 +10,6 @@
 from ansible_base.lib.utils.views.ansible_base import AnsibleBaseView
 from ansible_base.lib.utils.views.django_app_api import AnsibleBaseDjangoAppApiView
 from ansible_base.lib.utils.views.permissions import IsSuperuserOrAuditor, try_add_oauth2_scope_permission
-
-# from ansible_base.oauth2_provider.permissions import OAuth2ScopePermission
 from ansible_base.rest_pagination import DefaultPaginator
 
 from .utils import get_django_flags

ansible_base/feature_flags/views.py

@@ -5,7 +5,6 @@
     load_envvars,
     load_python_file_with_injected_context,
     load_standard_settings_files,
-    toggle_database_feature_flags,
     toggle_feature_flags,
     validate,
 )
@@ -18,6 +17,5 @@
     "load_python_file_with_injected_context",
     "load_standard_settings_files",
     "toggle_feature_flags",
-    "toggle_database_feature_flags",
     "validate",
 ]

ansible_base/lib/dynamic_config/__init__.py

@@ -15,8 +15,6 @@
 from dynaconf.loaders.yaml_loader import yaml
 from dynaconf.utils.files import glob
 from dynaconf.utils.functional import empty
-from flags.sources import get_flags
-from flags.state import disable_flag, enable_flag
 
 from ansible_base.lib.dynamic_config.settings_logic import get_mergeable_dab_settings
 
@@ -317,17 +315,3 @@ def toggle_feature_flags(settings: Dynaconf) -> dict[str, Any]:
             feature_content[0]["value"] = installer_value
             data[f"FLAGS__{feature_name}"] = feature_content
     return data
-
-
-def toggle_database_feature_flags(settings: Dynaconf) -> dict[str, Any]:
-    """Toggle FLAGS based on installer settings.
-    FLAGS is a django-flags formatted dictionary.
-    Installers will place `FEATURE_SOME_PLATFORM_FLAG_ENABLED=True/False` in the settings file.
-    This function will update the value in the database with the expected boolean value
-    """
-    for feature_name in get_flags():
-        if (installer_value := settings.get(feature_name, empty)) is not empty:
-            if installer_value:
-                enable_flag(feature_name)
-            else:
-                disable_flag(feature_name)

ansible_base/lib/dynamic_config/dynaconf_helpers.py

@@ -306,7 +306,7 @@ def get_mergeable_dab_settings(settings: dict) -> dict:  # NOSONAR
         if "flags" not in installed_apps:
             installed_apps.append('flags')
 
-        dab_data['FLAG_SOURCES'] = ('ansible_base.lib.dynamic_config.feature_flags.flag_source.AAPFlagSource',)
+        dab_data['FLAG_SOURCES'] = ('ansible_base.feature_flags.flag_source.AAPFlagSource',)
 
         found_template_backend = False
         template_context_processor = 'django.template.context_processors.request'

ansible_base/lib/dynamic_config/settings_logic.py

@@ -97,7 +97,6 @@ def test_authenticators_cli_initialize(
     err = StringIO()
 
     # Sanity check:
-    # _system user exists
     assert django_user_model.objects.count() == 0
 
     # Optionally create admin user