ci-workflow.yml

name: CI

env:
  RUNTIME_CHECKS: 1
  WERROR: 1

on:
  pull_request:
    branches:
      - master
  push:
    branches:
      - master
  workflow_dispatch:

# Only allow one run in this group to run at a time, and cancel any runs in progress in this group.
# We use the workflow name and then add the pull request number, or (if it's a push to master), we use the name of the branch.
# See github's docs[1] and a relevant stack overflow answer[2]
#   [1]: https://docs.github.com/en/actions/using-jobs/using-concurrency
#   [2]: https://stackoverflow.com/questions/66335225/how-to-cancel-previous-runs-in-the-pr-when-you-push-new-commitsupdate-the-curre
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  gcc-build-test:
    name: gcc build & test
    needs: [clang-format, sanity-checks, python-lint-check]
    runs-on: kuzu-self-hosted-testing
    env:
      NUM_THREADS: 32
      TEST_JOBS: 16
      CLANGD_DIAGNOSTIC_JOBS: 32
      CLANGD_DIAGNOSTIC_INSTANCES: 6
      GEN: ninja
      CC: gcc
      CXX: g++
      UW_S3_ACCESS_KEY_ID: ${{ secrets.UW_S3_ACCESS_KEY_ID }}
      UW_S3_SECRET_ACCESS_KEY: ${{ secrets.UW_S3_SECRET_ACCESS_KEY }}
      AWS_S3_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_S3_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      RUN_ID: "$(hostname)-$(date +%s)"

    steps:
      - uses: actions/checkout@v3

      - name: Ensure Python dependencies
        run: |
          pip install torch~=2.0.0 --extra-index-url https://download.pytorch.org/whl/cpu
          pip install --user -r tools/python_api/requirements_dev.txt -f https://data.pyg.org/whl/torch-2.0.0+cpu.html

      - name: Ensure Node.js dependencies
        run: npm install --include=dev
        working-directory: tools/nodejs_api

      - name: Build
        run: make all

      - name: Test with coverage
        run: make lcov

      - name: Python test
        run: make pytest

      - name: Node.js test
        run: make nodejstest

      - name: Java test
        run: make javatest

      - name: Generate coverage report
        run: |
          lcov --config-file .lcovrc -c -d ./ --no-external -o cover.info &&\
          lcov --remove cover.info $(< .github/workflows/lcov_exclude) -o cover.info

      - name: Upload coverage report
        uses: codecov/codecov-action@v3
        with:
          file: cover.info
          functionalities: "search"

  gcc-build-test-x86:
    name: gcc build & test 32-bit
    needs: [clang-format, sanity-checks]
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Start Docker container
        run: |
          docker run -d --name kuzu-x86 \
                     -v $PWD:/kuzu -w /kuzu \
                     -e NUM_THREADS=2 -e GEN=ninja -e CC=gcc -e CXX=g++ \
                     i386/debian:stable tail -f /dev/null

      - name: Install dependencies
        run: |
          docker exec kuzu-x86 apt-get update
          docker exec kuzu-x86 apt-get install -y git python3 ninja-build build-essential cmake libssl-dev

      - name: Build & Test
        run: |
          docker exec kuzu-x86 make test

      - name: Stop Docker container
        run: docker stop kuzu-x86

  rust-build-test:
    name: rust build & test
    needs: [rustfmt-check]
    runs-on: kuzu-self-hosted-testing
    env:
      CARGO_BUILD_JOBS: 32
      CC: gcc
      CXX: g++
    steps:
      - uses: actions/checkout@v3

      - name: Rust test
        working-directory: tools/rust_api
        run: |
          cargo test --locked --features arrow -- --test-threads=1

      - name: Rust example
        working-directory: examples/rust
        run: cargo build --locked --features arrow

  gcc-build-test-with-asan:
    name: gcc build & test with asan
    needs: [gcc-build-test]
    runs-on: kuzu-self-hosted-testing
    env:
      NUM_THREADS: 32
      TEST_JOBS: 16
      GEN: ninja
      CC: gcc
      CXX: g++
    steps:
      - uses: actions/checkout@v3

      - name: Ensure Python dependencies
        run: |
          pip install torch~=2.0.0 --extra-index-url https://download.pytorch.org/whl/cpu
          pip install --user -r tools/python_api/requirements_dev.txt -f https://data.pyg.org/whl/torch-2.0.0+cpu.html

      - name: Ensure Node.js dependencies
        run: npm install --include=dev
        working-directory: tools/nodejs_api

      - name: Test with ASAN
        run: make test ASAN=1
        env:
          ASAN_OPTIONS: "detect_leaks=1"

  clang-build-test:
    name: clang build and test
    needs: [clang-format, sanity-checks, python-lint-check]
    runs-on: kuzu-self-hosted-testing
    env:
      NUM_THREADS: 32
      TEST_JOBS: 16
      CC: clang
      CXX: clang++
      UW_S3_ACCESS_KEY_ID: ${{ secrets.UW_S3_ACCESS_KEY_ID }}
      UW_S3_SECRET_ACCESS_KEY: ${{ secrets.UW_S3_SECRET_ACCESS_KEY }}
      AWS_S3_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_S3_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      RUN_ID: "$(hostname)-$(date +%s)"
    steps:
      - uses: actions/checkout@v3

      - name: Ensure Python dependencies
        run: |
          pip install torch~=2.0.0 --extra-index-url https://download.pytorch.org/whl/cpu
          pip install --user -r tools/python_api/requirements_dev.txt -f https://data.pyg.org/whl/torch-2.0.0+cpu.html

      - name: Ensure Node.js dependencies
        run: npm install --include=dev
        working-directory: tools/nodejs_api

      - name: Build
        run: make all

      - name: Test
        run: make test

      - name: Python test
        run: make pytest

      - name: Node.js test
        run: make nodejstest

      - name: Java test
        run: make javatest

  msvc-build-test:
    name: msvc build & test
    needs: [clang-format, sanity-checks, python-lint-check]
    runs-on: self-hosted-windows
    env:
      # Shorten build path as much as possible
      CARGO_TARGET_DIR: ${{ github.workspace }}/rs
      CARGO_BUILD_JOBS: 18
      NUM_THREADS: 18
      TEST_JOBS: 9
      WERROR: 0
      UW_S3_ACCESS_KEY_ID: ${{ secrets.UW_S3_ACCESS_KEY_ID }}
      UW_S3_SECRET_ACCESS_KEY: ${{ secrets.UW_S3_SECRET_ACCESS_KEY }}
      AWS_S3_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_S3_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      PG_HOST: ${{ secrets.PG_HOST }}
      RUN_ID: "$(hostname)-$([Math]::Floor((Get-Date).TimeOfDay.TotalSeconds))"
    steps:
      - uses: actions/checkout@v3

      - name: Ensure Python dependencies
        run: |
          pip install torch~=2.0.0 --extra-index-url https://download.pytorch.org/whl/cpu
          pip install --user -r tools/python_api/requirements_dev.txt -f https://data.pyg.org/whl/torch-2.0.0+cpu.html

      - name: Ensure Node.js dependencies
        run: npm install --include=dev
        working-directory: tools/nodejs_api

      - name: Build
        shell: cmd
        run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat"
          make all

      - name: Test
        shell: cmd
        run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat"
          make test

      - name: Python test
        shell: cmd
        run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat"
          make pytest

      - name: Node.js test
        shell: cmd
        run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat"
          make nodejstest

      - name: Rust test
        shell: cmd
        working-directory: tools/rust_api
        run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat"
          set KUZU_TESTING=1
          set CFLAGS=/MDd
          set CXXFLAGS=/MDd /std:c++20
          cargo test --locked -- --test-threads=1

      - name: Java test
        shell: cmd
        run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat"
          make javatest

  tidy-and-diagnostics:
    name: clang tidy & clangd diagnostics check
    needs: [clang-format, sanity-checks]
    runs-on: kuzu-self-hosted-testing
    env:
      NUM_THREADS: 32

    steps:
      - uses: actions/checkout@v3

      # For `napi.h` header.
      - name: Ensure Node.js dependencies
        run: npm install --include=dev
        working-directory: tools/nodejs_api

      - name: Check for clangd diagnostics
        run: make clangd-diagnostics

      - name: Run clang-tidy
        run: make tidy

      - name: Run clang-tidy analyzer
        run: make tidy-analyzer

  sanity-checks:
    name: sanity checks
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v3

      - name: Check headers for include guards
        run: ./scripts/check-include-guards.sh src/include

      - name: Checks files for std::assert
        run: ./scripts/check-no-std-assert.sh src

      - name: Ensure generated grammar files are up to date
        run: cmp src/antlr4/Cypher.g4 scripts/antlr4/Cypher.g4.copy

  clang-format:
    name: clang format
    runs-on: ubuntu-22.04
    steps:
      - name: Install clang-format
        run: |
          sudo apt-get install -y lsb-release wget software-properties-common gnupg
          wget https://apt.llvm.org/llvm.sh
          chmod +x llvm.sh
          yes | sudo ./llvm.sh 18 all

      - uses: actions/checkout@v3
        with:
          repository: ${{ github.event.pull_request.head.repo.full_name }}
          ref: ${{ github.event.pull_request.head.ref }}

      - name: Check and fix source format
        run: python3 scripts/run-clang-format.py --in-place --clang-format-executable /usr/bin/clang-format-18 -r src/

      - name: Check and fix test format
        run: python3 scripts/run-clang-format.py --in-place --clang-format-executable /usr/bin/clang-format-18 -r test/

      - name: Check and fix extension format
        run: python3 scripts/run-clang-format.py --in-place --clang-format-executable /usr/bin/clang-format-18 -r extension/

      - name: Fail if any chang is made (master branch)
        if: github.ref == 'refs/heads/master'
        run: git diff --exit-code

      - name: Commit changes (non-master branch)
        uses: EndBug/add-and-commit@v9
        if: github.ref != 'refs/heads/master'
        with:
          author_name: "CI Bot"
          message: "Run clang-format"

  python-lint-check:
    name: python lint check
    runs-on: macos-14
    steps:
      - uses: actions/checkout@v3

      - name: Setup Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.11"

      - name: Run Python lint
        working-directory: tools/python_api
        run: |
          make requirements
          ./.venv/bin/ruff check src_py test --verbose

  rustfmt-check:
    name: rustfmt check
    runs-on: ubuntu-22.04
    steps:
      - name: Update Rust
        run: rustup update

      - uses: actions/checkout@v3

      - name: Check Rust API format
        working-directory: tools/rust_api
        run: cargo fmt --check

  benchmark:
    name: benchmark
    needs: [gcc-build-test, clang-build-test]
    uses: ./.github/workflows/benchmark-workflow.yml

  macos-clang-tidy:
    name: macos clang tidy & clangd diagnostics check
    needs: [clang-format, sanity-checks]
    runs-on: self-hosted-mac-x64
    env:
      NUM_THREADS: 32
      GEN: ninja

    steps:
      - uses: actions/checkout@v3

      # For `napi.h` header.
      - name: Ensure Node.js dependencies
        run: npm install --include=dev
        working-directory: tools/nodejs_api

      - name: Check for clangd diagnostics
        run: make clangd-diagnostics

      - name: Run clang-tidy
        run: make tidy

      - name: Run clang-tidy analyzer
        run: make tidy-analyzer

  macos-build-test:
    name: apple clang build & test
    needs: [clang-format, sanity-checks, rustfmt-check, python-lint-check]
    runs-on: self-hosted-mac-x64
    env:
      NUM_THREADS: 32
      TEST_JOBS: 16
      GEN: ninja
      UW_S3_ACCESS_KEY_ID: ${{ secrets.UW_S3_ACCESS_KEY_ID }}
      UW_S3_SECRET_ACCESS_KEY: ${{ secrets.UW_S3_SECRET_ACCESS_KEY }}
      AWS_S3_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_S3_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      PG_HOST: ${{ secrets.PG_HOST }}
      RUN_ID: "$(hostname)-$(date +%s)"
    steps:
      - uses: actions/checkout@v3

      - name: Ensure Python dependencies
        run: |
          pip3 install torch~=2.0.0 --extra-index-url https://download.pytorch.org/whl/cpu
          pip3 install --user -r tools/python_api/requirements_dev.txt -f https://data.pyg.org/whl/torch-2.0.0+cpu.html

      - name: Ensure Node.js dependencies
        run: npm install --include=dev
        working-directory: tools/nodejs_api

      - name: Build
        run: make all

      - name: Test
        run: |
          ulimit -n 10240
          make test

      - name: Python test
        run: |
          ulimit -n 10240
          make pytest

      - name: C and C++ Examples
        run: |
          ulimit -n 10240
          make example

      - name: Node.js test
        run: |
          ulimit -n 10240
          make nodejstest

      - name: Java test
        run: |
          ulimit -n 10240
          make javatest

      - name: Rust test
        run: |
          ulimit -n 10240
          source /Users/runner/.cargo/env
          make rusttest

      - name: Rust example
        working-directory: examples/rust
        run: |
          ulimit -n 10240
          source /Users/runner/.cargo/env
          cargo build --locked --features arrow

  shell-test:
    name: shell test
    runs-on: ubuntu-latest
    needs: [clang-format, sanity-checks]
    env:
      WERROR: 0
    steps:
      - uses: actions/checkout@v3

      - name: Build
        run: make release NUM_THREADS=$(nproc)

      - name: Test
        working-directory: tools/shell/test
        run: |
          pip3 install pytest pexpect
          python3 -m pytest -v .

  linux-extension-test:
    name: linux extension test
    needs: [gcc-build-test, clang-build-test]
    runs-on: kuzu-self-hosted-testing
    env:
      NUM_THREADS: 32
      TEST_JOBS: 16
      CLANGD_DIAGNOSTIC_JOBS: 32
      CLANGD_DIAGNOSTIC_INSTANCES: 6
      GEN: ninja
      CC: gcc
      CXX: g++
      UW_S3_ACCESS_KEY_ID: ${{ secrets.UW_S3_ACCESS_KEY_ID }}
      UW_S3_SECRET_ACCESS_KEY: ${{ secrets.UW_S3_SECRET_ACCESS_KEY }}
      AWS_S3_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_S3_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      RUN_ID: "$(hostname)-$(date +%s)"

    steps:
      - uses: actions/checkout@v3

      - name: Update PostgreSQL host
        working-directory: extension/postgres_scanner/test/test_files
        env:
          FNAME: postgres_scanner.test
          FIND: "localhost"
        run: |
          node -e 'fs=require("fs");fs.readFile(process.env.FNAME,"utf8",(err,data)=>{if(err!=null)throw err;fs.writeFile(process.env.FNAME,data.replaceAll(process.env.FIND,process.env.PG_HOST),"utf8",e=>{if(e!=null)throw e;});});'
          cat postgres_scanner.test

      - name: Extension test
        run: |
          cd scripts/ && python3 http-server.py &
          make extension-test && make clean

  macos-extension-test:
    name: macos extension test
    needs: [macos-build-test]
    runs-on: self-hosted-mac-x64
    env:
      NUM_THREADS: 32
      TEST_JOBS: 16
      GEN: ninja
      UW_S3_ACCESS_KEY_ID: ${{ secrets.UW_S3_ACCESS_KEY_ID }}
      UW_S3_SECRET_ACCESS_KEY: ${{ secrets.UW_S3_SECRET_ACCESS_KEY }}
      AWS_S3_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_S3_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      PG_HOST: ${{ secrets.PG_HOST }}
      RUN_ID: "$(hostname)-$(date +%s)"
    steps:
      - uses: actions/checkout@v3

      - name: Update PostgreSQL host
        working-directory: extension/postgres_scanner/test/test_files
        env:
          FNAME: postgres_scanner.test
          FIND: "localhost"
        run: |
          node -e 'fs=require("fs");fs.readFile(process.env.FNAME,"utf8",(err,data)=>{if(err!=null)throw err;fs.writeFile(process.env.FNAME,data.replaceAll(process.env.FIND,process.env.PG_HOST),"utf8",e=>{if(e!=null)throw e;});});'
          cat postgres_scanner.test

      - name: Extension test
        run: |
          cd scripts/ && python3 http-server.py &
          make extension-test && make clean

  windows-extension-test:
    name: windows extension test
    needs: [msvc-build-test]
    runs-on: self-hosted-windows
    env:
      # Shorten build path as much as possible
      CARGO_TARGET_DIR: ${{ github.workspace }}/rs
      CARGO_BUILD_JOBS: 18
      NUM_THREADS: 18
      TEST_JOBS: 9
      WERROR: 0
      UW_S3_ACCESS_KEY_ID: ${{ secrets.UW_S3_ACCESS_KEY_ID }}
      UW_S3_SECRET_ACCESS_KEY: ${{ secrets.UW_S3_SECRET_ACCESS_KEY }}
      AWS_S3_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_S3_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_S3_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }}
      PG_HOST: ${{ secrets.PG_HOST }}
      RUN_ID: "$(hostname)-$([Math]::Floor((Get-Date).TimeOfDay.TotalSeconds))"
    steps:
      - uses: actions/checkout@v3

      - name: Update PostgreSQL host
        working-directory: extension/postgres_scanner/test/test_files
        env:
          FNAME: postgres_scanner.test
          FIND: "localhost"
        run: |
          node -e 'fs=require("fs");fs.readFile(process.env.FNAME,"utf8",(err,data)=>{if(err!=null)throw err;fs.writeFile(process.env.FNAME,data.replaceAll(process.env.FIND,process.env.PG_HOST),"utf8",e=>{if(e!=null)throw e;});});'
          cat postgres_scanner.test

      - name: Extension test
        shell: cmd
        run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat"
          cd scripts/ && start /b python http-server.py && cd ..
          make extension-test && make clean