rippled/.github/workflows/reusable-clang-tidy.yml

name: Run clang-tidy on files

on:
  workflow_call:
    inputs:
      create_issue_on_failure:
        description: "Whether to create an issue if the check failed"
        type: boolean
        default: false

defaults:
  run:
    shell: bash

env:
  BUILD_DIR: build
  BUILD_TYPE: Debug # Debug so that ASSERTS and such participate in clang-tidy check

  OUTPUT_FILE: /tmp/clang-tidy-output.txt
  FILTERED_OUTPUT_FILE: /tmp/clang-tidy-filtered-output.txt
  DIFF_FILE: /tmp/clang-tidy-git-diff.txt
  ISSUE_FILE: /tmp/clang-tidy-issue.md

  COMPILER: clang

jobs:
  determine-files:
    permissions:
      contents: read
    uses: XRPLF/actions/.github/workflows/determine-tidy-files.yml@d041ac9f1fa9f07a4ba335eb4c1c82233fb3fef6

  run-clang-tidy:
    name: Run clang tidy
    needs: [determine-files]
    if: ${{ needs.determine-files.outputs.cpp_changed_files != '' || needs.determine-files.outputs.need_full_run == 'true' }}
    runs-on: ["self-hosted", "Linux", "X64", "heavy"]
    container: "ghcr.io/xrplf/xrpld/nix-debian:sha-3122de8"
    permissions:
      contents: read
      issues: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

      - name: Prepare runner
        uses: XRPLF/actions/prepare-runner@e4b6449d55a61c002d7c3fdfa6c20f721ede0606
        with:
          enable_ccache: false

      - name: Print build environment
        uses: XRPLF/actions/print-build-env@59dec886e4afb05a1724443af08baccbc045b574

      - name: Get number of processors
        uses: XRPLF/actions/get-nproc@cf0433aa74563aead044a1e395610c96d65a37cf
        id: nproc

      - name: Set compiler environment
        uses: ./.github/actions/set-compiler-env
        with:
          compiler: ${{ env.COMPILER }}

      - name: Setup Conan
        uses: ./.github/actions/setup-conan

      - name: Build dependencies
        uses: ./.github/actions/build-deps
        with:
          build_nproc: ${{ steps.nproc.outputs.nproc }}
          build_type: ${{ env.BUILD_TYPE }}
          log_verbosity: verbose

      - name: Configure CMake
        working-directory: ${{ env.BUILD_DIR }}
        run: |
          cmake \
              -G 'Ninja' \
              -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake \
              -DCMAKE_BUILD_TYPE="${BUILD_TYPE}" \
              -Dtests=ON \
              -Dwerr=ON \
              -Dxrpld=ON \
              -Dverify_headers=ON \
              ..

      # clang-tidy needs headers generated from proto files
      - name: Build libxrpl.libpb
        working-directory: ${{ env.BUILD_DIR }}
        run: |
          ninja -j ${{ steps.nproc.outputs.nproc }} xrpl.libpb

      - name: Run clang tidy
        id: run_clang_tidy
        continue-on-error: true
        env:
          TARGETS: ${{ needs.determine-files.outputs.need_full_run != 'true' && needs.determine-files.outputs.cpp_changed_files || 'include src tests' }}
        run: |
          set -o pipefail
          run-clang-tidy -j ${{ steps.nproc.outputs.nproc }} -p "${BUILD_DIR}" -quiet -fix -allow-no-checks ${TARGETS} 2>&1 | tee "${OUTPUT_FILE}"

      - name: Print filtered clang-tidy errors
        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
        run: |
          bin/filter-clang-tidy.py "${OUTPUT_FILE}"

      - name: Upload clang-tidy output
        if: ${{ github.event.repository.visibility == 'public' && steps.run_clang_tidy.outcome != 'success' }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          path: ${{ env.OUTPUT_FILE }}
          archive: false
          retention-days: 30

      - name: Check for changes
        id: files_changed
        continue-on-error: true
        run: |
          git diff --exit-code

      - name: Fix style
        if: ${{ steps.files_changed.outcome != 'success' }}
        run: |
          pre-commit run --all-files || true

      - name: Generate git diff
        if: ${{ steps.files_changed.outcome != 'success' }}
        run: |
          git diff | tee "${DIFF_FILE}"

      - name: Upload clang-tidy diff output
        if: ${{ github.event.repository.visibility == 'public' && steps.files_changed.outcome != 'success' }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          path: ${{ env.DIFF_FILE }}
          archive: false
          retention-days: 30

      - name: Write issue header
        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
        run: |
          cat >"${ISSUE_FILE}" <<EOF
          ## Clang-tidy Check Failed

          ### Clang-tidy Output:
          \`\`\`
          EOF

      - name: Append filtered clang-tidy output to issue body
        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
        run: |
          if [ -f "${OUTPUT_FILE}" ]; then
              # Filter to the unique errors with their source context.
              bin/filter-clang-tidy.py "${OUTPUT_FILE}" >"${FILTERED_OUTPUT_FILE}" || true

              # If filtered output is empty, use original (might be a different error format)
              if [ ! -s "${FILTERED_OUTPUT_FILE}" ]; then
                  cp "${OUTPUT_FILE}" "${FILTERED_OUTPUT_FILE}"
              fi

              # Truncate if too large
              head -c 60000 "${FILTERED_OUTPUT_FILE}" >>"${ISSUE_FILE}"
              if [ "$(wc -c <"${FILTERED_OUTPUT_FILE}")" -gt 60000 ]; then
                  echo "" >>"${ISSUE_FILE}"
                  echo "... (output truncated, see artifacts for full output)" >>"${ISSUE_FILE}"
              fi

              rm "${FILTERED_OUTPUT_FILE}"
          else
              echo "No output file found" >>"${ISSUE_FILE}"
          fi

      - name: Append issue footer
        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
        run: |
          cat >>"${ISSUE_FILE}" <<EOF
          \`\`\`

          ---
          *This issue was automatically created by the clang-tidy workflow.*
          EOF

      - name: Create issue
        if: ${{ steps.run_clang_tidy.outcome != 'success' && inputs.create_issue_on_failure }}
        uses: XRPLF/actions/create-issue@2b8bc36af85b88bca0dd7bfac2e2dc05f94ad712
        with:
          title: "Clang-tidy check failed"
          body_file: ${{ env.ISSUE_FILE }}
          labels: "Bug,Clang-tidy"
          assignees: "godexsoft,mathbunnyru"

      - name: Fail if clang-tidy found issues
        if: ${{ steps.run_clang_tidy.outcome != 'success' }}
        run: |
          echo "Clang-tidy check failed!"
          exit 1