Refactor the integrations module organization #350

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

Author: tdruez

workflow/integrations/__init__.py

@@ -6,69 +6,31 @@
 # See https://aboutcode.org for more information about AboutCode FOSS projects.
 #
 
-from django.conf import settings
-
-import requests
-
-DEJACODE_SITE_URL = settings.SITE_URL.rstrip("/")
-
-
-class BaseIntegration:
-    """Base class for managing issue tracker integrations from DejaCode requests."""
-
-    default_timeout = 10
-
-    def __init__(self, dataspace):
-        if not dataspace:
-            raise ValueError("Dataspace must be provided.")
-        self.dataspace = dataspace
-        self.session = self.get_session()
-
-    def get_session(self):
-        session = requests.Session()
-        session.headers.update(self.get_headers())
-        return session
-
-    def get_headers(self):
-        """
-        Return authentication headers specific to the integration.
-        Must be implemented in subclasses.
-        """
-        raise NotImplementedError
-
-    @staticmethod
-    def make_issue_title(request):
-        return f"[DEJACODE] {request.title}"
-
-    @staticmethod
-    def make_issue_body(request):
-        request_url = f"{DEJACODE_SITE_URL}{request.get_absolute_url()}"
-        label_fields = [
-            ("📝 Request Template", request.request_template),
-            ("📦 Product Context", request.product_context),
-            ("📌 Applies To", request.content_object),
-            ("🙋 Submitted By", request.requester),
-            ("👤 Assigned To", request.assignee),
-            ("🚨 Priority", request.priority),
-            ("🗒️ Notes", request.notes),
-            ("🔗️ DejaCode URL", request_url),
-        ]
-
-        lines = []
-        for label, value in label_fields:
-            if value:
-                lines.append(f"### {label}\n{value}")
-
-        lines.append("----")
-
-        for question in request.get_serialized_data_as_list():
-            label = question.get("label")
-            value = question.get("value")
-            input_type = question.get("input_type")
-
-            if input_type == "BooleanField":
-                value = "Yes" if str(value).lower() in ("1", "true", "yes") else "No"
-
-            lines.append(f"### {label}\n{value}")
-
-        return "\n\n".join(lines)
+from workflow.integrations.base import BaseIntegration
+from workflow.integrations.github import GitHubIntegration
+from workflow.integrations.gitlab import GitLabIntegration
+from workflow.integrations.jira import JiraIntegration
+
+__all__ = [
+    "BaseIntegration",
+    "GitHubIntegration",
+    "GitLabIntegration",
+    "JiraIntegration",
+]
+
+
+def get_class_for_tracker(issue_tracker_id):
+    if "github.com" in issue_tracker_id:
+        return GitHubIntegration
+    elif "gitlab.com" in issue_tracker_id:
+        return GitLabIntegration
+    elif "atlassian.net" in issue_tracker_id:
+        return JiraIntegration
+
+
+def get_class_for_platform(platform):
+    return {
+        "github": GitHubIntegration,
+        "gitlab": GitLabIntegration,
+        "jira": JiraIntegration,
+    }.get(platform)

workflow/integrations/base.py

