Allow to specify a different build number for a single package

This commit allow to specify a different build number for a single
package, to allow to perform a fix to a build of a single package,
without the need to do a full rebuild.

This is an advanced option, so special care is needed:
* A rebuild is only possible if it does not change the version
  or in any other way the ABI of the package.
* On the following full rebuild, it is important to make sure that
  the build number select is higher then any custom build number used for single packages.

Author: traversaro

vinca/main.py

@@ -16,7 +16,7 @@
 from .distro import Distro
 
 from vinca import config
-from vinca.utils import get_repodata
+from vinca.utils import get_repodata, get_pkg_build_number
 
 unsatisfied_deps = set()
 distro = None
@@ -218,6 +218,11 @@ def read_vinca_yaml(filepath):
 
     vinca_conf["trigger_new_versions"] = vinca_conf.get("trigger_new_versions", False)
 
+    if (Path(filepath).parent / "pkg_additional_info.yaml").exists():
+        vinca_conf["_pkg_additional_info"] = yaml.load(open(Path(filepath).parent / "pkg_additional_info.yaml"))
+    else:
+        vinca_conf["_pkg_additional_info"] = {}
+
     return vinca_conf
 
 
@@ -864,6 +869,7 @@ def main():
     base_dir = os.path.abspath(arguments.dir)
     vinca_yaml = os.path.join(base_dir, "vinca.yaml")
     vinca_conf = read_vinca_yaml(vinca_yaml)
+
     snapshot = read_snapshot(arguments.snapshot)
 
     from .template import generate_bld_ament_cmake
@@ -946,19 +952,19 @@ def main():
                 # only URLs
                 if "://" in fn:
                     selected_bn = vinca_conf.get("build_number", 0)
-                    distro = vinca_conf["ros_distro"]
-                    all_pkgs = repodata.get("packages", {})
-                    all_pkgs.update(repodata.get("packages.conda", {}))
-                    for pkg_name, pkg in all_pkgs.items():
-                        if pkg_name.startswith(f"ros-{distro}"):
-                            if pkg_name.rsplit("-", 2)[0] in additional_recipe_names:
-                                print(
-                                    f"Skipping additional recipe for build number computation {pkg_name}"
-                                )
-                                continue
-                            selected_bn = max(selected_bn, pkg["build_number"])
-
-                print(f"Selected build number: {selected_bn}")
+                    if not vinca_conf.get("use_explicit_build_number", False):
+                        distro = vinca_conf["ros_distro"]
+                        all_pkgs = repodata.get("packages", {})
+                        all_pkgs.update(repodata.get("packages.conda", {}))
+                        for pkg_name, pkg in all_pkgs.items():
+                            if pkg_name.startswith(f"ros-{distro}"):
+                                if pkg_name.rsplit("-", 2)[0] in additional_recipe_names:
+                                    print(
+                                        f"Skipping additional recipe for build number computation {pkg_name}"
+                                    )
+                                    continue
+                                selected_bn = max(selected_bn, pkg["build_number"])
+
 
                 explicitly_selected_pkgs = [
                     f"ros-{distro}-{pkg.replace('_', '-')}"
@@ -969,14 +975,15 @@ def main():
                 for _, pkg in all_pkgs.items():
                     is_built = False
                     if selected_bn is not None:
+                        pkg_build_number = get_pkg_build_number(selected_bn, pkg["name"], vinca_conf)
                         if vinca_conf.get("full_rebuild", True):
-                            if pkg["build_number"] == selected_bn:
+                            if pkg["build_number"] == pkg_build_number:
                                 is_built = True
                         else:
                             # remove all packages except explicitly selected ones
                             if (
                                 pkg["name"] not in explicitly_selected_pkgs
-                                or pkg["build_number"] == selected_bn
+                                or pkg["build_number"] == pkg_build_number
                             ):
                                 is_built = True
                     else:

vinca/template.py

@@ -7,6 +7,8 @@
 from ruamel import yaml
 from pathlib import Path
 
+from vinca.utils import get_pkg_build_number
+
 TEMPLATE = """\
 # yaml-language-server: $schema=https://raw.githubusercontent.com/prefix-dev/recipe-format/main/schema.json
 
@@ -71,7 +73,6 @@ def copyfile_with_exec_permissions(source_file, destination_file):
         os.chmod(destination_file, current_permissions | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
 
 def write_recipe(source, outputs, vinca_conf, single_file=True):
-    build_number = vinca_conf.get("build_number", 0)
     # single_file = False
     if single_file:
         file = yaml.YAML()
@@ -84,7 +85,7 @@ def write_recipe(source, outputs, vinca_conf, single_file=True):
         meta["package"]["version"] = f"{datetime.datetime.now():%Y.%m.%d}"
         meta["recipe"] = meta["package"]
         del meta["package"]
-        meta["build"]["number"] = build_number
+        meta["build"]["number"] = vinca_conf.get("build_number", 0)
         meta["build"]["post_process"] = post_process_items
         with open("recipe.yaml", "w") as stream:
             file.dump(meta, stream)
@@ -102,7 +103,7 @@ def write_recipe(source, outputs, vinca_conf, single_file=True):
             meta["package"]["name"] = o["package"]["name"]
             meta["package"]["version"] = o["package"]["version"]
 
-            meta["build"]["number"] = build_number
+            meta["build"]["number"] = get_pkg_build_number(vinca_conf.get("build_number", 0), o["package"]["name"], vinca_conf)
             meta["build"]["post_process"] = post_process_items
 
             if test := vinca_conf["_tests"].get(o["package"]["name"]):

vinca/utils.py

@@ -65,3 +65,20 @@ def get_repodata(url_or_path, platform=None):
     with open(fn, "w") as fcache:
         fcache.write(content.decode("utf-8"))
     return json.loads(content)
+
+def ensure_name_is_without_distro_prefix_and_with_underscores(name, vinca_conf):
+    """
+    Ensure that the name is without distro prefix and with underscores
+    e.g. "ros-humble-pkg-name" -> "pkg_name"
+    """
+    newname = name.replace("-", "_")
+    distro_prefix = "ros_" + vinca_conf.get("ros_distro") + "_"
+    if (newname.startswith(distro_prefix) ):
+        newname = newname.replace(distro_prefix, "")
+
+    return newname
+
+def get_pkg_build_number(default_build_number, pkg_name, vinca_conf):
+    normalized_name = ensure_name_is_without_distro_prefix_and_with_underscores(pkg_name, vinca_conf)
+    pkg_additional_info = vinca_conf["_pkg_additional_info"].get(normalized_name, {})
+    return pkg_additional_info.get("build_number", default_build_number)