Compare commits

..
3 Commits
Author SHA1 Message Date
james.maes 0eab936d85 fix(static_analysis): use mvn install for multi-module dependency resolution
Static analysis needs artifacts in local repo for inter-module deps.
2026-01-14 13:58:26 -06:00
james.maes 04888150fd build: cleaned up linting errors 2026-01-14 13:58:26 -06:00
james.maes 43fcfe1213 feat(orb): added spotbugs and pmd workflows 2026-01-14 13:58:26 -06:00
8 changed files with 214 additions and 0 deletions

No files matched your search

@@ -0,0 +1,9 @@
description: >
Collects SpotBugs and PMD reports from all modules into a central
location for artifact storage. Generates a summary report.
steps:
- run:
name: Collect Static Analysis Reports
command: <<include(scripts/collect_static_analysis_reports.sh)>>
when: always
+17
View File
@@ -0,0 +1,17 @@
description: >
Runs PMD static analysis on Maven project.
Detects code quality issues, potential bugs, and style violations.
Requires maven-pmd-plugin configured in project pom.xml.
parameters:
fail_on_violation:
type: boolean
default: false
description: "Fail the build if PMD finds violations"
steps:
- run:
name: Run PMD Analysis
environment:
PMD_FAIL_ON_VIOLATION: << parameters.fail_on_violation >>
command: <<include(scripts/mvn_pmd.sh)>>
+18
View File
@@ -0,0 +1,18 @@
description: >
Runs SpotBugs static analysis on Maven project.
Reports potential bugs including null pointer issues, resource leaks,
and security vulnerabilities (via FindSecBugs plugin).
Requires spotbugs-maven-plugin configured in project pom.xml.
parameters:
fail_on_error:
type: boolean
default: false
description: "Fail the build if SpotBugs finds bugs"
steps:
- run:
name: Run SpotBugs Analysis
environment:
SPOTBUGS_FAIL_ON_ERROR: << parameters.fail_on_error >>
command: <<include(scripts/mvn_spotbugs.sh)>>
+72
View File
@@ -0,0 +1,72 @@
description: >
Runs SpotBugs and PMD static analysis on a Maven project.
This job is designed to be used in an optional workflow triggered
by tag (static-analysis/*) or pipeline parameter.
Usage in consuming repo:
workflows:
static_analysis:
when:
or:
- matches:
pattern: "^static-analysis/.*"
value: << pipeline.git.tag >>
- equal: [true, << pipeline.parameters.run_static_analysis >>]
jobs:
- qqq-orb/static_analysis
executor: java
parameters:
java_version:
type: string
default: "21"
description: "Java major version to install"
fail_on_spotbugs:
type: boolean
default: false
description: "Fail the build if SpotBugs finds bugs"
fail_on_pmd:
type: boolean
default: false
description: "Fail the build if PMD finds violations"
run_spotbugs:
type: boolean
default: true
description: "Run SpotBugs analysis"
run_pmd:
type: boolean
default: true
description: "Run PMD analysis"
steps:
- install_java:
java_version: << parameters.java_version >>
- git_full_checkout
- run:
name: Setup Maven Settings
command: <<include(scripts/setup_maven_settings.sh)>>
- restore_cache:
keys:
- v1-dependencies-{{ checksum "pom.xml" }}
- run:
name: Build and Install for Analysis
command: <<include(scripts/mvn_install_for_analysis.sh)>>
- save_cache:
paths:
- ~/.m2
key: v1-dependencies-{{ checksum "pom.xml" }}
- when:
condition: << parameters.run_spotbugs >>
steps:
- mvn_spotbugs:
fail_on_error: << parameters.fail_on_spotbugs >>
- when:
condition: << parameters.run_pmd >>
steps:
- mvn_pmd:
fail_on_violation: << parameters.fail_on_pmd >>
- collect_static_analysis_reports
- store_artifacts:
path: /home/circleci/static-analysis-reports
destination: static-analysis
@@ -0,0 +1,46 @@
#!/bin/bash
# Collect SpotBugs and PMD reports to a central location for artifacts
REPORT_DIR="/home/circleci/static-analysis-reports"
mkdir -p "$REPORT_DIR/spotbugs" "$REPORT_DIR/pmd"
echo "Collecting static analysis reports..."
# Collect SpotBugs reports
find . -name "spotbugsXml.xml" -exec sh -c '
MODULE=$(dirname "$1" | sed "s|^\./||;s|/target.*||" | tr "/" "_")
cp "$1" "'"$REPORT_DIR/spotbugs"'/${MODULE}_spotbugs.xml" 2>/dev/null || true
' _ {} \;
# Collect PMD reports
find . -name "pmd.xml" -exec sh -c '
MODULE=$(dirname "$1" | sed "s|^\./||;s|/target.*||" | tr "/" "_")
cp "$1" "'"$REPORT_DIR/pmd"'/${MODULE}_pmd.xml" 2>/dev/null || true
' _ {} \;
# Generate combined summary
{
echo "=== Static Analysis Report Summary ==="
echo "Generated: $(date)"
echo ""
echo "SpotBugs:"
} > "$REPORT_DIR/summary.txt"
find "$REPORT_DIR/spotbugs" -name "*.xml" 2>/dev/null | while read -r f; do
MODULE=$(basename "$f" _spotbugs.xml)
COUNT=$(grep -c "<BugInstance" "$f" 2>/dev/null || echo "0")
echo " $MODULE: $COUNT bugs" >> "$REPORT_DIR/summary.txt"
done
echo "" >> "$REPORT_DIR/summary.txt"
echo "PMD:" >> "$REPORT_DIR/summary.txt"
find "$REPORT_DIR/pmd" -name "*.xml" 2>/dev/null | while read -r f; do
MODULE=$(basename "$f" _pmd.xml)
COUNT=$(grep -c "<violation" "$f" 2>/dev/null || echo "0")
echo " $MODULE: $COUNT violations" >> "$REPORT_DIR/summary.txt"
done
cat "$REPORT_DIR/summary.txt"
echo ""
echo "Reports collected to: $REPORT_DIR"
+6
View File
@@ -0,0 +1,6 @@
#!/bin/bash
set -e
echo "Building and installing project for static analysis..."
mvn install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true
echo "Build complete - artifacts installed to local repository"
+23
View File
@@ -0,0 +1,23 @@
#!/bin/bash
set -e
echo "Running PMD static analysis..."
# Default to report-only mode unless PMD_FAIL_ON_VIOLATION is set
FAIL_FLAG=""
if [ "${PMD_FAIL_ON_VIOLATION}" = "true" ]; then
FAIL_FLAG="-Dpmd.failOnViolation=true"
fi
# Run PMD
mvn pmd:check -DskipTests ${FAIL_FLAG} 2>&1 | tee /tmp/pmd-output.txt
# Summarize results
echo ""
echo "=== PMD Summary ==="
find . -name "pmd.xml" -exec sh -c '
MODULE=$(dirname "$1" | sed "s|^\./||;s|/target.*||")
COUNT=$(grep -c "<violation" "$1" 2>/dev/null || echo "0")
echo " $MODULE: $COUNT violations"
' _ {} \; 2>/dev/null | sort || true
echo "==================="
+23
View File
@@ -0,0 +1,23 @@
#!/bin/bash
set -e
echo "Running SpotBugs static analysis..."
# Default to report-only mode unless SPOTBUGS_FAIL_ON_ERROR is set
FAIL_FLAG=""
if [ "${SPOTBUGS_FAIL_ON_ERROR}" = "true" ]; then
FAIL_FLAG="-Dspotbugs.failOnError=true"
fi
# Run SpotBugs
mvn spotbugs:check -DskipTests ${FAIL_FLAG} 2>&1 | tee /tmp/spotbugs-output.txt
# Summarize results
echo ""
echo "=== SpotBugs Summary ==="
find . -name "spotbugsXml.xml" -exec sh -c '
MODULE=$(dirname "$1" | sed "s|^\./||;s|/target.*||")
COUNT=$(grep -c "<BugInstance" "$1" 2>/dev/null || echo "0")
echo " $MODULE: $COUNT bugs"
' _ {} \; 2>/dev/null | sort || true
echo "========================"