Add preparedepends

Author: Eeems

docs/recipe-format.md

@@ -209,6 +209,29 @@ For example, `build:autotools` and `libvncserver>=0.9.13` are valid dependency s
 
 **Dependencies declared in the `makedepends` field are only satisfied during the build process, not at install time** — see the [`installdepends`](#installdepends-field) below for declaring install-time dependencies.
 
+#### `preparedepends` field
+
+<table>
+    <tr>
+        <th>Required?</th>
+        <td>No, defaults to <code>()</code></th>
+    </tr>
+    <tr>
+        <th>Type</th>
+        <td>Array of dependency specifications (strings)</td>
+    </tr>
+</table>
+
+The list of Debian, Toltec or Entware packages that are needed to prepare this package.
+Dependency specifications have the following format: `[host:|build:]package-name`.
+For example, `build:autotools` and `libvncserver>=0.9.13` are valid dependency specifications.
+
+*Build-type dependencies* (prefixed with `build:`) are packages from Debian to install in the container’s root system before the recipe’s build script is executed.
+
+*Host-type dependencies* (prefixed with `host:`) are packages from Toltec or Entware to install in the container’s `$SYSROOT` before the recipe’s build script is executed. The packages are offline-installed (i.e., none of their [install scripts](#install-section) are executed).
+
+**Dependencies declared in the `preparedepends` field are only satisfied during the prepare process, not at install time** — see the [`installdepends`](#installdepends-field) below for declaring install-time dependencies.
+
 #### `pkgnames` field
 
 <table>

toltec/builder.py

@@ -15,7 +15,7 @@
 from . import hooks
 from . import bash, util, ipk
 from .recipe import RecipeBundle, Recipe, Package
-from .version import DependencyKind
+from .version import Dependency, DependencyKind
 
 logger = logging.getLogger(__name__)
 
@@ -112,9 +112,7 @@ def post_build(self, recipe: Recipe, src_dir: str) -> None:
         """
 
     @util.hook
-    def post_package(
-        self, package: Package, src_dir: str, pkg_dir: str
-    ) -> None:
+    def post_package(self, package: Package, src_dir: str, pkg_dir: str) -> None:
         """
         Triggered after part of the artifacts from a build have been copied
         in place to the packaging directory.
@@ -195,9 +193,7 @@ def _make_arch(
         base_pkg_dir = os.path.join(build_dir, "pkg")
         os.makedirs(base_pkg_dir, exist_ok=True)
 
-        for package in (
-            packages if packages is not None else recipe.packages.values()
-        ):
+        for package in packages if packages is not None else recipe.packages.values():
             pkg_dir = os.path.join(base_pkg_dir, package.name)
             os.makedirs(pkg_dir, exist_ok=True)
 
@@ -227,9 +223,7 @@ def _fetch_sources(
 
             if self.URL_REGEX.match(source.url) is None:
                 # Get source file from the recipe’s directory
-                _ = shutil.copy2(
-                    os.path.join(recipe.path, source.url), local_path
-                )
+                _ = shutil.copy2(os.path.join(recipe.path, source.url), local_path)
             else:
                 # Fetch source file from the network
                 req = requests.get(source.url, timeout=(3.05, 300))
@@ -261,69 +255,28 @@ def _fetch_sources(
                         local_path,
                     )
 
-    def _prepare(self, recipe: Recipe, src_dir: str) -> None:
-        """Prepare source files before building."""
-        if not recipe.prepare:
-            logger.debug("Skipping prepare (nothing to do)")
-            return
-
-        logger.info("Preparing source files")
-        mount_src = "/src"
-        uid = os.getuid()
-        gid = os.getgid()
-        logs = bash.run_script_in_container(
-            self.docker,
-            image=self.IMAGE_PREFIX + "toolchain:v4.0",
-            mounts=[
-                docker.types.Mount(
-                    type="bind",
-                    source=os.path.abspath(src_dir),
-                    target=mount_src,
-                ),
-            ],
-            variables={
-                "srcdir": mount_src,
-            },
-            script="\n".join(
-                [
-                    f'cd "{mount_src}"',
-                    recipe.prepare,
-                    f"chown -R {uid}:{gid} {mount_src}",
-                ]
-            ),
-        )
-        bash.pipe_logs(logger, logs, "prepare()")
-
-    # pylint: disable=too-many-locals
-    def _build(self, recipe: Recipe, src_dir: str) -> None:
-        """Build artifacts for a recipe."""
-        if not recipe.build:
-            logger.debug("Skipping build (nothing to do)")
-            return
-
-        logger.info("Building artifacts")
-
-        # Set fixed atime and mtime for all the source files
-        epoch = int(recipe.timestamp.timestamp())
-
-        for filename in util.list_tree(src_dir):
-            os.utime(filename, (epoch, epoch))
-
-        mount_src = "/src"
-        repo_src = "/repo"
-        uid = os.getuid()
-        gid = os.getgid()
+    def _run_script(  # pylint: disable=R0913, R0917, R0914
+        self,
+        script: list[str],
+        arch: str = "rmall",
+        image: str = "toolchain:v4.0",
+        dependencies: set[Dependency] | None = None,
+        mounts: list[docker.types.Mount] | None = None,
+        variables: bash.Variables | None = None,
+    ) -> bash.LogGenerator:
+        """Run a recipe script in a container"""
         pre_script: list[str] = []
 
         # Install required dependencies
         build_deps: list[str] = []
         host_deps: list[str] = []
 
-        for dep in recipe.makedepends:
-            if dep.kind == DependencyKind.BUILD:
-                build_deps.append(dep.package)
-            elif dep.kind == DependencyKind.HOST:
-                host_deps.append(dep.package)
+        if dependencies is not None:
+            for dep in dependencies:
+                if dep.kind == DependencyKind.BUILD:
+                    build_deps.append(dep.package)
+                elif dep.kind == DependencyKind.HOST:
+                    host_deps.append(dep.package)
 
         if build_deps:
             pre_script.extend(
@@ -338,25 +291,16 @@ def _build(self, recipe: Recipe, src_dir: str) -> None:
                 )
             )
 
+        is_aarch64 = arch.startswith("rmpp")
         if host_deps:
             opkg_conf_path = (
                 "$SYSROOT_AARCH64/etc/opkg/opkg.conf"
-                if recipe.arch.startswith("rmpp")
+                if is_aarch64
                 else "$SYSROOT/etc/opkg/opkg.conf"
             )
-            opkg_exec = (
-                "opkg-aarch64" if recipe.arch.startswith("rmpp") else "opkg"
-            )
-            opkg_arch = (
-                "aarch64-3.10"
-                if recipe.arch.startswith("rmpp")
-                else "armv7-3.2"
-            )
-            opkg_src = (
-                "aarch64-k3.10"
-                if recipe.arch.startswith("rmpp")
-                else "armv7sf-k3.2"
-            )
+            opkg_exec = "opkg-aarch64" if is_aarch64 else "opkg"
+            opkg_arch = "aarch64-3.10" if is_aarch64 else "armv7-3.2"
+            opkg_src = "aarch64-k3.10" if is_aarch64 else "armv7sf-k3.2"
 
             pre_script.extend(
                 (
@@ -370,11 +314,11 @@ def _build(self, recipe: Recipe, src_dir: str) -> None:
                 )
             )
 
-            if recipe.arch != "rmall":
+            if arch != "rmall":
                 pre_script.extend(
                     (
-                        f'echo -n "arch {recipe.arch} 250',
-                        f"src/gz toltec-{recipe.arch} file:///repo/{recipe.arch}",
+                        f'echo -n "arch {arch} 250',
+                        f"src/gz toltec-{arch} file:///repo/{arch}",
                         f'" >> "{opkg_conf_path}"',
                     )
                 )
@@ -388,12 +332,88 @@ def _build(self, recipe: Recipe, src_dir: str) -> None:
                 )
             )
 
-        if recipe.arch.startswith("rmpp"):
-            pre_script.append(("source /opt/x-tools/switch-aarch64.sh"))
+        if is_aarch64:
+            pre_script.append(
+                (
+                    "if [ -f /opt/x-tools/switch-aarch64.sh ]; then"
+                    + "source /opt/x-tools/switch-aarch64.sh;"
+                    + "fi"
+                )
+            )
 
-        logs = bash.run_script_in_container(
+        return bash.run_script_in_container(
             self.docker,
-            image=self.IMAGE_PREFIX + recipe.image,
+            image=self.IMAGE_PREFIX + image,
+            mounts=mounts or [],
+            variables=variables or {},
+            script="\n".join(
+                [
+                    *pre_script,
+                    *script,
+                ]
+            ),
+        )
+
+    def _prepare(self, recipe: Recipe, src_dir: str) -> None:
+        """Prepare source files before building."""
+        if not recipe.prepare:
+            logger.debug("Skipping prepare (nothing to do)")
+            return
+
+        logger.info("Preparing source files")
+        mount_src = "/src"
+        uid = os.getuid()
+        gid = os.getgid()
+        logs = self._run_script(
+            [
+                f'cd "{mount_src}"',
+                recipe.prepare,
+                f"chown -R {uid}:{gid} {mount_src}",
+            ],
+            image=recipe.image,
+            arch=recipe.arch,
+            dependencies=recipe.preparedepends,
+            mounts=[
+                docker.types.Mount(
+                    type="bind",
+                    source=os.path.abspath(src_dir),
+                    target=mount_src,
+                ),
+            ],
+            variables={
+                "srcdir": mount_src,
+            },
+        )
+        bash.pipe_logs(logger, logs, "prepare()")
+
+    # pylint: disable=too-many-locals
+    def _build(self, recipe: Recipe, src_dir: str) -> None:
+        """Build artifacts for a recipe."""
+        if not recipe.build:
+            logger.debug("Skipping build (nothing to do)")
+            return
+
+        logger.info("Building artifacts")
+
+        # Set fixed atime and mtime for all the source files
+        epoch = int(recipe.timestamp.timestamp())
+
+        for filename in util.list_tree(src_dir):
+            os.utime(filename, (epoch, epoch))
+
+        mount_src = "/src"
+        repo_src = "/repo"
+        uid = os.getuid()
+        gid = os.getgid()
+
+        logs = self._run_script(
+            [
+                f'cd "{mount_src}"',
+                recipe.build,
+                f"chown -R {uid}:{gid} {mount_src} {repo_src}",
+            ],
+            arch=recipe.arch,
+            dependencies=recipe.makedepends,
             mounts=[
                 docker.types.Mount(
                     type="bind",
@@ -409,14 +429,6 @@ def _build(self, recipe: Recipe, src_dir: str) -> None:
             variables={
                 "srcdir": mount_src,
             },
-            script="\n".join(
-                (
-                    *pre_script,
-                    f'cd "{mount_src}"',
-                    recipe.build,
-                    f"chown -R {uid}:{gid} {mount_src} {repo_src}",
-                )
-            ),
         )
         bash.pipe_logs(logger, logs, "build()")
 
@@ -437,9 +449,7 @@ def _package(self, package: Package, src_dir: str, pkg_dir: str) -> None:
         for filename in util.list_tree(pkg_dir):
             logger.debug(
                 " - %s",
-                os.path.normpath(
-                    os.path.join("/", os.path.relpath(filename, pkg_dir))
-                ),
+                os.path.normpath(os.path.join("/", os.path.relpath(filename, pkg_dir))),
             )
 
     @staticmethod
@@ -484,9 +494,7 @@ def _archive(package: Package, pkg_dir: str, ar_path: str) -> None:
                 )
 
         for step in ("pre", "post"):
-            if getattr(package, step + "upgrade") or getattr(
-                package, step + "remove"
-            ):
+            if getattr(package, step + "upgrade") or getattr(package, step + "remove"):
                 script = script_header
 
                 for action in ("upgrade", "remove"):

toltec/recipe.py

@@ -69,6 +69,9 @@ class Recipe:  # pylint: disable=too-many-instance-attributes
     # Set of packages that are needed to build this recipe
     makedepends: set[Dependency]
 
+    # Set of packages that are needed to prepare this recipe
+    preparedepends: set[Dependency]
+
     # Full name and email address of this recipe’s maintainer
     maintainer: str