feat(GitLab): Add GitLab to Project Integrations (#7239)

Author: emyller

api/app/settings/common.py

@@ -154,6 +154,7 @@
     "integrations.flagsmith",
     "integrations.launch_darkly",
     "integrations.github",
+    "integrations.gitlab",
     "integrations.grafana",
     # Rate limiting admin endpoints
     "axes",

api/integrations/gitlab/__init__.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class GitLabIntegrationConfig(AppConfig):
+    name = "integrations.gitlab"

api/integrations/gitlab/apps.py

@@ -0,0 +1,69 @@
+# Generated by Django 5.2.13
+
+import uuid
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("projects", "0028_add_enforce_feature_owners_to_project"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="GitLabConfiguration",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "deleted_at",
+                    models.DateTimeField(
+                        blank=True,
+                        db_index=True,
+                        default=None,
+                        editable=False,
+                        null=True,
+                    ),
+                ),
+                (
+                    "uuid",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        unique=True,
+                    ),
+                ),
+                (
+                    "gitlab_instance_url",
+                    models.URLField(max_length=200),
+                ),
+                (
+                    "access_token",
+                    models.CharField(max_length=300),
+                ),
+                (
+                    "project",
+                    models.OneToOneField(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="gitlab_config",
+                        to="projects.project",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+    ]

api/integrations/gitlab/migrations/0001_initial.py

@@ -0,0 +1,13 @@
+from django.db import models
+
+from core.models import SoftDeleteExportableModel
+
+
+class GitLabConfiguration(SoftDeleteExportableModel):
+    project = models.OneToOneField(
+        "projects.Project",
+        on_delete=models.CASCADE,
+        related_name="gitlab_config",
+    )
+    gitlab_instance_url = models.URLField(max_length=200)
+    access_token = models.CharField(max_length=300)

api/integrations/gitlab/migrations/__init__.py

@@ -0,0 +1,17 @@
+from typing import Any
+
+from integrations.common.serializers import BaseProjectIntegrationModelSerializer
+from integrations.gitlab.models import GitLabConfiguration
+
+WRITE_ONLY_PLACEHOLDER = "write-only"
+
+
+class GitLabConfigurationSerializer(BaseProjectIntegrationModelSerializer):
+    class Meta:
+        model = GitLabConfiguration
+        fields = ("id", "gitlab_instance_url", "access_token")
+
+    def to_representation(self, instance: GitLabConfiguration) -> dict[str, Any]:
+        data = super().to_representation(instance)
+        data["access_token"] = WRITE_ONLY_PLACEHOLDER
+        return data

api/integrations/gitlab/models.py

@@ -0,0 +1,42 @@
+import structlog
+
+from integrations.common.views import ProjectIntegrationBaseViewSet
+from integrations.gitlab.models import GitLabConfiguration
+from integrations.gitlab.serializers import GitLabConfigurationSerializer
+
+logger = structlog.get_logger("gitlab")
+
+
+class GitLabConfigurationViewSet(ProjectIntegrationBaseViewSet):
+    serializer_class = GitLabConfigurationSerializer  # type: ignore[assignment]
+    model_class = GitLabConfiguration  # type: ignore[assignment]
+    pagination_class = None
+
+    def _log_for(
+        self, instance: GitLabConfiguration
+    ) -> structlog.typing.FilteringBoundLogger:
+        return logger.bind(  # type: ignore[no-any-return]
+            project__id=instance.project.id,
+            organisation__id=instance.project.organisation_id,
+        )
+
+    def perform_create(self, serializer: GitLabConfigurationSerializer) -> None:  # type: ignore[override]
+        super().perform_create(serializer)
+        instance: GitLabConfiguration = serializer.instance  # type: ignore[assignment]
+        self._log_for(instance).info(
+            "gitlab-configuration-created",
+            gitlab_instance_url=instance.gitlab_instance_url,
+        )
+
+    def perform_update(self, serializer: GitLabConfigurationSerializer) -> None:  # type: ignore[override]
+        super().perform_update(serializer)
+        instance: GitLabConfiguration = serializer.instance  # type: ignore[assignment]
+        self._log_for(instance).info(
+            "gitlab-configuration-updated",
+            gitlab_instance_url=instance.gitlab_instance_url,
+        )
+
+    def perform_destroy(self, instance: GitLabConfiguration) -> None:
+        log = self._log_for(instance)
+        super().perform_destroy(instance)
+        log.info("gitlab-configuration-deleted")

api/integrations/gitlab/serializers.py

@@ -19,6 +19,7 @@
 from features.multivariate.views import MultivariateFeatureOptionViewSet
 from features.views import FeatureViewSet
 from integrations.datadog.views import DataDogConfigurationViewSet
+from integrations.gitlab.views import GitLabConfigurationViewSet
 from integrations.grafana.views import GrafanaProjectConfigurationViewSet
 from integrations.launch_darkly.views import LaunchDarklyImportRequestViewSet
 from integrations.new_relic.views import NewRelicConfigurationViewSet
@@ -65,6 +66,11 @@
     LaunchDarklyImportRequestViewSet,
     basename="imports-launch-darkly",
 )
+projects_router.register(
+    r"integrations/gitlab",
+    GitLabConfigurationViewSet,
+    basename="integrations-gitlab",
+)
 projects_router.register(
     r"integrations/grafana",
     GrafanaProjectConfigurationViewSet,