fix: char set validators (#154)

* add validators

* validators

* read only

* delete unnecessary comment

* clean up

* delete codecov.yml

* support unicode

* fix regex validations

* unicode tests

* fix linting error

* fix tests

* fix linting errors

* test ascii does not include unicode

* feedback

* class_access_code_validators

* regex validator test case

Author: SKairinos

.github/workflows/main.yml

@@ -29,6 +29,8 @@ jobs:
     if: |
       github.repository_owner_id == 2088731 &&
       github.ref_name == github.event.repository.default_branch
+    env:
+      CONFIG: releaserc.toml
     steps:
       - name: 🛫 Checkout
         uses: actions/checkout@v4
@@ -59,7 +61,7 @@ jobs:
         run: |
           PYTHON_SCRIPT="from codeforlife import __version__; print(__version__)"
           echo OLD_VERSION=$(python -c "$PYTHON_SCRIPT") >> $GITHUB_ENV
-          semantic-release version
+          semantic-release --config=${{ env.CONFIG }} version
           echo NEW_VERSION=$(python -c "$PYTHON_SCRIPT") >> $GITHUB_ENV
 
       - name: 🏗️ Build Distributions
@@ -70,7 +72,7 @@ jobs:
         if: env.OLD_VERSION != env.NEW_VERSION
         env:
           GH_TOKEN: ${{ secrets.CFL_BOT_GH_TOKEN }}
-        run: semantic-release publish
+        run: semantic-release --config=${{ env.CONFIG }} publish
 
       - name: 🚀 Publish to PyPI
         if: env.OLD_VERSION != env.NEW_VERSION

.vscode/settings.json

@@ -8,7 +8,7 @@
   },
   "black-formatter.args": [
     "--config",
-    "pyproject.toml"
+    "../configs/backend/pyproject.toml"
   ],
   "black-formatter.path": [
     ".venv/bin/python",
@@ -37,23 +37,23 @@
     "**/__pycache__": true
   },
   "isort.args": [
-    "--settings-file=pyproject.toml"
+    "--settings-file=../configs/backend/pyproject.toml"
   ],
   "isort.path": [
     ".venv/bin/python",
     "-m",
     "isort"
   ],
   "mypy-type-checker.args": [
-    "--config-file=pyproject.toml"
+    "--config-file=../configs/backend/pyproject.toml"
   ],
   "mypy-type-checker.path": [
     ".venv/bin/python",
     "-m",
     "mypy"
   ],
   "pylint.args": [
-    "--rcfile=pyproject.toml"
+    "--rcfile=../configs/backend/pyproject.toml"
   ],
   "pylint.path": [
     ".venv/bin/python",
@@ -65,7 +65,7 @@
     "-n=auto",
     "--cov=.",
     "--cov-report=html",
-    "-c=pyproject.toml",
+    "-c=../configs/backend/pyproject.toml",
     "."
   ],
   "python.testing.pytestEnabled": true,

Pipfile

@@ -18,6 +18,7 @@ django-storages = {version = "==1.14.4", extras = ["s3"]}
 pyotp = "==2.9.0"
 python-dotenv = "==1.0.1"
 psycopg2-binary = "==2.9.9"
+regex = "==2024.11.6"
 requests = "==2.32.2"
 gunicorn = "==23.0.0"
 uvicorn-worker = "==0.2.0"
@@ -48,6 +49,7 @@ isort = "==5.13.2"
 mypy = "==1.6.1"
 django-stubs = {version = "==4.2.6", extras = ["compatible-mypy"]}
 djangorestframework-stubs = {version = "==3.14.4", extras = ["compatible-mypy"]}
+types-regex = "==2024.11.6.*"
 
 [requires]
 python_version = "3.12"

Pipfile.lock

@@ -28,7 +28,6 @@
 SERVICE_PORT = int(os.getenv("SERVICE_PORT", "8000"))
 
 # The base url of the current service.
-# The root service does not need its name included in the base url.
 SERVICE_BASE_URL = f"{SERVICE_PROTOCOL}://{SERVICE_DOMAIN}:{SERVICE_PORT}"
 
 # The domain without the last level and a preceding dot.

codecov.yml

@@ -21,3 +21,4 @@
 from .model_view_set import BaseModelViewSetTestCase, ModelViewSetTestCase
 from .model_view_set_client import BaseModelViewSetClient, ModelViewSetClient
 from .test import Client, TestCase
+from .validator import RegexValidatorTestCase, ValidatorTestCase

