Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
43247349d7 | ||
|
|
4486188522 | ||
|
|
1232a17f36 | ||
|
|
1f2e730512 | ||
|
|
2b59dac369 | ||
|
|
22fa420c52 | ||
|
|
f337e2ff51 | ||
|
|
9d1a70e433 | ||
|
|
145c99e2f8 | ||
|
|
8792d74fb0 | ||
|
|
5b5df41faa | ||
|
|
59c80f756a | ||
|
|
187d0df5c7 | ||
|
|
aa5cab7390 | ||
|
|
f2d8a9927a | ||
|
|
8820a7af82 | ||
|
|
8adb9e65f7 | ||
|
|
492af48c0d | ||
|
|
ae26b2288a | ||
|
|
f122b4a470 | ||
|
|
ea30ebdb2f | ||
|
|
06a3d113bd | ||
|
|
b0dc7e1eea | ||
|
|
0bbd09cdca | ||
|
|
9af91511aa | ||
|
|
7e3b967bb2 | ||
|
|
629ec15a2e | ||
|
|
f10f63fe27 | ||
|
|
c0365111f5 | ||
|
|
002b82d1f1 | ||
|
|
9751567138 | ||
|
|
0383e9fabf |
No files matched your search
@@ -2,3 +2,9 @@
|
||||
orb.yml
|
||||
.DS_Store
|
||||
target
|
||||
|
||||
# Test data directory (created dynamically during tests)
|
||||
tests/test_data
|
||||
|
||||
# IDE
|
||||
.idea
|
||||
Generated
-120
@@ -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">{
|
||||
"lastFilter": {
|
||||
"state": "OPEN",
|
||||
"assignee": "KofTwentyTwo"
|
||||
}
|
||||
}</component>
|
||||
<component name="GithubPullRequestsUISettings">{
|
||||
"selectedUrlAndAccountId": {
|
||||
"url": "git@github.com:Kingsrook/qqq-orb.git",
|
||||
"accountId": "7a0b7646-5b0c-4647-976d-932a62661dd2"
|
||||
}
|
||||
}</component>
|
||||
<component name="MacroExpansionManager">
|
||||
<option name="directoryName" value="Qi1Hqxgr" />
|
||||
</component>
|
||||
<component name="ProjectColorInfo">{
|
||||
"associatedIndex": 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">{
|
||||
"keyToString": {
|
||||
"RunOnceActivity.ShowReadmeOnStart": "true",
|
||||
"RunOnceActivity.git.unshallow": "true",
|
||||
"RunOnceActivity.go.formatter.settings.were.checked": "true",
|
||||
"RunOnceActivity.go.migrated.go.modules.settings": "true",
|
||||
"SHARE_PROJECT_CONFIGURATION_FILES": "true",
|
||||
"git-widget-placeholder": "develop",
|
||||
"go.import.settings.migrated": "true",
|
||||
"io.aesy.yamllint.do.not.ask.to.enable": "true",
|
||||
"last_opened_file_path": "/Users/james.maes/Git.Local/Kingsrook/qqq-orb/src/jobs",
|
||||
"node.js.detected.package.eslint": "true",
|
||||
"node.js.selected.package.eslint": "(autodetect)",
|
||||
"nodejs_package_manager_path": "npm",
|
||||
"org.rust.cargo.project.model.impl.CargoExternalSystemProjectAware.subscribe.first.balloon": "",
|
||||
"org.rust.first.attach.projects": "true",
|
||||
"settings.editor.selected.configurable": "preferences.sourceCode.yaml"
|
||||
},
|
||||
"keyToStringList": {
|
||||
"stardust.markdown.MarkdownSplitEditorSuppressor:keyList": []
|
||||
}
|
||||
}</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>
|
||||
@@ -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
|
||||
+69
-19
@@ -5,9 +5,10 @@ All notable changes to QQQ Orb will be documented in this file.
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
## [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 +18,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-15
|
||||
|
||||
### 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).
|
||||
+2
-84
@@ -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
@@ -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
@@ -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)!
|
||||
@@ -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"
|
||||
@@ -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."
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# QQQ Orb
|
||||
|
||||
[](https://circleci.com/developer/orbs/orb/kingsrook/qqq-orb)
|
||||
[](https://circleci.com/developer/orbs/orb/kingsrook/qqq-orb)
|
||||
[](https://circleci.com/developer/orbs/orb/kingsrook/qqq-orb)
|
||||
[](LICENSE)
|
||||
|
||||
> **CircleCI Orb for QQQ Framework Projects**
|
||||
@@ -15,10 +15,11 @@ QQQ Orb is a **CircleCI orb** that provides standardized CI/CD workflows for pro
|
||||
### What This Repository Contains
|
||||
|
||||
- **CircleCI Orb**: Reusable CI/CD workflows and commands
|
||||
- **GitFlow Integration**: Automated branching and version management
|
||||
- **GitFlow Integration**: Automated branching and version management with intelligent version calculation
|
||||
- **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
|
||||
- **Comprehensive Testing**: Full test suite with dynamic test environments
|
||||
- **Quality Gates**: Enforced linting, testing, and validation before publishing
|
||||
|
||||
### What This Repository Does NOT Contain
|
||||
|
||||
@@ -34,15 +35,15 @@ QQQ Orb is a **CircleCI orb** that provides standardized CI/CD workflows for pro
|
||||
- **GitFlow**: Branching strategy for release management
|
||||
- **Maven**: Java project build and dependency management
|
||||
- **npm**: Node.js package management
|
||||
- **Shell Scripts**: Automation and utility scripts
|
||||
- **Shell Scripts**: Automation and utility scripts with comprehensive testing
|
||||
- **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
|
||||
- **Intelligent Version Management**: Automated semantic versioning based on GitFlow with feature branch support
|
||||
- **Publishing**: Maven Central and npm registry publishing with quality gates
|
||||
- **Documentation**: Automated documentation generation and publishing
|
||||
|
||||
## 🚀 Quick Start
|
||||
@@ -133,7 +134,7 @@ src/
|
||||
│ ├── node_publish.yml # npm publishing workflow
|
||||
│ └── node_test_only.yml # npm testing workflow
|
||||
├── scripts/ # Shell scripts
|
||||
│ ├── calculate_version.sh # Version calculation
|
||||
│ ├── calculate_version.sh # Intelligent version calculation
|
||||
│ ├── mvn_build_compile.sh # Maven compilation
|
||||
│ ├── node_npm_auth.sh # npm authentication
|
||||
│ └── ... # Additional scripts
|
||||
@@ -141,6 +142,11 @@ src/
|
||||
│ └── default.yml # Default executor configuration
|
||||
└── examples/ # Usage examples
|
||||
└── build.yml # Example configuration
|
||||
|
||||
tests/ # Comprehensive test suite
|
||||
├── test_calculate_version.sh # Version calculation tests
|
||||
├── run_tests.sh # Test runner with CI support
|
||||
└── README.md # Test documentation
|
||||
```
|
||||
|
||||
## 🎯 Available Jobs
|
||||
@@ -175,23 +181,36 @@ sudo apt-get install shellcheck yamllint
|
||||
### Development Commands
|
||||
|
||||
```bash
|
||||
# Core development
|
||||
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
|
||||
```
|
||||
make lint # Run all linting checks (YAML, ShellCheck, CircleCI orb)
|
||||
make dev # Pack + validate + show status
|
||||
make clean # Clean build artifacts and test data
|
||||
|
||||
### Publishing Commands
|
||||
# Testing
|
||||
make test # Pack and validate orb
|
||||
make test-scripts # Run comprehensive calculate_version.sh tests
|
||||
make test-all # Run all tests (orb + scripts)
|
||||
|
||||
```bash
|
||||
# Publishing (with full build cycle)
|
||||
make publish-snapshot # Publish as kingsrook/qqq-orb@dev:snapshot
|
||||
make publish-release # Publish as kingsrook/qqq-orb@X.Y.Z
|
||||
```
|
||||
|
||||
## 📋 Version Management
|
||||
### Quality Gates
|
||||
|
||||
Automated version calculation based on GitFlow branches:
|
||||
All publishing commands enforce a complete quality gate:
|
||||
|
||||
1. **check-clean**: Ensures working directory is clean
|
||||
2. **lint**: Runs all linting checks (YAML, ShellCheck, CircleCI orb validation)
|
||||
3. **clean**: Removes all generated files for fresh build
|
||||
4. **dev**: Development workflow (pack + validate)
|
||||
5. **test-all**: Comprehensive testing (orb + scripts)
|
||||
|
||||
## 📋 Intelligent Version Management
|
||||
|
||||
Automated version calculation with GitFlow integration and feature branch support:
|
||||
|
||||
| Branch Pattern | Version Change | Example |
|
||||
|----------------|----------------|---------|
|
||||
@@ -199,6 +218,22 @@ Automated version calculation based on GitFlow branches:
|
||||
| `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` |
|
||||
| `feature/new-feature` | Feature-specific | `1.5.0-SNAPSHOT` → `1.5.0-NEW-abc1234-SNAPSHOT` |
|
||||
|
||||
### Feature Branch Versioning
|
||||
|
||||
Feature branches create unique, traceable versions:
|
||||
- **Format**: `{version}-{feature_branch_name}-{commit_hash}-SNAPSHOT`
|
||||
- **Example**: `feature/new-feature` → `1.5.0-new-feature-abc1234-SNAPSHOT`
|
||||
- **Dynamic Updates**: Automatically updates when commit hash changes
|
||||
- **Safe Abbreviations**: 3-character uppercase feature name abbreviation
|
||||
|
||||
### Version Parsing Support
|
||||
|
||||
The version calculator handles multiple formats:
|
||||
- **Standard**: `1.5.0`, `1.5.0-SNAPSHOT`, `1.5.0-RC.1`
|
||||
- **V-prefixed**: `v1.5.0` → `1.5.0` (clean conversion)
|
||||
- **Feature-specific**: `1.5.0-new-feature-name-abc1234-SNAPSHOT`
|
||||
|
||||
**Main branch requires release tags**:
|
||||
```bash
|
||||
@@ -206,19 +241,34 @@ git tag -a v1.5.0 -m "Release 1.5.0"
|
||||
git push origin v1.5.0
|
||||
```
|
||||
|
||||
## 🧪 Testing
|
||||
## 🧪 Comprehensive Testing
|
||||
|
||||
### Test Suite Features
|
||||
|
||||
- **Dynamic Test Environment**: Creates isolated git repositories for each test run
|
||||
- **Pattern Matching**: Supports wildcard patterns for commit hash testing
|
||||
- **Comprehensive Coverage**: Tests all branch types and edge cases
|
||||
- **CI Integration**: Clean exit codes and minimal output for CI systems
|
||||
- **Automatic Cleanup**: Test data removed automatically after tests
|
||||
|
||||
### Running Tests
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
make test
|
||||
make test-all
|
||||
|
||||
# Run specific test suites
|
||||
make test # Orb tests only
|
||||
make test-scripts # Script tests only
|
||||
|
||||
# Run with verbose output
|
||||
./tests/run_tests.sh --verbose
|
||||
|
||||
# Run in CI mode
|
||||
./tests/run_tests.sh --ci
|
||||
|
||||
# Run linting checks
|
||||
make lint
|
||||
|
||||
# Validate orb configuration
|
||||
make validate
|
||||
```
|
||||
|
||||
### Test Coverage
|
||||
@@ -227,7 +277,9 @@ 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
|
||||
- **Version Calculation**: 20+ test cases covering all branch types
|
||||
- **Integration Testing**: End-to-end workflow testing
|
||||
- **Edge Case Testing**: Invalid formats, missing tags, error conditions
|
||||
|
||||
## 📦 Usage Examples
|
||||
|
||||
@@ -267,17 +319,19 @@ jobs:
|
||||
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
|
||||
4. **Run tests**: `make test-all`
|
||||
5. **Run linting**: `make lint`
|
||||
6. **Commit your changes**: `git commit -m 'Add amazing feature'`
|
||||
7. **Push to the branch**: `git push origin feature/amazing-feature`
|
||||
8. **Open a Pull Request** to the main QQQ repository
|
||||
|
||||
### Code Standards
|
||||
|
||||
- **YAML**: Follow CircleCI orb best practices
|
||||
- **Shell Scripts**: Use ShellCheck for validation
|
||||
- **Shell Scripts**: Use ShellCheck for validation, comprehensive testing
|
||||
- **Documentation**: Update README and inline documentation
|
||||
- **Testing**: Comprehensive test coverage
|
||||
- **Testing**: Comprehensive test coverage with dynamic test environments
|
||||
- **Quality Gates**: All changes must pass linting and testing
|
||||
|
||||
## 📄 License
|
||||
|
||||
|
||||
+2
-111
@@ -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)
|
||||
@@ -30,5 +30,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" }}
|
||||
@@ -33,6 +33,7 @@ steps:
|
||||
- restore_cache:
|
||||
keys:
|
||||
- v1-dependencies-{{ checksum "pom.xml" }}
|
||||
- v1-npm-dependencies-{{ checksum "package.json" }}
|
||||
|
||||
# (Optional) Guard: if node_modules is missing, install it quickly so "npm run build" works
|
||||
- run:
|
||||
@@ -67,3 +68,10 @@ 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" }}
|
||||
|
||||
Executable
+11
@@ -0,0 +1,11 @@
|
||||
description: >
|
||||
Full checkout of the repository
|
||||
- Clones the repository
|
||||
- Checks out the commit specified by CIRCLE_SHA1
|
||||
|
||||
steps:
|
||||
- run:
|
||||
name: Full checkout
|
||||
command: |
|
||||
git clone "$CIRCLE_REPOSITORY_URL" .
|
||||
git checkout "$CIRCLE_SHA1"
|
||||
+37
-21
@@ -4,55 +4,71 @@ description: >
|
||||
|
||||
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\/.*/
|
||||
@@ -12,16 +12,10 @@ parameters:
|
||||
description: "Branch type: snapshot, release_candidate, release, or hotfix"
|
||||
|
||||
steps:
|
||||
- checkout
|
||||
- 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
|
||||
@@ -7,6 +7,6 @@ description: >
|
||||
executor: localstack/default
|
||||
|
||||
steps:
|
||||
- checkout
|
||||
- git_full_checkout
|
||||
- frontend_build
|
||||
- frontend_test
|
||||
@@ -1,7 +1,7 @@
|
||||
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), feasture (tagged) and hotfix workflows
|
||||
|
||||
executor: localstack/default
|
||||
|
||||
@@ -9,29 +9,43 @@ parameters:
|
||||
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
|
||||
- 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:
|
||||
or:
|
||||
- equal: ["snapshot", << parameters.branch_type >>]
|
||||
- equal: ["release_candidate", << parameters.branch_type >>]
|
||||
not:
|
||||
equal: [ "<< parameters.branch_type >>", "feature" ]
|
||||
steps:
|
||||
- git_operations
|
||||
- publish_asciidoc
|
||||
|
||||
- when:
|
||||
condition: << parameters.publish_asciidoc >>
|
||||
steps:
|
||||
- publish_asciidoc
|
||||
@@ -13,7 +13,7 @@ parameters:
|
||||
description: "Whether to run middleware API version checks"
|
||||
|
||||
steps:
|
||||
- checkout
|
||||
- git_full_checkout
|
||||
- mvn_build
|
||||
- mvn_verify
|
||||
- when:
|
||||
|
||||
@@ -12,7 +12,7 @@ parameters:
|
||||
description: "Branch type: snapshot, release_candidate, release, or hotfix"
|
||||
|
||||
steps:
|
||||
- checkout
|
||||
- git_full_checkout
|
||||
- node_install_dependencies
|
||||
- node_run_tests
|
||||
- node_manage_version
|
||||
|
||||
@@ -12,6 +12,6 @@ parameters:
|
||||
description: "Branch type: snapshot, release_candidate, release, or hotfix"
|
||||
|
||||
steps:
|
||||
- checkout
|
||||
- git_full_checkout
|
||||
- node_install_dependencies
|
||||
- node_run_tests
|
||||
+265
-141
@@ -18,7 +18,7 @@ set -e
|
||||
###################
|
||||
## Configuration ##
|
||||
###################
|
||||
POM_FILE="pom.xml"
|
||||
POM_FILE="${POM_FILE:-pom.xml}"
|
||||
DRY_RUN=false
|
||||
|
||||
##################################
|
||||
@@ -29,13 +29,37 @@ 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/<.*//')
|
||||
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 +73,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 +94,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 +114,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 +135,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 +145,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 +154,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 +167,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 +373,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 +420,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
|
||||
|
||||
@@ -27,7 +27,14 @@ 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}"
|
||||
|
||||
if [ -n "$CIRCLE_BRANCH" ]; then
|
||||
git push origin "HEAD:${CIRCLE_BRANCH}"
|
||||
else
|
||||
# Tag build: push to main (or your default branch)
|
||||
git push origin HEAD:main
|
||||
fi
|
||||
|
||||
echo "Version updated to: $NEW_VERSION and pushed"
|
||||
else
|
||||
echo "No version change needed"
|
||||
|
||||
+113
@@ -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.
|
||||
Executable
+91
@@ -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 "$@"
|
||||
Executable
+581
@@ -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 "$@"
|
||||
Reference in new issue
Block a user