Add form validation for the issue_tracker_id value #350

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

workflow/admin.py

@@ -11,13 +11,15 @@
 from django.contrib import messages
 from django.contrib.admin.utils import unquote
 from django.core.exceptions import PermissionDenied
+from django.core.exceptions import ValidationError
 from django.template.defaultfilters import pluralize
 from django.utils.translation import gettext as _
 
 from dje.admin import DataspacedAdmin
 from dje.admin import dejacode_site
 from dje.forms import DataspacedAdminForm
 from workflow.inlines import QuestionInline
+from workflow.integrations import is_valid_issue_tracker_id
 from workflow.models import Priority
 from workflow.models import RequestTemplate
 
@@ -56,6 +58,21 @@ class PriorityAdmin(DataspacedAdmin):
     save_as = False
 
 
+class RequestTemplateAdminForm(DataspacedAdminForm):
+    def clean_issue_tracker_id(self):
+        issue_tracker_id = self.cleaned_data.get("issue_tracker_id")
+        if issue_tracker_id and not is_valid_issue_tracker_id(issue_tracker_id):
+            raise ValidationError(
+                [
+                    "Invalid issue tracker URL format. Supported formats include:",
+                    "• GitHub: https://github.com/ORG/REPO_NAME",
+                    "• GitLab: https://gitlab.com/GROUP/PROJECT_NAME",
+                    "• Jira: https://YOUR_DOMAIN.atlassian.net/projects/PROJECTKEY",
+                ]
+            )
+        return issue_tracker_id
+
+
 @admin.register(RequestTemplate, site=dejacode_site)
 class RequestTemplateAdmin(DataspacedAdmin):
     list_display = (
@@ -75,6 +92,7 @@ class RequestTemplateAdmin(DataspacedAdmin):
         "include_applies_to",
         "include_product",
     )
+    form = RequestTemplateAdminForm
     inlines = (QuestionInline,)
     actions = [
         "copy_to",

workflow/integrations/__init__.py

@@ -6,6 +6,8 @@
 # See https://aboutcode.org for more information about AboutCode FOSS projects.
 #
 
+import re
+
 from workflow.integrations.base import BaseIntegration
 from workflow.integrations.github import GitHubIntegration
 from workflow.integrations.gitlab import GitLabIntegration
@@ -16,9 +18,31 @@
     "GitHubIntegration",
     "GitLabIntegration",
     "JiraIntegration",
+    "is_valid_issue_tracker_id",
+    "get_class_for_tracker",
+    "get_class_for_platform",
 ]
 
 
+GITHUB_PATTERN = re.compile(r"^https://github\.com/[^/]+/[^/]+/?$")
+
+GITLAB_PATTERN = re.compile(r"^https://gitlab\.com/[^/]+/[^/]+/?$")
+
+JIRA_PATTERN = re.compile(
+    r"^https://[a-zA-Z0-9.-]+\.atlassian\.net/(?:projects|jira/software/projects)/[A-Z][A-Z0-9]+"
+)
+
+ISSUE_TRACKER_PATTERNS = [
+    GITHUB_PATTERN,
+    GITLAB_PATTERN,
+    JIRA_PATTERN,
+]
+
+
+def is_valid_issue_tracker_id(issue_tracker_id):
+    return any(pattern.match(issue_tracker_id) for pattern in ISSUE_TRACKER_PATTERNS)
+
+
 def get_class_for_tracker(issue_tracker_id):
     if "github.com" in issue_tracker_id:
         return GitHubIntegration

workflow/tests/test_integrations.py

@@ -14,12 +14,54 @@
 
 from dje.models import Dataspace
 from dje.tests import create_superuser
+from workflow.integrations import JiraIntegration
+from workflow.integrations import get_class_for_platform
+from workflow.integrations import get_class_for_tracker
+from workflow.integrations import is_valid_issue_tracker_id
 from workflow.integrations.github import GitHubIntegration
 from workflow.integrations.gitlab import GitLabIntegration
 from workflow.models import Question
 from workflow.models import RequestTemplate
 
 
+class WorkflowIntegrationsTestCase(TestCase):
+    def test_is_valid_issue_tracker_id(self):
+        valid_urls = [
+            "https://github.com/org/repo",
+            "https://gitlab.com/group/project",
+            "https://aboutcode.atlassian.net/projects/PROJ",
+            "https://aboutcode.atlassian.net/jira/software/projects/PROJ",
+        ]
+        for url in valid_urls:
+            with self.subTest(url=url):
+                self.assertTrue(is_valid_issue_tracker_id(url))
+
+        invalid_urls = [
+            "https://bitbucket.org/team/repo",
+            "https://github.com/",
+            "https://gitlab.com/",
+            "https://atlassian.net/projects/",
+            "https://example.com",
+        ]
+        for url in invalid_urls:
+            with self.subTest(url=url):
+                self.assertFalse(is_valid_issue_tracker_id(url))
+
+    def test_get_class_for_tracker(self):
+        self.assertIs(get_class_for_tracker("https://github.com/org/repo"), GitHubIntegration)
+        self.assertIs(get_class_for_tracker("https://gitlab.com/group/project"), GitLabIntegration)
+        self.assertIs(
+            get_class_for_tracker("https://aboutcode.atlassian.net/projects/PROJ"), JiraIntegration
+        )
+        self.assertIsNone(get_class_for_tracker("https://example.com"))
+
+    def test_get_class_for_platform(self):
+        self.assertIs(get_class_for_platform("github"), GitHubIntegration)
+        self.assertIs(get_class_for_platform("gitlab"), GitLabIntegration)
+        self.assertIs(get_class_for_platform("jira"), JiraIntegration)
+        self.assertIsNone(get_class_for_platform("example"))
+
+
 class GitHubIntegrationTestCase(TestCase):
     def setUp(self):
         patcher = mock.patch("workflow.models.Request.handle_integrations", return_value=None)