Merge branch 'dspace-cris-2024_02_x' into ux-plus-cris-2024_02_x

Author: atarix83

.github/workflows/docker.yml

@@ -9,44 +9,66 @@ name: Docker images
 on:
   push:
     branches:
-      - main
-      - 'dspace-**'
+      - main-cris
+      - 'dspace-cris-*_02_x'
     tags:
-      - 'dspace-**'
+      - 'dspace-cris-**'
   pull_request:
 
 permissions:
   contents: read  # to fetch code (actions/checkout)
   packages: write # to write images to GitHub Container Registry (GHCR)
 
 jobs:
+
+  ####################################################
+  # Build/Push the '4science/dspace-cris-dependencies' image.
+  # This image is used by all other DSpace build jobs.
+  ####################################################
+  dspace-cris-angular-dependencies:
+    # Ensure this job never runs on forked repos. It's only executed for '4science/dspace'
+    if: github.repository == '4science/dspace-angular'
+    # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
+    uses: 4science/DSpace/.github/workflows/reusable-docker-build.yml@dspace-cris-2024_02_x
+    with:
+      build_id: dspace-cris-angular-dependencies
+      image_name: 4science/dspace-cris-angular-dependencies
+      dockerfile_path: ./Dockerfile.dependencies
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_ACCESS_TOKEN: ${{ secrets.DOCKER_ACCESS_TOKEN }}
+
+
   #############################################################
-  # Build/Push the 'dspace/dspace-angular' image
+  # Build/Push the '4science/dspace-cris-angular' image
   #############################################################
   dspace-angular:
     # Ensure this job never runs on forked repos. It's only executed for 'dspace/dspace-angular'
-    if: github.repository == 'dspace/dspace-angular'
+    if: github.repository == '4science/dspace-angular'
     # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
-    uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@main
+    uses: 4science/DSpace/.github/workflows/reusable-docker-build.yml@dspace-cris-2024_02_x
+    needs: dspace-cris-angular-dependencies
     with:
-      build_id: dspace-angular-dev
-      image_name: dspace/dspace-angular
+      build_id: dspace-cris-angular-dev
+      image_name: 4science/dspace-cris-angular
       dockerfile_path: ./Dockerfile
     secrets:
       DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
       DOCKER_ACCESS_TOKEN: ${{ secrets.DOCKER_ACCESS_TOKEN }}
 
   #############################################################
-  # Build/Push the 'dspace/dspace-angular' image ('-dist' tag)
+  # Build/Push the '4science/dspace-cris-angular' image ('-dist' tag)
   #############################################################
   dspace-angular-dist:
     # Ensure this job never runs on forked repos. It's only executed for 'dspace/dspace-angular'
-    if: github.repository == 'dspace/dspace-angular'
+    if: github.repository == '4science/dspace-angular'
     # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
-    uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@main
+    uses: 4science/DSpace/.github/workflows/reusable-docker-build.yml@dspace-cris-2024_02_x
+    # Must run after 'dspace-dependencies' job above
+    needs: dspace-cris-angular-dependencies
     with:
-      build_id: dspace-angular-dist
-      image_name: dspace/dspace-angular
+      build_id: dspace-cris-angular-dist
+      image_name: 4science/dspace-cris-angular
       dockerfile_path: ./Dockerfile.dist
       # As this is a "dist" image, its tags are all suffixed with "-dist". Otherwise, it uses the same
       # tagging logic as the primary 'dspace/dspace-angular' image above.

Dockerfile

@@ -2,10 +2,10 @@
 # See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
 
 ARG NODE_VERSION=22
-ARG DSPACE_VERSION=2024_02_x
+ARG DSPACE_VERSION=dspace-cris-2024_02_x
 ARG DOCKER_REGISTRY=docker.io
 
-FROM ${DOCKER_REGISTRY:-docker.io}/4science/dspace-cris-angular-dependencies:${DSPACE_VERSION:-2024_02_x} AS dev
+FROM ${DOCKER_REGISTRY:-docker.io}/4science/dspace-cris-angular-dependencies:${DSPACE_VERSION:-dspace-cris-2024_02_x} AS dev
 
 WORKDIR /app
 ADD . /app/

