diff mbox series

[1/3] classes: add 'customization' package support

Message ID 20250311210939.4090-2-chris.larson@siemens.com
State Accepted, archived
Headers show
Series Add 'customization' package support | expand

Commit Message

chris.larson March 11, 2025, 9:09 p.m. UTC 
From: Christopher Larson <chris.larson@siemens.com>

A number of downstream layers have customization dpkg-raw recipes making use of
template variables to support build-time settings: add the infrastructure to
Isar to help uniformization of such recipes. Settings are often specific to a
DISTRO, MACHINE or IMAGE: provide a mechanism to decorate (prefix or suffix)
packages being constructed and pulled into the image. This helps use of
customization packages in multiconfig builds but also with the deployment of
binary package feeds for projects supporting multiple variants.

To create a customization package, a recipe must inherit the
`dpkg-customization` bbclass. By default, images will inherit the
`image-customizations` class, which will install the package for any
customizations listed in `CUSTOMIZATIONS`.

To add variables to the customization package names, beyond the default DISTRO
and MACHINE, add them to `CUSTOMIZATION_VARS` as variable references
(`${DISTRO}`, `${MACHINE}`). By default, these variables are appended to the
package name, but if they should be prefixed, add them to
`CUSTOMIZATION_VARS_PREFIXED`. By default, the `DISTRO` and `MACHINE` variables
are used, and the `DISTRO` is prefixed, while the `MACHINE` is suffixed.

To enable support for per-image changes, and per-image customization packages,
add the image name to `CUSTOMIZATION_FOR_IMAGES`. In the customization package
recipe, the `IMAGE` variable will be set to the image name, and the package name
will be decorated with the image name. The `IMAGE` will also be added to the
`OVERRIDES`, allowing for variable definitions like this in the customization
recipe:

    HOSTNAME:isar-image-ci = "isar-ci"

When `CUSTOMIZATION_FOR_IMAGES` is defined, `${IMAGE}` will be implicitly added
to `CUSTOMIZATION_VARS`, and the package will be decorated with the image name.

Signed-off-by: Christopher Larson <chris.larson@siemens.com>
---
 meta/classes/customization-base.bbclass   | 21 +++++++++++++
 meta/classes/dpkg-customization.bbclass   | 37 +++++++++++++++++++++++
 meta/classes/image-customizations.bbclass | 30 ++++++++++++++++++
 meta/classes/image.bbclass                |  1 +
 4 files changed, 89 insertions(+)
 create mode 100644 meta/classes/customization-base.bbclass
 create mode 100644 meta/classes/dpkg-customization.bbclass
 create mode 100644 meta/classes/image-customizations.bbclass
diff mbox series

Patch

