Make owner fields not nullable

Previously, the owner field in Service, Project, Farm, and Sender models was nullable to accommodate
legacy data during migration. This change enforces the owner field to be non-nullable,
ensuring data consistency.

Author: hoangpn

promgen/management/commands/import-jobs.py

@@ -6,6 +6,7 @@
 from django.core.management.base import BaseCommand
 
 from promgen import prometheus, util
+from promgen.middleware import get_current_user
 from promgen.signals import (
     trigger_write_config,
     trigger_write_rules,
@@ -24,7 +25,7 @@ def handle(self, target_file, replace_shard, **kwargs):
         else:
             config = json.load(open(target_file), encoding="utf8")
 
-        imported, skipped = prometheus.import_config(config, replace_shard)
+        imported, skipped = prometheus.import_config(config, get_current_user(), replace_shard)
 
         if imported:
             counters = {key: len(imported[key]) for key in imported}

promgen/migrations/0026_alter_farm_owner_alter_project_owner_and_more.py

@@ -0,0 +1,43 @@
+# Generated by Django 4.2.11 on 2025-04-09 05:23
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("promgen", "0025_farm_owner"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="farm",
+            name="owner",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL
+            ),
+        ),
+        migrations.AlterField(
+            model_name="project",
+            name="owner",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL
+            ),
+        ),
+        migrations.AlterField(
+            model_name="sender",
+            name="owner",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL
+            ),
+        ),
+        migrations.AlterField(
+            model_name="service",
+            name="owner",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL
+            ),
+        ),
+    ]

promgen/models.py

@@ -81,7 +81,7 @@ class Sender(models.Model):
     object_id = models.PositiveIntegerField()
     content_object = GenericForeignKey("content_type", "object_id")
 
-    owner = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, null=True)
+    owner = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.PROTECT)
 
     enabled = models.BooleanField(default=True)
 
@@ -211,9 +211,7 @@ def __str__(self):
 class Service(models.Model):
     name = models.CharField(max_length=128, unique=True, validators=[validators.labelvalue])
     description = models.TextField(blank=True)
-    owner = models.ForeignKey(
-        settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True, default=None
-    )
+    owner = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.PROTECT)
 
     notifiers = GenericRelation(Sender)
     rule_set = GenericRelation("Rule")
@@ -242,9 +240,7 @@ def default(cls, service_name="Default", shard_name="Default"):
 class Project(models.Model):
     name = models.CharField(max_length=128, unique=True, validators=[validators.labelvalue])
     description = models.TextField(blank=True)
-    owner = models.ForeignKey(
-        settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True, default=None
-    )
+    owner = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.PROTECT)
 
     service = models.ForeignKey("promgen.Service", on_delete=models.CASCADE)
     shard = models.ForeignKey("promgen.Shard", on_delete=models.CASCADE)
@@ -266,9 +262,7 @@ def __str__(self):
 class Farm(models.Model):
     name = models.CharField(max_length=128, validators=[validators.labelvalue])
     source = models.CharField(max_length=128)
-    owner = models.ForeignKey(
-        settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True, default=None
-    )
+    owner = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.PROTECT)
 
     class Meta:
         ordering = ["name"]

promgen/prometheus.py

@@ -184,7 +184,7 @@ def import_rules_v2(config, content_object=None):
     return dict(counters)
 
 
-def import_config(config, replace_shard=None):
+def import_config(config, user, replace_shard=None):
     counters = collections.defaultdict(list)
     skipped = collections.defaultdict(list)
     for entry in config:
@@ -202,6 +202,7 @@ def import_config(config, replace_shard=None):
 
         service, created = models.Service.objects.get_or_create(
             name=entry["labels"]["service"],
+            owner=user,
         )
         if created:
             logger.debug("Created service %s", service)
@@ -212,6 +213,7 @@ def import_config(config, replace_shard=None):
         farm, created = models.Farm.objects.get_or_create(
             name=entry["labels"]["farm"],
             defaults={"source": entry["labels"].get("__farm_source", "pmc")},
+            owner=user,
         )
         if created:
             logger.debug("Created farm %s", farm)
@@ -224,6 +226,7 @@ def import_config(config, replace_shard=None):
             service=service,
             shard=shard,
             defaults={"farm": farm},
+            owner=user,
         )
         if created:
             logger.debug("Created project %s", project)

promgen/signals.py

@@ -281,7 +281,7 @@ def add_user_to_default_group(instance, created, **kwargs):
 def add_email_sender(instance, created, **kwargs):
     if instance.email:
         models.Sender.objects.get_or_create(
-            obj=instance, sender="promgen.notification.email", value=instance.email
+            obj=instance, sender="promgen.notification.email", value=instance.email, owner=instance
         )
     else:
         logger.warning("No email for user %s", instance)

promgen/tests/notification/test_email.py

@@ -13,10 +13,11 @@ class EmailTest(tests.PromgenTest):
     def setUp(self):
         one = models.Project.objects.get(pk=1)
         two = models.Project.objects.get(pk=2)
