add unit tests

Author: zkayyali812

ansible_base/feature_flags/feature_flags.py

@@ -61,7 +61,7 @@ class AAPFlagNameSchema(TypedDict):
         labels=['gateway'],
     ),
     AAPFlagNameSchema(
-        name="FEATURE_GATEWAY_CREATE_CRC_SERVICE_TYPE",
+        name="FEATURE_GATEWAY_CREATE_CRC_SERVICE_TYPE_ENABLED",
         ui_name="Gateway Create CRC Service Type",
         condition="boolean",
         value="False",
@@ -71,4 +71,15 @@ class AAPFlagNameSchema(TypedDict):
         support_url="https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/",
         labels=['gateway'],
     ),
+    AAPFlagNameSchema(
+        name="FEATURE_DISPATCHERD_ENABLED",
+        ui_name="AAP Dispatcherd",
+        condition="boolean",
+        value="False",
+        visibility="private",
+        support_level="NOT_FOR_PRODUCTION",
+        description="TBD",
+        support_url="https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/",
+        labels=['eda', 'controller'],
+    ),
 ]

ansible_base/feature_flags/models/aap_flag.py

@@ -17,7 +17,7 @@ class Meta:
         unique_together = ("name", "condition")
 
     def __str__(self):
-        return "{name} is enabled when {condition} is " "{value}{required}".format(
+        return "{name} condition {condition} is set to " "{value}{required}".format(
             name=self.name,
             condition=self.condition,
             value=self.value,

ansible_base/feature_flags/utils.py

@@ -18,64 +18,64 @@ def create_initial_data(**kwargs):  # NOSONAR
     """
     Loads in platform feature flags when the server starts
     """
+    delete_feature_flags()
+    load_feature_flags()
 
-    from ansible_base.feature_flags.models.aap_flag import AAPFlag
 
-    def update_feature_flag(existing: AAPFlag, new):
-        """
-        Update only the required fields of the feature flag model.
-        This is used to ensure that flags can be loaded in when the server starts, with any applicable updates.
-        """
-        existing.support_level = new.get('support_level')
-        existing.visibility = new.get('visibility')
-        existing.ui_name = new.get('ui_name')
-        existing.support_url = new.get('support_url')
-        existing.required = new.get('required', False)
-        existing.toggle_type = new.get('toggle_type', 'run-time')
-        existing.labels = new.get('labels', [])
-        existing.description = new.get('description', '')
-        return existing
+def update_feature_flag(existing, new):
+    """
+    Update only the required fields of the feature flag model.
+    This is used to ensure that flags can be loaded in when the server starts, with any applicable updates.
+    """
+    existing.support_level = new.get('support_level')
+    existing.visibility = new.get('visibility')
+    existing.ui_name = new.get('ui_name')
+    existing.support_url = new.get('support_url')
+    existing.required = new.get('required', False)
+    existing.toggle_type = new.get('toggle_type', 'run-time')
+    existing.labels = new.get('labels', [])
+    existing.description = new.get('description', '')
+    return existing
 
-    def load_feature_flags():
-        """
-        Loads in all feature flags into the database. Updates them if necessary.
-        """
-        feature_flags_model = apps.get_model('dab_feature_flags', 'AAPFlag')
-        for flag in AAP_FEATURE_FLAGS:
-            try:
-                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 = 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.':
-                    logger.info(f"Feature flag: {flag['name']} already exists")
-                else:
-                    error_msg = f"Invalid feature flag: {flag['name']}. Error: {e}"
-                    logger.error(error_msg)
 
-    def delete_feature_flags():
-        """
-        If a feature flag has been removed from the platform flags list, delete it from the database.
-        """
-        all_flags = apps.get_model('dab_feature_flags', 'AAPFlag').objects.all()
-        for flag in all_flags:
-            found = False
-            for _flag in AAP_FEATURE_FLAGS:
-                if flag.name == _flag['name'] and flag.condition == _flag['condition']:
-                    found = True
-                    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()
+def load_feature_flags():
+    """
+    Loads in all feature flags into the database. Updates them if necessary.
+    """
+    feature_flags_model = apps.get_model('dab_feature_flags', 'AAPFlag')
+    for flag in AAP_FEATURE_FLAGS:
+        try:
+            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 = 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.':
+                logger.info(f"Feature flag: {flag['name']} already exists")
+            else:
+                error_msg = f"Invalid feature flag: {flag['name']}. Error: {e}"
+                logger.error(error_msg)
 
-    delete_feature_flags()
-    load_feature_flags()
+
+def delete_feature_flags():
+    """
+    If a feature flag has been removed from the platform flags list, delete it from the database.
+    """
+    all_flags = apps.get_model('dab_feature_flags', 'AAPFlag').objects.all()
+    for flag in all_flags:
+        found = False
+        for _flag in AAP_FEATURE_FLAGS:
+            if flag.name == _flag['name'] and flag.condition == _flag['condition']:
+                found = True
+                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()

ansible_base/lib/dynamic_config/settings_logic.py

@@ -306,7 +306,12 @@ 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.feature_flags.flag_source.AAPFlagSource',)
+        # After all flags are migrated to database flags, remove settings flag source
+        # Settings flag source is defined for compatibility until migration is complete
+        dab_data['FLAG_SOURCES'] = (
+            'flags.sources.SettingsFlagsSource',
+            'ansible_base.feature_flags.flag_source.AAPFlagSource',
+        )
 
         found_template_backend = False
         template_context_processor = 'django.template.context_processors.request'

ansible_base/lib/testing/fixtures.py

@@ -366,6 +366,13 @@ def ldap_authenticator(ldap_configuration):
     delete_authenticator(authenticator)
 
 
+@pytest.fixture
+def aap_flags():
+    from ansible_base.feature_flags.utils import create_initial_data
+
+    create_initial_data()
+
+
 @pytest.fixture
 def create_mock_method():
     # Creates a function that when called, generates a function that can be used to patch

requirements/requirements_dev.txt

@@ -17,6 +17,7 @@ pytest-asyncio
 pytest-xdist
 pytest-cov
 pytest-django
+pytest-mock
 setuptools-scm
 sqlparse==0.5.2
 psycopg[binary]

test_app/defaults.py

@@ -205,29 +205,3 @@
 RENAMED_USERNAME_PREFIX = "dab:"
 
 JUST_A_TEST = 41
-
-FLAGS = {
-    "FEATURE_SOME_PLATFORM_FLAG_ENABLED": [
-        {
-            "condition": "boolean",
-            "value": False,
-            "required": True,
-        },
-        {
-            "condition": "before date",
-            "value": '2022-06-01T12:00Z',
-        },
-    ],
-    "FEATURE_SOME_PLATFORM_FLAG_FOO_ENABLED": [
-        {
-            "condition": "boolean",
-            "value": False,
-        },
-    ],
-    "FEATURE_SOME_PLATFORM_FLAG_BAR_ENABLED": [
-        {
-            "condition": "boolean",
-            "value": True,
-        },
-    ],
-}