Fix post-migrate call. Replace with manual migrations

zkayyali812 · zkayyali812 · commit 1e9b6aa23aa6 · 2025-06-24T10:00:41.000-04:00
diff --git a/ansible_base/feature_flags/apps.py b/ansible_base/feature_flags/apps.py
@@ -11,7 +11,4 @@ class FeatureFlagsConfig(AppConfig):
     verbose_name = 'Feature Flags'
 
     def ready(self):
-        try:
-            create_initial_data()
-        except Exception:
-            post_migrate.connect(create_initial_data, sender=self)
+        post_migrate.connect(create_initial_data, sender=self)
diff --git a/ansible_base/feature_flags/definitions/feature_flags.yaml b/ansible_base/feature_flags/definitions/feature_flags.yaml
@@ -3,27 +3,28 @@
   visibility: True
   condition: boolean
   value: 'False'
-  support_level: TECHNICAL_PREVIEW
-  description: TBD
-  support_url: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/
+  support_level: TECHNOLOGY_PREVIEW
+  description: "Indirect Node Counting parses the event stream of all jobs to identify resources and stores these in the platform database. Example: Job automates VMware, the parser will report back the VMs, Hypervisors that were automated. This feature helps customers and partners report on the automations they are doing beyond an API endpoint."
+  support_url: https://access.redhat.com/articles/7109910
   labels:
     - controller
 - name: FEATURE_EDA_ANALYTICS_ENABLED
   ui_name: Event-Driven Ansible Analytics
-  visibility: True
+  visibility: False
   condition: boolean
   value: 'False'
-  support_level: TECHNICAL_PREVIEW
-  description: Submit Event-Driven Ansible usage analytics to console.redhat.com
+  support_level: TECHNOLOGY_PREVIEW
+  description: Submit Event-Driven Ansible usage analytics to console.redhat.com.
   support_url: https://access.redhat.com/solutions/7112810
+  toggle_type: install-time
   labels:
     - eda
 - name: FEATURE_GATEWAY_IPV6_USAGE_ENABLED
   ui_name: Gateway IPv6 Enablement
   visibility: False
   condition: boolean
   value: 'False'
-  support_level: TECHNICAL_PREVIEW
+  support_level: TECHNOLOGY_PREVIEW
   description: The feature flag represents enabling IPv6 only traffic to be allowed through the gateway component and does not include all components of the platform.
   support_url: https://access.redhat.com/articles/7116569
   labels:
@@ -40,13 +41,14 @@
   labels:
     - gateway
 - name: FEATURE_DISPATCHERD_ENABLED
-  ui_name: AAP Dispatcherd
-  visibility: True
+  ui_name: AAP Dispatcherd background tasking system
+  visibility: False
   condition: boolean
   value: 'False'
-  support_level: DEVELOPER_PREVIEW
+  support_level: TECHNOLOGY_PREVIEW
   description: A service to run python tasks in subprocesses, designed specifically to work well with pg_notify, but intended to be extensible to other message delivery means.
   support_url: ''
+  toggle_type: install-time
   labels:
     - eda
     - controller
diff --git a/ansible_base/feature_flags/definitions/schema.json b/ansible_base/feature_flags/definitions/schema.json
@@ -34,7 +34,7 @@
         "description": "The level of support provided for this feature.",
         "type": "string",
         "enum": [
-          "TECHNICAL_PREVIEW",
+          "TECHNOLOGY_PREVIEW",
           "DEVELOPER_PREVIEW"
         ]
       },
diff --git a/ansible_base/feature_flags/migrations/0001_initial.py b/ansible_base/feature_flags/migrations/0001_initial.py
@@ -1,4 +1,5 @@
-# Generated by Django 4.2.21 on 2025-06-17 20:08
+# Generated by Django 4.2.21 on 2025-06-24 13:34
+# FileHash: 8207dc6b9a446b7d4222d21287e695990b80846c779184388dbd63d32771b400
 
 import ansible_base.feature_flags.models.aap_flag
 from django.conf import settings
