Skip to content

♻️ New fakes in dev/catalog/service #6012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 1, 2024
Merged

♻️ New fakes in dev/catalog/service #6012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ee8cca
new examples and fakes
pcrespov Jun 28, 2024
423e102
fix
pcrespov Jun 28, 2024
f72d5f1
fix
pcrespov Jun 28, 2024
c9a291d
Merge branch 'master' into is5964/updates-fake-services-example
pcrespov Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/models-library/src/models_library/api_schemas_catalog/services.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ class Config:
}
},
"owner": "[email protected]",
}
},
}


Expand Down
212 changes: 171 additions & 41 deletions packages/models-library/src/models_library/api_schemas_webserver/catalog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
from copy import deepcopy
from typing import Any, ClassVar, TypeAlias

from pydantic import Extra, Field
Expand Down Expand Up @@ -100,18 +99,137 @@ class Config(_BaseCommonApiExtension.Config):
ServiceOutputsGetDict: TypeAlias = dict[ServicePortKey, ServiceOutputGet]


_EXAMPLE: dict[str, Any] = deepcopy(
api_schemas_catalog_services.ServiceGet.Config.schema_extra["example"]
)
_EXAMPLE.update(
{
_EXAMPLE_FILEPICKER: dict[str, Any] = {
**api_schemas_catalog_services.ServiceGet.Config.schema_extra["example"],
**{
"inputs": {
f"input{i}": example
for i, example in enumerate(ServiceInputGet.Config.schema_extra["examples"])
},
"outputs": {"outFile": ServiceOutputGet.Config.schema_extra["example"]},
}
)
},
}


_EXAMPLE_SLEEPER: dict[str, Any] = {
"name": "sleeper",
"thumbnail": None,
"description": "A service which awaits for time to pass, two times.",
"classifiers": [],
"quality": {},
"accessRights": {"1": {"execute_access": True, "write_access": False}},
"key": "simcore/services/comp/itis/sleeper",
"version": "2.2.1",
"version_display": "2 Xtreme",
"integration-version": "1.0.0",
"type": "computational",
"authors": [
{
"name": "Author Bar",
"email": "[email protected]",
"affiliation": "ACME",
},
],
"contact": "[email protected]",
"inputs": {
"input_1": {
"displayOrder": 1,
"label": "File with int number",
"description": "Pick a file containing only one integer",
"type": "data:text/plain",
"fileToKeyMap": {"single_number.txt": "input_1"},
"keyId": "input_1",
},
"input_2": {
"unitLong": "second",
"unitShort": "s",
"label": "Sleep interval",
"description": "Choose an amount of time to sleep in range [0:]",
"keyId": "input_2",
"displayOrder": 2,
"type": "ref_contentSchema",
"contentSchema": {
"title": "Sleep interval",
"type": "integer",
"x_unit": "second",
"minimum": 0,
},
"defaultValue": 2,
},
"input_3": {
"displayOrder": 3,
"label": "Fail after sleep",
"description": "If set to true will cause service to fail after it sleeps",
"type": "boolean",
"defaultValue": False,
"keyId": "input_3",
},
"input_4": {
"unitLong": "meter",
"unitShort": "m",
"label": "Distance to bed",
"description": "It will first walk the distance to bed",
"keyId": "input_4",
"displayOrder": 4,
"type": "ref_contentSchema",
"contentSchema": {
"title": "Distance to bed",
"type": "integer",
"x_unit": "meter",
},
"defaultValue": 0,
},
"input_5": {
"unitLong": "byte",
"unitShort": "B",
"label": "Dream (or nightmare) of the night",
"description": "Defines the size of the dream that will be generated [0:]",
"keyId": "input_5",
"displayOrder": 5,
"type": "ref_contentSchema",
"contentSchema": {
"title": "Dream of the night",
"type": "integer",
"x_unit": "byte",
"minimum": 0,
},
"defaultValue": 0,
},
},
"outputs": {
"output_1": {
"displayOrder": 1,
"label": "File containing one random integer",
"description": "Integer is generated in range [1-9]",
"type": "data:text/plain",
"fileToKeyMap": {"single_number.txt": "output_1"},
"keyId": "output_1",
},
"output_2": {
"unitLong": "second",
"unitShort": "s",
"label": "Random sleep interval",
"description": "Interval is generated in range [1-9]",
"keyId": "output_2",
"displayOrder": 2,
"type": "ref_contentSchema",
"contentSchema": {
"title": "Random sleep interval",
"type": "integer",
"x_unit": "second",
},
},
"output_3": {
"displayOrder": 3,
"label": "Dream output",
"description": "Contains some random data representing a dream",
"type": "data:text/plain",
"fileToKeyMap": {"dream.txt": "output_3"},
"keyId": "output_3",
},
},
"owner": "[email protected]",
}


