Enhance the Jira URL support #350

Signed-off-by: tdruez <[email protected]>

Author: tdruez

workflow/integrations/__init__.py

@@ -29,7 +29,8 @@
 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]+"
+    r"^https://[a-zA-Z0-9.-]+\.atlassian\.net(?:/[^/]+)*"
+    r"/(?:projects|browse)/[A-Z][A-Z0-9]+(?:/[^/]*)*/*$"
 )
 
 ISSUE_TRACKER_PATTERNS = [

workflow/integrations/base.py

@@ -36,6 +36,15 @@ def get_headers(self):
         """
         raise NotImplementedError
 
+    def post(self, url, data):
+        response = self.session.post(
+            url,
+            json=data,
+            timeout=self.default_timeout,
+        )
+        response.raise_for_status()
+        return response.json()
+
     @staticmethod
     def make_issue_title(request):
         return f"[DEJACODE] {request.title}"

workflow/integrations/jira.py

@@ -77,14 +77,7 @@ def create_issue(self, project_key, title, body=""):
                 "issuetype": {"name": "Request"},
             }
         }
-
-        response = self.session.post(
-            url,
-            json=data,
-            timeout=self.default_timeout,
-        )
-        response.raise_for_status()
-        return response.json()
+        return self.post(url, data)
 
     def update_issue(self, issue_id, title=None, body=None, status=None):
         """Update an existing Jira issue."""
@@ -112,17 +105,9 @@ def update_issue(self, issue_id, title=None, body=None, status=None):
     def post_comment(self, repo_id, issue_id, comment_body):
         """Post a comment on an existing Jira issue."""
         api_url = repo_id.rstrip("/") + JIRA_API_PATH
-
         url = f"{api_url}/issue/{issue_id}/comment"
         data = {"body": markdown_to_adf(comment_body)}
-
-        response = self.session.post(
-            url,
-            json=data,
-            timeout=self.default_timeout,
-        )
-        response.raise_for_status()
-        return response.json()
+        return self.post(url, data)
 
     def transition_issue(self, issue_id, target_status_name):
         """Transition a Jira issue to a new status by name."""
@@ -138,12 +123,8 @@ def transition_issue(self, issue_id, target_status_name):
         else:
             raise ValueError(f"No transition found for status '{target_status_name}'")
 
-        response = self.session.post(
-            transitions_url,
-            json={"transition": {"id": transition_id}},
-            timeout=self.default_timeout,
-        )
-        response.raise_for_status()
+        data = {"transition": {"id": transition_id}}
+        return self.post(transitions_url, data)
 
     @staticmethod
     def extract_jira_info(url):
@@ -153,6 +134,7 @@ def extract_jira_info(url):
         - https://<domain>.atlassian.net/projects/PROJECTKEY
         - https://<domain>.atlassian.net/browse/PROJECTKEY
         - https://<domain>.atlassian.net/jira/software/projects/PROJECTKEY/...
+        - https://<domain>.atlassian.net/jira/servicedesk/projects/PROJECTKEY/...
         """
         parsed = urlparse(url)
         if not parsed.netloc.endswith("atlassian.net"):
@@ -161,7 +143,7 @@ def extract_jira_info(url):
         base_url = f"{parsed.scheme}://{parsed.netloc}"
         path = parsed.path
 
-        project_key_pattern = r"/(?:projects|browse|jira/software/projects)/([A-Z][A-Z0-9]+)"
+        project_key_pattern = r"/(?:[^/]+/)*(?:projects|browse)/([A-Z][A-Z0-9]+)"
         match = re.search(project_key_pattern, path)
         if match:
             return base_url, match.group(1)

workflow/tests/test_integrations.py

@@ -25,16 +25,24 @@
 
 
 class WorkflowIntegrationsTestCase(TestCase):
-    def test_is_valid_issue_tracker_id(self):
+    def test_integrations_is_valid_issue_tracker_id(self):
         valid_urls = [
+            # GitHub
             "https://github.com/org/repo",
+            # GitLab
             "https://gitlab.com/group/project",
+            # Jira
+            "https://aboutcode.atlassian.net/browse/PROJ",
             "https://aboutcode.atlassian.net/projects/PROJ",
+            "https://aboutcode.atlassian.net/projects/PROJ/",
+            "https://aboutcode.atlassian.net/projects/PROJ/summary",
             "https://aboutcode.atlassian.net/jira/software/projects/PROJ",
+            "https://aboutcode.atlassian.net/jira/software/projects/PROJ/",
+            "https://aboutcode.atlassian.net/jira/software/projects/PROJ/summary",
+            "https://aboutcode.atlassian.net/jira/servicedesk/projects/PROJ",
         ]
         for url in valid_urls:
-            with self.subTest(url=url):
-                self.assertTrue(is_valid_issue_tracker_id(url))
+            self.assertTrue(is_valid_issue_tracker_id(url), msg=url)
 
         invalid_urls = [
             "https://bitbucket.org/team/repo",
@@ -44,18 +52,17 @@ def test_is_valid_issue_tracker_id(self):
             "https://example.com",
         ]
         for url in invalid_urls:
-            with self.subTest(url=url):
-                self.assertFalse(is_valid_issue_tracker_id(url))
+            self.assertFalse(is_valid_issue_tracker_id(url), msg=url)
 
-    def test_get_class_for_tracker(self):
+    def test_integrations_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):
+    def test_integrations_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)