Merge pull request #142 from adamblake/main

Allow extra options to be passed to docker build

Author: consideRatio

README.md

@@ -192,6 +192,14 @@ charts:
         buildArgs:
           MY_STATIC_BUILD_ARG: "hello world"
           MY_DYNAMIC_BUILD_ARG: "{TAG}-{LAST_COMMIT}"
+        # Build options to be passed to the docker build command. Pass a list
+        # of strings to be appended to the end of the build command. These are
+        # passed directly to the command line, so prepend each option with "--"
+        # like in the examples below. TAG and LAST_COMMIT are expandable.
+        extraBuildCommandOptions:
+          - --label=maintainer=octocat
+          - --label=ref={TAG}-{LAST_COMMIT}
+          - --rm
         # contextPath is the path to the directory that is to be considered the
         # current working directory during the build process of the Dockerfile.
         # This is by default the folder of the Dockerfile. This path should be

chartpress.py

@@ -236,6 +236,23 @@ def _get_image_build_args(image_options, ns):
     return build_args
 
 
+def _get_image_extra_build_command_options(image_options, ns):
+    """
+    Render extraBuildCommandOptions from chartpress.yaml that could be
+    templates, using the provided namespace that contains keys with dynamic
+    values such as LAST_COMMIT or TAG.
+
+    Args:
+    image_options (dict):
+        The dictionary for a given image from chartpress.yaml.
+        Strings in `image_options['extraBuildCommandOptions']` will be rendered
+        and returned.
+    ns (dict): the namespace used when rendering templated arguments
+    """
+    options = image_options.get("extraBuildCommandOptions", [])
+    return [str(option).format(**ns) for option in options]
+
+
 def _get_image_build_context_path(name, options):
     """
     Return the image's contextPath configuration value, or a default value based
@@ -296,6 +313,7 @@ def build_image(
     context_path,
     dockerfile_path=None,
     build_args=None,
+    extra_build_command_options=None,
     *,
     push=False,
     builder=Builder.DOCKER_BUILD,
@@ -321,6 +339,9 @@ def build_image(
         "<context_path>/Dockerfile".
     build_args (dict, optional):
         Dictionary of docker build arguments.
+    extra_build_command_options (list, optional):
+        List of other docker build options to use. Each item should be a string
+        that gets appended to the build command (e.g. "--label=version=0.1.0").
     push (bool, optional):
         Whether to push the image to a registry
     builder (str):
@@ -356,6 +377,8 @@ def build_image(
             cmd.append("--push")
         elif len(platforms) <= 1:
             cmd.append("--load")
+    if extra_build_command_options:
+        cmd.extend(extra_build_command_options)
     _check_call(cmd)
 
     if builder == Builder.DOCKER_BUILD and push:
@@ -592,18 +615,19 @@ def build_images(
 
         # build image and optionally push image
         if force_build or _image_needs_building(image_spec, platforms):
+            expansion_namespace = {
+                "LAST_COMMIT": _get_latest_commit_tagged_or_modifying_paths(
+                    *all_image_paths, echo=False
+                ),
+                "TAG": image_tag,
+            }
             build_image(
                 image_spec,
                 _get_image_build_context_path(name, options),
                 dockerfile_path=_get_image_dockerfile_path(name, options),
-                build_args=_get_image_build_args(
-                    options,
-                    {
-                        "LAST_COMMIT": _get_latest_commit_tagged_or_modifying_paths(
-                            *all_image_paths, echo=False
-                        ),
-                        "TAG": image_tag,
-                    },
+                build_args=_get_image_build_args(options, expansion_namespace),
+                extra_build_command_options=_get_image_extra_build_command_options(
+                    options, expansion_namespace
                 ),
                 push=push or force_push,
                 builder=builder,

tests/test_commands.py

@@ -53,6 +53,63 @@ def test_build_image(mock_check_call, with_args):
         )
 
 
+@pytest.mark.parametrize("with_opts", [False, True])
+def test_build_image_with_options(git_repo, mock_check_call, with_opts):
+    image_spec = "index.docker.io/library/ubuntu:latest"
+    context_path = "dir"
+    dockerfile_path = None
+    build_args = None
+    extra_build_command_options = None
+
+    if with_opts:
+        dockerfile_path = "Dockerfile.custom"
+        extra_build_command_options = [
+            "--label=maintainer=octocat",
+            "--label",
+            "ref=tag-sha",
+            "--rm",
+        ]
+
+    chartpress.build_image(
+        image_spec,
+        context_path,
+        dockerfile_path,
+        build_args,
+        extra_build_command_options,
+    )
+
+    assert len(mock_check_call.commands) == 1
+    if with_opts:
+        sha = git_repo.commit(git_repo.head).hexsha
+        assert mock_check_call.commands[0] == (
+            [
+                "docker",
+                "build",
+                "-t",
+                image_spec,
+                context_path,
+                "-f",
+                "Dockerfile.custom",
+                "--label=maintainer=octocat",
+                "--label",
+                "ref=tag-sha",
+                "--rm",
+            ],
+            {},
+        )
+    else:
+        assert mock_check_call.commands[0] == (
+            [
+                "docker",
+                "build",
+                "-t",
+                image_spec,
+                context_path,
+            ],
+            {},
+        )
+
+
 @pytest.mark.parametrize("push", [False, True])
 @pytest.mark.parametrize("tag", [None, "1.2.3"])
 def test_build_images(git_repo, mock_check_call, push, tag):

tests/test_helm_chart/chartpress.yaml

@@ -13,6 +13,11 @@ charts:
         buildArgs:
           TEST_STATIC_BUILD_ARG: "test"
           TEST_DYNAMIC_BUILD_ARG: "{TAG}-{LAST_COMMIT}"
+        extraBuildCommandOptions:
+          - --label=maintainer=octocat
+          - --label
+          - ref={TAG}-{LAST_COMMIT}
+          - --rm
         contextPath: image
         dockerfilePath: image/Dockerfile
         valuesPath:

tests/test_helpers.py

@@ -5,6 +5,7 @@
 from chartpress import _get_git_remote_url
 from chartpress import _get_identifier_from_parts
 from chartpress import _get_image_build_args
+from chartpress import _get_image_extra_build_command_options
 from chartpress import _get_latest_commit_tagged_or_modifying_paths
 from chartpress import _image_needs_pushing
 from chartpress import Builder
@@ -156,3 +157,25 @@ def test__get_image_build_args(git_repo):
                 }
             else:
                 assert build_args == {}
+
+
+def test__get_image_extra_build_command_options(git_repo):
+    with open("chartpress.yaml") as f:
+        config = yaml.load(f)
+    for chart in config["charts"]:
+        for name, options in chart["images"].items():
+            extra_build_command_options = _get_image_extra_build_command_options(
+                options,
+                {
+                    "LAST_COMMIT": "sha",
+                    "TAG": "tag",
+                },
+            )
+            assert name in ("testimage", "amd64only")
+            if name == "testimage":
+                assert extra_build_command_options == [
+                    "--label=maintainer=octocat",
+                    "--label",
+                    "ref=tag-sha",
+                    "--rm",
+                ]