Enhance Spotbugs parametrization and sarif output #1 #2
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
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 |
|---|---|---|
| @@ -1,16 +1,106 @@ | ||
| #!/bin/bash | ||
|
|
||
| # set com.example.demo and all chid packages (.- means all children, .* this package only) | ||
| # PACKAGES="com.example.demo.-" | ||
| # source path to prepend to the class path | ||
| # BASEPATH="src/main/java" | ||
| # DEPENDENCIES_PATH="~/.m2" | ||
| # OUTPUT_TYPE="sarif" | ||
|
|
||
| # Check whether to use latest version of PMD | ||
| if [ "$SPOTBUGS_VERSION" == 'latest' ] || [ "$SPOTBUGS_VERSION" == "" ]; then | ||
| LATEST_TAG="$(curl -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/spotbugs/spotbugs/releases/latest | jq --raw-output '.tag_name')" | ||
| SPOTBUGS_VERSION=$LATEST_TAG | ||
| fi | ||
|
|
||
| # Download SpotBugs | ||
| wget -q -N https://github.com/spotbugs/spotbugs/releases/download/"${SPOTBUGS_VERSION}"/spotbugs-"${SPOTBUGS_VERSION}".zip | ||
|
There was a problem hiding this comment. This change serves to avoid a too long log that is not related to the actual SAST review |
||
| unzip -q -o spotbugs-"${SPOTBUGS_VERSION}".zip | ||
|
|
||
| # Run SpotBugs | ||
| SPOTBUGS_HOME=spotbugs-"${SPOTBUGS_VERSION}" | ||
| SPOTBUGS=${SPOTBUGS_HOME}/bin/spotbugs | ||
|
|
||
| #sh $SPOTBUGS -textui -output "${OUTPUT}" "${ARGUMENTS}" "${TARGET}" | ||
|
|
||
| # Take care of parameter order, sometimes does not work if you change it | ||
|
|
||
| CMD="java -Xmx1900M -Dlog4j2.formatMsgNoLookups=true \ | ||
|
There was a problem hiding this comment. Here we start building the SpotBugs command line depending on the provided parameters |
||
| -jar ${SPOTBUGS_HOME}/lib/spotbugs.jar -textui " | ||
|
|
||
| if [ "$PACKAGES" != "" ]; then | ||
| CMD="$CMD -onlyAnalyze ${PACKAGES}" | ||
| fi | ||
|
|
||
| CMD="$CMD -quiet -effort:max -low -noClassOk" | ||
|
|
||
| case $OUTPUT_TYPE in | ||
| "xml") | ||
| if [ "$OUTPUT" == "" ]; then | ||
| OUTPUT="results.xml" | ||
| fi | ||
| CMD="$CMD -xml:withMessages=./$OUTPUT" | ||
| ;; | ||
| "html") | ||
| if [ "$OUTPUT" == "" ]; then | ||
| OUTPUT="results.html" | ||
| fi | ||
| CMD="$CMD -html:withMessages=./$OUTPUT" | ||
| ;; | ||
| "emacs") | ||
| if [ "$OUTPUT" == "" ]; then | ||
| OUTPUT="results.emacs" | ||
| fi | ||
| CMD="$CMD -emacs:withMessages=./$OUTPUT" | ||
| ;; | ||
| "xdocs") | ||
| if [ "$OUTPUT" == "" ]; then | ||
| OUTPUT="results.xdocs" | ||
| fi | ||
| CMD="$CMD -xdoc:withMessages=./$OUTPUT" | ||
| ;; | ||
| *) | ||
| OUTPUT_TYPE="sarif" | ||
| if [ "$OUTPUT" == "" ]; then | ||
| OUTPUT="results.sarif" | ||
| fi | ||
| CMD="$CMD -sarif:withMessages=./resultspre.sarif" | ||
| ;; | ||
| esac | ||
|
|
||
| if [ "$DEPENDENCIES_PATH" != "" ]; then | ||
| DEP_CMD="find ${DEPENDENCIES_PATH} -name \"*.jar\" -type f > /tmp/jardependencies.txt" | ||
| echo "Scanning jars with: ${DEP_CMD}" | ||
| eval ${DEP_CMD} | ||
| CMD="$CMD -auxclasspathFromFile /tmp/jardependencies.txt" | ||
| fi | ||
|
|
||
| if [ "$BASE_PATH" != "" ]; then | ||
| if [[ "$BASE_PATH" != */ ]]; then | ||
| BASE_PATH="$BASE_PATH/" | ||
| fi | ||
| # using sourcepath does not work for GitHub's sarif parser | ||
| # but keeping there just in case | ||
| CMD="$CMD -sourcepath ${BASE_PATH}" | ||
| fi | ||
|
|
||
| if [ "$ARGUMENTS" != "" ]; then | ||
| CMD="$CMD ${ARGUMENTS}" | ||
| fi | ||
|
|
||
| if [ "$TARGET" != "" ]; then | ||
| CMD="$CMD ${TARGET}" | ||
| else | ||
| CMD="$CMD ." | ||
| fi | ||
|
|
||
| echo "Running SpotBugs with command: $CMD" | ||
|
|
||
| eval ${CMD} | ||
|
|
||
| if [ "$OUTPUT_TYPE" == "sarif" ] && [ "$BASE_PATH" != "" ]; then | ||
| # prepend the pyhsical path | ||
| echo "Transform sarif file to include the physical path" | ||
| jq -c "(.runs[].results[].locations[].physicalLocation.artifactLocation.uri) |=\"$BASE_PATH\"+." resultspre.sarif > "$OUTPUT" | ||
|
There was a problem hiding this comment. This is needed to provide compatibility with the GitHub SARIF parser that needs the base path as a prefix (typically src/main/java) |
||
| fi | ||
|
|
||
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.
This way the default behavior downloads the latest version