diff --git a/meta/classes/customization-base.bbclass b/meta/classes/customization-base.bbclass
new file mode 100644
index 00000000..82cad67e
--- /dev/null
+++ b/meta/classes/customization-base.bbclass
@@ -0,0 +1,21 @@ 
+# Common class for customization packages, used by dpkg-customization.bbclass
+# and image-customizations.bbclass.
+
+LIST_VARIABLES += "CUSTOMIZATIONS CUSTOMIZATION_VARS CUSTOMIZATION_VARS_PREFIXED"
+
+CUSTOMIZATIONS ?= ""
+CUSTOMIZATIONS[doc] = "List of customization packages to be installed in images."
+
+CUSTOMIZATION_VARS ?= "${DISTRO} ${MACHINE}"
+CUSTOMIZATION_VARS[doc] = "List of variables that should be added to customization package names."
+CUSTOMIZATION_VARS_IMAGE ?= "${IMAGE}"
+CUSTOMIZATION_VARS:append = " ${@d.getVar('CUSTOMIZATION_VARS_IMAGE') if d.getVar('CUSTOMIZATION_FOR_IMAGES').strip() else ''}"
+
+CUSTOMIZATION_VARS_PREFIXED ?= "${DISTRO}"
+CUSTOMIZATION_VARS_PREFIXED[doc] = "List of variables from CUSTOMIZATION_VARS that should be prefixed rather than suffixed to customization package names."
+
+CUSTOMIZATION_FOR_IMAGES ?= ""
+CUSTOMIZATION_FOR_IMAGES[doc] = "List of images that should install the customizations in CUSTOMIZATIONS"
+
+CUSTOMIZATION_PREFIX ?= "${@'-'.join(var for var in d.getVar('CUSTOMIZATION_VARS').split() if var in d.getVar('CUSTOMIZATION_VARS_PREFIXED'))}"
+CUSTOMIZATION_SUFFIX ?= "${@'-'.join(var for var in d.getVar('CUSTOMIZATION_VARS').split() if var not in d.getVar('CUSTOMIZATION_VARS_PREFIXED'))}"
diff --git a/meta/classes/dpkg-customization.bbclass b/meta/classes/dpkg-customization.bbclass
new file mode 100644
index 00000000..7b8c586b
--- /dev/null
+++ b/meta/classes/dpkg-customization.bbclass
@@ -0,0 +1,37 @@ 
+inherit dpkg-raw customization-base
+
+PRE_CUSTOMIZATION_PN := "${PN}"
+FILESEXTRAPATHS:prepend := "${THISDIR}/${BPN}:"
+PN =. "${@d.getVar('CUSTOMIZATION_PREFIX') + '-' if d.getVar('CUSTOMIZATION_PREFIX') else ''}"
+PN .= "${@'-' + d.getVar('CUSTOMIZATION_SUFFIX') if d.getVar('CUSTOMIZATION_SUFFIX') else ''}"
+
+BBCLASSEXTEND = "${@' '.join(f'dpkg-customization:{image}' for image in d.getVar('CUSTOMIZATION_FOR_IMAGES').split())}"
+
+python customization_virtclass_handler() {
+    orig_pn = d.getVar('PRE_CUSTOMIZATION_PN')
+
+    d = e.data
+    extend = d.getVar('BBEXTENDCURR') or ''
+    variant = d.getVar('BBEXTENDVARIANT') or ''
+    if extend != 'dpkg-customization' or variant == '':
+        d.appendVar('PROVIDES', f' {orig_pn}')
+        d.setVar('IMAGE', '')
+        return
+
+    vars = (d.getVar('CUSTOMIZATION_VARS', expand=False) or '').split()
+    if '${IMAGE}' not in vars:
+        return
+
+    images = (d.getVar('CUSTOMIZATION_FOR_IMAGES') or '').split()
+    if variant not in images:
+        return
+
+    d.setVar('IMAGE', variant)
+    if not d.getVar('BPN').endswith(f'-{variant}'):
+        d.appendVar('BPN', f'-{variant}')
+    d.appendVar('PROVIDES', f' {orig_pn}-{variant}')
+    d.appendVar('OVERRIDES', f':{variant}')
+}
+addhandler customization_virtclass_handler
+customization_virtclass_handler[eventmask] = "bb.event.RecipePreFinalise"
+
diff --git a/meta/classes/image-customizations.bbclass b/meta/classes/image-customizations.bbclass
new file mode 100644
index 00000000..996f3fb8
--- /dev/null
+++ b/meta/classes/image-customizations.bbclass
@@ -0,0 +1,30 @@ 
+inherit customization-base
+
+def customization_packages(d):
+    customizations = d.getVar('CUSTOMIZATIONS').split()
+    if not customizations:
+        return ''
+
+    # Use image-specific customization if enabled for this image
+    images = (d.getVar('CUSTOMIZATION_FOR_IMAGES') or '').split()
+    image = d.getVar('BPN')
+    if not images or image not in images:
+        d.setVar('IMAGE', '')
+    else:
+        d.setVar('IMAGE', image)
+
+    prefix = d.getVar('CUSTOMIZATION_PREFIX')
+    if prefix:
+        prefix += '-'
+
+    suffix = d.getVar('CUSTOMIZATION_SUFFIX')
+    if suffix:
+        suffix = '-customization-' + suffix
+    else:
+        suffix = '-customization'
+
+    customizations = [ prefix + package + suffix for package in customizations ]
+    return ' '.join(customizations)
+
+CUSTOMIZATION_PACKAGES = "${@ customization_packages(d) }"
+IMAGE_INSTALL:append = " ${CUSTOMIZATION_PACKAGES}"
diff --git a/meta/classes/image.bbclass b/meta/classes/image.bbclass
index 56eca202..d36bb816 100644
--- a/meta/classes/image.bbclass
+++ b/meta/classes/image.bbclass
@@ -80,6 +80,7 @@  inherit image-tools-extension
 inherit image-postproc-extension
 inherit image-locales-extension
 inherit image-account-extension
+inherit image-customizations
 
 # Extra space for rootfs in MB
 ROOTFS_EXTRA ?= "64"