codeforlife/settings/custom.py

@@ -0,0 +1,30 @@
+"""
+© Ocado Group
+Created on 14/03/2025 at 10:04:16(+00:00).
+"""
+
+import typing as t
+
+from django.core.validators import RegexValidator
+
+from .test import TestCase
+
+AnyValidator = t.TypeVar("AnyValidator", bound=t.Callable)
+AnyRegexValidator = t.TypeVar("AnyRegexValidator", bound=RegexValidator)
+
+
+class ValidatorTestCase(TestCase, t.Generic[AnyValidator]):
+    """Test case with utilities for testing validators."""
+
+    validator_class: t.Type[AnyValidator]
+
+
+class RegexValidatorTestCase(
+    ValidatorTestCase[AnyRegexValidator], t.Generic[AnyRegexValidator]
+):
+    """Test case with utilities for testing regex validators."""
+
+    def assert_raises_validation_error(self, *args, **kwargs):
+        return super().assert_raises_validation_error(
+            self.validator_class.code, *args, **kwargs
+        )

codeforlife/tests/__init__.py

@@ -21,6 +21,8 @@
 DataDict = t.Dict[str, t.Any]
 OrderedDataDict = t.OrderedDict[str, t.Any]
 
+Validators = t.Sequence[t.Callable]
+
 
 def get_arg(cls: t.Type[t.Any], index: int, orig_base: int = 0):
     """Get a type arg from a class.

codeforlife/tests/validator.py

@@ -4,9 +4,9 @@
 """
 
 from .auth_factor import AuthFactor
-from .klass import Class
+from .klass import Class, class_name_validators
 from .otp_bypass_token import OtpBypassToken
-from .school import School
+from .school import School, school_name_validators
 from .session import Session
 from .session_auth_factor import SessionAuthFactor
 from .student import Independent, Student
@@ -35,4 +35,6 @@
     TypedUser,
     User,
     UserProfile,
+    user_first_name_validators,
+    user_last_name_validators,
 )

codeforlife/types.py

@@ -5,10 +5,13 @@
 
 import typing as t
 
+from django.core.validators import MaxLengthValidator, MinLengthValidator
 from django.db import models
 from django.db.models.query import QuerySet
 from django.utils.translation import gettext_lazy as _
 
+from ...types import Validators
+from ...validators import AsciiNumericCharSetValidator
 from .user import User
 
 if t.TYPE_CHECKING:  # pragma: no cover
@@ -20,6 +23,12 @@ class AuthFactor(models.Model):
 
     sessions: QuerySet["SessionAuthFactor"]
 
+    otp_validators: Validators = [
+        AsciiNumericCharSetValidator(),
+        MinLengthValidator(6),
+        MaxLengthValidator(6),
+    ]
+
     class Type(models.TextChoices):
         """The type of authentication factor."""
 

codeforlife/user/models/__init__.py

@@ -5,3 +5,22 @@
 
 # pylint: disable-next=unused-import
 from common.models import Class  # type: ignore[import-untyped]
+from django.core.validators import MaxLengthValidator, MinLengthValidator
+
+from ...validators import (
+    UnicodeAlphanumericCharSetValidator,
+    UppercaseAsciiAlphanumericCharSetValidator,
+)
+
+class_access_code_validators = [
+    MinLengthValidator(5),
+    MaxLengthValidator(5),
+    UppercaseAsciiAlphanumericCharSetValidator(),
+]
+
+class_name_validators = [
+    UnicodeAlphanumericCharSetValidator(
+        spaces=True,
+        special_chars="-_",
+    )
+]

codeforlife/user/models/auth_factor.py

@@ -8,11 +8,14 @@
 
 from cryptography.fernet import Fernet
 from django.conf import settings
+from django.core.validators import MaxLengthValidator, MinLengthValidator
 from django.db import models
 from django.db.utils import IntegrityError
 from django.utils.crypto import get_random_string
 from django.utils.translation import gettext_lazy as _
 
+from ...types import Validators
+from ...validators import CharSetValidatorBuilder
 from .user import User
 
 if t.TYPE_CHECKING:
@@ -29,6 +32,14 @@ class OtpBypassToken(models.Model):
     length = 8
     allowed_chars = string.ascii_lowercase
     max_count = 10
+    validators: Validators = [
+        MinLengthValidator(length),
+        MaxLengthValidator(length),
+        CharSetValidatorBuilder(
+            allowed_chars,
+            "lowercase alpha characters (a-z)",
+        ),
+    ]
 
     # pylint: disable-next=missing-class-docstring,too-few-public-methods
     class Manager(models.Manager["OtpBypassToken"]):

