Initial implementation of rightmost bumps

Adds new magic comments supported in commits:

[bump_rightmost: 3]
[start_rightmost]

This should implement missing z-stream type bumps used mainly in RHEL
already released branches fixes.

It is needed to ensure latest branch build is always preferred after
upgrade to higher version. In Fedora regular mass rebuilds mitigates the
need for something similar. But it could be still used when doing rebase
in multiple branches, where only rawhide build should always have
highest release.

This is attempt to provide user-friendly alternative to manual calls of
rpmdev-bumpspec -r command.

Signed-off-by: Petr Menšík <pemensik@redhat.com>

Author: pemensik

rpmautospec/magic_comments.py

@@ -1,26 +1,37 @@
 import re
-from typing import NamedTuple
+import typing
 
 magic_comment_re = re.compile(r"^\s*\[(?P<magic>.*)\]\s*$")
-skip_changelog_re = re.compile(r"\s*skip\s+changelog\s*")
-bump_release_re = re.compile(r"\s*bump\s+release\s*(?::\s*)?(?P<bump_value>\d+)\s*")
+intvalue_re = re.compile(r"\s*(?P<keyname>[a-z]+([\s_]+[a-z]+)*)\s*(?::\s*)?(?P<value>\d+)\s*")
 
 
-class MagicCommentResult(NamedTuple):
-    skip_changelog: bool
-    bump_release: int
+class MagicCommentResult(typing.NamedTuple):
+    """Do not include this commit in changelog."""
+    skip_changelog: bool = False
+    """Start increasing number on the right of release string, not left."""
+    start_rightmost: bool = False
+    """Bump release to specified number."""
+    bump_release: int = 0
+    """Bump rightmost of the release to specified number."""
+    bump_rightmost: int = 0
 
 
 def parse_magic_comments(message: str) -> MagicCommentResult:
-    skip_changelog = False
-    bump_release = 0
+    types = typing.get_type_hints(MagicCommentResult)
+    values = dict()
 
     for line in message.split("\n"):
         if l_match := magic_comment_re.match(line):
             for part in l_match.group("magic").split(","):
-                if skip_changelog_re.match(part):
-                    skip_changelog = True
-                if br_match := bump_release_re.match(part):
-                    bump_release = max(bump_release, int(br_match.group("bump_value")))
+                part = part.strip().replace(" ", "_")
+                if part in types and types[part] is bool:
+                    values[part] = True
+                elif br_match := intvalue_re.match(part):
+                    keyname = br_match.group("keyname")
+                    if keyname in types and types[keyname] is int:
+                        values[keyname] = int(br_match.group("value"))
+                    else:
+                        raise ValueError(f"Parameter \"{keyname}\" "
+                                          "is not recognized int type magic")
 
-    return MagicCommentResult(skip_changelog=skip_changelog, bump_release=bump_release)
+    return MagicCommentResult(**values)

rpmautospec/pkg_history.py

@@ -87,6 +87,7 @@ def __init__(self, spec_or_path: Union[str, Path]):
             self.repo = None
 
         self._rpmverflags_for_commits = {}
+        self.rightmost_bumps = False
 
     @staticmethod
     def _get_rpm_packager() -> str:
@@ -217,10 +218,13 @@ def release_number_visitor(self, commit: pygit2.Commit, child_info: dict[str, An
             base = verflags["base"]
             if base is None:
                 base = 1
+            right_base = verflags.get("right_base", 1)
+            if right_base is None:
+                right_base = 1
             tag_string = "".join(f".{t}" for t in (verflags["extraver"], verflags["snapinfo"]) if t)
         else:
             epoch_version = prerelease = None
-            base = 1
+            base = right_base = 1
             tag_string = ""
 
         if not epoch_version:
@@ -247,13 +251,22 @@ def release_number_visitor(self, commit: pygit2.Commit, child_info: dict[str, An
 
         commit_result["verflags"] = commit_verflags
         commit_result["epoch-version"] = epoch_version
-        commit_result["magic-comment-result"] = parse_magic_comments(commit.message)
+        magic_comments = parse_magic_comments(commit.message)
+        commit_result["magic-comment-result"] = magic_comments
+
+        if magic_comments.start_rightmost:
+            log.debug("\tstarting rightmost bumps")
+            self.rightmost_bumps = True
 
         log.debug("\tepoch_version: %s", epoch_version)
         log.debug(
             "\tparent rel numbers: %s",
             ", ".join(str(res["release-number"]) if res else "none" for res in parent_results),
         )
+        log.debug(
+            "\tparent rightmost numbers: %s",
+            ", ".join(str(res["rightmost-number"]) if res else "none" for res in parent_results),
+        )
 
         # Find the maximum applicable parent release number and increment by one if the
         # epoch-version can be parsed from the spec file.
@@ -272,20 +285,51 @@ def release_number_visitor(self, commit: pygit2.Commit, child_info: dict[str, An
             )
             for res in parent_results
         )
+
         release_number = max(parent_release_numbers, default=0)
 
+        parent_rightmost_numbers = tuple(
+            (
+                res["rightmost-number"]
+                if res
+                and (
+                    # Now increase rightmost only until epoch-version or release-number changes
+                    epoch_version is None
+                    or res["epoch-version"] is None
+                    or epoch_version == res["epoch-version"]
+                    or res["release-number"] == release_number
+                )
+                else 0
+            )
+            for res in parent_results
+        )
+
+        rightmost_number = max(parent_rightmost_numbers, default=0)
+
         if self.specfile.name in commit.tree:
-            release_number += 1
+            if self.rightmost_bumps:
+                rightmost_number += 1
+            else:
+                release_number += 1
 
-        release_number = max(release_number, commit_result["magic-comment-result"].bump_release)
+        release_number = max(release_number, magic_comments.bump_release)
+        rightmost_number = max(rightmost_number, magic_comments.bump_rightmost)
 
         commit_result["release-number"] = release_number
+        commit_result["rightmost-number"] = rightmost_number
 
-        log.debug("\trelease_number: %s", release_number)
+        log.debug("\trelease_number: %s (r%s)", release_number, rightmost_number)
 
         prerel_str = "0." if prerelease else ""
         release_number_with_base = release_number + base - 1
-        commit_result["release-complete"] = f"{prerel_str}{release_number_with_base}{tag_string}"
+        rightmost_with_base = rightmost_number + right_base - 1
+        rightmost_str = "" # hide rightmost unless used
+        if rightmost_with_base > 0:
+            rightmost_str = "." + str(rightmost_with_base)
+
+        commit_result["release-complete"] = (
+            f"{prerel_str}{release_number_with_base}{tag_string}{rightmost_str}"
+        )
 
         yield commit_result