Added build.yml

Author: Sandip117

.github/workflows/build.yml

@@ -0,0 +1,79 @@
+# Automatically build container images for every push to master,
+# and also every version tag in the form X.X.X[.*].
+# Built images are pushed to both docker.io and ghcr.io
+
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get git tag
+        id: git_info
+        if: startsWith(github.ref, 'refs/tags/')
+        run: echo "::set-output name=tag::${GITHUB_REF##*/}"
+      - name: Determine image tags
+        id: determine
+        env:
+          git_tag: ${{ steps.git_info.outputs.tag }}
+        run: |
+          repo="${GITHUB_REPOSITORY,,}"  # to lower case
+          tag="${git_tag:-latest}"  # if build triggered by tag, use tag name
+          echo "::set-output name=repo::$repo"
+          echo "::set-output name=tag::$tag"
+          echo "::set-output name=dock_image::$repo:$tag"
+      - uses: docker/setup-qemu-action@v1
+      - uses: docker/setup-buildx-action@v1
+        id: buildx
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: |
+           ${{ steps.determine.outputs.dock_image }}
+           ghcr.io/${{ steps.determine.outputs.dock_image }}
+          platforms: linux/amd64,linux/ppc64le,linux/arm64,linux/arm/v7
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+  PushContainerReadme:
+    runs-on: ubuntu-latest
+    name: Push README to Docker Hub
+    steps:
+      - name: git checkout
+        uses: actions/checkout@v2
+      - name: push README to Dockerhub
+        uses: christian-korneck/update-container-description-action@v1
+        env:
+          DOCKER_USER: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKER_PASS: ${{ secrets.DOCKERHUB_PASSWORD }}
+        with:
+          destination_container_repo: fnndsc/pflink
+          provider: dockerhub
+          short_description: 'A Python-FastAPI application to interact with CUBE and pfdcm.'
+          readme_file: 'README.md'
+

app/config.py

@@ -3,7 +3,7 @@
 
 class Settings(BaseSettings):
     pflink_mongodb: MongoDsn = 'mongodb://localhost:27017'
-    version: str = "2.1.3"
+    version: str = "2.1.5"
 
 
 settings = Settings()

app/controllers/pfdcm.py

@@ -85,45 +85,48 @@ async def about_pfdcm(service_name: str) -> dict:
 
 
 # Get the list of `cube` available in a pfdcm instance
-async def cube_list(service_name: str) -> dict:
+async def cube_list(service_name: str) -> list[str]:
+    d_results = []
     pfdcm_server = retrieve_pfdcm(service_name)
     if not pfdcm_server:
-        return {"error": f"{service_name} does not exist."}
+        return d_results
     pfdcm_url = pfdcm_server['service_address']
     pfdcm_cube_list_api = f'{pfdcm_url}/api/v1/SMDB/CUBE/list/'
     try:
         response = requests.get(pfdcm_cube_list_api)
         d_results = json.loads(response.text)
         return d_results
     except:
-        return{"error": f"Unable to reach {pfdcm_url}."}
+        return d_results
 
 
 # Get the list of `swift` servers available in a pfdcm instance
-async def swift_list(service_name: str) -> dict:
+async def swift_list(service_name: str) -> list[str]:
+    d_results = []
     pfdcm_server = retrieve_pfdcm(service_name)
     if not pfdcm_server:
-        return {"error": f"{service_name} does not exist."}
+        return d_results
     pfdcm_url = pfdcm_server['service_address']
     pfdcm_swift_list_api = f'{pfdcm_url}/api/v1/SMDB/swift/list/'
     try:
         response = requests.get(pfdcm_swift_list_api)
         d_results = json.loads(response.text)
         return d_results
     except:
-        return{"error": f"Unable to reach {pfdcm_url}."}
+        return d_results
 
 
 # Get the list of `PACS service` available in a pfdcm instance
-async def pacs_list(service_name: str) -> dict:
+async def pacs_list(service_name: str) -> list[str]:
+    d_results = []
     pfdcm_server = retrieve_pfdcm(service_name)
     if not pfdcm_server:
