Skip to content

feat(api): add support for gitlab service account #2851

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
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
21 changes: 21 additions & 0 deletions docs/gl_objects/groups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -458,3 +458,24 @@ Edit group push rules::
Delete group push rules::

pr.delete()

Group Service Account
=====================

Reference
---------

* v4 API:

+ :class:`gitlab.v4.objects.GroupServiceAccount`
+ :class:`gitlab.v4.objects.GroupServiceAccountManager`
+ :attr:`gitlab.v4.objects.Group.serviceaccounts`

* GitLab API: https://docs.gitlab.com/ee/api/groups.html#service-accounts

Examples
---------

Create group service account (only allowed at top level group)::

group.serviceaccount.create({'name': 'group-service-account', 'username': 'group-service-account'})
1 change: 1 addition & 0 deletions gitlab/v4/objects/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
from .reviewers import *
from .runners import *
from .secure_files import *
from .service_accounts import *
from .settings import *
from .sidekiq import *
from .snippets import *
Expand Down
2 changes: 2 additions & 0 deletions gitlab/v4/objects/groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
from .projects import GroupProjectManager, SharedProjectManager # noqa: F401
from .push_rules import GroupPushRulesManager
from .runners import GroupRunnerManager # noqa: F401
from .service_accounts import GroupServiceAccountManager # noqa: F401
from .statistics import GroupIssuesStatisticsManager # noqa: F401
from .variables import GroupVariableManager # noqa: F401
from .wikis import GroupWikiManager # noqa: F401
Expand Down Expand Up @@ -102,6 +103,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
variables: GroupVariableManager
wikis: GroupWikiManager
saml_group_links: "GroupSAMLGroupLinkManager"
service_accounts: "GroupServiceAccountManager"

@cli.register_custom_action("Group", ("project_id",))
@exc.on_http_error(exc.GitlabTransferProjectError)
Expand Down
18 changes: 18 additions & 0 deletions gitlab/v4/objects/service_accounts.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
from gitlab.base import RESTManager, RESTObject
from gitlab.mixins import CreateMixin
from gitlab.types import RequiredOptional

__all__ = ["GroupServiceAccount", "GroupServiceAccountManager"]


class GroupServiceAccount(RESTObject):
pass


class GroupServiceAccountManager(CreateMixin, RESTManager):
_path = "/groups/{group_id}/service_accounts"
_obj_cls = GroupServiceAccount
_from_parent_attrs = {"group_id": "id"}
_create_attrs = RequiredOptional(
optional=("name", "username"),
)
9 changes: 9 additions & 0 deletions tests/functional/api/test_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,3 +308,12 @@ def test_group_saml_group_links(group):
group.saml_group_links.create(
{"saml_group_name": "saml-group-1", "access_level": 10}
)


@pytest.mark.gitlab_premium
def test_group_service_account(group):
service_account = group.service_accounts.create(
{"name": "gitlab-service-account", "username": "gitlab-service-account"}
)
assert service_account.name == "gitlab-service-account"
assert service_account.username == "gitlab-service-account"
26 changes: 26 additions & 0 deletions tests/unit/objects/test_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@
"max_file_size": 100,
}

service_account_content = {
"name": "gitlab-service-account",
"username": "gitlab-service-account",
}


@pytest.fixture
def resp_groups():
Expand Down Expand Up @@ -325,6 +330,19 @@ def resp_restore_group(created_content):
yield rsps


@pytest.fixture
def resp_create_group_service_account():
with responses.RequestsMock() as rsps:
rsps.add(
method=responses.POST,
url="http://localhost/api/v4/groups/1/service_accounts",
json=service_account_content,
content_type="application/json",
status=200,
)
yield rsps


def test_get_group(gl, resp_groups):
data = gl.groups.get(1)
assert isinstance(data, gitlab.v4.objects.Group)
Expand Down Expand Up @@ -466,3 +484,11 @@ def test_delete_saml_group_link(group, resp_delete_saml_group_link):

def test_group_restore(group, resp_restore_group):
group.restore()


def test_create_group_service_account(group, resp_create_group_service_account):
service_account = group.service_accounts.create(
{"name": "gitlab-service-account", "username": "gitlab-service-account"}
)
assert service_account.name == "gitlab-service-account"
assert service_account.username == "gitlab-service-account"