resource-sync

Author: zkayyali812

.dockerignore

@@ -0,0 +1,6 @@
+**/.github
+**/.cache
+**/.gitignore
+**/.venv
+**/venv
+**/.tox

ansible_base/feature_flags/apps.py

@@ -1,27 +1,8 @@
 from django.apps import AppConfig
-from django.db.models.signals import post_migrate
-from django.db.utils import OperationalError, ProgrammingError
-
-from .utils import create_initial_data
 
 
 class FeatureFlagsConfig(AppConfig):
     default_auto_field = 'django.db.models.BigAutoField'
     name = 'ansible_base.feature_flags'
     label = 'dab_feature_flags'
     verbose_name = 'Feature Flags'
-
-    def ready(self):
-        from django.conf import settings
-
-        if 'ansible_base.feature_flags' in settings.INSTALLED_APPS:
-            # TODO: Is there a better way to handle this logic?
-
-            # If migrations are complete, attempt to load in feature flags again.
-            # This can help capture any updates to the platform flags loaded in to ensure that new values
-            # are added and updated.
-            # Otherwise wait for migrations to be complete before loading in feature flags.
-            try:
-                create_initial_data()
-            except (ProgrammingError, OperationalError):
-                post_migrate.connect(create_initial_data)

ansible_base/feature_flags/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.17 on 2025-04-08 14:36
+# Generated by Django 4.2.17 on 2025-06-04 12:00
 
 import ansible_base.feature_flags.models.aap_flag
 from django.conf import settings
@@ -36,7 +36,7 @@ class Migration(migrations.Migration):
                 ('modified_by', models.ForeignKey(default=None, editable=False, help_text='The user who last modified this resource.', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='%(app_label)s_%(class)s_modified+', to=settings.AUTH_USER_MODEL)),
             ],
             options={
-                'unique_together': {('name', 'condition', 'value')},
+                'unique_together': {('name', 'condition')},
             },
         ),
     ]

ansible_base/feature_flags/models/aap_flag.py

@@ -2,21 +2,19 @@
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
-from ansible_base.activitystream.models import AuditableModel
 from ansible_base.lib.abstract_models.common import NamedCommonModel
-
-# from ansible_base.resource_registry.fields import AnsibleResourceField
+from ansible_base.resource_registry.fields import AnsibleResourceField
 
 
 def validate_feature_flag_name(value: str):
     if not value.startswith('FEATURE_') or not value.endswith('_ENABLED'):
         raise ValidationError(_("Feature flag names must follow the format of `FEATURE_<flag-name>_ENABLED`"))
 
 
-class AAPFlag(NamedCommonModel, AuditableModel):
+class AAPFlag(NamedCommonModel):
     class Meta:
         app_label = "dab_feature_flags"
-        unique_together = ("name", "condition", "value")
+        unique_together = ("name", "condition")
 
     def __str__(self):
         return "{name} is enabled when {condition} is " "{value}{required}".format(
@@ -26,7 +24,7 @@ def __str__(self):
             required=" (required)" if self.required else "",
         )
 
