Compare commits

...
15 Commits
Author SHA1 Message Date
james.maes 748016f105 Merge pull request #10 from QRun-IO/develop
[minor] feat: add node_app_* job family
2026-02-27 12:59:51 -06:00
james.maesandClaude Sonnet 4.6 dbd158e5eb fix(node-app): handle corepack permission error on cimg/node
cimg/node images have pnpm pre-installed; corepack enable fails with
EACCES when trying to replace /usr/local/bin/pnpm (owned by root).
Skip corepack entirely when the package manager is already available.
Fall back to sudo corepack enable or user-local --install-directory
only when the tool is genuinely missing.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-02-27 12:34:41 -06:00
james.maesandClaude Sonnet 4.6 1297ba10f0 fix(node-app): fix helper sourcing and cache key bugs
- Add fallback stubs to all node_app_*.sh scripts — qqq_helpers.sh
  is not present on disk in a packed orb, so the source silently fails
  and banner/require_tool are undefined (exit 127)
- Fix node_app_install cache keys to use per-pkg_manager conditionals —
  checksumming all three lockfiles simultaneously fails hard when the
  non-primary lockfiles (package-lock.json, yarn.lock) don't exist

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-02-27 12:31:35 -06:00
james.maes 62ae2f7d29 Merge pull request #9 from QRun-IO/feature/node-app-jobs
feat: add node_app_* job family for deployed Node.js apps
2026-02-27 12:07:31 -06:00
james.maesandClaude Opus 4.6 99fa73a581 feat: add node_app_* job family for deployed Node.js applications
Add new job family for pnpm/npm/yarn-based Node.js applications that
need CI for build/test/e2e but do NOT publish to npm (e.g., Next.js apps).

New files:
- qqq_helpers.sh: shared helper functions (banner, require_tool, source guard)
- node_app_install.sh/yml: dependency install with corepack + cache
- node_app_test.sh/yml: type-check + lint + unit tests
- node_app_build.sh/yml: production build with timing
- node_app_e2e.sh/yml: Playwright browser install + e2e tests

