refactor: rename resource_available to usage_available (#1263)

Author: ciyer

components/renku_data_services/crc/api.spec.yaml

@@ -1229,10 +1229,10 @@ components:
           $ref: "#/components/schemas/K8sLabelList"
         node_affinities:
           $ref: "#/components/schemas/NodeAffinityList"
-        resource_available:
-          $ref: "#/components/schemas/ResourceAvailable"
-        resource_available_percentage:
-          $ref: "#/components/schemas/ResourceAvailablePercentage"
+        usage_available:
+          $ref: "#/components/schemas/UsageAvailable"
+        usage_available_percentage:
+          $ref: "#/components/schemas/UsageAvailablePercentage"
       required: ["cpu", "memory", "gpu", "max_storage", "name", "id", "default", "default_storage"]
       example:
         name: "resource class"
@@ -1701,13 +1701,13 @@ components:
       minimum: 0
       # Max value for int64 in postgres
       maximum: 9223372036854775807
-    ResourceAvailable:
+    UsageAvailable:
       type: number
       format: double
       description: Amount of a resource available (in hours)
       example: 3.141
       minimum: 0
-    ResourceAvailablePercentage:
+    UsageAvailablePercentage:
       type: number
       format: float
       description: Percentage of available resources based on quota

components/renku_data_services/crc/apispec.py

@@ -799,13 +799,13 @@ class ResourceClassWithIdFiltered(BaseAPISpec):
         examples=[[{"key": "test-label-1", "required_during_scheduling": False}]],
         min_length=0,
     )
