wip cicd split

dogboat · dogboat · commit fa3ce1bf7ae7 · 2026-06-09T15:53:45.000-04:00
diff --git a/dojo/api_v2/serializers.py b/dojo/api_v2/serializers.py
@@ -49,6 +49,7 @@
     App_Analysis,
     BurpRawRequestResponse,
     Check_List,
+    CICDInfrastructure,
     Development_Environment,
     Dojo_User,
     DojoMeta,
@@ -811,6 +812,12 @@ class Meta:
         fields = "__all__"
 
 
+class CICDInfrastructureSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = CICDInfrastructure
+        fields = "__all__"
+
+
 class ToolTypeSerializer(serializers.ModelSerializer):
     class Meta:
         model = Tool_Type
diff --git a/dojo/api_v2/views.py b/dojo/api_v2/views.py
@@ -86,6 +86,7 @@
     App_Analysis,
     BurpRawRequestResponse,
     Check_List,
+    CICDInfrastructure,
     Development_Environment,
     Dojo_User,
     DojoMeta,
@@ -2209,6 +2210,19 @@ def get_queryset(self):
 
 
 # Authorization: configuration
+class CICDInfrastructureViewSet(
+    DojoModelViewSet,
+):
+    serializer_class = serializers.CICDInfrastructureSerializer
+    queryset = CICDInfrastructure.objects.none()
+    filter_backends = (DjangoFilterBackend,)
+    filterset_fields = ["id", "name", "infrastructure_type"]
+    permission_classes = (permissions.UserHasConfigurationPermissionSuperuser,)
+
+    def get_queryset(self):
+        return CICDInfrastructure.objects.all().order_by("id")
+
+
 class ToolTypesViewSet(
     DojoModelViewSet,
 ):
diff --git a/dojo/db_migrations/0264_cicd_infrastructure.py b/dojo/db_migrations/0264_cicd_infrastructure.py
@@ -0,0 +1,131 @@
+import logging
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+logger = logging.getLogger(__name__)
+
+
+def migrate_tool_configs_to_cicd_infrastructure(apps, schema_editor):
+    """
+    For each Tool_Configuration referenced by an engagement's build_server,
+    source_code_management_server, or orchestration_engine FK, create a
+    CICDInfrastructure record and point the new engagement FK to it.
+    """
+    Engagement = apps.get_model("dojo", "Engagement")
+    CICDInfrastructure = apps.get_model("dojo", "CICDInfrastructure")
+
+    field_mappings = [
+        ("build_server", "cicd_build_server", "build_server"),
+        ("source_code_management_server", "cicd_scm_server", "scm_server"),
+        ("orchestration_engine", "cicd_orchestration_engine", "orchestration"),
+    ]
+
+    for old_field, new_field, infra_type in field_mappings:
+        engagements_with_old_fk = Engagement.objects.filter(
+            **{f"{old_field}__isnull": False},
+        ).select_related(old_field)
+
+        for engagement in engagements_with_old_fk:
+            tc = getattr(engagement, old_field)
+            if tc is None:
+                continue
+
+            cicd_infra, created = CICDInfrastructure.objects.get_or_create(
+                name=tc.name,
+                infrastructure_type=infra_type,
+                defaults={
+                    "description": tc.description or "",
+                    "url": tc.url or "",
+                },
+            )
+            if created:
+                logger.info(
+                    "Created CICDInfrastructure '%s' (type=%s) from Tool_Configuration '%s'",
+                    cicd_infra.name, infra_type, tc.name,
+                )
+
+            setattr(engagement, new_field, cicd_infra)
+            engagement.save(update_fields=[new_field])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("dojo", "0263_language_type_unique_language"),
+    ]
+
+    operations = [
+        # Step 1: Create CICDInfrastructure model
+        migrations.CreateModel(
+            name="CICDInfrastructure",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("name", models.CharField(max_length=200)),
+                ("description", models.CharField(blank=True, max_length=2000, null=True)),
+                ("url", models.URLField(blank=True, help_text="Public URL of the tool (e.g., https://jenkins.company.com)", max_length=2000, null=True)),
+                ("infrastructure_type", models.CharField(choices=[("build_server", "Build Server"), ("scm_server", "SCM Server"), ("orchestration", "Orchestration Engine")], max_length=30)),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+        ),
+        # Step 2: Add new FK fields to Engagement (before removing old ones)
+        migrations.AddField(
+            model_name="engagement",
+            name="cicd_build_server",
+            field=models.ForeignKey(
+                blank=True, null=True,
+                help_text="Build server used for this CI/CD engagement",
+                limit_choices_to={"infrastructure_type": "build_server"},
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="engagements_as_build_server",
+                to="dojo.cicdinfrastructure",
+                verbose_name="Build Server",
+            ),
+        ),
+        migrations.AddField(
+            model_name="engagement",
+            name="cicd_scm_server",
+            field=models.ForeignKey(
+                blank=True, null=True,
+                help_text="Source code management server used for this CI/CD engagement",
+                limit_choices_to={"infrastructure_type": "scm_server"},
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="engagements_as_scm_server",
+                to="dojo.cicdinfrastructure",
+                verbose_name="SCM Server",
+            ),
+        ),
+        migrations.AddField(
+            model_name="engagement",
+            name="cicd_orchestration_engine",
+            field=models.ForeignKey(
+                blank=True, null=True,
+                help_text="Orchestration engine used for this CI/CD engagement",
+                limit_choices_to={"infrastructure_type": "orchestration"},
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="engagements_as_orchestration",
+                to="dojo.cicdinfrastructure",
+                verbose_name="Orchestration Engine",
+            ),
+        ),
+        # Step 3: Migrate data from Tool_Configuration to CICDInfrastructure
+        migrations.RunPython(
+            migrate_tool_configs_to_cicd_infrastructure,
+            reverse_code=migrations.RunPython.noop,
+        ),
+        # Step 4: Remove old FK fields from Engagement
+        migrations.RemoveField(
+            model_name="engagement",
+            name="build_server",
+        ),
+        migrations.RemoveField(
+            model_name="engagement",
+            name="source_code_management_server",
+        ),
+        migrations.RemoveField(
+            model_name="engagement",
+            name="orchestration_engine",
+        ),
+    ]
diff --git a/dojo/engagement/views.py b/dojo/engagement/views.py
@@ -1606,8 +1606,8 @@ def get_excludes():
 
 
 def get_foreign_keys():
