feat: add resource iteration events (see https://docs.gitlab.com/ee/api/resource_iteration_events.html)

Oliver Blasius · nejch · commit ef5feb4d0795 · 2022-12-04T11:20:03.000+01:00
diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst
@@ -203,6 +203,10 @@ Get the list of participants::
 
     users = issue.participants()
 
+Get the list of iteration events::
+
+    iteration_events = issue.resource_iteration_events.list()
+
 Issue links
 ===========
 
diff --git a/gitlab/v4/objects/events.py b/gitlab/v4/objects/events.py
@@ -15,6 +15,8 @@
     "ProjectIssueResourceMilestoneEvent",
     "ProjectIssueResourceMilestoneEventManager",
     "ProjectIssueResourceStateEvent",
+    "ProjectIssueResourceIterationEventManager",
+    "ProjectIssueResourceIterationEvent",
     "ProjectIssueResourceStateEventManager",
     "ProjectMergeRequestResourceLabelEvent",
     "ProjectMergeRequestResourceLabelEventManager",
@@ -116,6 +118,23 @@ def get(
         )
 
 
+class ProjectIssueResourceIterationEvent(RESTObject):
+    pass
+
+
+class ProjectIssueResourceIterationEventManager(RetrieveMixin, RESTManager):
+    _path = "/projects/{project_id}/issues/{issue_iid}/resource_iteration_events"
+    _obj_cls = ProjectIssueResourceIterationEvent
+    _from_parent_attrs = {"project_id": "project_id", "issue_iid": "iid"}
+
+    def get(
+        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
+    ) -> ProjectIssueResourceIterationEvent:
+        return cast(
+            ProjectIssueResourceIterationEvent, super().get(id=id, lazy=lazy, **kwargs)
+        )
+
+
 class ProjectMergeRequestResourceLabelEvent(RESTObject):
     pass
 
diff --git a/gitlab/v4/objects/issues.py b/gitlab/v4/objects/issues.py
@@ -23,6 +23,7 @@
 from .award_emojis import ProjectIssueAwardEmojiManager  # noqa: F401
 from .discussions import ProjectIssueDiscussionManager  # noqa: F401
 from .events import (  # noqa: F401
+    ProjectIssueResourceIterationEventManager,
     ProjectIssueResourceLabelEventManager,
     ProjectIssueResourceMilestoneEventManager,
     ProjectIssueResourceStateEventManager,
@@ -119,6 +120,7 @@ class ProjectIssue(
     resourcelabelevents: ProjectIssueResourceLabelEventManager
     resourcemilestoneevents: ProjectIssueResourceMilestoneEventManager
     resourcestateevents: ProjectIssueResourceStateEventManager
+    resource_iteration_events: ProjectIssueResourceIterationEventManager
 
     @cli.register_custom_action("ProjectIssue", ("to_project_id",))
     @exc.on_http_error(exc.GitlabUpdateError)
diff --git a/tests/unit/objects/test_resource_iteration_events.py b/tests/unit/objects/test_resource_iteration_events.py
@@ -0,0 +1,55 @@
+"""
+GitLab API: https://docs.gitlab.com/ee/api/resource_iteration_events.html
+"""
+
+import pytest
+import responses
+
+from gitlab.v4.objects import ProjectIssueResourceIterationEvent
+
+issue_event_content = {"id": 1, "resource_type": "Issue"}
+
+
+@pytest.fixture()
+def resp_list_project_issue_iteration_events():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.GET,
+            url="http://localhost/api/v4/projects/1/issues/1/resource_iteration_events",
+            json=[issue_event_content],
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
+@pytest.fixture()
+def resp_get_project_issue_iteration_event():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.GET,
+            url="http://localhost/api/v4/projects/1/issues/1/resource_iteration_events/1",
+            json=issue_event_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
+def test_list_project_issue_iteration_events(
+    project_issue, resp_list_project_issue_iteration_events
+):
+    iteration_events = project_issue.resource_iteration_events.list()
+    assert isinstance(iteration_events, list)
+
+    iteration_event = iteration_events[0]
+    assert isinstance(iteration_event, ProjectIssueResourceIterationEvent)
+    assert iteration_event.resource_type == "Issue"
+
+
+def test_get_project_issue_iteration_event(
+    project_issue, resp_get_project_issue_iteration_event
+):
+    iteration_event = project_issue.resource_iteration_events.get(1)
+    assert isinstance(iteration_event, ProjectIssueResourceIterationEvent)
+    assert iteration_event.resource_type == "Issue"
