ci_linting.yml

---
name: Linters
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  merge_group:
    types: [checks_requested]
    branches: [main]
jobs:
  cppcheck:
    # ubuntu-latest introduced a newer gcc version that cannot compile cppcheck 2.3
    # TODO: upgrade to latest cppcheck and revert to ubuntu-latest
    #       see https://github.com/aws/s2n-tls/issues/3656
    runs-on: ubuntu-20.04
    env:
      CPPCHECK_INSTALL_DIR: test-deps/cppcheck
    steps:
      - uses: actions/checkout@v4

      - name: Setup
        run: source ./codebuild/bin/s2n_setup_env.sh

      - name: Cache
        id: cache
        uses: actions/cache@v4
        continue-on-error: true
        with:
          path: ${{ env.CPPCHECK_INSTALL_DIR }}
          key: cppcheck-2.3-${{ env.CPPCHECK_INSTALL_DIR }}

      - name: Install
        if: steps.cache.outputs.cache-hit != 'true'
        run: ./codebuild/bin/install_cppcheck.sh "$CPPCHECK_INSTALL_DIR"

      - name: Check
        run: ./codebuild/bin/run_cppcheck.sh "$CPPCHECK_INSTALL_DIR"

  headers:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup
        run: source ./codebuild/bin/s2n_setup_env.sh

      - name: Check
        run: ./codebuild/bin/header_mistake_scanner.sh

  simple-mistakes:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup
        run: source ./codebuild/bin/s2n_setup_env.sh

      - name: Check
        run: ./codebuild/bin/grep_simple_mistakes.sh

  comments:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup
        run: source ./codebuild/bin/s2n_setup_env.sh

      - name: Install
        run: sudo apt update && sudo apt install -y kwstyle

      - name: Check
        run: |
          ./codebuild/bin/run_kwstyle.sh
          ./codebuild/bin/cpp_style_comment_linter.sh
  ruff:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v4

      - name: Set up uv
        uses: astral-sh/setup-uv@v5

      - name: Run Ruff formatting check
        working-directory: tests/integrationv2
        id: ruff_format
        run: uv run ruff format --diff .
        continue-on-error: true

      - name: Check exit code
        if: steps.ruff_format.outcome == 'failure'
        run: |
            echo "Run 'ruff format .' to fix formatting issues"
            exit 1
  clang-format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: clang-format check
        uses: harrisonkaiser/clang-format-action@verbose
        with:
          clang-format-version: '15'
          include-regex: '^(\.\/)?(api|bin|crypto|stuffer|error|tls|utils|tests\/unit|tests\/testlib|docs\/examples).*\.(c|h)$'
  nixflake:
    # The nix develop changes contain broken nixpkg dependenecies; the allow/impure flags workaround this.
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: nixbuild/nix-quick-install-action@v30
        with:
          nix_conf: experimental-features = nix-command flakes
      - name: nix flake check
        run: NIXPKGS_ALLOW_BROKEN=1 NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1 nix flake check --impure
  nixfmt:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: nixbuild/nix-quick-install-action@v30
        with:
          nix_conf: experimental-features = nix-command flakes
      - name: nix fmt
        run: nix fmt $(find . -name \*nix -type f -not -path "./.git/*")
      - name: Changed files
        id: dirty
        run: |
          echo "Checking nix files with: nix fmt ..."
          git diff --exit-code
        continue-on-error: true
      - name: Failure case
        if: steps.dirty.outcome != 'success'
        run: |
          echo "Please fix formatting with nix fmt (file)"
          exit 1
      - name: Success
        run: echo "All nix files passed format check"
        
  validate_start_codebuild_script:
    name: validate start_codebuild.sh
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: pause
        run: "sleep 120"
      - name: retrieve statuses
        id: get_statuses
        uses: octokit/request-action@v2.x
        with:
          route: GET /repos/{repo}/commits/{ref}/statuses?per_page=100
          repo: ${{ github.repository }}
          ref: ${{ github.event.merge_group.head_sha || github.event.pull_request.head.sha || github.event.after }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: check start_codebuild.sh against statuses
        id: github_builds
        run: |
            from_github=$(
                jq '.[] | .description' <<< '${{ steps.get_statuses.outputs.data }}' \
                    | grep "for project" \
                    | sed -r "s/^.*?for project (.*?)\"$/\1/" \
                    | sort -u
            )
            if [ -z "$from_github" ]; then
                echo "No codebuild job statuses!"
                echo "You may need to kick off the codebuild jobs with" \
                    "./codebuild/bin/start_codebuild.sh and then retry."
                exit 1
            fi
            echo builds from github statuses:
            printf "$from_github\n\n"
            from_file=$(
                source codebuild/bin/start_codebuild.sh > /dev/null \
                || printf "%s\n" "${BUILDS[@]}" | cut -d" " -f1 | sort -u
            )
            echo builds from start_codebuild.sh:
            printf "$from_file\n\n"
            echo "diff output:"
            diff <(echo "$from_github") <(echo "$from_file")