unit-tests.yml

# Reusable Workflow: Tests
#
# Runs test suites via the Makefile. By default runs unit tests and component
# validation. Callers can enable additional suites (CLI, Vector API, behavior)
# via boolean inputs.
#
# With coverage: false (default), plain cargo-nextest; uploads test results to Datadog.
# With coverage: true, cargo-llvm-cov (COVERAGE=true); uploads an lcov artifact named "coverage-unit".
#
# When `default` is true (the default), all nextest-based suites run in a
# single `make test` invocation with the relevant features enabled. When
# `default` is false, only the explicitly enabled suites run, using a nextest
# filter expression to select the matching tests.

name: Tests

on:
  workflow_call:
    inputs:
      ref:
        description: "Git ref to checkout"
        required: false
        type: string
      coverage:
        description: "Collect code coverage (sets COVERAGE=true for make targets)"
        required: false
        type: boolean
        default: false
      default:
        description: "Run the full default unit test suite (--workspace with default features)"
        required: true
        type: boolean
      component-validation:
        description: "Include component validation tests"
        required: false
        type: boolean
        default: true
      cli:
        description: "Include CLI tests"
        required: false
        type: boolean
        default: false
      vector-api:
        description: "Include Vector API tests"
        required: false
        type: boolean
        default: false
      behavior:
        description: "Include behavior tests (cargo run based, no coverage)"
        required: false
        type: boolean
        default: false

permissions:
  contents: read

env:
  CI: true
  DD_ENV: "ci"

jobs:
  tests:
    name: Tests
    runs-on: ubuntu-24.04-8core
    permissions:
      contents: read
      id-token: write
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          ref: ${{ inputs.ref }}

      - uses: ./.github/actions/dd-token

      - uses: ./.github/actions/setup
        with:
          rust: true
          cargo-nextest: true
          cargo-llvm-cov: ${{ inputs.coverage }}
          datadog-ci: ${{ !inputs.coverage }}
          protoc: true
          libsasl2: true

      - name: Run tests
        run: |
          add_suite() {
            local enabled="$1" feature="$2" filter="$3"
            [[ "${enabled}" != "true" ]] && return
            FEATURES="${FEATURES:+$FEATURES,}${feature}"
            if [[ "${{ inputs.default }}" != "true" ]]; then
              SCOPE="${SCOPE:+$SCOPE | }${filter}"
            fi
          }

          # Mirror the Makefile's OS-based default: `default-msvc` on Windows,
          # `default` elsewhere. Keep in sync with the FEATURES defaults in Makefile.
          if [[ "${RUNNER_OS}" == "Windows" ]]; then
            DEFAULT_FEATURES="default-msvc"
          else
            DEFAULT_FEATURES="default"
          fi

          if [[ "${{ inputs.default }}" == "true" ]]; then
            FEATURES="${DEFAULT_FEATURES}"
          else
            FEATURES=""
          fi

          add_suite "${{ inputs.component-validation }}" "component-validation-tests" "test(components::validation::tests)"
          add_suite "${{ inputs.cli }}" "cli-tests" "package(vector) & binary(=integration)"
          add_suite "${{ inputs.vector-api }}" "vector-api-tests" "binary(=vector_api)"

          # Skip `make test` entirely if no nextest-based suite was selected
          # (e.g. behavior-only runs). Running `make test` with empty FEATURES
          # would otherwise execute the workspace-wide suite.
          if [[ "${{ inputs.default }}" == "true" ]]; then
            make test FEATURES="${FEATURES}"
          elif [[ -n "${SCOPE}" ]]; then
            make test FEATURES="${FEATURES}" SCOPE="-E '${SCOPE}'"
          else
            echo "No nextest suites selected; skipping 'make test'"
          fi
        env:
          COVERAGE: ${{ inputs.coverage }}

      - name: Behavior tests
        if: ${{ inputs.behavior }}
        run: make test-behavior

      - name: Upload test results to Datadog
        if: ${{ !inputs.coverage && always() }}
        run: scripts/upload-test-results.sh

      - name: Generate lcov report
        if: ${{ inputs.coverage }}
        run: |
          make coverage-report
          # Normalize absolute source paths to relative so they merge cleanly with
          # coverage from the containerized integration tests (which use SF:src/...).
          sed -i "s|SF:$(pwd)/|SF:|g" lcov.info

      - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
        if: ${{ inputs.coverage }}
        with:
          name: coverage-unit
          path: lcov.info