build-and-test-reusable.yaml

name: build-and-test-reusable

on:
  workflow_call:
    inputs:
      # Why is it a JSON string?
      # https://github.com/orgs/community/discussions/11692#discussioncomment-3541856
      runner:
        type: string
        default: "['ubuntu-latest']"
        required: false
      container:
        type: string
        default: ghcr.io/autowarefoundation/autoware:universe-devel
        required: false
      container-suffix:
        type: string
        default: ""
        required: false
      rosdistro:
        type: string
        default: humble
        required: false
      build-pre-command:
        type: string
        default: ""
        required: false
      arch:
        type: string
        default: amd64
        required: false
      push-ccache:
        type: boolean
        default: false
        required: false
      pull-ccache:
        type: boolean
        default: false
        required: false
      concurrency-group:
        type: string
        default: ${{ github.workflow }}-${{ github.ref }}-${{ github.run_id }} # unique per run
        required: false
      cancel-in-progress:
        type: boolean
        default: false
        required: false
      upload-coverage:
        type: boolean
        default: false
        required: false
      codecov-flag:
        type: string
        default: temp
        required: false
    secrets:
      codecov-token:
        required: false

concurrency:
  group: ${{ inputs.concurrency-group }}
  cancel-in-progress: ${{ inputs.cancel-in-progress }}

env:
  CC: /usr/lib/ccache/gcc
  CXX: /usr/lib/ccache/g++