-        return {"error": f"{service_name} does not exist."}
+        return d_results
     pfdcm_url = pfdcm_server['service_address']
     pfdcm_pacs_list_api = f'{pfdcm_url}/api/v1/PACSservice/list'
     try:
         response = requests.get(pfdcm_pacs_list_api)
         d_results = json.loads(response.text)
         return d_results
     except:
-        return{"error": f"Unable to reach {pfdcm_url}."}
+        return d_results

app/main.py

@@ -1,9 +1,9 @@
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
-from app.routes.basic import router as BasicRouter
-from app.routes.pfdcm import router as PfdcmRouter
-from app.routes.workflow import router as WorkflowRouter
-from app.routes.testing import router as WorkflowTestRouter
+from app.routes.basic import router as basic_router
+from app.routes.pfdcm import router as pfdcm_router
+from app.routes.workflow import router as workflow_router
+from app.routes.testing import router as workflow_testing_router
 from app.config import settings
 
 description = """
@@ -15,8 +15,15 @@
 ## pfdcm
 
 You can **add**,**retrieve** `pfdcm` service info.
+Additionally you can:
 
-## Workflows
+* **Get a `hello` response from a pfdcm instance.**
+* **Know `about` a pfdcm instance.**
+* **Get the list of the names of all `cube` instances available in a pfdcm instance.**
+* **Get the list of the names of all `swift` instances available in a pfdcm instance.**
+* **Get the list of the names of all `PACS` instances available in a pfdcm instance.**
+
+## Workflow
 
 You can **create** new workflows and get status of the workflow.
 
@@ -69,7 +76,7 @@
     allow_methods=["GET", "POST", "PUT", "OPTIONS"],
     allow_headers=["*"],
 )
-app.include_router(BasicRouter, tags=["Basic Info"], prefix="/api/v1")
-app.include_router(PfdcmRouter, tags=["Pfdcm Service Info"], prefix="/api/v1/pfdcm")
-app.include_router(WorkflowRouter, tags=["Workflow Services"], prefix="/api/v1/workflow")
-app.include_router(WorkflowTestRouter, tags=["Test Workflow Services"], prefix="/api/v1/testing")
+app.include_router(basic_router, tags=["Basic Info"], prefix="/api/v1")
+app.include_router(pfdcm_router, tags=["Pfdcm Service Info"], prefix="/api/v1/pfdcm")
+app.include_router(workflow_router, tags=["Workflow Services"], prefix="/api/v1/workflow")
+app.include_router(workflow_testing_router, tags=["Test Workflow Services"], prefix="/api/v1/testing")

app/routes/pfdcm.py

@@ -1,4 +1,4 @@
-from fastapi import APIRouter, Body
+from fastapi import APIRouter, Body, HTTPException
 from fastapi.encoders import jsonable_encoder
 
 from app.controllers.pfdcm import (
@@ -15,7 +15,6 @@
 from app.models.pfdcm import (
     PfdcmQuerySchema,
     PfdcmQueryResponseSchema,
-    PfdcmCollectionResponseModel,
 )
 
 router = APIRouter()
@@ -44,14 +43,12 @@ async def add_pfdcm_data(pfdcm: PfdcmQuerySchema = Body(...)) -> PfdcmQueryRespo
     response_description="pfdcm setup info.",
     summary="Retrieve all `pfdcm` services saved."
 )
-async def get_pfdcms() -> PfdcmCollectionResponseModel:
+async def get_pfdcms() -> list[str]:
     """
     Fetch all `pfdcm` service addresses from the DB.
     """
     pfdcms = await retrieve_pfdcms()
-    if pfdcms:
-        return PfdcmCollectionResponseModel(data=pfdcms, message="pfdcm data retrieved successfully.")
-    return PfdcmCollectionResponseModel(data=pfdcms, message="There are no records in the DB.")
+    return pfdcms
 
 
 @router.get(
@@ -100,35 +97,41 @@ async def get_about_pfdcm(service_name: str) -> PfdcmQueryResponseSchema:
     response_description="About PFDCM",
     summary="Get the list of cube services registered to a `pfdcm` instance"
 )
-async def cube_service_list(service_name: str) -> PfdcmCollectionResponseModel:
+async def cube_service_list(service_name: str) -> list[str]:
     """
     Get the list of PACS services registered to a `pfdcm` instance by providing its service name
     """
     response = await cube_list(service_name)
-    return PfdcmQueryResponseSchema(data=response, message="")
+    if not response:
+        raise HTTPException(status_code=404, detail=f"Unable to reach endpoints of {service_name}")
+    return response
 
 
 @router.get(
     "/{service_name}/swift/list",
     response_description="About PFDCM",
     summary="Get the list of swift services registered to a `pfdcm` instance"
 )
-async def swift_service_list(service_name: str) -> PfdcmCollectionResponseModel:
+async def swift_service_list(service_name: str) -> list[str]:
     """
     Get the list of PACS services registered to a `pfdcm` instance by providing its service name
     """
     response = await swift_list(service_name)
-    return PfdcmQueryResponseSchema(data=response, message="")
+    if not response:
+        raise HTTPException(status_code=404, detail=f"Unable to reach endpoints of {service_name}")
+    return response
 
 
 @router.get(
     "/{service_name}/PACSservice/list",
     response_description="About PFDCM",
     summary="Get the list of PACS services registered to a `pfdcm` instance"
 )
-async def pacs_service_list(service_name: str) -> PfdcmCollectionResponseModel:
+async def pacs_service_list(service_name: str) -> list[str]:
     """
     Get the list of PACS services registered to a `pfdcm` instance by providing its service name
     """
     response = await pacs_list(service_name)
-    return PfdcmQueryResponseSchema(data=response, message="")
+    if not response:
+        raise HTTPException(status_code=404, detail=f"Unable to reach endpoints of {service_name}")
+    return response

app/routes/testing.py

@@ -31,7 +31,7 @@ async def test_create_workflow(
      * **compute**
      * **cube**
 
-     For an invalid error_type you get a error message as follows:
+     For an invalid error_type you get an error message as follows:
       * "Undefined error_type : Please pass values as pfdcm/study/feed/analysis/compute/cube as valid error_type"
     """
     response = await post_workflow(data, test=True, error_type=error_type)

