chore(models): add procfile_type check

Author: duanhongyi

rootfs/api/migrations/0008_alter_domain_procfile_type_alter_route_procfile_type_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.10 on 2024-05-15 04:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0007_domain_procfile_type'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='domain',
+            name='procfile_type',
+            field=models.CharField(max_length=63),
+        ),
+        migrations.AlterField(
+            model_name='route',
+            name='procfile_type',
+            field=models.CharField(max_length=63),
+        ),
+        migrations.AlterField(
+            model_name='service',
+            name='procfile_type',
+            field=models.CharField(max_length=63),
+        ),
+    ]

rootfs/api/models/app.py

@@ -25,20 +25,18 @@
 from api.utils import generate_app_name, apply_tasks
 from scheduler import KubeHTTPException, KubeException
 from scheduler.resources.pod import DEFAULT_CONTAINER_PORT
-from .gateway import Gateway, Route, DEFAULT_HTTP_PORT
+from .gateway import Gateway, Route
 from .limit import LimitPlan
 from .config import Config
 from .service import Service
 from .release import Release
 from .tls import TLS
 from .appsettings import AppSettings
 from .volume import Volume
-from .base import UuidAuditedModel
+from .base import UuidAuditedModel, PROCFILE_TYPE_WEB, PROCFILE_TYPE_RUN, DEFAULT_HTTP_PORT
 
 User = get_user_model()
 logger = logging.getLogger(__name__)
-PROCFILE_TYPE_WEB = "web"
-PROCFILE_TYPE_RUN = "run"
 
 
 # http://kubernetes.io/v1.1/docs/design/identifiers.html

rootfs/api/models/base.py

@@ -27,6 +27,12 @@
         "access_token", "expires_in", "token_type", "scope", "refresh_token"
     ],
 }
+PROCFILE_TYPE_WEB = "web"
+PROCFILE_TYPE_RUN = "run"
+DEFAULT_HTTP_PORT = 80
+DEFAULT_HTTPS_PORT = 443
+PROCFILE_TYPE_MIN_LENGTH = 3
+PROCFILE_TYPE_MAX_LENGTH = 63
 
 
 def get_anonymous_user_instance(user): return user(id=-1, username=settings.ANONYMOUS_USER_NAME)

rootfs/api/models/domain.py

@@ -1,7 +1,7 @@
 from django.db import models
 from django.db import transaction
 from django.contrib.auth import get_user_model
-from .base import AuditedModel
+from .base import AuditedModel, PROCFILE_TYPE_MAX_LENGTH
 
 User = get_user_model()
 
@@ -21,7 +21,7 @@ class Domain(AuditedModel):
         blank=True,
         null=True
     )
-    procfile_type = models.TextField()
+    procfile_type = models.CharField(max_length=PROCFILE_TYPE_MAX_LENGTH)
 
     class Meta:
         ordering = ['domain', 'certificate']

rootfs/api/models/gateway.py

@@ -8,12 +8,10 @@
 from api.exceptions import ServiceUnavailable
 from scheduler import KubeException
 
-from .base import AuditedModel
+from .base import AuditedModel, DEFAULT_HTTP_PORT, DEFAULT_HTTPS_PORT, PROCFILE_TYPE_MAX_LENGTH
 
 User = get_user_model()
 logger = logging.getLogger(__name__)
-DEFAULT_HTTP_PORT = 80
-DEFAULT_HTTPS_PORT = 443
 
 TLS_PROTOCOLS = ("HTTPS", "TLS")
 HOSTNAME_PROTOCOLS = TLS_PROTOCOLS + ("HTTP", )
@@ -190,7 +188,7 @@ class Route(AuditedModel):
     rules = models.JSONField(default=list)
     routable = models.BooleanField(default=True)
     parent_refs = models.JSONField(default=list)
-    procfile_type = models.TextField()
+    procfile_type = models.CharField(max_length=PROCFILE_TYPE_MAX_LENGTH)
 
     @property
     def protocols(self):

rootfs/api/models/service.py

@@ -6,7 +6,7 @@
 from api.utils import validate_json
 from api.exceptions import ServiceUnavailable
 from scheduler import KubeException
-from .base import AuditedModel
+from .base import AuditedModel, PROCFILE_TYPE_MAX_LENGTH
 
 
 User = get_user_model()
@@ -34,7 +34,7 @@ class Service(AuditedModel):
     ports = models.JSONField(
         default=list, validators=[partial(validate_json, schema=service_ports_schema)])
     canary = models.BooleanField(default=False)
-    procfile_type = models.TextField()
+    procfile_type = models.CharField(max_length=PROCFILE_TYPE_MAX_LENGTH)
 
     class Meta:
         get_latest_by = 'created'

rootfs/api/serializers/__init__.py

@@ -17,6 +17,7 @@
 from api import models
 from api.utils import validate_json
 from api.exceptions import DryccException
+from api.models.base import PROCFILE_TYPE_MIN_LENGTH, PROCFILE_TYPE_MAX_LENGTH
 from scheduler.resources.pod import DEFAULT_CONTAINER_PORT
 from .schemas.rules import SCHEMA as RULES_SCHEMA
 from .schemas.volumes import SCHEMA as VOLUMES_SCHEMA
