Compare commits

..
87 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
james.maes 34688a1a53 Merge branch 'develop' 2026-01-10 20:43:05 -06:00
james.maes 6d181f361b fix: npm prerelease tags and skip GitHub release for RCs 2026-01-10 20:41:49 -06:00
james.maes d4ba7722c7 Merge branch 'develop' 2026-01-09 13:34:16 -06:00
james.maes 43ccb6ced0 fix: make version commit push failures non-fatal 2026-01-07 10:04:44 -06:00
james.maes b34cde9d19 fix(surefire-reports): Strip rerunFailure elements that CircleCI's JUnit parser doesn't support 2026-01-07 08:55:56 -06:00
james.maes 19deffb20e Merge branch 'develop' 2026-01-07 08:31:49 -06:00
james.maes a50948c1af docs(changelog): Added 0.5.1 changes 2026-01-07 08:31:14 -06:00
james.maes 7c79a57a8a fix(frontend_test_dependencies): updated Installing browser dependencies to ensure that it works noninteractive 2026-01-07 08:20:59 -06:00
james.maes aa4442618b chore: migrate license from AGPL-3.0 to Apache-2.0 2026-01-05 10:18:00 -06:00
james.maes 825937776c fix(gitignore): added local claude settings 2025-12-29 07:47:57 -06:00
james.maes 41702b0a30 docs(changelog): add missing versions 0.3.9-0.3.13 and fix dates 2025-12-29 07:46:01 -06:00
james.maes b3c6f237ee build(claude): removed local settings 2025-12-29 06:46:17 -06:00
james.maes 6649766a51 docs: update for v0.5.0 release 2025-12-28 11:33:10 -06:00
james.maes 342646a856 docs: update README for machine executor and Docker support 2025-12-28 11:29:06 -06:00
james.maes c43666fb4c feat: switch to machine executor for Docker support
Replace cimg/openjdk Docker executor with Ubuntu machine executor
that has native Docker support. This enables Testcontainers and
LocalStack Docker extension tests to run properly in CI.