@@ -0,0 +1,74 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# DejaCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: AGPL-3.0-only
+# See https://github.com/aboutcode-org/dejacode for support or download.
+# See https://aboutcode.org for more information about AboutCode FOSS projects.
+#
+
+from django.conf import settings
+
+import requests
+
+DEJACODE_SITE_URL = settings.SITE_URL.rstrip("/")
+
+
+class BaseIntegration:
+    """Base class for managing issue tracker integrations from DejaCode requests."""
+
+    default_timeout = 10
+
+    def __init__(self, dataspace):
+        if not dataspace:
+            raise ValueError("Dataspace must be provided.")
+        self.dataspace = dataspace
+        self.session = self.get_session()
+
+    def get_session(self):
+        session = requests.Session()
+        session.headers.update(self.get_headers())
+        return session
+
+    def get_headers(self):
+        """
+        Return authentication headers specific to the integration.
+        Must be implemented in subclasses.
+        """
+        raise NotImplementedError
+
+    @staticmethod
+    def make_issue_title(request):
+        return f"[DEJACODE] {request.title}"
+
+    @staticmethod
+    def make_issue_body(request):
+        request_url = f"{DEJACODE_SITE_URL}{request.get_absolute_url()}"
+        label_fields = [
+            ("📝 Request Template", request.request_template),
+            ("📦 Product Context", request.product_context),
+            ("📌 Applies To", request.content_object),
+            ("🙋 Submitted By", request.requester),
+            ("👤 Assigned To", request.assignee),
+            ("🚨 Priority", request.priority),
+            ("🗒️ Notes", request.notes),
+            ("🔗️ DejaCode URL", request_url),
+        ]
+
+        lines = []
+        for label, value in label_fields:
+            if value:
+                lines.append(f"### {label}\n{value}")
+
+        lines.append("----")
+
+        for question in request.get_serialized_data_as_list():
+            label = question.get("label")
+            value = question.get("value")
+            input_type = question.get("input_type")
+
+            if input_type == "BooleanField":
+                value = "Yes" if str(value).lower() in ("1", "true", "yes") else "No"
+
+            lines.append(f"### {label}\n{value}")
+
+        return "\n\n".join(lines)

workflow/integrations/github.py

@@ -8,7 +8,7 @@
 
 from urllib.parse import urlparse
 
-from workflow.integrations import BaseIntegration
+from workflow.integrations.base import BaseIntegration
 
 GITHUB_API_URL = "https://api.github.com"
 

workflow/integrations/gitlab.py

@@ -9,7 +9,7 @@
 from urllib.parse import quote
 from urllib.parse import urlparse
 
-from workflow.integrations import BaseIntegration
+from workflow.integrations.base import BaseIntegration
 
 GITLAB_API_URL = "https://gitlab.com/api/v4"
 

workflow/integrations/jira.py

@@ -10,7 +10,7 @@
 import re
 from urllib.parse import urlparse
 
-from workflow.integrations import BaseIntegration
+from workflow.integrations.base import BaseIntegration
 
 JIRA_API_PATH = "/rest/api/3"
 

workflow/models.py

@@ -39,9 +39,7 @@
 from dje.models import HistoryDateFieldsMixin
 from dje.models import HistoryFieldsMixin
 from dje.models import get_unsecured_manager
-from workflow.integrations.github import GitHubIntegration
-from workflow.integrations.gitlab import GitLabIntegration
-from workflow.integrations.jira import JiraIntegration
+from workflow import integrations
 from workflow.notification import request_comment_slack_payload
 from workflow.notification import request_slack_payload
 
@@ -139,12 +137,7 @@ def icon_css_class(self):
 
     @property
     def integration_class(self):
-        if self.platform == self.Platform.GITHUB:
-            return GitHubIntegration
-        elif self.platform == self.Platform.GITLAB:
-            return GitLabIntegration
-        elif self.platform == self.Platform.JIRA:
-            return JiraIntegration
+        return integrations.get_class_for_platform(self.platform)
 
 
 class RequestQuerySet(DataspacedQuerySet):
@@ -626,12 +619,9 @@ def handle_integrations(self):
         if not issue_tracker_id:
             return
 
-        if "github.com" in issue_tracker_id:
-            GitHubIntegration(dataspace=self.dataspace).sync(request=self)
-        elif "gitlab.com" in issue_tracker_id:
-            GitLabIntegration(dataspace=self.dataspace).sync(request=self)
-        elif "atlassian.net" in issue_tracker_id:
-            JiraIntegration(dataspace=self.dataspace).sync(request=self)
+        integration_class = integrations.get_class_for_tracker(issue_tracker_id)
+        if integration_class:
+            integration_class(dataspace=self.dataspace).sync(request=self)
 
 
 @receiver(models.signals.post_delete, sender=Request)