-    return ["build_server", "lead", "orchestration_engine", "preset", "product",
-        "report_type", "requester", "source_code_management_server"]
+    return ["cicd_build_server", "cicd_orchestration_engine", "cicd_scm_server",
+        "lead", "preset", "product", "report_type", "requester"]
 
 
 def csv_export(request):
diff --git a/dojo/forms.py b/dojo/forms.py
@@ -1058,10 +1058,10 @@ def __init__(self, *args, **kwargs):
             del self.fields["build_id"]
             del self.fields["commit_hash"]
             del self.fields["branch_tag"]
-            del self.fields["build_server"]
-            del self.fields["source_code_management_server"]
+            del self.fields["cicd_build_server"]
+            del self.fields["cicd_scm_server"]
             # del self.fields['source_code_management_uri']
-            del self.fields["orchestration_engine"]
+            del self.fields["cicd_orchestration_engine"]
         else:
             del self.fields["test_strategy"]
             del self.fields["status"]
diff --git a/dojo/models.py b/dojo/models.py
@@ -1337,6 +1337,25 @@ def __str__(self):
         return self.name
 
 
+class CICDInfrastructure(models.Model):
+    INFRASTRUCTURE_TYPE_CHOICES = (
+        ("build_server", "Build Server"),
+        ("scm_server", "SCM Server"),
+        ("orchestration", "Orchestration Engine"),
+    )
+
+    name = models.CharField(max_length=200)
+    description = models.CharField(max_length=2000, null=True, blank=True)
+    url = models.URLField(max_length=2000, null=True, blank=True, help_text=_("Public URL of the tool (e.g., https://jenkins.company.com)"))
+    infrastructure_type = models.CharField(max_length=30, choices=INFRASTRUCTURE_TYPE_CHOICES)
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+
 class Product_API_Scan_Configuration(models.Model):
     product = models.ForeignKey(Product, null=False, blank=False, on_delete=models.CASCADE)
     tool_configuration = models.ForeignKey(Tool_Configuration, null=False, blank=False, on_delete=models.CASCADE)