Jobs:
- node_app_test_only: checkout + install + test (feature branches)
- node_app_build: checkout + install + test + build + persist workspace
- node_app_e2e: attach workspace + Playwright e2e tests

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-27 12:05:30 -06:00
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
27 changed files with 1217 additions and 24 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]
+14
View File
@@ -5,6 +5,20 @@ 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
+14 -6
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.6.1)
**Status:** Stable (v0.6.x)
## Why This Exists
@@ -58,6 +58,7 @@ workflows:
| `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
@@ -94,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
@@ -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
+21
View File
@@ -0,0 +1,21 @@
description: >
Runs the production build for a Node.js application
- Executes the build script with timing output
parameters:
pkg_manager:
type: string
default: "pnpm"
description: "Package manager to use (e.g., 'pnpm', 'npm', 'yarn')."
build_script:
type: string
default: "build"
description: "Name of the build script in package.json."
steps:
- run:
name: "Production build"
environment:
NODE_PKG_MANAGER: << parameters.pkg_manager >>
BUILD_SCRIPT: << parameters.build_script >>
command: <<include(scripts/node_app_build.sh)>>
+31
View File
@@ -0,0 +1,31 @@
description: >
Runs Playwright end-to-end tests for a Node.js application
- Installs Playwright browsers
- Runs e2e test suite producing JUnit output
- Stores test results and Playwright traces as artifacts
parameters:
pkg_manager:
type: string
default: "pnpm"
description: "Package manager to use (e.g., 'pnpm', 'npm', 'yarn')."
e2e_script:
type: string
default: "test:e2e"
description: "Name of the e2e test script in package.json."
steps:
- run:
name: "Run Playwright e2e tests"
environment:
NODE_PKG_MANAGER: << parameters.pkg_manager >>
E2E_SCRIPT: << parameters.e2e_script >>
command: <<include(scripts/node_app_e2e.sh)>>
- store_test_results:
path: test-results/e2e
- store_artifacts:
path: test-results/e2e
destination: e2e-results
- store_artifacts:
path: playwright-report
destination: playwright-report
+72
View File
@@ -0,0 +1,72 @@
description: >
Installs dependencies for a Node.js application
- Restores dependency cache
- Runs install via configured package manager (pnpm, npm, yarn)
- Saves dependency cache
parameters:
pkg_manager:
type: string
default: "pnpm"
description: "Package manager to use (e.g., 'pnpm', 'npm', 'yarn')."
steps:
# Restore cache using only the lockfile for the configured pkg manager.
# All three lockfiles cannot be checksummed simultaneously — CircleCI
# fails hard if any referenced file doesn't exist.
- when:
condition:
equal: [ pnpm, << parameters.pkg_manager >> ]
steps:
- restore_cache:
keys:
- node-app-v1-pnpm-{{ checksum "pnpm-lock.yaml" }}
- node-app-v1-pnpm-
- when:
condition:
equal: [ npm, << parameters.pkg_manager >> ]
steps:
- restore_cache:
keys:
- node-app-v1-npm-{{ checksum "package-lock.json" }}
- node-app-v1-npm-
- when:
condition:
equal: [ yarn, << parameters.pkg_manager >> ]
steps:
- restore_cache:
keys:
- node-app-v1-yarn-{{ checksum "yarn.lock" }}
- node-app-v1-yarn-
- run:
name: "Install dependencies"
environment:
NODE_PKG_MANAGER: << parameters.pkg_manager >>
command: <<include(scripts/node_app_install.sh)>>
- when:
condition:
equal: [ pnpm, << parameters.pkg_manager >> ]
steps:
- save_cache:
key: node-app-v1-pnpm-{{ checksum "pnpm-lock.yaml" }}
paths:
- node_modules
- ~/.cache/pnpm
- when:
condition:
equal: [ npm, << parameters.pkg_manager >> ]
steps:
- save_cache:
key: node-app-v1-npm-{{ checksum "package-lock.json" }}
paths:
- node_modules
- ~/.npm
- when:
condition:
equal: [ yarn, << parameters.pkg_manager >> ]
steps:
- save_cache:
key: node-app-v1-yarn-{{ checksum "yarn.lock" }}
paths:
- node_modules
- ~/.cache/yarn
+37
View File
@@ -0,0 +1,37 @@
description: >
Runs type-check, lint, and unit tests for a Node.js application
- Runs type checking, linting, and tests via package.json scripts
- Stores test results as artifacts
parameters:
pkg_manager:
type: string
default: "pnpm"
description: "Package manager to use (e.g., 'pnpm', 'npm', 'yarn')."
typecheck_script:
type: string
default: "typecheck"
description: "Name of the typecheck script in package.json."
lint_script:
type: string
default: "lint"
description: "Name of the lint script in package.json."
test_script:
type: string
default: "test"
description: "Name of the test script in package.json."
steps:
- run:
name: "Run type-check, lint, and tests"
environment:
NODE_PKG_MANAGER: << parameters.pkg_manager >>
TYPECHECK_SCRIPT: << parameters.typecheck_script >>
LINT_SCRIPT: << parameters.lint_script >>
TEST_SCRIPT: << parameters.test_script >>
command: <<include(scripts/node_app_test.sh)>>
- store_test_results:
path: test-results
- store_artifacts:
path: test-results
destination: test-results
+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 ]
+53
View File
@@ -0,0 +1,53 @@
description: >
Build job for Node.js applications on protected branches
Runs checkout, install, test, and production build
Persists build output to workspace for downstream jobs (e.g., e2e)
executor:
name: default
tag: << parameters.node_version >>
parameters:
node_version:
type: string
default: "lts"
description: "Node.js version tag (e.g., 'lts', '18.0', '20.0')."
pkg_manager:
type: string
default: "pnpm"
description: "Package manager to use (e.g., 'pnpm', 'npm', 'yarn')."
typecheck_script:
type: string
default: "typecheck"
description: "Name of the typecheck script in package.json."
lint_script:
type: string
default: "lint"
description: "Name of the lint script in package.json."
test_script:
type: string
default: "test"
description: "Name of the test script in package.json."
build_script:
type: string
default: "build"
description: "Name of the build script in package.json."
steps:
- checkout
- node_app_install:
pkg_manager: << parameters.pkg_manager >>
- node_app_test:
pkg_manager: << parameters.pkg_manager >>
typecheck_script: << parameters.typecheck_script >>
lint_script: << parameters.lint_script >>
test_script: << parameters.test_script >>
- node_app_build_step:
pkg_manager: << parameters.pkg_manager >>
build_script: << parameters.build_script >>
- persist_to_workspace:
root: .
paths:
- .next/
- node_modules/
- package.json
+29
View File
@@ -0,0 +1,29 @@
description: >
End-to-end test job for Node.js applications using Playwright
Attaches workspace from a prior build job and runs e2e tests
Stores JUnit results and Playwright traces as artifacts
executor:
name: default
tag: << parameters.node_version >>
parameters:
node_version:
type: string
default: "lts"
description: "Node.js version tag (e.g., 'lts', '18.0', '20.0')."
pkg_manager:
type: string
default: "pnpm"
description: "Package manager to use (e.g., 'pnpm', 'npm', 'yarn')."
e2e_script:
type: string
default: "test:e2e"
description: "Name of the e2e test script in package.json."
steps:
- attach_workspace:
at: .
- node_app_e2e:
pkg_manager: << parameters.pkg_manager >>
e2e_script: << parameters.e2e_script >>
+40
View File
@@ -0,0 +1,40 @@
description: >
Test-only job for Node.js application feature branches
Runs checkout, dependency install, and test suite
Supports: pnpm, npm, and yarn package managers
executor:
name: default
tag: << parameters.node_version >>
parameters:
node_version:
type: string
default: "lts"
description: "Node.js version tag (e.g., 'lts', '18.0', '20.0')."
pkg_manager:
type: string
default: "pnpm"
description: "Package manager to use (e.g., 'pnpm', 'npm', 'yarn')."
typecheck_script:
type: string
default: "typecheck"
description: "Name of the typecheck script in package.json."
lint_script:
type: string
default: "lint"
description: "Name of the lint script in package.json."
test_script:
type: string
default: "test"
description: "Name of the test script in package.json."
steps:
- checkout
- node_app_install:
pkg_manager: << parameters.pkg_manager >>
- node_app_test:
pkg_manager: << parameters.pkg_manager >>
typecheck_script: << parameters.typecheck_script >>
lint_script: << parameters.lint_script >>
test_script: << parameters.test_script >>
+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
+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"
+43
View File
@@ -0,0 +1,43 @@
#!/bin/bash
############################################################################
## node_app_build.sh
## Node Application Production Build
##
## Runs the production build for a Node.js application with timing output.
##
## Environment Variables:
## NODE_PKG_MANAGER - Package manager to use (default: pnpm)
## BUILD_SCRIPT - Script name for the build step (default: build)
##
## Usage: Called by CircleCI orb command node_app_build_step
## Output: Production build artifacts
############################################################################
set -e
# Source shared helpers (no-op in packed orb — file won't exist at runtime)
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]:-$0}")" && pwd)"
# shellcheck disable=SC1091
source "${SCRIPT_DIR}/qqq_helpers.sh" 2>/dev/null || true
# Fallback stubs when helpers couldn't be sourced (packed orb environment)
if ! type banner &>/dev/null; then
banner() { echo ""; echo "========================================"; echo " ${1:-}"; echo "========================================"; echo ""; }
require_tool() { command -v "$1" &>/dev/null || { echo "ERROR: Required tool '$1' is not installed."; exit 1; }; }
fi
NODE_PKG_MANAGER="${NODE_PKG_MANAGER:-pnpm}"
BUILD_SCRIPT="${BUILD_SCRIPT:-build}"
banner "Production Build"
require_tool "${NODE_PKG_MANAGER}"
START_TIME=$(date +%s)
"${NODE_PKG_MANAGER}" run "${BUILD_SCRIPT}"
END_TIME=$(date +%s)
ELAPSED=$((END_TIME - START_TIME))
echo "Build completed in ${ELAPSED}s"
+56
View File
@@ -0,0 +1,56 @@
#!/bin/bash
############################################################################
## node_app_e2e.sh
## Node Application End-to-End Test Runner
##
## Installs Playwright browsers and runs e2e tests producing JUnit output.
##
## Environment Variables:
## NODE_PKG_MANAGER - Package manager to use (default: pnpm)
## E2E_SCRIPT - Script name for e2e tests (default: test:e2e)
##
## Usage: Called by CircleCI orb command node_app_e2e
## Output: JUnit test results in test-results/e2e/ and Playwright traces
############################################################################
set -e
# Source shared helpers (no-op in packed orb — file won't exist at runtime)
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]:-$0}")" && pwd)"
# shellcheck disable=SC1091
source "${SCRIPT_DIR}/qqq_helpers.sh" 2>/dev/null || true
# Fallback stubs when helpers couldn't be sourced (packed orb environment)
if ! type banner &>/dev/null; then
banner() { echo ""; echo "========================================"; echo " ${1:-}"; echo "========================================"; echo ""; }
require_tool() { command -v "$1" &>/dev/null || { echo "ERROR: Required tool '$1' is not installed."; exit 1; }; }
fi
NODE_PKG_MANAGER="${NODE_PKG_MANAGER:-pnpm}"
E2E_SCRIPT="${E2E_SCRIPT:-test:e2e}"
banner "End-to-End Tests (Playwright)"
require_tool "${NODE_PKG_MANAGER}"
###########################
## Install Browsers ##
###########################
echo "Installing Playwright browsers..."
npx playwright install --with-deps chromium
###########################
## Run E2E Tests ##
###########################
mkdir -p test-results/e2e
echo "Running e2e tests..."
"${NODE_PKG_MANAGER}" run "${E2E_SCRIPT}" || E2E_EXIT=$?
if [[ "${E2E_EXIT:-0}" -ne 0 ]]; then
echo "E2E tests failed with exit code ${E2E_EXIT}"
exit "${E2E_EXIT}"
fi
echo "E2E tests completed successfully"
+96
View File
@@ -0,0 +1,96 @@
#!/bin/bash
############################################################################
## node_app_install.sh
## Node Application Dependency Installation
##
## Installs dependencies for a Node.js application project using the
## configured package manager (pnpm, npm, or yarn). Enables corepack
## when using pnpm or yarn.
##
## Environment Variables:
## NODE_PKG_MANAGER - Package manager to use (default: pnpm)
##
## Usage: Called by CircleCI orb command node_app_install
## Output: Installed node_modules and validated lockfile
############################################################################
set -e
# Source shared helpers (no-op in packed orb — file won't exist at runtime)
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]:-$0}")" && pwd)"
# shellcheck disable=SC1091
source "${SCRIPT_DIR}/qqq_helpers.sh" 2>/dev/null || true
# Fallback stubs when helpers couldn't be sourced (packed orb environment)
if ! type banner &>/dev/null; then
banner() { echo ""; echo "========================================"; echo " ${1:-}"; echo "========================================"; echo ""; }
require_tool() { command -v "$1" &>/dev/null || { echo "ERROR: Required tool '$1' is not installed."; exit 1; }; }
fi
NODE_PKG_MANAGER="${NODE_PKG_MANAGER:-pnpm}"
banner "Install Dependencies (${NODE_PKG_MANAGER})"
###########################
## Enable Corepack ##
###########################
if [[ "${NODE_PKG_MANAGER}" == "pnpm" || "${NODE_PKG_MANAGER}" == "yarn" ]]; then
if command -v "${NODE_PKG_MANAGER}" &>/dev/null; then
echo "${NODE_PKG_MANAGER} already available: $(${NODE_PKG_MANAGER} --version)"
else
echo "Installing ${NODE_PKG_MANAGER} via corepack..."
# corepack enable requires write access to /usr/local/bin; use sudo if available
if sudo -n corepack enable 2>/dev/null; then
echo "corepack enable succeeded (sudo)"
else
corepack enable --install-directory "${HOME}/.local/bin"
export PATH="${HOME}/.local/bin:${PATH}"
fi
corepack prepare "${NODE_PKG_MANAGER}@latest" --activate
fi
fi
require_tool "${NODE_PKG_MANAGER}"
###########################
## Lockfile Validation ##
###########################
case "${NODE_PKG_MANAGER}" in
pnpm)
if [[ ! -f pnpm-lock.yaml ]]; then
echo "WARNING: pnpm-lock.yaml not found"
fi
;;
npm)
if [[ ! -f package-lock.json ]]; then
echo "WARNING: package-lock.json not found"
fi
;;
yarn)
if [[ ! -f yarn.lock ]]; then
echo "WARNING: yarn.lock not found"
fi
;;
*)
echo "ERROR: Unsupported package manager '${NODE_PKG_MANAGER}'"
exit 1
;;
esac
###########################
## Install ##
###########################
case "${NODE_PKG_MANAGER}" in
pnpm)
pnpm install --frozen-lockfile
;;
npm)
npm ci
;;
yarn)
yarn install --immutable
;;
esac
echo "Dependencies installed successfully with ${NODE_PKG_MANAGER}"
+73
View File
@@ -0,0 +1,73 @@
#!/bin/bash
############################################################################
## node_app_test.sh
## Node Application Test Runner
##
## Runs type-checking, linting, and unit tests for a Node.js application.
## Each step can be overridden via environment variables to support
## projects with non-standard script names.
##
## Environment Variables:
## NODE_PKG_MANAGER - Package manager to use (default: pnpm)
## TYPECHECK_SCRIPT - Script name for type checking (default: typecheck)
## LINT_SCRIPT - Script name for linting (default: lint)
## TEST_SCRIPT - Script name for unit tests (default: test)
##
## Usage: Called by CircleCI orb command node_app_test
## Output: Test results and lint/typecheck status
############################################################################
set -e
# Source shared helpers (no-op in packed orb — file won't exist at runtime)
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]:-$0}")" && pwd)"
# shellcheck disable=SC1091
source "${SCRIPT_DIR}/qqq_helpers.sh" 2>/dev/null || true
# Fallback stubs when helpers couldn't be sourced (packed orb environment)
if ! type banner &>/dev/null; then
banner() { echo ""; echo "========================================"; echo " ${1:-}"; echo "========================================"; echo ""; }
require_tool() { command -v "$1" &>/dev/null || { echo "ERROR: Required tool '$1' is not installed."; exit 1; }; }
fi
NODE_PKG_MANAGER="${NODE_PKG_MANAGER:-pnpm}"
TYPECHECK_SCRIPT="${TYPECHECK_SCRIPT:-typecheck}"
LINT_SCRIPT="${LINT_SCRIPT:-lint}"
TEST_SCRIPT="${TEST_SCRIPT:-test}"
############################################################################
## has_script - check if a script exists in package.json
############################################################################
has_script() {
local name="$1"
node -e "
const pkg = require('./package.json');
process.exit(pkg.scripts && pkg.scripts['${name}'] ? 0 : 1);
"
}
############################################################################
## run_step - run a package.json script if it exists
############################################################################
run_step() {
local label="$1"
local script="$2"
banner "${label}"
if has_script "${script}"; then
"${NODE_PKG_MANAGER}" run "${script}"
else
echo "SKIP: No '${script}' script found in package.json"
fi
}
###########################
## Run Steps ##
###########################
run_step "Type Check" "${TYPECHECK_SCRIPT}"
run_step "Lint" "${LINT_SCRIPT}"
run_step "Unit Tests" "${TEST_SCRIPT}"
echo "All test steps completed successfully"
+50
View File
@@ -0,0 +1,50 @@
#!/bin/bash
############################################################################
## qqq_helpers.sh
## QQQ Orb Shared Helper Functions
##
## Provides common utilities used across node_app_* scripts:
## - Double-source guard to prevent re-initialization
## - Banner display for step identification
## - Tool existence checking
##
## Usage: source qqq_helpers.sh (from other scripts)
## Output: Exports helper functions into the calling script
############################################################################
# Double-source guard
if [[ -n "${_QQQ_HELPERS_LOADED:-}" ]]; then
# shellcheck disable=SC2317
return 0 2>/dev/null || true
fi
_QQQ_HELPERS_LOADED=1
############################################################################
## banner
## Print a visible section header
##
## Usage: banner "Step Name"
############################################################################
banner() {
local msg="$1"
echo ""
echo "========================================"
echo " ${msg}"
echo "========================================"
echo ""
}
############################################################################
## require_tool
## Verify a CLI tool is available, exit 1 if missing
##
## Usage: require_tool "pnpm"
############################################################################
require_tool() {
local tool="$1"
if ! command -v "${tool}" &>/dev/null; then
echo "ERROR: Required tool '${tool}' is not installed."
exit 1
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})"