Generic debuginfo RPM platform support (#942)

This change splits the `debuginfo` RPM support into `fedora` and `centos`, and bundles `almalinux` into the `centos` category.

This facilitates future support as more versions are being added as opposed to hardcoding every individual OS name and version combination.

The fedora and centos specific logic remains unchanged.

Author: nicbadiu

pkg/make_rpm.py

@@ -178,6 +178,15 @@ class RpmBuilder(object):
   RPMS_DIR = 'RPMS'
   DIRS = [SOURCE_DIR, BUILD_DIR, RPMS_DIR, TEMP_DIR]
 
+  # `debuginfo` RPM types as defined in `toolchains/rpm/rpmbuild_configure.bzl`
+  DEBUGINFO_TYPE_NONE = "none"
+  DEBUGINFO_TYPE_CENTOS = "centos"
+  DEBUGINFO_TYPE_FEDORA = "fedora"
+  SUPPORTED_DEBUGINFO_TYPES = {
+    DEBUGINFO_TYPE_CENTOS,
+    DEBUGINFO_TYPE_FEDORA,
+  }
+
   def __init__(self, name, version, release, arch, rpmbuild_path,
                source_date_epoch=None,
                debug=False):
@@ -362,7 +371,7 @@ def CallRpmBuild(self, dirname, rpmbuild_args, debuginfo_type):
     if self.debug:
       args.append('-vv')
 
-    if debuginfo_type == "fedora40":
+    if debuginfo_type == RpmBuilder.DEBUGINFO_TYPE_FEDORA:
       os.makedirs(f'{dirname}/{RpmBuilder.BUILD_DIR}/{RpmBuilder.BUILD_SUBDIR}')
 
     # Common options
@@ -375,13 +384,13 @@ def CallRpmBuild(self, dirname, rpmbuild_args, debuginfo_type):
       '--define', '_builddir %s/BUILD' % dirname,
     ]
 
-    if debuginfo_type in ["fedora40", "centos7", "centos9", "almalinux9.3"]:
+    if debuginfo_type in RpmBuilder.SUPPORTED_DEBUGINFO_TYPES:
       args += ['--undefine', '_debugsource_packages']
 
-    if debuginfo_type in ["centos7", "centos9", "almalinux9.3"]:
+    if debuginfo_type == RpmBuilder.DEBUGINFO_TYPE_CENTOS:
       args += ['--define', 'buildsubdir .']
 
-    if debuginfo_type == "fedora40":
+    if debuginfo_type == RpmBuilder.DEBUGINFO_TYPE_FEDORA:
       args += ['--define', f'buildsubdir {RpmBuilder.BUILD_SUBDIR}']
 
     args += [
@@ -399,7 +408,7 @@ def CallRpmBuild(self, dirname, rpmbuild_args, debuginfo_type):
     if self.file_list_path:
       # %files -f is taken relative to the package root
       base_path = os.path.basename(self.file_list_path)
-      if debuginfo_type == "fedora40":
+      if debuginfo_type == RpmBuilder.DEBUGINFO_TYPE_FEDORA:
         base_path = os.path.join("..", base_path)
 
       args += ['--define', 'build_rpm_files %s' % base_path]
@@ -556,30 +565,31 @@ def main(argv):
   parser.add_argument('--install_script',
                       help='Installer script')
   parser.add_argument('--file_list',
-                      help='File containing a list of files to include with rpm spec %files -f')
+                      help='File containing a list of files to include with rpm spec %%files -f')
   parser.add_argument('--preamble',
                       help='File containing the RPM Preamble')
   parser.add_argument('--description',
-                      help='File containing the RPM %description text')
+                      help='File containing the RPM %%description text')
   parser.add_argument('--subrpms',
                       help='File containing the RPM subrpm details')
   parser.add_argument('--pre_scriptlet',
-                      help='File containing the RPM %pre scriptlet, if to be substituted')
+                      help='File containing the RPM %%pre scriptlet, if to be substituted')
   parser.add_argument('--post_scriptlet',
-                      help='File containing the RPM %post scriptlet, if to be substituted')
+                      help='File containing the RPM %%post scriptlet, if to be substituted')
   parser.add_argument('--preun_scriptlet',
-                      help='File containing the RPM %preun scriptlet, if to be substituted')
+                      help='File containing the RPM %%preun scriptlet, if to be substituted')
   parser.add_argument('--postun_scriptlet',
-                      help='File containing the RPM %postun scriptlet, if to be substituted')
+                      help='File containing the RPM %%postun scriptlet, if to be substituted')
   parser.add_argument('--posttrans_scriptlet',
-                      help='File containing the RPM %posttrans scriptlet, if to be substituted')
+                      help='File containing the RPM %%posttrans scriptlet, if to be substituted')
   parser.add_argument('--changelog',
                       help='File containing the RPM changelog text')
 
   parser.add_argument('--rpmbuild_arg', dest='rpmbuild_args', action='append',
                       help='Any additional arguments to pass to rpmbuild')