pflink.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 docker build -t local/pflink .
 docker-compose up -d --remove-orphans
-docker-compose exec pflink pytest .
+

test.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+docker-compose exec pflink pytest .

tests/test_pfdcm.py

@@ -71,36 +71,26 @@ def test_get_pfdcm_about(test_app, monkeypatch):
 
 def test_get_pfdcm_cube_list(test_app, monkeypatch):
     test_response_payload = {
-        "data": {
-            "error": "Unable to reach something else."
-        },
-        "message": ""
+        "detail": "Unable to reach endpoints of something"
     }
     response = test_app.get("/api/v1/pfdcm/something/cube/list")
-    assert response.status_code == 200
+    assert response.status_code == 404
     assert response.json() == test_response_payload
 
 
 def test_get_pfdcm_swift_list(test_app, monkeypatch):
     test_response_payload = {
-        "data": {
-            "error": "Unable to reach something else."
-        },
-        "message": ""
+        "detail": "Unable to reach endpoints of something"
     }
     response = test_app.get("/api/v1/pfdcm/something/swift/list")
-    assert response.status_code == 200
+    assert response.status_code == 404
     assert response.json() == test_response_payload
 
 
 def test_get_pfdcm_pacs_list(test_app, monkeypatch):
     test_response_payload = {
-        "data": {
-            "error": "Unable to reach something else."
-        },
-        "message": ""
+        "detail": "Unable to reach endpoints of something"
     }
     response = test_app.get("/api/v1/pfdcm/something/PACSservice/list")
-    assert response.status_code == 200
+    assert response.status_code == 404
     assert response.json() == test_response_payload
-