FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat(api): Add support for new runner creation API by lgatellier · Pull Request #2635 · python-gitlab/python-gitlab · GitHub

Repository navigation

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .py  (3) .rst  (2) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
8 changes: 8 additions & 0 deletions docs/gl_objects/runners.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@ Register a new runner::

runner = gl.runners.create({'token': secret_token})

.. note::

A new runner registration workflow has been introduced since GitLab 16.0. This new
workflow comes with a new API endpoint to create runners, which does not use
registration tokens.

The new endpoint can be called using ``gl.user.runners.create() after authenticating with `gl.auth()```.

Update a runner::

runner = gl.runners.get(runner_id)
Expand Down
57 changes: 57 additions & 0 deletions docs/gl_objects/users.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -456,3 +456,60 @@ Get the users activities::
query_parameters={'from': '2018-07-01'},
get_all=True,
)

Create new runner
=================

References
----------

* New runner registration API endpoint (see `Migrating to the new runner registration workflow <https://docs.gitlab.com/ee/ci/runners/new_creation_workflow.html#creating-runners-programmatically>`_)

* v4 API:

+ :class:`gitlab.v4.objects.CurrentUserRunner`
+ :class:`gitlab.v4.objects.CurrentUserRunnerManager`
+ :attr:`gitlab.Gitlab.user.runners`

* GitLab API : https://docs.gitlab.com/ee/api/users.html#create-a-runner

Examples
--------

Create an instance-wide runner::

runner = gl.user.runners.create({
"runner_type": "instance_type",
"description": "My brand new runner",
"paused": True,
"locked": False,
"run_untagged": True
"tag_list": ["linux", "docker", "testing"],
"access_level": "not_protected"
Comment thread
nejch marked this conversation as resolved.
})

Create a group runner::

runner = gl.user.runners.create({
"runner_type": "group_type",
"group_id": 12345678,
"description": "My brand new runner",
"paused": True,
"locked": False,
"run_untagged": True
"tag_list": ["linux", "docker", "testing"],
"access_level": "not_protected"
})

Create a project runner::

runner = gl.user.runners.create({
"runner_type": "project_type",
"project_id": 987564321,
"description": "My brand new runner",
"paused": True,
"locked": False,
"run_untagged": True
"tag_list": ["linux", "docker", "testing"],
"access_level": "not_protected"
})
28 changes: 28 additions & 0 deletions gitlab/v4/objects/users.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
"CurrentUserGPGKeyManager",
"CurrentUserKey",
"CurrentUserKeyManager",
"CurrentUserRunner",
"CurrentUserRunnerManager",
"CurrentUserStatus",
"CurrentUserStatusManager",
"CurrentUser",
Expand Down Expand Up @@ -111,6 +113,31 @@ def get(
return cast(CurrentUserKey, super().get(id=id, lazy=lazy, **kwargs))


class CurrentUserRunner(RESTObject):
pass


class CurrentUserRunnerManager(CreateMixin, RESTManager):
_path = "/user/runners"
_obj_cls = CurrentUserRunner
_types = {"tag_list": types.CommaSeparatedListAttribute}
_create_attrs = RequiredOptional(
required=("runner_type",),
optional=(
"group_id",
"project_id",
"description",
"paused",
"locked",
"run_untagged",
"tag_list",
"access_level",
"maximum_timeout",
"maintenance_note",
),
)


class CurrentUserStatus(SaveMixin, RESTObject):
_id_attr = None
_repr_attr = "message"
Expand All @@ -132,6 +159,7 @@ class CurrentUser(RESTObject):
emails: CurrentUserEmailManager
gpgkeys: CurrentUserGPGKeyManager
keys: CurrentUserKeyManager
runners: CurrentUserRunnerManager
status: CurrentUserStatusManager


Expand Down
24 changes: 24 additions & 0 deletions tests/unit/conftest.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import pytest
import responses

import gitlab
from tests.unit import helpers
Expand Down Expand Up @@ -59,6 +60,23 @@ def gl_retry():
)


@pytest.fixture
def resp_get_current_user():
with responses.RequestsMock() as rsps:
rsps.add(
method=responses.GET,
url="http://localhost/api/v4/user",
json={
"id": 1,
"username": "username",
"web_url": "http://localhost/username",
},
content_type="application/json",
status=200,
)
yield rsps


# Todo: parametrize, but check what tests it's really useful for
@pytest.fixture
def gl_trailing():
Expand Down Expand Up @@ -129,6 +147,12 @@ def user(gl):
return gl.users.get(1, lazy=True)


@pytest.fixture
def current_user(gl, resp_get_current_user):
gl.auth()
return gl.user


@pytest.fixture
def migration(gl):
return gl.bulk_imports.get(1, lazy=True)
19 changes: 19 additions & 0 deletions tests/unit/objects/test_users.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,19 @@ def resp_starred_projects():
yield rsps


@pytest.fixture
def resp_runner_create():
with responses.RequestsMock() as rsps:
rsps.add(
method=responses.POST,
url="http://localhost/api/v4/user/runners",
json={"id": "6", "token": "6337ff461c94fd3fa32ba3b1ff4125"},
content_type="application/json",
status=201,
)
yield rsps


def test_get_user(gl, resp_get_user):
user = gl.users.get(1)
assert isinstance(user, User)
Expand Down Expand Up @@ -304,3 +317,9 @@ def test_list_starred_projects(user, resp_starred_projects):
projects = user.starred_projects.list()
assert isinstance(projects[0], StarredProject)
assert projects[0].id == project_content["id"]


def test_create_user_runner(current_user, resp_runner_create):
runner = current_user.runners.create({"runner_type": "instance_type"})
assert runner.id == "6"
assert runner.token == "6337ff461c94fd3fa32ba3b1ff4125"

Back | FazBrowse Home | New Git URL