- Create install_java command to install Temurin JDK and Maven
- Add optional Node.js installation for frontend builds
- Update all Maven jobs to use machine executor
2025-12-28 11:15:06 -06:00
james.maes eff82e0ffd revert: remove setup_remote_docker (not needed) 2025-12-28 08:56:46 -06:00
james.maes a1c797d897 feat: add setup_remote_docker for Docker-dependent tests 2025-12-28 08:46:14 -06:00
james.maes 76f37ad23a build(claude): added settings 2025-12-28 08:33:16 -06:00
james.maes b1523223d0 Merge main into develop 2025-12-28 08:32:17 -06:00
james.maes 09db303b9b fix(git): use CircleCI checkout for SSH/known_hosts handling 2025-12-28 08:31:35 -06:00
james.maes eedc21aeff fix(git): add GitHub SSH host key before clone 2025-12-28 08:23:58 -06:00
james.maes f23015ff1e fix(orb): update URLs to valid QRun-IO GitHub repo 2025-12-28 08:22:31 -06:00
james.maes b4a6aa0d4c docs: update for v0.4.0 release
- Add CHANGELOG entry for v0.4.0
- Update README to follow QQQ repo standards
- Add CLAUDE.md for Claude Code guidance
2025-12-28 08:15:58 -06:00
james.maes a347ddd68b Merge branch 'develop' 2025-12-28 08:06:18 -06:00
james.maes f6e04f7a58 style(makefile): fixed formatting 2025-12-28 08:05:19 -06:00
james.maes 5580d51cf7 feat: add Java 21 support with configurable executor (#4)
- Add java executor using cimg/openjdk with configurable version
- Update Maven jobs to use java executor with java_version parameter
- Update Node jobs to use default executor with node_version parameter
- Remove localstack orb dependency (no longer needed)
- Default Java version: 21.0 (use 17.0 for older projects)
2025-12-28 08:04:26 -06:00
james.maes eb9de5db69 chore(license): change to AGPL-3.0 with QRun-IO copyright 2025-12-25 19:35:16 -06:00
james.maes 3f5dd9a746 feat(release): add RC support for GitHub release creation 2025-12-24 21:46:38 -06:00
james.maes 65787b7dd2 feat(release): add automatic GitHub release creation
- Update create_github_release.sh to use CircleCI env vars for repo detection
- Add artifact links to Maven Central and npmjs in release notes
- Support both Maven and Node projects with auto-detection
- Add publish_github_release command wrapper
- Integrate into mvn_publish and node_publish jobs for release/hotfix branches
2025-12-24 20:16:44 -06:00
james.maes 4f07167e26 docs: Standardize README 2025-12-24 14:21:42 -06:00
james.maes 84a0e345b9 ci: Add GitHub release configuration 2025-12-24 12:44:44 -06:00
james.maes a1ef2a419f style(lint): spacing cleanup for lint 2025-10-22 08:38:34 -05:00
james.maes 99a776ee2a fix(calulate_version): updated to use circle-ci branch env before failing back to git ref parsing 2025-10-22 08:37:37 -05:00
james.maes 5b167ca8f8 fix(cache): seperated saves and cache restores by key 2025-10-09 16:42:41 -05:00
james.maes 43247349d7 fix(frontend_build): fixed cache steps in frontend_test part of workflow 2025-10-09 16:36:40 -05:00
james.maes 4486188522 hotfix from develop - frontend build 2025-10-09 16:18:04 -05:00
james.maes 1232a17f36 fix(frontend_build): updated save cache to also save npm module cache 2025-10-09 16:14:28 -05:00
james.maes 1f2e730512 Merge pull request #3 from Kingsrook/feature/snapshot-releases
Feature/snapshot releases
2025-09-29 11:22:04 -05:00
james.maes 2b59dac369 style(git-operations): converted to our internal git-operations command 2025-09-29 11:19:58 -05:00
james.maes 22fa420c52 docs: updated documents for release of 3.8 2025-09-29 11:07:58 -05:00
james.maes f337e2ff51 fix(circleci): updated publish jobs to skip git_operations for feature snapshot builds 2025-09-29 11:01:27 -05:00
james.maes 9d1a70e433 fix(calculate_version): fixed leading whitespaces issues on feature branch detection 2025-09-29 10:53:38 -05:00
james.maes 145c99e2f8 fix(git_full_checkout): removed depth - default to full 2025-09-29 10:47:04 -05:00
james.maes 8792d74fb0 fix(git-checkout): converting to a custom command to get full git clones 2025-09-29 10:45:17 -05:00
james.maes 5b5df41faa fix(git-checkout): updated depth to 10 2025-09-29 10:40:36 -05:00
james.maes 59c80f756a fix(git-checkout): updated to use command to get full clone 2025-09-29 10:34:26 -05:00
james.maes 187d0df5c7 ci(git-checkout): feature name detection was failing due to shallow git checkout clones, updated to be full clones 2025-09-29 10:30:56 -05:00
james.maes aa5cab7390 test: updated publish tag tests 2025-09-22 08:55:17 -05:00
james.maes f2d8a9927a fix(calulate_version): updated handling for finding feature name from a publish tag 2025-09-22 08:51:48 -05:00
james.maes 8820a7af82 fix(calulate_version): fixed support for tags on feature branches and added tests 2025-09-22 08:44:11 -05:00
james.maes 8adb9e65f7 fix: Linting updates 2025-09-20 09:38:23 -05:00
james.maes 492af48c0d docs: updated changelog and example build files 2025-09-20 09:12:23 -05:00
james.maes ae26b2288a feat: adding support for publishing snapshots for feature branches
Support Feature Snapshot Releases #1
2025-09-20 09:06:55 -05:00
james.maes f122b4a470 chore: Removed ignored file 2025-09-20 07:25:44 -05:00
james.maes ea30ebdb2f chore: Added IDE to ignore 2025-09-20 07:25:03 -05:00
james.maes 06a3d113bd docs: update README with current functionality and testing framework
- Add comprehensive testing section with dynamic test environments
- Document intelligent version management and feature branch support
- Update development workflow with quality gates and test commands
2025-09-18 09:33:37 -05:00
james.maes b0dc7e1eea feat: enforce full build cycle before publishing releases
Publish targets now run lint, clean, dev, and test-all before releasing,
ensuring quality gates and comprehensive testing before any publication.
2025-09-18 09:31:19 -05:00
james.maes 0bbd09cdca feat: enhance feature branch versioning with dynamic commit hash updates
Feature branches now automatically update version when commit hash changes,
with dynamic test environment creation and automatic cleanup via make clean.
2025-09-18 09:29:38 -05:00
james.maes 9af91511aa feat: enhance calculate_version.sh with comprehensive test suite and improved linting
- feat: add comprehensive test suite for calculate_version.sh script
  - Add test_calculate_version.sh with 20+ test cases covering all branch types
  - Add run_tests.sh test runner with verbose and CI modes
  - Add tests/README.md with complete documentation
  - Test coverage: main, develop, release, hotfix, feature branches
  - Test edge cases: invalid formats, missing tags, version parsing

- feat: integrate test suite into Make process
  - Add make test-scripts target for script testing
  - Add make test-all target for comprehensive testing (orb + scripts)
  - Update help documentation with new test targets

- fix: improve version parsing to handle v-prefixed versions
  - Fix extract_version_parts() to handle versions like 'v0.2.1'
  - Add regex to strip 'v' prefix before parsing version components
  - Ensure clean version output (e.g., 'v0.2.1' → '0.2.1')

- fix: resolve ShellCheck warnings for better code quality
  - Fix SC2155: declare and assign variables separately
  - Fix SC2001: replace sed with bash parameter expansion
  - Improve error handling and script robustness

- feat: enhance linting to include test scripts
  - Add test script ShellCheck validation to make lint
  - Ensure consistent code quality across source and test files
  - Update lint numbering and output formatting

- refactor: improve script structure with clear branch-specific handlers
  - Separate handle_main_branch(), handle_develop_branch(), etc.
  - Add detect_branch_type() for clear routing logic
  - Improve maintainability and reduce bugs across branch types

All tests passing, linting clean, ready for production use.
2025-09-18 09:04:53 -05:00
james.maes 7e3b967bb2 fix(calulate_version): refactored to make branch level code more clear and cleaner 2025-09-18 08:56:28 -05:00
james.maes 629ec15a2e fix(calulate_version): refactored to make branch level code more clear and cleaner 2025-09-18 08:54:58 -05:00
james.maes f10f63fe27 fix: Updated hanlding for tagged releases in main - issue not promoting to latest tag 2025-09-16 14:10:00 -05:00
james.maes c0365111f5 fix: Updated git commit on main to work for tag releases for production releases 2025-09-16 10:50:57 -05:00
james.maes 002b82d1f1 fix: updated standard GH docs to point to top level project docs 2025-09-15 15:25:43 -05:00
james.maes 9751567138 fix: removed condistionals around git ops after version checks for main and hotfixes 2025-09-15 14:36:50 -05:00
james.maes 0383e9fabf feat: made publish_asciidoc a params run 2025-09-15 13:29:30 -05:00
62 changed files with 3148 additions and 1374 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]
+31
View File
@@ -0,0 +1,31 @@
# GitHub Release Configuration
# Auto-generates release notes from PR labels
changelog:
exclude:
labels:
- ignore-for-release
- duplicate
- invalid
authors:
- dependabot
- dependabot[bot]
categories:
- title: Breaking Changes
labels:
- breaking-change
- breaking
- title: New Features
labels:
- enhancement
- feature
- title: Bug Fixes
labels:
- bug
- fix
- title: Dependencies
labels:
- dependencies
- title: Other Changes
labels:
- "*"
+8
View File
@@ -2,3 +2,11 @@
orb.yml
.DS_Store
target
# Test data directory (created dynamically during tests)
tests/test_data
# IDE
.idea
.claude
-120
View File
@@ -1,120 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="AutoImportSettings">
<option name="autoReloadType" value="SELECTIVE" />
</component>
<component name="ChangeListManager">
<list default="true" id="39f8d35a-1bb7-489b-b59c-b0ba3ffefe23" name="Changes" comment="">
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/calculate-version.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/calculate-version.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/check_middleware_api_versions.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/check_middleware_api_versions.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/create_github_release.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/create_github_release.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/manage_version_calculate.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/manage_version_calculate.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/manage_version_commit.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/manage_version_commit.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/manage_version_git_config.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/manage_version_git_config.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/mvn_build_compile.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/mvn_build_compile.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/mvn_jar_deploy_deploy.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/mvn_jar_deploy_deploy.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/mvn_jar_deploy_gpg_setup.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/mvn_jar_deploy_gpg_setup.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/mvn_verify_save_test_results.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/mvn_verify_save_test_results.sh" afterDir="false" />
<change beforePath="$PROJECT_DIR$/src/scripts/mvn_verify_verify.sh" beforeDir="false" afterPath="$PROJECT_DIR$/src/scripts/mvn_verify_verify.sh" afterDir="false" />
</list>
<option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" />
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
<option name="LAST_RESOLUTION" value="IGNORE" />
</component>
<component name="Git.Settings">
<option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
</component>
<component name="GitHubPullRequestSearchHistory">{
&quot;lastFilter&quot;: {
&quot;state&quot;: &quot;OPEN&quot;,
&quot;assignee&quot;: &quot;KofTwentyTwo&quot;
}
}</component>
<component name="GithubPullRequestsUISettings">{
&quot;selectedUrlAndAccountId&quot;: {
&quot;url&quot;: &quot;git@github.com:Kingsrook/qqq-orb.git&quot;,
&quot;accountId&quot;: &quot;7a0b7646-5b0c-4647-976d-932a62661dd2&quot;
}
}</component>
<component name="MacroExpansionManager">
<option name="directoryName" value="Qi1Hqxgr" />
</component>
<component name="ProjectColorInfo">{
&quot;associatedIndex&quot;: 5
}</component>
<component name="ProjectId" id="32YtZdjn4FeSrJsD5VMG3tLBHKD" />
<component name="ProjectLevelVcsManager">
<ConfirmationsSetting value="2" id="Add" />
</component>
<component name="ProjectViewState">
<option name="autoscrollFromSource" value="true" />
<option name="showExcludedFiles" value="false" />
<option name="showLibraryContents" value="true" />
</component>
<component name="PropertiesComponent">{
&quot;keyToString&quot;: {
&quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
&quot;RunOnceActivity.git.unshallow&quot;: &quot;true&quot;,
&quot;RunOnceActivity.go.formatter.settings.were.checked&quot;: &quot;true&quot;,
&quot;RunOnceActivity.go.migrated.go.modules.settings&quot;: &quot;true&quot;,
&quot;SHARE_PROJECT_CONFIGURATION_FILES&quot;: &quot;true&quot;,
&quot;git-widget-placeholder&quot;: &quot;develop&quot;,
&quot;go.import.settings.migrated&quot;: &quot;true&quot;,
&quot;io.aesy.yamllint.do.not.ask.to.enable&quot;: &quot;true&quot;,
&quot;last_opened_file_path&quot;: &quot;/Users/james.maes/Git.Local/Kingsrook/qqq-orb/src/jobs&quot;,
&quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
&quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
&quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
&quot;org.rust.cargo.project.model.impl.CargoExternalSystemProjectAware.subscribe.first.balloon&quot;: &quot;&quot;,
&quot;org.rust.first.attach.projects&quot;: &quot;true&quot;,
&quot;settings.editor.selected.configurable&quot;: &quot;preferences.sourceCode.yaml&quot;
},
&quot;keyToStringList&quot;: {
&quot;stardust.markdown.MarkdownSplitEditorSuppressor:keyList&quot;: []
}
}</component>
<component name="RecentsManager">
<key name="CopyFile.RECENT_KEYS">
<recent name="$PROJECT_DIR$/src/jobs" />
<recent name="$PROJECT_DIR$/src/commands" />
</key>
</component>
<component name="RustProjectSettings">
<option name="toolchainHomeDirectory" value="$USER_HOME$/.cargo/bin" />
</component>
<component name="SharedIndexes">
<attachedChunks>
<set>
<option value="bundled-jdk-9823dce3aa75-bf35d07a577b-intellij.indexing.shared.core-IU-252.25557.131" />
<option value="bundled-js-predefined-d6986cc7102b-b598e85cdad2-JavaScript-IU-252.25557.131" />
</set>
</attachedChunks>
</component>
<component name="TaskManager">
<task active="true" id="Default" summary="Default task">
<changelist id="39f8d35a-1bb7-489b-b59c-b0ba3ffefe23" name="Changes" comment="" />
<created>1757609391348</created>
<option name="number" value="Default" />
<option name="presentableId" value="Default" />
<updated>1757609391348</updated>
<workItem from="1757609392578" duration="5983000" />
<workItem from="1757633227531" duration="300000" />
<workItem from="1757633543711" duration="945000" />
<workItem from="1757634532876" duration="26000" />
<workItem from="1757634568948" duration="111000" />
<workItem from="1757634683262" duration="86000" />
<workItem from="1757634778652" duration="275000" />
<workItem from="1757635061044" duration="63000" />
<workItem from="1757721395861" duration="3728000" />
</task>
<servers />
</component>
<component name="TypeScriptGeneratedFilesManager">
<option name="version" value="3" />
</component>
<component name="VgoProject">
<settings-migrated>true</settings-migrated>
</component>
</project>
+8
View File
@@ -0,0 +1,8 @@
repos:
- hooks:
- id: commitizen
- id: commitizen-branch
stages:
- pre-push
repo: https://github.com/commitizen-tools/commitizen
rev: v4.9.1
+173 -18
View File
@@ -8,6 +8,112 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [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
## [0.5.0] - 2025-12-28
### Added
- Machine executor with native Docker support for Testcontainers and LocalStack
- `install_java` command to install Temurin JDK and Maven on machine executors
- Optional Node.js installation for frontend builds on machine executor
### Changed
- Switched from Docker executor (cimg/openjdk) to Ubuntu machine executor
- All Maven jobs now use machine executor with Docker pre-installed
### Fixed
- GitHub SSH host key added before clone operations
## [0.4.0] - 2025-12-28
### Added
- Java 21 support with configurable executor - New `java` executor using `cimg/openjdk` with version parameter (default: 21.0)
- Automatic GitHub release creation for releases and release candidates
- RC support for GitHub releases (published as pre-releases)
### Changed
- License changed to AGPL-3.0 with QRun-IO copyright
- Maven jobs now use the new `java` executor (resource_class: large)
- Node jobs use `default` executor with configurable version
### Migration
Projects needing Java 17 can explicitly set `java_version: "17.0"` in their workflow config.
## [0.3.13] - 2025-12-28
### Added
- GitHub release configuration for CI pipeline
- Standardized README documentation
### Changed
- Merged develop branch updates in preparation for 0.4.0
## [0.3.12] - 2025-10-22
### Fixed
- Version calculation now uses `CIRCLE_BRANCH` environment variable before falling back to git ref parsing
### Changed
- Linting cleanup for spacing consistency
## [0.3.11] - 2025-10-09
### Fixed
- Separated cache saves and restores by key for proper cache isolation
## [0.3.10] - 2025-10-09
### Fixed
- Frontend build cache steps in test workflow corrected
## [0.3.9] - 2025-10-09
### Fixed
- Frontend build now properly saves npm module cache
## [0.3.8] - 2025-09-29
### Added
- Support for publishing snapshots for feature branches
- Comprehensive README with detailed usage examples
- CONTRIBUTING.md with development guidelines
- SECURITY.md with security policy and reporting procedures
@@ -17,40 +123,89 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Updated README to follow QQQ framework standards
- Enhanced documentation structure and organization
## [2.1] - 2024-01-XX
## [0.3.7] - 2025-09-18
### Added
- Multi-platform support for Maven and Node.js projects
- GitFlow integration with automated version management
- Comprehensive testing framework with coverage reporting
- Automated publishing to Maven Central and npm registries
- Shell script automation and utilities
- Documentation generation and publishing
- Comprehensive README with current functionality and testing framework documentation
### Changed
- Improved orb structure and organization
- Enhanced error handling and validation
- Updated dependencies and security patches
- Enhanced documentation structure and organization
## [0.3.6] - 2025-09-16
### Fixed
- Various bug fixes and stability improvements
- Updated handling for tagged releases in main branch to properly promote to latest tag
- Fixed git commit operations on main branch for production releases
## [2.0] - 2023-XX-XX
## [0.3.5] - 2025-09-16
### Fixed
- Updated git commit on main branch to work correctly for tag releases in production releases
## [0.3.4] - 2025-09-15
### Fixed
- Removed conditionals around git operations after version checks for main and hotfix branches
- Updated standard GitHub documentation to point to top-level project documentation
## [0.3.3] - 2025-09-15
### Added
- Made publish_asciidoc a parameterized run option
### Changed
- Enhanced parameterization for better flexibility
## [0.3.2] - 2025-09-15
### Added
- Base level repository files and updated README
### Changed
- Updated check_middleware_api_versions to run based on parameter configuration
## [0.3.1] - 2025-09-15
### Fixed
- Version bump corrections
- Fixed bad sync RC update
- Updated example version references
## [0.3.0] - 2025-09-15
### Added
- Support for pure Node.js projects
- Support for building integrated frontend (npm) within Maven projects
- Support for publishing snapshots and tags
- Enhanced feature branch versioning with dynamic commit hash updates
- Comprehensive test suite and improved linting for calculate_version.sh
### Changed
- Reverted to only handle POM files (npm handled within its own job)
- Adjusted default execution state for scripts
- Converted longer commands to scripts per organization linting standards
- Refactored calculate_version.sh for cleaner branch level code
### Fixed
- Multiple linting fixes from CircleCI integration
- Improved error handling and validation
## [0.2.0] - 2025-09-13
### Added
- Initial CircleCI orb implementation
- Basic Maven project support
- Core CI/CD workflows
- Initial documentation for orb
### Changed
- Migrated from custom CI/CD to CircleCI orbs
- Updated CircleCI to use new QQQ orb for workflows
## [1.x] - 2022-XX-XX
### Added
- Legacy CI/CD implementation
- Basic automation scripts
### Fixed
- Implemented initial linting fixes from CircleCI
- Initial import of scripts and jobs from QQQ base repository
---
**Note**: For detailed release information and breaking changes, see the [QQQ Wiki](https://github.com/Kingsrook/qqq/wiki).
**Note**: For detailed release information and breaking changes, see the [QQQ Wiki](https://github.com/Kingsrook/qqq/wiki).
+82
View File
@@ -0,0 +1,82 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
CircleCI orb for QQQ framework projects. Provides pre-built jobs for building, testing, and publishing Maven and Node.js projects using GitFlow branching strategy.
## Build Commands
```bash
make pack # Pack orb to target/qqq-orb-packed.yml
make validate # Pack and validate orb
make test # Pack and validate (alias for validate)
make test-scripts # Run calculate_version.sh test suite
make test-all # Run all tests (orb + scripts)
make lint # Run yamllint, shellcheck, and CircleCI validation
make dev # Development workflow: pack, validate, show status
make clean # Remove target/ and tests/test_data/
make publish-snapshot # Publish to kingsrook/qqq-orb@dev:snapshot
make publish-release # Interactive production release with git tagging
```
## Running Individual Tests
```bash
./tests/run_tests.sh # Standard test run
./tests/run_tests.sh --verbose # Verbose output
./tests/run_tests.sh --ci # CI mode (minimal output)
./tests/test_calculate_version.sh # Direct test suite execution
```
## Architecture
### Directory Structure
- `src/@orb.yml` - Main orb definition entry point
- `src/commands/` - Reusable orb commands (YAML files that include scripts)
- `src/jobs/` - Complete job definitions combining commands
- `src/executors/` - Docker executor definitions (java.yml, default.yml)
- `src/scripts/` - Bash scripts included in commands
- `tests/` - Test suite for calculate_version.sh
### Key Components
**Executors:**
- `java` - cimg/openjdk image with configurable version (17.0, 21.0), resource_class: large
- `default` - cimg/node image for Node.js projects
**Jobs:**
- `mvn_publish` - Full publish workflow (build, version, test, deploy, git ops, GitHub release)
- `mvn_test_only` - Build and test for feature branches
- `mvn_frontend_publish` / `mvn_frontend_test_only` - Same with frontend support
- `node_publish` / `node_test_only` - Pure Node.js workflows
**Version Calculation:**
The core logic is in `src/scripts/calculate_version.sh`. It determines version based on branch type:
- `develop` -> `X.Y.Z-SNAPSHOT`
- `release/*` -> `X.Y.Z-RC.N`
- `main` (tagged) -> `X.Y.Z`
- `hotfix/*` -> Patch version bump
- `feature/*` -> `X.Y.Z-feature-{name}-{hash}-SNAPSHOT`
### Orb Packing
The orb uses CircleCI's "unpacked" format. YAML files in `src/` are packed into a single `target/qqq-orb-packed.yml`. Commands reference scripts via `<<include(scripts/scriptname.sh)>>` syntax.
### CI Pipeline
`.circleci/config.yml` runs lint/pack/review/shellcheck, then continues to `.circleci/test-deploy.yml` which runs command tests and publishes on release tags (`v*.*.*`).
## Linting Requirements
- YAML: yamllint for commands/jobs/examples
- Shell: shellcheck for all .sh files in src/scripts/ and tests/
- Orb: `circleci orb validate` for orb syntax
## Required Context Variables for Publishing
- `MAVEN_USERNAME`, `MAVEN_PASSWORD` - Sonatype credentials
- `GPG_PRIVATE_KEY_B64`, `GPG_KEYNAME`, `GPG_PASSPHRASE` - GPG signing
- `GITHUB_TOKEN` - GitHub API access
+2 -84
View File
@@ -1,86 +1,4 @@
# Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
- **Being respectful and inclusive** of differing viewpoints and experiences
- **Accepting constructive criticism** gracefully
- **Focusing on what is best** for the community
- **Showing empathy** towards other community members
- **Being collaborative** and helping others learn and grow
- **Using welcoming and inclusive language** in all interactions
Examples of unacceptable behavior include:
- **Harassment** in any form, including sexual harassment
- **Trolling, insulting, or derogatory comments** and personal or political attacks
- **Public or private harassment** of any kind
- **Publishing others' private information** without explicit permission
- **Conduct that could reasonably be considered inappropriate** in a professional setting
- **Dismissing or attacking inclusion-oriented requests** or concerns
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at **conduct@kingsrook.com**. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
## Contact Information
- **Code of Conduct Issues**: conduct@kingsrook.com
- **General Contact**: contact@kingsrook.com
- **Company**: Kingsrook, LLC
- **Website**: https://qrun.io
---
**Thank you for helping create a welcoming and inclusive community!** 🌟
See Project level [Code of Conduct](https://github.com/Kingsrook/qqq/blob/develop/CODE_OF_CONDUCT.md)
+2 -306
View File
@@ -1,307 +1,3 @@
# Code Style Guide
This document outlines the coding standards and style guidelines for QQQ Orb development.
## 🎯 Overview
QQQ Orb follows consistent coding standards to ensure maintainability, readability, and reliability across all components.
## 📁 File Organization
### Directory Structure
```
src/
├── @orb.yml # Main orb definition
├── commands/ # Reusable commands
├── jobs/ # Complete workflow jobs
├── scripts/ # Shell scripts
├── executors/ # Execution environments
└── examples/ # Usage examples
```
### Naming Conventions
- **Files**: Use lowercase with underscores (`mvn_build.yml`)
- **Directories**: Use lowercase with underscores (`commands/`)
- **Variables**: Use uppercase with underscores (`MAVEN_USERNAME`)
- **Functions**: Use lowercase with underscores (`calculate_version`)
## 🔧 YAML Configuration
### General Guidelines
- **Indentation**: Use 2 spaces (no tabs)
- **Line Length**: Maximum 120 characters
- **Quotes**: Use single quotes for strings when possible
- **Comments**: Use `#` for comments, explain complex logic
### Orb Definition Structure
```yaml
# @orb.yml
version: 2.1
description: >
Brief description of the orb's purpose.
display:
home_url: "https://www.qrun.io"
source_url: "https://github.com/Kingsrook/qqq-orb"
orbs:
dependency-orb: circleci/dependency@1.0.0
```
### Command Structure
```yaml
# commands/example_command.yml
description: "Brief description of what this command does"
parameters:
param1:
type: string
default: "default_value"
description: "Parameter description"
steps:
- run:
name: "Step Name"
command: |
echo "Command content"
# Additional commands
```
### Job Structure
```yaml
# jobs/example_job.yml
description: "Brief description of what this job does"
executor: default
parameters:
param1:
type: string
default: "default_value"
description: "Parameter description"
steps:
- checkout
- qqq-orb/example-command:
param1: << parameters.param1 >>
```
## 🐚 Shell Scripts
### General Guidelines
- **Shebang**: Always use `#!/bin/bash`
- **Error Handling**: Use `set -euo pipefail`
- **Variables**: Use `readonly` for constants
- **Functions**: Use descriptive names and document parameters
### Script Template
```bash
#!/bin/bash
set -euo pipefail
# Script description
# Usage: script_name [options] [arguments]
readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
readonly SCRIPT_NAME="$(basename "$0")"
# Function documentation
# Parameters: $1 - description, $2 - description
function example_function() {
local param1="$1"
local param2="$2"
# Function implementation
echo "Processing: $param1, $param2"
}
# Main execution
main() {
# Main logic here
example_function "value1" "value2"
}
# Run main function if script is executed directly
if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
main "$@"
fi
```
### Error Handling
```bash
# Check if command exists
if ! command -v mvn &> /dev/null; then
echo "Error: Maven is not installed" >&2
exit 1
fi
# Check if file exists
if [[ ! -f "pom.xml" ]]; then
echo "Error: pom.xml not found" >&2
exit 1
fi
# Handle command failures
if ! mvn clean compile; then
echo "Error: Maven compilation failed" >&2
exit 1
fi
```
## 📝 Documentation
### README Structure
- **Title**: Clear, descriptive title
- **Badges**: Status badges for version, license, etc.
- **Overview**: Brief description of purpose
- **Quick Start**: Getting started instructions
- **Usage**: Detailed usage examples
- **Development**: Development setup and guidelines
- **Contributing**: Contribution guidelines
- **License**: License information
### Inline Documentation
```yaml
# commands/mvn_build.yml
description: >
Builds a Maven project with specified goals.
Supports multi-module projects and custom settings.
parameters:
goals:
type: string
default: "clean compile"
description: >
Maven goals to execute.
Common values: clean, compile, test, package, install
```
### Shell Script Documentation
```bash
#!/bin/bash
# Script: calculate_version.sh
# Description: Calculates semantic version based on GitFlow branch
# Usage: calculate_version.sh [branch_name]
# Parameters:
# branch_name - Git branch name (optional, defaults to current branch)
# Returns: Semantic version string
```
## 🧪 Testing Standards
### Test Structure
- **Unit Tests**: Test individual functions and commands
- **Integration Tests**: Test complete workflows
- **Validation Tests**: Test orb configuration and packing
### Test Naming
- **Test Files**: `test_<component>.yml`
- **Test Functions**: `test_<function_name>`
- **Test Descriptions**: Clear, descriptive test names
### Coverage Requirements
- **Commands**: All parameters and error conditions
- **Jobs**: All workflow paths and error handling
- **Scripts**: All functions and error conditions
## 🔍 Code Review Standards
### Review Checklist
- [ ] **Functionality**: Code works as intended
- [ ] **Style**: Follows project style guidelines
- [ ] **Documentation**: Adequate documentation and comments
- [ ] **Testing**: Appropriate test coverage
- [ ] **Security**: No security vulnerabilities
- [ ] **Performance**: Efficient implementation
- [ ] **Maintainability**: Code is maintainable and readable
### Review Process
1. **Self Review**: Author reviews their own code first
2. **Peer Review**: At least one peer review required
3. **Testing**: All tests must pass
4. **Documentation**: Documentation updated as needed
5. **Approval**: Required approvals before merge
## 🛠️ Development Tools
### Required Tools
- **CircleCI CLI**: For orb development and validation
- **ShellCheck**: For shell script linting
- **yamllint**: For YAML linting
- **Git**: For version control
### IDE Configuration
#### VS Code
```json
{
"editor.tabSize": 2,
"editor.insertSpaces": true,
"editor.rulers": [120],
"files.trimTrailingWhitespace": true,
"files.insertFinalNewline": true,
"yaml.schemas": {
"https://json.schemastore.org/circle-ci-config.json": ".circleci/config.yml"
}
}
```
#### IntelliJ IDEA
- **Code Style**: Use project code style settings
- **File Templates**: Use project file templates
- **Inspections**: Enable all relevant inspections
## 📋 Best Practices
### General Principles
- **DRY**: Don't Repeat Yourself
- **KISS**: Keep It Simple, Stupid
- **YAGNI**: You Aren't Gonna Need It
- **SOLID**: Follow SOLID principles where applicable
### Security Considerations
- **Secrets**: Never commit secrets or credentials
- **Input Validation**: Validate all inputs
- **Error Handling**: Don't expose sensitive information in errors
- **Dependencies**: Keep dependencies up to date
### Performance Considerations
- **Efficiency**: Use efficient algorithms and data structures
- **Caching**: Cache expensive operations when appropriate
- **Parallelization**: Use parallel execution where beneficial
- **Resource Usage**: Minimize resource consumption
## 🔗 Resources
- **CircleCI Orb Development**: https://circleci.com/docs/2.0/orb-author-intro/
- **Shell Script Best Practices**: https://google.github.io/styleguide/shellguide.html
- **YAML Best Practices**: https://yaml.org/spec/1.2/spec.html
- **GitFlow Workflow**: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
---
**Remember**: Consistent code style improves maintainability and reduces bugs. When in doubt, follow existing patterns in the codebase.
* See Project [Code Style Guide](https://github.com/Kingsrook/qqq/blob/develop/CODE_STYLE.md)
+2 -134
View File
@@ -1,136 +1,4 @@
# Contributing to QQQ Orb
# Contributing to QBit User Role Permissions
First off, thanks for taking the time to contribute! ❤️
* See Project [Contributing](https://github.com/Kingsrook/qqq/blob/develop/CONTRIBUTING.md)
QQQ Orb is **open source** and welcomes contributions from the community. This document provides a quick overview - for detailed guides, see our [Complete Documentation Wiki](https://github.com/Kingsrook/qqq/wiki).
## 🚀 Quick Start
**New to QQQ?** Start with our [Developer Onboarding Guide](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding) to get your environment set up.
## 📚 Documentation & Guides
All detailed information is in our [Wiki](https://github.com/Kingsrook/qqq/wiki):
- **[🏠 Home](https://github.com/Kingsrook/qqq/wiki/Home)** - Project overview
- **[🔧 Development](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)** - Complete setup guide
- **[📝 Contribution Process](https://github.com/Kingsrook/qqq/wiki/Contribution-Guidelines)** - Detailed contribution workflow
- **[🔍 Code Standards](https://github.com/Kingsrook/qqq/wiki/Code-Review-Standards)** - Coding standards and review process
- **[🧪 Testing](https://github.com/Kingsrook/qqq/wiki/Testing)** - Testing strategy and requirements
- **[🏗️ Architecture](https://github.com/Kingsrook/qqq/wiki/High-Level-Architecture)** - System design and principles
## 🤝 How to Contribute
### **1. Report Issues**
Found a bug or have a feature request? [Create an issue](https://github.com/Kingsrook/qqq/issues).
### **2. Code Contributions**
Want to contribute code? Follow our [Contribution Guidelines](https://github.com/Kingsrook/qqq/wiki/Contribution-Guidelines).
**Key Requirements:**
- CircleCI CLI and orb development tools
- Follow QQQ's [Code Review Standards](https://github.com/Kingsrook/qqq/wiki/Code-Review-Standards)
- Meet testing coverage requirements
- Use conventional commit messages
- Validate orb configuration with `make lint`
### **3. Documentation**
Improve our docs by updating the [Wiki](https://github.com/Kingsrook/qqq/wiki) or suggesting improvements via issues.
## 🔧 Development Setup
**Prerequisites:**
- **macOS** (QQQ dev tools are macOS-optimized)
- **CircleCI CLI** for orb development
- **ShellCheck** and **yamllint** for linting
- **Git** with SSH access
**Quick Setup:**
```bash
# Install CircleCI CLI
curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | sudo bash
# Install linting tools (macOS)
brew install shellcheck yamllint
# Clone the repository
git clone git@github.com:Kingsrook/qqq.git
cd qqq/qqq-orb
# Run development workflow
make dev
```
For complete setup instructions, see [Developer Onboarding](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding).
## 📋 Contribution Checklist
Before submitting your contribution:
- [ ] **Environment**: Development environment properly set up
- [ ] **Code Style**: Follows QQQ's [Code Review Standards](https://github.com/Kingsrook/qqq/wiki/Code-Review-Standards)
- [ ] **Testing**: All tests pass with `make test`
- [ ] **Linting**: All linting checks pass with `make lint`
- [ ] **Documentation**: Updated relevant wiki pages
- [ ] **Commit Messages**: Follow conventional commit format
- [ ] **Orb Validation**: Orb packs and validates successfully
## 🧪 Testing
### Running Tests
```bash
# Run all tests
make test
# Run linting checks
make lint
# Validate orb configuration
make validate
# Development workflow
make dev
```
### Test Coverage
The orb includes comprehensive testing:
- **YAML Validation**: CircleCI orb configuration validation
- **Shell Script Testing**: ShellCheck for shell script validation
- **Orb Packing**: Tests orb packing and resolution
- **Integration Testing**: End-to-end workflow testing
## 📦 Publishing
### Development Publishing
```bash
# Publish snapshot for testing
make publish-snapshot
```
### Production Publishing
```bash
# Publish production release
make publish-release
```
## 🆘 Getting Help
- **📖 [Wiki](https://github.com/Kingsrook/qqq/wiki)**: Start here for comprehensive guides
- **🐛 [Issues](https://github.com/Kingsrook/qqq/issues)**: Search existing issues or create new ones
- **💬 [Discussions](https://github.com/Kingsrook/qqq/discussions)**: Ask questions and get help
## 📄 Legal Notice
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content, and that the content you contribute may be provided under the project license.
## 🏢 About Kingsrook
QQQ Orb is built by **[Kingsrook](https://qrun.io)** - making engineers more productive through intelligent automation and developer tools.
---
**Ready to contribute?** [Start with our Developer Onboarding Guide](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)!
+187 -17
View File
@@ -1,21 +1,191 @@
MIT License
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Copyright (c) 2021-2024 Kingsrook, LLC
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
1. Definitions.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to the Licensor for inclusion in the Work by the copyright
owner or by an individual or Legal Entity authorized to submit on
behalf of the copyright owner. For the purposes of this definition,
"submitted" means any form of electronic, verbal, or written
communication sent to the Licensor or its representatives, including
but not limited to communication on electronic mailing lists, source
code control systems, and issue tracking systems that are managed by,
or on behalf of, the Licensor for the purpose of discussing and
improving the Work, but excluding communication that is conspicuously
marked or otherwise designated in writing by the copyright owner as
"Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
Copyright 2022-2025 QRunIO, LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+25 -7
View File
@@ -1,7 +1,7 @@
# QQQ Orb Development Makefile
# Provides convenient commands for orb development, validation, and publishing
.PHONY: help pack validate clean test publish-snapshot publish-release dev check-clean check-branch
.PHONY: help pack validate clean test test-scripts test-all publish-snapshot publish-release dev check-clean check-branch
# Default target
help:
@@ -10,6 +10,8 @@ help:
@echo " make pack - Pack the orb using 'orb pack' (recommended for orb development)"
@echo " make validate - Validate the packed orb"
@echo " make test - Pack and validate the orb"
@echo " make test-scripts - Run comprehensive tests for calculate_version.sh"
@echo " make test-all - Run all tests (orb + scripts)"
@echo " make clean - Remove packed orb files"
@echo " make dev - Development workflow: pack, validate, and show status"
@echo " make lint - Run all CircleCI-style linting checks"
@@ -17,7 +19,7 @@ help:
@echo " make publish-release - Interactive production release (tagged version)"
@echo ""
@echo "Key Files:"
@echo " src/@orb.yml - Main orb definition"
@echo " src/@orb.yml - Main orb definition"
@echo " target/qqq-orb-packed.yml - Packed orb (generated)"
# Pack the orb using the correct command for orb development
@@ -37,10 +39,22 @@ validate: pack
test: validate
@echo "✅ All tests passed!"
# Test scripts: run comprehensive tests for calculate_version.sh
test-scripts:
@echo "🧪 Running calculate_version.sh test suite..."
@./tests/run_tests.sh --ci
@echo "✅ Script tests passed!"
# Test all: run both orb tests and script tests
test-all: test test-scripts
@echo "🎉 All tests completed successfully!"
# Clean up generated files
clean:
@echo "Cleaning up packed orb files..."
@rm -rf target
@echo "Cleaning up test data..."
@rm -rf tests/test_data
@echo "✅ Cleanup complete"
# Lint source files (same checks as CircleCI)
@@ -53,13 +67,17 @@ lint:
@echo ""
@echo "2. Shell Script Linting (ShellCheck)..."
@shellcheck src/scripts/*.sh
@echo "✅ ShellCheck passed"
@echo "✅ Source script ShellCheck passed"
@echo ""
@echo "3. CircleCI Orb Linting..."
@echo "3. Test Script Linting (ShellCheck)..."
@shellcheck tests/*.sh
@echo "✅ Test script ShellCheck passed"
@echo ""
@echo "4. CircleCI Orb Linting..."
@circleci orb validate src/@orb.yml
@echo "✅ CircleCI orb validation passed"
@echo ""
@echo "4. Orb Packing Test..."
@echo "5. Orb Packing Test..."
@circleci orb pack src > /tmp/test-packed.yml
@circleci orb validate /tmp/test-packed.yml
@rm -f /tmp/test-packed.yml
@@ -105,7 +123,7 @@ check-branch:
fi
# Interactive snapshot release (dev:snapshot)
publish-snapshot: check-clean lint validate
publish-snapshot: check-clean lint clean dev test-all
@echo "🚀 Publishing Snapshot Release"
@echo ""
@echo "This will publish to: kingsrook/qqq-orb@dev:snapshot"
@@ -121,7 +139,7 @@ publish-snapshot: check-clean lint validate
echo "✅ Snapshot published successfully!"
# Interactive production release (tagged version)
publish-release: check-clean check-branch lint validate
publish-release: check-clean check-branch lint clean dev test-all
@echo "🚀 Publishing Production Release"
@echo ""
@echo "This will create a git tag and publish a production version."
+6
View File
@@ -0,0 +1,6 @@
QQQ CircleCI Orb
Copyright 2022-2025 QRunIO, LLC
This product includes software developed at QRunIO, LLC (https://qrun.io/).
Licensed under the Apache License, Version 2.0.
+87 -299
View File
@@ -1,339 +1,127 @@
# QQQ Orb
# qqq-orb
[![CircleCI Orb](https://img.shields.io/badge/CircleCI%20Orb-kingsrook%2Fqqq--orb-blue.svg)](https://circleci.com/developer/orbs/orb/kingsrook/qqq-orb)
[![Version](https://img.shields.io/badge/version-2.1-blue.svg)](https://circleci.com/developer/orbs/orb/kingsrook/qqq-orb)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
CircleCI orb for QQQ framework projects.
> **CircleCI Orb for QQQ Framework Projects**
**For:** Teams using CircleCI to build, test, and publish QQQ applications
**Status:** Stable (v0.6.x)
CircleCI orb for Maven and Node.js projects using GitFlow. Provides automated building, testing, version management, and publishing to Maven Central and npm registries.
## Why This Exists
## 🚀 Overview
QQQ projects share common CI/CD patterns: build with Maven, run tests, publish to Maven Central or npm. Setting this up from scratch means duplicating workflow configuration across every repository.
QQQ Orb is a **CircleCI orb** that provides standardized CI/CD workflows for projects in the QQQ ecosystem. It handles the complete development lifecycle from building and testing to publishing releases.
This orb provides pre-built jobs for the complete QQQ development lifecycle. Add a few lines of YAML and your project has automated testing, version management, and publishing.
### What This Repository Contains
## Features
- **CircleCI Orb**: Reusable CI/CD workflows and commands
- **GitFlow Integration**: Automated branching and version management
- **Multi-Platform Support**: Maven (Java) and npm (Node.js) project support
- **Publishing Automation**: Automated publishing to Maven Central and npm
- **Testing Framework**: Comprehensive testing with coverage reporting
- **Maven and npm support** - Builds Java and Node.js projects
- **Docker-native execution** - Machine executor with Docker pre-installed for Testcontainers/LocalStack
- **GitFlow integration** - Automated versioning based on branch type
- **Publishing automation** - Maven Central and npm registry publishing
- **Test coverage** - JaCoCo integration with coverage reporting
- **Version calculation** - Semantic versioning with SNAPSHOT, RC, and release support
- **Java 21 default** - Temurin JDK with configurable version (17, 21)
### What This Repository Does NOT Contain
## Quick Start
- **QQQ Framework**: The actual low-code engine and backend
- **Application Code**: Business logic or application-specific code
- **Runtime Dependencies**: Libraries or frameworks used by applications
## 🏗️ Architecture
### Technology Stack
- **CircleCI Orbs**: Reusable configuration components
- **GitFlow**: Branching strategy for release management
- **Maven**: Java project build and dependency management
- **npm**: Node.js package management
- **Shell Scripts**: Automation and utility scripts
- **YAML**: Configuration and workflow definitions
### Core Capabilities
- **Automated Building**: Maven and npm project compilation
- **Testing**: Unit tests, integration tests, and coverage reporting
- **Version Management**: Automated semantic versioning based on GitFlow
- **Publishing**: Maven Central and npm registry publishing
- **Documentation**: Automated documentation generation and publishing
## 🚀 Quick Start
### Using the Orb
**Prerequisites:** CircleCI account, repository connected to CircleCI
```yaml
# .circleci/config.yml
version: 2.1
orbs:
qqq-orb: kingsrook/qqq-orb@2.1
qqq-orb: kingsrook/qqq-orb@0.6
workflows:
test_only:
filters:
branches:
ignore: [develop, main, /release\/.*/, /hotfix\/.*/]
build_and_test:
jobs:
- qqq-orb/build
- qqq-orb/test:
requires: [qqq-orb/build]
- qqq-orb/mvn_test_only
publish_snapshot:
filters: { branches: { only: develop } }
when:
equal: [develop, << pipeline.git.branch >>]
jobs:
- qqq-orb/publish:
- qqq-orb/mvn_publish:
context: qqq-maven-registry-credentials
branch_type: snapshot
publish_release_candidate:
filters: { branches: { only: /release\/.*/ } }
jobs:
- qqq-orb/publish:
context: qqq-maven-registry-credentials
branch_type: release_candidate
production_release:
filters: { branches: { only: main } }
jobs:
- qqq-orb/publish:
context: qqq-maven-registry-credentials
branch_type: release
hotfix_release:
filters: { branches: { only: /hotfix\/.*/ } }
jobs:
- qqq-orb/publish:
context: qqq-maven-registry-credentials
branch_type: hotfix
```
### Required Context
## Usage
Set up `qqq-maven-registry-credentials` context in CircleCI:
### Available Jobs
| Variable | Description | Required For |
|----------|-------------|--------------|
| `MAVEN_USERNAME` | Sonatype username | Maven publishing |
| `MAVEN_PASSWORD` | Sonatype password | Maven publishing |
| `GPG_PRIVATE_KEY_B64` | Base64 encoded GPG private key | Maven signing |
| `GPG_KEYNAME` | GPG key identifier | Maven signing |
| `GPG_PASSPHRASE` | GPG passphrase | Maven signing |
| `GITHUB_TOKEN` | GitHub API token | GitHub releases |
| `RDBMS_PASSWORD` | Database password | Integration testing |
| Job | Purpose |
|-----|---------|
| `mvn_test_only` | Build and test Maven projects |
| `mvn_publish` | Build, test, and publish Maven artifacts |
| `mvn_frontend_test_only` | Build and test Maven projects with npm frontend |
| `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 |
### Project Requirements
### Branch Types
- **Maven Projects**: `pom.xml` with `<revision>` property
- **Node.js Projects**: `package.json` with version field
- **Settings**: `/tmp/circleci/mvn-settings.xml` (auto-generated if missing)
- **Documentation**: `docs/index.adoc` (optional, for documentation)
| Branch | Version Format |
|--------|----------------|
| `develop` | `1.5.0-SNAPSHOT` |
| `release/1.5` | `1.5.0-RC.1` |
| `main` | `1.5.0` (requires tag) |
| `hotfix/1.5.1` | `1.5.1` |
| `feature/*` | `1.5.0-feature-abc1234-SNAPSHOT` |
## 📁 Repository Structure
### Java Version
```
src/
├── @orb.yml # Main orb definition
├── commands/ # Reusable commands
│ ├── mvn_build.yml # Maven build command
│ ├── mvn_verify.yml # Maven test and verify
│ ├── mvn_jar_deploy.yml # Maven deployment
│ ├── node_build_package.yml # Node.js build and package
│ ├── node_publish.yml # npm publishing
│ └── ... # Additional commands
├── jobs/ # Complete workflow jobs
│ ├── mvn_publish.yml # Maven publishing workflow
│ ├── mvn_test_only.yml # Maven testing workflow
│ ├── node_publish.yml # npm publishing workflow
│ └── node_test_only.yml # npm testing workflow
├── scripts/ # Shell scripts
│ ├── calculate_version.sh # Version calculation
│ ├── mvn_build_compile.sh # Maven compilation
│ ├── node_npm_auth.sh # npm authentication
│ └── ... # Additional scripts
├── executors/ # Execution environments
│ └── default.yml # Default executor configuration
└── examples/ # Usage examples
└── build.yml # Example configuration
```
## 🎯 Available Jobs
| Job | Branch | Output | Description |
|-----|--------|--------|-------------|
| `build` | Any | Compiled artifacts | Build project without testing |
| `test` | Any | Test results + JaCoCo | Run tests with coverage |
| `publish` | Any | Published artifacts | Unified publishing based on branch_type |
### Publish Job Parameters
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `branch_type` | string | "snapshot" | Branch type: snapshot, release_candidate, release, hotfix |
## 🔧 Development
### Prerequisites
```bash
# Install CircleCI CLI
curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | sudo bash
# Install linting tools (macOS)
brew install shellcheck yamllint
# Install linting tools (Ubuntu/Debian)
sudo apt-get install shellcheck yamllint
```
### Development Commands
```bash
make pack # Pack orb (resolves <<include()>>)
make validate # Validate packed orb
make lint # Run all linting checks
make dev # Pack + validate
make clean # Clean build artifacts
```
### Publishing Commands
```bash
make publish-snapshot # Publish as kingsrook/qqq-orb@dev:snapshot
make publish-release # Publish as kingsrook/qqq-orb@X.Y.Z
```
## 📋 Version Management
Automated version calculation based on GitFlow branches:
| Branch Pattern | Version Change | Example |
|----------------|----------------|---------|
| `develop` | Minor bump | `1.5.0-SNAPSHOT` → `1.6.0-SNAPSHOT` |
| `release/1.5` | RC versions | `1.5.0-RC.1`, `1.5.0-RC.2`, ... |
| `main` | Stable release | `1.5.0-RC.3` → `1.5.0` **requires v* tag** |
| `hotfix/1.5.1` | Patch bump | `1.5.0` → `1.5.1` |
**Main branch requires release tags**:
```bash
git tag -a v1.5.0 -m "Release 1.5.0"
git push origin v1.5.0
```
## 🧪 Testing
### Running Tests
```bash
# Run all tests
make test
# Run linting checks
make lint
# Validate orb configuration
make validate
```
### Test Coverage
The orb includes comprehensive testing:
- **YAML Validation**: CircleCI orb configuration validation
- **Shell Script Testing**: ShellCheck for shell script validation
- **Orb Packing**: Tests orb packing and resolution
- **Integration Testing**: End-to-end workflow testing
## 📦 Usage Examples
### Maven Project (Backend Only)
Maven jobs run on Ubuntu machine executors with Temurin JDK. Default is Java 21. To use Java 17:
```yaml
jobs:
- qqq-orb/publish:
context: qqq-maven-registry-credentials
branch_type: snapshot
- qqq-orb/mvn_test_only:
java_version: "17"
```
### Node.js Project (Frontend Only)
### Docker Support
```yaml
jobs:
- qqq-orb/publish:
context: qqq-maven-registry-credentials
branch_type: release
Maven jobs use machine executors with Docker pre-installed. Tests using Testcontainers, LocalStack, or other Docker-dependent frameworks work without additional configuration.
### Required Context Variables
| Variable | Purpose |
|----------|---------|
| `MAVEN_USERNAME` | Sonatype username |
| `MAVEN_PASSWORD` | Sonatype password |
| `GPG_PRIVATE_KEY_B64` | Base64-encoded GPG key |
| `GPG_KEYNAME` | GPG key ID |
| `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)
## Contributing
```bash
git clone git@github.com:QRun-IO/qqq-orb.git
cd qqq-orb
make test-all
```
### Hybrid Project (Maven + Node.js)
See [QQQ Contribution Guidelines](https://github.com/Kingsrook/qqq/blob/develop/CONTRIBUTING.md).
```yaml
jobs:
- qqq-orb/publish:
context: qqq-maven-registry-credentials
branch_type: release_candidate
```
## License
## 🤝 Contributing
**Important**: This repository is a component of the QQQ framework. All contributions, issues, and discussions should go through the main QQQ repository.
### Development Workflow
1. **Fork the main QQQ repository**: https://github.com/Kingsrook/qqq
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
3. **Make your changes** (including orb changes if applicable)
4. **Run tests**: `make test`
5. **Commit your changes**: `git commit -m 'Add amazing feature'`
6. **Push to the branch**: `git push origin feature/amazing-feature`
7. **Open a Pull Request** to the main QQQ repository
### Code Standards
- **YAML**: Follow CircleCI orb best practices
- **Shell Scripts**: Use ShellCheck for validation
- **Documentation**: Update README and inline documentation
- **Testing**: Comprehensive test coverage
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
```
QQQ Orb
Copyright (C) 2021-2024 Kingsrook, LLC
651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
contact@kingsrook.com | https://github.com/Kingsrook/
```
## 🆘 Support & Community
### ⚠️ Important: Use Main QQQ Repository
**All support, issues, discussions, and community interactions should go through the main QQQ repository:**
- **Main Repository**: https://github.com/Kingsrook/qqq
- **Issues**: https://github.com/Kingsrook/qqq/issues
- **Discussions**: https://github.com/Kingsrook/qqq/discussions
- **Wiki**: https://github.com/Kingsrook/qqq/wiki
### Why This Repository Exists
This repository is maintained separately from the main QQQ repository to:
- **Enable independent orb development** and versioning
- **Allow orb-specific CI/CD** and deployment pipelines
- **Provide clear separation** between orb and framework concerns
- **Support different release cycles** for CI/CD tools vs. core framework
### Getting Help
- **Documentation**: Check the [QQQ Wiki](https://github.com/Kingsrook/qqq/wiki)
- **Issues**: Report bugs and feature requests on [Main QQQ Issues](https://github.com/Kingsrook/qqq/issues)
- **Discussions**: Join community discussions on [Main QQQ Discussions](https://github.com/Kingsrook/qqq/discussions)
- **Questions**: Ask questions in the main QQQ repository
### Contact Information
- **Company**: Kingsrook, LLC
- **Email**: contact@kingsrook.com
- **Website**: https://qrun.io
- **Main GitHub**: https://github.com/Kingsrook/qqq
- **CircleCI Registry**: [kingsrook/qqq-orb](https://circleci.com/developer/orbs/orb/kingsrook/qqq-orb)
## 🙏 Acknowledgments
- **CircleCI Team**: For the excellent CI/CD platform and orb system
- **Maven Team**: For the powerful Java build system
- **npm Team**: For the Node.js package management system
- **QQQ Framework Team**: For the underlying low-code platform
- **Open Source Community**: For the tools and libraries that make this possible
---
**Built with ❤️ by the Kingsrook Team**
**This is a CI/CD component of the QQQ framework. For complete information, support, and community, visit: https://github.com/Kingsrook/qqq**
Apache-2.0
+2 -111
View File
@@ -1,112 +1,3 @@
# Security Policy
## Supported Versions
QQQ Orb follows semantic versioning and provides security updates for the following versions:
| Version | Supported | End of Life |
| ------- | ------------------ | ----------- |
| 2.1.x | :white_check_mark: | TBD |
| 2.0.x | :white_check_mark: | TBD |
| 1.x.x | :white_check_mark: | TBD |
| < 1.0 | :x: | EOL |
**Note**: We recommend using the latest stable version for security updates.
## Reporting a Vulnerability
**🚨 Security vulnerabilities should NEVER be reported publicly.**
If you discover a security vulnerability in QQQ Orb, please report it privately:
### **Email Security Reports**
Send security reports to: **security@kingsrook.com**
### **What to Include**
- **Description**: Clear description of the vulnerability
- **Impact**: Potential impact on users and CI/CD systems
- **Reproduction**: Steps to reproduce the issue
- **Environment**: QQQ Orb version, CircleCI version, OS details
- **Timeline**: If you need disclosure by a specific date
### **Response Timeline**
- **Initial Response**: Within 24 hours
- **Assessment**: Within 3 business days
- **Update**: Regular updates on progress
- **Resolution**: As quickly as possible based on severity
### **What Happens Next**
1. **Acknowledgment**: We'll acknowledge receipt within 24 hours
2. **Investigation**: Our security team will investigate the report
3. **Assessment**: We'll assess the severity and impact
4. **Fix Development**: Develop and test a security fix
5. **Release**: Release a security update
6. **Disclosure**: Public disclosure with credit (if requested)
## Security Best Practices
### **For Users**
- **Keep Updated**: Always use the latest stable version
- **Monitor Releases**: Watch for security advisories
- **Report Issues**: Report any security concerns immediately
- **Follow Guidelines**: Use QQQ Orb according to security best practices
- **Secure Contexts**: Ensure CircleCI contexts contain only necessary secrets
### **For Contributors**
- **Security Review**: All code changes undergo security review
- **Dependency Scanning**: Regular vulnerability scanning of dependencies
- **Secure Development**: Follow secure coding practices
- **Testing**: Security testing is part of our development process
- **Secret Management**: Never commit secrets or credentials
## Security Features
QQQ Orb includes several security features:
- **Input Validation**: Comprehensive input validation and sanitization
- **Secret Management**: Secure handling of CI/CD secrets and credentials
- **Audit Logging**: Comprehensive audit trails for CI/CD events
- **Secure Defaults**: Secure-by-default configuration
- **Dependency Scanning**: Regular scanning of orb dependencies
## Security Updates
### **Release Process**
Security updates follow our standard [Release Flow](https://github.com/Kingsrook/qqq/wiki/Release-Flow):
1. **Security Fix**: Develop and test security fix
2. **Release Branch**: Create release branch for security update
3. **Testing**: Thorough testing of security fix
4. **Release**: Release security update to users
5. **Communication**: Notify users of security update
### **Update Notifications**
- **GitHub Releases**: Security updates announced in release notes
- **Security Advisories**: GitHub security advisories for critical issues
- **Email Notifications**: Direct notifications for critical vulnerabilities
- **CircleCI Registry**: Updated orb versions in CircleCI registry
## CI/CD Security Considerations
### **CircleCI Context Security**
- **Minimal Permissions**: Use least-privilege access for contexts
- **Secret Rotation**: Regularly rotate secrets and credentials
- **Access Control**: Limit access to sensitive contexts
- **Audit Logs**: Monitor context usage and access
### **Orb Security**
- **Version Pinning**: Always pin specific orb versions
- **Source Verification**: Verify orb source and integrity
- **Regular Updates**: Keep orb versions up to date
- **Security Scanning**: Scan orb dependencies regularly
## Contact Information
- **Security Email**: security@kingsrook.com
- **General Contact**: contact@kingsrook.com
- **Company**: Kingsrook, LLC
- **Website**: https://qrun.io
---
**Thank you for helping keep QQQ Orb secure!** 🛡️
* See Project [Security Policy](https://github.com/Kingsrook/qqq/blob/develop/SECURITY.md)
+3 -4
View File
@@ -4,14 +4,13 @@ version: 2.1
description: >
QQQ Orb to handle the branching, testing, releasing, and auto updating of
all maven and npm based projects within the Kingsrook/QRunIO Repo world.
all Maven and npm based projects within the QRun-IO ecosystem.
display:
home_url: "https://www.qrun.io"
source_url: "https://github.com/Kingsrook/qqq-orb"
home_url: "https://github.com/QRun-IO/qqq-orb"
source_url: "https://github.com/QRun-IO/qqq-orb"
orbs:
localstack: localstack/platform@2.1
browser-tools: circleci/browser-tools@1.4.7
slack: circleci/slack@5.2.1
node: circleci/node@4.7
@@ -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
+6 -1
View File
@@ -11,6 +11,8 @@ steps:
- restore_cache:
keys:
- v1-dependencies-{{ checksum "pom.xml" }}
- restore_cache:
keys:
- v1-npm-dependencies-{{ checksum "package.json" }}
- run:
name: Setup NPM authentication
@@ -30,5 +32,8 @@ steps:
- save_cache:
paths:
- ~/.m2
- node_modules
key: v1-dependencies-{{ checksum "pom.xml" }}
- save_cache:
paths:
- node_modules
key: v1-npm-dependencies-{{ checksum "package.json" }}
+9
View File
@@ -33,6 +33,9 @@ steps:
- restore_cache:
keys:
- v1-dependencies-{{ checksum "pom.xml" }}
- restore_cache:
keys:
- v1-npm-dependencies-{{ checksum "package.json" }}
# (Optional) Guard: if node_modules is missing, install it quickly so "npm run build" works
- run:
@@ -67,3 +70,9 @@ steps:
paths:
- ~/.m2
key: v1-dependencies-{{ checksum "pom.xml" }}
# Re-cache Node deps
- save_cache:
paths:
- node_modules
key: v1-npm-dependencies-{{ checksum "package.json" }}
+12
View File
@@ -0,0 +1,12 @@
description: >
Full checkout of the repository with complete git history.
Uses CircleCI's checkout (handles SSH keys and known_hosts)
then fetches full history for version calculation.
steps:
- checkout
- run:
name: Fetch full git history
command: |
git fetch --unshallow || true
git fetch --tags || true
+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)>>
+30
View File
@@ -0,0 +1,30 @@
description: >
Installs Eclipse Temurin JDK and Maven on Ubuntu machine executor.
Sets JAVA_HOME and updates PATH for subsequent steps.
Optionally installs Node.js for frontend builds.
Also verifies Docker is available (required for Testcontainers/LocalStack tests).
parameters:
java_version:
type: string
default: "21"
description: >
Java major version to install (e.g., "17", "21").
Uses Eclipse Temurin (AdoptOpenJDK successor) distribution.
install_node:
type: boolean
default: false
description: "Whether to also install Node.js (for frontend builds)"
node_version:
type: string
default: "20"
description: "Node.js major version to install (e.g., '18', '20')"
steps:
- run:
name: Install Java << parameters.java_version >> and build tools
environment:
PARAM_JAVA_VERSION: << parameters.java_version >>
PARAM_INSTALL_NODE: << parameters.install_node >>
PARAM_NODE_VERSION: << parameters.node_version >>
command: <<include(scripts/install_java.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)>>
+1 -1
View File
@@ -9,4 +9,4 @@ steps:
command: <<include(scripts/node_npm_auth.sh)>>
- run:
name: "Publish to NPM"
command: npm publish --access public
command: <<include(scripts/node_npm_publish.sh)>>
+26
View File
@@ -0,0 +1,26 @@
description: >
Creates a GitHub Release for the current version tag.
- Extracts version from pom.xml or package.json
- Verifies the Git tag exists
- Creates GitHub release with auto-generated notes
- Adds artifact links to Maven Central and/or npmjs
- Handles prerelease versions (RC, SNAPSHOT, alpha, beta)
parameters:
project_type:
type: enum
enum: [maven, node, both, auto]
default: auto
description: >
Project type for artifact link generation.
- maven: Link to Maven Central
- node: Link to npmjs
- both: Link to both registries
- auto: Auto-detect from project files
steps:
- run:
name: Create GitHub Release
command: <<include(scripts/create_github_release.sh)>>
environment:
PROJECT_TYPE: << parameters.project_type >>
+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)>>
+47 -22
View File
@@ -1,58 +1,83 @@
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
orbs:
qqq-orb: kingsrook/qqq-orb@0.3.1
qqq-orb: kingsrook/qqq-orb@0.3.8
workflows:
# Test workflow for feature branches
test_only:
jobs:
- qqq-orb/mvn_test_only:
context: [ qqq-maven-registry-credentials ]
filters:
branches:
ignore: [develop, main, /release\/.*/, /hotfix\/.*/]
filters:
branches:
ignore: /(develop|main|release/.*|hotfix/.*|integration.*)/
tags:
only: []
# Snapshot deployment for develop branch
publish_snapshot:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
branch_type: snapshot
filters:
branches:
only: [develop]
filters:
branches:
only:
- develop
publish_feature:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
branch_type: feature
filters:
branches:
only:
- feature/.*
tags:
only: [ /publish.*/ ]
# Release candidate workflow
publish_release_candidate:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
branch_type: release_candidate
filters:
branches:
only: [/release\/.*/]
filters:
branches:
only:
- /release\/.*/
# Production release workflow
publish_release:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
branch_type: release
filters:
branches:
only: [main]
filters:
branches:
only: [ main ]
tags:
only: [ /v.*/ ]
# Hotfix release workflow
publish_hotfix_release:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
branch_type: hotfix
filters:
branches:
only: [/hotfix\/.*/]
filters:
branches:
only:
- /hotfix\/.*/
security_scan:
jobs:
- qqq-orb/security_scan:
context: [ qqq-maven-registry-credentials, qqq-security-credentials ]
filters:
branches:
only: [ develop ]
+18
View File
@@ -0,0 +1,18 @@
description: >
Java/OpenJDK machine executor with Docker support.
Uses Ubuntu 22.04 VM with Docker pre-installed.
Java is installed via the install_java command.
Required for tests that use Testcontainers or LocalStack Docker extensions.
parameters:
image:
default: ubuntu-2204:current
description: >
Ubuntu machine image tag. Use 'current' for latest or pin to specific
version like 'ubuntu-2204:2023.02.1' for reproducibility.
type: string
machine:
image: '<<parameters.image>>'
resource_class: large
+19 -12
View File
@@ -1,27 +1,34 @@
description: >
Unified publishing job for all branch types
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: localstack/default
executor: java
parameters:
java_version:
type: string
default: "21"
description: "Java major version to install (e.g., '17', '21')"
node_version:
type: string
default: "20"
description: "Node.js major version to install (e.g., '18', '20')"
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:
- checkout
- install_java:
java_version: << parameters.java_version >>
install_node: true
node_version: << parameters.node_version >>
- git_full_checkout
- mvn_manage_version
- frontend_build
- frontend_test
- frontend_package
- mvn_jar_deploy
- when:
condition:
or:
- equal: ["snapshot", << parameters.branch_type >>]
- equal: ["release_candidate", << parameters.branch_type >>]
steps:
- git_operations
- git_operations:
branch_type: << parameters.branch_type >>
+17 -3
View File
@@ -1,12 +1,26 @@
description: >
Complete test-only workflow for feature branches
Complete test-only workflow for feature branches with frontend
Runs build, test, API version check, and documentation generation
Used by: test_only workflow for feature branches
Triggers: Any push to branches NOT matching develop, main, release/*, hotfix/*
executor: localstack/default
executor: java
parameters:
java_version:
type: string
default: "21"
description: "Java major version to install (e.g., '17', '21')"
node_version:
type: string
default: "20"
description: "Node.js major version to install (e.g., '18', '20')"
steps:
- checkout
- install_java:
java_version: << parameters.java_version >>
install_node: true
node_version: << parameters.node_version >>
- git_full_checkout
- frontend_build
- frontend_test
+41 -8
View File
@@ -1,37 +1,70 @@
description: >
Unified publishing job for all branch types
Handles version management, building, testing, and publishing based on branch type
Supports: snapshot, release_candidate, release, and hotfix workflows
Supports: snapshot, release_candidate, release (tagged), feature (tagged) and hotfix workflows
executor: localstack/default
executor: java
parameters:
java_version:
type: string
default: "21"
description: "Java major version to install (e.g., '17', '21')"
branch_type:
type: string
default: "snapshot"
description: "Branch type: snapshot, release_candidate, release, or hotfix"
description: "Branch type: snapshot, release_candidate, release, features, or hotfix"
check_middleware_api_versions:
type: boolean
default: false
description: "Whether to run middleware API version checks"
publish_asciidoc:
type: boolean
default: false
description: "Whether to publish AsciiDoc documentation"
steps:
- checkout
- install_java:
java_version: << parameters.java_version >>
- git_full_checkout
- mvn_build
- mvn_manage_version
- attach_workspace:
at: .
- mvn_verify
- when:
condition: << parameters.check_middleware_api_versions >>
steps:
- check_middleware_api_versions
- mvn_jar_deploy
- when:
condition:
not:
equal: [ "<< parameters.branch_type >>", "feature" ]
steps:
- git_operations:
branch_type: << parameters.branch_type >>
- when:
condition: << parameters.publish_asciidoc >>
steps:
- publish_asciidoc
# GitHub releases only for final releases and hotfixes (not RCs)
# RCs just publish artifacts - GitHub release happens when merged to main
- when:
condition:
or:
- equal: ["snapshot", << parameters.branch_type >>]
- equal: ["release_candidate", << parameters.branch_type >>]
- equal: [ "<< parameters.branch_type >>", "release" ]
- equal: [ "<< parameters.branch_type >>", "hotfix" ]
steps:
- git_operations
- publish_asciidoc
- publish_github_release:
project_type: maven
+8 -2
View File
@@ -4,16 +4,22 @@ description: >
Used by: test_only workflow for feature branches
Triggers: Any push to branches NOT matching develop, main, release/*, hotfix/*
executor: localstack/default
executor: java
parameters:
java_version:
type: string
default: "21"
description: "Java major version to install (e.g., '17', '21')"
check_middleware_api_versions:
type: boolean
default: false
description: "Whether to run middleware API version checks"
steps:
- checkout
- install_java:
java_version: << parameters.java_version >>
- git_full_checkout
- mvn_build
- mvn_verify
- when:
+21 -3
View File
@@ -3,20 +3,38 @@ description: >
Handles version management, building, testing, and publishing based on branch type
Supports: snapshot, release_candidate, release, and hotfix workflows
executor: localstack/default
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')."
branch_type:
type: string
default: "snapshot"
description: "Branch type: snapshot, release_candidate, release, or hotfix"
steps:
- checkout
- 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
- node_publish
# GitHub releases only for final releases and hotfixes (not RCs)
# RCs just publish artifacts - GitHub release happens when merged to main
- when:
condition:
or:
- equal: [ "<< parameters.branch_type >>", "release" ]
- equal: [ "<< parameters.branch_type >>", "hotfix" ]
steps:
- publish_github_release:
project_type: node
+8 -2
View File
@@ -3,15 +3,21 @@ description: >
Handles testing based on branch type
Supports: snapshot, release_candidate, release, and hotfix workflows
executor: localstack/default
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')."
branch_type:
type: string
default: "snapshot"
description: "Branch type: snapshot, release_candidate, release, or hotfix"
steps:
- checkout
- git_full_checkout
- node_install_dependencies
- node_run_tests
+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
+274 -142
View File
@@ -18,7 +18,7 @@ set -e
###################
## Configuration ##
###################
POM_FILE="pom.xml"
POM_FILE="${POM_FILE:-pom.xml}"
DRY_RUN=false
##################################
@@ -29,13 +29,45 @@ if [[ "$1" == "--dry-run" ]]; then
echo "DRY RUN MODE - No changes will be made"
fi
################################################
## Function to find original feature branch ##
################################################
find_original_feature_branch() {
local original_branch=""
# Method 1: Look for remote branches containing this commit
echo "Method 1: Checking remote branches..." >&2
original_branch=$(git branch -r --contains HEAD 2>/dev/null | grep 'origin/feature/' | head -1 | sed 's/origin\///' | sed 's/^[[:space:]]*//' || echo "")
if [[ -n "$original_branch" ]]; then
echo "Found via remote branches: [$original_branch]" >&2
fi
# Return the result
if [[ "$original_branch" =~ ^feature/ ]]; then
echo "✅ Found original feature branch: [$original_branch]" >&2
echo "$original_branch"
else
echo "⚠️ Could not determine original feature branch, using generic name" >&2
echo "feature/publish"
fi
}
####################################
## Get current branch and version ##
####################################
CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
CURRENT_VERSION=$(grep '<revision>' $POM_FILE | sed 's/.*<revision>//;s/<.*//')
# Try to get branch from CircleCI environment variable first (for CI environments)
# then fall back to git command (for local development)
if [[ -n "$CIRCLE_BRANCH" ]]; then
echo "Using branch from CircleCI environment: $CIRCLE_BRANCH"
CURRENT_BRANCH="$CIRCLE_BRANCH"
else
CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
fi
CURRENT_VERSION=$(grep '<revision>' "$POM_FILE" | sed 's/.*<revision>//;s/<.*//')
# Check if we're on a tag (HEAD means we're on a tag)
CURRENT_TAG=""
if [[ "$CURRENT_BRANCH" == "HEAD" ]]; then
# Get the tag name we're on
CURRENT_TAG=$(git describe --tags --exact-match HEAD 2>/dev/null || echo "")
@@ -49,6 +81,9 @@ if [[ "$CURRENT_BRANCH" == "HEAD" ]]; then
echo "This is a release candidate tag, treating as release branch"
CURRENT_BRANCH="release/${CURRENT_TAG#v}"
CURRENT_BRANCH="release/${CURRENT_BRANCH%-RC.*}"
elif [[ "$CURRENT_TAG" =~ ^publish- ]]; then
echo "This is a publish tag for feature branch, treating as feature branch"
CURRENT_BRANCH=$(find_original_feature_branch)
else
echo "Unknown tag format: $CURRENT_TAG"
CURRENT_BRANCH="unknown"
@@ -67,6 +102,12 @@ echo "Current version: $CURRENT_VERSION"
############################################
extract_version_parts() {
local version=$1
# Remove 'v' prefix if present
if [[ "$version" =~ ^v(.+)$ ]]; then
version=${BASH_REMATCH[1]}
fi
########################################
## Handle RC versions like 1.5.0-RC.1 ##
########################################
@@ -81,6 +122,14 @@ extract_version_parts() {
MAJOR=${BASH_REMATCH[1]}
MINOR=${BASH_REMATCH[2]}
PATCH=${BASH_REMATCH[3]}
#############################################################
## Handle feature-specific versions like 1.5.0-NEW-abc1234-SNAPSHOT ##
## or 1.4.0-test-new-orb-825957d-SNAPSHOT ##
#############################################################
elif [[ "$version" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)-[a-zA-Z0-9-]+-[a-f0-9]+-SNAPSHOT$ ]]; then
MAJOR=${BASH_REMATCH[1]}
MINOR=${BASH_REMATCH[2]}
PATCH=${BASH_REMATCH[3]}
#######################################
## Handle stable versions like 1.5.0 ##
#######################################
@@ -94,139 +143,6 @@ extract_version_parts() {
fi
}
#############################################################
## Function to calculate next version based on branch type ##
#############################################################
calculate_next_version() {
local branch=$1
case "$branch" in
"develop")
#############################################################################
## Check if we just merged a release branch back to develop ##
## Look for very specific patterns that indicate a release completion ##
## Only look at recent commits to avoid historical merges triggering bumps ##
#############################################################################
RECENT_RELEASE_MERGES=$(git log --oneline -10 --grep="Merge.*release.*into.*develop" --grep="Merge.*release.*back.*develop" --grep="Bump.*version.*after.*release.*v" --since="3 days ago" || true)
#######################################################################
## Also check if current version suggests we're ready for next cycle ##
#######################################################################
if [[ -n "$RECENT_RELEASE_MERGES" ]] || [[ "$CURRENT_VERSION" =~ -RC\.[0-9]+$ ]] || [[ "$CURRENT_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
#########################################################################
## We just merged a release or have an RC/stable version, bump to next ##
#########################################################################
NEW_VERSION="$MAJOR.$((MINOR + 1)).0-SNAPSHOT"
else
################################################################
## Keep current SNAPSHOT version - no recent release activity ##
################################################################
NEW_VERSION="$CURRENT_VERSION"
fi
;;
"main")
###############################################################################
## Main should always have stable versions ##
## Check for version tags to detect releases instead of merge commits ##
###############################################################################
echo "In Main - Looking for the most recent version tag"
# If we're on a tag, use that tag; otherwise find the latest tag
if [[ "$CURRENT_BRANCH" == "main" && -n "$CURRENT_TAG" ]]; then
LATEST_TAG="$CURRENT_TAG"
echo "Using current tag: $LATEST_TAG"
else
LATEST_TAG=$(git describe --tags --abbrev=0 --match="v*" 2>/dev/null || echo "")
echo "Found latest tag: $LATEST_TAG"
fi
if [[ -n "$LATEST_TAG" ]]; then
# Extract version from tag (e.g., v1.5.0 -> 1.5.0)
if [[ "$LATEST_TAG" =~ ^v([0-9]+\.[0-9]+\.[0-9]+)$ ]]; then
TAG_VERSION=${BASH_REMATCH[1]}
echo "Release tag: $LATEST_TAG (version: $TAG_VERSION)"
# Check if current version matches the tag
if [[ "$CURRENT_VERSION" == "$TAG_VERSION" ]]; then
################################################################
## We're at the tagged release, keep stable version ##
################################################################
NEW_VERSION="$CURRENT_VERSION"
echo "Version matches release tag, keeping stable version"
elif [[ "$CURRENT_VERSION" =~ -RC\.[0-9]+$ ]]; then
########################################################################
## We have an RC version, convert to the tag version ##
########################################################################
NEW_VERSION="$TAG_VERSION"
echo "Converting RC version to tag version: $NEW_VERSION"
else
#####################################################################
## Keep current version (might be ahead of tag) ##
#####################################################################
NEW_VERSION="$CURRENT_VERSION"
echo "Keeping current version (ahead of tag)"
fi
else
echo "Warning: Tag format not recognized: $LATEST_TAG"
NEW_VERSION="$CURRENT_VERSION"
fi
else
#####################################################################
## No tags found - main branch should always have a release tag ##
#####################################################################
echo "ERROR: No version tags found on main branch"
echo "Main branch should always have a corresponding release tag (e.g., v1.5.0)"
echo "Please create a release tag before deploying from main"
exit 1
fi
;;
release/*)
############################################################################
## Extract major.minor from branch name (e.g., release/1.5 -> 1.5.0-RC.n) ##
############################################################################
if [[ "$branch" =~ release/([0-9]+)\.([0-9]+) ]]; then
BRANCH_MAJOR=${BASH_REMATCH[1]}
BRANCH_MINOR=${BASH_REMATCH[2]}
############################################
## Check if we already have an RC version ##
############################################
if [[ "$CURRENT_VERSION" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)-RC\.([0-9]+)$ ]]; then
################################################
## Extract current RC number and increment it ##
################################################
CURRENT_RC=${BASH_REMATCH[4]}
NEW_RC=$((CURRENT_RC + 1))
NEW_VERSION="$BRANCH_MAJOR.$BRANCH_MINOR.0-RC.$NEW_RC"
else
###############################
## First RC for this release ##
###############################
NEW_VERSION="$BRANCH_MAJOR.$BRANCH_MINOR.0-RC.1"
fi
else
echo "ERROR: Invalid release branch format: $branch"
exit 1
fi
;;
hotfix/*)
###################################
## Bump patch version for hotfix ##
###################################
NEW_VERSION="$MAJOR.$MINOR.$((PATCH + 1))"
;;
feature/*|*)
###############################################################
## Feature branches inherit version from develop, no changes ##
###############################################################
NEW_VERSION="$CURRENT_VERSION"
;;
esac
}
#########################################
## Function to set version using Maven ##
@@ -237,7 +153,6 @@ set_version() {
if [[ "$DRY_RUN" == "true" ]]; then
echo "DRY RUN: Would set version to: $new_version"
echo "Command: mvn versions:set-property -Dproperty=revision -DnewVersion=$new_version -DgenerateBackupPoms=false"
return
fi
@@ -247,12 +162,11 @@ set_version() {
## Use Maven versions plugin to set version ##
##############################################
mvn versions:set-property -Dproperty=revision -DnewVersion="$new_version" -DgenerateBackupPoms=false
#######################
## Verify the change ##
#######################
ACTUAL_VERSION=$(grep "<revision>" $POM_FILE | sed 's/.*<revision>//;s/<.*//')
ACTUAL_VERSION=$(grep "<revision>" "$POM_FILE" | sed 's/.*<revision>//;s/<.*//')
if [[ "$ACTUAL_VERSION" == "$new_version" ]]; then
echo "✅ Version successfully updated to: $ACTUAL_VERSION"
else
@@ -261,6 +175,195 @@ set_version() {
fi
}
#############################################
## Branch Detection and Routing Functions ##
#############################################
detect_branch_type() {
local branch=$1
if [[ "$branch" == "main" ]]; then
echo "main"
elif [[ "$branch" == "develop" ]]; then
echo "develop"
elif [[ "$branch" =~ ^release/ ]]; then
echo "release"
elif [[ "$branch" =~ ^hotfix/ ]]; then
echo "hotfix"
elif [[ "$branch" =~ ^feature/ ]]; then
echo "feature"
else
echo "unknown"
fi
}
#############################################
## Branch-Specific Version Handlers ##
#############################################
handle_main_branch() {
echo "=== Handling MAIN branch ==="
echo "Main branch should always have stable versions"
echo "Looking for the most recent version tag"
# If we're on a tag, use that tag; otherwise find the latest tag
local latest_tag=""
if [[ -n "$CURRENT_TAG" ]]; then
latest_tag="$CURRENT_TAG"
echo "Using current tag: $latest_tag"
else
latest_tag=$(git describe --tags --abbrev=0 --match="v*" 2>/dev/null || echo "")
echo "Found latest tag: $latest_tag"
fi
if [[ -n "$latest_tag" ]]; then
# Extract version from tag (e.g., v1.5.0 -> 1.5.0)
if [[ "$latest_tag" =~ ^v([0-9]+\.[0-9]+\.[0-9]+)$ ]]; then
local tag_version=${BASH_REMATCH[1]}
echo "Release tag: $latest_tag (version: $tag_version)"
# Check if current version matches the tag
if [[ "$CURRENT_VERSION" == "$tag_version" ]]; then
echo "Version matches release tag, keeping stable version"
NEW_VERSION="$CURRENT_VERSION"
elif [[ "$CURRENT_VERSION" =~ -RC\.[0-9]+$ ]]; then
echo "Converting RC version to tag version: $tag_version"
NEW_VERSION="$tag_version"
else
NEW_VERSION="$tag_version"
fi
else
echo "Warning: Tag format not recognized: $latest_tag"
NEW_VERSION="$CURRENT_VERSION"
fi
else
echo "ERROR: No version tags found on main branch"
echo "Main branch should always have a corresponding release tag (e.g., v1.5.0)"
echo "Please create a release tag before deploying from main"
exit 1
fi
}
handle_develop_branch() {
echo "=== Handling DEVELOP branch ==="
echo "Develop branch manages SNAPSHOT versions"
# Check if we just merged a release branch back to develop
local recent_release_merges
recent_release_merges=$(git log --oneline -10 --grep="Merge.*release.*into.*develop" --grep="Merge.*release.*back.*develop" --grep="Bump.*version.*after.*release.*v" --since="3 days ago" || true)
# Also check if current version suggests we're ready for next cycle
if [[ -n "$recent_release_merges" ]] || [[ "$CURRENT_VERSION" =~ -RC\.[0-9]+$ ]] || [[ "$CURRENT_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
echo "Recent release activity detected or RC/stable version found"
echo "Bumping to next minor version SNAPSHOT"
NEW_VERSION="$MAJOR.$((MINOR + 1)).0-SNAPSHOT"
else
echo "No recent release activity, keeping current SNAPSHOT version"
NEW_VERSION="$CURRENT_VERSION"
fi
}
handle_release_branch() {
echo "=== Handling RELEASE branch ==="
echo "Release branch manages RC versions"
# Extract major.minor from branch name (e.g., release/1.5 -> 1.5.0-RC.n)
if [[ "$CURRENT_BRANCH" =~ release/([0-9]+)\.([0-9]+) ]]; then
local branch_major=${BASH_REMATCH[1]}
local branch_minor=${BASH_REMATCH[2]}
echo "Release branch: $branch_major.$branch_minor"
# Check if we already have an RC version
if [[ "$CURRENT_VERSION" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)-RC\.([0-9]+)$ ]]; then
# Extract current RC number and increment it
local current_rc=${BASH_REMATCH[4]}
local new_rc=$((current_rc + 1))
echo "Incrementing RC from $current_rc to $new_rc"
NEW_VERSION="$branch_major.$branch_minor.0-RC.$new_rc"
else
# First RC for this release
echo "Creating first RC for this release"
NEW_VERSION="$branch_major.$branch_minor.0-RC.1"
fi
else
echo "ERROR: Invalid release branch format: $CURRENT_BRANCH"
echo "Expected format: release/X.Y (e.g., release/1.5)"
exit 1
fi
}
handle_hotfix_branch() {
echo "=== Handling HOTFIX branch ==="
echo "Hotfix branch bumps patch version"
NEW_VERSION="$MAJOR.$MINOR.$((PATCH + 1))"
echo "Bumping patch version: $CURRENT_VERSION -> $NEW_VERSION"
}
handle_feature_branch() {
echo "=== Handling FEATURE branch ==="
echo "Feature branches create unique SNAPSHOT versions"
# Extract feature name from branch (e.g., feature/new-feature -> new-feature)
local feature_name
if [[ "$CURRENT_BRANCH" =~ ^feature/(.+)$ ]]; then
feature_name=${BASH_REMATCH[1]}
else
feature_name="unknown"
fi
# Create safe abbreviation (first 3 characters, uppercase)
local feature_abbrev
feature_abbrev=$(echo "$feature_name" | cut -c1-100 | tr '[:upper:]' '[:lower:]')
# Generate short commit hash
local commit_hash
commit_hash=$(git rev-parse --short HEAD 2>/dev/null || echo "unknown")
# Create unique SNAPSHOT version
if [[ "$CURRENT_VERSION" =~ ^([0-9]+\.[0-9]+\.[0-9]+)-SNAPSHOT$ ]]; then
# Convert SNAPSHOT to feature-specific version
local base_version=${BASH_REMATCH[1]}
NEW_VERSION="$base_version-$feature_abbrev-$commit_hash-SNAPSHOT"
echo "Creating feature-specific version: $NEW_VERSION"
elif [[ "$CURRENT_VERSION" =~ ^([0-9]+\.[0-9]+\.[0-9]+)$ ]]; then
# Convert stable version to feature-specific SNAPSHOT
NEW_VERSION="$CURRENT_VERSION-$feature_abbrev-$commit_hash-SNAPSHOT"
echo "Converting stable version to feature-specific SNAPSHOT: $NEW_VERSION"
else
# Check if it's already a feature-specific format
if [[ "$CURRENT_VERSION" =~ ^([0-9]+\.[0-9]+\.[0-9]+)-([A-Z]{3})-([a-f0-9]{7})-SNAPSHOT$ ]]; then
local base_version=${BASH_REMATCH[1]}
local existing_abbrev=${BASH_REMATCH[2]}
local existing_hash=${BASH_REMATCH[3]}
# Check if the commit hash has changed
if [[ "$existing_hash" != "$commit_hash" ]]; then
# Update to new commit hash
NEW_VERSION="$base_version-$existing_abbrev-$commit_hash-SNAPSHOT"
echo "Updating feature-specific version with new commit hash: $NEW_VERSION"
else
# Keep current version if commit hash hasn't changed
NEW_VERSION="$CURRENT_VERSION"
echo "Keeping current feature-specific version: $NEW_VERSION"
fi
else
# Unknown format, keep as-is
NEW_VERSION="$CURRENT_VERSION"
echo "Keeping current version (unknown format): $NEW_VERSION"
fi
fi
}
handle_unknown_branch() {
echo "=== Handling UNKNOWN branch ==="
echo "Unknown branch type, keeping current version"
NEW_VERSION="$CURRENT_VERSION"
echo "Keeping current version: $NEW_VERSION"
}
####################
## Main execution ##
####################
@@ -278,9 +381,38 @@ main() {
echo ""
############################
## Calculate next version ##
## Detect branch type and route ##
############################
calculate_next_version "$CURRENT_BRANCH"
local branch_type
branch_type=$(detect_branch_type "$CURRENT_BRANCH")
echo "Detected branch type: $branch_type"
echo ""
############################
## Route to appropriate handler ##
############################
case "$branch_type" in
"main")
handle_main_branch
;;
"develop")
handle_develop_branch
;;
"release")
handle_release_branch
;;
"hotfix")
handle_hotfix_branch
;;
"feature")
handle_feature_branch
;;
*)
handle_unknown_branch
;;
esac
echo ""
echo "Calculated next version: $NEW_VERSION"
echo ""
@@ -296,7 +428,7 @@ main() {
###################
echo ""
echo "Changes made:"
git diff $POM_FILE
git diff "$POM_FILE"
else
echo "No version change needed. Current version is correct for branch: $CURRENT_BRANCH"
fi
+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"
+217 -48
View File
@@ -3,86 +3,255 @@
############################################################################
## create_github_release.sh
## GitHub Release Creation Script
##
##
## This script creates GitHub releases for production releases.
## The Git tag should already exist from the version management process.
## This script creates the corresponding GitHub release using the GitHub API.
##
## Process:
## 1. Extracts version from pom.xml revision field
## 2. Verifies the Git tag exists (should be created by version management)
## 3. Creates GitHub release using GitHub API (no gh CLI required)
## 4. Generates release notes from recent commits
## 1. Extracts version from pom.xml or package.json
## 2. Verifies the Git tag exists
## 3. Creates GitHub release using GitHub API with auto-generated notes
## 4. Adds artifact links to Maven Central and/or npmjs
##
## Usage: Called by CircleCI orb commands publish_release and publish_hotfix
## Environment Variables:
## GITHUB_TOKEN - Required: GitHub token with repo scope
## PROJECT_TYPE - Optional: maven, node, or both (default: auto-detect)
## DRY_RUN - Optional: Set to "true" to skip API calls
## CIRCLE_PROJECT_USERNAME - CircleCI: GitHub org/user
## CIRCLE_PROJECT_REPONAME - CircleCI: Repository name
##
## Usage: Called by CircleCI orb command publish_github_release
## Output: Creates GitHub release for the existing tag
############################################################################
set -e
##################################
## Extract version from pom.xml ##
##################################
VERSION=$(grep '<revision>' pom.xml | sed 's/.*<revision>//;s/<.*//')
###################
## Configuration ##
###################
DRY_RUN="${DRY_RUN:-false}"
REPO_OWNER="${CIRCLE_PROJECT_USERNAME:-}"
REPO_NAME="${CIRCLE_PROJECT_REPONAME:-}"
API_URL="https://api.github.com/repos/${REPO_OWNER}/${REPO_NAME}/releases"
############################
## Validate configuration ##
############################
if [[ -z "$GITHUB_TOKEN" ]]; then
echo "ERROR: GITHUB_TOKEN environment variable is not set"
exit 1
fi
if [[ -z "$REPO_OWNER" ]] || [[ -z "$REPO_NAME" ]]; then
echo "ERROR: CIRCLE_PROJECT_USERNAME and CIRCLE_PROJECT_REPONAME must be set"
exit 1
fi
echo "Repository: ${REPO_OWNER}/${REPO_NAME}"
###############################
## Extract version from file ##
###############################
VERSION=""
PROJECT_TYPE="${PROJECT_TYPE:-auto}"
# Auto-detect project type if not specified
if [[ "$PROJECT_TYPE" == "auto" ]]; then
if [[ -f "pom.xml" ]]; then
PROJECT_TYPE="maven"
elif [[ -f "package.json" ]]; then
PROJECT_TYPE="node"
else
echo "ERROR: Cannot detect project type. No pom.xml or package.json found."
exit 1
fi
fi
echo "Project type: $PROJECT_TYPE"
# Extract version based on project type
if [[ "$PROJECT_TYPE" == "maven" ]] || [[ "$PROJECT_TYPE" == "both" ]]; then
if [[ -f "pom.xml" ]]; then
VERSION=$(grep '<revision>' pom.xml | sed 's/.*<revision>//;s/<.*//' | head -1)
if [[ -z "$VERSION" ]]; then
# Fallback to version tag if revision not found
VERSION=$(grep -m1 '<version>' pom.xml | sed 's/.*<version>//;s/<.*//')
fi
fi
fi
if [[ -z "$VERSION" ]] && { [[ "$PROJECT_TYPE" == "node" ]] || [[ "$PROJECT_TYPE" == "both" ]]; }; then
if [[ -f "package.json" ]]; then
VERSION=$(jq -r '.version' package.json)
fi
fi
if [[ -z "$VERSION" ]]; then
echo "ERROR: Could not extract version from project files"
exit 1
fi
TAG_NAME="v$VERSION"
echo "Creating GitHub release for tag: $TAG_NAME"
echo "Version: $VERSION"
echo "Tag: $TAG_NAME"
#######################################
## Determine if this is a prerelease ##
#######################################
PRERELEASE="false"
if [[ "$VERSION" =~ -RC\.[0-9]+$ ]] || [[ "$VERSION" =~ -SNAPSHOT$ ]] || [[ "$VERSION" =~ -alpha ]] || [[ "$VERSION" =~ -beta ]]; then
PRERELEASE="true"
echo "This is a prerelease version"
fi
##########################################
## Verify the tag exists (should be created by version management) ##
## Verify the tag exists ##
##########################################
if ! git tag --list | grep -q "^$TAG_NAME$"; then
echo "ERROR: Tag $TAG_NAME does not exist"
echo "The tag should have been created by the version management process"
exit 1
# Also check for version- prefix format
ALT_TAG="version-$VERSION"
if git tag --list | grep -q "^$ALT_TAG$"; then
TAG_NAME="$ALT_TAG"
echo "Using alternate tag format: $TAG_NAME"
else
echo "ERROR: Tag $TAG_NAME does not exist"
echo "The tag should have been created by the version management process"
exit 1
fi
fi
echo "Tag $TAG_NAME exists, proceeding with GitHub release creation"
##########################################
## Generate release notes from commits ##
##########################################
echo "Generating release notes..."
################################
## Build artifact links ##
################################
ARTIFACT_SECTION=""
# Get the previous tag for comparison
PREVIOUS_TAG=$(git describe --tags --abbrev=0 --match="v*" HEAD~1 2>/dev/null || echo "")
# Maven Central links
if [[ "$PROJECT_TYPE" == "maven" ]] || [[ "$PROJECT_TYPE" == "both" ]]; then
if [[ -f "pom.xml" ]]; then
GROUP_ID=$(grep -m1 '<groupId>' pom.xml | sed 's/.*<groupId>//;s/<.*//')
ARTIFACT_ID=$(grep -m1 '<artifactId>' pom.xml | sed 's/.*<artifactId>//;s/<.*//')
if [[ -n "$PREVIOUS_TAG" ]]; then
echo "Comparing with previous release: $PREVIOUS_TAG"
RELEASE_NOTES=$(git log --pretty=format:"- %s" "$PREVIOUS_TAG"..HEAD | head -20)
else
echo "No previous tag found, using recent commits"
RELEASE_NOTES=$(git log --pretty=format:"- %s" -10)
if [[ -n "$GROUP_ID" ]] && [[ -n "$ARTIFACT_ID" ]]; then
MAVEN_URL="https://central.sonatype.com/artifact/${GROUP_ID}/${ARTIFACT_ID}/${VERSION}"
ARTIFACT_SECTION="### Artifacts
**Maven Central:**
- [${GROUP_ID}:${ARTIFACT_ID}:${VERSION}](${MAVEN_URL})"
echo "Maven artifact: ${GROUP_ID}:${ARTIFACT_ID}"
fi
fi
fi
# Create a more detailed release notes
FULL_NOTES="## Release $VERSION
# NPM links
if [[ "$PROJECT_TYPE" == "node" ]] || [[ "$PROJECT_TYPE" == "both" ]]; then
if [[ -f "package.json" ]]; then
NPM_PACKAGE=$(jq -r '.name' package.json)
### Changes
$RELEASE_NOTES
if [[ -n "$NPM_PACKAGE" ]] && [[ "$NPM_PACKAGE" != "null" ]]; then
NPM_URL="https://www.npmjs.com/package/${NPM_PACKAGE}/v/${VERSION}"
if [[ -n "$ARTIFACT_SECTION" ]]; then
ARTIFACT_SECTION="${ARTIFACT_SECTION}
### Artifacts
This release includes Maven artifacts published to Maven Central.
**NPM:**
- [${NPM_PACKAGE}@${VERSION}](${NPM_URL})"
else
ARTIFACT_SECTION="### Artifacts
**NPM:**
- [${NPM_PACKAGE}@${VERSION}](${NPM_URL})"
fi
echo "NPM package: ${NPM_PACKAGE}"
fi
fi
fi
# Add footer
if [[ -n "$ARTIFACT_SECTION" ]]; then
ARTIFACT_SECTION="${ARTIFACT_SECTION}
---
*Automated release from CircleCI*"
_Automated release via CircleCI_"
fi
###########################
## Create GitHub release ##
###########################
echo "Creating GitHub release for $TAG_NAME"
# Create the release using GitHub API
curl -X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token $GITHUB_TOKEN" \
-H "Content-Type: application/json" \
-d "{
\"tag_name\": \"$TAG_NAME\",
\"name\": \"Release $VERSION\",
\"body\": $(echo "$FULL_NOTES" | jq -Rs .),
\"draft\": false,
\"prerelease\": false
}" \
"https://api.github.com/repos/Kingsrook/qqq/releases"
if [[ "$DRY_RUN" == "true" ]]; then
echo "DRY RUN: Would create release with:"
echo " Tag: $TAG_NAME"
echo " Name: Release $VERSION"
echo " Prerelease: $PRERELEASE"
echo " Artifact section:"
echo "$ARTIFACT_SECTION"
echo "DRY RUN: Skipping API call"
exit 0
fi
echo "✅ GitHub release created successfully for $TAG_NAME"
# Build the request body
# Using generate_release_notes to auto-generate from PRs (respects .github/release.yml)
REQUEST_BODY=$(jq -n \
--arg tag "$TAG_NAME" \
--arg name "Release $VERSION" \
--arg body "$ARTIFACT_SECTION" \
--argjson prerelease "$PRERELEASE" \
'{
tag_name: $tag,
name: $name,
body: $body,
draft: false,
prerelease: $prerelease,
generate_release_notes: true
}')
# Create the release with retry logic
MAX_RETRIES=2
RETRY_COUNT=0
while [[ $RETRY_COUNT -lt $MAX_RETRIES ]]; do
HTTP_RESPONSE=$(curl -s -w "\n%{http_code}" -X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token $GITHUB_TOKEN" \
-H "Content-Type: application/json" \
-d "$REQUEST_BODY" \
"$API_URL")
HTTP_BODY=$(echo "$HTTP_RESPONSE" | sed '$d')
HTTP_CODE=$(echo "$HTTP_RESPONSE" | tail -n1)
if [[ "$HTTP_CODE" -ge 200 ]] && [[ "$HTTP_CODE" -lt 300 ]]; then
RELEASE_URL=$(echo "$HTTP_BODY" | jq -r '.html_url')
echo "GitHub release created successfully: $RELEASE_URL"
exit 0
elif [[ "$HTTP_CODE" -ge 500 ]]; then
echo "Server error (HTTP $HTTP_CODE), retrying..."
RETRY_COUNT=$((RETRY_COUNT + 1))
sleep 2
elif [[ "$HTTP_CODE" == "422" ]]; then
# Check if release already exists
if echo "$HTTP_BODY" | grep -q "already_exists"; then
echo "Release for $TAG_NAME already exists, skipping"
exit 0
else
echo "ERROR: GitHub API returned HTTP $HTTP_CODE"
echo "$HTTP_BODY"
# Don't fail the build - artifacts are already published
echo "WARNING: GitHub release creation failed, but artifacts are published"
exit 0
fi
else
echo "ERROR: GitHub API returned HTTP $HTTP_CODE"
echo "$HTTP_BODY"
# Don't fail the build - artifacts are already published
echo "WARNING: GitHub release creation failed, but artifacts are published"
exit 0
fi
done
echo "WARNING: GitHub release creation failed after $MAX_RETRIES retries"
echo "Artifacts are published, continuing..."
exit 0
+14 -1
View File
@@ -3,7 +3,7 @@
############################################################################
## frontend_test_collect_results.sh
## Collect JUnit XML Test Results
##
##
## This script collects JUnit XML test results from the Maven
## surefire reports directory for CircleCI test reporting.
##
@@ -16,3 +16,16 @@ set -e
echo "Collecting JUnit XML test results"
mkdir -p ~/test-results/junit/
find . -type f -regex ".*/target/surefire-reports/.*xml" -exec cp {} ~/test-results/junit/ \; || true
############################################################################
## Strip rerunFailure elements that CircleCI's JUnit parser doesn't support
## These are added by Maven Surefire when rerunFailingTestsCount > 0
############################################################################
echo "Cleaning JUnit XML files for CircleCI compatibility"
for xml_file in ~/test-results/junit/*.xml; do
if [ -f "$xml_file" ]; then
sed -i.bak '/<rerunFailure/,/<\/rerunFailure>/d' "$xml_file" 2>/dev/null || \
sed -i '' '/<rerunFailure/,/<\/rerunFailure>/d' "$xml_file" 2>/dev/null || true
rm -f "${xml_file}.bak" 2>/dev/null || true
fi
done
+2 -1
View File
@@ -14,6 +14,7 @@
set -e
echo "Installing browser dependencies"
export DEBIAN_FRONTEND=noninteractive
sudo apt-get update
sudo apt-get install -y \
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y \
libnss3-dev libgdk-pixbuf2.0-dev libgtk-3-dev libxss-dev
+57
View File
@@ -0,0 +1,57 @@
#!/bin/bash
set -euo pipefail
# Install Java and Maven on Ubuntu machine executor
# Uses Eclipse Temurin (AdoptOpenJDK successor) for reliable JDK installation
# Optionally installs Node.js via NodeSource repository
JAVA_VERSION="${PARAM_JAVA_VERSION:-21}"
INSTALL_NODE="${PARAM_INSTALL_NODE:-false}"
NODE_VERSION="${PARAM_NODE_VERSION:-20}"
echo "Installing Java ${JAVA_VERSION} and Maven..."
# Add Eclipse Temurin repository
sudo apt-get update -qq
sudo apt-get install -y -qq wget apt-transport-https gpg maven curl
# Add Temurin GPG key
wget -qO - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo gpg --dearmor -o /usr/share/keyrings/adoptium.gpg
# Add repository
echo "deb [signed-by=/usr/share/keyrings/adoptium.gpg] https://packages.adoptium.net/artifactory/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
# Install Java
sudo apt-get update -qq
sudo apt-get install -y -qq "temurin-${JAVA_VERSION}-jdk"
# Set JAVA_HOME
JAVA_HOME="/usr/lib/jvm/temurin-${JAVA_VERSION}-jdk-amd64"
echo "export JAVA_HOME=${JAVA_HOME}" >> "${BASH_ENV}"
echo "export PATH=${JAVA_HOME}/bin:\$PATH" >> "${BASH_ENV}"
# Install Node.js if requested
if [ "${INSTALL_NODE}" = "true" ]; then
echo ""
echo "Installing Node.js ${NODE_VERSION}..."
curl -fsSL "https://deb.nodesource.com/setup_${NODE_VERSION}.x" | sudo -E bash -
sudo apt-get install -y -qq nodejs
echo ""
echo "Node.js version:"
node --version
echo "npm version:"
npm --version
fi
# Verify installation
echo ""
echo "Java version:"
java -version
echo ""
echo "Maven version:"
mvn --version
echo ""
echo "Docker version:"
docker --version
echo ""
echo "Installation completed successfully"
+27 -2
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 ##
################################################################
@@ -27,8 +37,23 @@ if [[ -n "$(git status --porcelain pom.xml)" ]]; then
NEW_VERSION=$(grep '<revision>' pom.xml | sed 's/.*<revision>//;s/<.*//')
git add pom.xml
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
+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 "========================"
+44
View File
@@ -0,0 +1,44 @@
#!/bin/bash
############################################################################
## node_npm_publish.sh
## NPM Publishing Script with Prerelease Tag Support
##
## This script publishes npm packages with proper handling of prerelease
## versions. NPM requires a --tag flag for prerelease versions.
##
## Prerelease detection:
## - RC versions (e.g., 1.0.0-RC.1) -> --tag rc
## - SNAPSHOT versions (e.g., 1.0.0-SNAPSHOT) -> --tag snapshot
## - Alpha/Beta versions -> --tag next
## - Stable versions (e.g., 1.0.0) -> --tag latest (default)
##
## Usage: Called by CircleCI orb command node_publish
############################################################################
set -e
# Extract version from package.json
VERSION=$(grep '"version"' package.json | sed 's/.*"version": "//;s/".*//')
echo "Publishing version: $VERSION"
# Determine the appropriate npm tag based on version
if [[ "$VERSION" =~ -RC\.[0-9]+$ ]]; then
NPM_TAG="rc"
echo "Detected RC version - using tag: $NPM_TAG"
elif [[ "$VERSION" =~ -SNAPSHOT$ ]]; then
NPM_TAG="snapshot"
echo "Detected SNAPSHOT version - using tag: $NPM_TAG"
elif [[ "$VERSION" =~ -(alpha|beta) ]]; then
NPM_TAG="next"
echo "Detected alpha/beta version - using tag: $NPM_TAG"
else
NPM_TAG="latest"
echo "Detected stable version - using tag: $NPM_TAG"
fi
# Publish with the appropriate tag
echo "Running: npm publish --access public --tag $NPM_TAG"
npm publish --access public --tag "$NPM_TAG"
echo "Successfully published $VERSION with tag $NPM_TAG"
+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})"
+113
View File
@@ -0,0 +1,113 @@
# Calculate Version Script Test Suite
This directory contains comprehensive tests for the `calculate_version.sh` script.
## Test Files
- `test_calculate_version.sh` - Main test suite with comprehensive test cases
- `run_tests.sh` - Test runner with different output modes
- `README.md` - This documentation
## Running Tests
### Quick Test Run
```bash
./tests/run_tests.sh
```
### Verbose Test Run
```bash
./tests/run_tests.sh --verbose
```
### CI Mode (minimal output)
```bash
./tests/run_tests.sh --ci
```
### Direct Test Suite
```bash
./tests/test_calculate_version.sh
./tests/test_calculate_version.sh --verbose
```
## Test Coverage
The test suite covers:
### Branch Types
- **Main Branch**: Tests stable version handling, tag detection, RC conversion
- **Develop Branch**: Tests SNAPSHOT version management, release detection
- **Release Branch**: Tests RC version creation and incrementing
- **Hotfix Branch**: Tests patch version bumping
- **Feature Branch**: Tests version inheritance
### Edge Cases
- Invalid branch formats
- Unknown branch types
- Missing tags on main branch
- Various version formats (stable, SNAPSHOT, RC)
### Version Parsing
- Standard versions: `1.0.0`
- SNAPSHOT versions: `1.0.0-SNAPSHOT`
- RC versions: `1.0.0-RC.1`, `1.0.0-RC.10`
- Multi-digit versions: `10.20.30`
## Test Environment
The test suite:
1. Creates a temporary test directory
2. Initializes a test git repository
3. Creates test pom.xml files with different versions
4. Creates test branches and tags
5. Runs the calculate_version.sh script
6. Validates the output
7. Cleans up test data
## Integration with Make
The tests are integrated into the Makefile and can be run with:
```bash
make test-scripts
```
## Test Results
The test suite provides:
- ✅ Pass/fail status for each test
- 📊 Summary statistics
- 🔍 Detailed output in verbose mode
- 🚫 Clean exit codes for CI integration
## Adding New Tests
To add new test cases:
1. Add a new test function in `test_calculate_version.sh`
2. Call `run_test` with appropriate parameters:
```bash
run_test "Test Name" "branch_name" "current_version" "expected_version" "tag_name"
```
3. Add the test function to the main execution flow
4. Update this README if needed
## Troubleshooting
### Common Issues
1. **Permission denied**: Make sure test scripts are executable
```bash
chmod +x tests/*.sh
```
2. **Git not found**: Ensure git is installed and available in PATH
3. **Test failures**: Run with `--verbose` to see detailed output
```bash
./tests/run_tests.sh --verbose
```
### Debug Mode
For debugging, you can run individual test functions by modifying the main function in `test_calculate_version.sh` to call only specific test functions.
+91
View File
@@ -0,0 +1,91 @@
#!/bin/bash
################################################################
## run_tests.sh ##
## Test runner for calculate_version.sh script ##
## ##
## This script runs the comprehensive test suite and provides ##
## different output formats for different use cases. ##
## ##
## Usage: ./run_tests.sh [--verbose] [--ci] ##
################################################################
set -e
###################
## Configuration ##
###################
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
TEST_SCRIPT="$SCRIPT_DIR/test_calculate_version.sh"
VERBOSE=false
CI_MODE=false
##################################
## Parse command line arguments ##
##################################
while [[ $# -gt 0 ]]; do
case $1 in
--verbose)
VERBOSE=true
shift
;;
--ci)
CI_MODE=true
shift
;;
*)
echo "Usage: $0 [--verbose] [--ci]"
echo " --verbose Show detailed test output"
echo " --ci CI mode (minimal output, exit codes for CI)"
exit 1
;;
esac
done
####################
## Main execution ##
####################
main() {
echo "🧪 Running calculate_version.sh test suite..."
###############################
## Verify test script exists ##
###############################
if [[ ! -f "$TEST_SCRIPT" ]]; then
echo "❌ Test script not found: $TEST_SCRIPT"
exit 1
fi
###############
## Run tests ##
###############
local test_args=""
if [[ "$VERBOSE" == "true" ]]; then
test_args="--verbose"
fi
if [[ "$CI_MODE" == "true" ]]; then
###############################################
## CI mode: minimal output, focus on results ##
###############################################
echo "Running tests in CI mode..."
if "$TEST_SCRIPT" $test_args > /tmp/test_output.log 2>&1; then
echo "✅ All tests passed!"
exit 0
else
echo "❌ Tests failed!"
echo "Test output:"
cat /tmp/test_output.log
exit 1
fi
else
###################################
## Interactive mode: full output ##
###################################
"$TEST_SCRIPT" $test_args
fi
}
#######################
## Run main function ##
#######################
main "$@"
+581
View File
@@ -0,0 +1,581 @@
#!/bin/bash
#######################################################################
## test_calculate_version.sh ##
## Comprehensive test suite for calculate_version.sh script ##
## ##
## This test suite validates all branch types and edge cases for the ##
## version calculation script. ##
## ##
## Usage: ./test_calculate_version.sh [--verbose] ##
#######################################################################
set -e
###################
## Configuration ##
###################
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
CALCULATE_VERSION_SCRIPT="$PROJECT_ROOT/src/scripts/calculate_version.sh"
TEST_DIR="$PROJECT_ROOT/tests/test_data"
VERBOSE=false
###################
## Test counters ##
###################
TESTS_RUN=0
TESTS_PASSED=0
TESTS_FAILED=0
##################################
## Parse command line arguments ##
##################################
if [[ "$1" == "--verbose" ]]; then
VERBOSE=true
fi
##############################
## Test Framework Functions ##
##############################
################################################
## Create a temporary directory for test data ##
################################################
setup_test_environment() {
echo "Setting up test environment..."
#################################################
## Remove existing test directory if it exists ##
#################################################
if [[ -d "$TEST_DIR" ]]; then
rm -rf "$TEST_DIR"
fi
#################################
## Create fresh test directory ##
#################################
mkdir -p "$TEST_DIR"
##################################
## Create a test git repository ##
##################################
cd "$TEST_DIR"
git init --quiet
git config user.name "Test User"
git config user.email "test@example.com"
echo "✅ Test environment ready"
}
###############################
## Clean up test environment ##
###############################
cleanup_test_environment() {
echo "Cleaning up test environment..."
cd "$PROJECT_ROOT"
rm -rf "$TEST_DIR"
echo "✅ Cleanup complete"
}
################################
## Create a test pom.xml file ##
################################
create_test_pom() {
local version="$1"
cat > "$TEST_DIR/pom.xml" << EOF
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>test-project</artifactId>
<version>1.0.0</version>
<properties>
<revision>$version</revision>
</properties>
</project>
EOF
}
##########################
## Create a test branch ##
##########################
create_test_branch() {
local branch_name="$1"
local tag_name="$2"
cd "$TEST_DIR"
###############################
## Create a commit if needed ##
###############################
if [[ -z "$(git log --oneline 2>/dev/null)" ]]; then
echo "Initial commit" > README.md
git add README.md
git commit -m "Initial commit" --quiet
fi
#############################
## Create tag if specified ##
#############################
if [[ -n "$tag_name" ]]; then
git tag -a "$tag_name" -m "Test tag $tag_name" 2>/dev/null || true
fi
################################
## Handle special HEAD case ##
################################
if [[ "$branch_name" == "HEAD" ]]; then
# For HEAD case, checkout the tag to simulate detached HEAD state
if [[ -n "$tag_name" ]]; then
git checkout "$tag_name" --quiet
fi
else
# Create and checkout branch
git checkout -b "$branch_name" 2>/dev/null || git checkout "$branch_name" 2>/dev/null || true
fi
}
#####################
## Run a test case ##
#####################
run_test() {
local test_name="$1"
local branch_name="$2"
local current_version="$3"
local expected_version="$4"
local tag_name="$5"
TESTS_RUN=$((TESTS_RUN + 1))
echo "🧪 Test: $test_name"
#####################
## Setup test case ##
#####################
create_test_pom "$current_version"
create_test_branch "$branch_name" "$tag_name"
####################
## Run the script ##
####################
cd "$TEST_DIR"
local output
local exit_code=0
if [[ "$VERBOSE" == "true" ]]; then
echo " Running: POM_FILE=pom.xml $CALCULATE_VERSION_SCRIPT --dry-run"
fi
output=$(cd "$TEST_DIR" && POM_FILE=pom.xml "$CALCULATE_VERSION_SCRIPT" --dry-run 2>&1) || exit_code=$?
######################################
## Check if script ran successfully ##
######################################
if [[ $exit_code -ne 0 ]]; then
echo " ❌ FAILED: Script exited with code $exit_code"
echo " Output: $output"
TESTS_FAILED=$((TESTS_FAILED + 1))
return 1
fi
################################################
## Extract the calculated version from output ##
################################################
local calculated_version
calculated_version=$(echo "$output" | grep "Calculated next version:" | sed 's/.*: //')
#########################################################
## Check if expected version contains wildcard pattern ##
#########################################################
if [[ "$expected_version" == *"*"* ]]; then
#######################################
## Convert wildcard pattern to regex ##
#######################################
local regex_pattern
# shellcheck disable=SC2001
# Handle different wildcard patterns:
# *-*-SNAPSHOT -> feature-name-commit-SNAPSHOT
# *-SNAPSHOT -> commit-SNAPSHOT
if [[ "$expected_version" == *-*-SNAPSHOT ]]; then
# Pattern: 1.4.0-*-*-SNAPSHOT -> 1.4.0-[feature-name]-[commit]-SNAPSHOT
regex_pattern=$(echo "$expected_version" | sed 's/\*/[a-zA-Z0-9-]+/g')
else
# Pattern: 1.4.0-*-SNAPSHOT -> 1.4.0-[commit]-SNAPSHOT
regex_pattern=$(echo "$expected_version" | sed 's/\*/[a-f0-9]+/g')
fi
if [[ "$calculated_version" =~ ^$regex_pattern$ ]]; then
echo " ✅ PASSED: Expected pattern $expected_version, got $calculated_version"
TESTS_PASSED=$((TESTS_PASSED + 1))
return 0
else
echo " ❌ FAILED: Expected pattern $expected_version, got $calculated_version"
if [[ "$VERBOSE" == "true" ]]; then
echo " Full output:"
# Add indentation to each line
while IFS= read -r line; do
echo " $line"
done <<< "$output"
fi
TESTS_FAILED=$((TESTS_FAILED + 1))
return 1
fi
else
#################
## Exact match ##
#################
if [[ "$calculated_version" == "$expected_version" ]]; then
echo " ✅ PASSED: Expected $expected_version, got $calculated_version"
TESTS_PASSED=$((TESTS_PASSED + 1))
return 0
else
echo " ❌ FAILED: Expected $expected_version, got $calculated_version"
if [[ "$VERBOSE" == "true" ]]; then
echo " Full output:"
# Add indentation to each line
while IFS= read -r line; do
echo " $line"
done <<< "$output"
fi
TESTS_FAILED=$((TESTS_FAILED + 1))
return 1
fi
fi
}
########################
## Print test summary ##
########################
print_summary() {
echo ""
echo "=== Test Summary ==="
echo "Tests run: $TESTS_RUN"
echo "Tests passed: $TESTS_PASSED"
echo "Tests failed: $TESTS_FAILED"
if [[ $TESTS_FAILED -eq 0 ]]; then
echo "🎉 All tests passed!"
return 0
else
echo "❌ Some tests failed!"
return 1
fi
}
################
## Test Cases ##
################
################################
## Test main branch scenarios ##
################################
test_main_branch() {
echo ""
echo "=== Testing MAIN Branch ==="
###########################################
## Test 1: Main branch with matching tag ##
###########################################
run_test "Main branch with matching tag" "main" "1.5.0" "1.5.0" "v1.5.0"
#################################################
## Test 2: Main branch with RC version and tag ##
#################################################
run_test "Main branch with RC version" "main" "1.5.0-RC.1" "1.5.0" "v1.5.0"
#######################################################
## Test 3: Main branch with SNAPSHOT version and tag ##
#######################################################
run_test "Main branch with SNAPSHOT version" "main" "1.5.0-SNAPSHOT" "1.5.0" "v1.5.0"
#############################################
## Test 4: Main branch on tag (HEAD state) ##
#############################################
run_test "Main branch on tag (HEAD)" "HEAD" "1.5.0" "1.5.0" "v1.5.0"
############################################################
## Test 5: Main branch with v-prefixed version in pom.xml ##
############################################################
run_test "Main branch with v-prefixed version" "main" "v0.2.1" "0.2.1" "v0.2.1"
}
###################################
## Test develop branch scenarios ##
###################################
test_develop_branch() {
echo ""
echo "=== Testing DEVELOP Branch ==="
#######################################################################
## Test 1: Develop branch with SNAPSHOT version (no recent activity) ##
#######################################################################
run_test "Develop branch - no recent activity" "develop" "1.5.0-SNAPSHOT" "1.5.0-SNAPSHOT" ""
##########################################################
## Test 2: Develop branch with RC version (should bump) ##
##########################################################
run_test "Develop branch with RC version" "develop" "1.5.0-RC.1" "1.6.0-SNAPSHOT" ""
##############################################################
## Test 3: Develop branch with stable version (should bump) ##
##############################################################
run_test "Develop branch with stable version" "develop" "1.5.0" "1.6.0-SNAPSHOT" ""
}
###################################
## Test release branch scenarios ##
###################################
test_release_branch() {
echo ""
echo "=== Testing RELEASE Branch ==="
#######################################
## Test 1: Release branch - first RC ##
#######################################
run_test "Release branch - first RC" "release/1.5" "1.5.0-SNAPSHOT" "1.5.0-RC.1" ""
###########################################
## Test 2: Release branch - increment RC ##
###########################################
run_test "Release branch - increment RC" "release/1.5" "1.5.0-RC.1" "1.5.0-RC.2" ""
#####################################################
## Test 3: Release branch - increment RC from RC.5 ##
#####################################################
run_test "Release branch - increment RC.5" "release/1.5" "1.5.0-RC.5" "1.5.0-RC.6" ""
}
##################################
## Test hotfix branch scenarios ##
##################################
test_hotfix_branch() {
echo ""
echo "=== Testing HOTFIX Branch ==="
########################################
## Test 1: Hotfix branch - bump patch ##
########################################
run_test "Hotfix branch - bump patch" "hotfix/fix-bug" "1.5.0" "1.5.1" ""
################################################
## Test 2: Hotfix branch - bump patch from RC ##
################################################
run_test "Hotfix branch - bump patch from RC" "hotfix/fix-bug" "1.5.0-RC.1" "1.5.1" ""
}
###################################
## Test feature branch scenarios ##
###################################
test_feature_branch() {
echo ""
echo "=== Testing FEATURE Branch ==="
###########################################################################
## Test 1: Feature branch - convert SNAPSHOT to feature-specific version ##
###########################################################################
run_test "Feature branch - convert SNAPSHOT to feature-specific version" "feature/new-feature" "1.5.0-SNAPSHOT" "1.5.0-new-feature-*-SNAPSHOT" ""
##################################################################################
## Test 2: Feature branch - convert stable version to feature-specific SNAPSHOT ##
##################################################################################
run_test "Feature branch - convert stable version to feature-specific SNAPSHOT" "feature/user-auth" "1.5.0" "1.5.0-user-auth-*-SNAPSHOT" ""
############################################################################################
## Test 3: Feature branch - update existing feature-specific version with new commit hash ##
############################################################################################
run_test "Feature branch - update existing feature-specific version" "feature/existing-feature" "1.5.0-SNAPSHOT" "1.5.0-existing-feature-*-SNAPSHOT" ""
############################################################################################
## Test 4: Feature branch - parse existing long feature-specific version ##
############################################################################################
run_test "Feature branch - parse existing long feature-specific version" "feature/test-new-orb" "1.4.0-test-new-orb-825957d-SNAPSHOT" "1.4.0-test-new-orb-*-SNAPSHOT" ""
}
####################################
## Test publish tag scenarios ##
####################################
test_publish_tag() {
echo ""
echo "=== Testing PUBLISH Tag Scenarios ==="
###########################################################################
## Test 1: Publish tag - convert SNAPSHOT to feature-specific version ##
## Note: Will use actual feature branch name found in git log ##
###########################################################################
run_test "Publish tag - convert SNAPSHOT to feature-specific version" "HEAD" "1.4.0-SNAPSHOT" "1.4.0-*-*-SNAPSHOT" "publish-825957d"
##################################################################################
## Test 2: Publish tag - convert stable version to feature-specific SNAPSHOT ##
## Note: Will use actual feature branch name found in git log ##
##################################################################################
run_test "Publish tag - convert stable version to feature-specific SNAPSHOT" "HEAD" "1.4.0" "1.4.0-*-*-SNAPSHOT" "publish-abc1234"
############################################################################################
## Test 3: Publish tag - update existing feature-specific version with new commit hash ##
############################################################################################
run_test "Publish tag - update existing feature-specific version" "HEAD" "1.4.0-test-feature-1234567-SNAPSHOT" "1.4.0-test-feature-*-SNAPSHOT" "publish-def5678"
############################################################################################
## Test 4: Publish tag with different commit hash format ##
## Note: Will use actual feature branch name found in git log ##
############################################################################################
run_test "Publish tag - different commit hash format" "HEAD" "1.5.0-SNAPSHOT" "1.5.0-*-*-SNAPSHOT" "publish-9a8b7c6"
}
#####################
## Test edge cases ##
#####################
test_edge_cases() {
echo ""
echo "=== Testing Edge Cases ==="
#########################################################
## Test 1: Invalid release branch format (should fail) ##
#########################################################
echo "🧪 Test: Invalid release branch format (should fail)"
TESTS_RUN=$((TESTS_RUN + 1))
create_test_pom "1.5.0-SNAPSHOT"
create_test_branch "release/invalid" ""
cd "$TEST_DIR"
local output
local exit_code=0
output=$(cd "$TEST_DIR" && POM_FILE=pom.xml "$CALCULATE_VERSION_SCRIPT" --dry-run 2>&1) || exit_code=$?
if [[ $exit_code -ne 0 ]]; then
echo " ✅ PASSED: Script correctly failed with invalid release branch format"
TESTS_PASSED=$((TESTS_PASSED + 1))
else
echo " ❌ FAILED: Script should have failed with invalid release branch format"
TESTS_FAILED=$((TESTS_FAILED + 1))
fi
#################################
## Test 2: Unknown branch type ##
#################################
run_test "Unknown branch type" "unknown-branch" "1.5.0-SNAPSHOT" "1.5.0-SNAPSHOT" ""
####################################################
## Test 3: Main branch with no tags (should fail) ##
####################################################
echo "🧪 Test: Main branch with no tags (should fail)"
TESTS_RUN=$((TESTS_RUN + 1))
create_test_pom "1.5.0-SNAPSHOT"
create_test_branch "main" "" # No tag
cd "$TEST_DIR"
output=$(cd "$TEST_DIR" && POM_FILE=pom.xml "$CALCULATE_VERSION_SCRIPT" --dry-run 2>&1) || exit_code=$?
if [[ $exit_code -ne 0 ]]; then
echo " ✅ PASSED: Script correctly failed with no tags on main branch"
TESTS_PASSED=$((TESTS_PASSED + 1))
else
echo " ❌ FAILED: Script should have failed with no tags on main branch"
TESTS_FAILED=$((TESTS_FAILED + 1))
fi
}
##########################
## Test version parsing ##
##########################
test_version_parsing() {
echo ""
echo "=== Testing Version Parsing ==="
##################################
## Test various version formats ##
##################################
local test_versions=(
"1.0.0"
"1.0.0-SNAPSHOT"
"1.0.0-RC.1"
"1.0.0-RC.10"
"10.20.30"
"10.20.30-SNAPSHOT"
"10.20.30-RC.5"
"v1.0.0"
"v1.0.0-SNAPSHOT"
"v1.0.0-RC.1"
"v10.20.30"
)
for version in "${test_versions[@]}"; do
echo "🧪 Testing version parsing: $version"
##################################################################
## Create a simple test to verify version parsing doesn't crash ##
##################################################################
create_test_pom "$version"
create_test_branch "main" ""
cd "$TEST_DIR"
local output
local exit_code=0
output=$(cd "$TEST_DIR" && POM_FILE=pom.xml "$CALCULATE_VERSION_SCRIPT" --dry-run 2>&1) || exit_code=$?
if [[ $exit_code -eq 0 ]]; then
echo " ✅ PASSED: Version $version parsed successfully"
TESTS_PASSED=$((TESTS_PASSED + 1))
else
echo " ❌ FAILED: Version $version parsing failed"
echo " Output: $output"
TESTS_FAILED=$((TESTS_FAILED + 1))
fi
TESTS_RUN=$((TESTS_RUN + 1))
done
}
####################
## Main execution ##
####################
main() {
echo "=== QQQ Version Calculator Test Suite ==="
echo "Testing script: $CALCULATE_VERSION_SCRIPT"
echo ""
##########################
## Verify script exists ##
##########################
if [[ ! -f "$CALCULATE_VERSION_SCRIPT" ]]; then
echo "❌ Script not found: $CALCULATE_VERSION_SCRIPT"
exit 1
fi
############################
## Setup test environment ##
############################
setup_test_environment
#########################
## Run all test suites ##
#########################
test_main_branch
test_develop_branch
test_release_branch
test_hotfix_branch
test_feature_branch
test_publish_tag
test_edge_cases
test_version_parsing
##############################
## Cleanup and show results ##
##############################
cleanup_test_environment
print_summary
}
#######################
## Run main function ##
#######################
main "$@"