Skip to content

Add support to resource label events #625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/gl_objects/labels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Labels
######

Project labels
==============

Reference
---------

Expand Down Expand Up @@ -48,3 +51,39 @@ Manage labels in issues and merge requests::
'labels': ['foo']})
issue.labels.append('bar')
issue.save()

Label events
============

Resource label events keep track about who, when, and which label was added or
removed to an issuable.

Group epic label events are only available in the EE edition.

Reference
---------

* v4 API:

+ :class:`gitlab.v4.objects.ProjectIssueResourceLabelEvent`
+ :class:`gitlab.v4.objects.ProjectIssueResourceLabelEventManager`
+ :attr:`gitlab.v4.objects.ProjectIssue.resourcelabelevents`
+ :class:`gitlab.v4.objects.ProjectMergeRequestResourceLabelEvent`
+ :class:`gitlab.v4.objects.ProjectMergeRequestResourceLabelEventManager`
+ :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcelabelevents`
+ :class:`gitlab.v4.objects.GroupEpicResourceLabelEvent`
+ :class:`gitlab.v4.objects.GroupEpicResourceLabelEventManager`
+ :attr:`gitlab.v4.objects.GroupEpic.resourcelabelevents`

* GitLab API: https://docs.gitlab.com/ee/api/resource_label_events.html

Examples
--------

Get the events for a resource (issue, merge request or epic)::

events = resource.resourcelabelevents.list()

Get a specific event for a resource::

event = resource.resourcelabelevents.get(event_id)
2 changes: 1 addition & 1 deletion docs/gl_objects/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ Delete project push rules::
pr.delete()

Project protected tags
==================
======================

Reference
---------
Expand Down
40 changes: 39 additions & 1 deletion gitlab/v4/objects.py
Original file line number Diff line number Diff line change
Expand Up @@ -662,9 +662,22 @@ def create(self, data, **kwargs):
return self._obj_cls(self, server_data)


class GroupEpicResourceLabelEvent(RESTObject):
pass


class GroupEpicResourceLabelEventManager(RetrieveMixin, RESTManager):
_path = ('/groups/%(group_id)s/epics/%(epic_id)s/resource_label_events')
_obj_cls = GroupEpicResourceLabelEvent
_from_parent_attrs = {'group_id': 'group_id', 'epic_id': 'id'}


class GroupEpic(ObjectDeleteMixin, SaveMixin, RESTObject):
_id_attr = 'iid'
_managers = (('issues', 'GroupEpicIssueManager'),)
_managers = (
('issues', 'GroupEpicIssueManager'),
('resourcelabelevents', 'GroupEpicResourceLabelEventManager'),
)


class GroupEpicManager(CRUDMixin, RESTManager):
Expand Down Expand Up @@ -1803,6 +1816,17 @@ def create(self, data, **kwargs):
return source_issue, target_issue


class ProjectIssueResourceLabelEvent(RESTObject):
pass


class ProjectIssueResourceLabelEventManager(RetrieveMixin, RESTManager):
_path = ('/projects/%(project_id)s/issues/%(issue_iid)s'
'/resource_label_events')
_obj_cls = ProjectIssueResourceLabelEvent
_from_parent_attrs = {'project_id': 'project_id', 'issue_iid': 'iid'}


class ProjectIssue(UserAgentDetailMixin, SubscribableMixin, TodoMixin,
TimeTrackingMixin, ParticipantsMixin, SaveMixin,
ObjectDeleteMixin, RESTObject):
Expand All @@ -1813,6 +1837,7 @@ class ProjectIssue(UserAgentDetailMixin, SubscribableMixin, TodoMixin,
('discussions', 'ProjectIssueDiscussionManager'),
('links', 'ProjectIssueLinkManager'),
('notes', 'ProjectIssueNoteManager'),
('resourcelabelevents', 'ProjectIssueResourceLabelEventManager'),
)

@cli.register_custom_action('ProjectIssue', ('to_project_id',))
Expand Down Expand Up @@ -2086,6 +2111,17 @@ class ProjectMergeRequestDiscussionManager(RetrieveMixin, CreateMixin,
_update_attrs = (('resolved',), tuple())


class ProjectMergeRequestResourceLabelEvent(RESTObject):
pass


class ProjectMergeRequestResourceLabelEventManager(RetrieveMixin, RESTManager):
_path = ('/projects/%(project_id)s/merge_requests/%(mr_iid)s'
'/resource_label_events')
_obj_cls = ProjectMergeRequestResourceLabelEvent
_from_parent_attrs = {'project_id': 'project_id', 'mr_iid': 'iid'}


class ProjectMergeRequest(SubscribableMixin, TodoMixin, TimeTrackingMixin,
ParticipantsMixin, SaveMixin, ObjectDeleteMixin,
RESTObject):
Expand All @@ -2097,6 +2133,8 @@ class ProjectMergeRequest(SubscribableMixin, TodoMixin, TimeTrackingMixin,
('diffs', 'ProjectMergeRequestDiffManager'),
('discussions', 'ProjectMergeRequestDiscussionManager'),
('notes', 'ProjectMergeRequestNoteManager'),
('resourcelabelevents',
'ProjectMergeRequestResourceLabelEventManager'),
)

@cli.register_custom_action('ProjectMergeRequest')
Expand Down
17 changes: 17 additions & 0 deletions tools/python_test_v4.py
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,15 @@
assert(issue1.user_agent_detail()['user_agent'])
assert(issue1.participants())

# issues labels and events
label2 = admin_project.labels.create({'name': 'label2', 'color': '#aabbcc'})
issue1.labels = ['label2']
issue1.save()
events = issue1.resourcelabelevents.list()
assert(events)
event = issue1.resourcelabelevents.get(events[0].id)
assert(event)

discussion = issue1.discussions.create({'body': 'Discussion body'})
assert(len(issue1.discussions.list()) == 1)
d_note = discussion.notes.create({'body': 'first note'})
Expand Down Expand Up @@ -628,6 +637,14 @@
discussion = mr.discussions.get(discussion.id)
assert(len(discussion.attributes['notes']) == 1)

# mr labels and events
mr.labels = ['label2']
mr.save()
events = mr.resourcelabelevents.list()
assert(events)
event = mr.resourcelabelevents.get(events[0].id)
assert(event)

# basic testing: only make sure that the methods exist
mr.commits()
mr.changes()
Expand Down