Compare commits

...
21 Commits
Author SHA1 Message Date
james.maes 6514aaa688 Merge pull request #8 from QRun-IO/develop
fix(ci): remove legacy tag-based publish workflow
2026-01-31 18:46:54 -06:00
james.maes c561e4d290 fix(ci): remove legacy tag-based publish workflow 2026-01-31 18:43:52 -06:00
james.maes 3ac47adc21 Merge pull request #7 from QRun-IO/develop
Release: auto-publish pipelines and security scanning
2026-01-31 18:40:34 -06:00
james.maes 8d7f645c0e fix(ci): pass CIRCLE_TOKEN to orb publish commands 2026-01-31 18:34:39 -06:00
james.maes 9285f2d842 fix(ci): use circleci-cli image for orb publish jobs 2026-01-31 18:33:07 -06:00
james.maes f4e1536d77 Merge pull request #6 from QRun-IO/feature/security-scan-job
ci: auto-publish orb on develop and main pushes
2026-01-31 18:04:35 -06:00
james.maes 8d1b353fe2 docs: update readme and changelog for auto-publish and security scan 2026-01-31 18:01:53 -06:00
james.maes d24b7d131f ci: auto-publish orb on develop and main pushes
develop pushes publish dev:snapshot, main pushes auto-increment
patch version with [minor]/[major] commit keyword support.
2026-01-31 17:55:05 -06:00
james.maes 184b7c54e9 feat(security): add security_scan job with Gitleaks, Semgrep, OWASP, and CycloneDX
Adds a new security_scan job with four tools (all report-only by default),
configurable fail gates, and aggregated artifact collection.
2026-01-31 10:34:16 -06:00
james.maes 2471f5adff docs: update changelog and readme for v0.6.2 2026-01-30 11:14:20 -06:00
james.maes 546bf38a0b Merge branch 'develop' 2026-01-30 11:11:22 -06:00
james.maes ab841b2ddd fix(node): handle empty CIRCLE_BRANCH in version commit
Aligned node_version_commit.sh with Maven equivalent: added feature
branch skip, empty branch fallback, and non-fatal push handling.
2026-01-30 11:10:57 -06:00
james.maes 3b3d80188d docs: update changelog and readme for v0.6.1 2026-01-21 12:17:16 -06:00
james.maes 5271b5bfa5 Merge branch 'develop' 2026-01-18 08:39:43 -06:00
james.maes d3e1891725 fix: skip version commit for feature branches 2026-01-18 08:12:52 -06:00
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
james.maes fec302d58d 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:47:34 -06:00
james.maes dabfcce4ad build: cleaned up linting errors 2026-01-14 13:30:15 -06:00
james.maes 3ffe371af2 feat(orb): added spotbugs and pmd workflows 2026-01-14 13:27:07 -06:00
30 changed files with 931 additions and 42 deletions

No files matched your search

