MK8S-25: Add saltenv directory cleanup to parent RedHat ISO task

Modify _package_mkdir_redhat_iso_root task to include cleanup of the
saltenv directory structure (metalk8s-{VERSION}) created by repository
index files.

This prevents cleanup failures in higher-level directory cleanup tasks
that were unable to remove non-empty directories containing our
index.html files.

- Add config import to packaging.py
- Add custom clean function to remove saltenv directory
- Use coreutils.rm_rf for safe recursive removal

This ensures complete cleanup allows e2e tests to run properly.

Author: rdebay-scality

buildchain/buildchain/packaging.py

@@ -32,6 +32,7 @@
 import doit  # type: ignore
 
 from buildchain import builder
+from buildchain import config
 from buildchain import constants
 from buildchain import coreutils
 from buildchain import docker_command
@@ -45,7 +46,7 @@
 
 
 def _list_packages_to_build(
-    pkg_cats: Mapping[str, Mapping[str, Tuple[targets.Package, ...]]]
+    pkg_cats: Mapping[str, Mapping[str, Tuple[targets.Package, ...]]],
 ) -> Dict[str, List[str]]:
     return {
         version: [pkg.name for pkg in pkg_list]
@@ -149,11 +150,27 @@ def task__package_mkdir_iso_root() -> types.TaskDict:
 
 def task__package_mkdir_redhat_iso_root() -> types.TaskDict:
     """Create the RedHat packages root directory on the ISO."""
-    return targets.Mkdir(
+
+    def clean() -> None:
+        """Clean RedHat directory including saltenv directory structure."""
+        # Remove saltenv directory structure created by repository index files
+        saltenv_dir = (
+            constants.REPO_REDHAT_ROOT
+            / f"{config.PROJECT_NAME.lower()}-{versions.VERSION}"
+        )
+        if saltenv_dir.exists():
+            coreutils.rm_rf(saltenv_dir)
+
+    mkdir_task = targets.Mkdir(
         directory=constants.REPO_REDHAT_ROOT,
         task_dep=["_package_mkdir_iso_root"],
     ).task
 
+    # Add our custom cleanup function
+    mkdir_task["clean"] = [clean]
+
+    return mkdir_task
+
 
 def _package_mkdir_redhat_release_iso_root(releasever: str) -> types.TaskDict:
     """
@@ -263,6 +280,7 @@ def task__build_redhat_8_repositories() -> Iterator[types.TaskDict]:
 # }}}
 # RPM packages and repository {{{
 
+
 # Packages to build, per repository.
 def _rpm_package(name: str, releasever: str, sources: List[Path]) -> targets.RPMPackage:
     try:
@@ -362,11 +380,11 @@ def _rpm_package_metalk8s_sosreport(releasever: str) -> targets.RPMPackage:
 
 
 # Store these versions in a dict to use with doit.tools.config_changed
-_TO_DOWNLOAD_RPM_CONFIG: Dict[
-    str, Dict[str, Optional[str]]
-] = _list_packages_to_download(
-    versions.REDHAT_PACKAGES,
-    _RPM_TO_BUILD_PKG_NAMES,
+_TO_DOWNLOAD_RPM_CONFIG: Dict[str, Dict[str, Optional[str]]] = (
+    _list_packages_to_download(
+        versions.REDHAT_PACKAGES,
+        _RPM_TO_BUILD_PKG_NAMES,
+    )
 )