@@ -69,6 +70,16 @@
 HEALTHCHECK_MISMATCH_MSG = "Healthcheck pattern: %s" % HEALTHCHECK_MATCH.pattern
 
 
+def validate_procfile_type(value):
+    if not re.match(PROCTYPE_MATCH, value):
+        raise serializers.ValidationError(PROCTYPE_MISMATCH_MSG)
+    if len(value) < PROCFILE_TYPE_MIN_LENGTH or len(value) > PROCFILE_TYPE_MAX_LENGTH:
+        raise serializers.ValidationError(
+            "The length of procfile_type must be between {} and {}".format(
+                PROCFILE_TYPE_MIN_LENGTH, PROCFILE_TYPE_MAX_LENGTH))
+    return value
+
+
 class JSONFieldSerializer(serializers.JSONField):
     def __init__(self, *args, **kwargs):
         self.convert_to_str = kwargs.pop('convert_to_str', True)
@@ -199,16 +210,17 @@ def validate_procfile(data):
         for key, value in data.items():
             if value is None or value == "":
                 raise serializers.ValidationError("Command can't be empty for process type")
-
-            if not re.match(PROCTYPE_MATCH, key):
-                raise serializers.ValidationError(PROCTYPE_MISMATCH_MSG)
-
+            validate_procfile_type(key)
         return data
 
     @staticmethod
     def validate_dryccfile(data):
         if data:
-            return validate_json(data, DRYCCFILE_SCHEMA, serializers.ValidationError)
+            validate_json(data, DRYCCFILE_SCHEMA, serializers.ValidationError)
+            procfile_types = set().union(data.get("deploy", {}).keys())
+            procfile_types = procfile_types.union(data.get("build", {}).get("docker", {}).keys())
+            for procfile_type in procfile_types:
+                validate_procfile_type(procfile_type)
         return data
 
 
@@ -460,12 +472,7 @@ def ToACE(x): return idna.alabel(x).decode("utf-8", "strict")
 
         return aceValue
 
-    @staticmethod
-    def validate_procfile_type(value):
-        if not re.match(PROCTYPE_MATCH, value):
-            raise serializers.ValidationError(PROCTYPE_MISMATCH_MSG)
-
-        return value
+    validate_procfile_type = staticmethod(validate_procfile_type)
 
 
 class ServiceSerializer(serializers.ModelSerializer):
@@ -502,12 +509,7 @@ def validate_protocol(value):
     def validate_target_port(cls, value):
         return cls.validate_port(value)
 
-    @staticmethod
-    def validate_procfile_type(value):
-        if not re.match(PROCTYPE_MATCH, value):
-            raise serializers.ValidationError(PROCTYPE_MISMATCH_MSG)
-
-        return value
+    validate_procfile_type = staticmethod(validate_procfile_type)
 
 
 class CertificateSerializer(serializers.ModelSerializer):
@@ -719,12 +721,7 @@ def validate_protocol(value):
             raise serializers.ValidationError(GATEWAY_PROTOCOL_MISMATCH_MSG)
         return value
 
-    @staticmethod
-    def validate_procfile_type(value):
-        if not re.match(PROCTYPE_MATCH, value):
-            raise serializers.ValidationError(PROCTYPE_MISMATCH_MSG)
-
-        return value
+    validate_procfile_type = staticmethod(validate_procfile_type)
 
 
 class RouteSerializer(serializers.Serializer):
@@ -751,12 +748,7 @@ def validate_kind(value):
             raise serializers.ValidationError(ROUTE_PROTOCOL_MISMATCH_MSG)
         return value
 
-    @staticmethod
-    def validate_procfile_type(value):
-        if not re.match(PROCTYPE_MATCH, value):
-            raise serializers.ValidationError(PROCTYPE_MISMATCH_MSG)
-
-        return value
+    validate_procfile_type = staticmethod(validate_procfile_type)
 
     @staticmethod
     def validate_rules(value):

rootfs/api/tests/test_app.py

@@ -15,7 +15,8 @@
 from django.core.cache import cache
 from django.test.utils import override_settings
 
-from api.models.app import App, PROCFILE_TYPE_WEB
+from api.models.app import App
+from api.models.base import PROCFILE_TYPE_WEB
 from api.models.config import Config
 from scheduler import KubeException, KubeHTTPException
 

rootfs/api/tests/test_build.py

@@ -11,7 +11,8 @@
 from unittest import mock
 
 from api.models.build import Build
-from api.models.app import App, PROCFILE_TYPE_WEB
+from api.models.app import App
+from api.models.base import PROCFILE_TYPE_WEB
 from scheduler import KubeException
 
 from api.tests import adapter, DryccTransactionTestCase

rootfs/api/tests/test_certificate_use_case_1.py

@@ -1,7 +1,8 @@
 from django.contrib.auth import get_user_model
 from django.core.cache import cache
 
-from api.models.app import App, PROCFILE_TYPE_WEB
+from api.models.app import App
+from api.models.base import PROCFILE_TYPE_WEB
 from api.models.certificate import Certificate
 from api.models.domain import Domain
 from api.tests import TEST_ROOT, DryccTestCase