Merge branch 'develop' into systems-tree-test-#1272

Author: joshdimanteto

.github/workflows/ci-build.yml

@@ -1,6 +1,12 @@
 name: CI Build
 
 on:
+  workflow_dispatch:
+    inputs:
+      push-docker-image-to-harbor:
+        description: 'Push Docker Image to Harbor'
+        type: boolean
+        default: false
   pull_request:
   push:
     branches:
@@ -17,7 +23,7 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: 20
           cache: 'yarn'
@@ -34,13 +40,13 @@ jobs:
 
       - name: Upload coverage reports to Codecov
         if: success()
-        uses: codecov/codecov-action@1e68e06f1dbfde0e4cefc87efeba9e4643565303 # v5
+        uses: codecov/codecov-action@ad3126e916f78f00edff4ed0317cf185271ccc2d # v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Upload test results to Codecov
         if: ${{ !cancelled() }}
-        uses: codecov/test-results-action@4e79e65778be1cecd5df25e14af1eafb6df80ea9 # v1
+        uses: codecov/test-results-action@f2dba722c67b86c6caa034178c6e4d35335f6706 # v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
@@ -53,7 +59,7 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: 20
           cache: 'yarn'
@@ -67,7 +73,7 @@ jobs:
 
       - name: Upload Cypress screenshots
         if: failure()
-        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: Inventory management system Screenshots
           path: cypress/screenshots
@@ -77,31 +83,31 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Clone api repo
-        uses: actions/checkout@cbb722410c2e876e24abbe8de2cc27693e501dcb
+      - name: Clone IMS api repo
+        uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2
         with:
           repository: ral-facilities/inventory-management-system-api
           ref: develop
 
       - name: Set up Python
-        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
           python-version: '3.12'
 
       # This is required as need to setup api in a different directory as checkout will attempt delete
       # all existing files which in this case will include a data directory created by docker causing
       # a permission error (checkout action also can't specify a different directory to clone into)
