ci.yml

#
# Copyright (c) 2022 ZettaScale Technology
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
# which is available at https://www.apache.org/licenses/LICENSE-2.0.
#
# SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
#
# Contributors:
#   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
#
name: CI

on:
  push:
    branches: ["**"]
  pull_request:
    branches: ["**"]
  schedule:
    - cron: "0 6 * * 1-5"

jobs:
  run_tests:
    name: Run unit tests on ubuntu-latest
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Build & run tests
        run: |
          sudo apt install -y ninja-build
          CMAKE_GENERATOR=Ninja ASAN=ON make test

  check_format:
    name: Check codebase format with clang-format
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Run clang-format dry-run
        run: |
          clang-format --version
          find include/ src/ tests/ examples/ -iname "*.ino" -o -iname "*.h" -o -iname "*.c" | xargs clang-format -n -Werror

  c99_build:
    name: Check c99 compilation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Build with C99
        run: |
          sudo apt install -y ninja-build
          FORCE_C99=ON CMAKE_GENERATOR=Ninja make

  raweth_build:
    name: Build raweth transport on ubuntu-latest
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Build raweth
        run: |
          sudo apt install -y ninja-build
          Z_FEATURE_RAWETH_TRANSPORT=1 CMAKE_GENERATOR=Ninja make

  zenoh_build:
    name: Build Zenoh from source
    runs-on: ubuntu-latest
    outputs:
      artifact-name: ${{ steps.main.outputs.artifact-name }}
    steps:
      - id: main
        name: Build Zenoh
        uses: eclipse-zenoh/ci/build-crates-standalone@main
        with:
          repo: eclipse-zenoh/zenoh
          branch: main
          artifact-patterns: |
            ^zenohd$
            ^libzenoh_plugin_rest.so$
            ^libzenoh_plugin_storage_manager.so$

  modular_build:
    needs: zenoh_build
    name: Modular build on ubuntu-latest
    runs-on: ubuntu-latest
    strategy:
      matrix:
        feature_publication: [1, 0]
        feature_subscription: [1, 0]
        feature_queryable: [1, 0]
        feature_query: [1, 0]
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Download Zenoh artifacts
        uses: actions/download-artifact@v4
        with:
          name: ${{ needs.zenoh_build.outputs.artifact-name }}

      - name: Unzip Zenoh artifacts
        run: unzip ${{ needs.zenoh_build.outputs.artifact-name }} -d zenoh-standalone

      - id: run-zenoh
        name: Run Zenoh router
        run: |
          RUST_LOG=debug ./zenoh-standalone/zenohd &
          echo "zenohd-pid=$!" >> $GITHUB_OUTPUT

      - name: Build project
        run: |
          sudo apt install -y ninja-build
          CMAKE_GENERATOR=Ninja make
          python3 ./build/tests/modularity.py --pub $Z_FEATURE_PUBLICATION --sub $Z_FEATURE_SUBSCRIPTION --queryable $Z_FEATURE_QUERYABLE --query $Z_FEATURE_QUERY
        timeout-minutes: 5
        env:
          Z_FEATURE_PUBLICATION: ${{ matrix.feature_publication }}
          Z_FEATURE_SUBSCRIPTION: ${{ matrix.feature_subscription }}
          Z_FEATURE_QUERYABLE: ${{ matrix.feature_queryable }}
          Z_FEATURE_QUERY: ${{ matrix.feature_query }}

      - name: Kill Zenoh router
        if: always()
        run: kill ${{ steps.run-zenoh.outputs.zenohd-pid }}

  unstable_build:
    name: Check compilation with unstable API
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Build with unstable
        run: |
          sudo apt install -y ninja-build
          Z_FEATURE_UNSTABLE_API=1 CMAKE_GENERATOR=Ninja make


  st_build:
    needs: zenoh_build
    name: Build and test in single thread on ubuntu-latest
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Download Zenoh artifacts
        uses: actions/download-artifact@v4
        with:
          name: ${{ needs.zenoh_build.outputs.artifact-name }}

      - name: Unzip Zenoh artifacts
        run: unzip ${{ needs.zenoh_build.outputs.artifact-name }} -d zenoh-standalone

      - id: run-zenoh
        name: Run Zenoh router
        run: |
          RUST_LOG=debug ./zenoh-standalone/zenohd &
          echo "zenohd-pid=$!" >> $GITHUB_OUTPUT

      - name: Build project and run test
        run: |
          sudo apt install -y ninja-build
          CMAKE_GENERATOR=Ninja make
          python3 ./build/tests/single_thread.py
        timeout-minutes: 5
        env:
          Z_FEATURE_MULTI_THREAD: 0

      - name: Kill Zenoh router
        if: always()
        run: kill ${{ steps.run-zenoh.outputs.zenohd-pid }}

  fragment_test:
    needs: zenoh_build
    name: Test multicast and unicast fragmentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Download Zenoh artifacts
        uses: actions/download-artifact@v4
        with:
          name: ${{ needs.zenoh_build.outputs.artifact-name }}

      - name: Unzip Zenoh artifacts
        run: unzip ${{ needs.zenoh_build.outputs.artifact-name }} -d zenoh-standalone

      - id: run-zenoh
        name: Run Zenoh router
        run: |
          RUST_LOG=debug ./zenoh-standalone/zenohd &
          echo "zenohd-pid=$!" >> $GITHUB_OUTPUT

      - name: Build project and run test
        run: |
          sudo apt install -y ninja-build
          cmake -DBATCH_UNICAST_SIZE=4096 -B build/ -G Ninja
          CMAKE_GENERATOR=Ninja make
          python3 ./build/tests/fragment.py
        timeout-minutes: 5

      - name: Kill Zenoh router
        if: always()
        run: kill ${{ steps.run-zenoh.outputs.zenohd-pid }}

  attachment_test:
    needs: zenoh_build
    name: Test attachments
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Download Zenoh artifacts
        uses: actions/download-artifact@v4
        with:
          name: ${{ needs.zenoh_build.outputs.artifact-name }}

      - name: Unzip Zenoh artifacts
        run: unzip ${{ needs.zenoh_build.outputs.artifact-name }} -d zenoh-standalone

      - id: run-zenoh
        name: Run Zenoh router
        run: |
          RUST_LOG=debug ./zenoh-standalone/zenohd &
          echo "zenohd-pid=$!" >> $GITHUB_OUTPUT

      - name: Build project and run test
        run: |
          sudo apt install -y ninja-build
          Z_FEATURE_UNSTABLE_API=1 CMAKE_GENERATOR=Ninja make
          python3 ./build/tests/attachment.py
        timeout-minutes: 5

      - name: Kill Zenoh router
        if: always()
        run: kill ${{ steps.run-zenoh.outputs.zenohd-pid }}

  memory_leak_test:
    needs: zenoh_build
    name: Test examples memory leak
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Download Zenoh artifacts
        uses: actions/download-artifact@v4
        with:
          name: ${{ needs.zenoh_build.outputs.artifact-name }}

      - name: Unzip Zenoh artifacts
        run: unzip ${{ needs.zenoh_build.outputs.artifact-name }} -d zenoh-standalone

      - id: run-zenoh
        name: Run Zenoh router
        run: |
          RUST_LOG=debug ./zenoh-standalone/zenohd &
          echo "zenohd-pid=$!" >> $GITHUB_OUTPUT

      - name: Install valgrind
        run: sudo apt install -y valgrind

      - name: Build project
        run: |
          sudo apt install -y ninja-build
          Z_FEATURE_UNSTABLE_API=1 Z_FEATURE_LIVELINESS=1 CMAKE_GENERATOR=Ninja make

      - name: Run test
        run: python3 -u ./build/tests/memory_leak.py
        timeout-minutes: 5 

      - name: Kill Zenoh router
        if: always()
        run: kill ${{ steps.run-zenoh.outputs.zenohd-pid }}

  no_router:
    name: Test examples without router
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Build & test pico
        run: |
          sudo apt install -y ninja-build
          CMAKE_GENERATOR=Ninja ASAN=ON make
          python3 ./build/tests/no_router.py
        timeout-minutes: 5

  markdown_lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: DavidAnson/markdownlint-cli2-action@v18
        with:
          config: '.markdownlint.yaml'
          globs: '**/README.md'

  build_shared:
    name: Build shared libs
    uses: ./.github/workflows/build-shared.yaml

  build_static:
    name: Build static libs
    uses: ./.github/workflows/build-static.yaml

  integration:
    name: Run integration tests
    uses: ./.github/workflows/integration.yaml

  multicast:
    name: Run multicast tests
    uses: ./.github/workflows/multicast.yaml

  # NOTE: In GitHub repository settings, the "Require status checks to pass
  # before merging" branch protection rule ensures that commits are only merged
  # from branches where specific status checks have passed. These checks are
  # specified manually as a list of workflow job names. Thus we use this extra
  # job to signal whether all CI checks have passed.
  ci:
    name: CI status checks
    runs-on: ubuntu-latest
    needs: [run_tests, check_format, c99_build, raweth_build, zenoh_build, modular_build, unstable_build, st_build, fragment_test, attachment_test, memory_leak_test, no_router, markdown_lint, build_shared, build_static, integration, multicast]
    if: always()
    steps:
      - name: Check whether all jobs pass
        run: echo '${{ toJson(needs) }}' | jq -e 'all(.result == "success")'