@@ -1472,10 +1491,10 @@ class Engagement(BaseModel):
                                    null=True, blank=True, help_text=_("Commit hash from repo"), verbose_name=_("Commit Hash"))
     branch_tag = models.CharField(editable=True, max_length=150,
                                    null=True, blank=True, help_text=_("Tag or branch of the product the engagement tested."), verbose_name=_("Branch/Tag"))
-    build_server = models.ForeignKey(Tool_Configuration, verbose_name=_("Build Server"), help_text=_("Build server responsible for CI/CD test"), null=True, blank=True, related_name="build_server", on_delete=models.CASCADE)
-    source_code_management_server = models.ForeignKey(Tool_Configuration, null=True, blank=True, verbose_name=_("SCM Server"), help_text=_("Source code server for CI/CD test"), related_name="source_code_management_server", on_delete=models.CASCADE)
     source_code_management_uri = models.URLField(max_length=600, null=True, blank=True, editable=True, verbose_name=_("Repo"), help_text=_("Resource link to source code"))
-    orchestration_engine = models.ForeignKey(Tool_Configuration, verbose_name=_("Orchestration Engine"), help_text=_("Orchestration service responsible for CI/CD test"), null=True, blank=True, related_name="orchestration", on_delete=models.CASCADE)
+    cicd_build_server = models.ForeignKey("CICDInfrastructure", null=True, blank=True, related_name="engagements_as_build_server", on_delete=models.SET_NULL, limit_choices_to={"infrastructure_type": "build_server"}, verbose_name=_("Build Server"), help_text=_("Build server used for this CI/CD engagement"))
+    cicd_scm_server = models.ForeignKey("CICDInfrastructure", null=True, blank=True, related_name="engagements_as_scm_server", on_delete=models.SET_NULL, limit_choices_to={"infrastructure_type": "scm_server"}, verbose_name=_("SCM Server"), help_text=_("Source code management server used for this CI/CD engagement"))
+    cicd_orchestration_engine = models.ForeignKey("CICDInfrastructure", null=True, blank=True, related_name="engagements_as_orchestration", on_delete=models.SET_NULL, limit_choices_to={"infrastructure_type": "orchestration"}, verbose_name=_("Orchestration Engine"), help_text=_("Orchestration engine used for this CI/CD engagement"))
     deduplication_on_engagement = models.BooleanField(default=False, verbose_name=_("Deduplication within this engagement only"), help_text=_("If enabled deduplication will only mark a finding in this engagement as duplicate of another finding if both findings are in this engagement. If disabled, deduplication is on the product level."))
 
     tags = TagField(blank=True, force_lowercase=True, help_text=_("Add tags that help describe this engagement. Choose from the list or add new tags. Press Enter key to add."))
diff --git a/dojo/urls.py b/dojo/urls.py
@@ -16,6 +16,7 @@
     AppAnalysisViewSet,
     BurpRawRequestResponseViewSet,
     CeleryViewSet,
+    CICDInfrastructureViewSet,
     ConfigurationPermissionViewSet,
     DevelopmentEnvironmentViewSet,
     DojoMetaViewSet,
@@ -152,6 +153,7 @@
 v2_api.register(r"tests", TestsViewSet, basename="test")
 v2_api.register(r"test_types", TestTypesViewSet, basename="test_type")
 v2_api.register(r"test_imports", TestImportViewSet, basename="test_imports")
+v2_api.register(r"cicd_infrastructure", CICDInfrastructureViewSet, basename="cicd_infrastructure")
 v2_api.register(r"tool_configurations", ToolConfigurationsViewSet, basename="tool_configuration")
 v2_api.register(r"tool_product_settings", ToolProductSettingsViewSet, basename="tool_product_settings")
 v2_api.register(r"tool_types", ToolTypesViewSet, basename="tool_type")