Dockerfile.dependencies

@@ -1,12 +1,12 @@
 # Test build:
-# docker build -f Dockerfile.dependencies -t 4science/dspace-angular-dependencies:2024_02_x .
+# docker build -f Dockerfile.dependencies -t 4science/dspace-cris-angular-dependencies:dspace-cris-2024_02_x .
 
 # Angular 17 + Node 22 optimized Dockerfile
 ARG NODE_VERSION=22
-ARG DSPACE_VERSION=2024_02_X
+ARG DSPACE_VERSION=dspace-cris-2024_02_x
 ARG DOCKER_REGISTRY=docker.io
 
-FROM ${DOCKER_REGISTRY:-docker.io}/node:${NODE_VERSION-22}-alpine AS dependencies
+FROM docker.io/node:${NODE_VERSION-22}-alpine AS dependencies
 
 # Install build dependencies
 RUN apk add --no-cache python3 make g++
@@ -15,4 +15,4 @@ WORKDIR /app
 
 # Install dependencies (use npm ci if you have package-lock.json)
 COPY package.json yarn.lock ./
-RUN yarn install --network-timeout 300000
+RUN yarn install --frozen-lockfile --network-timeout 300000

Dockerfile.dist

@@ -1,27 +1,28 @@
 # syntax=docker/dockerfile:1.7-labs
 
 # This image will be published as dspace/dspace-angular:$DSPACE_VERSION-dist
-# See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
+# See https://github.com/4science/dspace-angular/tree/main/docker for usage details
 
 # Test build:
-# docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-8_x-dist .
+# docker build -f Dockerfile.dist -t 4science/dspace-angular:dspace-cris-2024_02_x-dist .
 
 # Angular 17 + Node 22 optimized Dockerfile
 ARG NODE_VERSION=22
-ARG DSPACE_VERSION=2024_02_x
+ARG DSPACE_VERSION=dspace-cris-2024_02_x
 ARG DOCKER_REGISTRY=docker.io
 
-FROM ${DOCKER_REGISTRY:-docker.io}/4science/dspace-cris-angular-dependencies:${DSPACE_VERSION:-2024_02_x} AS build
+FROM ${DOCKER_REGISTRY:-docker.io}/4science/dspace-cris-angular-dependencies:${DSPACE_VERSION:-dspace-cris-2024_02_x} AS build
 
