Merge branch 'add-functions-locust-test' of github.com:bisgaard-itis/osparc-simcore into add-functions-locust-test

Author: bisgaard-itis

api/specs/web-server/_auth.py

@@ -260,8 +260,8 @@ async def email_confirmation(code: str):
 
 @router.get(
     "/auth/captcha",
-    operation_id="request_captcha",
+    operation_id="create_captcha",
     status_code=status.HTTP_200_OK,
     responses={status.HTTP_200_OK: {"content": {"image/png": {}}}},
 )
-async def request_captcha(): ...
+async def create_captcha(): ...

api/specs/web-server/_users.py

@@ -7,20 +7,25 @@
 from enum import Enum
 from typing import Annotated
 
+from _common import as_query
 from fastapi import APIRouter, Depends, status
 from models_library.api_schemas_webserver.users import (
     MyPermissionGet,
     MyProfileGet,
     MyProfilePatch,
     MyTokenCreate,
     MyTokenGet,
-    UserForAdminGet,
+    UserAccountApprove,
+    UserAccountGet,
+    UserAccountReject,
+    UserAccountSearchQueryParams,
     UserGet,
-    UsersForAdminSearchQueryParams,
+    UsersAccountListQueryParams,
     UsersSearch,
 )
 from models_library.api_schemas_webserver.users_preferences import PatchRequestBody
 from models_library.generics import Envelope
+from models_library.rest_pagination import Page
 from models_library.user_preferences import PreferenceIdentifier
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.users._common.schemas import PreRegisteredUserGet
@@ -144,20 +149,46 @@ async def search_users(_body: UsersSearch): ...
 
 
 @router.get(
-    "/admin/users:search",
-    response_model=Envelope[list[UserForAdminGet]],
+    "/admin/user-accounts",
+    response_model=Page[UserAccountGet],
     tags=_extra_tags,
 )
-async def search_users_for_admin(
-    _query: Annotated[UsersForAdminSearchQueryParams, Depends()],
+async def list_users_accounts(
+    _query: Annotated[as_query(UsersAccountListQueryParams), Depends()],
+): ...
+
+
+@router.post(
+    "/admin/user-accounts:approve",
+    status_code=status.HTTP_204_NO_CONTENT,
+    tags=_extra_tags,
+)
+async def approve_user_account(_body: UserAccountApprove): ...
+
+
+@router.post(
+    "/admin/user-accounts:reject",
+    status_code=status.HTTP_204_NO_CONTENT,
+    tags=_extra_tags,
+)
+async def reject_user_account(_body: UserAccountReject): ...
+
+
+@router.get(
+    "/admin/user-accounts:search",
+    response_model=Envelope[list[UserAccountGet]],
+    tags=_extra_tags,
+)
+async def search_user_accounts(
+    _query: Annotated[UserAccountSearchQueryParams, Depends()],
 ):
     # NOTE: see `Search` in `Common Custom Methods` in https://cloud.google.com/apis/design/custom_methods
     ...
 
 
 @router.post(
-    "/admin/users:pre-register",
-    response_model=Envelope[UserForAdminGet],
+    "/admin/user-accounts:pre-register",
+    response_model=Envelope[UserAccountGet],
     tags=_extra_tags,
 )
-async def pre_register_user_for_admin(_body: PreRegisteredUserGet): ...
+async def pre_register_user_account(_body: PreRegisteredUserGet): ...

packages/models-library/src/models_library/api_schemas_catalog/services.py

@@ -172,23 +172,57 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     )
 
 
-class _BaseServiceGetV2(CatalogOutputSchema):
-    # Model used in catalog's rpc and rest interfaces
+class ServiceSummary(CatalogOutputSchema):
     key: ServiceKey
     version: ServiceVersion
-
     name: str
-    thumbnail: HttpUrl | None = None
-    icon: HttpUrl | None = None
     description: str
 
-    description_ui: bool = False
-
     version_display: str | None = None
 