-    # resource = AnsibleResourceField(primary_key_field="id")
+    resource = AnsibleResourceField(primary_key_field="id")
 
     name = models.CharField(
         max_length=64,

ansible_base/feature_flags/serializers.py

@@ -15,7 +15,7 @@ class FeatureFlagSerializer(NamedCommonModelSerializer):
     class Meta:
         model = AAPFlag
         fields = NamedCommonModelSerializer.Meta.fields + [x.name for x in AAPFlag._meta.concrete_fields] + ['state']
-        read_only_fields = ["name", "condition", "required", "support_level", "visibility", "toggle_type", "description", "labels"]
+        read_only_fields = ["name", "condition", "required", "support_level", "visibility", "toggle_type", "description", "labels", "ui_name", "support_url"]
 
     def get_state(self, instance):
         return flag_state(instance.name)
@@ -35,7 +35,7 @@ class Meta:
         fields = NamedCommonModelSerializer.Meta.fields + [x.name for x in AAPFlag._meta.concrete_fields]
         read_only_fields = ["name", "condition", "required", "support_level", "visibility", "toggle_type", "description", "labels"]
 
-    def to_representation(self) -> dict:
+    def to_representation(self, instance=None) -> dict:
         return_data = {}
         feature_flags = get_django_flags()
         for feature_flag in feature_flags:

ansible_base/feature_flags/urls.py

@@ -8,6 +8,7 @@
 
 router = AssociationResourceRouter()
 
+router.register(r'feature_flags/states', views.FeatureFlagsStatesView, basename='aap_flags_states')
 router.register(r'feature_flags', views.FeatureFlagsView, basename='aap_flags')
 
 # TODO: Remove once all components are migrated to new endpoints.

ansible_base/feature_flags/utils.py

@@ -1,19 +1,19 @@
+import logging
+
 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.lib.dynamic_config.feature_flags.platform_flags import AAP_FEATURE_FLAGS
 
+logger = logging.getLogger('ansible_base.feature_flags.utils')
+
 
 def get_django_flags():
     return get_flags()
 
 
-def is_boolean_str(val):
-    return val.lower() in {'true', 'false'}
-
-
 def create_initial_data(**kwargs):
     """
     Loads in platform feature flags when the server starts
@@ -26,20 +26,15 @@ 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['support_level']
-        existing.visibility = new['visibility']
-        existing.ui_name = new['ui_name']
-        existing.support_url = new['support_url']
-        if 'required' in new:
-            existing.required = new['required']
-        if 'toggle_type' in new:
-            existing.toggle_type = new['toggle_type']
-        if 'labels' in new:
-            existing.labels = new['labels']
-        if 'description' in new:
-            existing.description = new['description']
-        existing.save()
+        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():
         """
@@ -50,19 +45,20 @@ def load_feature_flags():
             try:
                 existing_flag = FeatureFlags.objects.filter(name=flag['name'], condition=flag['condition'])
                 if existing_flag:
-                    update_feature_flag(existing_flag.first(), flag)
+                    feature_flag = update_feature_flag(existing_flag.first(), flag)
                 else:
                     if hasattr(settings, flag['name']):
                         flag['value'] = getattr(settings, flag['name'])
-                    FeatureFlags.objects.create(**flag)
-                AAPFlag(**flag).full_clean()
+                    feature_flag = FeatureFlags(**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, Condition and Value already exists.':
+                if e.messages[0] == 'Aap flag with this Name and Condition already exists.':
                     pass
                 else:
-                    # Raise row validation errors
-                    raise e
+                    error_msg = f"Invalid feature flag: {flag['name']}. Error: {e}"
+                    logger.error(error_msg)
 
     def delete_feature_flags():
         """

ansible_base/feature_flags/views.py

@@ -1,17 +1,19 @@
-from django.shortcuts import get_object_or_404
 from django.utils.translation import gettext_lazy as _
-from flags.state import flag_enabled
-from rest_framework import status
+from flags.sources import get_flags
+from flags.state import flag_state
 from rest_framework.response import Response
 from rest_framework.viewsets import ModelViewSet
 
 from ansible_base.feature_flags.models import AAPFlag
 from ansible_base.feature_flags.serializers import FeatureFlagSerializer, OldFeatureFlagSerializer
 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
+from ansible_base.lib.utils.views.permissions import IsSuperuserOrAuditor, try_add_oauth2_scope_permission
 
-from .utils import get_django_flags, is_boolean_str
+# from ansible_base.oauth2_provider.permissions import OAuth2ScopePermission
+from ansible_base.rest_pagination import DefaultPaginator
+
+from .utils import get_django_flags
 
 
 class FeatureFlagsView(AnsibleBaseDjangoAppApiView, ModelViewSet):
@@ -21,24 +23,27 @@ class FeatureFlagsView(AnsibleBaseDjangoAppApiView, ModelViewSet):
 
     queryset = AAPFlag.objects.order_by('id')
     serializer_class = FeatureFlagSerializer
-    permission_classes = [IsSuperuserOrAuditor]
-    http_method_names = ['get', 'put', 'head', 'options']
-
-    def update(self, request, **kwargs):
-        _feature_flag = self.get_object()
-        value = request.data.get('value')
-        if not value:
-            return Response(status=status.HTTP_400_BAD_REQUEST, data={"details": "Invalid request object."})
-
-        feature_flag = get_object_or_404(AAPFlag, pk=_feature_flag.id)
-        if feature_flag.toggle_type == 'install-time':
-            return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED, data={"details": "Install-time feature flags cannot be toggled at run-time."})
-        if feature_flag.condition == "boolean" and not is_boolean_str(value):
-            return Response(status=status.HTTP_400_BAD_REQUEST, data={"details": "Feature flag boolean conditional requires using boolean value."})
-        feature_flag.value = value
-        feature_flag.save()
-
-        return Response(self.get_serializer().to_representation(feature_flag))
+    permission_classes = try_add_oauth2_scope_permission([IsSuperuserOrAuditor])
+    http_method_names = ['get', 'head', 'options']
+
+
+class FeatureFlagsStatesView(AnsibleBaseDjangoAppApiView, ModelViewSet):
+    """
+    A view class for displaying feature flags states
+    """
+
+    queryset = AAPFlag.objects.order_by('id')
+    permission_classes = try_add_oauth2_scope_permission([IsSuperuserOrAuditor])
+    http_method_names = ['get', 'head', 'options']
+
+    def list(self, request):
+        paginator = DefaultPaginator()
+        flags = get_flags()
+        ret = []
+        for flag in flags:
+            ret.append({"flag_name": flag, "flag_state": flag_state(flag)})
+        result_page = paginator.paginate_queryset(ret, request)
+        return paginator.get_paginated_response(result_page)
 
 
 # TODO: This can be removed after functionality is migrated over to new class

ansible_base/lib/dynamic_config/feature_flags/platform_flags.py

@@ -49,4 +49,26 @@ class AAPFlagNameSchema(TypedDict):
         support_url="https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/",
         labels=['eda'],
     ),
+    AAPFlagNameSchema(
+        name="FEATURE_GATEWAY_IPV6_USAGE_ENABLED",
+        ui_name="Gateway IPv6 Usage",
+        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=['gateway'],
+    ),
+    AAPFlagNameSchema(
+        name="FEATURE_GATEWAY_CREATE_CRC_SERVICE_TYPE",
+        ui_name="Gateway Create CRC Service Type",
+        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=['gateway'],
+    ),
 ]

ansible_base/rbac/permission_registry.py

@@ -143,6 +143,7 @@ def create_managed_roles(self, apps) -> list[tuple[Model, bool]]:
         return ret
 
     def call_when_apps_ready(self, apps, app_config) -> None:
+        from ansible_base.feature_flags.utils import create_initial_data as feature_flag_create_initial_data
         from ansible_base.rbac import triggers
         from ansible_base.rbac.evaluations import bound_has_obj_perm, bound_singleton_permissions, connect_rbac_methods
         from ansible_base.rbac.management import create_dab_permissions
@@ -172,6 +173,11 @@ def call_when_apps_ready(self, apps, app_config) -> None:
             sender=app_config,
             dispatch_uid="ansible_base.rbac.triggers.post_migration_rbac_setup",
         )
+        if 'ansible_base.feature_flags' in settings.INSTALLED_APPS:
+            try:
+                feature_flag_create_initial_data()
+            except Exception:
+                post_migrate.connect(feature_flag_create_initial_data, sender=self)
 
         self.user_model.add_to_class('has_obj_perm', bound_has_obj_perm)
         self.user_model.add_to_class('singleton_permissions', bound_singleton_permissions)