LocalAI/.github/workflows/test.yml

---
name: 'tests'

on:
  pull_request:
    paths:
      - 'core/**'
      - 'pkg/**'
      - 'cmd/**'
      - 'internal/**'
      - 'backend/go/**'
      - 'backend/*.proto'
      - 'backend/*/*.proto'
      - 'addons/**'
      - 'tests/**'
      - 'configuration/**'
      - 'swagger/**'
      - 'prompt-templates/**'
      - 'backend/cpp/**'
      - 'gallery/**'
      - 'docs/content/features/addons.md'
      - 'docs/content/features/tables.md'
      - 'docs/content/features/image-generation.md'
      - 'docs/content/features/diagnostics.md'
      - 'docs/content/reference/cli-reference.md'
      - 'docs/content/getting-started/troubleshooting.md'
      - 'go.mod'
      - 'go.sum'
      - 'Makefile'
      - 'scripts/**'
      - '.github/actions/**'
      - '.github/workflows/test.yml'
      - 'backend/index.yaml'
      - 'coverage-baseline.txt'
  push:
    branches: [master]
    tags: ['*']
    paths:
      - 'core/**'
      - 'pkg/**'
      - 'cmd/**'
      - 'internal/**'
      - 'backend/go/**'
      - 'backend/*.proto'
      - 'backend/*/*.proto'
      - 'addons/**'
      - 'tests/**'
      - 'configuration/**'
      - 'swagger/**'
      - 'prompt-templates/**'
      - 'backend/cpp/**'
      - 'gallery/**'
      - 'docs/content/features/addons.md'
      - 'docs/content/features/tables.md'
      - 'docs/content/features/image-generation.md'
      - 'docs/content/features/diagnostics.md'
      - 'docs/content/reference/cli-reference.md'
      - 'docs/content/getting-started/troubleshooting.md'
      - 'go.mod'
      - 'go.sum'
      - 'Makefile'
      - 'scripts/**'
      - '.github/actions/**'
      - '.github/workflows/test.yml'
      - 'backend/index.yaml'
      - 'coverage-baseline.txt'
  workflow_dispatch:

