fix:codeql full scan #327
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Full CodeQL scan config. | ||
| paths-ignore: | ||
| - '**/target/' | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| java_build_mode="${1:-autobuild}" | ||
|
|
||
| matrix_entries="" | ||
|
|
||
| has_files() { | ||
| git ls-files "$@" | grep -q . | ||
|
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: #!/usr/bin/env bash
set -euo pipefail
repo="$(mktemp -d)"
trap 'rm -rf "$repo"' EXIT
git -C "$repo" init -q
mkdir -p "$repo/src"
for i in $(seq 1 10000); do
: > "$repo/src/CodeQlMatrixProbe${i}.java"
done
git -C "$repo" add .
has_files() {
git -C "$repo" ls-files "$@" | grep -q .
}
if has_files '*.java'; then
echo "Unexpected success: SIGPIPE was not reproduced."
exit 1
fi
echo "Confirmed: pipefail treats the early consumer exit as a failed detection."Repository: opentiny/tiny-engine-backend-java Length of output: 282 🏁 Script executed: #!/usr/bin/env bash
set -u
printf '%s\n' '--- review conventions ---'
find /tmp/coderabbit-repo-knowledge/opentiny-tiny-engine-backend-java-1b9e840d \
-maxdepth 2 -type f -name '*.md' -print -exec sed -n '1,120p' {} \;
printf '%s\n' '--- target script ---'
cat -n .github/scripts/codeql-matrix.sh
printf '%s\n' '--- repository status and relevant references ---'
git diff --stat
rg -n --fixed-strings 'git ls-files' .github . 2>/dev/null | head -80Repository: opentiny/tiny-engine-backend-java Length of output: 2472 Consume the complete With 🤖 Prompt for AI Agents |
||
| } | ||
|
|
||
| add_entry() { | ||
| local entry="$1" | ||
| if [ -n "$matrix_entries" ]; then | ||
| matrix_entries="$matrix_entries,$entry" | ||
| else | ||
| matrix_entries="$entry" | ||
| fi | ||
| } | ||
|
|
||
| if has_files '.github/workflows/*.yml' '.github/workflows/*.yaml'; then | ||
| add_entry '{"language":"actions","build-mode":"none"}' | ||
| fi | ||
|
|
||
| if has_files '*.java'; then | ||
| add_entry "{\"language\":\"java-kotlin\",\"build-mode\":\"$java_build_mode\"}" | ||
| fi | ||
|
|
||
| if has_files '*.js' '*.jsx' '*.ts' '*.tsx' '*.mjs' '*.cjs' '*.vue' '*.html'; then | ||
| add_entry '{"language":"javascript-typescript","build-mode":"none"}' | ||
| fi | ||
|
|
||
| printf '{"include":[%s]}\n' "$matrix_entries" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| name: CodeQL Full Scan | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: '34 7 * * 1' | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| security-events: write | ||
| packages: read | ||
| actions: read | ||
|
|
||
| jobs: | ||
| detect: | ||
| name: Detect CodeQL languages | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true | ||
| outputs: | ||
| matrix: ${{ steps.matrix.outputs.matrix }} | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v6 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Build matrix | ||
| id: matrix | ||
| shell: bash | ||
| run: | | ||
| matrix=$(bash .github/scripts/codeql-matrix.sh manual) | ||
| printf 'matrix=%s\n' "$matrix" >> "$GITHUB_OUTPUT" | ||
|
|
||
| analyze: | ||
| needs: detect | ||
| name: Full scan (${{ matrix.language }}) | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: ${{ fromJSON(needs.detect.outputs.matrix) }} | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v6 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Set up JDK 17 | ||
| if: matrix.language == 'java-kotlin' | ||
| uses: actions/setup-java@v5 | ||
| with: | ||
| java-version: '17' | ||
| distribution: 'temurin' | ||
| cache: maven | ||
|
|
||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@v4 | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| build-mode: ${{ matrix.build-mode }} | ||
| config-file: ./.github/codeql/codeql-full-config.yml | ||
|
|
||
| - name: Build project | ||
| if: matrix.language == 'java-kotlin' | ||
| run: mvn -B clean test-compile -DskipTests -Dcheckstyle.skip=true -Dpmd.skip=true -Dspotbugs.skip=true -Dcpd.skip=true | ||
|
|
||
| - name: Prepare CodeQL SARIF directory | ||
| shell: bash | ||
| run: | | ||
| rm -rf codeql-sarif | ||
| mkdir -p codeql-sarif | ||
|
|
||
| - name: Perform CodeQL Analysis | ||
| id: codeql-analysis | ||
| uses: github/codeql-action/analyze@v4 | ||
| with: | ||
| output: ${{ github.workspace }}/codeql-sarif | ||
| upload: always | ||
| category: "/codeql-full:${{ matrix.language }}" | ||
|
|
||
| - name: Summarize CodeQL SARIF report | ||
| id: sarif-summary | ||
| if: always() | ||
| shell: bash | ||
| run: | | ||
| set -euo pipefail | ||
|
|
||
| mkdir -p codeql-sarif | ||
| report_index="codeql-sarif/scan-files.txt" | ||
| sarif_count=0 | ||
| invalid_sarif=0 | ||
| violations=0 | ||
|
|
||
| { | ||
| printf 'language=%s\n' '${{ matrix.language }}' | ||
| printf 'codeql_output=%s\n' '${{ github.workspace }}/codeql-sarif' | ||
| printf '\nGenerated SARIF files:\n' | ||
| } > "$report_index" | ||
|
|
||
| while IFS= read -r -d '' file; do | ||
| sarif_count=$((sarif_count + 1)) | ||
| result_count=$(jq '[.runs[]?.results[]?] | length' "$file" 2>/dev/null || true) | ||
|
|
||
| if [[ "$result_count" =~ ^[0-9]+$ ]]; then | ||
| violations=$((violations + result_count)) | ||
| printf '%s results=%s\n' "$file" "$result_count" >> "$report_index" | ||
| else | ||
| invalid_sarif=$((invalid_sarif + 1)) | ||
| printf '%s results=invalid-sarif\n' "$file" >> "$report_index" | ||
| fi | ||
| done < <(find codeql-sarif -type f -name '*.sarif' -print0) | ||
|
|
||
| { | ||
| printf '\nSummary:\n' | ||
| printf 'sarif_count=%s\n' "$sarif_count" | ||
| printf 'invalid_sarif=%s\n' "$invalid_sarif" | ||
| printf 'violations=%s\n' "$violations" | ||
| } >> "$report_index" | ||
|
|
||
| printf 'sarif_count=%s\n' "$sarif_count" >> "$GITHUB_OUTPUT" | ||
| printf 'invalid_sarif=%s\n' "$invalid_sarif" >> "$GITHUB_OUTPUT" | ||
| printf 'violations=%s\n' "$violations" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Install SARIF tools | ||
| if: ${{ always() && hashFiles('codeql-sarif/**/*.sarif') != '' }} | ||
| run: python -m pip install sarif-tools | ||
|
|
||
| - name: Generate CodeQL HTML report | ||
| id: html-report | ||
| if: ${{ always() && hashFiles('codeql-sarif/**/*.sarif') != '' }} | ||
| shell: bash | ||
| run: | | ||
| set -euo pipefail | ||
|
|
||
| html_dir="codeql-html-report" | ||
| rm -rf "$html_dir" | ||
| mkdir -p "$html_dir" | ||
|
|
||
| html_count=0 | ||
| while IFS= read -r -d '' sarif_file; do | ||
| sarif html "$sarif_file" --output "$html_dir" | ||
| html_count=$((html_count + 1)) | ||
| printf '%s -> %s/\n' "$sarif_file" "$html_dir" | ||
| done < <(find codeql-sarif -type f -name '*.sarif' -print0) | ||
|
|
||
| index_file="$html_dir/reports.html" | ||
| { | ||
| printf '<!doctype html>\n' | ||
| printf '<html lang="en">\n' | ||
| printf '<head><meta charset="utf-8"><title>CodeQL HTML Reports</title></head>\n' | ||
| printf '<body>\n' | ||
| printf '<h1>CodeQL HTML Reports - %s</h1>\n' '${{ matrix.language }}' | ||
| printf '<ul>\n' | ||
| while IFS= read -r -d '' html_file; do | ||
| link="${html_file#$html_dir/}" | ||
| printf '<li><a href="%s">%s</a></li>\n' "$link" "$link" | ||
| done < <(find "$html_dir" -maxdepth 1 -type f -name '*.html' ! -name 'reports.html' -print0 | sort -z) | ||
| printf '</ul>\n' | ||
| printf '</body>\n' | ||
| printf '</html>\n' | ||
| } > "$index_file" | ||
|
|
||
| if [ -n "${GITHUB_STEP_SUMMARY:-}" ]; then | ||
| { | ||
| printf '## CodeQL HTML report\n\n' | ||
| printf '| Metric | Result |\n' | ||
| printf '|------|------|\n' | ||
| printf '| Language | %s |\n' '${{ matrix.language }}' | ||
| printf '| HTML files | %s |\n' "$html_count" | ||
| printf '| Artifact | codeql-full-html-%s |\n' '${{ matrix.language }}' | ||
| } >> "$GITHUB_STEP_SUMMARY" | ||
| fi | ||
|
|
||
| printf 'html_count=%s\n' "$html_count" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Upload CodeQL SARIF report | ||
| if: always() | ||
| uses: actions/upload-artifact@v7 | ||
| with: | ||
| name: codeql-full-sarif-${{ matrix.language }} | ||
| path: codeql-sarif | ||
| if-no-files-found: error | ||
| retention-days: 30 | ||
|
|
||
| - name: Upload CodeQL HTML report | ||
| if: ${{ always() && hashFiles('codeql-html-report/**/*.html') != '' }} | ||
| uses: actions/upload-artifact@v7 | ||
| with: | ||
| name: codeql-full-html-${{ matrix.language }} | ||
| path: codeql-html-report | ||
| if-no-files-found: error | ||
| retention-days: 30 | ||
|
|
||
| - name: Check CodeQL findings | ||
| if: always() | ||
| shell: bash | ||
| env: | ||
| SARIF_COUNT: ${{ steps.sarif-summary.outputs.sarif_count }} | ||
| INVALID_SARIF: ${{ steps.sarif-summary.outputs.invalid_sarif }} | ||
| VIOLATIONS: ${{ steps.sarif-summary.outputs.violations }} | ||
| run: | | ||
| sarif_count="${SARIF_COUNT:-0}" | ||
| invalid_sarif="${INVALID_SARIF:-0}" | ||
| violations="${VIOLATIONS:-0}" | ||
|
|
||
| if [[ "$sarif_count" -eq 0 ]]; then | ||
| echo "::error::CodeQL did not produce a SARIF report." | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [[ "$invalid_sarif" -ne 0 ]]; then | ||
| echo "::error::CodeQL produced $invalid_sarif invalid SARIF report(s)." | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [[ "$violations" -ne 0 ]]; then | ||
| echo "::error::CodeQL found $violations result(s)." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "CodeQL found no results." |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift
🔎 Supported by static analysis
🏁 Script executed:
Repository: opentiny/tiny-engine-backend-java
Length of output: 19384
🏁 Script executed:
Repository: opentiny/tiny-engine-backend-java
Length of output: 6174
🌐 Web query:
GitHub CodeQL workflow configuration paths-ignore compiled languages build mode autobuild Java generated sources💡 Result:
In GitHub CodeQL, handling generated sources and ignoring specific paths in compiled languages (such as Java) differs significantly depending on the chosen build mode. The standard
pathsandpaths-ignoreworkflow configuration filters (used foron:pull_requestandon:push) only control when a workflow is triggered; they do not instruct the CodeQL extractor to ignore files during the analysis build process [1][2]. Build Modes and Generated Sources For compiled languages, CodeQL analyzes all code built during the workflow execution [2]. Consequently, if you usebuild-mode: autobuildorbuild-mode: manual, the resulting CodeQL database will include any generated sources that were compiled by your build system [3][2]. 1. If usingbuild-mode: autobuild: The autobuilder automatically detects and runs your build system (e.g., Maven, Gradle) [4][5]. Because it executes the entire build process, it inherently includes all generated code [2]. To ignore specific paths, you must transition away from autobuild to a manual build [6][2]. 2. If usingbuild-mode: manual: This is the recommended approach for excluding generated sources [2]. You must explicitly define your build steps in the workflow using a run block [7][3]. By crafting your build commands to avoid compiling the generated source directories, you effectively prevent those files from being included in the CodeQL database [6][2]. 3. If usingbuild-mode: none: For Java, you can choosebuild-mode: noneto generate a database directly from the source code without building [3][5]. In this specific mode, you can utilize CodeQL configuration files to applypathsandpaths-ignorefilters to restrict which files are extracted for analysis [1][2]. Note that this mode is best suited for scenarios where a build is not strictly required for accurate analysis [3]. Summary of Recommendations - For Projects with Complex Builds: Replaceautobuildwithmanualbuild steps and ensure your build commands explicitly exclude generated source directories [2]. - For Projects where a Build is Unnecessary: Switch tobuild-mode: noneto leverage configuration-based file filtering [1][3]. - Trigger Control vs. Analysis Control: Ensure you distinguish between workflow trigger filters (at the top level of the YAML) and analysis extraction filters (available fornonebuild mode or through custom build commands) [1][2].Citations:
Exclude generated Java sources through the build, not
paths-ignore. The full matrix usesbuild-mode: autobuild, and the workflow compiles the Maven project withmvn ... test-compile. CodeQL can include generated sources compiled during built-language analysis. Iftarget/**contains generated Java sources that must be excluded, use a build configuration that omits them.🤖 Prompt for AI Agents