chore: Use running openRAG for tests

Author: paultranvan

.github/workflows/unit_tests.yml

@@ -13,33 +13,122 @@ jobs:
       matrix:
         python-version: ["3.12"]
 
+    env:
+      APP_PORT: 8080
+      RAG_BASE_URL: http://localhost:8080
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - name: env file
+        run: |
+          cp tests/.env-tests .env
+
+      # Move storage to /mnt to avoid disk space issues
+      - name: Free up space and move Docker storage to /mnt
+        run: |
+          echo "Stopping Docker..."
+          sudo systemctl stop docker
+
+          echo "Creating new Docker root at /mnt/docker..."
+          sudo mkdir -p /mnt/docker
+          sudo rsync -aqxP /var/lib/docker/ /mnt/docker
+
+          echo "Updating Docker daemon config..."
+          echo '{"data-root": "/mnt/docker"}' | sudo tee /etc/docker/daemon.json
+
+          cat /etc/docker/daemon.json
+
+          echo "Restarting Docker..."
+          sudo systemctl start docker
+
+          echo "Verifying Docker root directory:"
+          docker info | grep "Docker Root Dir"
+
+      # Setup docker builds with cache
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build openrag image
+        uses: docker/build-push-action@v6
         with:
-          python-version: ${{ matrix.python-version }}
+          context: .
+          file: ./Dockerfile
+          tags: linagoraai/openrag:latest
+          push: false
+          cache-from: type=gha,scope=openrag
+          cache-to: type=gha,mode=max,scope=openrag
 
-      - name: Install uv
+      - name: Build vllm CPU image
+        uses: docker/build-push-action@v6
+        with:
+          context: ./extern/vllm
+          file: ./extern/vllm/Dockerfile.cpu
+          target: vllm-openai
+          tags: openrag-vllm-openai-cpu
+          push: false
+          load: true
+          cache-from: type=gha,scope=vllm-cpu
+          cache-to: type=gha,mode=max,scope=vllm-cpu
+
+      - name: Check vllm image
+        run: docker images | grep vllm || true
+
+      # Start openRAG CPU
+      - name: Start openRAG CPU
         run: |
-          curl -LsSf https://astral.sh/uv/install.sh | sh
-          echo "$HOME/.local/bin" >> $GITHUB_PATH
+          docker compose \
+            -f docker-compose.yaml \
+            -f docker-compose.ci.yaml \
+            --profile cpu up -d \
+            --no-build --pull=never
+          docker compose --profile cpu up -d
+
+      - name: Wait for RAG API
+        run: |
+          echo "Waiting for RAG API on ${RAG_BASE_URL}..."
+          for i in {1..60}; do
+            if curl -fsS "${RAG_BASE_URL}/health_check" > /dev/null 2>&1; then
+              echo "RAG API is up!"
+              exit 0
+            fi
+            sleep 5
+          done
+          docker compose logs
+          exit 1
+
+      # Install uv with cache
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
 
       - name: Cache uv
         uses: actions/cache@v4
         with:
-          path: |
-            ~/.cache/uv
+          path: ~/.cache/uv
           key: uv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/pyproject.toml', '**/uv.lock') }}
           restore-keys: |
             uv-${{ runner.os }}-${{ matrix.python-version }}-
 
-      - name: Install dependencies with uv
+      # Install deps for tests
+      - name: Install with test dependencies
         run: |
-          uv sync
+          uv pip install -e ".[test]"
 
+      # Run actual tests
       - name: Run tests
         run: |
-          uv run pytest
+          uv run pytest -vv tests
+
+
+      # Dump logs on failure
+      - name: Dump logs on failure
+        if: failure()
+        run: docker compose logs
+
+      # Proper shutdown
+      - name: Shutdown openRAG
+        if: always()
+        run: |
+          docker compose down -v
+

docker-compose-ci.yaml

@@ -0,0 +1,4 @@
+services:
+  vllm-cpu:
+    build: null   # Do not build for faster startup
+    image: openrag-vllm-openai-cpu

pyproject.toml

@@ -54,6 +54,14 @@ dev = [
     "pytest>=8.4.1",
     "pytest-asyncio>=1.3.0",
 ]
+
+[project.optional-dependencies]
+test = [
+  "pytest",
+  "httpx",
+  "pytest-timeout"
+]
+
 lint = [
     "ruff>=0.14.1",
 ]

pytest.ini

@@ -1,6 +1,7 @@
 [pytest]
 testpaths =
   openrag
+  tests
 pythonpath = ./openrag
 python_files =
     test_*.py

tests/.env-tests