@@ -26,7 +27,7 @@ class Migration(migrations.Migration):
                 ('condition', models.CharField(default='boolean', help_text='Used to specify a condition, which if met, will enable the feature flag.', max_length=64)),
                 ('value', models.CharField(default='False', help_text='The value used to evaluate the conditional specified.', max_length=127)),
                 ('required', models.BooleanField(default=False, help_text="If multiple conditions are required to be met to enable a feature flag, 'required' can be used to specify the necessary conditionals.")),
-                ('support_level', models.CharField(choices=[('DEVELOPER_PREVIEW', 'Developer Preview'), ('TECHNICAL_PREVIEW', 'Technical Preview')], help_text='The support criteria for the feature flag. Must be one of (DEVELOPER_PREVIEW or TECHNICAL_PREVIEW).', max_length=25)),
+                ('support_level', models.CharField(choices=[('DEVELOPER_PREVIEW', 'Developer Preview'), ('TECHNOLOGY_PREVIEW', 'Technology Preview')], help_text='The support criteria for the feature flag. Must be one of (DEVELOPER_PREVIEW or TECHNOLOGY_PREVIEW).', max_length=25)),
                 ('visibility', models.BooleanField(default=False, help_text='The visibility of the feature flag. If false, flag is hidden.')),
                 ('toggle_type', models.CharField(choices=[('install-time', 'install-time'), ('run-time', 'run-time')], default='run-time', help_text="Details whether a flag is toggle-able at run-time or install-time. (Default: 'run-time').", max_length=20)),
                 ('description', models.CharField(default='', help_text='A detailed description giving an overview of the feature flag.', max_length=500)),