-    resource_available: Optional[float] = Field(
+    usage_available: Optional[float] = Field(
         None,
         description="Amount of a resource available (in hours)",
         examples=[3.141],
         ge=0.0,
     )
-    resource_available_percentage: Optional[float] = Field(
+    usage_available_percentage: Optional[float] = Field(
         None,
         description="Percentage of available resources based on quota",
         examples=[75.5],

components/renku_data_services/crc/core.py

@@ -631,7 +631,7 @@ def __validate_runtime_platform(body: apispec.RuntimePlatform | None) -> models.
     return models.RuntimePlatform(platform_str)
 
 
-async def calculate_available_resources(
+async def calculate_available_usage(
     resource_requests_repo: ResourceRequestsRepo,
     resource_pool_id: int,
     resource_class_id: int,

components/renku_data_services/crc/db.py

@@ -28,7 +28,7 @@
 from renku_data_services.crc import models
 from renku_data_services.crc import orm as schemas
 from renku_data_services.crc.core import (
-    calculate_available_resources,
+    calculate_available_usage,
     validate_resource_class_update,
     validate_resource_pool_update,
 )
@@ -315,13 +315,13 @@ async def filter_resource_pools(
                 if self.resource_requests_repo:
                     updated_classes = []
                     for resource_class in rp_model.classes:
-                        resource_available, resource_available_percentage = await calculate_available_resources(
+                        usage_available, usage_available_percentage = await calculate_available_usage(
                             self.resource_requests_repo, rp.id, resource_class.id, resource_usage
                         )
                         updated_class = replace(
                             resource_class,
-                            resource_available=resource_available,
-                            resource_available_percentage=resource_available_percentage,
+                            usage_available=usage_available,
+                            usage_available_percentage=usage_available_percentage,
                         )
                         updated_classes.append(updated_class)
 

components/renku_data_services/crc/models.py

@@ -110,8 +110,8 @@ class ResourceClass(ResourcesCompareMixin):
     node_affinities: list[NodeAffinity] = field(default_factory=list)
     tolerations: list[str] = field(default_factory=list)
     quota: str | None = None
-    resource_available: float | None = None
-    resource_available_percentage: float | None = None
+    usage_available: float | None = None
+    usage_available_percentage: float | None = None
 
 
 @dataclass(frozen=True, eq=True, kw_only=True)

components/renku_data_services/crc/orm.py

@@ -145,7 +145,7 @@ def from_unsaved_model(
     def dump(
         self,
         matching_criteria: models.ResourceClass | models.UnsavedResourceClass | None = None,
-        resource_available: float | None = None,
+        usage_available: float | None = None,
     ) -> models.ResourceClass:
         """Create a resource class model from the ORM object."""
         matching: bool | None = None
@@ -169,7 +169,7 @@ def dump(
             tolerations=[toleration.key for toleration in self.tolerations],
             matching=matching,
             quota=self.resource_pool.quota if self.resource_pool else None,
-            resource_available=resource_available,
+            usage_available=usage_available,
         )
 
 

test/bases/renku_data_services/data_api/test_resource_pools.py

@@ -1655,7 +1655,7 @@ async def test_resource_class_empty_patch_noop(
 async def test_resource_pools_quota_with_partial_usage(
     sanic_client, admin_headers, user_headers, regular_user, valid_resource_pool_payload, cluster, app_manager_instance
 ) -> None:
-    """Test resource pools endpoint returns correct resource_usage and resource_available."""
+    """Test resource pools endpoint returns correct resource_usage and usage_available."""
     payload = valid_resource_pool_payload.copy()
     payload["classes"] = [
         {
@@ -1722,9 +1722,9 @@ async def test_resource_pools_quota_with_partial_usage(
 
     resource_class = resource_pool["classes"][0]
 
-    # resource_available should be 3 hours which is 75 percent of the total 4 hours available
-    assert resource_class["resource_available"] == 3.0
-    assert resource_class["resource_available_percentage"] == 75.0
+    # usage_available should be 3 hours which is 75 percent of the total 4 hours available
+    assert resource_class["usage_available"] == 3.0
+    assert resource_class["usage_available_percentage"] == 75.0
 
 
 @pytest.mark.asyncio
@@ -1738,7 +1738,7 @@ async def test_resource_pools_quota_with_no_usage(
     cluster: KindCluster,
     app_manager_instance,
 ) -> None:
-    """Test resource pools endpoint returns correct resource_available when user has no usage."""
+    """Test resource pools endpoint returns correct usage_available when user has no usage."""
     from renku_data_services.resource_usage.db import ResourceRequestsRepo
     from renku_data_services.resource_usage.model import Credit, ResourceClassCost, ResourcePoolLimits
 
@@ -1792,10 +1792,10 @@ async def test_resource_pools_quota_with_no_usage(
 
     resource_class = resource_pool["classes"][0]
 
-    # resource_available should be full quota: 200/50 = 4.0 hours
-    assert resource_class["resource_available"] == 4.0
-    # resource_available_percentage should be 100%
-    assert resource_class["resource_available_percentage"] == 100.0
+    # usage_available should be full quota: 200/50 = 4.0 hours
+    assert resource_class["usage_available"] == 4.0
+    # usage_available_percentage should be 100%
+    assert resource_class["usage_available_percentage"] == 100.0
 
 
 @pytest.mark.asyncio
@@ -1875,10 +1875,10 @@ async def test_resource_pools_quota_exceeded(
 
     resource_class = resource_pool["classes"][0]
 
-    # resource_available should be 0 (quota exceeded)
-    assert resource_class["resource_available"] == 0.0
-    # resource_available_percentage should be 0%
-    assert resource_class["resource_available_percentage"] == 0.0
+    # usage_available should be 0 (quota exceeded)
+    assert resource_class["usage_available"] == 0.0
+    # usage_available_percentage should be 0%
+    assert resource_class["usage_available_percentage"] == 0.0
 
 
 @pytest.mark.asyncio
@@ -1892,7 +1892,7 @@ async def test_resource_pools_quota_with_no_limits(
     cluster: KindCluster,
     app_manager_instance,
 ) -> None:
-    """Test resource pools endpoint returns null for resource_available when no limits are set."""
+    """Test resource pools endpoint returns null for usage_available when no limits are set."""
     payload = valid_resource_pool_payload.copy()
     payload["classes"] = [
         {
@@ -1950,10 +1950,10 @@ async def test_resource_pools_quota_with_no_limits(
 
     resource_class = resource_pool["classes"][0]
 
-    # resource_available should not exist in the response since it's None
-    assert "resource_available" not in resource_class
-    # resource_available_percentage should not exist in the response since it's None
-    assert "resource_available_percentage" not in resource_class
+    # usage_available should not exist in the response since it's None
+    assert "usage_available" not in resource_class
+    # usage_available_percentage should not exist in the response since it's None
+    assert "usage_available_percentage" not in resource_class
 
 
 @pytest.mark.asyncio
@@ -1967,7 +1967,7 @@ async def test_resource_pools_quota_with_no_costs(
     cluster: KindCluster,
     app_manager_instance,
 ) -> None:
-    """Test resource pools endpoint returns null for resource_available when no costs are defined."""
+    """Test resource pools endpoint returns null for usage_available when no costs are defined."""
     payload = valid_resource_pool_payload.copy()
     payload["classes"] = [
         {
@@ -2029,7 +2029,7 @@ async def test_resource_pools_quota_with_no_costs(
 
     resource_class = resource_pool["classes"][0]
 
-    # resource_available should not exist in the response since it's None
-    assert "resource_available" not in resource_class
-    # resource_available_percentage should not exist in the response since it's None
-    assert "resource_available_percentage" not in resource_class
+    # usage_available should not exist in the response since it's None
+    assert "usage_available" not in resource_class
+    # usage_available_percentage should not exist in the response since it's None
+    assert "usage_available_percentage" not in resource_class