feat(api): Add support for new runner creation API

lgatellier · lgatellier · commit a99204a30580 · 2023-08-19T10:37:52.000+02:00
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -189,6 +189,8 @@ def __init__(
         """See :class:`~gitlab.v4.objects.PagesDomainManager`"""
         self.user_activities = objects.UserActivitiesManager(self)
         """See :class:`~gitlab.v4.objects.UserActivitiesManager`"""
+        self.user_runners = objects.UserRunnerManager(self)
+        """See :class:`~gitlab.v4.objects.UserRunnerManager`"""
         self.applications = objects.ApplicationManager(self)
         """See :class:`~gitlab.v4.objects.ApplicationManager`"""
         self.variables = objects.VariableManager(self)
diff --git a/gitlab/v4/objects/users.py b/gitlab/v4/objects/users.py
@@ -63,6 +63,8 @@
     "UserMembershipManager",
     "UserProject",
     "UserProjectManager",
+    "UserRunner",
+    "UserRunnerManager",
 ]
 
 
@@ -678,3 +680,28 @@ class UserFollowingManager(ListMixin, RESTManager):
     _path = "/users/{user_id}/following"
     _obj_cls = User
     _from_parent_attrs = {"user_id": "id"}
+
+
+class UserRunner(RESTObject):
+    pass
+
+
+class UserRunnerManager(CreateMixin, RESTManager):
+    _path = "/user/runners"
+    _obj_cls = UserRunner
+    _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",
+        ),
+    )
diff --git a/tests/unit/objects/test_users.py b/tests/unit/objects/test_users.py
@@ -6,6 +6,7 @@
 import pytest
 import responses
 
+import gitlab
 from gitlab.v4.objects import StarredProject, User, UserMembership, UserStatus
 
 from .test_projects import project_content
@@ -243,6 +244,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=200,
+        )
+        yield rsps
+
+
 def test_get_user(gl, resp_get_user):
     user = gl.users.get(1)
     assert isinstance(user, User)
@@ -306,3 +320,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(gl: gitlab.Gitlab, resp_runner_create):
+    runner = gl.user_runners.create({"runner_type": "instance_type"})
+    assert runner.id == "6"
+    assert runner.token == "6337ff461c94fd3fa32ba3b1ff4125"
