codeql.yml

name: 🔍 CodeQL

on:
  push:
    branches: [ "development" ]
  pull_request:
    branches: [ "development" ]
  schedule:
    - cron: "27 3 * * 0"

concurrency:
  group: ${{ github.ref }}-${{ github.head_ref }}-codeql
  cancel-in-progress: true

jobs:
  analyze:
    name: Analyze
    runs-on: ubuntu-latest
    if: github.event.pull_request.draft == false
    permissions:
      actions: read
      contents: read
      security-events: write

    strategy:
      fail-fast: false
      matrix:
        language: [ python, cpp ]

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Packages (C++)
        if: ${{ matrix.language == 'cpp' }}
        run: |
          sudo apt-get update
          sudo apt-get install --yes cmake openmpi-bin libopenmpi-dev libhdf5-openmpi-dev libadios-openmpi-dev ccache

          python -m pip install --upgrade pip
          python -m pip install --upgrade wheel
          python -m pip install --upgrade cmake
          export CMAKE="$HOME/.local/bin/cmake" && echo "CMAKE=$CMAKE" >> $GITHUB_ENV

      - name: Set Up Cache
        if: ${{ matrix.language == 'cpp' }}
        uses: actions/cache@v4
        with:
          path: ~/.cache/ccache
          key: ccache-${{ github.workflow }}-${{ github.job }}-git-${{ github.sha }}
          restore-keys: |
               ccache-${{ github.workflow }}-${{ github.job }}-git-

      - name: Configure (C++)
        if: ${{ matrix.language == 'cpp' }}
        run: |
          $CMAKE -S . -B build -DWarpX_OPENPMD=ON

      - name: Initialize CodeQL
        uses: github/codeql-action/init@v3
        with:
          config-file: ./.github/codeql/warpx-codeql.yml
          languages: ${{ matrix.language }}
          queries: +security-and-quality

      - name: Build (py)
        uses: github/codeql-action/autobuild@v3
        if: ${{ matrix.language == 'python' }}

      - name: Build (C++)
        if: ${{ matrix.language == 'cpp' }}
        run: |
          export CCACHE_COMPRESS=1
          export CCACHE_COMPRESSLEVEL=10
          export CCACHE_MAXSIZE=100M
          ccache -z

          $CMAKE --build build -j 4

          ccache -s
          du -hs ~/.cache/ccache

          # Make sure CodeQL has something to do
          touch Source/Utils/WarpXVersion.cpp
          export CCACHE_DISABLE=1
          $CMAKE --build build -j 4

      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@v3
        with:
          category: "/language:${{ matrix.language }}"
          upload: False
          output: sarif-results

      - name: filter-sarif
        uses: advanced-security/filter-sarif@v1
        with:
          patterns: |
            -build/_deps/*/*
            -build/_deps/*/*/*
            -build/_deps/*/*/*/*
            -build/_deps/*/*/*/*/*
            -build/_deps/*/*/*/*/*/*
            -build/_deps/*/*/*/*/*/*/*
            -build/_deps/*/*/*/*/*/*/*/*
          input: sarif-results/${{ matrix.language }}.sarif
          output: sarif-results/${{ matrix.language }}.sarif

      - name: Upload SARIF
        uses: github/codeql-action/upload-sarif@v3
        with:
          sarif_file: sarif-results/${{ matrix.language }}.sarif

  save_pr_number:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - name: Save PR number
        env:
          PR_NUMBER: ${{ github.event.number }}
        run: |
          echo $PR_NUMBER > pr_number.txt
      - uses: actions/upload-artifact@v4
        with:
          name: pr_number
          path: pr_number.txt
          retention-days: 1