chore: update jobmanager client (#579)

* regenerate openapi client

* update endpoints in app

* delete legacy files in jobmanager/client

* add removal of current jobmanager client

* update integration test

* fix unit test

* lint

Author: cbartz

github-runner-manager/src/github_runner_manager/platform/jobmanager_provider.py

@@ -77,7 +77,7 @@ def get_runner_health(
         with jobmanager_client.ApiClient(configuration) as api_client:
             api_instance = jobmanager_client.RunnersApi(api_client)
             try:
-                response = api_instance.get_runner_health_v1_runner_runner_id_health_get(
+                response = api_instance.get_runner_health_v1_runners_runner_id_health_get(
                     int(runner_identity.metadata.runner_id)
                 )
             except NotFoundException:
@@ -174,24 +174,20 @@ def get_runner_context(
         with jobmanager_client.ApiClient(configuration) as api_client:
             api_instance = jobmanager_client.RunnersApi(api_client)
             try:
-                runner_register_request = (
-                    jobmanager_client.RegisterRunnerV1RunnerRegisterPostRequest(
-                        name=instance_id.name, labels=labels
-                    )
+                runner_register_request = jobmanager_client.RunnerCreate(
+                    name=instance_id.name, labels=labels
                 )
 
-                response = api_instance.register_runner_v1_runner_register_post(
+                response = api_instance.register_runner_v1_runners_register_post(
                     runner_register_request
                 )
-                if not response.id:
-                    raise PlatformApiError("No runner ID from jobmanager API")
                 updated_metadata = RunnerMetadata(
                     platform_name=metadata.platform_name, url=self._url
                 )
                 updated_metadata.runner_id = str(response.id)
                 if token := response.token:
                     jobmanager_endpoint = (
-                        f"{self._url}/v1/runner/{updated_metadata.runner_id}/health"
+                        f"{self._url}/v1/runners/{updated_metadata.runner_id}/health"
                     )
                     # For now, use the first label
                     label = "undefined"

github-runner-manager/tests/unit/platform/test_jobmanager_provider.py

@@ -10,10 +10,10 @@
 
 import pytest
 from jobmanager_client import (
-    GetRunnerHealthV1RunnerRunnerIdHealthGet200Response,
-    RegisterRunnerV1RunnerRegisterPost200Response,
+    RunnerHealthResponse,
+    RunnerRegisterResponse,
 )
-from jobmanager_client.models.job import Job
+from jobmanager_client.models.job_read import JobRead
 from jobmanager_client.rest import ApiException, NotFoundException
 from pydantic import BaseModel, HttpUrl
 
@@ -39,9 +39,7 @@ def test_get_runner_context_succeeds(monkeypatch: pytest.MonkeyPatch):
     monkeypatch.setattr("jobmanager_client.ApiClient.call_api", call_api_mock)
     runner_id = random.randint(1, 1000)
     token = secrets.token_hex(16)
-    call_api_mock.return_value = RegisterRunnerV1RunnerRegisterPost200Response(
-        id=runner_id, token=token
-    )
+    call_api_mock.return_value = RunnerRegisterResponse(id=runner_id, token=token)
 
     metadata = RunnerMetadata(platform_name="jobmanager", runner_id=None, url=None)
     instance_id = InstanceID.build(prefix="unit-0")
@@ -61,20 +59,10 @@ def test_get_runner_context_succeeds(monkeypatch: pytest.MonkeyPatch):
     "api_return_value, error_message",
     [
         pytest.param(
-            RegisterRunnerV1RunnerRegisterPost200Response(id=random.randint(1, 10)),
-            "Empty token",
-            id="No token",
-        ),
-        pytest.param(
-            RegisterRunnerV1RunnerRegisterPost200Response(id=random.randint(1, 10), token=""),
+            RunnerRegisterResponse(id=random.randint(1, 10), token=""),
             "Empty token",
             id="Empty token",
         ),
-        pytest.param(
-            RegisterRunnerV1RunnerRegisterPost200Response(token=secrets.token_hex(16)),
-            "No runner ID",
-            id="No runner id",
-        ),
         pytest.param(ApiException, "API error", id="Exception from api"),
     ],
 )
@@ -106,8 +94,28 @@ def test_get_runner_context_fails(
 @pytest.mark.parametrize(
     "api_return_value, picked_up",
     [
-        pytest.param(Job(status=JobStatus.IN_PROGRESS.value), True, id="in progress job"),
-        pytest.param(Job(status=JobStatus.PENDING.value), False, id="pending job"),
+        pytest.param(
+            JobRead(
+                status=JobStatus.IN_PROGRESS.value,
+                architecture="arm64",
+                base_series="jammy",
+                id=1,
+                requested_by="foobar",
+            ),
+            True,
+            id="in progress job",
+        ),
+        pytest.param(
+            JobRead(
+                status=JobStatus.PENDING.value,
+                architecture="arm64",
+                base_series="jammy",
+                id=1,
+                requested_by="foobar",
+            ),
+            False,
+            id="pending job",
+        ),
     ],
 )
 def test_check_job_been_picked_up(monkeypatch: pytest.MonkeyPatch, api_return_value, picked_up):
@@ -208,7 +216,15 @@ def test_check_job_been_picked_up_job_url_validation_err(
 ):
     call_api_mock = MagicMock()
     monkeypatch.setattr("jobmanager_client.ApiClient.call_api", call_api_mock)
-    call_api_mock.side_effect = [Job(status=JobStatus.IN_PROGRESS.value)]
+    call_api_mock.side_effect = [
+        JobRead(
+            status=JobStatus.IN_PROGRESS.value,
+            architecture="arm64",
+            base_series="jammy",
+            id=1,
+            requested_by="foobar",
+        )
+    ]
 
     platform = JobManagerPlatform(TEST_JOB_MANAGER_URL)
     metadata = RunnerMetadata(platform_name="jobmanager", runner_id="3", url=job_url)
@@ -257,10 +273,13 @@ def test_get_runner_health(
     call_api_mock = MagicMock()
     monkeypatch.setattr("jobmanager_client.ApiClient.call_api", call_api_mock)
 
-    api_return_value = GetRunnerHealthV1RunnerRunnerIdHealthGet200Response(
+    api_return_value = RunnerHealthResponse(
         label="label",
         status=job_status,
         deletable=job_deletable,
+        cpu_usage="10%",
+        ram_usage="20%",
+        disk_usage="30%",
     )
     call_api_mock.side_effect = [api_return_value]
 
@@ -307,10 +326,13 @@ def test_get_runner_health(
                 ),
             ],
             [
-                GetRunnerHealthV1RunnerRunnerIdHealthGet200Response(
+                RunnerHealthResponse(
                     label="label",
                     status="IN_PROGRESS",
                     deletable=False,
+                    cpu_usage="10%",
+                    ram_usage="20%",
+                    disk_usage="30%",
                 ),
                 ApiException,
             ],
@@ -349,10 +371,13 @@ def test_get_runner_health(
                 ),
             ],
             [
-                GetRunnerHealthV1RunnerRunnerIdHealthGet200Response(
+                RunnerHealthResponse(
                     label="label",
                     status="FAILED",
                     deletable=True,
+                    cpu_usage="10%",
+                    ram_usage="20%",
+                    disk_usage="30%",
                 ),
                 NotFoundException,
             ],

jobmanager/client/.openapi-generator/FILES

@@ -1,20 +1,21 @@
 .github/workflows/python.yml
 .gitignore
 .gitlab-ci.yml
+.openapi-generator-ignore
 .travis.yml
 README.md
 docs/DefaultApi.md
-docs/GetRunnerHealthV1RunnerRunnerIdHealthGet200Response.md
 docs/HTTPValidationError.md
 docs/JobCreate.md
 docs/JobRead.md
 docs/JobUpdate.md
 docs/JobsApi.md
-docs/RegisterRunnerV1RunnerRegisterPost200Response.md
-docs/RegisterRunnerV1RunnerRegisterPostRequest.md
+docs/RunnerCreate.md
+docs/RunnerHealthResponse.md
+docs/RunnerHealthUpdateResponse.md
+docs/RunnerRegisterResponse.md
 docs/RunnersApi.md
 docs/TokensApi.md
-docs/UpdateRunnerHealthV1RunnerRunnerIdHealthPutRequest.md
 docs/ValidationError.md
 docs/ValidationErrorLocInner.md
 docs/VmDependencies.md
@@ -30,14 +31,14 @@ jobmanager_client/api_response.py
 jobmanager_client/configuration.py
 jobmanager_client/exceptions.py
 jobmanager_client/models/__init__.py
-jobmanager_client/models/get_runner_health_v1_runner_runner_id_health_get200_response.py
 jobmanager_client/models/http_validation_error.py
 jobmanager_client/models/job_create.py
 jobmanager_client/models/job_read.py
 jobmanager_client/models/job_update.py
-jobmanager_client/models/register_runner_v1_runner_register_post200_response.py
-jobmanager_client/models/register_runner_v1_runner_register_post_request.py
-jobmanager_client/models/update_runner_health_v1_runner_runner_id_health_put_request.py
+jobmanager_client/models/runner_create.py
+jobmanager_client/models/runner_health_response.py
+jobmanager_client/models/runner_health_update_response.py
+jobmanager_client/models/runner_register_response.py
 jobmanager_client/models/validation_error.py
 jobmanager_client/models/validation_error_loc_inner.py
 jobmanager_client/models/vm_dependencies.py
@@ -49,4 +50,19 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
+test/test_default_api.py
+test/test_http_validation_error.py
+test/test_job_create.py
+test/test_job_read.py
+test/test_job_update.py
+test/test_jobs_api.py
+test/test_runner_create.py
+test/test_runner_health_response.py
+test/test_runner_health_update_response.py
+test/test_runner_register_response.py
+test/test_runners_api.py
+test/test_tokens_api.py
+test/test_validation_error.py
+test/test_validation_error_loc_inner.py
+test/test_vm_dependencies.py
 tox.ini

jobmanager/client/README.md

@@ -95,23 +95,23 @@ Class | Method | HTTP request | Description
 *JobsApi* | [**get_jobs_v1_jobs_get**](docs/JobsApi.md#get_jobs_v1_jobs_get) | **GET** /v1/jobs | Get Jobs
 *JobsApi* | [**update_health_v1_jobs_job_id_health_put**](docs/JobsApi.md#update_health_v1_jobs_job_id_health_put) | **PUT** /v1/jobs/{job_id}/health | Update Health
 *JobsApi* | [**update_job_v1_jobs_job_id_put**](docs/JobsApi.md#update_job_v1_jobs_job_id_put) | **PUT** /v1/jobs/{job_id} | Update Job
-*RunnersApi* | [**get_runner_health_v1_runner_runner_id_health_get**](docs/RunnersApi.md#get_runner_health_v1_runner_runner_id_health_get) | **GET** /v1/runner/{runner_id}/health | Get Runner Health
-*RunnersApi* | [**register_runner_v1_runner_register_post**](docs/RunnersApi.md#register_runner_v1_runner_register_post) | **POST** /v1/runner/register | Register Runner
-*RunnersApi* | [**update_runner_health_v1_runner_runner_id_health_put**](docs/RunnersApi.md#update_runner_health_v1_runner_runner_id_health_put) | **PUT** /v1/runner/{runner_id}/health | Update Runner Health
+*RunnersApi* | [**get_runner_health_v1_runners_runner_id_health_get**](docs/RunnersApi.md#get_runner_health_v1_runners_runner_id_health_get) | **GET** /v1/runners/{runner_id}/health | Get Runner Health
+*RunnersApi* | [**register_runner_v1_runners_register_post**](docs/RunnersApi.md#register_runner_v1_runners_register_post) | **POST** /v1/runners/register | Register Runner
+*RunnersApi* | [**update_runner_health_v1_runners_runner_id_health_put**](docs/RunnersApi.md#update_runner_health_v1_runners_runner_id_health_put) | **PUT** /v1/runners/{runner_id}/health | Update Runner Health
 *TokensApi* | [**create_api_access_token_v1_api_access_token_post**](docs/TokensApi.md#create_api_access_token_v1_api_access_token_post) | **POST** /v1/api_access_token | Create Api Access Token
 *TokensApi* | [**revoke_api_access_token_v1_api_access_token_delete**](docs/TokensApi.md#revoke_api_access_token_v1_api_access_token_delete) | **DELETE** /v1/api_access_token | Revoke Api Access Token
 
 
 ## Documentation For Models
 
- - [GetRunnerHealthV1RunnerRunnerIdHealthGet200Response](docs/GetRunnerHealthV1RunnerRunnerIdHealthGet200Response.md)
  - [HTTPValidationError](docs/HTTPValidationError.md)
  - [JobCreate](docs/JobCreate.md)
  - [JobRead](docs/JobRead.md)
  - [JobUpdate](docs/JobUpdate.md)
- - [RegisterRunnerV1RunnerRegisterPost200Response](docs/RegisterRunnerV1RunnerRegisterPost200Response.md)
- - [RegisterRunnerV1RunnerRegisterPostRequest](docs/RegisterRunnerV1RunnerRegisterPostRequest.md)
- - [UpdateRunnerHealthV1RunnerRunnerIdHealthPutRequest](docs/UpdateRunnerHealthV1RunnerRunnerIdHealthPutRequest.md)
+ - [RunnerCreate](docs/RunnerCreate.md)
+ - [RunnerHealthResponse](docs/RunnerHealthResponse.md)
+ - [RunnerHealthUpdateResponse](docs/RunnerHealthUpdateResponse.md)
+ - [RunnerRegisterResponse](docs/RunnerRegisterResponse.md)
  - [ValidationError](docs/ValidationError.md)
  - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
  - [VmDependencies](docs/VmDependencies.md)
@@ -120,17 +120,7 @@ Class | Method | HTTP request | Description
 <a id="documentation-for-authorization"></a>
 ## Documentation For Authorization
 
-
-Authentication schemes defined for the API:
-<a id="APIAccessToken"></a>
-### APIAccessToken
-
-- **Type**: HTTP basic authentication
-
-<a id="BuilderToken"></a>
-### BuilderToken
-
-- **Type**: HTTP basic authentication
+Endpoints do not require authorization.
 
 
 ## Author