Merge branch 'main' into sortable-versions

minrk · web-flow · commit b62dcc7815f9 · 2022-08-22T15:40:00.000+02:00
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-python@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: "3.9"
 
@@ -43,7 +43,7 @@ jobs:
           ls -alh dist
 
       - name: publish to pypi
-        uses: pypa/gh-action-pypi-publish@v1.5.0
+        uses: pypa/gh-action-pypi-publish@v1.5.1
         if: startsWith(github.ref, 'refs/tags/')
         with:
           user: __token__
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -49,9 +49,9 @@ jobs:
           # chartpress requires the full history
           fetch-depth: 0
 
-      # NOTE: actions/setup-python@v3 make use of a cache within the GitHub base
+      # NOTE: actions/setup-python@v4 make use of a cache within the GitHub base
       #       environment and setup in a fraction of a second.
-      - uses: actions/setup-python@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: "${{ matrix.python }}"
 
@@ -75,7 +75,7 @@ jobs:
 
       # https://github.com/docker/setup-buildx-action
       - name: Setup docker buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
         with:
           # Allows pushing to registry on localhost:5000
           driver-opts: network=host
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,28 +9,42 @@
 # - Register git hooks: pre-commit install --install-hooks
 #
 repos:
+  # Autoformat: Python code, syntax patterns are modernized
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.37.3
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py37-plus
+
   # Autoformat: Python code
   - repo: https://github.com/psf/black
-    rev: 22.1.0
+    rev: 22.6.0
     hooks:
       - id: black
-        args: [--target-version=py36]
+        args:
+          - --target-version=py37
+          - --target-version=py38
+          - --target-version=py39
+          - --target-version=py310
 
-  # Autoformat: markdown, yaml
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.5.1
+  # Autoformat: Python code
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
     hooks:
-      - id: prettier
+      - id: isort
+        args:
+          - --profile=black
 
-  # Autoformat: https://github.com/asottile/reorder_python_imports
-  - repo: https://github.com/asottile/reorder_python_imports
+  # Autoformat: markdown, yaml
+  - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v2.7.1
     hooks:
-      - id: reorder-python-imports
+      - id: prettier
 
   # Misc...
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.3.0
     # ref: https://github.com/pre-commit/pre-commit-hooks#hooks-available
     hooks:
       # Autoformat: Makes sure files end in a newline and only a newline.
@@ -48,6 +62,6 @@ repos:
 
   # Lint: Python code
   - repo: https://github.com/PyCQA/flake8
-    rev: "4.0.1"
+    rev: "5.0.4"
     hooks:
       - id: flake8
diff --git a/README.md b/README.md
@@ -206,6 +206,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
diff --git a/chartpress.py b/chartpress.py
@@ -13,8 +13,7 @@
 import sys
 from collections.abc import MutableMapping
 from enum import Enum
-from functools import lru_cache
-from functools import partial
+from functools import lru_cache, partial
 from tempfile import TemporaryDirectory
 
 import docker
@@ -246,6 +245,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
@@ -306,6 +322,7 @@ def build_image(
     context_path,
     dockerfile_path=None,
     build_args=None,
+    extra_build_command_options=None,
     *,
     push=False,
     builder=Builder.DOCKER_BUILD,
@@ -331,6 +348,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):
@@ -366,6 +386,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:
@@ -626,18 +648,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,
@@ -897,9 +920,11 @@ def publish_pages(
     if os.path.isfile(os.path.join(checkout_dir, "index.yaml")):
         with open(os.path.join(checkout_dir, "index.yaml")) as f:
             chart_repo_index = yaml.load(f)
-            published_charts = chart_repo_index["entries"].get(chart_name)
+            published_charts = chart_repo_index["entries"].get(chart_name, [])
 
-        if any(c["version"] == chart_version for c in published_charts):
+        if published_charts and any(
+            c["version"] == chart_version for c in published_charts
+        ):
             if force:
                 _log(
                     f"Chart of version {chart_version} already exists, overwriting it."
diff --git a/tests/test_chartpress.py b/tests/test_chartpress.py
@@ -1,9 +1,7 @@
 import json
 import sys
-from subprocess import PIPE
-from subprocess import run
-from urllib.request import Request
-from urllib.request import urlopen
+from subprocess import PIPE, run
+from urllib.request import Request, urlopen
 from uuid import uuid4
 
 import pytest
@@ -15,8 +13,7 @@ def test_list_images(git_repo):
     p = run(
         [sys.executable, "-m", "chartpress", "--list-images"],
         check=True,
-        stdout=PIPE,
-        stderr=PIPE,
+        capture_output=True,
     )
     stdout = p.stdout.decode("utf8").strip()
     # echo stdout/stderr for debugging
@@ -32,8 +29,7 @@ def test_list_images(git_repo):
     p = run(
         ["git", "status", "--porcelain"],
         check=True,
-        stdout=PIPE,
-        stderr=PIPE,
+        capture_output=True,
     )
     assert not p.stdout, "--list-images should not make changes!"
 
@@ -88,6 +84,7 @@ def test_buildx(git_repo, capfd):
             tag,
         ],
         check=True,
+        capture_output=True,
     )
     stdout, stderr = capfd.readouterr()
     # stdout = p.stdout.decode("utf8").strip()
diff --git a/tests/test_commands.py b/tests/test_commands.py
@@ -54,6 +54,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):
diff --git a/tests/test_helm_chart/chartpress.yaml b/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:
diff --git a/tests/test_helpers.py b/tests/test_helpers.py
@@ -1,15 +1,19 @@
 import pytest
 
-from chartpress import _check_call
-from chartpress import _fix_chart_version
-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_latest_commit_tagged_or_modifying_paths
-from chartpress import _image_needs_pushing
-from chartpress import GITHUB_ACTOR_KEY
-from chartpress import GITHUB_TOKEN_KEY
-from chartpress import yaml
+from chartpress import (
+    GITHUB_ACTOR_KEY,
+    GITHUB_TOKEN_KEY,
+    Builder,
+    yaml,
+    _check_call,
+    _fix_chart_version,
+    _get_git_remote_url,
+    _get_identifier_from_parts,
+    _get_image_build_args,
+    _get_image_extra_build_command_options,
+    _get_latest_commit_tagged_or_modifying_paths,
+    _image_needs_pushing,
+)
 
 
 @pytest.mark.parametrize(
@@ -131,3 +135,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",
+                ]
diff --git a/tests/test_repo_interactions.py b/tests/test_repo_interactions.py