-  parser.add_argument('--debuginfo_type', dest='debuginfo_type', default='none',
-                      help='debuginfo type to use (centos7, fedora40, or none)')
+  parser.add_argument('--debuginfo_type', default=RpmBuilder.DEBUGINFO_TYPE_NONE,
+                      choices=sorted(RpmBuilder.SUPPORTED_DEBUGINFO_TYPES) + [RpmBuilder.DEBUGINFO_TYPE_NONE],
+                      help='debuginfo type to use')
   parser.add_argument('files', nargs='*')
 
   options = parser.parse_args(argv or ())

pkg/rpm_pfg.bzl

@@ -25,6 +25,11 @@ find_system_rpmbuild(name="rules_pkg_rpmbuild")
 ```
 """
 
+load(
+    "@rules_pkg//toolchains/rpm:rpmbuild_configure.bzl",
+    "DEBUGINFO_TYPE_FEDORA",
+    "DEBUGINFO_TYPE_NONE",
+)
 load(
     "//pkg:providers.bzl",
     "PackageDirsInfo",
@@ -223,7 +228,7 @@ def _process_files(pfi, origin_label, grouping_label, file_base, rpm_ctx, debugi
             rpm_ctx.rpm_files_list.append(_FILE_MODE_STANZA_FMT.format(file_base, abs_dest))
 
             install_stanza_fmt = _INSTALL_FILE_STANZA_FMT
-            if debuginfo_type == "fedora40":
+            if debuginfo_type == DEBUGINFO_TYPE_FEDORA:
                 install_stanza_fmt = _INSTALL_FILE_STANZA_FMT_FEDORA40_DEBUGINFO
 
             rpm_ctx.install_script_pieces.append(install_stanza_fmt.format(
@@ -470,7 +475,7 @@ def _pkg_rpm_impl(ctx):
 
     files = []
     tools = []
-    debuginfo_type = "none"
+    debuginfo_type = DEBUGINFO_TYPE_NONE
     name = ctx.attr.package_name if ctx.attr.package_name else ctx.label.name
     rpm_ctx.make_rpm_args.append("--name=" + name)
 
@@ -755,7 +760,7 @@ def _pkg_rpm_impl(ctx):
         files.append(subrpm_file)
         rpm_ctx.make_rpm_args.append("--subrpms=" + subrpm_file.path)
 
-    if debuginfo_type != "none":
+    if debuginfo_type != DEBUGINFO_TYPE_NONE:
         debuginfo_default_file = ctx.actions.declare_file(
             "{}-debuginfo.rpm".format(rpm_name),
         )

toolchains/rpm/rpmbuild.bzl

@@ -60,7 +60,7 @@ rpmbuild_toolchain = rule(
             doc = """
             The underlying debuginfo configuration for the system rpmbuild.
 
-            One of centos7, fedora40, or none
+            One of `centos`, `fedora`, and `none`
             """,
             default = "none",
         ),

toolchains/rpm/rpmbuild_configure.bzl

@@ -57,19 +57,21 @@ def _parse_release_info(release_info):
 
     return os_name, os_version
 
-KNOWN_DEBUGINFO_VERSIONS = {
-    "almalinux": ["9.3"],
-    "centos": ["7", "9"],
-    "fedora": ["40"],
+DEBUGINFO_TYPE_NONE = "none"
+DEBUGINFO_TYPE_CENTOS = "centos"
+DEBUGINFO_TYPE_FEDORA = "fedora"
+
+DEBUGINFO_TYPE_BY_OS_RELEASE = {
+    "almalinux": DEBUGINFO_TYPE_CENTOS,
+    "centos": DEBUGINFO_TYPE_CENTOS,
+    "fedora": DEBUGINFO_TYPE_FEDORA,
 }
 
 def _build_repo_for_rpmbuild_toolchain_impl(rctx):
-    debuginfo_type = "none"
+    debuginfo_type = DEBUGINFO_TYPE_NONE
     if rctx.path(RELEASE_PATH).exists:
-        os_name, os_version = _parse_release_info(rctx.read(RELEASE_PATH))
-        if (os_name in KNOWN_DEBUGINFO_VERSIONS and
-            os_version in KNOWN_DEBUGINFO_VERSIONS[os_name]):
-            debuginfo_type = os_name + os_version
+        os_name, _ = _parse_release_info(rctx.read(RELEASE_PATH))
+        debuginfo_type = DEBUGINFO_TYPE_BY_OS_RELEASE.get(os_name, debuginfo_type)
 
     rpmbuild_path = rctx.which("rpmbuild")
     if rctx.attr.verbose:
@@ -110,7 +112,7 @@ build_repo_for_rpmbuild_toolchain = repository_rule(
             doc = """
             The underlying debuginfo configuration for the system rpmbuild.
 
-            One of centos7, fedora40, or none
+            One of `centos`, `fedora`, and `none`
             """,
             default = "none",
         ),