Spawn reactive runner (#8)

* add public interface * WIP checkin * change reactive.runner_manager.reconcile signature * move reactive types into own module * refactor config and use it in script * WIP checkin unit tests * implement spawning a runner * lint * Add unit tests for github_client * add cleanup * write get_job_info method * rename run_url -> job_url * Fix parsing of job_url * validate path of job_url * rename reactive_config -> runner_config * rename manager_name -> name * add pymongo depedency * bump version in pyproject.toml
canonical · Sep 19, 2024 · e53ed35 · e53ed35
1 parent 59974da
commit e53ed35
Show file tree

Hide file tree

Showing 30 changed files with 752 additions and 363 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@
 
 [project]
 name = "github-runner-manager"
-version = "0.1.5"
+version = "0.2.0"
 authors = [
     { name = "Canonical IS DevOps", email = "[email protected]" },
 ]
@@ -46,7 +46,7 @@ omit = [
 ]
 
 [tool.coverage.report]
-fail_under = 79
+fail_under = 80
 show_missing = true
 
 

diff --git a/requirements.txt b/requirements.txt
@@ -4,3 +4,4 @@ jinja2
 kombu==5.4.1
 openstacksdk>=3,<4
 pydantic < 2
+pymongo==4.8.0
diff --git a/src-docs/github_client.md b/src-docs/github_client.md
@@ -81,19 +81,43 @@ Delete the self-hosted runner from GitHub.
 
 ---
 
-<a href="../src/github_runner_manager/github_client.py#L203"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/github_client.py#L244"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `get_job_info`
 
 ```python
-get_job_info(
+get_job_info(path: GitHubRepo, job_id: str) → JobInfo
+```
+
+Get information about a job identified by the job id. 
+
+
+
+**Args:**
+
+ - <b>`path`</b>:  GitHub repository path in the format '<owner>/<repo>'. 
+ - <b>`job_id`</b>:  The job id. 
+
+
+
+**Returns:**
+ The JSON response from the API. 
+
+---
+
+<a href="../src/github_runner_manager/github_client.py#L203"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>method</kbd> `get_job_info_by_runner_name`
+
+```python
+get_job_info_by_runner_name(
     path: GitHubRepo,
     workflow_run_id: str,
     runner_name: str
-) → JobStats
+) → JobInfo
 ```
 
-Get information about a job for a specific workflow run. 
+Get information about a job for a specific workflow run identified by the runner name. 
 
 
 
@@ -107,7 +131,7 @@ Get information about a job for a specific workflow run.
 
 **Raises:**
 
- - <b>`TokenError`</b>:  if there was an error with the Github token crdential provided. 
+ - <b>`TokenError`</b>:  if there was an error with the Github token credential provided. 
  - <b>`JobNotFoundError`</b>:  If no jobs were found. 
 
 

diff --git a/src-docs/manager.runner_manager.md b/src-docs/manager.runner_manager.md
@@ -77,6 +77,7 @@ Configuration for the runner manager.
 
 **Attributes:**
 
+ - <b>`name`</b>:  A name to identify this manager. 
  - <b>`token`</b>:  GitHub personal access token to query GitHub API. 
  - <b>`path`</b>:  Path to GitHub repository or organization to registry the runners. 
 
@@ -85,7 +86,7 @@ Configuration for the runner manager.
 ### <kbd>method</kbd> `__init__`
 
 ```python
-__init__(token: str, path: GitHubOrg | GitHubRepo) → None
+__init__(name: str, token: str, path: GitHubOrg | GitHubRepo) → None
 ```
 
 
@@ -98,7 +99,7 @@ __init__(token: str, path: GitHubOrg | GitHubRepo) → None
 
 ---
 
-<a href="../src/github_runner_manager/manager/runner_manager.py#L94"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/manager/runner_manager.py#L96"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `RunnerManager`
 Manage the runners. 
@@ -110,16 +111,12 @@ Manage the runners.
  - <b>`manager_name`</b>:  A name to identify this manager. 
  - <b>`name_prefix`</b>:  The name prefix of the runners. 
 
-<a href="../src/github_runner_manager/manager/runner_manager.py#L102"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/manager/runner_manager.py#L104"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `__init__`
 
 ```python
-__init__(
-    manager_name: str,
-    cloud_runner_manager: CloudRunnerManager,
-    config: RunnerManagerConfig
-)
+__init__(cloud_runner_manager: CloudRunnerManager, config: RunnerManagerConfig)
 ```
 
 Construct the object. 
@@ -128,7 +125,6 @@ Construct the object.
 
 **Args:**
 
- - <b>`manager_name`</b>:  A name to identify this manager. 
  - <b>`cloud_runner_manager`</b>:  For managing the cloud instance of the runner. 
  - <b>`config`</b>:  Configuration of this class. 
 

diff --git a/src-docs/manager.runner_scaler.md b/src-docs/manager.runner_scaler.md
@@ -9,7 +9,7 @@ Module for scaling the runners amount.
 
 ---
 
-<a href="../src/github_runner_manager/manager/runner_scaler.py#L28"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/manager/runner_scaler.py#L26"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `RunnerInfo`
 Information on the runners. 
@@ -50,17 +50,20 @@ __init__(
 
 ---
 
-<a href="../src/github_runner_manager/manager/runner_scaler.py#L49"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/manager/runner_scaler.py#L47"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `RunnerScaler`
 Manage the reconcile of runners. 
 
-<a href="../src/github_runner_manager/manager/runner_scaler.py#L52"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/manager/runner_scaler.py#L50"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `__init__`
 
 ```python
-__init__(runner_manager: RunnerManager, reactive_config: ReactiveConfig | None)
+__init__(
+    runner_manager: RunnerManager,
+    reactive_runner_config: RunnerConfig | None
+)
 ```
 
 Construct the object. 
@@ -70,7 +73,7 @@ Construct the object.
 **Args:**
 
  - <b>`runner_manager`</b>:  The RunnerManager to perform runner reconcile. 
- - <b>`reactive_config`</b>:  Reactive runner configuration. 
+ - <b>`reactive_runner_config`</b>:  Reactive runner configuration. 
 
 
 

diff --git a/src-docs/openstack_cloud.openstack_runner_manager.md b/src-docs/openstack_cloud.openstack_runner_manager.md
@@ -78,24 +78,29 @@ __init__(image: str, flavor: str, network: str) → None
 
 ---
 
-<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L114"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L101"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
-## <kbd>class</kbd> `OpenStackRunnerManager`
-Manage self-hosted runner on OpenStack cloud. 
+## <kbd>class</kbd> `OpenStackRunnerManagerConfig`
+Configuration for OpenStack runner manager. 
 
 
 
 **Attributes:**
 
- - <b>`name_prefix`</b>:  The name prefix of the runners created. 
+ - <b>`name`</b>:  The name of the manager. 
+ - <b>`prefix`</b>:  The prefix of the runner names. 
+ - <b>`cloud_config`</b>:  The configuration for OpenStack cloud. 
+ - <b>`server_config`</b>:  The configuration for OpenStack server. 
+ - <b>`runner_config`</b>:  The configuration for the GitHub runner. 
+ - <b>`service_config`</b>:  The configuration for supporting services. 
 
-<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L122"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../<string>"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `__init__`
 
 ```python
 __init__(
-    manager_name: str,
+    name: str,
     prefix: str,
     cloud_config: OpenStackCloudConfig,
     server_config: OpenStackServerConfig | None,
@@ -104,18 +109,42 @@ __init__(
 ) → None
 ```
 
+
+
+
+
+
+
+
+
+---
+
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L135"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>class</kbd> `OpenStackRunnerManager`
+Manage self-hosted runner on OpenStack cloud. 
+
+
+
+**Attributes:**
+
+ - <b>`name_prefix`</b>:  The name prefix of the runners created. 
+
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L142"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>method</kbd> `__init__`
+
+```python
+__init__(config: OpenStackRunnerManagerConfig) → None
+```
+
 Construct the object. 
 
 
 
 **Args:**
 
- - <b>`manager_name`</b>:  A name to identify this manager. 
- - <b>`prefix`</b>:  The prefix to runner name. 
- - <b>`cloud_config`</b>:  The configuration for OpenStack authorisation. 
- - <b>`server_config`</b>:  The configuration for creating OpenStack server. Unable to create  runner if None. 
- - <b>`runner_config`</b>:  The configuration for the runner. 
- - <b>`service_config`</b>:  The configuration of supporting services of the runners. 
+ - <b>`config`</b>:  The configuration for the openstack runner manager. 
 
 
 ---
@@ -133,7 +162,7 @@ The prefix of runner names.
 
 ---
 
-<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L322"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L354"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `cleanup`
 
@@ -156,7 +185,7 @@ Cleanup runner and resource on the cloud.
 
 ---
 
-<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L172"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L181"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `create_runner`
 
@@ -186,7 +215,7 @@ Create a self-hosted runner.
 
 ---
 
-<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L271"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L289"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `delete_runner`
 
@@ -210,7 +239,7 @@ Delete self-hosted runners.
 
 ---
 
-<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L297"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L323"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `flush_runners`
 
@@ -233,7 +262,7 @@ Remove idle and/or busy runners.
 
 ---
 
-<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L217"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L230"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `get_runner`
 
@@ -256,7 +285,7 @@ Get a self-hosted runner by instance id.
 
 ---
 
-<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L239"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/github_runner_manager/openstack_cloud/openstack_runner_manager.py#L257"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `get_runners`