Additional scheme endpoints for projects (#1295)

Author: Jay Greguske

examples/maintenance.py

@@ -16,11 +16,11 @@
 
 CI_JIRA_URL = os.environ["CI_JIRA_URL"]
 CI_JIRA_ADMIN = os.environ["CI_JIRA_ADMIN"]
-CI_JIRA_ADMIN_PASSWORD = os.environ["CI_JIRA_ADMIN_PASSWORD"]
+CI_JIRA_ADMIN_TOKEN = os.environ["CI_JIRA_ADMIN_TOKEN"]
 
 j = JIRA(
     CI_JIRA_URL,
-    basic_auth=(CI_JIRA_ADMIN, CI_JIRA_ADMIN_PASSWORD),
+    basic_auth=(CI_JIRA_ADMIN, CI_JIRA_ADMIN_TOKEN),
     logging=True,
     validate=True,
     async_=True,

jira/client.py

@@ -68,9 +68,13 @@
     Issue,
     IssueLink,
     IssueLinkType,
+    IssueSecurityLevelScheme,
     IssueType,
+    IssueTypeScheme,
+    NotificationScheme,
     PermissionScheme,
     Priority,
+    PriorityScheme,
     Project,
     RemoteLink,
     RequestType,
@@ -86,6 +90,7 @@
     Version,
     Votes,
     Watchers,
+    WorkflowScheme,
     Worklog,
 )
 from jira.utils import json_loads, threaded_requests
@@ -2133,6 +2138,32 @@ def votes(self, issue: str) -> Votes:
         """
         return self._find_for_resource(Votes, issue)
 
+    @translate_resource_args
+    def project_issue_security_level_scheme(
+        self, project: str
+    ) -> IssueSecurityLevelScheme:
+        """Get a IssueSecurityLevelScheme Resource from the server.
+
+        Args:
+            project (str): ID or key of the project to get the IssueSecurityLevelScheme for
+
+        Returns:
+            IssueSecurityLevelScheme: The issue security level scheme
+        """
+        return self._find_for_resource(IssueSecurityLevelScheme, project)
+
+    @translate_resource_args
+    def project_notification_scheme(self, project: str) -> NotificationScheme:
+        """Get a NotificationScheme Resource from the server.
+
+        Args:
+            project (str): ID or key of the project to get the NotificationScheme for
+
+        Returns:
+            NotificationScheme: The notification scheme
+        """
+        return self._find_for_resource(NotificationScheme, project)
+
     @translate_resource_args
     def project_permissionscheme(self, project: str) -> PermissionScheme:
         """Get a PermissionScheme Resource from the server.
@@ -2146,6 +2177,30 @@ def project_permissionscheme(self, project: str) -> PermissionScheme:
         """
         return self._find_for_resource(PermissionScheme, project)
 
+    @translate_resource_args
+    def project_priority_scheme(self, project: str) -> PriorityScheme:
+        """Get a PriorityScheme Resource from the server.
+
+        Args:
+            project (str): ID or key of the project to get the PriorityScheme for
+
+        Returns:
+            PriorityScheme: The priority scheme
+        """
+        return self._find_for_resource(PriorityScheme, project)
+
+    @translate_resource_args
+    def project_workflow_scheme(self, project: str) -> WorkflowScheme:
+        """Get a WorkflowScheme Resource from the server.
+
+        Args:
+            project (str): ID or key of the project to get the WorkflowScheme for
+
+        Returns:
+            WorkflowScheme: The workflow scheme
+        """
+        return self._find_for_resource(WorkflowScheme, project)
+
     @translate_resource_args
     def add_vote(self, issue: str) -> Response:
         """Register a vote for the current authenticated user on an issue.
@@ -3989,6 +4044,21 @@ def permissionschemes(self):
 
         return data["permissionSchemes"]
 
+    @lru_cache(maxsize=None)
+    def issue_type_schemes(self) -> List[IssueTypeScheme]:
+        """Get all issue type schemes defined (Admin required).
+
+        Returns:
+            List[IssueTypeScheme]: All the Issue Type Schemes available to the currently logged in user.
+        """
+
+        url = self._get_url("issuetypescheme")
+
+        r = self._session.get(url)
+        data: Dict[str, Any] = json_loads(r)
+
+        return data["schemes"]
+
     @lru_cache(maxsize=None)
     def issuesecurityschemes(self):
 
@@ -4075,6 +4145,20 @@ def delete_permissionscheme(self, id: str):
         self.permissionschemes.cache_clear()
         return data
 
+    def get_issue_type_scheme_associations(self, id: str) -> List[Project]:
+        """For the specified issue type scheme, returns all of the associated projects. (Admin required)
+
+        Args:
+            id (str): The issue type scheme id.
+
+        Returns:
+            List[Project]: Associated Projects for the Issue Type Scheme.
+        """
+        url = self._get_url(f"issuetypescheme/{id}/associations")
+        r = self._session.get(url)
+        data = json_loads(r)
+        return data
+
     def create_project(
         self,
         key: str,

jira/resources.py

@@ -42,9 +42,14 @@ class AnyLike:
     "Worklog",
     "IssueLink",
     "IssueLinkType",
+    "IssueSecurityLevelScheme",
     "IssueType",
+    "IssueTypeScheme",
+    "NotificationScheme",
     "Priority",
+    "PriorityScheme",
     "Version",
+    "WorkflowScheme",
     "Role",
     "Resolution",
     "SecurityLevel",
@@ -820,6 +825,40 @@ def __init__(
         self.raw: Dict[str, Any] = cast(Dict[str, Any], self.raw)
 
 
+class IssueTypeScheme(Resource):
+    """An issue type scheme."""
+
+    def __init__(self, options, session, raw=None):
+        Resource.__init__(self, "issuetypescheme", options, session)
+        if raw:
+            self._parse_raw(raw)
+        self.raw: Dict[str, Any] = cast(Dict[str, Any], self.raw)
+
+
+class IssueSecurityLevelScheme(Resource):
+    """IssueSecurityLevelScheme information on an project."""
+
+    def __init__(self, options, session, raw=None):
+        Resource.__init__(
+            self, "project/{0}/issuesecuritylevelscheme?expand=user", options, session
+        )
+        if raw:
+            self._parse_raw(raw)
+        self.raw: Dict[str, Any] = cast(Dict[str, Any], self.raw)
+
+
+class NotificationScheme(Resource):
+    """NotificationScheme information on an project."""
+
+    def __init__(self, options, session, raw=None):
+        Resource.__init__(
+            self, "project/{0}/notificationscheme?expand=user", options, session
+        )
+        if raw:
+            self._parse_raw(raw)
+        self.raw: Dict[str, Any] = cast(Dict[str, Any], self.raw)
+
+
 class PermissionScheme(Resource):
     """Permissionscheme information on an project."""
 
@@ -832,6 +871,30 @@ def __init__(self, options, session, raw=None):
         self.raw: Dict[str, Any] = cast(Dict[str, Any], self.raw)
 
 
+class PriorityScheme(Resource):
+    """PriorityScheme information on an project."""
+
+    def __init__(self, options, session, raw=None):
+        Resource.__init__(
+            self, "project/{0}/priorityscheme?expand=user", options, session
+        )
+        if raw:
+            self._parse_raw(raw)
+        self.raw: Dict[str, Any] = cast(Dict[str, Any], self.raw)
+
+
+class WorkflowScheme(Resource):
+    """WorkflowScheme information on an project."""
+
+    def __init__(self, options, session, raw=None):
+        Resource.__init__(
+            self, "project/{0}/workflowscheme?expand=user", options, session
+        )
+        if raw:
+            self._parse_raw(raw)
+        self.raw: Dict[str, Any] = cast(Dict[str, Any], self.raw)
+
+
 class Watchers(Resource):
     """Watcher information on an issue."""
 
@@ -1428,10 +1491,15 @@ def dict2resource(
     r"issueLink/[^/]+$": IssueLink,
     r"issueLinkType/[^/]+$": IssueLinkType,
     r"issuetype/[^/]+$": IssueType,
+    r"issuetypescheme/[^/]+$": IssueTypeScheme,
+    r"project/[^/]+/issuesecuritylevelscheme[^/]+$": IssueSecurityLevelScheme,
+    r"project/[^/]+/notificationscheme[^/]+$": NotificationScheme,
+    r"project/[^/]+/priorityscheme[^/]+$": PriorityScheme,
     r"priority/[^/]+$": Priority,
     r"project/[^/]+$": Project,
     r"project/[^/]+/role/[^/]+$": Role,
     r"project/[^/]+/permissionscheme[^/]+$": PermissionScheme,
+    r"project/[^/]+/workflowscheme[^/]+$": WorkflowScheme,
     r"resolution/[^/]+$": Resolution,
     r"securitylevel/[^/]+$": SecurityLevel,
     r"status/[^/]+$": Status,

tests/resources/test_issue_type_scheme_associations.py

@@ -0,0 +1,20 @@
+from tests.conftest import JiraTestCase
+
+
+class IssueTypeSchemeAssociationTests(JiraTestCase):
+    def test_scheme_associations(self):
+        all_schemes = self.jira.issue_type_schemes()
+        # there should be more than 1 scheme
+        self.assertGreaterEqual(len(all_schemes), 2)
+        test_pass = False
+        for scheme in all_schemes:
+            associations = self.jira.get_issue_type_scheme_associations(scheme["id"])
+            # As long as one of these schemes is associated with a project-like object
+            # we're probably ok.
+            if len(associations) > 0:
+                self.assertTrue(associations[0].get("id", False))
+                self.assertTrue(associations[0].get("key", False))
+                self.assertTrue(associations[0].get("lead", False))
+                test_pass = True
+                break
+        self.assertTrue(test_pass)

tests/resources/test_project.py

@@ -1,3 +1,4 @@
+from jira import JIRAError
 from tests.conftest import JiraTestCase, find_by_id, rndstr
 
 
@@ -201,6 +202,29 @@ def test_project_roles(self):
         self.assertIn(user.name, [a.name for a in role.actors])
         self.assertIn(actor_admin, [a.name for a in role.actors])
 
-    def test_project_permissionscheme(self):
+    def test_project_permission_scheme(self):
         permissionscheme = self.jira.project_permissionscheme(self.project_b)
         self.assertEqual(permissionscheme.name, "Default Permission Scheme")
+
+    def test_project_priority_scheme(self):
+        priorityscheme = self.jira.project_priority_scheme(self.project_b)
+        self.assertEqual(priorityscheme.name, "Default priority scheme")
+
+    def test_project_notification_scheme(self):
+        notificationscheme = self.jira.project_notification_scheme(self.project_b)
+        self.assertEqual(notificationscheme.name, "Default Notification Scheme")
+
+    def test_project_issue_security_level_scheme(self):
+        # 404s are thrown when a project does not have an issue security scheme
+        # associated with it explicitly. There are no ReST APIs for creating an
+        # issue security scheme programmatically, so there is no way to test
+        # this on the fly.
+        with self.assertRaises(JIRAError):
+            self.jira.project_issue_security_level_scheme(self.project_b)
+
+    def test_project_workflow_scheme(self):
+        workflowscheme = self.jira.project_workflow_scheme(self.project_b)
+        self.assertEqual(
+            workflowscheme.name,
+            f"{self.project_b}: Software Simplified Workflow Scheme",
+        )