From 6516eff584065ed121109b7874cb080f72c5e3cc Mon Sep 17 00:00:00 2001
From: Numerlor <25886452+Numerlor@users.noreply.github.com>
Date: Mon, 3 Aug 2020 22:16:27 +0200
Subject: Add a validator for package names.

Package names are used for stats in the bot and are restricted to
the a-z_ char set, a validator is added to accommodate this restriction
at the site admin side.
---
 pydis_site/apps/api/models/bot/documentation_link.py  |  7 +++++++
 pydis_site/apps/api/tests/test_documentation_links.py | 11 +++++++++++
 2 files changed, 18 insertions(+)

(limited to 'pydis_site/apps/api')

diff --git a/pydis_site/apps/api/models/bot/documentation_link.py b/pydis_site/apps/api/models/bot/documentation_link.py
index 5a46460b..f77d6f38 100644
--- a/pydis_site/apps/api/models/bot/documentation_link.py
+++ b/pydis_site/apps/api/models/bot/documentation_link.py
@@ -1,3 +1,4 @@
+from django.core.validators import RegexValidator
 from django.db import models
 
 from pydis_site.apps.api.models.mixins import ModelReprMixin
@@ -9,6 +10,12 @@ class DocumentationLink(ModelReprMixin, models.Model):
     package = models.CharField(
         primary_key=True,
         max_length=50,
+        validators=(
+            RegexValidator(
+                regex=r"^[a-z_]+$",
+                message="Package names can only consist of lowercase a-z letters and underscores."
+            ),
+        ),
         help_text="The Python package name that this documentation link belongs to."
     )
     base_url = models.URLField(
diff --git a/pydis_site/apps/api/tests/test_documentation_links.py b/pydis_site/apps/api/tests/test_documentation_links.py
index e560a2fd..72e5cadb 100644
--- a/pydis_site/apps/api/tests/test_documentation_links.py
+++ b/pydis_site/apps/api/tests/test_documentation_links.py
@@ -108,6 +108,17 @@ class DetailLookupDocumentationLinkAPITests(APISubdomainTestCase):
 
         self.assertEqual(response.status_code, 400)
 
+    def test_create_invalid_package_name_returns_400(self):
+        test_cases = ("InvalidPackage", "invalid package", "i\u0150valid")
+        for case in test_cases:
+            with self.subTest(package_name=case):
+                body = self.doc_json.copy()
+                body['package'] = case
+                url = reverse('bot:documentationlink-list', host='api')
+                response = self.client.post(url, data=body)
+
+                self.assertEqual(response.status_code, 400)
+
 
 class DocumentationLinkCreationTests(APISubdomainTestCase):
     def setUp(self):
-- 
cgit v1.2.3