Merge branch 'master' into p-models-split-licensed-items-2-attempt-continuation

Author: matusdrobuliak66

.env-devel

@@ -83,6 +83,12 @@ DIRECTOR_REGISTRY_CACHING=True
 DIRECTOR_SERVICES_CUSTOM_CONSTRAINTS=null
 DIRECTOR_TRACING=null
 
+DOCKER_API_PROXY_HOST=docker-api-proxy
+DOCKER_API_PROXY_PASSWORD=null
+DOCKER_API_PROXY_PORT=8888
+DOCKER_API_PROXY_SECURE=False
+DOCKER_API_PROXY_USER=null
+
 EFS_USER_ID=8006
 EFS_USER_NAME=efs
 EFS_GROUP_ID=8106

.github/mergify.yml

@@ -22,48 +22,3 @@ queue_rules:
       - 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-deploy.yml

@@ -77,6 +77,7 @@ jobs:
       migration: ${{ steps.filter.outputs.migration }}
       payments: ${{ steps.filter.outputs.payments }}
       dynamic-scheduler: ${{ steps.filter.outputs.dynamic-scheduler }}
+      docker-api-proxy: ${{ steps.filter.outputs.docker-api-proxy }}
       resource-usage-tracker: ${{ steps.filter.outputs.resource-usage-tracker }}
       static-webserver: ${{ steps.filter.outputs.static-webserver }}
       storage: ${{ steps.filter.outputs.storage }}
@@ -233,6 +234,9 @@ jobs:
                 - 'services/docker-compose*'
                 - 'scripts/mypy/*'
                 - 'mypy.ini'
+            docker-api-proxy:
+                - 'packages/**'
+                - 'services/docker-api-proxy/**'
             resource-usage-tracker:
               - 'packages/**'
               - 'services/resource-usage-tracker/**'
@@ -2190,6 +2194,71 @@ jobs:
         with:
           flags: integrationtests #optional
 
+
+  integration-test-docker-api-proxy:
+    needs: [changes, build-test-images]
+    if: ${{ needs.changes.outputs.anything-py == 'true' || needs.changes.outputs.docker-api-proxy == 'true' || github.event_name == 'push'}}
+    timeout-minutes: 30 # if this timeout gets too small, then split the tests
+    name: "[int] docker-api-proxy"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python: ["3.11"]
+        os: [ubuntu-22.04]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - name: setup docker buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          driver: docker-container
+      - name: setup python environment
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: expose github runtime for buildx
+        uses: crazy-max/ghaction-github-runtime@v3
+      # FIXME: Workaround for https://github.com/actions/download-artifact/issues/249
+      - name: download docker images with retry
+        uses: Wandalen/wretry.action@master
+        with:
+          action: actions/download-artifact@v4
+          with: |
+            name: docker-buildx-images-${{ runner.os }}-${{ github.sha }}-backend
+            path: /${{ runner.temp }}/build
+          attempt_limit: 5
+          attempt_delay: 1000
+      - name: load docker images
+        run: make load-images local-src=/${{ runner.temp }}/build
+      - name: install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.5.x"
+          enable-cache: false
+          cache-dependency-glob: "**/docker-api-proxy/requirements/ci.txt"
+      - name: show system version
+        run: ./ci/helpers/show_system_versions.bash
+      - name: install
+        run: ./ci/github/integration-testing/docker-api-proxy.bash install
+      - name: test
+        run: ./ci/github/integration-testing/docker-api-proxy.bash test
+      - name: upload failed tests logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ github.job }}_docker_logs
+          path: ./services/docker-api-proxy/test_failures
+      - name: cleanup
+        if: ${{ !cancelled() }}
+        run: ./ci/github/integration-testing/docker-api-proxy.bash clean_up
+      - uses: codecov/codecov-action@v5
+        if: ${{ !cancelled() }}
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          flags: integrationtests #optional
+
   integration-test-simcore-sdk:
     needs: [changes, build-test-images]
     if: ${{ needs.changes.outputs.anything-py == 'true' || needs.changes.outputs.simcore-sdk == 'true' || github.event_name == 'push' }}
@@ -2262,6 +2331,7 @@ jobs:
         integration-test-director-v2-01,
         integration-test-director-v2-02,
         integration-test-dynamic-sidecar,
+        integration-test-docker-api-proxy,
         integration-test-simcore-sdk,
         integration-test-webserver-01,
         integration-test-webserver-02,

Makefile

@@ -47,6 +47,7 @@ SERVICES_NAMES_TO_BUILD := \
 	payments \
 	resource-usage-tracker \
 	dynamic-scheduler \
+	docker-api-proxy \
   service-integration \
   static-webserver \
   storage \

api/specs/web-server/_catalog.py

