Merge pull request #5590 from raft-tech/5535-feature-flag-model

Feature Flag Model and Admin

Author: elipe17

tdrs-backend/tdpservice/core/admin.py

@@ -1,10 +1,13 @@
-"""Admin class for LogEntry objects."""
+"""Admin classes for core app models."""
 from django.contrib import admin
 from django.contrib.admin.models import LogEntry
+from django.forms import ModelForm
 from django.urls import reverse
 from django.utils.html import escape
 from django.utils.safestring import mark_safe
+from django_json_widget.widgets import JSONEditorWidget
 
+from tdpservice.core.models import FeatureFlag
 from tdpservice.core.utils import ReadOnlyAdminMixin
 
 # LogEntry needs to be de-registered first before registering a custom Admin Model below.
@@ -45,3 +48,50 @@ def object_link(self, obj):
 
     object_link.admin_order_field = "object_repr"
     object_link.short_description = "object"
+
+
+class FeatureFlagAdminForm(ModelForm):
+    """Custom form for FeatureFlag admin with JSON editor widget."""
+
+    class Meta:
+        """Metadata."""
+
+        model = FeatureFlag
+        fields = '__all__'
+        widgets = {
+            'config': JSONEditorWidget(options={
+                'mode': 'code',
+                'modes': ['code', 'tree'],
+                'search': True
+            })
+        }
+
+
+@admin.register(FeatureFlag)
+class FeatureFlagAdmin(admin.ModelAdmin):
+    """Admin interface for FeatureFlag model."""
+
+    form = FeatureFlagAdminForm
+
+    list_display = ['feature_name', 'enabled', 'updated_at']
+    list_filter = ['enabled', 'created_at', 'updated_at']
+    search_fields = ['feature_name', 'description']
+    readonly_fields = ['created_at', 'updated_at']
+
+    fieldsets = (
+        ('Feature Identity', {
+            'fields': ('feature_name', 'description')
+        }),
+        ('Configuration', {
+            'fields': ('enabled', 'config'),
+            'description': 'Toggle the feature on/off and configure feature-specific settings'
+        }),
+        ('Metadata', {
+            'fields': ('created_at', 'updated_at'),
+            'classes': ('collapse',)
+        }),
+    )
+
+    def has_delete_permission(self, request, obj=None):
+        """Only allow superusers to delete feature flags."""
+        return request.user.is_superuser

tdrs-backend/tdpservice/core/migrations/0004_featureflag.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.2.10 on 2026-01-16 18:37
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0003_load_uswds_admin_theme'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='FeatureFlag',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('feature_name', models.CharField(db_index=True, max_length=100, unique=True)),
+                ('enabled', models.BooleanField(default=False)),
+                ('config', models.JSONField(blank=True, default=dict)),
+                ('description', models.TextField(blank=True)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+            ],
+            options={
+                'verbose_name': 'Feature Flag',
+                'verbose_name_plural': 'Feature Flags',
+                'ordering': ['feature_name'],
+            },
+        ),
+    ]

tdrs-backend/tdpservice/core/models.py

@@ -4,6 +4,30 @@
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
 
