✨ Enhancement/get node resources (ITISFoundation#2987)

Author: sanderegg

api/specs/webserver/components/schemas/node_resources.yaml

@@ -0,0 +1,30 @@
+components:
+  schemas:
+    NodeResourcesEnveloped:
+      type: object
+      required:
+        - data
+      properties:
+        data:
+          $ref: "#/components/schemas/NodeResources"
+        error:
+          nullable: true
+          default: null
+    NodeResources:
+      type: object
+      additionalProperties:
+        type: object
+        required:
+          - limit
+          - reservation
+        properties:
+          limit:
+            anyOf:
+              - type: integer
+              - type: number
+              - type: string
+          reservation:
+            anyOf:
+              - type: integer
+              - type: number
+              - type: string

api/specs/webserver/openapi-catalog.yaml

@@ -400,6 +400,36 @@ paths:
           description: Validation Error
       summary: Get Compatible Outputs Given Target Input
 
+  catalog_services_service_key_service_version_resources:
+    get:
+      tags:
+        - catalog
+      description: Returns the service default resources
+      operationId: get_service_resources_handler
+      parameters:
+        - in: path
+          name: service_key
+          required: true
+          schema:
+            pattern: ^(simcore)/(services)/(comp|dynamic|frontend)(/[\w/-]+)+$
+            title: Service Key
+            type: string
+        - in: path
+          name: service_version
+          required: true
+          schema:
+            pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*)){2}(-(0|[1-9]\d*|\d*[-a-zA-Z][-\da-zA-Z]*)(\.(0|[1-9]\d*|\d*[-a-zA-Z][-\da-zA-Z]*))*)?(\+[-\da-zA-Z]+(\.[-\da-zA-Z-]+)*)?$
+            title: Service Version
+            type: string
+      responses:
+        "200":
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServiceResourcesEnveloped"
+        default:
+          $ref: "#/components/responses/DefaultErrorResponse"
 components:
   parameters:
     ServiceType:
@@ -678,3 +708,8 @@ components:
         - SelectBox
       title: WidgetType
       type: string
+    ServiceResourcesEnveloped:
+      $ref: "./components/schemas/node_resources.yaml#/components/schemas/NodeResourcesEnveloped"
+  responses:
+    DefaultErrorResponse:
+      $ref: "./openapi.yaml#/components/responses/DefaultErrorResponse"

api/specs/webserver/openapi-projects.yaml

@@ -476,6 +476,55 @@ paths:
         default:
           $ref: "#/components/responses/DefaultErrorResponse"
 
+  /projects/{project_id}/nodes/{node_id}/resources:
+    parameters:
+      - name: project_id
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: node_id
+        in: path
+        required: true
+        schema:
+          type: string
+    get:
+      tags:
+        - project
+      description: Returns the node resources
+      operationId: get_node_resources
+      responses:
+        "200":
+          description: Returns the node resources.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NodeResourcesEnveloped"
+
+        default:
+          $ref: "#/components/responses/DefaultErrorResponse"
+    put:
+      tags:
+        - project
+      description: Replaces the node resources
+      operationId: replace_node_resources
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NodeResources"
+      responses:
+        "200":
+          description: Returns the udpated node resources.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NodeResourcesEnveloped"
+
+        default:
+          $ref: "#/components/responses/DefaultErrorResponse"
+
   /projects/{study_uuid}/tags/{tag_id}:
     parameters:
       - name: tag_id
@@ -559,6 +608,12 @@ components:
     RunningServiceEnveloped:
       $ref: "../common/schemas/running_service.yaml#/components/schemas/RunningServiceEnveloped"
 
+    NodeResources:
+      $ref: "./components/schemas/node_resources.yaml#/components/schemas/NodeResources"
+
+    NodeResourcesEnveloped:
+      $ref: "./components/schemas/node_resources.yaml#/components/schemas/NodeResourcesEnveloped"
+
     HTTPValidationError:
       title: HTTPValidationError
       type: object

api/specs/webserver/openapi.yaml

@@ -205,6 +205,9 @@ paths:
   /projects/{project_uuid}/nodes/{node_id}:restart:
     $ref: "./openapi-projects.yaml#/paths/~1projects~1{project_uuid}~1nodes~1{node_id}~1restart"
 
+  /projects/{project_id}/nodes/{node_id}/resources:
+    $ref: "./openapi-projects.yaml#/paths/~1projects~1{project_id}~1nodes~1{node_id}~1resources"
+
   /nodes/{nodeInstanceUUID}/outputUi/{outputKey}:
     $ref: "./openapi-node-v0.0.1.yaml#/paths/~1nodes~1{nodeInstanceUUID}~1outputUi~1{outputKey}"
 
@@ -287,6 +290,8 @@ paths:
     $ref: "./openapi-catalog.yaml#/paths/catalog_services_service_key_service_version_outputs_output_key"
   /catalog/services/{service_key}/{service_version}/outputs:match:
     $ref: "./openapi-catalog.yaml#/paths/catalog_services_service_key_service_version_outputs_match"