diff --git a/ansible_base/feature_flags/migrations/example_migration b/ansible_base/feature_flags/migrations/example_migration
@@ -0,0 +1,21 @@
+### INSTRUCTIONS ###
+# If updating the feature_flags.yaml, create a new migration file by copying this one.
+# 1. Name the file XXXX_manual_YYYYMMDD.py. For example 0002_manual_20250808.py
+# 1. Uncomment the migration below, by uncommenting everything below the FileHash
+# 2. Update the dependency to point to the last dependency
+# 3. Set the FileHash
+###
+
+# FileHash: <FileHash>
+
+# from django.db import migrations
+
+
+# class Migration(migrations.Migration):
+
+#     dependencies = [
+#         ('dab_feature_flags', '0001_initial'),
+#     ]
+
+#     operations = [
+#     ]
diff --git a/ansible_base/feature_flags/models/aap_flag.py b/ansible_base/feature_flags/models/aap_flag.py
@@ -47,8 +47,8 @@ def __str__(self):
     support_level = models.CharField(
         max_length=25,
         null=False,
-        help_text=_("The support criteria for the feature flag. Must be one of (DEVELOPER_PREVIEW or TECHNICAL_PREVIEW)."),
-        choices=(('DEVELOPER_PREVIEW', 'Developer Preview'), ('TECHNICAL_PREVIEW', 'Technical Preview')),
+        help_text=_("The support criteria for the feature flag. Must be one of (DEVELOPER_PREVIEW or TECHNOLOGY_PREVIEW)."),
+        choices=(('DEVELOPER_PREVIEW', 'Developer Preview'), ('TECHNOLOGY_PREVIEW', 'Technology Preview')),
         blank=False,
     )
     visibility = models.BooleanField(
diff --git a/ansible_base/feature_flags/utils.py b/ansible_base/feature_flags/utils.py
@@ -28,7 +28,7 @@ def create_initial_data(**kwargs):  # NOSONAR
     """
     Loads in platform feature flags when the server starts
     """
-    delete_feature_flags()
+    purge_feature_flags()
     load_feature_flags()
 
 
@@ -76,9 +76,9 @@ def load_feature_flags():
                 logger.error(error_msg)
 
 
-def delete_feature_flags():
+def purge_feature_flags():
     """
-    If a feature flag has been removed from the platform flags list, delete it from the database.
+    If a feature flag has been removed from the platform flags list, purge it from the database.
     """
     from ansible_base.resource_registry.signals.handlers import no_reverse_sync
 
diff --git a/ansible_base/feature_flags/views.py b/ansible_base/feature_flags/views.py
@@ -14,7 +14,9 @@
 
 class FeatureFlagsStatesView(AnsibleBaseDjangoAppApiView, ModelViewSet):
     """
-    A view class for displaying feature flags states
+    A view class for displaying feature flags states.
+    To add/update/remove a feature flag, see the instructions in
+    `docs/apps/feature_flags.md`
     """
 
     queryset = AAPFlag.objects.order_by('id')
diff --git a/ansible_base/resource_registry/shared_types.py b/ansible_base/resource_registry/shared_types.py
@@ -78,8 +78,6 @@ class TeamType(SharedResourceTypeSerializer):
 
 
 class FeatureFlagType(SharedResourceTypeSerializer):
-    """Serialize list of feature flags"""
-
     RESOURCE_TYPE = "aapflag"
     UNIQUE_FIELDS = (
         "name",
diff --git a/docs/apps/feature_flags.md b/docs/apps/feature_flags.md
@@ -18,7 +18,7 @@ INSTALLED_APPS = [
 ## Detail
 
 By adding the `ansible_base.feature_flags` app to your application, all Ansible Automation Platform feature flags will be loaded and available in your component.
-To receive flag state updates, ensure the following definition is available in your components `RESOURCE_LIST` - 
+To receive flag state updates, ensure the following definition is available in your components `RESOURCE_LIST` -
 
 ```python
 from ansible_base.feature_flags.models import AAPFlag
@@ -48,9 +48,9 @@ urlpatterns = [
 ]
 ```
 
-## Adding Feature Flags
+## Adding/updating/removing feature flags
 
-To add a feature flag to the platform, specify it in the following [file](../../ansible_base/feature_flags/definitions/feature_flags.yaml)
+To add/update/remove a feature flag to the platform, ensure its configuration is specified correctly it in the following [file](../../ansible_base/feature_flags/definitions/feature_flags.yaml)
 
 An example flag could resemble -
 
@@ -73,3 +73,11 @@ Validate this file against the json schema by running `check-jsonschema` -
 pip install check-jsonschema
 check-jsonschema --schemafile ansible_base/feature_flags/definitions/schema.json ansible_base/feature_flags/definitions/feature_flags.yaml
 ```
+
+After adding/updating/removing a feature flag, make a manual migration. This can be done by -
+
+1. Copying this [example-migration](../../ansible_base/feature_flags/migrations/example_migration).
+2. Name the file XXXX_manual_YYYYMMDD.py. For example 0002_manual_20250808.py
+3. Uncomment the migration, by uncommenting everything below the FileHash
+4. Update the dependency in the migration to point to the previous migration
+5. Set the **FileHash** in the migration file
diff --git a/test_app/tests/feature_flags/migrations/__init__.py b/test_app/tests/feature_flags/migrations/__init__.py
diff --git a/test_app/tests/feature_flags/migrations/test_migrations.py b/test_app/tests/feature_flags/migrations/test_migrations.py
@@ -0,0 +1,82 @@
+import hashlib
+import os
+
+from django.conf import settings
+from django.test import TestCase
+
+
+class FileHashTest(TestCase):
+    FILE_TO_CHECK_PATH = os.path.join(settings.BASE_DIR, 'ansible_base', 'feature_flags', 'definitions', 'feature_flags.yaml')
+    HASH_ALGORITHM = 'sha256'
+    HASH_COMMENT_PREFIX = '# FileHash:'
+
+    def _get_last_migration_file(self):
+        """
+        Finds the path to the last migration file in the specified Django app.
+        """
+        migrations_dir = os.path.join(settings.BASE_DIR, 'ansible_base', 'feature_flags', 'migrations')
+        if not os.path.isdir(migrations_dir):
+            raise FileNotFoundError(f"Migrations directory not found for app: {self.APP_NAME}")
+
+        migration_files = sorted([
+            f for f in os.listdir(migrations_dir)
+            if f.endswith('.py') and f != '__init__.py'
+        ])
+
+        if not migration_files:
+            raise FileNotFoundError(f"No migration files found in {migrations_dir}")
+
+        return os.path.join(migrations_dir, migration_files[-1])
+
+    def _extract_hash_from_migration(self, migration_file_path):
+        """
+        Extracts the expected hash from a comment in the migration file.
+        Assumes the format: '# FileHash: <hash_value>'
+        """
+        with open(migration_file_path, 'r') as f:
+            for line in f:
+                if line.strip().startswith(self.HASH_COMMENT_PREFIX):
+                    return line.strip().replace(self.HASH_COMMENT_PREFIX, '').strip()
+        return None
+
+    def _calculate_file_hash(self, file_path):
+        """
+        Calculates the hash of the given file.
+        """
+        hash_func = getattr(hashlib, self.HASH_ALGORITHM, None)
+        if not hash_func:
+            raise ValueError(f"Unsupported hash algorithm: {self.HASH_ALGORITHM}")
+
+        hasher = hash_func()
+        with open(file_path, 'rb') as f:
+            for chunk in iter(lambda: f.read(4096), b""):
+                hasher.update(chunk)
+        return hasher.hexdigest()
+
+    def test_file_hash_matches_migration_comment(self):
+        """
+        Checks if the hash of a specified file matches the hash commented
+        in the last migration file.
+        """
+        # 1. Get the last migration file
+        try:
+            last_migration_file = self._get_last_migration_file()
+        except FileNotFoundError as e:
+            self.fail(f"Could not find last migration file: {e}")
+
+        # 2. Extract the expected hash from the migration file
+        expected_hash = self._extract_hash_from_migration(last_migration_file)
+        self.assertIsNotNone(expected_hash,
+                             f"No hash comment '{self.HASH_COMMENT_PREFIX}' found in {last_migration_file}")
+        self.assertTrue(expected_hash, "Extracted hash is empty.")
+
+        # 3. Calculate the hash of the target file
+        self.assertTrue(os.path.exists(self.FILE_TO_CHECK_PATH),
+                        f"File to check does not exist: {self.FILE_TO_CHECK_PATH}")
+        actual_hash = self._calculate_file_hash(self.FILE_TO_CHECK_PATH)
+
+        # 4. Compare the hashes
+        self.assertEqual(expected_hash, actual_hash,
+                         f"Hash mismatch for '{os.path.basename(self.FILE_TO_CHECK_PATH)}'. "
+                         f"Expected: {expected_hash}, Got: {actual_hash} "
+                         f"If the feature_flags.yaml file changed, generate a new no-op migration file, and correctly set the FileHash.")
diff --git a/test_app/tests/feature_flags/test_utils.py b/test_app/tests/feature_flags/test_utils.py
@@ -224,7 +224,7 @@ def test_load_feature_flags_creates_new_flag_with_default_value_if_not_in_settin
         mock_constructed_flag = MockAAPFlagInstance()
         mock_aap_flag_model_cls.side_effect = [mock_constructed_flag]
 
-        mock_aap_flag_model_cls.objects.all.return_value = []  # For delete_feature_flags
+        mock_aap_flag_model_cls.objects.all.return_value = []  # For purge_feature_flags
 
         create_initial_data()
 
@@ -349,7 +349,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_feature_flags_list):
+    def test_purge_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')
@@ -367,7 +367,7 @@ 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_feature_flags_list):
+    def test_purge_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'}
@@ -396,7 +396,7 @@ def test_create_initial_data_call_order(self, mocker):
         from ansible_base.feature_flags.utils import create_initial_data
 
         # Mock the inner functions directly to check call order
-        mock_delete = mocker.patch(f"{MODULE_PATH}.delete_feature_flags")
+        mock_delete = mocker.patch(f"{MODULE_PATH}.purge_feature_flags")
         mock_load = mocker.patch(f"{MODULE_PATH}.load_feature_flags")
 
         manager = MagicMock()

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`"description": "The level of support provided for this feature.",`
`35`	`35`	`"type": "string",`
`36`	`36`	`"enum": [`
`37`		`- "TECHNICAL_PREVIEW",`
	`37`	`+ "TECHNOLOGY_PREVIEW",`
`38`	`38`	`"DEVELOPER_PREVIEW"`
`39`	`39`	`]`
`40`	`40`	`},`