+
+class FeatureFlag(models.Model):
+    """Model for storing feature flags that can be toggled on/off via Django admin."""
+
+    class Meta:
+        """Metadata."""
+
+        ordering = ['feature_name']
+        verbose_name = 'Feature Flag'
+        verbose_name_plural = 'Feature Flags'
+
+    feature_name = models.CharField(max_length=100, unique=True, db_index=True)
+    enabled = models.BooleanField(default=False)
+    config = models.JSONField(null=False, blank=True, default=dict)
+    description = models.TextField(blank=True)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self) -> str:
+        """Return string representation of the feature flag."""
+        status = "enabled" if self.enabled else "disabled"
+        return f"{self.feature_name} ({status})"
+
+
 """Global permissions
 
 Allows for the creation of permissions that are

tdrs-backend/tdpservice/core/test/test_admin.py

@@ -1,12 +1,15 @@
 """Core Admin class tests."""
 from django.contrib.admin.models import ADDITION, LogEntry
+from django.contrib.admin.sites import AdminSite
 from django.contrib.contenttypes.models import ContentType
-from django.test import TestCase, Client
+from django.test import TestCase, Client, RequestFactory
 from django.urls import reverse
 from tdpservice.users.models import UserChangeRequest, UserChangeRequestStatus
 
 import pytest
 
+from tdpservice.core.admin import FeatureFlagAdmin
+from tdpservice.core.models import FeatureFlag
 from tdpservice.users.models import User
 
 
@@ -82,3 +85,176 @@ def test_user_change_request_approve(self):
         # Approve the change request
         response = client.post(f'/admin/users/userchangerequest/{change_request.id}/approve/')
         self.assertEqual(response.status_code, 302)
+
+
+class TestFeatureFlagAdmin(TestCase):
+    """Test the FeatureFlagAdmin interface."""
+
+    def setUp(self):
+        """Create users for testing."""
+        self.superuser = User.objects.create_superuser(
+            username='superadmin',
+            password='superpassword',
+            first_name='Super',
+            last_name='Admin',
+            email='superadmin@example.com'
+        )
+        self.superuser.is_active = True
+        self.superuser.save()
+
+        self.staff_user = User.objects.create_user(
+            username='staffuser',
+            password='staffpassword',
+            first_name='Staff',
+            last_name='User',
+            email='staff@example.com'
+        )
+        self.staff_user.is_staff = True
+        self.staff_user.is_active = True
+        self.staff_user.save()
+
+        self.site = AdminSite()
+        self.admin = FeatureFlagAdmin(FeatureFlag, self.site)
+        self.factory = RequestFactory()
+
+        return super().setUp()
+
+    def test_feature_flag_list_view(self):
+        """Test that feature flags are visible in admin list view."""
+        FeatureFlag.objects.create(
+            feature_name="test_feature",
+            enabled=True,
+            description="A test feature"
+        )
+
+        client = Client()
+        client.login(username='superadmin', password='superpassword')
+        response = client.get(reverse('admin:core_featureflag_changelist'))
+
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, 'test_feature')
+
+    def test_feature_flag_add_view(self):
+        """Test that feature flags can be added via admin."""
+        client = Client()
+        client.login(username='superadmin', password='superpassword')
+        response = client.get(reverse('admin:core_featureflag_add'))
+
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, 'Feature Identity')
+        self.assertContains(response, 'Configuration')
+
+    def test_feature_flag_change_view(self):
+        """Test that feature flags can be edited via admin."""
+        flag = FeatureFlag.objects.create(
+            feature_name="edit_feature",
+            enabled=False
+        )
+
+        client = Client()
+        client.login(username='superadmin', password='superpassword')
+        response = client.get(
+            reverse('admin:core_featureflag_change', args=[flag.id])
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, 'edit_feature')
+
+    def test_superuser_can_delete(self):
+        """Test that superusers can delete feature flags."""
+        flag = FeatureFlag.objects.create(feature_name="deletable_feature")
+
+        request = self.factory.get('/')
+        request.user = self.superuser
+
+        self.assertTrue(self.admin.has_delete_permission(request, flag))
+
+    def test_non_superuser_cannot_delete(self):
+        """Test that non-superusers cannot delete feature flags."""
+        flag = FeatureFlag.objects.create(feature_name="protected_feature")
+
+        request = self.factory.get('/')
+        request.user = self.staff_user
+
+        self.assertFalse(self.admin.has_delete_permission(request, flag))
+
+    def test_list_display_fields(self):
+        """Test that list_display contains expected fields."""
+        self.assertIn('feature_name', self.admin.list_display)
+        self.assertIn('enabled', self.admin.list_display)
+        self.assertIn('updated_at', self.admin.list_display)
+
+    def test_list_filter_fields(self):
+        """Test that list_filter contains expected fields."""
+        self.assertIn('enabled', self.admin.list_filter)
+        self.assertIn('created_at', self.admin.list_filter)
+        self.assertIn('updated_at', self.admin.list_filter)
+
+    def test_search_fields(self):
+        """Test that search_fields contains expected fields."""
+        self.assertIn('feature_name', self.admin.search_fields)
+        self.assertIn('description', self.admin.search_fields)
+
+    def test_readonly_fields(self):
+        """Test that timestamps are read-only."""
+        self.assertIn('created_at', self.admin.readonly_fields)
+        self.assertIn('updated_at', self.admin.readonly_fields)
+
+    def test_feature_flag_create_via_admin(self):
+        """Test creating a feature flag through the admin interface."""
+        client = Client()
+        client.login(username='superadmin', password='superpassword')
+
+        response = client.post(
+            reverse('admin:core_featureflag_add'),
+            {
+                'feature_name': 'datafiles_pia_submission',
+                'enabled': True,
+                'config': '{"max_file_size": 1000}',
+                'description': 'Enable PIA datafile submission'
+            }
+        )
+
+        # Should redirect after successful creation
+        self.assertEqual(response.status_code, 302)
+        self.assertTrue(
+            FeatureFlag.objects.filter(feature_name='datafiles_pia_submission').exists()
+        )
+
+    def test_feature_flag_search(self):
+        """Test searching for feature flags."""
+        FeatureFlag.objects.create(
+            feature_name="searchable_feature",
+            description="This feature can be searched"
+        )
+        FeatureFlag.objects.create(
+            feature_name="another_feature",
+            description="Different description"
+        )
+
+        client = Client()
+        client.login(username='superadmin', password='superpassword')
+        response = client.get(
+            reverse('admin:core_featureflag_changelist'),
+            {'q': 'searchable'}
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, 'searchable_feature')
+        self.assertNotContains(response, 'another_feature')
+
+    def test_feature_flag_filter_by_enabled(self):
+        """Test filtering feature flags by enabled status."""
+        FeatureFlag.objects.create(feature_name="enabled_flag", enabled=True)
+        FeatureFlag.objects.create(feature_name="disabled_flag", enabled=False)
+
+        client = Client()
+        client.login(username='superadmin', password='superpassword')
+        response = client.get(
+            reverse('admin:core_featureflag_changelist'),
+            {'enabled__exact': '1'}
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, 'enabled_flag')
+        self.assertNotContains(response, 'disabled_flag')