@@ -138,7 +138,7 @@ def get_service_resources(
 @router.get(
     "/catalog/services/{service_key:path}/{service_version}/pricing-plan",
     response_model=Envelope[ServicePricingPlanGet],
-    summary="Retrieve default pricing plan for provided service",
+    description="Retrieve default pricing plan for provided service",
     tags=["pricing-plans"],
 )
 async def get_service_pricing_plan(

api/specs/web-server/_diagnostics.py

@@ -36,7 +36,7 @@ async def healthcheck_liveness_probe():
 
 @router.get(
     "/config",
-    summary="Front end runtime configuration",
+    description="Front end runtime configuration",
     response_model=Envelope[dict[str, Any]],
 )
 async def get_config():
@@ -53,7 +53,7 @@ async def get_scheduled_maintenance():
 
 @router.get(
     "/status",
-    summary="checks status of self and connected services",
+    description="checks status of self and connected services",
     response_model=Envelope[AppStatusCheck],
     response_description="Returns app status check",
 )

api/specs/web-server/_folders.py

@@ -105,7 +105,7 @@ async def delete_folder(
 @router.post(
     "/folders/{folder_id}/workspaces/{workspace_id}:move",
     status_code=status.HTTP_204_NO_CONTENT,
-    summary="Move folder to the workspace",
+    description="Move folder to the workspace",
     tags=["workspaces"],
 )
 async def move_folder_to_workspace(

api/specs/web-server/_projects_crud.py renamed to api/specs/web-server/_projects.py

@@ -31,7 +31,7 @@
 from pydantic import BaseModel
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.projects._common.models import ProjectPathParams
-from simcore_service_webserver.projects._crud_handlers import ProjectCreateParams
+from simcore_service_webserver.projects._crud_handlers import ProjectCreateQueryParams
 from simcore_service_webserver.projects._crud_handlers_models import (
     ProjectActiveQueryParams,
     ProjectsListQueryParams,
@@ -67,12 +67,14 @@ class _ProjectCreateHeaderParams(BaseModel):
 @router.post(
     "/projects",
     response_model=Envelope[TaskGet],
-    summary="Creates a new project or copies an existing one",
-    status_code=status.HTTP_201_CREATED,
+    description="Creates a new project or copies an existing one. "
+    "NOTE: implemented as a long running task, "
+    "i.e. requires polling `status_href` (HTTP_200_OK) to get status and `result_href` (HTTP_201_CREATED) to get created project",
+    status_code=status.HTTP_202_ACCEPTED,
 )
 async def create_project(
     _h: Annotated[_ProjectCreateHeaderParams, Depends()],
-    _path: Annotated[ProjectCreateParams, Depends()],
+    _query: Annotated[ProjectCreateQueryParams, Depends()],
     _body: ProjectCreateNew | ProjectCopyOverride,
 ):
     ...

api/specs/web-server/_projects_comments.py

@@ -40,7 +40,7 @@
 @router.post(
     "/projects/{project_uuid}/comments",
     response_model=Envelope[dict[Literal["comment_id"], CommentID]],
-    summary="Create a new comment for a specific project. The request body should contain the comment contents and user information.",
+    description="Create a new comment for a specific project. The request body should contain the comment contents and user information.",
     status_code=201,
 )
 async def create_project_comment(
@@ -57,7 +57,7 @@ async def create_project_comment(
 @router.get(
     "/projects/{project_uuid}/comments",
     response_model=Envelope[list[ProjectsCommentsAPI]],
-    summary="Retrieve all comments for a specific project.",
+    description="Retrieve all comments for a specific project.",
 )
 async def list_project_comments(
     project_uuid: ProjectID, limit: int = 20, offset: NonNegativeInt = 0
@@ -73,7 +73,7 @@ async def list_project_comments(
 @router.put(
     "/projects/{project_uuid}/comments/{comment_id}",
     response_model=Envelope[ProjectsCommentsAPI],
-    summary="Update the contents of a specific comment for a project. The request body should contain the updated comment contents.",
+    description="Update the contents of a specific comment for a project. The request body should contain the updated comment contents.",
 )
 async def update_project_comment(
     project_uuid: ProjectID,
@@ -90,7 +90,7 @@ async def update_project_comment(
 
 @router.delete(
     "/projects/{project_uuid}/comments/{comment_id}",
-    summary="Delete a specific comment associated with a project.",
+    description="Delete a specific comment associated with a project.",
     status_code=204,
 )
 async def delete_project_comment(project_uuid: ProjectID, comment_id: CommentID):
@@ -105,7 +105,7 @@ async def delete_project_comment(project_uuid: ProjectID, comment_id: CommentID)
 @router.get(
     "/projects/{project_uuid}/comments/{comment_id}",
     response_model=Envelope[ProjectsCommentsAPI],
-    summary="Retrieve a specific comment by its ID within a project.",
+    description="Retrieve a specific comment by its ID within a project.",
 )
 async def get_project_comment(project_uuid: ProjectID, comment_id: CommentID):
     ...

api/specs/web-server/_projects_folders.py

@@ -26,7 +26,7 @@
 @router.put(
     "/projects/{project_id}/folders/{folder_id}",
     status_code=status.HTTP_204_NO_CONTENT,
-    summary="Move project to the folder",
+    description="Move project to the folder",
 )
 async def replace_project_folder(
     _path: Annotated[_ProjectsFoldersPathParams, Depends()],