Skip to content

Stats #968

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 4 commits into from
Dec 13, 2019
Merged

Stats #968

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
51 changes: 51 additions & 0 deletions docs/gl_objects/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -754,3 +754,54 @@ Protect a single repository tag or several project repository tags using a wildc
Unprotect the given protected tag or wildcard protected tag.::

protected_tag.delete()

Additional project statistics
=============================

Reference
---------

* v4 API:

+ :class:`gitlab.v4.objects.ProjectAdditionalStatistics`
+ :class:`gitlab.v4.objects.ProjectAdditionalStatisticsManager`
+ :attr:`gitlab.v4.objects.Project.additionalstatistics`

* GitLab API: https://docs.gitlab.com/ce/api/project_statistics.html

Examples
---------

Get all additional statistics of a project::

statistics = project.additionalstatistics.get()

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')
56 changes: 56 additions & 0 deletions gitlab/tests/test_gitlab.py
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,62 @@ def resp_get_environment(url, request):
self.assertEqual(environment.last_deployment, "sometime")
self.assertEqual(environment.name, "environment_name")

def test_project_additional_statistics(self):
@urlmatch(
scheme="http", netloc="localhost", path="/api/v4/projects/1$", method="get"
)
def resp_get_project(url, request):
headers = {"content-type": "application/json"}
content = '{"name": "name", "id": 1}'.encode("utf-8")
return response(200, content, headers, None, 5, request)

@urlmatch(
scheme="http",
netloc="localhost",
path="/api/v4/projects/1/statistics",
method="get",
)
def resp_get_environment(url, request):
headers = {"content-type": "application/json"}
content = """{"fetches": {"total": 50, "days": [{"count": 10, "date": "2018-01-10"}]}}""".encode(
"utf-8"
)
return response(200, content, headers, None, 5, request)

with HTTMock(resp_get_project, resp_get_environment):
project = self.gl.projects.get(1)
statistics = project.additionalstatistics.get()
self.assertIsInstance(statistics, ProjectAdditionalStatistics)
self.assertEqual(statistics.fetches["total"], 50)

def test_project_issues_statistics(self):
@urlmatch(
scheme="http", netloc="localhost", path="/api/v4/projects/1$", method="get"
)
def resp_get_project(url, request):
headers = {"content-type": "application/json"}
content = '{"name": "name", "id": 1}'.encode("utf-8")
return response(200, content, headers, None, 5, request)

@urlmatch(
scheme="http",
netloc="localhost",
path="/api/v4/projects/1/issues_statistics",
method="get",
)
def resp_get_environment(url, request):
headers = {"content-type": "application/json"}
content = """{"statistics": {"counts": {"all": 20, "closed": 5, "opened": 15}}}""".encode(
"utf-8"
)
return response(200, content, headers, None, 5, request)

with HTTMock(resp_get_project, resp_get_environment):
project = self.gl.projects.get(1)
statistics = project.issuesstatistics.get()
self.assertIsInstance(statistics, ProjectIssuesStatistics)
self.assertEqual(statistics.statistics["counts"]["all"], 20)

def test_groups(self):
@urlmatch(
scheme="http", netloc="localhost", path="/api/v4/groups/1", method="get"
Expand Down
22 changes: 22 additions & 0 deletions gitlab/v4/objects.py
Original file line number Diff line number Diff line change
Expand Up @@ -3997,6 +3997,26 @@ class ProjectImportManager(GetWithoutIdMixin, RESTManager):
_from_parent_attrs = {"project_id": "id"}


class ProjectAdditionalStatistics(RefreshMixin, RESTObject):
_id_attr = None


class ProjectAdditionalStatisticsManager(GetWithoutIdMixin, RESTManager):
_path = "/projects/%(project_id)s/statistics"
_obj_cls = ProjectAdditionalStatistics
_from_parent_attrs = {"project_id": "id"}


class ProjectIssuesStatistics(RefreshMixin, RESTObject):
_id_attr = None


class ProjectIssuesStatisticsManager(GetWithoutIdMixin, RESTManager):
_path = "/projects/%(project_id)s/issues_statistics"
_obj_cls = ProjectIssuesStatistics
_from_parent_attrs = {"project_id": "id"}


class Project(SaveMixin, ObjectDeleteMixin, RESTObject):
_short_print_attr = "path"
_managers = (
Expand Down Expand Up @@ -4042,6 +4062,8 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject):
("variables", "ProjectVariableManager"),
("wikis", "ProjectWikiManager"),
("clusters", "ProjectClusterManager"),
("additionalstatistics", "ProjectAdditionalStatisticsManager"),
("issuesstatistics", "ProjectIssuesStatisticsManager"),
)

@cli.register_custom_action("Project", ("submodule", "branch", "commit_sha"))
Expand Down