feat: health check

[yanksyoon]

Applicable spec: N/A

Overview

• Adds a thorough health check.

Rationale

• To safely health check OpenStack statuses via openstack instance status, cloud-init status and ssh connection process tatus.

Module Changes

• openstack_manager health check function.

Library/Dependency Changes

None.

Checklist

• The contributing guide was applied
• The documentation is generated using src-docs
• The PR is tagged with appropriate label (urgent, trivial, complex)
• The library version in pyproject.toml is incremented

[cbartz]

LGTM, can you create a draft PR on github-runner-operator and pin this branch to let the integration tests run? Thanks.

[cbartz]

Created canonical/github-runner-operator#372

[github-actions]

Test coverage for 2141d24

Name                                                         Stmts   Miss Branch BrPart  Cover   Missing
--------------------------------------------------------------------------------------------------------
src/github_runner_manager/__init__.py                            0      0      0      0   100%
src/github_runner_manager/errors.py                             22      0      0      0   100%
src/github_runner_manager/github_client.py                      83     36     34      2    47%   63-72, 100-135, 148-157, 171-180, 191-198, 220->260, 254
src/github_runner_manager/manager/__init__.py                    0      0      0      0   100%
src/github_runner_manager/manager/cloud_runner_manager.py       61      0      6      0   100%
src/github_runner_manager/manager/github_runner_manager.py      17      0      6      0   100%
src/github_runner_manager/manager/runner_manager.py            134     34     48      5    70%   175, 187, 191, 207-212, 230-231, 268-284, 298-305, 325-329, 338
src/github_runner_manager/manager/runner_scaler.py             106     10     38      3    90%   128-129, 143-144, 149, 155, 249-250, 263-264
src/github_runner_manager/metrics/__init__.py                    0      0      0      0   100%
src/github_runner_manager/metrics/events.py                     55      2      8      1    95%   56->59, 166-167
src/github_runner_manager/metrics/github.py                     16      0      0      0   100%
src/github_runner_manager/metrics/runner.py                    144     10     32      3    91%   164, 190-203, 239, 276, 458-459
src/github_runner_manager/metrics/runner_logs.py                24      5      4      1    79%   30-33, 47->46, 51-52
src/github_runner_manager/metrics/storage.py                    70      8     12      0    90%   89-90, 117-118, 182-183, 189-190
src/github_runner_manager/metrics/type.py                        5      0      0      0   100%
src/github_runner_manager/openstack_cloud/__init__.py           26      0      2      0   100%
src/github_runner_manager/reactive/__init__.py                   0      0      0      0   100%
src/github_runner_manager/reactive/consumer.py                  40      2      6      0    96%   98-101
src/github_runner_manager/reactive/runner.py                    18     18      6      0     0%   6-50
src/github_runner_manager/reactive/runner_manager.py            53      0     14      1    99%   103->exit
src/github_runner_manager/types_/__init__.py                    33      8      4      1    70%   39-52, 72, 80
src/github_runner_manager/types_/github.py                      72      9     10      0    82%   186, 207, 228-235
src/github_runner_manager/utilities.py                          46     28     14      0    30%   73-100, 127-145, 157-158
--------------------------------------------------------------------------------------------------------
TOTAL                                                         1025    170    244     17    80%

Static code analysis report

Run started:2024-09-12 13:15:31.868518

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 3698
  Total lines skipped (#nosec): 2
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 3

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):