-COPY --parents src/** config/** webpack/** docker/dspace-ui.json angular.json server.ts startup-message.ts tsconfig.json tsconfig.app.json tsconfig.server.json tsconfig.spec.json tsconfig.ts-node.json typedoc.json /app/
+COPY . /app/
 
 WORKDIR /app
 
 # Build Angular app
 RUN yarn build:prod
+RUN yarn build:mirador
 
 # ---- Production image ----
-FROM ${DOCKER_REGISTRY:-docker.io}/node:${NODE_VERSION-22}-alpine AS prod
+FROM docker.io/node:${NODE_VERSION-22}-alpine AS prod
 
 # Install pm2 globally and clean npm cache
 RUN npm install --global pm2 && npm cache clean --force

bitbucket-pipelines.yml

@@ -18,8 +18,8 @@ definitions:
           - git config --global user.name "${BB_EMAIL}"
           - git clone https://x-token-auth:${E2ERUNNERS_ACCESS_TOKEN}@${E2E_VALUES_REPO}
           - cd e2erunners-values
-          - sed "s#HASH_COMMIT#${HASH_COMMIT}#g" TPL > ${HASH_COMMIT}
-          - sed -i "s#BRANCH_NAME#${BRANCH_NAME}#g" TPL ${HASH_COMMIT}
+          - sed "s#HASH_COMMIT#${HASH_COMMIT}#g" TPL-cris-2024 > ${HASH_COMMIT}
+          - sed -i "s#BRANCH_NAME#${BRANCH_NAME}#g" TPL-cris-2024 ${HASH_COMMIT}
           - git add ${HASH_COMMIT}
           - git commit -m "Add configuration for e2e-${HASH_COMMIT}" || echo "No changes to commit"
           - git push
@@ -44,8 +44,8 @@ definitions:
           - git config --global user.name "${BB_EMAIL}"
           - git clone https://x-token-auth:${E2ERUNNERS_ACCESS_TOKEN}@${E2E_VALUES_REPO}
           - cd e2erunners-values
-          - sed "s#HASH_COMMIT#${HASH_COMMIT}#g" TPL > ${HASH_COMMIT}
-          - sed -i "s#BRANCH_NAME#${BRANCH_NAME}#g" TPL ${HASH_COMMIT}
+          - sed "s#HASH_COMMIT#${HASH_COMMIT}#g" TPL-cris-2024 > ${HASH_COMMIT}
+          - sed -i "s#BRANCH_NAME#${BRANCH_NAME}#g" TPL-cris-2024 ${HASH_COMMIT}
           - git add ${HASH_COMMIT}
           - git commit -m "Add configuration for e2e-${HASH_COMMIT}" || echo "No changes to commit"
           - git push
@@ -184,6 +184,21 @@ definitions:
           - git commit -am "Update TAG with ${BRANCH_NAME}-${HASH_COMMIT}" || echo "No changes to commit"
           - git push
 
+    - step: &deploy-on-test
+        name: Deploy on Test environment
+        image: alpine/git:latest
+        script:
+          - export HASH_COMMIT=${BITBUCKET_COMMIT:0:8}
+          - export BRANCH_NAME=$(echo "$BITBUCKET_BRANCH" | tr '[:upper:]' '[:lower:]' | sed 's|/|--|g')
+          - export BRANCH_FILE=$(echo "$BITBUCKET_BRANCH" | awk -F'/' '{if(NF==1)val=$1;else if(NF==2)val=$2;else if(NF==3)val=$2;else val=$3;gsub(/_/, "-", val);print tolower(val)}')
+          - git clone https://x-token-auth:${DSPACE_VALUES_ACCESS_TOKEN}@${DSPACE_VALUES_REPO}
+          - cd dspace-values
+          - '[ -f "test/${BRANCH_FILE}" ] && sed -i "/^angular:/,/^[^ ]/s/\(tag: \).*/\1${BRANCH_NAME}-${HASH_COMMIT}/" "test/${BRANCH_FILE}" && sed -i "s/^\([[:space:]]*replicaCount:\) 0/\1 1/" "test/${BRANCH_FILE}"'
+          - git config --global user.email "${BB_EMAIL}"
+          - git config --global user.name "${BB_USER}"
+          - git commit -am "Update TAG with ${BRANCH_NAME}-${HASH_COMMIT}" || echo "No changes to commit"
+          - git push
+
     - step: &turn-on-dev
         name: Turn On Dev environment
         image: alpine/git:latest
@@ -214,6 +229,21 @@ definitions:
           - git commit -am "Enable staging environment for ${BRANCH_NAME}" || echo "No changes to commit"
           - git push
 
+    - step: &turn-on-test
+        name: Turn On Test environment
+        image: alpine/git:latest
+        script:
+          - export HASH_COMMIT=${BITBUCKET_COMMIT:0:8}
+          - export BRANCH_NAME=$(echo "$BITBUCKET_BRANCH" | tr '[:upper:]' '[:lower:]' | sed 's|/|--|g')
+          - export BRANCH_FILE=$(echo "$BITBUCKET_BRANCH" | awk -F'/' '{if(NF==1)val=$1;else if(NF==2)val=$2;else if(NF==3)val=$2;else val=$3;gsub(/_/, "-", val);print tolower(val)}')
+          - git clone https://x-token-auth:${DSPACE_VALUES_ACCESS_TOKEN}@${DSPACE_VALUES_REPO}
+          - cd dspace-values
+          - '[ -f "test/${BRANCH_FILE}" ] && sed -i "s/^\([[:space:]]*replicaCount:\) 0/\1 1/" "staging/${BRANCH_FILE}"'
+          - git config --global user.email "${BB_USER}"
+          - git config --global user.name "${BB_EMAIL}"
+          - git commit -am "Enable test environment for ${BRANCH_NAME}" || echo "No changes to commit"
+          - git push
+
     - step: &find-and-invalidate-cloudfront-dev
         name: Invalidate CloudFront Dev Cache
         image: amazon/aws-cli
