-
Notifications
You must be signed in to change notification settings - Fork 89
fix:multiple CodeQL scan issues #328
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
msslulu
wants to merge
32
commits into
opentiny:develop
Choose a base branch
from
msslulu:fix-codeql-scanning
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
32 commits
Select commit
Hold shift + click to select a range
c2f63de
fix:codeql scan
msslulu 2a05919
fix:codeql scan
msslulu 1746057
fix:codeql scan
msslulu 03e143f
fix:codeql scan
msslulu b324c37
fix:codeql scan
msslulu ceb3717
fix:codeql scan
msslulu bcb7ee0
Merge pull request #2 from msslulu/code-scanning
msslulu fe1a54c
fix:codeql scan
msslulu 82fdc15
fix:codeql scan
msslulu a09a635
fix:codeql scan
msslulu b1087fc
fix:codeql scan
msslulu c919e36
fix:codeql scan
msslulu 8310dac
Merge pull request #3 from msslulu/code-scanning
msslulu 93ed667
fix:codeql scan
msslulu 2d512ec
Merge pull request #4 from msslulu/code-scanning
msslulu 5673da3
fix:codeql scan
msslulu 06e73eb
Merge pull request #5 from msslulu/code-scanning
msslulu 96457c5
fix:codeql scan
msslulu 0e8a488
Merge pull request #6 from msslulu/code-scanning
msslulu 84d2d55
fix:codeql scan Security issue
msslulu 1870d90
fix:codeql scan Security issue
msslulu 1e654c6
fix:codeql scan Security issue
msslulu 320d46e
fix:codeql scan Security issue
msslulu 9af2034
fix:codeql scan Security issue
msslulu 81b04c8
fix:codeql scan Security issue
msslulu c7c8686
fix:codeql scan Security issue
msslulu cd4ac3d
fix:codeql scan Security issue
msslulu 1573d3e
fix:codeql scan Security issue
msslulu 23f513f
fix:codeql scan Security issue
msslulu 950f477
fix:codeql scan Security issue
msslulu c88bd7b
fix:codeql scan Security issue
msslulu 1717e83
fix:codeql scan Security issue
msslulu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 . >/dev/null | ||
| } | ||
|
|
||
| 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,221 @@ | ||
| 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 }} | ||
|
|
||
| - 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 | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
Repository: opentiny/tiny-engine-backend-java
Length of output: 231
🏁 Script executed:
Repository: opentiny/tiny-engine-backend-java
Length of output: 25924
🤖 get_repo_knowledge executed:
get_repo_knowledge opentiny/tiny-engine-backend-java /tmp/coderabbit-repo-knowledge/opentiny-tiny-engine-backend-java-1b9e840dLength of output: 410
🏁 Script executed:
Repository: opentiny/tiny-engine-backend-java
Length of output: 5974
🌐 Web query:
Apache Maven reactor behavior when invoking a non-aggregator plugin goal from an aggregator POM with modules, and maven-checkstyle-plugin check/checkstyle goal reactor execution💡 Result:
In Apache Maven, the behavior of a plugin goal when invoked from an aggregator POM (a project with modules) depends on whether the goal is marked as an aggregator via the
@aggregatorannotation [1][2]. Non-Aggregator Goals: When a standard (non-aggregator) plugin goal is invoked from the command line in a multi-module reactor, Maven executes the goal for every project in the reactor [3][4]. If you want to restrict such a goal to only execute on the root POM, you can use the command-line flag -non-recursive [5][4]. Alternatively, setting the false configuration in your POM can prevent the plugin from being inherited by child modules, though this affects how the plugin is applied during the build lifecycle [3]. Aggregator Goals: Goals explicitly marked with the@aggregatorannotation are designed to be executed only once, typically at the root of the project structure, and have access to the full list of reactor projects [1][2]. When an aggregator goal is invoked, it is intended to summarize or aggregate information across the reactor [1][2]. Maven Checkstyle Plugin Behavior: The maven-checkstyle-plugin provides specific goals to handle different aggregation requirements: 1. checkstyle:check: This is a standard (non-aggregator) goal that performs analysis on the current project [6][7]. When run in a multi-module project, it executes on each module individually [8]. If bound to the lifecycle (e.g., verify), it executes as part of the standard build for each module [8]. 2. checkstyle:checkstyle-aggregate: This is an aggregator goal specifically designed to perform analysis across the entire reactor and generate a single, aggregate report [7][9]. In summary, if you wish to run a Checkstyle check across your entire project from the root without triggering it on every individual module, you should use an aggregator-specific goal if available, or use the --non-recursive command-line flag if you intend to limit a standard goal to the aggregator POM only [5][7][4].Citations:
Restrict both Checkstyle invocations to
$module. The root aggregator POM runscheckstyle:checkandcheckstyle:checkstyleforbaseandapp. Each loop iteration therefore applies one module'sfile_listto the entire reactor and can overwrite other modules' reports. Add-pl "$module"to both commands or invoke the module POM.🤖 Prompt for AI Agents