Compare commits

...
6 Commits
Author SHA1 Message Date
james.maes 06a3d113bd docs: update README with current functionality and testing framework
- Add comprehensive testing section with dynamic test environments
- Document intelligent version management and feature branch support
- Update development workflow with quality gates and test commands
2025-09-18 09:33:37 -05:00
james.maes b0dc7e1eea feat: enforce full build cycle before publishing releases
Publish targets now run lint, clean, dev, and test-all before releasing,
ensuring quality gates and comprehensive testing before any publication.
2025-09-18 09:31:19 -05:00
james.maes 0bbd09cdca feat: enhance feature branch versioning with dynamic commit hash updates
Feature branches now automatically update version when commit hash changes,
with dynamic test environment creation and automatic cleanup via make clean.
2025-09-18 09:29:38 -05:00
james.maes 9af91511aa feat: enhance calculate_version.sh with comprehensive test suite and improved linting
- feat: add comprehensive test suite for calculate_version.sh script
  - Add test_calculate_version.sh with 20+ test cases covering all branch types
  - Add run_tests.sh test runner with verbose and CI modes
  - Add tests/README.md with complete documentation
  - Test coverage: main, develop, release, hotfix, feature branches
  - Test edge cases: invalid formats, missing tags, version parsing

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

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

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

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

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

All tests passing, linting clean, ready for production use.
2025-09-18 09:04:53 -05:00
james.maes 7e3b967bb2 fix(calulate_version): refactored to make branch level code more clear and cleaner 2025-09-18 08:56:28 -05:00
james.maes 629ec15a2e fix(calulate_version): refactored to make branch level code more clear and cleaner 2025-09-18 08:54:58 -05:00
7 changed files with 962 additions and 171 deletions

No files matched your search

