Merge branch 'python-gitlab:master' into master

spamsch · spamsch · commit 406590323c52 · 2021-05-31T09:07:11.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@ MANIFEST
 coverage.xml
 docs/_build
 .coverage
+.python-version
 .tox
 .venv/
 venv/
diff --git a/docs/gl_objects/deployments.rst b/docs/gl_objects/deployments.rst
@@ -39,3 +39,25 @@ Update a deployment::
     deployment = project.deployments.get(42)
     deployment.status = "failed"
     deployment.save()
+
+Merge requests associated with a deployment
+===========================================
+
+Reference
+----------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequest`
+  + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequestManager`
+  + :attr:`gitlab.v4.objects.ProjectDeployment.mergerequests`
+
+* GitLab API: https://docs.gitlab.com/ee/api/deployments.html#list-of-merge-requests-associated-with-a-deployment
+
+Examples
+--------
+
+List the merge requests associated with a deployment::
+
+    deployment = project.deployments.get(42, lazy=True)
+    mrs = deployment.mergerequests.list()
diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst
@@ -225,3 +225,55 @@ Link issue ``i1`` to issue ``i2``::
 Delete a link::
 
     i1.links.delete(issue_link_id)
+
+Issues statistics
+=========================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.IssuesStatistics`
+  + :class:`gitlab.v4.objects.IssuesStatisticsManager`
+  + :attr:`gitlab.issues_statistics`
+  + :class:`gitlab.v4.objects.GroupIssuesStatistics`
+  + :class:`gitlab.v4.objects.GroupIssuesStatisticsManager`
+  + :attr:`gitlab.v4.objects.Group.issues_statistics`
+  + :class:`gitlab.v4.objects.ProjectIssuesStatistics`
+  + :class:`gitlab.v4.objects.ProjectIssuesStatisticsManager`
+  + :attr:`gitlab.v4.objects.Project.issues_statistics`
+
+
+* GitLab API: https://docs.gitlab.com/ce/api/issues_statistics.htm
+
+Examples
+---------
+
+Get statistics of all issues created by the current user::
+
+    statistics = gl.issues_statistics.get()
+
+Get statistics of all issues the user has access to::
+
+    statistics = gl.issues_statistics.get(scope='all')
+
+Get statistics of issues for the user with ``foobar`` in the ``title`` or the ``description``::
+
+    statistics = gl.issues_statistics.get(search='foobar')
+
+Get statistics of all issues in a group::
+
+    statistics = group.issues_statistics.get()
+
+Get statistics of issues in a group with ``foobar`` in the ``title`` or the ``description``::
+
+    statistics = group.issues_statistics.get(search='foobar')
+
+Get statistics of all issues in a project::
+
+    statistics = project.issues_statistics.get()
+
+Get statistics of issues in a project with ``foobar`` in the ``title`` or the ``description``::
+
+    statistics = project.issues_statistics.get(search='foobar')
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -768,29 +768,3 @@ Get all additional statistics of a project::
 Get total fetches in last 30 days of a project::
 
     total_fetches = project.additionalstatistics.get().fetches['total']
-
-Project issues statistics
-=========================
-
-Reference
----------
-
-* v4 API:
-
-  + :class:`gitlab.v4.objects.ProjectIssuesStatistics`
-  + :class:`gitlab.v4.objects.ProjectIssuesStatisticsManager`
-  + :attr:`gitlab.v4.objects.Project.issuesstatistics`
-
-* GitLab API: https://docs.gitlab.com/ce/api/issues_statistics.html#get-project-issues-statistics
-
-Examples
----------
-
-Get statistics of all issues in a project::
-
-    statistics = project.issuesstatistics.get()
-
-Get statistics of issues in a project with ``foobar`` in ``title`` and
-``description``::
-
-    statistics = project.issuesstatistics.get(search='foobar')
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -118,6 +118,7 @@ def __init__(
         self.groups = objects.GroupManager(self)
         self.hooks = objects.HookManager(self)
         self.issues = objects.IssueManager(self)
+        self.issues_statistics = objects.IssuesStatisticsManager(self)
         self.ldapgroups = objects.LDAPGroupManager(self)
         self.licenses = objects.LicenseManager(self)
         self.namespaces = objects.NamespaceManager(self)
diff --git a/gitlab/v4/objects/deployments.py b/gitlab/v4/objects/deployments.py
@@ -1,21 +1,30 @@
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
 from gitlab.mixins import CreateMixin, RetrieveMixin, SaveMixin, UpdateMixin
 
+from .merge_requests import ProjectDeploymentMergeRequestManager  # noqa: F401
+
 __all__ = [
     "ProjectDeployment",
     "ProjectDeploymentManager",
 ]
 
 
 class ProjectDeployment(SaveMixin, RESTObject):
-    pass
+    _managers = (("mergerequests", "ProjectDeploymentMergeRequestManager"),)
 
 
 class ProjectDeploymentManager(RetrieveMixin, CreateMixin, UpdateMixin, RESTManager):
     _path = "/projects/%(project_id)s/deployments"
     _obj_cls = ProjectDeployment
     _from_parent_attrs = {"project_id": "id"}
-    _list_filters = ("order_by", "sort")
+    _list_filters = (
+        "order_by",
+        "sort",
+        "updated_after",
+        "updated_before",
+        "environment",
+        "status",
+    )
     _create_attrs = RequiredOptional(
         required=("sha", "ref", "tag", "status", "environment")
     )
diff --git a/gitlab/v4/objects/groups.py b/gitlab/v4/objects/groups.py
@@ -26,6 +26,7 @@
 from .packages import GroupPackageManager  # noqa: F401
 from .projects import GroupProjectManager  # noqa: F401
 from .runners import GroupRunnerManager  # noqa: F401
+from .statistics import GroupIssuesStatisticsManager  # noqa: F401
 from .variables import GroupVariableManager  # noqa: F401
 from .wikis import GroupWikiManager  # noqa: F401
 
@@ -53,6 +54,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
         ("epics", "GroupEpicManager"),
         ("imports", "GroupImportManager"),
         ("issues", "GroupIssueManager"),
+        ("issues_statistics", "GroupIssuesStatisticsManager"),
         ("labels", "GroupLabelManager"),
         ("members", "GroupMemberManager"),
         ("members_all", "GroupMemberAllManager"),
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py
@@ -36,6 +36,8 @@
     "GroupMergeRequestManager",
     "ProjectMergeRequest",
     "ProjectMergeRequestManager",
+    "ProjectDeploymentMergeRequest",
+    "ProjectDeploymentMergeRequestManager",
     "ProjectMergeRequestDiff",
     "ProjectMergeRequestDiffManager",
 ]
@@ -48,32 +50,42 @@ class MergeRequest(RESTObject):
 class MergeRequestManager(ListMixin, RESTManager):
     _path = "/merge_requests"
     _obj_cls = MergeRequest
-    _from_parent_attrs = {"group_id": "id"}
     _list_filters = (
         "state",
         "order_by",
         "sort",
         "milestone",
         "view",
         "labels",
+        "with_labels_details",
+        "with_merge_status_recheck",
         "created_after",
         "created_before",
         "updated_after",
         "updated_before",
         "scope",
         "author_id",
+        "author_username",
         "assignee_id",
         "approver_ids",
         "approved_by_ids",
+        "reviewer_id",
+        "reviewer_username",
         "my_reaction_emoji",
         "source_branch",
         "target_branch",
         "search",
+        "in",
         "wip",
+        "not",
+        "environment",
+        "deployed_before",
+        "deployed_after",
     )
     _types = {
         "approver_ids": types.ListAttribute,
         "approved_by_ids": types.ListAttribute,
+        "in": types.ListAttribute,
         "labels": types.ListAttribute,
     }
 
@@ -409,6 +421,16 @@ class ProjectMergeRequestManager(CRUDMixin, RESTManager):
     }
 
 
+class ProjectDeploymentMergeRequest(MergeRequest):
+    pass
+
+
+class ProjectDeploymentMergeRequestManager(MergeRequestManager):
+    _path = "/projects/%(project_id)s/deployments/%(deployment_id)s/merge_requests"
+    _obj_cls = ProjectDeploymentMergeRequest
+    _from_parent_attrs = {"deployment_id": "id", "project_id": "project_id"}
+
+
 class ProjectMergeRequestDiff(RESTObject):
     pass
 
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -155,7 +155,8 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO
         ("wikis", "ProjectWikiManager"),
         ("clusters", "ProjectClusterManager"),
         ("additionalstatistics", "ProjectAdditionalStatisticsManager"),
-        ("issuesstatistics", "ProjectIssuesStatisticsManager"),
+        ("issues_statistics", "ProjectIssuesStatisticsManager"),
+        ("issuesstatistics", "ProjectIssuesStatisticsManager"),  # Deprecated
         ("deploytokens", "ProjectDeployTokenManager"),
     )
 
diff --git a/gitlab/v4/objects/statistics.py b/gitlab/v4/objects/statistics.py
@@ -2,8 +2,12 @@
 from gitlab.mixins import GetWithoutIdMixin, RefreshMixin
 
 __all__ = [
+    "GroupIssuesStatistics",
+    "GroupIssuesStatisticsManager",
     "ProjectAdditionalStatistics",
     "ProjectAdditionalStatisticsManager",
+    "IssuesStatistics",
+    "IssuesStatisticsManager",
     "ProjectIssuesStatistics",
     "ProjectIssuesStatisticsManager",
 ]
@@ -19,6 +23,25 @@ class ProjectAdditionalStatisticsManager(GetWithoutIdMixin, RESTManager):
     _from_parent_attrs = {"project_id": "id"}
 
 
+class IssuesStatistics(RefreshMixin, RESTObject):
+    _id_attr = None
+
+
+class IssuesStatisticsManager(GetWithoutIdMixin, RESTManager):
+    _path = "/issues_statistics"
+    _obj_cls = IssuesStatistics
+
+
+class GroupIssuesStatistics(RefreshMixin, RESTObject):
+    _id_attr = None
+
+
+class GroupIssuesStatisticsManager(GetWithoutIdMixin, RESTManager):
+    _path = "/groups/%(group_id)s/issues_statistics"
+    _obj_cls = GroupIssuesStatistics
+    _from_parent_attrs = {"group_id": "id"}
+
+
 class ProjectIssuesStatistics(RefreshMixin, RESTObject):
     _id_attr = None
 
diff --git a/tests/unit/objects/test_issues.py b/tests/unit/objects/test_issues.py
@@ -1,11 +1,16 @@
 """
 GitLab API: https://docs.gitlab.com/ce/api/issues.html
 """
+import re
 
 import pytest
 import responses
 
-from gitlab.v4.objects import ProjectIssuesStatistics
+from gitlab.v4.objects import (
+    GroupIssuesStatistics,
+    IssuesStatistics,
+    ProjectIssuesStatistics,
+)
 
 
 @pytest.fixture
@@ -43,7 +48,9 @@ def resp_issue_statistics():
     with responses.RequestsMock() as rsps:
         rsps.add(
             method=responses.GET,
-            url="http://localhost/api/v4/projects/1/issues_statistics",
+            url=re.compile(
+                r"http://localhost/api/v4/((groups|projects)/1/)?issues_statistics"
+            ),
             json=content,
             content_type="application/json",
             status=200,
@@ -63,7 +70,23 @@ def test_get_issue(gl, resp_get_issue):
     assert issue.name == "name"
 
 
-def test_project_issues_statistics(project, resp_issue_statistics):
-    statistics = project.issuesstatistics.get()
+def test_get_issues_statistics(gl, resp_issue_statistics):
+    statistics = gl.issues_statistics.get()
+    assert isinstance(statistics, IssuesStatistics)
+    assert statistics.statistics["counts"]["all"] == 20
+
+
+def test_get_group_issues_statistics(group, resp_issue_statistics):
+    statistics = group.issues_statistics.get()
+    assert isinstance(statistics, GroupIssuesStatistics)
+    assert statistics.statistics["counts"]["all"] == 20
+
+
+def test_get_project_issues_statistics(project, resp_issue_statistics):
+    statistics = project.issues_statistics.get()
     assert isinstance(statistics, ProjectIssuesStatistics)
     assert statistics.statistics["counts"]["all"] == 20
+
+    # Deprecated attribute
+    deprecated = project.issuesstatistics.get()
+    assert deprecated.statistics == statistics.statistics
diff --git a/tests/unit/objects/test_merge_requests.py b/tests/unit/objects/test_merge_requests.py

Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,8 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO`
`155`	`155`	`("wikis", "ProjectWikiManager"),`
`156`	`156`	`("clusters", "ProjectClusterManager"),`
`157`	`157`	`("additionalstatistics", "ProjectAdditionalStatisticsManager"),`
`158`		`- ("issuesstatistics", "ProjectIssuesStatisticsManager"),`
	`158`	`+ ("issues_statistics", "ProjectIssuesStatisticsManager"),`
	`159`	`+ ("issuesstatistics", "ProjectIssuesStatisticsManager"), # Deprecated`
`159`	`160`	`("deploytokens", "ProjectDeployTokenManager"),`
`160`	`161`	`)`
`161`	`162`