chore: rename cleanup function (#605)

* chore: rename cleanup function

* test: update cleanup function name

* chore: remove unused import

Author: yanksyoon

github-runner-manager/src/github_runner_manager/openstack_cloud/openstack_cloud.py

@@ -532,7 +532,7 @@ def get_instances(self) -> tuple[OpenstackInstance, ...]:
             )
 
     @_catch_openstack_errors
-    def cleanup(self) -> None:
+    def delete_expired_keys(self) -> None:
         """Cleanup unused key files and openstack keypairs."""
         with self._get_openstack_connection() as conn:
             instances = self._get_openstack_instances(conn)

github-runner-manager/src/github_runner_manager/openstack_cloud/openstack_runner_manager.py

@@ -5,7 +5,6 @@
 
 import logging
 import secrets
-from dataclasses import dataclass
 from pathlib import Path
 from typing import Sequence
 
@@ -47,25 +46,6 @@
 OUTDATED_METRICS_STORAGE_IN_SECONDS = CREATE_SERVER_TIMEOUT + 30  # add a bit on top of the timeout
 
 
-class _GithubRunnerRemoveError(Exception):
-    """Represents an error while SSH into a runner and running the remove script."""
-
-
-@dataclass
-class _RunnerHealth:
-    """Runners with health state.
-
-    Attributes:
-        healthy: The list of healthy runners.
-        unhealthy:  The list of unhealthy runners.
-        unknown: The list of runners whose health state could not be determined.
-    """
-
-    healthy: tuple[OpenstackInstance, ...]
-    unhealthy: tuple[OpenstackInstance, ...]
-    unknown: tuple[OpenstackInstance, ...]
-
-
 class OpenStackRunnerManager(CloudRunnerManager):
     """Manage self-hosted runner on OpenStack cloud.
 
@@ -158,7 +138,7 @@ def get_runners(self) -> Sequence[CloudRunnerInstance]:
 
     def cleanup(self) -> None:
         """Cleanup runner and resource on the cloud."""
-        self._openstack_cloud.cleanup()
+        self._openstack_cloud.delete_expired_keys()
 
     def _build_cloud_runner_instance(self, instance: OpenstackInstance) -> CloudRunnerInstance:
         """Build a new cloud runner instance from an openstack instance."""

github-runner-manager/tests/unit/openstack_cloud/test_openstack_cloud.py

@@ -85,7 +85,7 @@ def mock_openstack_conn_fixture(monkeypatch: pytest.MonkeyPatch):
         ),
         pytest.param("get_instance", {"instance_id": FAKE_ARG}, id="get_instance"),
         pytest.param("get_instances", {}, id="get_instances"),
-        pytest.param("cleanup", {}, id="cleanup"),
+        pytest.param("delete_expired_keys", {}, id="delete_expired_keys"),
     ],
 )
 def test_raises_openstack_error(
@@ -237,7 +237,7 @@ def test_keypair_cleanup_freshly_created_keypairs(
     openstack_connect_mock.return_value = openstack_connection_mock
 
     # act #
-    openstack_cloud.cleanup()
+    openstack_cloud.delete_expired_keys()
 
     # assert #
     # Check if only the old keypairs are deleted