Add resource usage endpoint to get usage for a given user

Author: eikek

components/renku_data_services/resource_usage/api.spec.yaml

@@ -48,6 +48,54 @@ paths:
       tags:
         - resource-usage
 
+  /resource_pools/{resource_pool_id}/admin_usage:
+    get:
+      summary: |
+        Get usage and limits of the supplied pool. If a `start_date`
+        is not given, the usage of the current week is returned. This
+        endpoint is only available to admins and it allows to specify
+        a user_id query parameter to check usages for any user.
+      parameters:
+        - in: path
+          name: resource_pool_id
+          required: true
+          schema:
+            type: integer
+        - in: query
+          name: start_date
+          required: false
+          schema:
+            type: string
+            format: date
+        - in: query
+          name: end_date
+          required: false
+          schema:
+            type: string
+            format: date
+        - in: query
+          name: user_id
+          required: false
+          schema:
+            type: string
+      responses:
+        "200":
+          description: "Return the pool limits and current usage."
+          content:
+            "application/json":
+              schema:
+                $ref: "#/components/schemas/ResourcePoolUsage"
+        "404":
+          description: "The resource pool doesn't exist."
+          content:
+            "application/json":
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        default:
+          $ref: "#/components/responses/Error"
+      tags:
+        - resource-usage
+
   /resource_pools/{resource_pool_id}/limits:
     get:
       summary: "Get resource pool limits"

components/renku_data_services/resource_usage/blueprints.py

@@ -135,18 +135,18 @@ async def _delete(_: Request, user: base_models.APIUser, resource_pool_id: int,
 
         return "/resource_pools/<resource_pool_id>/classes/<class_id>/cost", ["DELETE"], _delete
 
+    def _extract_date(self, req: Request, name: str) -> date | None:
+        datestr = req.args.get(name)
+        return datetime.strptime(datestr, "%Y-%m-%d") if datestr is not None else None
+
     def get_pool_usage(self) -> BlueprintFactoryResponse:
         """Get usage of a pool."""
 
-        def extract_date(req: Request, name: str) -> date | None:
-            datestr = req.args.get(name)
-            return datetime.strptime(datestr, "%Y-%m-%d") if datestr is not None else None
-
         @authenticate(self.authenticator)
         @validate_db_ids
         async def _get(req: Request, user: base_models.APIUser, resource_pool_id: int) -> HTTPResponse:
-            start_date = extract_date(req, "start_date")
-            end_date = extract_date(req, "end_date")
+            start_date = self._extract_date(req, "start_date")
+            end_date = self._extract_date(req, "end_date")
             result: model.ResourcePoolUsage | None = None
             if start_date:
                 result = await self.rr_svc.get_for_date(resource_pool_id, user.id or "", start_date, end_date)
@@ -174,3 +174,42 @@ async def _get(req: Request, user: base_models.APIUser, resource_pool_id: int) -
                 raise errors.MissingResourceError()
 
         return "/resource_pools/<resource_pool_id>/usage", ["GET"], _get
+
+    def get_admin_pool_usage(self) -> BlueprintFactoryResponse:
+        """Get usage of a pool."""
+
+        @authenticate(self.authenticator)
+        @only_admins
+        @validate_db_ids
+        async def _get(req: Request, user: base_models.APIUser, resource_pool_id: int) -> HTTPResponse:
+            start_date = self._extract_date(req, "start_date")
+            end_date = self._extract_date(req, "end_date")
+            user_id = req.args.get("user_id")
+            uid = str(user_id) if user_id else user.id or ""
+            result: model.ResourcePoolUsage | None = None
+            if start_date:
+                result = await self.rr_svc.get_for_date(resource_pool_id, uid, start_date, end_date)
+            else:
+                result = await self.rr_svc.get_running_week(resource_pool_id, uid)
+            if result:
+                output = apispec.ResourcePoolUsage(
+                    total_usage=apispec.ResourceUsageSummary(
+                        runtime=result.total_usage.runtime_hours, cost=result.total_usage.cost.value
+                    ),
+                    pool_limits=apispec.ResourcePoolLimits(
+                        pool_id=result.pool_limits.pool_id,
+                        total_limit=result.pool_limits.total_limit.value,
+                        user_limit=result.pool_limits.user_limit.value,
+                    ),
+                    user_usage=apispec.ResourceUsageSummary(
+                        runtime=result.user_usage.runtime_hours, cost=result.user_usage.cost.value
+                    ),
+                )
+                return validated_json(
+                    apispec.ResourcePoolUsage,
+                    output,
+                )
+            else:
+                raise errors.MissingResourceError()
+
+        return "/resource_pools/<resource_pool_id>/admin_usage", ["GET"], _get