jobs:
  build-and-test:
    runs-on: ${{ fromJson(inputs.runner) }}
    container: ${{ inputs.container }}${{ inputs.container-suffix }}
    steps:
      - name: Check out repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Show disk space before the tasks
        run: df -h

      - name: Show machine specs
        run: lscpu && free -h

      - name: Remove exec_depend
        uses: autowarefoundation/autoware-github-actions/remove-exec-depend@v1

      - name: Get self packages
        id: get-self-packages
        uses: autowarefoundation/autoware-github-actions/get-self-packages@v1

      - name: Create ccache directory
        if: ${{ inputs.pull-ccache || inputs.push-ccache }}
        run: |
          mkdir -p ${CCACHE_DIR}
          du -sh ${CCACHE_DIR} && ccache -s
        shell: bash

      - name: Attempt to restore ccache
        if: ${{ inputs.pull-ccache }}
        uses: actions/cache/restore@v4
        with:
          path: |
            /root/.ccache
          key: ccache-main-${{ runner.arch }}-${{ inputs.rosdistro }}-${{ github.sha }}
          restore-keys: |
            ccache-main-${{ runner.arch }}-${{ inputs.rosdistro }}-

      - name: Limit ccache size
        if: ${{ inputs.pull-ccache || inputs.push-ccache }}
        run: |
          rm -f "${CCACHE_DIR}/ccache.conf"
          echo -e "# Set maximum cache size\nmax_size = 900MB" >> "${CCACHE_DIR}/ccache.conf"
        shell: bash

      - name: Show ccache stats before build and reset stats
        if: ${{ inputs.pull-ccache || inputs.push-ccache }}
        run: |
          du -sh ${CCACHE_DIR} && ccache -s
          ccache --zero-stats
        shell: bash

      - name: Export CUDA state as a variable for adding to cache key
        run: |
          build_type_cuda_state=nocuda
          if [[ "${{ inputs.container-suffix }}" == "-cuda" ]]; then
            build_type_cuda_state=cuda
          fi
          echo "BUILD_TYPE_CUDA_STATE=$build_type_cuda_state" >> "${GITHUB_ENV}"
          echo "::notice::BUILD_TYPE_CUDA_STATE=$build_type_cuda_state"
        shell: bash

      - name: Prepare build_depends.repos file
        uses: ./.github/actions/combine-repos-action
        with:
          base_file: build_depends_stable.repos
          overlay_file: build_depends_nightly.repos
          output_file: build_depends.repos

      - name: Build
        if: ${{ steps.get-self-packages.outputs.self-packages != '' }}
        uses: autowarefoundation/autoware-github-actions/colcon-build@v1
        with:
          rosdistro: ${{ inputs.rosdistro }}
          target-packages: ${{ steps.get-self-packages.outputs.self-packages }}
          build-depends-repos: build_depends.repos
          cache-key-element: ${{ env.BUILD_TYPE_CUDA_STATE }}
          build-pre-command: ${{ inputs.build-pre-command }}

      - name: Show ccache stats after build
        if: ${{ inputs.pull-ccache || inputs.push-ccache }}
        run: du -sh ${CCACHE_DIR} && ccache -s
        shell: bash

      # Only keep save the -cuda version because cuda packages covers non-cuda packages too
      - name: Push the ccache cache (if inputs.container-suffix == '-cuda' AND inputs.push-ccache)
        if: ${{ inputs.push-ccache }}
        uses: actions/cache/save@v4
        with:
          path: |
            /root/.ccache
          key: ccache-main-${{ runner.arch }}-${{ inputs.rosdistro }}-${{ github.sha }}

      - name: Test
        if: ${{ steps.get-self-packages.outputs.self-packages != '' }}
        id: test
        uses: autowarefoundation/autoware-github-actions/colcon-test@v1
        with:
          rosdistro: ${{ inputs.rosdistro }}
          target-packages: ${{ steps.get-self-packages.outputs.self-packages }}
          build-depends-repos: build_depends.repos

      - name: Upload coverage to CodeCov
        if: ${{ steps.test.outputs.coverage-report-files != '' && inputs.upload-coverage }}
        uses: codecov/codecov-action@v6
        with:
          files: ${{ steps.test.outputs.coverage-report-files }}
          fail_ci_if_error: false
          verbose: true
          flags: ${{ inputs.codecov-flag }}
          token: ${{ secrets.codecov-token }}
          disable_search: true
          # Disable gcov and xcode plugins, keeping only pycoverage.
          # Default plugins: https://github.com/getsentry/prevent-cli/blob/45e518e5ca344c9fb7a5cbe596a21b7ab85a39ed/codecov-cli/README.md?plain=1#L178
          plugins: pycoverage

      - name: Show disk space after the tasks
        run: df -h

  clang-tidy:
    needs: build-and-test
    if: ${{ inputs.rosdistro == 'jazzy' && inputs.container-suffix == '-cuda' && inputs.arch == 'amd64' }}
    runs-on: ubuntu-latest
    container: ${{ inputs.container }}${{ inputs.container-suffix }}
    steps:
      - name: Check out repository
        uses: actions/checkout@v6

      - name: Show disk space before the tasks
        run: df -h

      - name: Remove exec_depend
        uses: autowarefoundation/autoware-github-actions/remove-exec-depend@v1

      - name: Get self packages
        id: get-self-packages
        uses: autowarefoundation/autoware-github-actions/get-self-packages@v1

      - name: Export CUDA state as a variable for adding to cache key
        run: |
          build_type_cuda_state=nocuda
          if [[ "${{ inputs.container-suffix }}" == "-cuda" ]]; then
            build_type_cuda_state=cuda
          fi
          echo "BUILD_TYPE_CUDA_STATE=$build_type_cuda_state" >> "${GITHUB_ENV}"
          echo "::notice::BUILD_TYPE_CUDA_STATE=$build_type_cuda_state"
        shell: bash

      - name: Prepare build_depends.repos file
        uses: ./.github/actions/combine-repos-action
        with:
          base_file: build_depends_stable.repos
          overlay_file: build_depends_nightly.repos
          output_file: build_depends.repos

      - name: Run clang-tidy
        if: ${{ steps.get-self-packages.outputs.self-packages != '' }}
        uses: autowarefoundation/autoware-github-actions/clang-tidy@v1
        with:
          rosdistro: ${{ inputs.rosdistro }}
          target-packages: ${{ steps.get-self-packages.outputs.self-packages }}
          clang-tidy-config-url: https://raw.githubusercontent.com/autowarefoundation/autoware_universe/main/.clang-tidy-ci
          clang-tidy-ignore-path: .clang-tidy-ignore
          build-depends-repos: build_depends.repos
          cache-key-element: ${{ env.BUILD_TYPE_CUDA_STATE }}
          artifact-name: clang-tidy-result-${{ inputs.rosdistro }}${{ inputs.container-suffix }}
          use-clang-tidy-cache: true

      - name: Show disk space after the tasks
        run: df -h