feat/PRWLR-3999 Implement providers endpoints (#21)

* feat(Backend): PRWLR-3989 add RLS to postgresql db and base models

* feat(API): PRWLR-3989 add TenantMiddleware

* chore(API, Backend): PRWLR-3989 create new db user without RLS bypass on migrations

* chore(Backend): PRWLR-3989 fix RLS bypasser for POST requests

* fix(Backend): PRWLR-3989 fix user permissions when migrating new models

* chore(Backend): PRWLR-3989 add testing view for RLS manual tests

* feat(API): PRWLR-3989 add tenant_id to API logging

* chore(API, Backend): PRWLR-3989 add TODOs

* test(API): PRWLR-3989 add new middleware unit tests

* chore(API): PRWLR-3989 refactor RLS code

* fix(tests): PRWLR-3989 fix testing db connector

* chore: PRWLR-3989 add references to JIRA tickets

* fix: PRWLR-3989 remove bypass logic and fix serializers

* fix: PRWLR-3989 improve drop SQL query for RLS models

* feat(Backend): PRWLR-3989 add specific permissions on each model

* fix(Backend): PRWLR-3989 fix database routing and grant select perms

* fix(test): PRWLR-3989 fix routing issues with unit tests

* chore: PRWLR-3989 remove references to JIRA tickets

* feat(Backend): PRWLR-3999 add Provider model

* feat: PRWLR-3999 add providers view logic

* fix: PRWLR-3999 fix unique index fields

* feat(API): PRWLR-3999 add custom exception handlers

* feat(API): PRWLR-3999 add /providers/{provider_id}/connection endpoint

* test(API): PRWLR-3999 add base unit tests for providers

* fix(API, Backend): PRWLR-3999 fix bugs after rebase

* chore(API, docker): PRWLR-3999 add dev feats for demo

* feat(API): PRWLR-3999 add drf-spectacular-jsonapi and improve docs

* test(API): PRWLR-3999 add providers unit tests

* chore(Backend): PRWLR-3989 adjust privileges for user on table tenant

* chore: PRWLR-3999 rename model custom validation error

* chore: PRWLR-3999 remove Test references

* chore: PRWLR-3999 update API v1 spec

* fix: PRWLR-3999 apply requested changes to filter and models

* feat: PRWLR-3999 add validation to PATCH /providers payload

* fix: PRWLR-3999 fix providers enum description

* chore: add more providers fixtures

* fix: PRWLR-3999 make providers.alias optional

src/backend/api/models.py

@@ -1,17 +1,96 @@
+import re
+from uuid import uuid4, UUID
+
+from django.core.validators import MinLengthValidator
 from django.db import models
+from django.utils.translation import gettext_lazy as _
 
-from api.rls import RowLevelSecurityProtectedModel, RowLevelSecurityConstraint
+from api.exceptions import ModelValidationError
+from api.rls import RowLevelSecurityConstraint
+from api.rls import RowLevelSecurityProtectedModel
 
 
-class Test(RowLevelSecurityProtectedModel):
-    name = models.CharField(max_length=100)
+class Provider(RowLevelSecurityProtectedModel):
+    class ProviderChoices(models.TextChoices):
+        AWS = "aws", _("AWS")
+        AZURE = "azure", _("Azure")
+        GCP = "gcp", _("GCP")
+        KUBERNETES = "kubernetes", _("Kubernetes")
 
-    class Meta:
-        db_table = "test"
+    @staticmethod
+    def validate_aws_provider_id(value):
+        if not re.match(r"^\d{12}$", value):
+            raise ModelValidationError(
+                detail="AWS provider ID must be exactly 12 digits.",
+                code="aws-provider-id",
+                pointer="/data/attributes/provider_id",
+            )
+
+    @staticmethod
+    def validate_azure_provider_id(value):
+        try:
+            val = UUID(value, version=4)
+            if str(val) != value:
+                raise ValueError
+        except ValueError:
+            raise ModelValidationError(
+                detail="Azure provider ID must be a valid UUID.",
+                code="azure-provider-id",
+                pointer="/data/attributes/provider_id",
+            )
+
+    @staticmethod
+    def validate_gcp_provider_id(value):
+        if not re.match(r"^[a-z][a-z0-9-]{5,29}$", value):
+            raise ModelValidationError(
+                detail="GCP provider ID must be 6 to 30 characters, start with a letter, and contain only lowercase "
+                "letters, numbers, and hyphens.",
+                code="gcp-provider-id",
+                pointer="/data/attributes/provider_id",
+            )
+
+    @staticmethod
+    def validate_kubernetes_provider_id(value):
+        if not re.match(r"^[a-z0-9]([-a-z0-9]{1,61}[a-z0-9])?$", value):
+            raise ModelValidationError(
+                detail="K8s provider ID must be up to 63 characters, start and end with a lowercase letter or number, "
+                "and contain only lowercase alphanumeric characters and hyphens.",
+                code="kubernetes-provider-id",
+                pointer="/data/attributes/provider_id",
+            )
+
+    id = models.UUIDField(primary_key=True, default=uuid4, editable=False)
+    inserted_at = models.DateTimeField(auto_now_add=True, editable=False)
+    updated_at = models.DateTimeField(auto_now=True, editable=False)
+    provider = models.CharField(
+        max_length=10, choices=ProviderChoices.choices, default=ProviderChoices.AWS
+    )
+    provider_id = models.CharField(max_length=63, validators=[MinLengthValidator(3)])
+    alias = models.CharField(
+        blank=True, null=True, max_length=100, validators=[MinLengthValidator(3)]
+    )
+    connected = models.BooleanField(null=True, blank=True)
+    connection_last_checked_at = models.DateTimeField(null=True, blank=True)
+    metadata = models.JSONField(default=dict, blank=True)
+    scanner_args = models.JSONField(default=dict, blank=True)
+
+    def clean(self):
+        super().clean()
+        getattr(self, f"validate_{self.provider}_provider_id")(self.provider_id)
+
+    def save(self, *args, **kwargs):
+        self.full_clean()
+        super().save(*args, **kwargs)
+
+    class Meta(RowLevelSecurityProtectedModel.Meta):
         constraints = [
+            models.UniqueConstraint(
+                fields=("tenant_id", "provider", "provider_id"),
+                name="unique_provider_ids",
+            ),
             RowLevelSecurityConstraint(
                 field="tenant_id",
                 name="rls_on_%(class)s",
                 statements=["SELECT", "INSERT", "UPDATE", "DELETE"],
-            )
+            ),
         ]