testing and docker replacements (#3968)

This PR restructures testing scripts and Docker configurations to use centralized compose files, introduces new Docker Compose variants with integrated frontend services, and updates related CI workflows. Migrate test scripts to reference testing/compose files and streamline test flows with forced rebuilds and direct curl checks. Add ultra-lite, security, and security-with-login compose files under testing/compose, each defining both backend and frontend services. Rename and adjust frontend imports and update CI workflows to build and validate the frontend separately.
2026-03-04 02:20:19 +01:00 · 2025-07-18 14:19:36 +01:00
parent 0742364a03
commit 0549c5b191
10 changed files with 203 additions and 300 deletions
--- a/docker/README.md
+++ b/docker/README.md
@@ -14,15 +14,10 @@ docker/
 │   ├── Dockerfile     # React/Vite frontend with nginx
 │   ├── nginx.conf     # Nginx configuration
 │   └── entrypoint.sh  # Dynamic backend URL setup
-├── monolith/          # Single container setup
-│   ├── Dockerfile           # Combined frontend + backend
-│   ├── nginx-monolith.conf  # Nginx config for monolith
-│   └── start-monolith.sh    # Startup script
 └── compose/           # Docker Compose files
    ├── docker-compose.yml           # Standard setup
    ├── docker-compose.ultra-lite.yml # Ultra-lite setup
-    ├── docker-compose.fat.yml       # Full-featured setup
-    └── docker-compose.monolith.yml  # Single container setup
+    └── docker-compose.fat.yml       # Full-featured setup
 ```

 ## Usage
@@ -42,12 +37,6 @@ docker-compose -f docker/compose/docker-compose.ultra-lite.yml up --build
 docker-compose -f docker/compose/docker-compose.fat.yml up --build
 ```

-### Single Container (Monolith)
-
-```bash
-# Single container with both frontend and backend
-docker-compose -f docker/compose/docker-compose.monolith.yml up --build
-```

 ## Access Points

@@ -57,7 +46,7 @@ docker-compose -f docker/compose/docker-compose.monolith.yml up --build

 ## Configuration

- **Backend URL**: Set `BACKEND_URL` environment variable for custom backend locations
+- **Backend URL**: Set `VITE_API_BASE_URL` environment variable for custom backend locations
 - **Custom Ports**: Modify port mappings in docker-compose files
 - **Memory Limits**: Adjust memory limits per variant (2G ultra-lite, 4G standard, 6G fat)

--- a/docker/compose/docker-compose.monolith.yml
+++ b/docker/compose/docker-compose.monolith.yml
@@ -1,40 +0,0 @@
-services:
-  stirling-pdf-monolith:
-    build:
-      context: ../..
-      dockerfile: docker/monolith/Dockerfile
-    container_name: stirling-pdf-monolith
-    restart: on-failure:5
-    deploy:
-      resources:
-        limits:
-          memory: 4G
-    healthcheck:
-      test: ["CMD-SHELL", "curl -f http://localhost:80/ && curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP'"]
-      interval: 10s
-      timeout: 15s
-      retries: 16
-    ports:
-      - "3000:80"   # Frontend access
-      - "8080:8080" # Direct backend access (for debugging)
-    volumes:
-      - ../../stirling/latest/data:/usr/share/tessdata:rw
-      - ../../stirling/latest/config:/configs:rw
-      - ../../stirling/latest/logs:/logs:rw
-    environment:
-      DISABLE_ADDITIONAL_FEATURES: "true"
-      SECURITY_ENABLELOGIN: "false"
-      LANGS: "en_GB,en_US,ar_AR,de_DE,fr_FR,es_ES,zh_CN,zh_TW,ca_CA,it_IT,sv_SE,pl_PL,ro_RO,ko_KR,pt_BR,ru_RU,el_GR,hi_IN,hu_HU,tr_TR,id_ID"
-      SYSTEM_DEFAULTLOCALE: en-US
-      UI_APPNAME: Stirling-PDF
-      UI_HOMEDESCRIPTION: Single container Stirling-PDF
-      UI_APPNAMENAVBAR: Stirling-PDF Monolith
-      SYSTEM_MAXFILESIZE: "100"
-      METRICS_ENABLED: "true"
-      SYSTEM_GOOGLEVISIBILITY: "true"
-      SHOW_SURVEY: "true"
-
-volumes:
-  stirling-data:
-  stirling-config:
-  stirling-logs:
--- a/docker/frontend/Dockerfile
+++ b/docker/frontend/Dockerfile
@@ -32,7 +32,7 @@ RUN chmod +x /entrypoint.sh
 EXPOSE 80

 # Environment variables for flexibility
-ENV BACKEND_URL=http://backend:8080
+ENV VITE_API_BASE_URL=http://backend:8080

 # Use custom entrypoint
 ENTRYPOINT ["/entrypoint.sh"]
--- a/docker/frontend/entrypoint.sh
+++ b/docker/frontend/entrypoint.sh
@@ -1,10 +1,10 @@
 #!/bin/sh

 # Set default backend URL if not provided
-BACKEND_URL=${BACKEND_URL:-"http://backend:8080"}
+VITE_API_BASE_URL=${VITE_API_BASE_URL:-"http://backend:8080"}

 # Replace the placeholder in nginx.conf with the actual backend URL
-sed -i "s|\${BACKEND_URL}|${BACKEND_URL}|g" /etc/nginx/nginx.conf
+sed -i "s|\${VITE_API_BASE_URL}|${VITE_API_BASE_URL}|g" /etc/nginx/nginx.conf

 # Start nginx
 exec nginx -g "daemon off;"
--- a/docker/frontend/nginx.conf
+++ b/docker/frontend/nginx.conf
@@ -28,7 +28,7 @@ http {

        # Proxy API calls to backend
        location /api/ {
-            proxy_pass ${BACKEND_URL}/api/;
+            proxy_pass ${VITE_API_BASE_URL}/api/;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
--- a/docker/monolith/Dockerfile
+++ b/docker/monolith/Dockerfile
@@ -1,153 +0,0 @@
-# Monolith Dockerfile - Frontend + Backend in same container
-# Build the application
-FROM gradle:8.14-jdk21 AS build
-
-COPY build.gradle .
-COPY settings.gradle .
-COPY gradlew .
-COPY gradle gradle/
-COPY app/core/build.gradle core/.
-COPY app/common/build.gradle common/.
-COPY app/proprietary/build.gradle proprietary/.
-RUN ./gradlew build -x spotlessApply -x spotlessCheck -x test -x sonarqube || return 0
-
-# Set the working directory
-WORKDIR /app
-
-# Copy the entire project to the working directory
-COPY . .
-
-# Build the application with DISABLE_ADDITIONAL_FEATURES=true
-RUN DISABLE_ADDITIONAL_FEATURES=true \
-    STIRLING_PDF_DESKTOP_UI=false \
-    ./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube
-
-# Build frontend
-FROM node:20-alpine AS frontend-build
-
-WORKDIR /app/frontend
-
-# Copy frontend package files
-COPY frontend/package*.json ./
-
-# Install frontend dependencies
-RUN npm ci
-
-# Copy frontend source
-COPY frontend/ ./
-
-# Build frontend
-RUN npm run build
-
-# Main stage - Backend with frontend files
-FROM alpine:3.22.0@sha256:8a1f59ffb675680d47db6337b49d22281a139e9d709335b492be023728e11715
-
-# Copy necessary files
-COPY scripts /scripts
-COPY pipeline /pipeline
-COPY app/core/src/main/resources/static/fonts/*.ttf /usr/share/fonts/opentype/noto/
-# first /app directory is for the build stage, second is for the final image
-COPY --from=build /app/app/core/build/libs/*.jar app.jar
-
-# Copy built frontend files
-COPY --from=frontend-build /app/frontend/dist /usr/share/nginx/html
-
-ARG VERSION_TAG
-
-LABEL org.opencontainers.image.title="Stirling-PDF Monolith"
-LABEL org.opencontainers.image.description="Single container with both frontend and backend for Stirling-PDF"
-LABEL org.opencontainers.image.source="https://github.com/Stirling-Tools/Stirling-PDF"
-LABEL org.opencontainers.image.licenses="MIT"
-LABEL org.opencontainers.image.vendor="Stirling-Tools"
-LABEL org.opencontainers.image.url="https://www.stirlingpdf.com"
-LABEL org.opencontainers.image.documentation="https://docs.stirlingpdf.com"
-LABEL maintainer="Stirling-Tools"
-LABEL org.opencontainers.image.authors="Stirling-Tools"
-LABEL org.opencontainers.image.version="${VERSION_TAG}"
-LABEL org.opencontainers.image.keywords="PDF, manipulation, monolith, single-container"
-
-# Set Environment Variables
-ENV DISABLE_ADDITIONAL_FEATURES=true \
-    VERSION_TAG=$VERSION_TAG \
-    JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \
-    JAVA_CUSTOM_OPTS="" \
-    HOME=/home/stirlingpdfuser \
-    PUID=1000 \
-    PGID=1000 \
-    UMASK=022 \
-    PYTHONPATH=/usr/lib/libreoffice/program:/opt/venv/lib/python3.12/site-packages \
-    UNO_PATH=/usr/lib/libreoffice/program \
-    URE_BOOTSTRAP=file:///usr/lib/libreoffice/program/fundamentalrc \
-    PATH=$PATH:/opt/venv/bin \
-    STIRLING_TEMPFILES_DIRECTORY=/tmp/stirling-pdf \
-    TMPDIR=/tmp/stirling-pdf \
-    TEMP=/tmp/stirling-pdf \
-    TMP=/tmp/stirling-pdf
-
-# Install nginx and all dependencies
-RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \
-    echo "@community https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \
-    echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \
-    apk upgrade --no-cache -a && \
-    apk add --no-cache \
-    ca-certificates \
-    tzdata \
-    tini \
-    bash \
-    curl \
-    shadow \
-    su-exec \
-    openssl \
-    openssl-dev \
-    openjdk21-jre \
-    nginx \
-    # Doc conversion
-    gcompat \
-    libc6-compat \
-    libreoffice \
-    # pdftohtml
-    poppler-utils \
-    # OCR MY PDF (unpaper for descew and other advanced features)
-    unpaper \
-    tesseract-ocr-data-eng \
-    tesseract-ocr-data-chi_sim \
-	tesseract-ocr-data-deu \
-	tesseract-ocr-data-fra \
-	tesseract-ocr-data-por \
-    ocrmypdf \
-    # CV
-    py3-opencv \
-    python3 \
-    py3-pip \
-    py3-pillow@testing \
-    py3-pdf2image@testing && \
-    python3 -m venv /opt/venv && \
-    /opt/venv/bin/pip install --upgrade pip setuptools && \
-    /opt/venv/bin/pip install --no-cache-dir --upgrade unoserver weasyprint && \
-    ln -s /usr/lib/libreoffice/program/uno.py /opt/venv/lib/python3.12/site-packages/ && \
-    ln -s /usr/lib/libreoffice/program/unohelper.py /opt/venv/lib/python3.12/site-packages/ && \
-    ln -s /usr/lib/libreoffice/program /opt/venv/lib/python3.12/site-packages/LibreOffice && \
-    mv /usr/share/tessdata /usr/share/tessdata-original && \
-    mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf && \
-    fc-cache -f -v && \
-    chmod +x /scripts/* && \
-    chmod +x /scripts/init.sh && \
-    # User permissions
-    addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \
-    chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /usr/share/fonts/opentype/noto /configs /customFiles /pipeline /tmp/stirling-pdf && \
-    chown stirlingpdfuser:stirlingpdfgroup /app.jar && \
-    chown -R stirlingpdfuser:stirlingpdfgroup /usr/share/nginx/html
-
-# Copy nginx configuration for monolith
-COPY docker/monolith/nginx-monolith.conf /etc/nginx/nginx.conf
-
-# Copy startup script
-COPY docker/monolith/start-monolith.sh /start-monolith.sh
-RUN chmod +x /start-monolith.sh
-
-# Expose both ports
-EXPOSE 80 8080
-
-# Set user and run command
-ENTRYPOINT ["tini", "--"]
-CMD ["/start-monolith.sh"]
--- a/docker/monolith/nginx-monolith.conf
+++ b/docker/monolith/nginx-monolith.conf
@@ -1,49 +0,0 @@
-events {
-    worker_connections 1024;
-}
-
-http {
-    include /etc/nginx/mime.types;
-    default_type application/octet-stream;
-
-    # Gzip compression
-    gzip on;
-    gzip_vary on;
-    gzip_min_length 1024;
-    gzip_types text/plain text/css text/xml text/javascript application/javascript application/xml+rss application/json;
-
-    server {
-        listen 80;
-        server_name _;
-        root /usr/share/nginx/html;
-        index index.html index.htm;
-
-        # Handle client-side routing - support subpaths
-        location / {
-            try_files $uri $uri/ /index.html;
-        }
-
-        # Proxy API calls to backend running on same container
-        location /api/ {
-            proxy_pass http://localhost:8080/api/;
-            proxy_set_header Host $host;
-            proxy_set_header X-Real-IP $remote_addr;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-            proxy_set_header X-Forwarded-Proto $scheme;
-            proxy_set_header X-Forwarded-Host $host;
-            proxy_set_header X-Forwarded-Port $server_port;
-        }
-
-        # Cache static assets
-        location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg|woff|woff2|ttf|eot)$ {
-            expires 1y;
-            add_header Cache-Control "public, immutable";
-        }
-
-        # Security headers
-        add_header X-Frame-Options "SAMEORIGIN" always;
-        add_header X-Content-Type-Options "nosniff" always;
-        add_header X-XSS-Protection "1; mode=block" always;
-        add_header Referrer-Policy "strict-origin-when-cross-origin" always;
-    }
-}
--- a/docker/monolith/start-monolith.sh
+++ b/docker/monolith/start-monolith.sh
@@ -1,20 +0,0 @@
-#!/bin/bash
-
-# Start the Java backend in the background
-echo "Starting Java backend..."
-su-exec stirlingpdfuser:stirlingpdfgroup bash -c "
-    cd /home/stirlingpdfuser && \
-    java -Dfile.encoding=UTF-8 -Djava.io.tmpdir=/tmp/stirling-pdf -jar /app.jar &
-    /opt/venv/bin/unoserver --port 2003 --interface 127.0.0.1 &
-"
-
-# Wait for backend to start
-echo "Waiting for backend to start..."
-until curl -f http://localhost:8080/api/v1/info/status >/dev/null 2>&1; do
-    sleep 2
-done
-
-echo "Backend started, starting nginx..."
-
-# Start nginx in the foreground
-nginx -g "daemon off;"