+    contact: LowerCaseEmailStr | None
+
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "examples": [
+                    {
+                        "key": _EXAMPLE_SLEEPER["key"],
+                        "version": _EXAMPLE_SLEEPER["version"],
+                        "name": _EXAMPLE_SLEEPER["name"],
+                        "description": _EXAMPLE_SLEEPER["description"],
+                        "version_display": _EXAMPLE_SLEEPER["version_display"],
+                        "contact": _EXAMPLE_SLEEPER["contact"],
+                    },
+                    {
+                        "key": _EXAMPLE_FILEPICKER["key"],
+                        "version": _EXAMPLE_FILEPICKER["version"],
+                        "name": _EXAMPLE_FILEPICKER["name"],
+                        "description": _EXAMPLE_FILEPICKER["description"],
+                        "version_display": None,
+                        "contact": _EXAMPLE_FILEPICKER["contact"],
+                    },
+                ]
+            }
+        )
+
+    model_config = ConfigDict(
+        extra="ignore",
+        populate_by_name=True,
+        alias_generator=snake_to_camel,
+        json_schema_extra=_update_json_schema_extra,
+    )
+
+
+class _BaseServiceGetV2(ServiceSummary):
     service_type: Annotated[ServiceType, Field(alias="type")]
 
-    contact: LowerCaseEmailStr | None
+    thumbnail: HttpUrl | None = None
+    icon: HttpUrl | None = None
+
+    description_ui: bool = False
+
     authors: Annotated[list[Author], Field(min_length=1)]
     owner: Annotated[
         LowerCaseEmailStr | None,
@@ -217,6 +251,7 @@ class _BaseServiceGetV2(CatalogOutputSchema):
         extra="forbid",
         populate_by_name=True,
         alias_generator=snake_to_camel,
+        json_schema_extra={"example": _EXAMPLE_SLEEPER},
     )
 
 
@@ -249,7 +284,6 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
 
 
 class ServiceGetV2(_BaseServiceGetV2):
-    # Model used in catalog's rpc and rest interfaces
     history: Annotated[
         list[ServiceRelease],
         Field(
@@ -338,6 +372,9 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     ServiceRelease
 ]
 
+# Create PageRpc types
+PageRpcServiceSummary = PageRpc[ServiceSummary]
+
 ServiceResourcesGet: TypeAlias = ServiceResourcesDict
 
 

packages/models-library/src/models_library/api_schemas_webserver/users.py

@@ -1,13 +1,15 @@
 import re
-from datetime import date
+from datetime import date, datetime
 from enum import Enum
 from typing import Annotated, Any, Literal, Self
 
 import annotated_types
 from common_library.basic_types import DEFAULT_FACTORY
 from common_library.dict_tools import remap_keys
-from common_library.users_enums import UserStatus
+from common_library.users_enums import AccountRequestStatus, UserStatus
 from models_library.groups import AccessRightsDict
+from models_library.rest_filters import Filters
+from models_library.rest_pagination import PageQueryParameters
 from pydantic import (
     ConfigDict,
     EmailStr,
@@ -39,6 +41,7 @@
     OutputSchemaWithoutCamelCase,
 )
 from .groups import MyGroupsGet
+from .products import InvitationGenerate
 from .users_preferences import AggregatedPreferences
 
 #
@@ -238,7 +241,30 @@ def from_domain_model(cls, data):
         return cls.model_validate(data, from_attributes=True)
 
 
-class UsersForAdminSearchQueryParams(RequestParameters):
+class UsersForAdminListFilter(Filters):
+    # 1. account_request_status: PENDING, REJECTED, APPROVED
+    # 2. If APPROVED AND user uses the invitation link, then when user is registered,
+    #  it can be in any of these statuses:
+    #     CONFIRMATION_PENDING, ACTIVE, EXPIRED, BANNED, DELETED
+    #
+    review_status: Literal["PENDING", "REVIEWED"] | None = None
+
+    model_config = ConfigDict(extra="forbid")
+
+
+class UsersAccountListQueryParams(UsersForAdminListFilter, PageQueryParameters): ...
+
+
+class UserAccountApprove(InputSchema):
+    email: EmailStr
+    invitation: InvitationGenerate | None = None
+
+
+class UserAccountReject(InputSchema):
+    email: EmailStr
+
+
+class UserAccountSearchQueryParams(RequestParameters):
     email: Annotated[
         str,
         Field(
@@ -249,7 +275,7 @@ class UsersForAdminSearchQueryParams(RequestParameters):
     ]
 
 
-class UserForAdminGet(OutputSchema):
+class UserAccountGet(OutputSchema):
     # ONLY for admins
     first_name: str | None
     last_name: str | None
@@ -269,8 +295,12 @@ class UserForAdminGet(OutputSchema):
         ),
     ] = DEFAULT_FACTORY
 