@@ -236,6 +266,17 @@ definitions:
           - export CLOUDFRONT_DISTRIBUTION_ID=$(aws cloudfront list-distributions --query "DistributionList.Items[?Comment=='staging--${CLOUDFRONT_NAME}'].Id" --output text)
           - aws cloudfront create-invalidation --distribution-id $CLOUDFRONT_DISTRIBUTION_ID --paths "/*"
 
+    - step: &find-and-invalidate-cloudfront-test
+        name: Invalidate CloudFront Test Cache
+        image: amazon/aws-cli
+        script:
+          - export AWS_ACCESS_KEY_ID=$AWS_ACCESS_CF_KEY_ID
+          - export AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_CF_KEY
+          - export AWS_DEFAULT_REGION=$AWS_REGION
+          - export CLOUDFRONT_NAME=$(echo "$BITBUCKET_BRANCH" | awk -F'/' '{if(NF==1)val=$1;else if(NF==2)val=$2;else if(NF==3)val=$2;else val=$3;gsub(/_/, "-", val);print tolower(val)}')
+          - export CLOUDFRONT_DISTRIBUTION_ID=$(aws cloudfront list-distributions --query "DistributionList.Items[?Comment=='test--${CLOUDFRONT_NAME}'].Id" --output text)
+          - aws cloudfront create-invalidation --distribution-id $CLOUDFRONT_DISTRIBUTION_ID --paths "/*"
+
 pipelines:
   custom:
     e2e-on-custom-backend:
@@ -253,6 +294,8 @@ pipelines:
       - step: *turn-on-dev
     turn-on-staging:
       - step: *turn-on-staging
+    turn-on-test:
+      - step: *turn-on-test
   branches:
     'ux-plus-cris-2024_02_x':
       - step: *preliminary-operation
@@ -272,6 +315,14 @@ pipelines:
       - step: *find-and-invalidate-cloudfront-dev
       - step: *deploy-on-staging
       - step: *find-and-invalidate-cloudfront-staging
+    'test/**':
+      - step: *preliminary-operation
+      - step: *angular-build
+      - parallel: *parallel-run-tests
+      - step: *build-and-push
+      - step: *deploy-on-test
+      - step: *find-and-invalidate-cloudfront-test
+
   pull-requests:
     '**':
       - step: *preliminary-operation

docker/README.md

@@ -23,14 +23,14 @@ the Docker compose scripts in this 'docker' folder.
 This Dockerfile is used to build a *development* DSpace-CRIS Angular UI image, published as '4science/dspace-cris-angular'
 
 ```
-docker build -t 4science/dspace-cris-angular:2024_02_x .
+docker build -t 4science/dspace-cris-angular:dspace-cris-2024_02_x .
 ```
 
 This image is built *automatically* after each commit is made to the `main` branch.
 
 Admins to our DockerHub repo can manually publish with the following command.
 ```
-docker push 4science/dspace-cris-angular:2024_02_x
+docker push 4science/dspace-cris-angular:dspace-cris-2024_02_x
 ```
 
 ### Dockerfile.dist
@@ -39,7 +39,7 @@ The `Dockerfile.dist` is used to generate a *production* build and runtime envir
 
 ```bash
 # build the latest image
-docker build -f Dockerfile.dist -t 4science/dspace-cris-angular:2024_02_x-dist .
+docker build -f Dockerfile.dist -t 4science/dspace-cris-angular:dspace-cris-2024_02_x-dist .
 ```
 
 A default/demo version of this image is built *automatically*.
@@ -71,7 +71,7 @@ docker compose -f docker/docker-compose.yml build
 
 This command provides a quick way to start both the frontend & backend from this single codebase
 ```
-docker compose -p c24 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
+docker compose -p dcris24 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
 ```
 
 Keep in mind, you may also start the backend by cloning the 'DSpace/DSpace' GitHub repository separately. See the next section.
