From e9feed1784e84096aede7fadef71c092a1896f31 Mon Sep 17 00:00:00 2001
From: Felix Seifert <mail@felix-seifert.com>
Date: Sat, 16 Mar 2024 10:45:19 +0100
Subject: [PATCH] ci: add ability to determine future versions

This script adds the functionality to determine the future version the lib should be bumped to. It allows to determine the next release version, its version tag, and the snapshot version required after the release. These different version numbers can be determined for the releases `PATCH`, `MINOR` and `MAJOR`.
---
 ci/version_determiner.py | 114 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 114 insertions(+)
 create mode 100755 ci/version_determiner.py

diff --git a/ci/version_determiner.py b/ci/version_determiner.py
new file mode 100755
index 0000000..b941f27
--- /dev/null
+++ b/ci/version_determiner.py
@@ -0,0 +1,114 @@
+#!/usr/bin/python3
+
+import re
+import sys
+import version_retriever
+
+
+def get_arg(arg_idx) -> str:
+    return sys.argv[arg_idx]
+
+
+def get_release_version(release_type: str, current_version: str) -> str:
+    major, minor, patch = determine_new_version(current_version, release_type)
+    return str(major) + "." + str(minor) + "." + str(patch)
+
+
+def get_snapshot_version(release_type: str, current_version: str) -> str:
+    major, minor, patch = determine_new_version(current_version, release_type)
+    patch += 1
+    return str(major) + "." + str(minor) + "." + str(patch) + "-SNAPSHOT"
+
+
+def get_version_tag(release_type: str, current_version: str) -> str:
+    major, minor, patch = determine_new_version(current_version, release_type)
+    return "v" + str(major) + "." + str(minor) + "." + str(patch)
+
+
+def determine_new_version(current_version, release_type):
+    major, minor, patch, is_prerelease = dissect_version(current_version)
+
+    match release_type:
+        case "MAJOR":
+            major, minor, patch = get_major_release_version(major)
+        case "MINOR":
+            major, minor, patch = get_minor_release_version(major, minor)
+        case "PATCH":
+            major, minor, patch = get_patch_release_version(major, minor, patch,
+                                                            is_prerelease)
+        case _:
+            print("Second arg has to be `MAJOR`, `MINOR` or `PATCH`")
+            sys.exit()
+
+    return major, minor, patch
+
+
+def dissect_version(current_version) -> (int, int, int):
+    version_regex = get_regex()
+    regex_match = version_regex.search(current_version)
+    major: int = int(regex_match.groupdict().get("major"))
+    minor: int = int(regex_match.groupdict().get("minor"))
+    patch: int = int(regex_match.groupdict().get("patch"))
+    is_prerelease: bool = True if regex_match.groupdict().get(
+        "prerelease") else False
+    return major, minor, patch, is_prerelease
+
+
+def get_regex():
+    # Following REGEX is suggested on semver.org
+    # https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+    return re.compile(
+        r'^'
+        r'(?P<major>0|[1-9]\d*)'
+        r'\.'
+        r'(?P<minor>0|[1-9]\d*)'
+        r'\.'
+        r'(?P<patch>0|[1-9]\d*)'
+        r'(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?'
+        r'(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$')
+
+
+def get_major_release_version(major):
+    major += 1
+    minor = 0
+    patch = 0
+    return major, minor, patch
+
+
+def get_minor_release_version(major, minor):
+    minor += 1
+    patch = 0
+    return major, minor, patch
+
+
+def get_patch_release_version(major, minor, patch, is_prerelease):
+    if is_prerelease:
+        # Leave values as is because current version without `prerelease` is new patch version
+        return major, minor, patch
+    return major, minor, patch + 1
+
+
+if __name__ == "__main__":
+
+    if len(sys.argv) != 3:
+        print("First argument has to be requested version type. Second argument has to specify type of version bump.")
+        sys.exit()
+
+    version_type = get_arg(1)
+    release_type = get_arg(2)
+
+    current_version = version_retriever.get_current_version()
+
+    match version_type:
+        case "release-version":
+            new_version = get_release_version(release_type, current_version)
+        case "version-tag":
+            new_version = get_version_tag(release_type, current_version)
+        case "snapshot-version":
+            new_version = get_snapshot_version(release_type, current_version)
+        case _:
+            print(
+                "First arg has to be `release-version`, `version-tag` or `snapshot-version`.")
+            sys.exit()
+
+    print(new_version)