concurrency:
  group: ci-tests-${{ github.event.pull_request.number || github.sha }}-${{ github.repository }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  tests-linux:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        go-version: ['1.26.x']
    # The PostgreSQL stores of the chats, agents, connectors, notifications,
    # workspace and triggers skip without a database, so a regression that only
    # shows on a cluster passed unseen. The coverage run below sees the URL,
    # and a separate step fails when any of those tests skipped. The tests
    # wipe their own tables, so the database is throwaway.
    services:
      postgres:
        image: postgres:16-alpine
        env:
          POSTGRES_USER: localai
          POSTGRES_PASSWORD: localai
          POSTGRES_DB: localai_test
        ports:
          - 5432:5432
        options: >-
          --health-cmd "pg_isready -U localai -d localai_test"
          --health-interval 5s
          --health-timeout 5s
          --health-retries 10
    env:
      LOCALAI_TEST_POSTGRES_URL: postgres://localai:localai@localhost:5432/localai_test?sslmode=disable
    steps:
      - name: Clone
        uses: actions/checkout@v7
        with:
          submodules: true
      # No free-disk-space step here on purpose. That action exists to make room
      # for docker buildx layers, and this job runs no buildx step. It was also
      # sized for a `make test` that downloaded multi-GB GGUF/whisper fixtures
      # and built llama-cpp/whisper/stablediffusion-ggml; after the test-suite
      # reorg it does neither (see the Makefile test target). It cost ~3min of
      # every run, and its tool-cache:true wipe also forced setup-go and
      # setup-node to re-download toolchains that ship preinstalled.
      - name: Setup Go ${{ matrix.go-version }}
        uses: actions/setup-go@v5
        with:
          go-version: ${{ matrix.go-version }}
          cache: false
      # You can test your matrix by printing the current Go version
      - name: Display Go version
        run: go version
      - name: Proto Dependencies
        run: |
          # Install protoc
          curl -L -s https://github.com/protocolbuffers/protobuf/releases/download/v26.1/protoc-26.1-linux-x86_64.zip -o protoc.zip && \
          unzip -j -d /usr/local/bin protoc.zip bin/protoc && \
          rm protoc.zip
          go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.34.2
          go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@1958fcbe2ca8bd93af633f11e97d44e567e945af
          PATH="$PATH:$HOME/go/bin" make protogen-go
      - name: Dependencies
        run: |
          sudo apt-get update
          sudo apt-get install curl ffmpeg libopus-dev poppler-utils
      - name: Setup Node.js
        uses: actions/setup-node@v7
        with:
          node-version: '22'
      - name: Build React UI
        run: make react-ui
      # Runs the core suite with coverage and fails if total coverage dropped
      # below the committed baseline (coverage-baseline.txt). The gate is
      # strict — any decrease fails. Raise the baseline with
      # `make test-coverage-baseline` and commit it when coverage rises.
      - name: Test (with coverage gate)
        run: |
          PATH="$PATH:/root/go/bin" make --jobs 5 --output-sync=target test-coverage-check
      # The coverage run above set the URL, but a skipped test is a passed test
      # to it. This runs the PostgreSQL stores alone and fails on any skip.
      - name: Test the PostgreSQL stores (no skips)
        run: PATH="$PATH:$HOME/go/bin" make test-postgres
      # tests/integration is outside the coverage roots because its store specs
      # need a live backend. test-stores builds and installs local-store before
      # running the complete suite, so new local-store specs are collected
      # automatically without adding another workflow entry.
      - name: Test local-store integration
        run: PATH="$PATH:$HOME/go/bin" make test-stores
      # Runs the real local-ai binary (MCP connectors and apps, collections,
      # process flags, route permissions). The suite builds the binary, the
      # mock backend and an MCP fixture itself and needs no Docker.
      - name: Test platform e2e
        run: PATH="$PATH:$HOME/go/bin" make test-e2e-platform
      - name: Upload coverage report
        if: ${{ always() }}
        uses: actions/upload-artifact@v4
        with:
          name: coverage-linux
          path: |
            coverage/coverage.out
            coverage/coverage.html
          if-no-files-found: ignore
      # tmate keeps the runner busy until the 6 hour job limit, so a single
      # failure costs a whole runner slot. Only open a session when someone
      # asked for one by labelling the pull request `ci-debug`, and cap the
      # session so a forgotten label cannot idle a runner either.
      - name: Setup tmate session if tests fail
        if: ${{ failure() && contains(github.event.pull_request.labels.*.name, 'ci-debug') }}
        timeout-minutes: 30
        uses: mxschmitt/action-tmate@v3.23
        with:
          detached: true
          connect-timeout-seconds: 180
          limit-access-to-actor: true

  tests-apple:
    runs-on: macos-latest
    strategy:
      matrix:
        go-version: ['1.26.x']
    steps:
      - name: Clone
        uses: actions/checkout@v7
        with:
          submodules: true
      - name: Setup Go ${{ matrix.go-version }}
        uses: actions/setup-go@v5
        with:
          go-version: ${{ matrix.go-version }}
          cache: false
      # You can test your matrix by printing the current Go version
      - name: Display Go version
        run: go version
      - name: Dependencies
        run: |
          brew install protobuf grpc make protoc-gen-go protoc-gen-go-grpc libomp llvm opus ffmpeg poppler
          pip install --user --no-cache-dir grpcio-tools grpcio
      - name: Setup Node.js
        uses: actions/setup-node@v7
        with:
          node-version: '22'
      - name: Build React UI
        run: make react-ui
      - name: Test
        run: |
          export C_INCLUDE_PATH=/usr/local/include
          export CPLUS_INCLUDE_PATH=/usr/local/include
          export CC=/opt/homebrew/opt/llvm/bin/clang
          # Used to run the newer GNUMake version from brew that supports --output-sync
          export PATH="/opt/homebrew/opt/make/libexec/gnubin:$PATH"
          PATH="$PATH:$HOME/go/bin" make protogen-go
          PATH="$PATH:$HOME/go/bin" BUILD_TYPE="GITHUB_CI_HAS_BROKEN_METAL" CMAKE_ARGS="-DGGML_F16C=OFF -DGGML_AVX512=OFF -DGGML_AVX2=OFF -DGGML_FMA=OFF" make --jobs 4 --output-sync=target test
      # tmate keeps the runner busy until the 6 hour job limit, so a single
      # failure costs a whole runner slot. Only open a session when someone
      # asked for one by labelling the pull request `ci-debug`, and cap the
      # session so a forgotten label cannot idle a runner either.
      - name: Setup tmate session if tests fail
        if: ${{ failure() && contains(github.event.pull_request.labels.*.name, 'ci-debug') }}
        timeout-minutes: 30
        uses: mxschmitt/action-tmate@v3.23
        with:
          detached: true
          connect-timeout-seconds: 180
          limit-access-to-actor: true

  # Fast standalone unit tests for the backends' pure C++ helpers - currently the
  # llama-cpp message reconstruction (backend/cpp/llama-cpp/message_content.h),
  # which guards the OpenAI chat content normalization (mudler/LocalAI#10524,
  # #7324, #7528). The runner discovers every *_test.cpp under backend/cpp/, so
  # new pure-C++ unit tests are picked up with no CI changes. These need only the
  # C++ stdlib + nlohmann/json, so they run on every PR without the full
  # llama.cpp + gRPC backend build. (The same suite is also wired as an opt-in
  # CMake/ctest target, -DLLAMA_GRPC_BUILD_TESTS=ON, for in-backend-build runs.)
  tests-backend-cpp:
    runs-on: ubuntu-latest
    steps:
      - name: Clone
        uses: actions/checkout@v7
      - name: Run backend C++ unit tests
        run: make test-backend-cpp