@@ -0,0 +1,66 @@
+# LLM
+BASE_URL=http://localhost:8001/
+API_KEY=sk-
+MODEL=HuggingFaceTB/SmolLM2-135M-Instruct
+
+# VLM (Visual Language Model) you can set it to the same as LLM if your LLM supports images
+VLM_BASE_URL=http://localhost:8002/
+VLM_API_KEY=sk-
+VLM_MODEL=HuggingFaceTB/SmolVLM-Instruct
+
+## FastAPI App (no need to change it)
+# APP_PORT=8080 # this is the forwarded port
+# API_NUM_WORKERS=1 # Number of uvicorn workers for the FastAPI app
+
+## To enable API HTTP authentication via HTTPBearer
+# AUTH_TOKEN=sk-openrag-1234
+
+# SAVE_UPLOADED_FILES=true # usefull for chainlit source viewing
+
+# Set to true, it will mount chainlit chat ui to the fastapi app (Default: true)
+## WITH_CHAINLIT_UI=true
+
+# RETRIEVER
+CONTEXTUAL_RETRIEVAL=false
+
+# EMBEDDER
+EMBEDDER_MODEL_NAME=ibm-granite/granite-embedding-small-english-r2
+EMBEDDER_BASE_URL=http://vllm:8000/v1
+# EMBEDDER_API_KEY=EMPTY
+
+# RERANKER
+RERANKER_ENABLED=true
+RERANKER_MODEL=Alibaba-NLP/gte-multilingual-reranker-base # or jinaai/jina-reranker-v2-base-multilingual
+
+# Prompts
+PROMPTS_DIR=../prompts/example1
+
+# Loaders
+PDFLoader=MarkerLoader
+XDG_CACHE_HOME=/app/model_weights
+# If using MarkerLoader
+MARKER_MAX_TASKS_PER_CHILD=1
+MARKER_MAX_PROCESSES=1
+MARKER_MIN_PROCESSES=1
+MARKER_POOL_SIZE=1 # Value au increment if you have a cluster of machines
+MARKER_NUM_GPUS=0.01
+
+# Ray
+RAY_POOL_SIZE=1 # Number of serializer actor instances
+RAY_MAX_TASKS_PER_WORKER=2 # Number of tasks per serializer
+RAY_DEDUP_LOGS=0 # turns off ray log deduplication that appear across multiple processes
+RAY_ENABLE_RECORD_ACTOR_TASK_LOGGING=1 # # to enable logs at task level in ray dashboard
+RAY_task_retry_delay_ms=3000
+RAY_ENABLE_UV_RUN_RUNTIME_ENV=0 # critical with the newest version of UV
+RAY_memory_monitor_refresh_ms=0
+
+# Indexer UI 
+## 1. replace X.X.X.X with localhost if launching local or with your server IP
+## 2. APP_PORT with your FastAPI port (8080 by default)
+## 3. Base URL of the Indexer UI (required to prevent CORS issues). Replace INDEXERUI_PORT with its value
+## 4. Base URL of your FastAPI backend. Used by the frondend. Replace APP_PORT with the actual port number of your FastAPI backend
+
+VITE_INCLUDE_CREDENTIALS=false # set true if fastapi authentification is enabled
+INDEXERUI_PORT=8060 # Port to expose the Indexer UI (default is 3042)
+INDEXERUI_URL='http://X.X.X.X:INDEXERUI_PORT'                 
+VITE_API_BASE_URL='http://X.X.X.X:APP_PORT'

tests/conftest.py

@@ -0,0 +1,29 @@
+# tests/conftest.py
+import os
+import time
+import httpx
+import pytest
+
+
+@pytest.fixture(scope="session")
+def base_url():
+    return os.environ.get("RAG_BASE_URL", "http://localhost:8080")
+
+
+@pytest.fixture(scope="session", autouse=True)
+def wait_for_api(base_url):
+    timeout = 60
+    start = time.time()
+
+    while True:
+        try:
+            r = httpx.get(f"{base_url}/health_check", timeout=3)
+            if r.status_code == 200:
+                return
+        except Exception:
+            pass
+
+        if time.time() - start > timeout:
+            raise RuntimeError("API not ready")
+
+        time.sleep(2)

tests/test_partitions.py

@@ -0,0 +1,12 @@
+# tests/test_partition.py
+import httpx
+import uuid
+
+
+def test_create_partition(base_url):
+    client = httpx.Client(timeout=5)
+
+    partition_name = "tets-partition"
+    r = client.post(f"{base_url}/partition/{partition_name}")
+    assert r.status_code is 200
+