Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

feat(api): add application statistics#2347

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
Show file tree
Hide file tree
Changes fromall 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
1 change: 1 addition & 0 deletionsdocs/api-objects.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ API examples
gl_objects/search
gl_objects/settings
gl_objects/snippets
gl_objects/statistics
gl_objects/system_hooks
gl_objects/templates
gl_objects/todos
Expand Down
21 changes: 21 additions & 0 deletionsdocs/gl_objects/statistics.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
##########
Statistics
##########

Reference
---------

* v4 API:

+ :class:`gitlab.v4.objects.ApplicationStatistics`
+ :class:`gitlab.v4.objects.ApplicationStatisticsManager`
+ :attr:`gitlab.Gitlab.statistics`

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

Examples
--------

Get the statistics::

statistics = gl.statistics.get()
2 changes: 2 additions & 0 deletionsgitlab/client.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,8 @@ def __init__(
"""See :class:`~gitlab.v4.objects.PersonalAccessTokenManager`"""
self.topics = objects.TopicManager(self)
"""See :class:`~gitlab.v4.objects.TopicManager`"""
self.statistics = objects.ApplicationStatisticsManager(self)
"""See :class:`~gitlab.v4.objects.ApplicationStatisticsManager`"""

def __enter__(self) -> "Gitlab":
return self
Expand Down
14 changes: 14 additions & 0 deletionsgitlab/v4/objects/statistics.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,8 @@
"IssuesStatisticsManager",
"ProjectIssuesStatistics",
"ProjectIssuesStatisticsManager",
"ApplicationStatistics",
"ApplicationStatisticsManager",
]


Expand DownExpand Up@@ -71,3 +73,15 @@ class ProjectIssuesStatisticsManager(GetWithoutIdMixin, RESTManager):

def get(self, **kwargs: Any) -> ProjectIssuesStatistics:
return cast(ProjectIssuesStatistics, super().get(**kwargs))


class ApplicationStatistics(RESTObject):
_id_attr = None


class ApplicationStatisticsManager(GetWithoutIdMixin, RESTManager):
_path = "/application/statistics"
_obj_cls = ApplicationStatistics

def get(self, **kwargs: Any) -> ApplicationStatistics:
return cast(ApplicationStatistics, super().get(**kwargs))
12 changes: 12 additions & 0 deletionstests/functional/api/test_statistics.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
"""
GitLab API: https://docs.gitlab.com/ee/api/statistics.html
"""


def test_get_statistics(gl):
statistics = gl.statistics.get()

assert statistics.snippets.isdigit()
assert statistics.users.isdigit()
assert statistics.groups.isdigit()
assert statistics.projects.isdigit()
13 changes: 12 additions & 1 deletiontests/functional/conftest.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,18 @@ def reset_gitlab(gl: gitlab.Gitlab) -> None:
helpers.safe_delete(deploy_token)
logging.info(f"Deleting project: {project.path_with_namespace!r}")
helpers.safe_delete(project)

for group in gl.groups.list():

# skip deletion of a descendant group to prevent scenarios where parent group
# gets deleted leaving a dangling descendant whose deletion will throw 404s.
if group.parent_id:
logging.info(
f"Skipping deletion of {group.full_path} as it is a descendant "
f"group and will be removed when the parent group is deleted"
)
continue

for deploy_token in group.deploytokens.list():
logging.info(
f"Deleting deploy token: {deploy_token.username!r} in "
Expand All@@ -110,7 +121,7 @@ def reset_gitlab(gl: gitlab.Gitlab) -> None:
logging.info(f"Deleting variable: {variable.key!r}")
helpers.safe_delete(variable)
for user in gl.users.list():
if user.username!="root":
if user.usernamenot in ["root", "ghost"]:
logging.info(f"Deleting user: {user.username!r}")
helpers.safe_delete(user, hard_delete=True)

Expand Down
49 changes: 49 additions & 0 deletionstests/unit/objects/test_statistics.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
"""
GitLab API: https://docs.gitlab.com/ee/api/statistics.html
"""

import pytest
import responses

content = {
"forks": "10",
"issues": "76",
"merge_requests": "27",
"notes": "954",
"snippets": "50",
"ssh_keys": "10",
"milestones": "40",
"users": "50",
"groups": "10",
"projects": "20",
"active_users": "50",
}


@pytest.fixture
def resp_application_statistics():

with responses.RequestsMock() as rsps:
rsps.add(
method=responses.GET,
url="http://localhost/api/v4/application/statistics",
json=content,
content_type="application/json",
status=200,
)

yield rsps


def test_get_statistics(gl, resp_application_statistics):
statistics = gl.statistics.get()
assert statistics.forks == content["forks"]
assert statistics.merge_requests == content["merge_requests"]
assert statistics.notes == content["notes"]
assert statistics.snippets == content["snippets"]
assert statistics.ssh_keys == content["ssh_keys"]
assert statistics.milestones == content["milestones"]
assert statistics.users == content["users"]
assert statistics.groups == content["groups"]
assert statistics.projects == content["projects"]
assert statistics.active_users == content["active_users"]
[8]ページ先頭
©2009-2025 Movatter.jp