+3
View File
@@ -2,3 +2,6 @@
orb.yml
.DS_Store
target
# Test data directory (created dynamically during tests)
tests/test_data
+24 -6
View File
@@ -1,7 +1,7 @@
# QQQ Orb Development Makefile
# Provides convenient commands for orb development, validation, and publishing
.PHONY: help pack validate clean test publish-snapshot publish-release dev check-clean check-branch
.PHONY: help pack validate clean test test-scripts test-all publish-snapshot publish-release dev check-clean check-branch
# Default target
help:
@@ -10,6 +10,8 @@ help:
@echo " make pack - Pack the orb using 'orb pack' (recommended for orb development)"
@echo " make validate - Validate the packed orb"
@echo " make test - Pack and validate the orb"
@echo " make test-scripts - Run comprehensive tests for calculate_version.sh"
@echo " make test-all - Run all tests (orb + scripts)"
@echo " make clean - Remove packed orb files"
@echo " make dev - Development workflow: pack, validate, and show status"
@echo " make lint - Run all CircleCI-style linting checks"
@@ -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."
+80 -26
View File
@@ -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}-{ABBREV}-{commit_hash}-SNAPSHOT`
- **Example**: `feature/new-feature` → `1.5.0-NEW-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-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
@@ -336,4 +390,4 @@ This repository is maintained separately from the main QQQ repository to:
**Built with ❤️ by the Kingsrook Team**
**This is a CI/CD component of the QQQ framework. For complete information, support, and community, visit: https://github.com/Kingsrook/qqq**
**This is a CI/CD component of the QQQ framework. For complete information, support, and community, visit: https://github.com/Kingsrook/qqq**
+239 -139
View File
@@ -18,7 +18,7 @@ set -e
###################
## Configuration ##
###################
POM_FILE="pom.xml"
POM_FILE="${POM_FILE:-pom.xml}"
DRY_RUN=false
##################################
@@ -33,9 +33,10 @@ 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 "")
@@ -67,6 +68,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 +88,13 @@ 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 ##
#############################################################
elif [[ "$version" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)-[A-Z]{3}-[a-f0-9]{7}-SNAPSHOT$ ]]; then
MAJOR=${BASH_REMATCH[1]}
MINOR=${BASH_REMATCH[2]}
PATCH=${BASH_REMATCH[3]}
#######################################
## Handle stable versions like 1.5.0 ##
#######################################
@@ -94,136 +108,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
NEW_VERSION="$LATEST_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 ##
#########################################
@@ -233,7 +117,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
@@ -243,12 +126,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
@@ -257,6 +139,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-3 | tr '[:lower:]' '[:upper:]')
# 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 ##
####################
@@ -274,9 +345,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 ""
@@ -292,7 +392,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
@@ -304,4 +404,4 @@ main() {
#######################
## Run main function ##
#######################
main "$@"
main "$@"
+113
View File
@@ -0,0 +1,113 @@
# Calculate Version Script Test Suite
This directory contains comprehensive tests for the `calculate_version.sh` script.
## Test Files
- `test_calculate_version.sh` - Main test suite with comprehensive test cases
- `run_tests.sh` - Test runner with different output modes
- `README.md` - This documentation
## Running Tests
### Quick Test Run
```bash
./tests/run_tests.sh
```
### Verbose Test Run
```bash
./tests/run_tests.sh --verbose
```
### CI Mode (minimal output)
```bash
./tests/run_tests.sh --ci
```
### Direct Test Suite
```bash
./tests/test_calculate_version.sh
./tests/test_calculate_version.sh --verbose
```
## Test Coverage
The test suite covers:
### Branch Types
- **Main Branch**: Tests stable version handling, tag detection, RC conversion
- **Develop Branch**: Tests SNAPSHOT version management, release detection
- **Release Branch**: Tests RC version creation and incrementing
- **Hotfix Branch**: Tests patch version bumping
- **Feature Branch**: Tests version inheritance
### Edge Cases
- Invalid branch formats
- Unknown branch types
- Missing tags on main branch
- Various version formats (stable, SNAPSHOT, RC)
### Version Parsing
- Standard versions: `1.0.0`
- SNAPSHOT versions: `1.0.0-SNAPSHOT`
- RC versions: `1.0.0-RC.1`, `1.0.0-RC.10`
- Multi-digit versions: `10.20.30`
## Test Environment
The test suite:
1. Creates a temporary test directory
2. Initializes a test git repository
3. Creates test pom.xml files with different versions
4. Creates test branches and tags
5. Runs the calculate_version.sh script
6. Validates the output
7. Cleans up test data
## Integration with Make
The tests are integrated into the Makefile and can be run with:
```bash
make test-scripts
```
## Test Results
The test suite provides:
- ✅ Pass/fail status for each test
- 📊 Summary statistics
- 🔍 Detailed output in verbose mode
- 🚫 Clean exit codes for CI integration
## Adding New Tests
To add new test cases:
1. Add a new test function in `test_calculate_version.sh`
2. Call `run_test` with appropriate parameters:
```bash
run_test "Test Name" "branch_name" "current_version" "expected_version" "tag_name"
```
3. Add the test function to the main execution flow
4. Update this README if needed
## Troubleshooting
### Common Issues
1. **Permission denied**: Make sure test scripts are executable
```bash
chmod +x tests/*.sh
```
2. **Git not found**: Ensure git is installed and available in PATH
3. **Test failures**: Run with `--verbose` to see detailed output
```bash
./tests/run_tests.sh --verbose
```
### Debug Mode
For debugging, you can run individual test functions by modifying the main function in `test_calculate_version.sh` to call only specific test functions.
+82
View File
@@ -0,0 +1,82 @@
#!/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 "$@"
+421
View File
@@ -0,0 +1,421 @@
#!/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 and checkout branch
git checkout -b "$branch_name" 2>/dev/null || git checkout "$branch_name" 2>/dev/null || true
# 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
}
# 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
regex_pattern=$(echo "$expected_version" | sed 's/\*/[a-f0-9]{7}/g')
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-*-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-USE-*-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-EXI-abc1234-SNAPSHOT" "1.5.0-EXI-*-SNAPSHOT" ""
}
# 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_edge_cases
test_version_parsing
# Cleanup and show results
cleanup_test_environment
print_summary
}
# Run main function
main "$@"