+        self.user = self.force_login(username="demo")
 
-        NotificationEmail.create(obj=one, value="[email protected]")
-        NotificationEmail.create(obj=one, value="[email protected]")
-        NotificationEmail.create(obj=two, value="[email protected]")
+        NotificationEmail.create(obj=one, value="[email protected]", owner=self.user)
+        NotificationEmail.create(obj=one, value="[email protected]", owner=self.user)
+        NotificationEmail.create(obj=two, value="[email protected]", owner=self.user)
 
     @override_settings(PROMGEN=tests.SETTINGS)
     @override_settings(CELERY_TASK_ALWAYS_EAGER=True)

promgen/tests/notification/test_linenotify.py

@@ -13,9 +13,10 @@ class LineNotifyTest(tests.PromgenTest):
     def setUp(self):
         one = models.Project.objects.get(pk=1)
         two = models.Service.objects.get(pk=2)
+        self.user = self.force_login(username="demo")
 
-        NotificationLineNotify.create(obj=one, value="hogehoge")
-        NotificationLineNotify.create(obj=two, value="asdfasdf")
+        NotificationLineNotify.create(obj=one, value="hogehoge", owner=self.user)
+        NotificationLineNotify.create(obj=two, value="asdfasdf", owner=self.user)
 
     @override_settings(PROMGEN=tests.SETTINGS)
     @override_settings(CELERY_TASK_ALWAYS_EAGER=True)

promgen/tests/notification/test_slack.py

@@ -16,9 +16,10 @@ class SlackTest(tests.PromgenTest):
     def setUp(self):
         one = models.Project.objects.get(pk=1)
         two = models.Service.objects.get(pk=2)
+        self.user = self.force_login(username="demo")
 
-        NotificationSlack.create(obj=one, value=self.TestHook1)
-        NotificationSlack.create(obj=two, value=self.TestHook2)
+        NotificationSlack.create(obj=one, value=self.TestHook1, owner=self.user)
+        NotificationSlack.create(obj=two, value=self.TestHook2, owner=self.user)
 
     @override_settings(PROMGEN=tests.SETTINGS)
     @override_settings(CELERY_TASK_ALWAYS_EAGER=True)

promgen/tests/notification/test_user_email.py

@@ -12,16 +12,19 @@
 
 
 class UserSplayTest(tests.PromgenTest):
+    def setUp(self):
+        self.user = self.force_login(username="demo")
+
     @override_settings(PROMGEN=tests.SETTINGS)
     @override_settings(CELERY_TASK_ALWAYS_EAGER=True)
     @mock.patch("promgen.notification.email.send_mail")
     @mock.patch("promgen.util.post")
     def test_user_splay(self, mock_email, mock_post):
         one = models.Service.objects.get(pk=1)
 
-        NotificationUser.create(obj=one, value=one.owner.username)
-        NotificationLineNotify.create(obj=one.owner, value="#foo")
-        NotificationEmail.create(obj=one.owner, value="[email protected]")
+        NotificationUser.create(obj=one, value=one.owner.username, owner=self.user)
+        NotificationLineNotify.create(obj=one.owner, value="#foo", owner=self.user)
+        NotificationEmail.create(obj=one.owner, value="[email protected]", owner=self.user)
 
         response = self.fireAlert()
         self.assertRoute(response, rest.AlertReceiver, 202)
@@ -41,8 +44,8 @@ def test_failed_user(self, mock_email):
         # The invalid one should be skipped while still letting
         # the valid one pass
         one = models.Service.objects.get(pk=1)
-        NotificationEmail.create(obj=one, value="[email protected]")
-        NotificationUser.create(obj=one, value="does not exist")
+        NotificationEmail.create(obj=one, value="[email protected]", owner=self.user)
+        NotificationUser.create(obj=one, value="does not exist", owner=self.user)
 
         response = self.fireAlert()
         self.assertRoute(response, rest.AlertReceiver, 202)
@@ -58,11 +61,15 @@ def test_enabled(self, mock_email):
         one = models.Service.objects.get(pk=1)
 
         # This notification is direct and disabled
-        NotificationEmail.create(obj=one, value="[email protected]", enabled=False)
+        NotificationEmail.create(
+            obj=one, value="[email protected]", enabled=False, owner=self.user
+        )
         # Our parent notification is enabled
-        NotificationUser.create(obj=one, value=one.owner.username)
+        NotificationUser.create(obj=one, value=one.owner.username, owner=self.user)
         # But the child notifier is disabled and shouldn't fire
-        NotificationEmail.create(obj=one.owner, value="[email protected]", enabled=False)
+        NotificationEmail.create(
+            obj=one.owner, value="[email protected]", enabled=False, owner=self.user
+        )
 
         response = self.fireAlert()
         self.assertRoute(response, rest.AlertReceiver, 202)

promgen/tests/notification/test_webhook.py