@@ -86,14 +86,14 @@ _The system will be started in 2 steps. Each step shares the same docker network
 
 From 'DSpace/DSpace' clone (build first as needed):
 ```
-docker compose -p c24 up -d
+docker compose -p dcris24 up -d
 ```
 
 NOTE: More detailed instructions on starting the backend via Docker can be found in the [Docker Compose instructions for the Backend](https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/README.md).
 
 From 'DSpace/dspace-angular' clone (build first as needed)
 ```
-docker compose -p c24 -f docker/docker-compose.yml up -d
+docker compose -p dcris24 -f docker/docker-compose.yml up -d
 ```
 
 At this point, you should be able to access the UI from http://localhost:4000,
@@ -107,38 +107,38 @@ This allows you to run the Angular UI in *production* mode, pointing it at the d
 ```
 docker compose -f docker/docker-compose-dist.yml pull
 docker compose -f docker/docker-compose-dist.yml build
-docker compose -p c24 -f docker/docker-compose-dist.yml up -d
+docker compose -p dcris24 -f docker/docker-compose-dist.yml up -d
 ```
 
 ## Ingest test data from AIPDIR
 
 Create an administrator
 ```
-docker compose -p c24 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
+docker compose -p dcris24 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
 ```
 
 Load content from AIP files
 ```
-docker compose -p c24 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
+docker compose -p dcris24 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
 ```
 
 ## Alternative Ingest - Use Entities dataset
 _Delete your docker volumes or use a unique project (-p) name_
 
 Start DSpace-CRIS with Database Content from a database dump
 ```
-docker compose -p c24 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
+docker compose -p dcris24 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
 ```
 
 Load assetstore content and trigger a re-index of the repository
 ```
-docker compose -p c24 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
+docker compose -p dcris24 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
 ```
 
 ## End to end testing of the REST API (runs in GitHub Actions CI).
 _In this instance, only the REST api runs in Docker using the Entities dataset. GitHub Actions will perform CI testing of Angular using Node to drive the tests.  See `.github/workflows/build.yml` for more details._
 
 This command is only really useful for testing our Continuous Integration process.
 ```
-docker compose -p c24ci -f docker/docker-compose-ci.yml up -d
+docker compose -p dcris24ci -f docker/docker-compose-ci.yml up -d
 ```

docker/cli.yml

@@ -14,14 +14,14 @@
 # Therefore, it should be kept in sync with that file
 networks:
   # Default to using network named 'dspacenet' from docker-compose-rest.yml.
-  # Its full name will be prepended with the project name (e.g. "-p d8" means it will be named "d8_dspacenet")
+  # Its full name will be prepended with the project name (e.g. "-p dcris24" means it will be named "dcris24_dspacenet")
   # If COMPOSITE_PROJECT_NAME is missing, default value will be "docker" (name of folder this file is in)
   default:
     name: ${COMPOSE_PROJECT_NAME:-docker}_dspacenet
     external: true
 services:
   dspace-cli:
-    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-4science}/dspace-cris-cli:${DSPACE_VER:-2024_02_x}"
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-4science}/dspace-cris-cli:${DSPACE_VER:-dspace-cris-2024_02_x}"
     container_name: dspace-cli
     environment:
       # Below syntax may look odd, but it is how to override dspace.cfg settings via env variables.

docker/db.entities.yml

@@ -14,7 +14,7 @@
 # # Therefore, it should be kept in sync with that file
 services:
   dspacedb:
-    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-4science}/dspace-cris-postgres-pgcrypto:${DSPACE_VER:-2024_02_x}-loadsql"
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-4science}/dspace-cris-postgres-pgcrypto:${DSPACE_VER:-dspace-cris-2024_02_x}-loadsql"
     environment:
       # This LOADSQL should be kept in sync with the URL in 4Science/DSpace
       # This SQL is available from https://github.com/4Science/DSpace-CRIS-Files/releases/download/cris-2024.02.00/db-entities.sql