chore: rename cloud runner instance [DO NOT MERGE WITHOUT CHANGING BASE TO MAIN] (#608)

* chore: rename cloud-runner-manager to vm-manager

* chore: rename cloud-runner-manager to vm-manager

* chore: rename CloudRunnerInstance to VM

* chore: rename cloud runner state

Author: yanksyoon

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

@@ -14,12 +14,7 @@
 from github_runner_manager import constants
 from github_runner_manager.errors import GithubMetricsError, RunnerError
 from github_runner_manager.manager.models import InstanceID, RunnerIdentity, RunnerMetadata
-from github_runner_manager.manager.vm_manager import (
-    CloudRunnerInstance,
-    CloudRunnerManager,
-    CloudRunnerState,
-    HealthState,
-)
+from github_runner_manager.manager.vm_manager import VM, CloudRunnerManager, HealthState, VMState
 from github_runner_manager.metrics import events as metric_events
 from github_runner_manager.metrics import github as github_metrics
 from github_runner_manager.metrics import runner as runner_metrics
@@ -78,12 +73,12 @@ class RunnerInstance:
     metadata: RunnerMetadata
     health: HealthState
     platform_state: PlatformRunnerState | None
-    cloud_state: CloudRunnerState
+    cloud_state: VMState
 
     @classmethod
     def from_cloud_and_platform_health(
         cls,
-        cloud_instance: CloudRunnerInstance,
+        cloud_instance: VM,
         platform_health_state: PlatformRunnerHealth | None,
     ) -> "RunnerInstance":
         """Construct an instance.
@@ -96,7 +91,7 @@ def from_cloud_and_platform_health(
             The RunnerInstance instantiated from cloud instance and platform state.
         """
         return cls(
-            name=cloud_instance.name,
+            name=cloud_instance.instance_id.name,
             instance_id=cloud_instance.instance_id,
             metadata=cloud_instance.metadata,
             health=cloud_instance.health,
@@ -317,7 +312,7 @@ def _cleanup_resources(
 
     def _delete_cloud_runners(
         self,
-        cloud_runners: Sequence[CloudRunnerInstance],
+        cloud_runners: Sequence[VM],
         runners_health: Sequence[PlatformRunnerHealth],
         delete_busy_runners: bool = False,
     ) -> Iterable[runner_metrics.RunnerMetrics]:
@@ -551,7 +546,7 @@ def _create_runner(args: _CreateRunnerArgs) -> InstanceID:
 
 
 def _filter_runner_to_delete(
-    cloud_runner: CloudRunnerInstance,
+    cloud_runner: VM,
     health: PlatformRunnerHealth | None,
     *,
     clean_idle: bool = False,
@@ -598,7 +593,7 @@ def _filter_runner_to_delete(
 
 
 def _runner_deletion_sort_key(
-    health_runners_map: dict[InstanceID, PlatformRunnerHealth], cloud_runner: CloudRunnerInstance
+    health_runners_map: dict[InstanceID, PlatformRunnerHealth], cloud_runner: VM
 ) -> int:
     """Order the runners in accordance to how inconvenient it is to delete them.
 

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

@@ -36,7 +36,7 @@ class HealthState(Enum):
     UNKNOWN = auto()
 
 
-class CloudRunnerState(str, Enum):
+class VMState(str, Enum):
     """Represent state of the instance hosting the runner.
 
     Attributes:
@@ -61,7 +61,7 @@ class CloudRunnerState(str, Enum):
     @staticmethod
     def from_openstack_server_status(  # pragma: no cover
         openstack_server_status: str,
-    ) -> "CloudRunnerState":
+    ) -> "VMState":
         """Create from openstack server status.
 
         The openstack server status are documented here:
@@ -73,45 +73,43 @@ def from_openstack_server_status(  # pragma: no cover
         Returns:
             The state of the runner.
         """
-        state = CloudRunnerState.UNEXPECTED
+        state = VMState.UNEXPECTED
         match openstack_server_status:
             case "BUILD":
-                state = CloudRunnerState.CREATED
+                state = VMState.CREATED
             case "REBUILD":
-                state = CloudRunnerState.CREATED
+                state = VMState.CREATED
             case "ACTIVE":
-                state = CloudRunnerState.ACTIVE
+                state = VMState.ACTIVE
             case "ERROR":
-                state = CloudRunnerState.ERROR
+                state = VMState.ERROR
             case "STOPPED":
-                state = CloudRunnerState.STOPPED
+                state = VMState.STOPPED
             case "DELETED":
-                state = CloudRunnerState.DELETED
+                state = VMState.DELETED
             case "UNKNOWN":
-                state = CloudRunnerState.UNKNOWN
+                state = VMState.UNKNOWN
             case _:
-                state = CloudRunnerState.UNEXPECTED
+                state = VMState.UNEXPECTED
         return state
 
 
 @dataclass
-class CloudRunnerInstance:
+class VM:
     """Information on the runner on the cloud.
 
     Attributes:
-        name: Name of the instance hosting the runner.
         instance_id: ID of the instance.
         metadata: Metadata of the runner.
         health: Health state of the runner.
         state: State of the instance hosting the runner.
         created_at: Creation time of the runner in the cloud provider.
     """
 
-    name: str
     instance_id: InstanceID
     metadata: RunnerMetadata
     health: HealthState
-    state: CloudRunnerState
+    state: VMState
     created_at: datetime
 
     def is_older_than(self, seconds: float) -> bool:
@@ -221,7 +219,7 @@ def create_runner(
         self,
         runner_identity: RunnerIdentity,
         runner_context: RunnerContext,
-    ) -> CloudRunnerInstance:
+    ) -> VM:
         """Create a self-hosted runner.
 
         Args:
@@ -230,7 +228,7 @@ def create_runner(
         """
 
     @abc.abstractmethod
-    def get_runners(self) -> Sequence[CloudRunnerInstance]:
+    def get_runners(self) -> Sequence[VM]:
         """Get cloud self-hosted runners."""
 
     @abc.abstractmethod

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

@@ -18,12 +18,7 @@
 )
 from github_runner_manager.manager.models import InstanceID, RunnerContext, RunnerIdentity
 from github_runner_manager.manager.runner_manager import HealthState
-from github_runner_manager.manager.vm_manager import (
-    CloudRunnerInstance,
-    CloudRunnerManager,
-    CloudRunnerState,
-    RunnerMetrics,
-)
+from github_runner_manager.manager.vm_manager import VM, CloudRunnerManager, RunnerMetrics, VMState
 from github_runner_manager.metrics import runner as runner_metrics
 from github_runner_manager.openstack_cloud.constants import (
     CREATE_SERVER_TIMEOUT,
@@ -94,7 +89,7 @@ def create_runner(
         self,
         runner_identity: RunnerIdentity,
         runner_context: RunnerContext,
-    ) -> CloudRunnerInstance:
+    ) -> VM:
         """Create a self-hosted runner.
 
         Args:
@@ -127,7 +122,7 @@ def create_runner(
         logger.info("Runner %s created successfully", instance.instance_id)
         return self._build_cloud_runner_instance(instance)
 
-    def get_runners(self) -> Sequence[CloudRunnerInstance]:
+    def get_runners(self) -> Sequence[VM]:
         """Get cloud self-hosted runners.
 
         Returns:
@@ -140,15 +135,14 @@ def cleanup(self) -> None:
         """Cleanup runner and resource on the cloud."""
         self._openstack_cloud.delete_expired_keys()
 
-    def _build_cloud_runner_instance(self, instance: OpenstackInstance) -> CloudRunnerInstance:
+    def _build_cloud_runner_instance(self, instance: OpenstackInstance) -> VM:
         """Build a new cloud runner instance from an openstack instance."""
         metadata = instance.metadata
-        return CloudRunnerInstance(
-            name=instance.instance_id.name,
+        return VM(
             metadata=metadata,
             instance_id=instance.instance_id,
             health=HealthState.UNKNOWN,
-            state=CloudRunnerState.from_openstack_server_status(instance.status),
+            state=VMState.from_openstack_server_status(instance.status),
             created_at=instance.created_at,
         )
 

github-runner-manager/tests/unit/factories/runner_instance_factory.py

@@ -10,8 +10,9 @@
 
 from github_runner_manager.manager.models import InstanceID, RunnerIdentity, RunnerMetadata
 from github_runner_manager.manager.runner_manager import RunnerInstance
-from github_runner_manager.manager.vm_manager import CloudRunnerInstance, CloudRunnerState
+from github_runner_manager.manager.vm_manager import VM
 from github_runner_manager.manager.vm_manager import HealthState as CloudHelathState
+from github_runner_manager.manager.vm_manager import VMState
 from github_runner_manager.platform.platform_provider import (
     PlatformRunnerHealth,
     PlatformRunnerState,
@@ -63,17 +64,16 @@ class Meta:
             model: The metadata reference model.
         """
 
-        model = CloudRunnerInstance
+        model = VM
 
-    name = factory.Faker("word")
     instance_id = factory.SubFactory(InstanceIDFactory)
     metadata = factory.SubFactory(RunnerMetadataFactory)
     health = CloudHelathState.HEALTHY
-    state = CloudRunnerState.ACTIVE
+    state = VMState.ACTIVE
     created_at = factory.LazyFunction(lambda: datetime.now(tz=timezone.utc))
 
     @classmethod
-    def from_self_hosted_runner(cls, self_hosted_runner: SelfHostedRunner) -> CloudRunnerInstance:
+    def from_self_hosted_runner(cls, self_hosted_runner: SelfHostedRunner) -> VM:
         """Construct CloudRunnerInstance associated to self hosted runner.
 
         Args:
@@ -142,11 +142,11 @@ class Meta:
     platform_state = platform_state = factory.LazyFunction(
         lambda: secrets.choice(list(PlatformRunnerState))
     )
-    cloud_state = CloudRunnerState.ACTIVE
+    cloud_state = VMState.ACTIVE
 
     @classmethod
     def from_state(
-        cls, cloud_runner: CloudRunnerInstance, platform_health: PlatformRunnerHealth | None = None
+        cls, cloud_runner: VM, platform_health: PlatformRunnerHealth | None = None
     ) -> RunnerInstance:
         """Generate RunnerInstance from cloud runner and platform runner states.
 
@@ -158,7 +158,7 @@ def from_state(
             The generated RunnerInstance.
         """
         return RunnerInstance(
-            name=cloud_runner.name,
+            name=cloud_runner.instance_id.name,
             instance_id=cloud_runner.instance_id,
             metadata=cloud_runner.metadata,
             health=cloud_runner.health,

github-runner-manager/tests/unit/fake_runner_managers.py

@@ -12,7 +12,7 @@
     RunnerIdentity,
     RunnerMetadata,
 )
-from github_runner_manager.manager.vm_manager import CloudRunnerInstance, CloudRunnerManager
+from github_runner_manager.manager.vm_manager import VM, CloudRunnerManager
 from github_runner_manager.metrics.runner import RunnerMetrics
 from github_runner_manager.openstack_cloud.openstack_cloud import _MAX_NOVA_COMPUTE_API_VERSION
 from github_runner_manager.platform.platform_provider import (
@@ -108,17 +108,15 @@ def name_prefix(self) -> str:
         """The naming prefix for runners managed."""
         return "fake_cloud_runner_manager"
 
-    def __init__(self, initial_cloud_runners: list[CloudRunnerInstance]) -> None:
+    def __init__(self, initial_cloud_runners: list[VM]) -> None:
         """Initialize the Cloud Runner Manager.
 
         Args:
             initial_cloud_runners: A list of initial Cloud Runner Instances.
         """
         self._cloud_runners = {runner.instance_id: runner for runner in initial_cloud_runners}
 
-    def create_runner(
-        self, runner_identity: RunnerIdentity, runner_context: RunnerContext
-    ) -> CloudRunnerInstance:
+    def create_runner(self, runner_identity: RunnerIdentity, runner_context: RunnerContext) -> VM:
         """Create a runner instance for the given runner identity and context.
 
         Args:
@@ -132,7 +130,7 @@ def create_runner(
         self._cloud_runners[runner_identity.instance_id] = created_runner
         return created_runner
 
-    def get_runners(self) -> Sequence[CloudRunnerInstance]:
+    def get_runners(self) -> Sequence[VM]:
         """Get all the cloud runner instances managed by the manager.
 
         Returns:

github-runner-manager/tests/unit/manager/test_runner_manager.py

@@ -9,7 +9,7 @@
 
 from github_runner_manager.manager.models import RunnerMetadata
 from github_runner_manager.manager.runner_manager import FlushMode, RunnerInstance, RunnerManager
-from github_runner_manager.manager.vm_manager import CloudRunnerInstance, CloudRunnerManager
+from github_runner_manager.manager.vm_manager import VM, CloudRunnerManager
 from github_runner_manager.platform.platform_provider import PlatformProvider
 from github_runner_manager.types_.github import SelfHostedRunner
 from tests.unit.factories.runner_instance_factory import (
@@ -94,9 +94,9 @@
 )
 def test_flush_runners(
     initial_runners: list[SelfHostedRunner],
-    initial_cloud_runners: list[CloudRunnerInstance],
+    initial_cloud_runners: list[VM],
     expected_runners: list[SelfHostedRunner],
-    expected_cloud_runners: list[CloudRunnerInstance],
+    expected_cloud_runners: list[VM],
     flush_mode: FlushMode,
 ):
     """
@@ -168,9 +168,9 @@ def test_flush_runners(
 )
 def test_runner_maanger_cleanup(
     initial_runners: list[SelfHostedRunner],
-    initial_cloud_runners: list[CloudRunnerInstance],
+    initial_cloud_runners: list[VM],
     expected_runners: list[SelfHostedRunner],
-    expected_cloud_runners: list[CloudRunnerInstance],
+    expected_cloud_runners: list[VM],
 ):
     """
     arrange: Given GitHub runners and Cloud runners.
@@ -226,7 +226,7 @@ def test_runner_manager_create_runners() -> None:
         pytest.param(
             [],
             [cloud_runner := CloudRunnerInstanceFactory()],
-            (RunnerInstanceFactory(name=cloud_runner.name),),
+            (RunnerInstanceFactory(name=cloud_runner.instance_id.name),),
             id="cloud runner without platform runner",
         ),
         pytest.param(
@@ -236,14 +236,14 @@ def test_runner_manager_create_runners() -> None:
                     self_hosted_runner=runner_with_cloud
                 )
             ],
-            (RunnerInstanceFactory(name=cloud_runner.name),),
+            (RunnerInstanceFactory(name=cloud_runner.instance_id.name),),
             id="platform runner with cloud runner",
         ),
     ],
 )
 def test_runner_manager_get_runners(
     initial_runners: list[SelfHostedRunner],
-    initial_cloud_runners: list[CloudRunnerInstance],
+    initial_cloud_runners: list[VM],
     expected_runner_instances: tuple[RunnerInstance],
 ):
     """
@@ -295,10 +295,10 @@ def test_runner_manager_get_runners(
 )
 def test_runner_manager_deterministic_delete_runners(
     initial_runners: list[SelfHostedRunner],
-    initial_cloud_runners: list[CloudRunnerInstance],
+    initial_cloud_runners: list[VM],
     num_delete: int,
     expected_runners: list[SelfHostedRunner],
-    expected_cloud_runners: list[CloudRunnerInstance],
+    expected_cloud_runners: list[VM],
 ):
     """
     arrange: given initial runners (platform and cloud).
@@ -338,7 +338,7 @@ def test_runner_manager_deterministic_delete_runners(
 )
 def test_runner_manager_non_deterministic_delete_runners(
     initial_runners: list[SelfHostedRunner],
-    initial_cloud_runners: list[CloudRunnerInstance],
+    initial_cloud_runners: list[VM],
     num_delete: int,
     expected_runners_count: int,
     expected_cloud_runners_count: int,