+74 -17
View File
@@ -12,12 +12,14 @@ filters: &filters
tags:
only: /.*/
# Filter for release tags.
release-filters: &release-filters
# Auto-publish filters.
develop-filters: &develop-filters
branches:
ignore: /.*/
tags:
only: /^v[0-9]+\.[0-9]+\.[0-9]+$/
only: [develop]
main-filters: &main-filters
branches:
only: [main]
jobs:
# Create jobs to test the commands of your orbs.
@@ -29,6 +31,64 @@ jobs:
- checkout
# Run your orb's commands to validate them.
- qqq-orb/install_asciidoctor
publish-dev-snapshot:
docker:
- image: circleci/circleci-cli:latest
steps:
- checkout
- run:
name: Pack and Publish Dev Snapshot
command: |
circleci orb pack src > /tmp/orb.yml
circleci orb validate /tmp/orb.yml
circleci orb publish --token "${CIRCLE_TOKEN}" /tmp/orb.yml kingsrook/qqq-orb@dev:snapshot
echo "Published kingsrook/qqq-orb@dev:snapshot"
publish-production:
docker:
- image: circleci/circleci-cli:latest
steps:
- checkout
- add_ssh_keys
- run:
name: Calculate Next Version and Publish
command: |
git fetch --tags
LATEST=$(git tag -l 'v*' | sort -V | tail -1)
LATEST=${LATEST:-v0.0.0}
LATEST_CLEAN=${LATEST#v}
# Check recent commit messages for bump keywords
BUMP="patch"
COMMITS=$(git log "${LATEST}..HEAD" --pretty=%s 2>/dev/null || git log --pretty=%s -10)
if echo "${COMMITS}" | grep -qi '\[major\]'; then
BUMP="major"
elif echo "${COMMITS}" | grep -qi '\[minor\]'; then
BUMP="minor"
fi
IFS='.' read -r MAJOR MINOR PATCH \<<< "${LATEST_CLEAN}"
case "${BUMP}" in
major) MAJOR=$((MAJOR + 1)); MINOR=0; PATCH=0 ;;
minor) MINOR=$((MINOR + 1)); PATCH=0 ;;
patch) PATCH=$((PATCH + 1)) ;;
esac
VERSION="${MAJOR}.${MINOR}.${PATCH}"
echo "Latest: ${LATEST} | Bump: ${BUMP} | Next: ${VERSION}"
circleci orb pack src > /tmp/orb.yml
circleci orb validate /tmp/orb.yml
circleci orb publish --token "${CIRCLE_TOKEN}" /tmp/orb.yml "kingsrook/qqq-orb@${VERSION}"
git config user.email "ci@qrun.io"
git config user.name "CircleCI"
git tag -a "v${VERSION}" -m "Release v${VERSION}"
git push origin "v${VERSION}"
echo "Published kingsrook/qqq-orb@${VERSION}"
workflows:
test-deploy:
jobs:
@@ -36,16 +96,13 @@ workflows:
# Test your orb's commands in a custom job and test your orb's jobs directly as a part of this workflow.
- command-test:
filters: *filters
# The orb must be re-packed for publishing, and saved to the workspace.
- orb-tools/pack:
filters: *release-filters
- orb-tools/publish:
orb_name: kingsrook/qqq-orb
vcs_type: << pipeline.project.type >>
pub_type: production
# Ensure this job requires all test jobs and the pack job.
requires:
- orb-tools/pack
- command-test
# Auto-publish dev snapshot on develop
- publish-dev-snapshot:
context: orb-publishing
filters: *release-filters
filters: *develop-filters
requires: [command-test]
# Auto-publish production release on main
- publish-production:
context: orb-publishing
filters: *main-filters
requires: [command-test]
+39 -2
View File
@@ -5,12 +5,49 @@ All notable changes to QQQ Orb will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- Auto-publish `dev:snapshot` on develop branch pushes
- Auto-publish production releases on main branch pushes with semantic version bumping
- Support for `[major]` and `[minor]` commit keywords to control version bumps (default: patch)
- Security scanning job with Gitleaks, Semgrep, OWASP Dependency Check, and CycloneDX SBOM
## [0.6.2] - 2026-01-30
### Fixed
- Node.js version commit fails with `invalid refspec 'HEAD:'` when `CIRCLE_BRANCH` is empty (detached HEAD builds)
- Aligned `node_version_commit.sh` with Maven equivalent: added feature branch skip, empty branch fallback, and non-fatal push handling
## [0.6.1] - 2026-01-18
### Fixed
- Skip version commit for feature branches (prevents unnecessary commits)
## [0.6.0] - 2026-01-14
### Added
- SpotBugs and PMD static analysis workflows
### Fixed
- Use `mvn install` for multi-module dependency resolution in static analysis
## [0.5.3] - 2026-01-10
### Fixed
- NPM prerelease tags now correctly formatted
- Skip GitHub release creation for release candidates
## [0.5.2] - 2026-01-09
### Fixed
- Version commit push failures no longer fail the build (moved from 0.5.1 notes)
- Strip `<rerunFailure>` elements from JUnit XML (moved from 0.5.1 notes)
## [0.5.1] - 2026-01-07
### Fixed
- Added `DEBIAN_FRONTEND=noninteractive` to browser dependency installation to prevent interactive prompts from blocking CI
- Strip `<rerunFailure>` elements from JUnit XML before upload to fix CircleCI test result parsing errors
- Version commit push failures no longer fail the build (handles race conditions between concurrent builds)
## [0.5.0] - 2025-12-28
+17 -8
View File
@@ -3,7 +3,7 @@
CircleCI orb for QQQ framework projects.
**For:** Teams using CircleCI to build, test, and publish QQQ applications
**Status:** Stable (v0.5.0)
**Status:** Stable (v0.6.x)
## Why This Exists
@@ -29,7 +29,7 @@ This orb provides pre-built jobs for the complete QQQ development lifecycle. Add
# .circleci/config.yml
version: 2.1
orbs:
qqq-orb: kingsrook/qqq-orb@0.5
qqq-orb: kingsrook/qqq-orb@0.6
workflows:
build_and_test:
@@ -57,6 +57,8 @@ workflows:
| `mvn_frontend_publish` | Build, test, and publish Maven projects with npm frontend |
| `node_test_only` | Build and test Node.js projects |
| `node_publish` | Build, test, and publish Node.js packages |
| `static_analysis` | Run SpotBugs and PMD static analysis |
| `security_scan` | Run Gitleaks, Semgrep, OWASP Dependency Check, and CycloneDX SBOM |
### Branch Types
@@ -93,16 +95,23 @@ Maven jobs use machine executors with Docker pre-installed. Tests using Testcont
| `GPG_PASSPHRASE` | GPG passphrase |
| `GITHUB_TOKEN` | GitHub API token |
## Orb Publishing
The orb auto-publishes via CircleCI:
| Branch | Action |
|--------|--------|
| `develop` | Publishes `kingsrook/qqq-orb@dev:snapshot` |
| `main` | Auto-increments version and publishes production release |
| `vX.Y.Z` tag | Manual production release (legacy) |
Version bumps on main default to patch. Include `[minor]` or `[major]` in a commit message to bump accordingly.
## Project Status
**Maturity:** Stable, used across all QQQ repositories
**Breaking changes:** See [CHANGELOG.md](CHANGELOG.md)
**Roadmap:**
- GitHub Actions support
- Parallel test execution
- Container image publishing
## Contributing
```bash
@@ -115,4 +124,4 @@ See [QQQ Contribution Guidelines](https://github.com/Kingsrook/qqq/blob/develop/
## License
AGPL-3.0 - QRun-IO
Apache-2.0
@@ -0,0 +1,9 @@
description: >
Collects all security scan reports into a central location for artifact
storage. Generates a summary.txt with finding counts from each tool.
steps:
- run:
name: Collect Security Reports
command: <<include(scripts/collect_security_reports.sh)>>
when: always
@@ -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
+10 -1
View File
@@ -2,7 +2,14 @@ description: >
Git operations for version management
- Adds SSH keys for Git operations
- Sets up Git identity for version commits
- Commits version changes if modified
- Commits version changes if modified (skipped for feature branches)
parameters:
branch_type:
type: string
default: "snapshot"
description: "Branch type: snapshot, release_candidate, release, hotfix, or feature"
steps:
- add_ssh_keys # injects the CircleCI User Key (write-capable)
- run:
@@ -10,4 +17,6 @@ steps:
command: <<include(scripts/manage_version_git_config.sh)>>
- run:
name: Commit version change if modified
environment:
BRANCH_TYPE: << parameters.branch_type >>
command: <<include(scripts/manage_version_commit.sh)>>
+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)>>
+9 -1
View File
@@ -3,7 +3,13 @@ description: >
- Adds SSH keys for Git operations
- Sets up Git identity for version commits
- Synchronizes NPM version
- Commits version changes if modified
- Commits version changes if modified (skipped for feature branches)
parameters:
branch_type:
type: string
default: "snapshot"
description: "Branch type: snapshot, release_candidate, release, hotfix, or feature"
steps:
- add_ssh_keys # injects the CircleCI User Key (write-capable)
@@ -15,4 +21,6 @@ steps:
command: <<include(scripts/sync-npm-version.sh)>>
- run:
name: Commit version changes if modified
environment:
BRANCH_TYPE: << parameters.branch_type >>
command: <<include(scripts/node_version_commit.sh)>>
+9
View File
@@ -0,0 +1,9 @@
description: >
Generates a CycloneDX Software Bill of Materials (SBOM) in JSON format.
Uses the CycloneDX Maven plugin to produce an aggregate BOM across all
modules. No pom.xml changes required -- runs as a CLI Maven goal.
steps:
- run:
name: Generate CycloneDX SBOM
command: <<include(scripts/run_cyclonedx_sbom.sh)>>
+17
View File
@@ -0,0 +1,17 @@
description: >
Runs Gitleaks secret detection scan on the repository.
Detects hardcoded secrets, API keys, passwords, and tokens in source code
and git history. Reports findings in JSON format.
parameters:
fail_on_findings:
type: boolean
default: false
description: "Fail the build if Gitleaks detects secrets"
steps:
- run:
name: Run Gitleaks Secret Detection
environment:
GITLEAKS_FAIL_ON_FINDINGS: << parameters.fail_on_findings >>
command: <<include(scripts/run_gitleaks.sh)>>
@@ -0,0 +1,32 @@
description: >
Runs OWASP Dependency-Check to scan project dependencies for known CVEs.
Uses the dependency-check-maven plugin as a CLI goal (no pom.xml changes needed).
Includes retry logic (3 attempts) for NVD database download reliability.
Supports NVD API key for faster database updates via NVD_API_KEY env var.
parameters:
fail_on_cvss:
type: boolean
default: false
description: "Fail the build if vulnerabilities exceed the CVSS threshold"
cvss_threshold:
type: string
default: "7"
description: "CVSS score threshold (0-10). Vulnerabilities at or above this score are flagged."
steps:
- restore_cache:
keys:
- v1-owasp-nvd-cache-{{ .Branch }}
- v1-owasp-nvd-cache-
- run:
name: Run OWASP Dependency-Check
environment:
OWASP_FAIL_ON_CVSS: << parameters.fail_on_cvss >>
OWASP_CVSS_THRESHOLD: << parameters.cvss_threshold >>
command: <<include(scripts/run_owasp_dependency_check.sh)>>
no_output_timeout: 30m
- save_cache:
paths:
- ~/.m2/repository/org/owasp
key: v1-owasp-nvd-cache-{{ .Branch }}-{{ epoch }}
+22
View File
@@ -0,0 +1,22 @@
description: >
Runs Semgrep SAST (Static Application Security Testing) analysis.
Scans source code for security vulnerabilities, code quality issues,
and OWASP Top 10 patterns. Produces JSON and SARIF reports.
parameters:
fail_on_findings:
type: boolean
default: false
description: "Fail the build if Semgrep finds security issues"
rulesets:
type: string
default: "p/java p/owasp-top-ten p/security-audit"
description: "Space-separated list of Semgrep rulesets to run"
steps:
- run:
name: Run Semgrep SAST Analysis
environment:
SEMGREP_FAIL_ON_FINDINGS: << parameters.fail_on_findings >>
SEMGREP_RULESETS: << parameters.rulesets >>
command: <<include(scripts/run_semgrep.sh)>>
+10 -1
View File
@@ -1,6 +1,7 @@
description: >
Complete CI/CD workflow example for Maven-based projects using GitFlow branching strategy.
This example demonstrates how to use the qqq-orb for automated building, testing, and releasing.
This example demonstrates how to use the qqq-orb for automated building, testing, releasing,
and security scanning.
usage:
version: 2.1
@@ -72,3 +73,11 @@ usage:
branches:
only:
- /hotfix\/.*/
security_scan:
jobs:
- qqq-orb/security_scan:
context: [ qqq-maven-registry-credentials, qqq-security-credentials ]
filters:
branches:
only: [ develop ]
+4 -3
View File
@@ -1,7 +1,7 @@
description: >
Unified publishing job for all branch types with frontend
Handles version management, building, testing, and publishing based on branch type
Supports: snapshot, release_candidate, release, and hotfix workflows
Supports: snapshot, release_candidate, release, hotfix, and feature workflows
executor: java
@@ -17,7 +17,7 @@ parameters:
branch_type:
type: string
default: "snapshot"
description: "Branch type: snapshot, release_candidate, release, or hotfix"
description: "Branch type: snapshot, release_candidate, release, hotfix, or feature"
steps:
- install_java:
@@ -30,4 +30,5 @@ steps:
- frontend_test
- frontend_package
- mvn_jar_deploy
- git_operations
- git_operations:
branch_type: << parameters.branch_type >>
+2 -1
View File
@@ -50,7 +50,8 @@ steps:
not:
equal: [ "<< parameters.branch_type >>", "feature" ]
steps:
- git_operations
- git_operations:
branch_type: << parameters.branch_type >>
- when:
condition: << parameters.publish_asciidoc >>
+2 -1
View File
@@ -21,7 +21,8 @@ steps:
- git_full_checkout
- node_install_dependencies
- node_run_tests
- node_manage_version
- node_manage_version:
branch_type: << parameters.branch_type >>
- attach_workspace:
at: .
- node_build_package
+101
View File
@@ -0,0 +1,101 @@
description: >
Runs security scanning tools on a Maven project: Gitleaks (secret detection),
Semgrep (SAST), OWASP Dependency-Check (CVE scanning), and CycloneDX (SBOM).
All tools default to report-only mode. Use fail_on_* parameters to enforce gates.
Usage in consuming repo:
workflows:
security_scan:
jobs:
- qqq-orb/security_scan:
context: [qqq-maven-registry-credentials, qqq-security-credentials]
filters:
branches:
only: [develop]
executor: java
parameters:
java_version:
type: string
default: "21"
description: "Java major version to install"
run_gitleaks:
type: boolean
default: true
description: "Run Gitleaks secret detection"
run_semgrep:
type: boolean
default: true
description: "Run Semgrep SAST analysis"
run_owasp:
type: boolean
default: true
description: "Run OWASP Dependency-Check CVE scanning"
run_sbom:
type: boolean
default: true
description: "Run CycloneDX SBOM generation"
fail_on_gitleaks:
type: boolean
default: false
description: "Fail the build if Gitleaks finds secrets"
fail_on_semgrep:
type: boolean
default: false
description: "Fail the build if Semgrep finds security issues"
fail_on_owasp:
type: boolean
default: false
description: "Fail the build if OWASP finds CVEs above threshold"
semgrep_rulesets:
type: string
default: "p/java p/owasp-top-ten p/security-audit"
description: "Space-separated list of Semgrep rulesets"
owasp_cvss_threshold:
type: string
default: "7"
description: "CVSS score threshold for OWASP (0-10)"
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 Security Analysis
command: <<include(scripts/mvn_install_for_analysis.sh)>>
- save_cache:
paths:
- ~/.m2
key: v1-dependencies-{{ checksum "pom.xml" }}
- when:
condition: << parameters.run_gitleaks >>
steps:
- run_gitleaks:
fail_on_findings: << parameters.fail_on_gitleaks >>
- when:
condition: << parameters.run_semgrep >>
steps:
- run_semgrep:
fail_on_findings: << parameters.fail_on_semgrep >>
rulesets: << parameters.semgrep_rulesets >>
- when:
condition: << parameters.run_owasp >>
steps:
- run_owasp_dependency_check:
fail_on_cvss: << parameters.fail_on_owasp >>
cvss_threshold: << parameters.owasp_cvss_threshold >>
- when:
condition: << parameters.run_sbom >>
steps:
- run_cyclonedx_sbom
- collect_security_reports
- store_artifacts:
path: /home/circleci/security-reports
destination: security-reports
+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
+88
View File
@@ -0,0 +1,88 @@
#!/bin/bash
# Collect security scan reports to a central location for artifacts
REPORT_DIR="/home/circleci/security-reports"
mkdir -p "$REPORT_DIR/gitleaks" "$REPORT_DIR/semgrep" "$REPORT_DIR/owasp" "$REPORT_DIR/sbom"
echo "Collecting security scan reports..."
# Collect Gitleaks reports
if [ -f /tmp/gitleaks-report.json ]; then
cp /tmp/gitleaks-report.json "$REPORT_DIR/gitleaks/" 2>/dev/null || true
fi
# Collect Semgrep reports
if [ -f /tmp/semgrep-report.json ]; then
cp /tmp/semgrep-report.json "$REPORT_DIR/semgrep/" 2>/dev/null || true
fi
if [ -f /tmp/semgrep-report.sarif ]; then
cp /tmp/semgrep-report.sarif "$REPORT_DIR/semgrep/" 2>/dev/null || true
fi
# Collect OWASP Dependency-Check reports
if [ -f /tmp/owasp-dependency-check.json ]; then
cp /tmp/owasp-dependency-check.json "$REPORT_DIR/owasp/" 2>/dev/null || true
fi
if [ -f /tmp/owasp-dependency-check.html ]; then
cp /tmp/owasp-dependency-check.html "$REPORT_DIR/owasp/" 2>/dev/null || true
fi
# Collect CycloneDX SBOM
if [ -f /tmp/cyclonedx-sbom.json ]; then
cp /tmp/cyclonedx-sbom.json "$REPORT_DIR/sbom/" 2>/dev/null || true
fi
# Generate combined summary
{
echo "=== Security Scan Report Summary ==="
echo "Generated: $(date)"
echo ""
echo "Gitleaks (Secret Detection):"
if [ -f "$REPORT_DIR/gitleaks/gitleaks-report.json" ]; then
COUNT=$(python3 -c "import json; print(len(json.load(open('$REPORT_DIR/gitleaks/gitleaks-report.json'))))" 2>/dev/null || echo "unknown")
echo " Findings: ${COUNT}"
else
echo " Not run or no report"
fi
echo ""
echo "Semgrep (SAST):"
if [ -f "$REPORT_DIR/semgrep/semgrep-report.json" ]; then
COUNT=$(python3 -c "import json; r=json.load(open('$REPORT_DIR/semgrep/semgrep-report.json')); print(len(r.get('results', [])))" 2>/dev/null || echo "unknown")
echo " Findings: ${COUNT}"
else
echo " Not run or no report"
fi
echo ""
echo "OWASP Dependency-Check (CVEs):"
if [ -f "$REPORT_DIR/owasp/owasp-dependency-check.json" ]; then
COUNT=$(python3 -c "
import json
r = json.load(open('$REPORT_DIR/owasp/owasp-dependency-check.json'))
deps = r.get('dependencies', [])
vulns = sum(len(d.get('vulnerabilities', [])) for d in deps)
print(vulns)
" 2>/dev/null || echo "unknown")
echo " Vulnerabilities: ${COUNT}"
else
echo " Not run or no report"
fi
echo ""
echo "CycloneDX SBOM:"
if [ -f "$REPORT_DIR/sbom/cyclonedx-sbom.json" ]; then
COUNT=$(python3 -c "import json; r=json.load(open('$REPORT_DIR/sbom/cyclonedx-sbom.json')); print(len(r.get('components', [])))" 2>/dev/null || echo "unknown")
echo " Components: ${COUNT}"
else
echo " Not run or no report"
fi
echo ""
echo "==================================="
} > "$REPORT_DIR/summary.txt"
cat "$REPORT_DIR/summary.txt"
echo ""
echo "Reports collected to: $REPORT_DIR"
@@ -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"
+10
View File
@@ -20,6 +20,16 @@
set -e
################################################################
## Skip version commit for feature branches ##
## Feature versions are ephemeral (include commit hash) and ##
## don't need to be persisted back to the repository ##
################################################################
if [[ "$BRANCH_TYPE" == "feature" ]]; then
echo "Skipping version commit for feature branch (ephemeral versions)"
exit 0
fi
################################################################
## Check if pom.xml was modified and commit changes if needed ##
################################################################
+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 "========================"
+36 -7
View File
@@ -3,16 +3,17 @@
############################################################################
## node_version_commit.sh
## Node.js Version Commit Management Script
##
##
## This script handles committing version changes to Git for Node.js projects.
## It checks if the package.json file has been modified and commits the changes if needed.
## It also pushes the changes back to the current branch.
##
## Process:
## 1. Checks if package.json has been modified
## 2. Extracts the new version from package.json
## 3. Commits the changes with skip ci flag
## 4. Pushes changes to the current branch
## 1. Skips for feature branches (ephemeral versions)
## 2. Checks if package.json has been modified
## 3. Extracts the new version from package.json
## 4. Commits the changes with skip ci flag
## 5. Pushes changes to the current branch (non-fatal on failure)
##
## Usage: Called by node_manage_version command
## Output: Commits and pushes version changes if package.json was modified
@@ -20,13 +21,41 @@
set -e
################################################################
## Skip version commit for feature branches ##
## Feature versions are ephemeral and don't need to be ##
## persisted back to the repository ##
################################################################
if [[ "$BRANCH_TYPE" == "feature" ]]; then
echo "Skipping version commit for feature branch (ephemeral versions)"
exit 0
fi
################################################################
## Check if package.json was modified and commit if needed ##
################################################################
echo "Checking for package.json version changes"
if [[ -n "$(git status --porcelain package.json)" ]]; then
NEW_VERSION=$(grep '"version"' package.json | sed 's/.*"version": "//;s/".*//')
git add package.json
git commit -m "Bump version to $NEW_VERSION [skip ci]"
git push origin "HEAD:${CIRCLE_BRANCH}"
echo "Version updated to: $NEW_VERSION and pushed"
# Determine target branch
if [ -n "$CIRCLE_BRANCH" ]; then
TARGET_BRANCH="$CIRCLE_BRANCH"
else
TARGET_BRANCH="main"
fi
# Try to push, but don't fail the build if push fails
# This can happen if another build pushed first (race condition)
if git push origin "HEAD:${TARGET_BRANCH}"; then
echo "Version updated to: $NEW_VERSION and pushed to ${TARGET_BRANCH}"
else
echo "WARNING: Failed to push version commit to ${TARGET_BRANCH}"
echo "This is not fatal - version will be updated on next build"
echo "Common causes: concurrent builds, branch protection rules"
fi
else
echo "No version change needed"
fi
+38
View File
@@ -0,0 +1,38 @@
#!/bin/bash
set -e
echo "Generating CycloneDX SBOM..."
##################################
## Run CycloneDX Maven plugin ##
##################################
mvn -s /tmp/circleci/mvn-settings.xml \
--no-transfer-progress \
org.cyclonedx:cyclonedx-maven-plugin:2.9.1:makeAggregateBom \
-DskipTests \
-DoutputFormat=json \
-DoutputName=bom
##################################
## Collect SBOM output ##
##################################
echo ""
echo "=== CycloneDX SBOM Summary ==="
if [ -f target/bom.json ]; then
COMPONENTS=$(python3 -c "import json; r=json.load(open('target/bom.json')); print(len(r.get('components', [])))" 2>/dev/null || echo "unknown")
echo " Components: ${COMPONENTS}"
cp target/bom.json /tmp/cyclonedx-sbom.json
else
# Multi-module projects may output to different location
BOM_FILE=$(find . -name "bom.json" -path "*/target/*" | head -1)
if [ -n "${BOM_FILE}" ]; then
COMPONENTS=$(python3 -c "import json; r=json.load(open('${BOM_FILE}')); print(len(r.get('components', [])))" 2>/dev/null || echo "unknown")
echo " Components: ${COMPONENTS}"
cp "${BOM_FILE}" /tmp/cyclonedx-sbom.json
else
echo " No SBOM generated"
fi
fi
echo "==============================="
echo "CycloneDX SBOM generation complete"
+46
View File
@@ -0,0 +1,46 @@
#!/bin/bash
set -e
echo "Running Gitleaks secret detection..."
##################################
## Install Gitleaks binary ##
##################################
GITLEAKS_VERSION="8.21.2"
curl -sSfL "https://github.com/gitleaks/gitleaks/releases/download/v${GITLEAKS_VERSION}/gitleaks_${GITLEAKS_VERSION}_linux_x64.tar.gz" \
| tar -xz -C /tmp
chmod +x /tmp/gitleaks
##################################
## Run Gitleaks scan ##
##################################
EXIT_CODE=0
/tmp/gitleaks detect \
--source=. \
--report-format=json \
--report-path=/tmp/gitleaks-report.json \
--verbose \
|| EXIT_CODE=$?
##################################
## Summarize results ##
##################################
echo ""
echo "=== Gitleaks Summary ==="
if [ -f /tmp/gitleaks-report.json ]; then
COUNT=$(python3 -c "import json; print(len(json.load(open('/tmp/gitleaks-report.json'))))" 2>/dev/null || echo "unknown")
echo " Findings: ${COUNT}"
else
echo " Findings: 0"
fi
echo "========================="
##################################
## Handle fail_on flag ##
##################################
if [ "${GITLEAKS_FAIL_ON_FINDINGS}" = "true" ] && [ "${EXIT_CODE}" -ne 0 ]; then
echo "Gitleaks found secrets and fail_on_gitleaks is enabled. Failing build."
exit 1
fi
echo "Gitleaks scan complete (exit code: ${EXIT_CODE})"
+98
View File
@@ -0,0 +1,98 @@
#!/bin/bash
set -e
echo "Running OWASP Dependency-Check..."
##################################
## Build Maven command ##
##################################
MVN_CMD="mvn -s /tmp/circleci/mvn-settings.xml --no-transfer-progress"
MVN_CMD="${MVN_CMD} org.owasp:dependency-check-maven:12.1.0:aggregate"
MVN_CMD="${MVN_CMD} -DskipTests"
MVN_CMD="${MVN_CMD} -DfailBuildOnCVSS=${OWASP_CVSS_THRESHOLD}"
MVN_CMD="${MVN_CMD} -Dformats=JSON,HTML"
# Use NVD API key if available (speeds up NVD database updates)
if [ -n "${NVD_API_KEY}" ]; then
MVN_CMD="${MVN_CMD} -DnvdApiKey=${NVD_API_KEY}"
echo " NVD API key detected -- using authenticated NVD access"
else
echo " No NVD API key -- using unauthenticated access (slower)"
fi
##################################
## Run with retry logic (3x) ##
##################################
MAX_RETRIES=3
ATTEMPT=1
EXIT_CODE=0
while [ "${ATTEMPT}" -le "${MAX_RETRIES}" ]; do
echo ""
echo "OWASP Dependency-Check attempt ${ATTEMPT}/${MAX_RETRIES}..."
EXIT_CODE=0
eval "${MVN_CMD}" 2>&1 | tee /tmp/owasp-output.txt || EXIT_CODE=$?
# Exit code 1 = vulnerabilities found (expected), anything else = tool error
if [ "${EXIT_CODE}" -eq 0 ] || [ "${EXIT_CODE}" -eq 1 ]; then
break
fi
echo "Attempt ${ATTEMPT} failed with exit code ${EXIT_CODE}"
ATTEMPT=$((ATTEMPT + 1))
if [ "${ATTEMPT}" -le "${MAX_RETRIES}" ]; then
echo "Retrying in 30 seconds..."
sleep 30
fi
done
if [ "${ATTEMPT}" -gt "${MAX_RETRIES}" ] && [ "${EXIT_CODE}" -gt 1 ]; then
echo "OWASP Dependency-Check failed after ${MAX_RETRIES} attempts"
echo "This is typically caused by NVD database download issues"
exit 1
fi
##################################
## Collect reports ##
##################################
REPORT_FILE=$(find . -name "dependency-check-report.json" -path "*/target/*" | head -1)
if [ -n "${REPORT_FILE}" ]; then
cp "${REPORT_FILE}" /tmp/owasp-dependency-check.json
fi
HTML_REPORT=$(find . -name "dependency-check-report.html" -path "*/target/*" | head -1)
if [ -n "${HTML_REPORT}" ]; then
cp "${HTML_REPORT}" /tmp/owasp-dependency-check.html
fi
##################################
## Summarize results ##
##################################
echo ""
echo "=== OWASP Dependency-Check Summary ==="
if [ -f /tmp/owasp-dependency-check.json ]; then
VULN_COUNT=$(python3 -c "
import json
r = json.load(open('/tmp/owasp-dependency-check.json'))
deps = r.get('dependencies', [])
vulns = sum(len(d.get('vulnerabilities', [])) for d in deps)
print(vulns)
" 2>/dev/null || echo "unknown")
echo " Vulnerabilities: ${VULN_COUNT}"
echo " CVSS Threshold: ${OWASP_CVSS_THRESHOLD}"
else
echo " No report generated"
fi
echo "======================================="
##################################
## Handle fail_on flag ##
##################################
if [ "${OWASP_FAIL_ON_CVSS}" = "true" ] && [ "${EXIT_CODE}" -ne 0 ]; then
echo "OWASP found CVEs above threshold and fail_on_owasp is enabled. Failing build."
exit 1
fi
echo "OWASP Dependency-Check complete"
+44
View File
@@ -0,0 +1,44 @@
#!/bin/bash
set -e
echo "Running Semgrep SAST analysis..."
##################################
## Install Semgrep ##
##################################
pip3 install --quiet semgrep
##################################
## Run Semgrep scan ##
##################################
EXIT_CODE=0
semgrep scan \
--config "${SEMGREP_RULESETS// / --config }" \
--json --output /tmp/semgrep-report.json \
--sarif --sarif-output /tmp/semgrep-report.sarif \
--metrics=off \
. \
|| EXIT_CODE=$?
##################################
## Summarize results ##
##################################
echo ""
echo "=== Semgrep Summary ==="
if [ -f /tmp/semgrep-report.json ]; then
COUNT=$(python3 -c "import json; r=json.load(open('/tmp/semgrep-report.json')); print(len(r.get('results', [])))" 2>/dev/null || echo "unknown")
echo " Findings: ${COUNT}"
else
echo " Findings: 0"
fi
echo "========================"
##################################
## Handle fail_on flag ##
##################################
if [ "${SEMGREP_FAIL_ON_FINDINGS}" = "true" ] && [ "${EXIT_CODE}" -ne 0 ]; then
echo "Semgrep found issues and fail_on_semgrep is enabled. Failing build."
exit 1
fi
echo "Semgrep scan complete (exit code: ${EXIT_CODE})"