codeforlife/user/models/klass.py

@@ -5,3 +5,12 @@
 
 # pylint: disable-next=unused-import
 from common.models import School  # type: ignore[import-untyped]
+
+from ...validators import UnicodeAlphanumericCharSetValidator
+
+school_name_validators = [
+    UnicodeAlphanumericCharSetValidator(
+        spaces=True,
+        special_chars="'.",
+    )
+]

codeforlife/user/models/otp_bypass_token.py

@@ -20,6 +20,7 @@
 
 from ... import mail
 from ...models import AbstractBaseUser
+from ...validators import UnicodeAlphanumericCharSetValidator
 from .klass import Class
 from .school import School
 
@@ -35,6 +36,21 @@
     TypedModelMeta = object
 
 
+# TODO: add to model validators in new schema.
+user_first_name_validators = [
+    UnicodeAlphanumericCharSetValidator(
+        spaces=True,
+        special_chars="-'",
+    )
+]
+user_last_name_validators = [
+    UnicodeAlphanumericCharSetValidator(
+        spaces=True,
+        special_chars="-'",
+    )
+]
+
+
 # TODO: remove in new schema
 class _AbstractBaseUser(AbstractBaseUser):
     password: str = None  # type: ignore[assignment]

codeforlife/user/models/school.py

@@ -8,6 +8,7 @@
 from ...serializers import ModelSerializer
 from ..models import Class
 from ..models import User as RequestUser
+from ..models import class_name_validators
 
 # pylint: disable=missing-class-docstring
 # pylint: disable=too-many-ancestors
@@ -19,6 +20,13 @@ class ClassSerializer(ModelSerializer[RequestUser, Class]):
         read_only=True,
     )
 
+    # TODO: add to model validators in new schema.
+    name = serializers.CharField(
+        validators=class_name_validators,
+        max_length=200,
+        read_only=True,
+    )
+
     read_classmates_data = serializers.BooleanField(
         source="classmates_data_viewable",
         read_only=True,

codeforlife/user/models/user.py

@@ -8,12 +8,20 @@
 from ...serializers import ModelSerializer
 from ..models import School
 from ..models import User as RequestUser
+from ..models import school_name_validators
 
 # pylint: disable=missing-class-docstring
 # pylint: disable=too-many-ancestors
 
 
 class SchoolSerializer(ModelSerializer[RequestUser, School]):
+    # TODO: add to model validators in new schema.
+    name = serializers.CharField(
+        validators=school_name_validators,
+        max_length=200,
+        read_only=True,
+    )
+
     uk_county = serializers.CharField(source="county", read_only=True)
 
     class Meta:

codeforlife/user/serializers/klass.py

@@ -8,7 +8,14 @@
 from rest_framework import serializers
 
 from ...serializers import ModelSerializer
-from ..models import AnyUser, Student, Teacher, User
+from ..models import (
+    AnyUser,
+    Student,
+    Teacher,
+    User,
+    user_first_name_validators,
+    user_last_name_validators,
+)
 from .student import StudentSerializer
 from .teacher import TeacherSerializer
 
@@ -21,6 +28,20 @@
 class BaseUserSerializer(
     ModelSerializer[RequestUser, AnyUser], t.Generic[AnyUser]
 ):
+    # TODO: add to model validators in new schema.
+    first_name = serializers.CharField(
+        validators=user_first_name_validators,
+        max_length=150,
+        read_only=True,
+    )
+
+    # TODO: add to model validators in new schema.
+    last_name = serializers.CharField(
+        validators=user_last_name_validators,
+        max_length=150,
+        read_only=True,
+    )
+
     requesting_to_join_class = serializers.CharField(
         source="new_student.pending_class_request",
         read_only=True,

codeforlife/user/serializers/school.py

@@ -17,6 +17,7 @@ class SchoolViewSet(ModelViewSet[User, School]):
     http_method_names = ["get"]
     serializer_class = SchoolSerializer
 
+    # pylint: disable-next=missing-function-docstring
     def get_permissions(self):
         # No one is allowed to list schools.
         if self.action == "list":

codeforlife/user/serializers/user.py

@@ -0,0 +1,7 @@
+"""
+© Ocado Group
+Created on 14/03/2025 at 08:33:12(+00:00).
+"""
+
+from .char_set import *
+from .enhanced_regex import EnhancedRegexValidator