add volumes parameter to images_build

Signed-off-by: Federico Rizzo <[email protected]>

Author: fulminemizzega

podman/domain/images_build.py

@@ -66,6 +66,28 @@ def build(self, **kwargs) -> tuple[Image, Iterator[bytes]]:
             layers (bool) - Cache intermediate layers during build.
             output (str) - specifies if any custom build output is selected for following build.
             outputformat (str) - The format of the output image's manifest and configuration data.
+            volumes (dict[str, dict[str, Union[str, list]]])
+                Mount a host directory into containers when executing RUN instructions during the build.
+                The key is the host path and the value is a dictionary with the keys:
+
+                - bind: The path to mount the volume inside the container
+                - mode: One or multiple of [ro|rw],[z|Z|O],[U],[[r]shared|[r]slave|[r]private]
+                        By default, the volumes are mounted read-write
+
+                For example:
+
+                    {
+
+                        '/etc/host':
+
+                            {'bind': '/etc/host', 'mode': 'ro'},
+
+                        '/tmp/cache':
+
+                            {'bind': '/var/cache/libdnf5', 'mode': ['rw', 'z']},
+
+                    }
+
 
         Returns:
             first item is the podman.domain.images.Image built
@@ -184,6 +206,7 @@ def _render_params(kwargs) -> dict[str, list[Any]]:
             "layers": kwargs.get("layers"),
             "output": kwargs.get("output"),
             "outputformat": kwargs.get("outputformat"),
+            "volume": [],
         }
 
         if "buildargs" in kwargs:
@@ -215,5 +238,17 @@ def default(value, def_value):
             params["dockerfile"], f".containerfile.{random.getrandbits(160):x}"
         )
 
+        volumes = kwargs.get("volumes")
+        if volumes is not None:
+            for hostdir, target in volumes.items():
+                mode = target.get('mode', [])
+                binddir = target.get('bind')
+                if binddir is None:
+                    raise ValueError("'bind' value not defined")
+                if not isinstance(mode, list):
+                    raise ValueError("'mode' value should be a list")
+                mode_str = ",".join(mode)
+                params["volume"].append(f"{hostdir}:{target['bind']}:{mode_str}")
+
         # Remove any unset parameters
         return dict(filter(lambda i: i[1] is not None, params.items()))

podman/tests/integration/test_images.py

@@ -19,7 +19,9 @@
 import platform
 import tarfile
 import types
+import random
 import unittest
+from tempfile import NamedTemporaryFile
 
 import podman.tests.integration.base as base
 from podman import PodmanClient
@@ -158,6 +160,25 @@ def test_build_cache(self):
                 break
         self.assertEqual(parsed.split()[3], image.id)
 
+    def test_build_volume(self):
+        file = self.enterContext(NamedTemporaryFile(mode="w+"))
+        content = "test"
+        file.write(content)
+        file.seek(0)
+        containerfile_str = "\n".join(
+            [
+                "FROM quay.io/libpod/alpine_labels:latest",
+                f"RUN cp /host{file.name} /copy",
+                """CMD ["cat", "/copy"]""",
+            ]
+        )
+        buffer = io.StringIO(containerfile_str)
+
+        vol_dict = {f"{file.name}": {"bind": f"/host{file.name}", "mode": ["ro", "Z"]}}
+        image, stream = self.client.images.build(fileobj=buffer, volumes=vol_dict)
+        cntr = self.client.containers.run(image, remove=True, stdout=True)
+        self.assertEqual(cntr.decode(), content)
+
     def test_build_with_context(self):
         context = io.BytesIO()
         with tarfile.open(fileobj=context, mode="w") as tar: