Merge branch 'master' into is6880/hash-api-key-secret

Author: giancarloromeo

.env-devel

@@ -133,6 +133,11 @@ DYNAMIC_SCHEDULER_UI_STORAGE_SECRET=adminadmin
 
 FUNCTION_SERVICES_AUTHORS='{"UN": {"name": "Unknown", "email": "[email protected]", "affiliation": "unknown"}}'
 
+WEBSERVER_LICENSES={}
+LICENSES_ITIS_VIP_SYNCER_ENABLED=false
+LICENSES_ITIS_VIP_API_URL=https://some-api/{category}
+LICENSES_ITIS_VIP_CATEGORIES='{"HumanWholeBody": "Humans", "HumanBodyRegion": "Humans (Region)", "AnimalWholeBody": "Animal"}'
+
 # Can use 'docker run -it itisfoundation/invitations:latest simcore-service-invitations generate-dotenv --auto-password'
 INVITATIONS_DEFAULT_PRODUCT=osparc
 INVITATIONS_HOST=invitations

.github/mergify.yml

@@ -0,0 +1,69 @@
+queue_rules:
+  - name: default
+    queue_conditions: # condtions to be met to add the PR to the queue (manually or automatically)
+      # general prerequisits fo accept the PR in the queue
+      - label=🤖-automerge # let Mergify know that the PR can be merged (added manually)
+      - label!=🤖-do-not-merge # block Mergify from merging the PR (added manually)
+      - base=master
+      - -draft # PR is not in draft state
+      - -conflict # No merge conflicts
+
+      # Check for required reviews
+      - "#approved-reviews-by>=2" # Requires 2 approving reviews
+      - "#changes-requested-reviews-by=0" # No changes requested
+      - "#review-threads-unresolved=0" # All review threads resolved
+
+    merge_conditions: # conditions to be met before being able to merge
+      # list of CI checks that need to pass
+      - check-success=system-test-environment-setup
+      - check-success=changes
+      - check-success=build-test-images
+      - check-success=build-test-images-frontend
+      - check-success=unit-tests
+      - check-success=integration-tests
+      - check-success=system-tests
+
+
+pull_request_rules:
+  - name: retry flaky tests (when PR is approved)
+    conditions:
+      - label=🤖-automerge
+      - label!=🤖-do-not-merge
+      - base=master
+
+      - -draft # PR is not in draft state
+      - -conflict # No merge conflicts
+      - "#approved-reviews-by>=2" # Requires 2 approving reviews
+      - "#changes-requested-reviews-by=0" # No changes requested
+      - "#review-threads-unresolved=0" # All review threads resolved
+
+      - or:
+          - check-failure=system-test-environment-setup
+          - check-failure=changes
+          - check-failure=build-test-images
+          - check-failure=build-test-images-frontend
+          - check-failure=unit-tests
+          - check-failure=integration-tests
+          - check-failure=system-tests
+    actions:
+      comment:
+        message: "Restarted CI due to failing tests"
+      github_actions:
+        workflow:
+          dispatch:
+            - workflow: ci-testing-deploy.yml
+
+  - name: Automatically add PR to queue if it meets conditions
+    conditions:
+      - "label=🤖-automerge"
+      - "label!=🤖-do-not-merge"
+      - "base=master"
+
+      - "-draft" # PR is not in draft state
+      - "-conflict" # PR has no conflicts
+      - "#approved-reviews-by>=2" # Requires 2 approvals
+      - "#changes-requested-reviews-by=0" # No requested changes
+      - "#review-threads-unresolved=0" # All review threads resolved
+    actions:
+      queue:
+        name: default

.github/workflows/ci-testing-pull-request.yml

@@ -31,13 +31,15 @@ jobs:
           enable-cache: false
       - name: checkout source branch
         uses: actions/checkout@v4
-      - name: Regenerate specs and check
+      - name: Generate openapi specs
         run: |
           make devenv
           source .venv/bin/activate
           make openapi-specs
+      - name: Check openapi specs are up to date
+        run: |
           if ! ./ci/github/helpers/openapi-specs-diff.bash diff \
-            https://raw.githubusercontent.com/${{ github.event.pull_request.head.repo.full_name }}/refs/heads/${{ github.event.pull_request.head.ref }} \
+            https://raw.githubusercontent.com/${{ github.event.pull_request.head.repo.full_name }}/${{ github.event.after }} \
             .; then \
             echo "::error:: OAS are not up to date. Run 'make openapi-specs' to update them"; exit 1; \
           fi
@@ -57,7 +59,7 @@ jobs:
       - name: check api-server backwards compatibility
         run: |
           ./scripts/openapi-diff.bash breaking --fail-on ERR\
-            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/refs/heads/${{ github.event.pull_request.base.ref }}/services/api-server/openapi.json \
+            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/${{ github.event.after }}/services/api-server/openapi.json \
             /specs/services/api-server/openapi.json
 
   all-oas-breaking:
@@ -76,5 +78,5 @@ jobs:
       - name: Check openapi-specs backwards compatibility
         run: |
           ./ci/github/helpers/openapi-specs-diff.bash breaking \
-            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/refs/heads/${{ github.event.pull_request.base.ref }} \
+            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/${{ github.event.after }} \
             .

.ruff.toml

@@ -1,5 +1,5 @@
 
-select = [
+lint.select = [
   "A",     # [https://pypi.org/project/flake8-builtins/]
   "ARG",   # [https://pypi.org/project/flake8-unused-arguments/]
   "ASYNC", # [https://pypi.org/project/flake8-async/]
@@ -40,7 +40,7 @@ select = [
   "W",     # [https://pypi.org/project/pycodestyle/] warnings
   "YTT",   # [https://pypi.org/project/flake8-2020/]
 ]
-ignore = [
+lint.ignore = [
   "E501",   # line too long, handled by black
   "S101",   # use of `assert` detected hanbled by pylance, does not support noseq
   "TID252", # [*] Relative imports from parent modules are banned
@@ -50,7 +50,7 @@ ignore = [
 target-version = "py311"
 
 
-[per-file-ignores]
+[lint.per-file-ignores]
 "**/{tests,pytest_simcore}/**" = [
   "T201",    # print found
   "ARG001",  # unused function argument
@@ -64,10 +64,10 @@ target-version = "py311"
   "FBT001",  # Boolean positional arg in function definition
 ]
 
-[flake8-pytest-style]
+[lint.flake8-pytest-style]
 fixture-parentheses = false
 parametrize-names-type = "csv"
 
 
-[pylint]
+[lint.pylint]
 max-args = 10

api/specs/web-server/_licensed_items.py

@@ -10,12 +10,15 @@
 
 from _common import as_query
 from fastapi import APIRouter, Depends, status
-from models_library.api_schemas_webserver.licensed_items import LicensedItemGet
+from models_library.api_schemas_webserver.licensed_items import LicensedItemRestGet
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
+from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.licenses._exceptions_handlers import _TO_HTTP_ERROR_MAP
-from simcore_service_webserver.licenses._models import (
+from simcore_service_webserver.licenses._common.exceptions_handlers import (
+    _TO_HTTP_ERROR_MAP,
+)
+from simcore_service_webserver.licenses._common.models import (
     LicensedItemsBodyParams,
     LicensedItemsListQueryParams,
     LicensedItemsPathParams,
@@ -35,7 +38,7 @@
 
 @router.get(
     "/catalog/licensed-items",
-    response_model=Envelope[list[LicensedItemGet]],
+    response_model=Page[LicensedItemRestGet],
 )
 async def list_licensed_items(
     _query: Annotated[as_query(LicensedItemsListQueryParams), Depends()],
@@ -45,7 +48,7 @@ async def list_licensed_items(
 
 @router.get(
     "/catalog/licensed-items/{licensed_item_id}",
-    response_model=Envelope[LicensedItemGet],
+    response_model=Envelope[LicensedItemRestGet],
 )
 async def get_licensed_item(
     _path: Annotated[LicensedItemsPathParams, Depends()],

api/specs/web-server/_licensed_items_checkouts.py

@@ -17,7 +17,9 @@
 from models_library.rest_error import EnvelopedError
 from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.licenses._exceptions_handlers import _TO_HTTP_ERROR_MAP
+from simcore_service_webserver.licenses._common.exceptions_handlers import (
+    _TO_HTTP_ERROR_MAP,
+)
 from simcore_service_webserver.licenses._licensed_items_checkouts_models import (
     LicensedItemCheckoutPathParams,
     LicensedItemsCheckoutsListQueryParams,

api/specs/web-server/_licensed_items_purchases.py

@@ -17,8 +17,10 @@
 from models_library.rest_error import EnvelopedError
 from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.licenses._exceptions_handlers import _TO_HTTP_ERROR_MAP
-from simcore_service_webserver.licenses._models import (
+from simcore_service_webserver.licenses._common.exceptions_handlers import (
+    _TO_HTTP_ERROR_MAP,
+)
+from simcore_service_webserver.licenses._common.models import (
     LicensedItemsPurchasesListQueryParams,
     LicensedItemsPurchasesPathParams,
 )

api/specs/web-server/_resource_usage.py

@@ -21,6 +21,7 @@
     CreatePricingPlanBodyParams,
     CreatePricingUnitBodyParams,
     PricingPlanAdminGet,
+    PricingPlanGet,
     PricingPlanToServiceAdminGet,
     PricingUnitAdminGet,
     PricingUnitGet,
@@ -29,15 +30,16 @@
     UpdatePricingUnitBodyParams,
 )
 from models_library.generics import Envelope
+from models_library.rest_pagination import Page, PageQueryParameters
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.resource_usage._pricing_plans_admin_handlers import (
+from simcore_service_webserver.resource_usage._pricing_plans_admin_rest import (
     PricingPlanGetPathParams,
     PricingUnitGetPathParams,
 )
-from simcore_service_webserver.resource_usage._pricing_plans_handlers import (
+from simcore_service_webserver.resource_usage._pricing_plans_rest import (
     PricingPlanUnitGetPathParams,
 )
-from simcore_service_webserver.resource_usage._service_runs_handlers import (
+from simcore_service_webserver.resource_usage._service_runs_rest import (
     ServicesAggregatedUsagesListQueryParams,
     ServicesResourceUsagesListQueryParams,
     ServicesResourceUsagesReportQueryParams,
@@ -48,7 +50,7 @@
 
 @router.get(
     "/services/-/resource-usages",
-    response_model=Envelope[list[ServiceRunGet]],
+    response_model=Page[ServiceRunGet],
     summary="Retrieve finished and currently running user services"
     " (user and product are taken from context, optionally wallet_id parameter might be provided).",
     tags=["usage"],
@@ -61,7 +63,7 @@ async def list_resource_usage_services(
 
 @router.get(
     "/services/-/aggregated-usages",
-    response_model=Envelope[list[OsparcCreditsAggregatedByServiceGet]],
+    response_model=Page[OsparcCreditsAggregatedByServiceGet],
     summary="Used credits based on aggregate by type, currently supported `services`"
     ". (user and product are taken from context, optionally wallet_id parameter might be provided).",
     tags=["usage"],
@@ -93,7 +95,6 @@ async def export_resource_usage_services(
 @router.get(
     "/pricing-plans/{pricing_plan_id}/pricing-units/{pricing_unit_id}",
     response_model=Envelope[PricingUnitGet],
-    summary="Retrieve detail information about pricing unit",
     tags=["pricing-plans"],
 )
 async def get_pricing_plan_unit(
@@ -102,27 +103,50 @@ async def get_pricing_plan_unit(
     ...
 
 
+@router.get(
+    "/pricing-plans",
+    response_model=Page[PricingPlanGet],
+    tags=["pricing-plans"],
+    description="To keep the listing lightweight, the pricingUnits field is None.",
+)
+async def list_pricing_plans(
+    _query: Annotated[as_query(PageQueryParameters), Depends()]
+):
+    ...
+
+
+@router.get(
+    "/pricing-plans/{pricing_plan_id}",
+    response_model=Envelope[PricingPlanGet],
+    tags=["pricing-plans"],
+)
+async def get_pricing_plan(
+    _path: Annotated[PricingPlanGetPathParams, Depends()],
+):
+    ...
+
+
 ## Pricing plans for Admin panel
 
 
 @router.get(
     "/admin/pricing-plans",
-    response_model=Envelope[list[PricingPlanAdminGet]],
-    summary="List pricing plans",
+    response_model=Page[PricingPlanAdminGet],
     tags=["admin"],
     description="To keep the listing lightweight, the pricingUnits field is None.",
 )
-async def list_pricing_plans():
+async def list_pricing_plans_for_admin_user(
+    _query: Annotated[as_query(PageQueryParameters), Depends()]
+):
     ...
 
 
 @router.get(
     "/admin/pricing-plans/{pricing_plan_id}",
     response_model=Envelope[PricingPlanAdminGet],
-    summary="Retrieve detail information about pricing plan",
     tags=["admin"],
 )
-async def get_pricing_plan(
+async def get_pricing_plan_for_admin_user(
     _path: Annotated[PricingPlanGetPathParams, Depends()],
 ):
     ...
@@ -131,7 +155,6 @@ async def get_pricing_plan(
 @router.post(
     "/admin/pricing-plans",
     response_model=Envelope[PricingPlanAdminGet],
-    summary="Create pricing plan",
     tags=["admin"],
 )
 async def create_pricing_plan(
@@ -143,7 +166,6 @@ async def create_pricing_plan(
 @router.put(
     "/admin/pricing-plans/{pricing_plan_id}",
     response_model=Envelope[PricingPlanAdminGet],
-    summary="Update detail information about pricing plan",
     tags=["admin"],
 )
 async def update_pricing_plan(
@@ -159,7 +181,6 @@ async def update_pricing_plan(
 @router.get(
     "/admin/pricing-plans/{pricing_plan_id}/pricing-units/{pricing_unit_id}",
     response_model=Envelope[PricingUnitAdminGet],
-    summary="Retrieve detail information about pricing unit",
     tags=["admin"],
 )
 async def get_pricing_unit(
@@ -171,7 +192,6 @@ async def get_pricing_unit(
 @router.post(
     "/admin/pricing-plans/{pricing_plan_id}/pricing-units",
     response_model=Envelope[PricingUnitAdminGet],
-    summary="Create pricing unit",
     tags=["admin"],
 )
 async def create_pricing_unit(
@@ -184,7 +204,6 @@ async def create_pricing_unit(
 @router.put(
     "/admin/pricing-plans/{pricing_plan_id}/pricing-units/{pricing_unit_id}",
     response_model=Envelope[PricingUnitAdminGet],
-    summary="Update detail information about pricing plan",
     tags=["admin"],
 )
 async def update_pricing_unit(
@@ -200,7 +219,6 @@ async def update_pricing_unit(
 @router.get(
     "/admin/pricing-plans/{pricing_plan_id}/billable-services",
     response_model=Envelope[list[PricingPlanToServiceAdminGet]],
-    summary="List services that are connected to the provided pricing plan",
     tags=["admin"],
 )
 async def list_connected_services_to_pricing_plan(
@@ -212,7 +230,6 @@ async def list_connected_services_to_pricing_plan(
 @router.post(
     "/admin/pricing-plans/{pricing_plan_id}/billable-services",
     response_model=Envelope[PricingPlanToServiceAdminGet],
-    summary="Connect service with pricing plan",
     tags=["admin"],
 )
 async def connect_service_to_pricing_plan(