@@ -16,10 +16,10 @@ def setUp(self):
         two = models.Service.objects.get(pk=1)
 
         self.senderA = NotificationWebhook.create(
-            obj=one, value="http://webhook.example.com/project"
+            obj=one, value="http://webhook.example.com/project", owner_id=1
         )
         self.senderB = NotificationWebhook.create(
-            obj=two, value="http://webhook.example.com/service"
+            obj=two, value="http://webhook.example.com/service", owner_id=1
         )
 
     @override_settings(PROMGEN=tests.SETTINGS)

promgen/tests/test_cli.py

@@ -13,6 +13,9 @@
 class CLITests(PromgenTest):
     fixtures = ["testcases.yaml", "extras.yaml"]
 
+    def setUp(self):
+        self.user = self.force_login(username="demo")
+
     @mock.patch("promgen.signals._trigger_write_config")
     def test_register_job(self, mock_signal):
         # Assert when project doesn't exist
@@ -38,14 +41,16 @@ def test_register_host(self, mock_signal):
         with self.assertRaises(CommandError):
             management.call_command("register-host", "missing-project", "cli.example.com")
 
-        project = models.Project.objects.create(name="cli-project", service_id=1, shard_id=1)
+        project = models.Project.objects.create(
+            name="cli-project", service_id=1, shard_id=1, owner=self.user
+        )
 
         # Still assert an error if there is no Farm
         with self.assertRaises(CommandError):
             management.call_command("register-host", "cli-project", "cli.example.com")
 
         # Register farm and finally register host
-        project.farm = models.Farm.objects.create(name="cli-farm")
+        project.farm = models.Farm.objects.create(name="cli-farm", owner=self.user)
         project.save()
         management.call_command("register-host", "cli-project", "cli.example.com")
         self.assertCount(models.Host, 2, "Should be a new host registered (1 host from fixture)")

promgen/tests/test_routes.py

@@ -59,11 +59,11 @@ def test_replace(self, mock_write, mock_reload):
     @mock.patch("requests.get")
     def test_scrape(self, mock_get):
         shard = models.Shard.objects.create(name="test_scrape_shard")
-        service = models.Service.objects.create(name="test_scrape_service")
-        farm = models.Farm.objects.create(name="test_scrape_farm")
+        service = models.Service.objects.create(name="test_scrape_service", owner=self.user)
+        farm = models.Farm.objects.create(name="test_scrape_farm", owner=self.user)
         farm.host_set.create(name="example.com")
         project = models.Project.objects.create(
-            name="test_scrape_project", service=service, shard=shard, farm=farm
+            name="test_scrape_project", service=service, shard=shard, farm=farm, owner=self.user
         )
 
         # Uses the scrape target as the key, and the POST body that should

promgen/tests/test_signals.py

@@ -7,14 +7,19 @@
 
 
 class SignalTest(tests.PromgenTest):
+    def setUp(self):
+        self.user = self.force_login(username="demo")
+
     @mock.patch("promgen.models.Audit.log")
     @mock.patch("promgen.signals.trigger_write_config.send")
     def test_write_signal(self, write_mock, log_mock):
         # Create a test farm
-        farm = models.Farm.objects.create(name="farm")
+        farm = models.Farm.objects.create(name="farm", owner=self.user)
         models.Host.objects.create(name="Host", farm=farm)
         # Create a new project or testing
-        project = models.Project.objects.create(name="Project", service_id=1, farm=farm, shard_id=1)
+        project = models.Project.objects.create(
+            name="Project", service_id=1, farm=farm, shard_id=1, owner=self.user
+        )
         e1 = models.Exporter.objects.create(
             job="Exporter 1",
             port=1234,
@@ -35,10 +40,12 @@ def test_write_signal(self, write_mock, log_mock):
     @mock.patch("promgen.signals.trigger_write_config.send")
     def test_write_and_delete(self, write_mock, log_mock):
         # Create a test farm
-        farm = models.Farm.objects.create(name="farm")
+        farm = models.Farm.objects.create(name="farm", owner=self.user)
         models.Host.objects.create(name="Host", farm=farm)
 
-        project = models.Project.objects.create(name="Project", service_id=1, farm=farm, shard_id=1)
+        project = models.Project.objects.create(
+            name="Project", service_id=1, farm=farm, shard_id=1, owner=self.user
+        )
         # Farm but no exporters so no call
         self.assertEqual(write_mock.call_count, 0, "Should not be called without exporters")
 

promgen/views.py

@@ -1013,7 +1013,7 @@ def post(self, request, *args, **kwargs):
         try:
             body = json.loads(request.body.decode("utf-8"))
 
-            prometheus.import_config(body, **kwargs)
+            prometheus.import_config(body, self.request.user, **kwargs)
         except Exception as e:
             return HttpResponse(e, status=400)
 
@@ -1328,7 +1328,9 @@ def form_valid(self, form):
         if data.get("shard"):
             kwargs["replace_shard"] = data.get("shard")
 
-        imported, skipped = prometheus.import_config(json.loads(config), **kwargs)
+        imported, skipped = prometheus.import_config(
+            json.loads(config), self.request.user, **kwargs
+        )
 
         if imported:
             counters = {key: len(imported[key]) for key in imported}