Change flags list to yaml list

Author: zkayyali812

ansible_base/feature_flags/feature_flags.py

@@ -0,0 +1,61 @@
+- name: FEATURE_INDIRECT_NODE_COUNTING_ENABLED
+  ui_name: Indirect Node Counting
+  visibility: public
+  condition: boolean
+  value: 'False'
+  support_level: NOT_FOR_PRODUCTION
+  description: TBD
+  support_url: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/
+  labels:
+    - controller
+- name: FEATURE_POLICY_AS_CODE_ENABLED
+  ui_name: Policy as Code
+  visibility: public
+  condition: boolean
+  value: 'False'
+  support_level: NOT_FOR_PRODUCTION
+  description: TBD
+  support_url: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/
+  labels:
+    - controller
+- name: FEATURE_EDA_ANALYTICS_ENABLED
+  ui_name: Event-Driven Ansible Analytics
+  visibility: public
+  condition: boolean
+  value: 'False'
+  support_level: NOT_FOR_PRODUCTION
+  description: TBD
+  support_url: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/
+  labels:
+    - eda
+- name: FEATURE_GATEWAY_IPV6_USAGE_ENABLED
+  ui_name: Gateway IPv6 Usage
+  visibility: private
+  condition: boolean
+  value: 'False'
+  support_level: NOT_FOR_PRODUCTION
+  description: TBD
+  support_url: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/
+  labels:
+    - gateway
+- name: FEATURE_GATEWAY_CREATE_CRC_SERVICE_TYPE_ENABLED
+  ui_name: Gateway Create CRC Service Type
+  visibility: private
+  condition: boolean
+  value: 'False'
+  support_level: NOT_FOR_PRODUCTION
+  description: TBD
+  support_url: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/
+  labels:
+    - gateway
+- name: FEATURE_DISPATCHERD_ENABLED
+  ui_name: AAP Dispatcherd
+  visibility: private
+  condition: boolean
+  value: 'False'
+  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/feature_flags.yaml

@@ -1,19 +1,29 @@
 import logging
+from pathlib import Path
 
+import yaml
 from django.apps import apps
 from django.conf import settings
 from django.core.exceptions import ValidationError
 from flags.sources import get_flags
 
-from ansible_base.feature_flags.feature_flags import AAP_FEATURE_FLAGS
-
 logger = logging.getLogger('ansible_base.feature_flags.utils')
 
 
 def get_django_flags():
     return get_flags()
 
 
