[#293] add whitespace like validation for tokens

src/openklant/components/token/models.py

@@ -2,14 +2,20 @@
 from django.utils.translation import gettext_lazy as _
 
 from openklant.components.token.utils import get_token
+from openklant.components.token.validators import validate_non_empty_chars
 
 
 class TokenAuth(models.Model):
     identifier = models.SlugField(
         unique=True, help_text=_("A human-friendly label to refer to this token")
     )
 
-    token = models.CharField(_("token"), max_length=40, unique=True)
+    token = models.CharField(
+        _("token"),
+        max_length=40,
+        unique=True,
+        validators=[validate_non_empty_chars]
+    )
 
     contact_person = models.CharField(
         _("contact person"),

src/openklant/components/token/tests/test_validators.py

@@ -0,0 +1,39 @@
+from django.core.exceptions import ValidationError
+from django.test import SimpleTestCase
+
+from openklant.components.token.validators import validate_non_empty_chars
+
+
+class WhiteSpaceValidatorTestCase(SimpleTestCase):
+    def test_characters_only(self):
+        self.assertIsNone(validate_non_empty_chars("test123"))
+
+    def test_trailing_whitespace(self):
+        self.assertIsNone(validate_non_empty_chars("test123  "))
+
+    def test_leading_whitespace(self):
+        self.assertIsNone(validate_non_empty_chars("  test123"))
+
+    def test_whitespace_in_between(self):
+        self.assertIsNone(validate_non_empty_chars("test  123"))
+
+    def test_whitespace_only(self):
+        with self.assertRaises(ValidationError):
+            validate_non_empty_chars("  ")
+
+    def test_trailing_tab_character(self):
+        self.assertIsNone(validate_non_empty_chars("test123\t"))
+
+    def test_leading_tab_character(self):
+        self.assertIsNone(validate_non_empty_chars("\ttest123"))
+
+    def test_tab_character_in_between(self):
+        self.assertIsNone(validate_non_empty_chars("test\t123"))
+
+    def test_tab_characters_only(self):
+        with self.assertRaises(ValidationError):
+            validate_non_empty_chars("\t\t")
+
+    def test_blank_value(self):
+        with self.assertRaises(ValidationError):
+            validate_non_empty_chars("")

src/openklant/components/token/validators.py

@@ -0,0 +1,24 @@
+import re
+
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext as _
+
+
+# includes tabs, carriage returns, newlines, form-feeds and vertical whitespace characters
+ALL_WHITESPACE_PATTERN = re.compile(r"^\s*$")
+
+
+def validate_non_empty_chars(value: str) -> None:
+    if not value:
+        raise ValidationError(
+            code="invalid",
+            message=_("Blank values are not allowed")
+        )
+
+    if ALL_WHITESPACE_PATTERN.match(value):
+        raise ValidationError(
+            code="all-whitespace",
+            message=_(
+                "Tokens cannot consistent exclusively out of whitespace-like characters"
+            )
+        )