-    # authorization
+    # pre-registration
+    pre_registration_id: int | None
     invited_by: str | None = None
+    account_request_status: AccountRequestStatus | None
+    account_request_reviewed_by: UserID | None = None
+    account_request_reviewed_at: datetime | None = None
 
     # user status
     registered: bool

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

@@ -13,6 +13,7 @@
     LatestServiceGet,
     ServiceGetV2,
     ServiceListFilters,
+    ServiceSummary,
     ServiceUpdateV2,
 )
 from models_library.api_schemas_catalog.services_ports import ServicePortGet
@@ -200,6 +201,66 @@ async def get_service_ports(
             ServicePortGet.model_json_schema()["examples"],
         )
 
+    @validate_call(config={"arbitrary_types_allowed": True})
+    async def list_all_services_summaries_paginated(
+        self,
+        rpc_client: RabbitMQRPCClient | MockType,
+        *,
+        product_name: ProductName,
+        user_id: UserID,
+        limit: PageLimitInt,
+        offset: NonNegativeInt,
+        filters: ServiceListFilters | None = None,
+    ):
+        assert rpc_client
+        assert product_name
+        assert user_id
+
+        service_summaries = TypeAdapter(list[ServiceSummary]).validate_python(
+            ServiceSummary.model_json_schema()["examples"],
+        )
+        if filters:
+            filtered_summaries = []
+            for summary in service_summaries:
+                # Match service type if specified
+                if (
+                    filters.service_type
+                    and {
+                        ServiceType.COMPUTATIONAL: "/comp/",
+                        ServiceType.DYNAMIC: "/dynamic/",
+                    }[filters.service_type]
+                    not in summary.key
+                ):
+                    continue
+
+                # Match service key pattern if specified
+                if filters.service_key_pattern and not fnmatch.fnmatch(
+                    summary.key, filters.service_key_pattern
+                ):
+                    continue
+
+                # Match version display pattern if specified
+                if filters.version_display_pattern and (
+                    summary.version_display is None
+                    or not fnmatch.fnmatch(
+                        summary.version_display, filters.version_display_pattern
+                    )
+                ):
+                    continue
+
+                filtered_summaries.append(summary)
+
+            service_summaries = filtered_summaries
+
+        total_count = len(service_summaries)
+
+        return PageRpc[ServiceSummary].create(
+            service_summaries[offset : offset + limit],
+            total=total_count,
+            limit=limit,
+            offset=offset,
+        )
+
 
 @dataclass
 class ZeroListingCatalogRpcSideEffects:
@@ -216,3 +277,11 @@ async def list_my_service_history_latest_first(self, *args, **kwargs):
             limit=10,
             offset=0,
         )
+
+    async def list_all_services_summaries_paginated(self, *args, **kwargs):
+        return PageRpc[ServiceSummary].create(
+            [],
+            total=0,
+            limit=10,
+            offset=0,
+        )

packages/service-library/src/servicelib/aiohttp/rest_responses.py

@@ -8,10 +8,10 @@
 from common_library.error_codes import ErrorCodeStr
 from common_library.json_serialization import json_dumps
 from models_library.rest_error import ErrorGet, ErrorItemType
-from servicelib.rest_constants import RESPONSE_MODEL_POLICY
 
 from ..aiohttp.status import HTTP_200_OK
 from ..mimetype_constants import MIMETYPE_APPLICATION_JSON
+from ..rest_constants import RESPONSE_MODEL_POLICY
 from ..rest_responses import is_enveloped
 from ..status_codes_utils import get_code_description
 
@@ -54,7 +54,7 @@ def create_http_error(
     http_error_cls: type[HTTPError] = web.HTTPInternalServerError,
     *,
     skip_internal_error_details: bool = False,
-    error_code: ErrorCodeStr | None = None
+    error_code: ErrorCodeStr | None = None,
 ) -> HTTPError:
     """
     - Response body conforms OAS schema model
@@ -92,7 +92,8 @@ def create_http_error(
     )
 
     return http_error_cls(
-        reason=reason,
+        # Multiline not allowed in HTTP reason
+        reason=reason.replace("\n", " ") if reason else None,
         text=json_dumps(
             payload,
         ),