+def feature_flags_list():
+    current_dir = Path(__file__).parent
+    flags_list_file = current_dir / 'feature_flags.yaml'
+    with open(flags_list_file, 'r') as file:
+        try:
+            return yaml.safe_load(file)
+        except yaml.YAMLError as exc:
+            print(exc)
+
+
 def create_initial_data(**kwargs):  # NOSONAR
     """
     Loads in platform feature flags when the server starts
@@ -45,7 +55,7 @@ def load_feature_flags():
     from ansible_base.resource_registry.signals.handlers import no_reverse_sync
 
     feature_flags_model = apps.get_model('dab_feature_flags', 'AAPFlag')
-    for flag in AAP_FEATURE_FLAGS:
+    for flag in feature_flags_list():
         try:
             existing_flag = feature_flags_model.objects.filter(name=flag['name'], condition=flag['condition'])
             if existing_flag:
@@ -75,7 +85,7 @@ def delete_feature_flags():
     all_flags = apps.get_model('dab_feature_flags', 'AAPFlag').objects.all()
     for flag in all_flags:
         found = False
-        for _flag in AAP_FEATURE_FLAGS:
+        for _flag in feature_flags_list():
             if flag.name == _flag['name'] and flag.condition == _flag['condition']:
                 found = True
                 break

ansible_base/feature_flags/utils.py

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

test_app/tests/authentication/management/test_authenticators.py

@@ -203,10 +203,10 @@ def test_handle_no_options():
 
 @pytest.mark.django_db
 def test_management_command_existing_data(aap_flags, capsys):
-    from ansible_base.feature_flags.feature_flags import AAP_FEATURE_FLAGS
+    from ansible_base.feature_flags.utils import feature_flags_list
 
     call_command('feature_flags', '--list')
 
     captured = capsys.readouterr()
     output_lines = captured.out.strip().split('\n')
-    assert len(output_lines) - 2 == len(AAP_FEATURE_FLAGS)  # Subtract 2 to remove header and '---' line before data
+    assert len(output_lines) - 2 == len(feature_flags_list())  # Subtract 2 to remove header and '---' line before data

test_app/tests/feature_flags/management/test_feature_flags.py

@@ -1,8 +1,8 @@
 import pytest
 from django.conf import settings
 
-from ansible_base.feature_flags.feature_flags import AAP_FEATURE_FLAGS
 from ansible_base.feature_flags.models import AAPFlag
+from ansible_base.feature_flags.utils import feature_flags_list
 
 
 @pytest.mark.django_db
@@ -13,7 +13,7 @@ def test_total_platform_flags(aap_flags):
 @pytest.mark.django_db
 @pytest.mark.parametrize(
     "feature_flag",
-    AAP_FEATURE_FLAGS,
+    feature_flags_list(),
 )
 def test_feature_flags_from_db(aap_flags, feature_flag):
     flag = AAPFlag.objects.get(name=feature_flag['name'])

test_app/tests/feature_flags/models/test_aap_flag.py

@@ -7,6 +7,6 @@ def test_feature_flags_state_api_list(admin_api_client: APIClient):
     """
     Test that we can list all feature flags
     """
-    url = get_relative_url("featureflags-list")
+    url = get_relative_url("feature-flags-state-list")
     response = admin_api_client.get(url)
     assert response.status_code == 200

test_app/tests/feature_flags/test_old_api.py

@@ -102,8 +102,9 @@ def mock_logger(mocker):
 
 
 @pytest.fixture
-def mock_aap_feature_flags_constant(mocker):
-    return mocker.patch(f"{MODULE_PATH}.AAP_FEATURE_FLAGS", [])
+def mock_feature_flags_list(mocker):
+    mock = mocker.patch(f"{MODULE_PATH}.feature_flags_list")
+    return mock
 
 
 def test_get_django_flags(mocker):
@@ -122,7 +123,7 @@ class TestCreateInitialData:
 
     @pytest.mark.django_db  # May not be strictly necessary with all the mocking, but good practice
     def test_load_feature_flags_creates_new_flag_from_settings_value(
-        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_aap_feature_flags_constant, mocker
+        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_feature_flags_list, mocker
     ):
         from ansible_base.feature_flags.utils import create_initial_data
 
@@ -134,8 +135,7 @@ def test_load_feature_flags_creates_new_flag_from_settings_value(
             'visibility': 'public',
             # No 'value' here, expecting it from settings
         }
-        mock_aap_feature_flags_constant.append(flag_def)
-
+        mock_feature_flags_list.return_value = [flag_def]
         # --- Mocks for database interaction (for load_feature_flags part) ---
         mock_filter_queryset = MagicMock()
         # Simulate flag does NOT exist:
@@ -182,7 +182,7 @@ def test_load_feature_flags_creates_new_flag_from_settings_value(
 
     @pytest.mark.django_db
     def test_load_feature_flags_creates_new_flag_with_default_value_if_not_in_settings(
-        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_aap_feature_flags_constant, mocker
+        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_feature_flags_list, mocker
     ):
         from ansible_base.feature_flags.utils import create_initial_data
 
@@ -194,7 +194,7 @@ def test_load_feature_flags_creates_new_flag_with_default_value_if_not_in_settin
             'visibility': 'private',
             'value': False,  # Default value in definition
         }
-        mock_aap_feature_flags_constant.extend([flag_def])
+        mock_feature_flags_list.return_value = [flag_def]
 
         mock_empty_queryset = MagicMock()
         mock_empty_queryset.first.return_value = None
@@ -216,7 +216,7 @@ def test_load_feature_flags_creates_new_flag_with_default_value_if_not_in_settin
 
     @pytest.mark.django_db
     def test_load_feature_flags_updates_existing_flag(
-        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_aap_feature_flags_constant, mocker
+        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_feature_flags_list, mocker
     ):
         from ansible_base.feature_flags.utils import create_initial_data
 
@@ -232,7 +232,7 @@ def test_load_feature_flags_updates_existing_flag(
             'labels': ['new'],
             'description': 'new desc',
         }
-        mock_aap_feature_flags_constant.extend([flag_def_updated])
+        mock_feature_flags_list.return_value = [flag_def_updated]
 
         existing_db_flag = MockAAPFlagInstance(
             name='EXISTING_FLAG',
@@ -274,12 +274,12 @@ def test_load_feature_flags_updates_existing_flag(
 
     @pytest.mark.django_db
     def test_load_feature_flags_handles_specific_validation_error(
-        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_aap_feature_flags_constant, mocker
+        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_feature_flags_list, mocker
     ):
         from ansible_base.feature_flags.utils import create_initial_data
 
         flag_def = {'name': 'ERROR_FLAG', 'condition': 'err_cond', 'ui_name': 'Error Flag'}
-        mock_aap_feature_flags_constant.extend([flag_def])
+        mock_feature_flags_list.return_value = [flag_def]
 
         mock_empty_queryset = MagicMock()
         mock_empty_queryset.first.return_value = None
@@ -302,12 +302,12 @@ def test_load_feature_flags_handles_specific_validation_error(
 
     @pytest.mark.django_db
     def test_load_feature_flags_logs_other_validation_errors(
-        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_aap_feature_flags_constant, mocker
+        self, mock_apps_get_model, mock_aap_flag_model_cls, mock_settings, mock_logger, mock_feature_flags_list, mocker
     ):
         from ansible_base.feature_flags.utils import create_initial_data
 
         flag_def = {'name': 'OTHER_ERROR_FLAG', 'condition': 'other_err_cond', 'ui_name': 'Other Error'}
-        mock_aap_feature_flags_constant.extend([flag_def])
+        mock_feature_flags_list.return_value = [flag_def]
 
         mock_empty_queryset = MagicMock()
         mock_empty_queryset.first.return_value = None
@@ -329,7 +329,7 @@ def test_load_feature_flags_logs_other_validation_errors(
         mock_created_instance.save.assert_not_called()
 
     @pytest.mark.django_db
-    def test_delete_feature_flags_removes_obsolete_flag(self, mock_apps_get_model, mock_aap_flag_model_cls, mock_logger, mock_aap_feature_flags_constant):
+    def test_delete_feature_flags_removes_obsolete_flag(self, mock_apps_get_model, mock_aap_flag_model_cls, mock_logger, mock_feature_flags_list):
         from ansible_base.feature_flags.utils import create_initial_data
 
         obsolete_flag_in_db = MockAAPFlagInstance(name='OBSOLETE_FLAG', condition='obs_cond')
@@ -347,11 +347,11 @@ def test_delete_feature_flags_removes_obsolete_flag(self, mock_apps_get_model, m
         mock_logger.info.assert_any_call(f"Deleting feature flag: {obsolete_flag_in_db.name} as it is no longer available as a platform flag")
 
     @pytest.mark.django_db
-    def test_delete_feature_flags_keeps_current_flag(self, mock_apps_get_model, mock_aap_flag_model_cls, mock_logger, mock_aap_feature_flags_constant):
+    def test_delete_feature_flags_keeps_current_flag(self, mock_apps_get_model, mock_aap_flag_model_cls, mock_logger, mock_feature_flags_list):
         from ansible_base.feature_flags.utils import create_initial_data
 
         current_flag_def = {'name': 'CURRENT_FLAG', 'condition': 'curr_cond', 'ui_name': 'Current'}
-        mock_aap_feature_flags_constant.extend([current_flag_def])
+        mock_feature_flags_list.return_value = [current_flag_def]
 
         current_flag_in_db = MockAAPFlagInstance(name='CURRENT_FLAG', condition='curr_cond')
 

test_app/tests/feature_flags/test_utils.py

@@ -52,7 +52,7 @@ def test_old_feature_flags_list(admin_api_client, aap_flags):
     """
     Test that we can list feature flags api, after preloading data
     """
-    url = get_relative_url("featureflags-list")
+    url = get_relative_url("feature-flags-state-list")
     response = admin_api_client.get(url)
     assert response.status_code == 200
     assert len(response.data) == 6

test_app/tests/feature_flags/views/test_feature_flag.py

@@ -73,6 +73,7 @@ def test_get_system_user_from_basic_model(self):
 
     @pytest.mark.django_db
     def test_get_system_user_from_managed_model(self):
+        User.all_objects.filter(username=get_system_username()[0]).delete()
         create_system_user(user_model=ManagedUser)
 
         assert ManagedUser.objects.filter(username=get_system_username()[0]).count() == 0