class ServiceGet(api_schemas_catalog_services.ServiceGet):
Expand All @@ -124,7 +242,7 @@ class ServiceGet(api_schemas_catalog_services.ServiceGet):
)

class Config(OutputSchema.Config):
schema_extra: ClassVar[dict[str, Any]] = {"example": _EXAMPLE}
schema_extra: ClassVar[dict[str, Any]] = {"example": _EXAMPLE_FILEPICKER}


class ServiceUpdate(api_schemas_catalog_services.ServiceUpdate):
Expand All @@ -148,39 +266,51 @@ class DEVServiceGet(ServiceGet):

class Config(OutputSchema.Config):
schema_extra: ClassVar[dict[str, Any]] = {
"example": {
**_EXAMPLE, # 1.0.0
"history": [
{
"version": "1.0.5",
"version_display": "Summer Release",
"release_date": "2024-07-20T15:00:00",
},
{
"version": _EXAMPLE["version"],
"compatibility": {
"can_update_to": "1.0.5",
"examples": [
{
**_EXAMPLE_SLEEPER, # v2.2.1 (latest)
"history": [
{
"version": _EXAMPLE_SLEEPER["version"],
"version_display": "Summer Release",
"release_date": "2024-07-20T15:00:00",
},
},
{"version": "0.9.11"},
{"version": "0.9.10"},
{
"version": "0.9.8",
"compatibility": {
"can_update_to": "0.9.10",
{
"version": "2.0.0",
"compatibility": {
"can_update_to": _EXAMPLE_SLEEPER["version"],
},
},
},
{
"version": "0.9.1",
"version_display": "Matterhorn",
"release_date": "2024-01-20T18:49:17",
"compatibility": {
"can_update_to": "0.9.10",
{"version": "0.9.11"},
{"version": "0.9.10"},
{
"version": "0.9.8",
"compatibility": {
"can_update_to": "0.9.11",
},
},
},
{"version": "0.9.0"},
{"version": "0.8.0"},
{"version": "0.1.0"},
],
}
{
"version": "0.9.1",
"version_display": "Matterhorn",
"release_date": "2024-01-20T18:49:17",
"compatibility": {
"can_update_to": "0.9.11",
},
},
{"version": "0.9.0"},
{"version": "0.8.0"},
{"version": "0.1.0"},
],
},
{
**_EXAMPLE_FILEPICKER,
"history": [
{
"version": _EXAMPLE_FILEPICKER["version"],
"version_display": "Odei Release",
"release_date": "2025-03-25T00:00:00",
}
],
},
]
}
10 changes: 5 additions & 5 deletions services/web/server/src/simcore_service_webserver/catalog/_handlers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,9 @@ async def dev_list_services_latest(request: Request):
assert query_params # nosec

_logger.debug("Moking response for %s...", request)
got = [
parse_obj_as(DEVServiceGet, DEVServiceGet.Config.schema_extra["example"]),
]
got = parse_obj_as(
list[DEVServiceGet], DEVServiceGet.Config.schema_extra["examples"]
)

return envelope_json_response(
got[query_params.offset : query_params.offset + query_params.limit]
Expand All @@ -113,7 +113,7 @@ async def dev_get_service(request: Request):
assert path_params # nosec

_logger.debug("Moking response for %s...", request)
got = parse_obj_as(DEVServiceGet, DEVServiceGet.Config.schema_extra["example"])
got = parse_obj_as(DEVServiceGet, DEVServiceGet.Config.schema_extra["examples"][0])
got.version = path_params.service_version
got.key = path_params.service_key

Expand All @@ -137,7 +137,7 @@ async def dev_update_service(request: Request):
assert update # nosec

_logger.debug("Moking response for %s...", request)
got = parse_obj_as(DEVServiceGet, DEVServiceGet.Config.schema_extra["example"])
got = parse_obj_as(DEVServiceGet, DEVServiceGet.Config.schema_extra["examples"][0])
got.version = path_params.service_version
got.key = path_params.service_key
updated = got.copy(update=update.dict(exclude_unset=True))
Expand Down
Loading