|
| 1 | +#!/usr/bin/env python3 |
| 2 | +""" |
| 3 | +Version Number Validator |
| 4 | +
|
| 5 | +This script validates version numbers and extracts major.minor.patch format. |
| 6 | +
|
| 7 | +Version format rules: |
| 8 | +- Can start with 'v' (optional): v2.3.1 or 2.3.1 |
| 9 | +- Must have major.minor.patch: 1.2.3 (minimum required) |
| 10 | +- May have build number: 1.2.3-1 or 1.2.3-2 |
| 11 | +- May end with -SNAPSHOT: 3.4.5-1-SNAPSHOT or 3.4.5-SNAPSHOT |
| 12 | +
|
| 13 | +Usage: |
| 14 | + python version_validator.py <version_string> |
| 15 | + python version_validator.py --extract <version_string> |
| 16 | +""" |
| 17 | + |
| 18 | +import re |
| 19 | +import sys |
| 20 | +import argparse |
| 21 | + |
| 22 | +def extract_major_minor_patch(version_string): |
| 23 | + """ |
| 24 | + Extract major.minor.patch from a valid version string in vX.Y.Z format. |
| 25 | +
|
| 26 | + Args: |
| 27 | + version_string (str): The version string to extract from |
| 28 | +
|
| 29 | + Returns: |
| 30 | + str: The extracted version in vX.Y.Z format, or None if invalid |
| 31 | + """ |
| 32 | + # Define the regex pattern for valid version strings |
| 33 | + pattern = r'^v?(\d+)\.(\d+)\.(\d+)(?:-(\d+))?(?:-SNAPSHOT)?$' |
| 34 | + match = re.match(pattern, version_string) |
| 35 | + |
| 36 | + if match: |
| 37 | + major, minor, patch = match.groups()[:3] |
| 38 | + return f"v{major}.{minor}.{patch}" |
| 39 | + |
| 40 | + return None |
| 41 | + |
| 42 | +def validate_version(version_string): |
| 43 | + """ |
| 44 | + Validate a version string according to the specified rules. |
| 45 | +
|
| 46 | + Args: |
| 47 | + version_string (str): The version string to validate |
| 48 | +
|
| 49 | + Returns: |
| 50 | + bool: True if valid, False otherwise |
| 51 | + """ |
| 52 | + return extract_major_minor_patch(version_string) is not None |
| 53 | + |
| 54 | +def main(): |
| 55 | + parser = argparse.ArgumentParser( |
| 56 | + description="Validate version number and extract major.minor.patch format", |
| 57 | + formatter_class=argparse.RawDescriptionHelpFormatter, |
| 58 | + epilog=""" |
| 59 | +Examples: |
| 60 | + python version_validator.py v2.3.1 # Validate version |
| 61 | + python version_validator.py 1.2.3-1 # Validate version with build |
| 62 | + python version_validator.py --extract v2.3.1-SNAPSHOT # Extract v2.3.1 |
| 63 | + python version_validator.py -e 3.4.5-2-SNAPSHOT # Extract v3.4.5 |
| 64 | +
|
| 65 | +Valid version formats: |
| 66 | + v1.2.3, 1.2.3, v1.2.3-1, 1.2.3-1, v1.2.3-SNAPSHOT, 1.2.3-1-SNAPSHOT |
| 67 | + """ |
| 68 | + ) |
| 69 | + |
| 70 | + parser.add_argument( |
| 71 | + 'version', |
| 72 | + help='Version string to validate/extract' |
| 73 | + ) |
| 74 | + parser.add_argument( |
| 75 | + '-e', '--extract', |
| 76 | + action='store_true', |
| 77 | + help='Extract major.minor.patch in vX.Y.Z format' |
| 78 | + ) |
| 79 | + |
| 80 | + args = parser.parse_args() |
| 81 | + |
| 82 | + if args.extract: |
| 83 | + # Extract mode |
| 84 | + result = extract_major_minor_patch(args.version) |
| 85 | + if result: |
| 86 | + print(result) |
| 87 | + sys.exit(0) |
| 88 | + else: |
| 89 | + print(f"Error: '{args.version}' is not a valid version string", file=sys.stderr) |
| 90 | + sys.exit(1) |
| 91 | + else: |
| 92 | + # Validation mode |
| 93 | + if validate_version(args.version): |
| 94 | + print(f"'{args.version}' is a valid version string") |
| 95 | + sys.exit(0) |
| 96 | + else: |
| 97 | + print(f"Error: '{args.version}' is not a valid version string", file=sys.stderr) |
| 98 | + sys.exit(1) |
| 99 | + |
| 100 | + |
| 101 | +if __name__ == "__main__": |
| 102 | + # If no arguments provided, run some test cases |
| 103 | + if len(sys.argv) == 1: |
| 104 | + print("Running test cases...") |
| 105 | + |
| 106 | + test_cases = [ |
| 107 | + # Valid cases |
| 108 | + ("v2.3.1", True), |
| 109 | + ("2.3.1", True), |
| 110 | + ("1.2.3-1", True), |
| 111 | + ("v1.2.3-1", True), |
| 112 | + ("3.4.5-SNAPSHOT", True), |
| 113 | + ("v3.4.5-SNAPSHOT", True), |
| 114 | + ("1.2.3-1-SNAPSHOT", True), |
| 115 | + ("v1.2.3-1-SNAPSHOT", True), |
| 116 | + ("10.20.30", True), |
| 117 | + ("v0.0.1", True), |
| 118 | + |
| 119 | + # Invalid cases |
| 120 | + ("1.2", False), |
| 121 | + ("v1.2", False), |
| 122 | + ("1.2.3.4", False), |
| 123 | + ("v1.2.3.4", False), |
| 124 | + ("1.2.3-", False), |
| 125 | + ("1.2.3-SNAPSHOT-1", False), |
| 126 | + ("1.2.3-a", False), |
| 127 | + ("v1.2.3-a", False), |
| 128 | + ("av1.2.3", False), |
| 129 | + ("a1.2.3", False), |
| 130 | + (" v1.2.3", False), |
| 131 | + ("V1.2.3-a", False), |
| 132 | + ("1.2.x", False), |
| 133 | + ("", False), |
| 134 | + ("v", False), |
| 135 | + ("1.2.3-1-SNAPSHOT-extra", False), |
| 136 | + ] |
| 137 | + |
| 138 | + print("\nValidation Tests:") |
| 139 | + for version, expected in test_cases: |
| 140 | + result = validate_version(version) |
| 141 | + status = "✓" if result == expected else "✗" |
| 142 | + print(f"{status} {version:<25} -> {result} (expected {expected})") |
| 143 | + |
| 144 | + print("\nExtraction Tests:") |
| 145 | + extraction_tests = [ |
| 146 | + ("v2.3.1", "v2.3.1"), |
| 147 | + ("2.3.1", "v2.3.1"), |
| 148 | + ("1.2.3-1", "v1.2.3"), |
| 149 | + ("v1.2.3-1-SNAPSHOT", "v1.2.3"), |
| 150 | + ("3.4.5-SNAPSHOT", "v3.4.5"), |
| 151 | + ("invalid", None), |
| 152 | + ] |
| 153 | + |
| 154 | + for version, expected in extraction_tests: |
| 155 | + result = extract_major_minor_patch(version) |
| 156 | + status = "✓" if result == expected else "✗" |
| 157 | + print(f"{status} {version:<25} -> {result} (expected {expected})") |
| 158 | + else: |
| 159 | + main() |
0 commit comments