-      - name: Move api repo
+      - name: Move IMS api repo
         run: |
           cd ..
           mkdir inventory-management-system-api
           mv -v inventory-management-system/* inventory-management-system-api/
           cd inventory-management-system-api/
 
-      - name: Setup MongoDB
+      - name: Start MongoDB (For inventory-management-system-api)
         working-directory: ../inventory-management-system-api
         run: |
-          python ./scripts/dev_cli.py --ci db-init --replicaSetMemberHost localhost
+          docker compose up --detach mongo-db
 
       # Use docker run here to test the actual built image
       # Use same network as the MongoDB instance (which is generated by docker compose based on the folder
@@ -121,16 +127,72 @@ jobs:
           --env API__ALLOWED_CORS_HEADERS='["*"]' \
           --env API__ALLOWED_CORS_ORIGINS='["*"]' \
           --env API__ALLOWED_CORS_METHODS='["*"]' \
-          --env OBJECT_STORAGE__ENABLED=false \
+          --env OBJECT_STORAGE__ENABLED=true \
           --env OBJECT_STORAGE__API_REQUEST_TIMEOUT_SECONDS=10 \
           --env OBJECT_STORAGE__API_URL=http://localhost:8002 \
           harbor.stfc.ac.uk/inventory-management-system/ims-api:develop
 
+      - name: Clone Object Storage api repo
+        uses: actions/checkout@cbb722410c2e876e24abbe8de2cc27693e501dcb
+        with:
+          repository: ral-facilities/object-storage-api
+          ref: develop
+          path: object-storage-api
+
+      - name: Move Object Storage api repo
+        run: |
+          cd ..
+          mkdir object-storage-api
+          mv -v inventory-management-system/* .
+          cd object-storage-api/
+
+      - name: Start MongoDB and MinIO (For object-storage-api)
+        working-directory: ../object-storage-api
+        run: |
+          docker compose up --detach mongo-db minio
+          sleep 10
+
+      - name: Create MinIO buckets (For object-storage-api)
+        working-directory: ../object-storage-api
+        run: |
+          docker compose up minio-create-buckets
+
+      - name: Start object-storage-api
+        run: |
+          docker run -d -p 8002:8000 \
+          --name object_storage_api_container \
+          --network object-storage-api_default \
+          --env AUTHENTICATION__ENABLED=false \
+          --env API__TITLE="Object Storage Service API" \
+          --env API__DESCRIPTION="This is the API for the Object Storage Service" \
+          --env DATABASE__PROTOCOL="mongodb" \
+          --env DATABASE__USERNAME="root" \
+          --env DATABASE__PASSWORD="example" \
+          --env DATABASE__HOST_AND_OPTIONS="object-storage-api-mongodb:27017" \
+          --env DATABASE__NAME="object-storage" \
+          --env API__ALLOWED_CORS_HEADERS='["*"]' \
+          --env API__ALLOWED_CORS_ORIGINS='["*"]' \
+          --env API__ALLOWED_CORS_METHODS='["*"]' \
+          --env OBJECT_STORAGE__ENDPOINT_URL="http://localhost:9000" \
+          --env OBJECT_STORAGE__ACCESS_KEY="root" \
+          --env OBJECT_STORAGE__SECRET_ACCESS_KEY="example_password" \
+          --env OBJECT_STORAGE__BUCKET_NAME="object-storage" \
+          --env OBJECT_STORAGE__PRESIGNED_URL_EXPIRY_SECONDS=1800 \
+          --env ATTACHMENT__MAX_SIZE_BYTES=104857600 \
+          --env IMAGE__THUMBNAIL_MAX_SIZE_PIXELS=300 \
+          --env ATTACHMENT__ALLOWED_FILE_EXTENSIONS='[".csv", ".doc", ".docx", ".ods", ".odt", ".rtf", ".pdf", ".txt", ".xls", ".xlsx"]' \
+          --env ATTACHMENT__UPLOAD_LIMIT=50 \
+          --env IMAGE__ALLOWED_FILE_EXTENSIONS='[".bmp", ".jpe", ".jpeg", ".jpg", ".png", ".tif", ".tiff", ".webp"]' \
+          --env IMAGE__UPLOAD_LIMIT=100 \
+          --add-host "localhost:host-gateway" \
+          -v /home/runner/work/inventory-management-system/object-storage-api/object_storage_api/logging.example.ini:/app/object_storage_api/logging.ini \
+          harbor.stfc.ac.uk/scd-object-storage-api/object-storage-api:develop
+
       - name: Checkout repo
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: 20
           cache: 'yarn'
@@ -142,17 +204,29 @@ jobs:
       - name: Run e2e tests
         run: yarn e2e:api
 
-      - name: Output docker logs (mongodb)
+      - name: Output docker logs (ims mongodb)
         if: failure()
         run: docker logs ims_api_mongodb_container
 
-      - name: Output docker logs (api)
+      - name: Output docker logs (ims api)
         if: failure()
         run: docker logs inventory_management_system_api_container
+      
+      - name: Output docker logs (object-storage mongodb)
+        if: failure()
+        run: docker logs object-storage-api-mongodb
+
+      - name: Output docker logs (object-storage minio)
+        if: failure()
+        run: docker logs object-storage-minio
+
+      - name: Output docker logs (object-storage api)
+        if: failure()
+        run: docker logs object_storage_api_container
 
       - name: Upload Cypress screenshots
         if: failure()
-        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: Inventory management system (with api) Screenshots
           path: cypress/screenshots
@@ -167,7 +241,7 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: 20
           cache: 'yarn'
@@ -187,28 +261,30 @@ jobs:
     needs: [lint-and-unit-test, e2e-tests, e2e-tests-api]
     name: Docker
     runs-on: ubuntu-latest
+    env:
+      PUSH_DOCKER_IMAGE_TO_HARBOR: ${{ inputs.push-docker-image-to-harbor != null && inputs.push-docker-image-to-harbor || 'false' }}
     steps:
       - name: Check out repo
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Login to Harbor
-        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
         with:
           registry: ${{ secrets.HARBOR_URL }}
           username: ${{ secrets.HARBOR_USERNAME }}
           password: ${{ secrets.HARBOR_TOKEN }}
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@369eb591f429131d6889c46b94e711f089e6ca96 # v5.6.1
+        uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0
         with:
           images: ${{ secrets.HARBOR_URL }}/ims
 
-      - name: Build and push Docker image to Harbor
-        uses: docker/build-push-action@b32b51a8eda65d6793cd0494a773d4f6bcef32dc # v6.11.0
+      - name: ${{ fromJSON(env.PUSH_DOCKER_IMAGE_TO_HARBOR) && 'Build and push Docker image to Harbor' || 'Build Docker image' }}
+        uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # v6.16.0
         with:
           context: .
           file: ./Dockerfile.prod
-          push: true
+          push: ${{ fromJSON(env.PUSH_DOCKER_IMAGE_TO_HARBOR) }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.github/workflows/release-build.yml

@@ -16,15 +16,15 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Login to Harbor
-        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
         with:
           registry: ${{ secrets.HARBOR_URL }}
           username: ${{ secrets.HARBOR_USERNAME }}
           password: ${{ secrets.HARBOR_TOKEN }}
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@369eb591f429131d6889c46b94e711f089e6ca96 # v5.6.1
+        uses: docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5.7.0
         with:
           images: ${{ secrets.HARBOR_URL }}/ims
           tags: |
@@ -34,7 +34,7 @@ jobs:
             latest=false
 
       - name: Build and push Docker image to Harbor
-        uses: docker/build-push-action@b32b51a8eda65d6793cd0494a773d4f6bcef32dc # v6.11.0
+        uses: docker/build-push-action@14487ce63c7a62a4a324b0bfb37086795e31c6c1 # v6.16.0
         with:
           context: .
           file: ./Dockerfile.prod

.gitignore

@@ -15,6 +15,7 @@ node_modules
 # testing
 **/cypress/logs/
 coverage
+cypress/downloads/
 cypress/screenshots/
 
 # development