+  /catalog/services/{service_key}/{service_version}/resources:
+    $ref: "./openapi-catalog.yaml#/paths/catalog_services_service_key_service_version_resources"
 
   # CLUSTER -------------------------------------------------------------------------
   /clusters:ping:

packages/models-library/src/models_library/generics.py

@@ -3,6 +3,7 @@
     Dict,
     Generic,
     ItemsView,
+    Iterable,
     Iterator,
     KeysView,
     List,
@@ -35,12 +36,18 @@ def keys(self) -> KeysView[DictKey]:
     def values(self) -> ValuesView[DictValue]:
         return self.__root__.values()
 
+    def update(self, *s: Iterable[tuple[DictKey, DictValue]]) -> None:
+        return self.__root__.update(*s)
+
     def __iter__(self) -> Iterator[DictKey]:
         return self.__root__.__iter__()
 
     def get(self, key: DictKey, default: Optional[DictValue] = None):
         return self.__root__.get(key, default)
 
+    def setdefault(self, key: DictKey, default: DictValue):
+        return self.__root__.setdefault(key, default)
+
     def __len__(self) -> int:
         return self.__root__.__len__()
 

packages/models-library/src/models_library/service_settings_labels.py

@@ -8,6 +8,8 @@
 
 from pydantic import BaseModel, Extra, Field, Json, PrivateAttr, validator
 
+from .generics import ListModel
+
 
 class _BaseConfig:
     extra = Extra.forbid
@@ -70,17 +72,7 @@ class Config(_BaseConfig):
         }
 
 
-class SimcoreServiceSettingsLabel(BaseModel):
-    __root__: List[SimcoreServiceSettingLabelEntry]
-
-    def __iter__(self):
-        return iter(self.__root__)
-
-    def __getitem__(self, item):
-        return self.__root__[item]
-
-    def __len__(self):
-        return len(self.__root__)
+SimcoreServiceSettingsLabel = ListModel[SimcoreServiceSettingLabelEntry]
 
 
 class PathMappingsLabel(BaseModel):

packages/models-library/src/models_library/services_resources.py

@@ -0,0 +1,25 @@
+from typing import Union
+
+from models_library.generics import DictModel
+from pydantic import BaseModel, StrictFloat, StrictInt, root_validator
+
+ResourceName = str
+
+
+class ResourceValue(BaseModel):
+    limit: Union[StrictInt, StrictFloat, str]
+    reservation: Union[StrictInt, StrictFloat, str]
+
+    @root_validator()
+    @classmethod
+    def ensure_limits_are_equal_or_above_reservations(cls, values):
+        if isinstance(values["reservation"], str):
+            # in case of string, the limit is the same as the reservation
+            values["limit"] = values["reservation"]
+        else:
+            values["limit"] = max(values["limit"], values["reservation"])
+
+        return values
+
+
+ServiceResources = DictModel[ResourceName, ResourceValue]

packages/pytest-simcore/src/pytest_simcore/helpers/utils_login.py

@@ -1,5 +1,5 @@
 import re
-from typing import TypedDict
+from typing import Optional, TypedDict
 
 from aiohttp import web
 from aiohttp.test_utils import TestClient
@@ -71,6 +71,7 @@ async def log_client_in(
     client: TestClient, user_data=None, *, enable_check=True
 ) -> UserInfoDict:
     # creates user directly in db
+    assert client.app
     db: AsyncpgStorage = get_plugin_storage(client.app)
     cfg: LoginOptions = get_plugin_options(client.app)
 
@@ -93,9 +94,10 @@ async def log_client_in(
 
 
 class NewUser:
-    def __init__(self, params=None, app: web.Application = None):
+    def __init__(self, params=None, app: Optional[web.Application] = None):
         self.params = params
         self.user = None
+        assert app
         self.db = get_plugin_storage(app)
 
     async def __aenter__(self):
@@ -121,13 +123,15 @@ async def __aenter__(self) -> UserInfoDict:
 
 class NewInvitation(NewUser):
     def __init__(self, client: TestClient, guest="", host=None):
+        assert client.app
         super().__init__(host, client.app)
         self.client = client
         self.guest = guest or get_random_string(10)
         self.confirmation = None
 
     async def __aenter__(self):
         # creates host user
+        assert self.client.app
         db: AsyncpgStorage = get_plugin_storage(self.client.app)
         self.user = await create_user(db, self.params)
 

packages/pytest-simcore/src/pytest_simcore/helpers/utils_projects.py

@@ -92,8 +92,8 @@ async def delete_all_projects(app: web.Application):
 class NewProject:
     def __init__(
         self,
-        params_override: Dict = None,
-        app: web.Application = None,
+        params_override: Optional[Dict] = None,
+        app: Optional[web.Application] = None,
         clear_all: bool = True,
         user_id: Optional[int] = None,
         *,
@@ -146,9 +146,10 @@ async def assert_get_same_project(
     # GET /v0/projects/{project_id}
 
     # with a project owned by user
+    assert client.app
     url = client.app.router["get_project"].url_for(project_id=project["uuid"])
     assert str(url) == f"{api_vtag}/projects/{project['uuid']}"
-    resp = await client.get(url)
+    resp = await client.get(f"{url}")
     data, error = await assert_status(resp, expected)
 
     if not error: