Add support for --metadata-file option with buildx bake (#693)

Closes #504

Author: ianpittwood

python_on_whales/components/buildx/cli_wrapper.py

@@ -135,6 +135,7 @@ def bake(
         push: bool = False,
         set: Dict[str, str] = {},
         variables: Dict[str, str] = {},
+        metadata_file: Optional[ValidPath] = None,
         stream_logs: bool = False,
         remote_definition: Union[str, None] = None,
     ) -> Union[Dict[str, Dict[str, Dict[str, Any]]], Iterator[str]]:
@@ -159,6 +160,7 @@ def bake(
             set: A list of overrides in the form `"targetpattern.key=value"`.
             variables: A dict containing the values of the variables defined in the
                 hcl file. See <https://github.com/docker/buildx#hcl-variables-and-functions>
+            metadata_file: Write build results metadata to the given file
             remote_definition: Remote context in which to find bake files
 
         # Returns
@@ -211,6 +213,8 @@ def bake(
         full_cmd.add_args_iterable_or_single("--set", format_mapping_for_cli(set))
         if remote_definition is not None:
             full_cmd.append(remote_definition)
+        if metadata_file is not None:
+            full_cmd.add_simple_arg("--metadata-file", metadata_file)
         targets = to_list(targets)
         env = dict(variables)
         if print:

tests/python_on_whales/components/buildx/test_buildx_cli_wrapper.py

@@ -705,6 +705,109 @@ def test_bake_stream_logs(monkeypatch):
     assert output[-1].startswith("#")
 
 
+@pytest.mark.usefixtures("with_docker_driver")
+@pytest.mark.usefixtures("change_cwd")
+@pytest.mark.parametrize("only_print", [True, False])
+def test_bake_metadata_file_output(only_print, tmp_path):
+    metadata_path = tmp_path / "metadata.json"
+
+    config = docker.buildx.bake(
+        files=[bake_file], metadata_file=metadata_path, print=only_print
+    )
+    assert config == {
+        "group": {"default": {"targets": ["my_out1", "my_out2"]}},
+        "target": {
+            "my_out1": {
+                "context": ".",
+                "dockerfile": "Dockerfile",
+                "tags": ["pretty_image1:1.0.0"],
+                "target": "out1",
+            },
+            "my_out2": {
+                "context": ".",
+                "dockerfile": "Dockerfile",
+                "tags": ["pretty_image2:1.0.0"],
+                "target": "out2",
+            },
+        },
+    }
+    if not only_print:
+        assert metadata_path.is_file()
+        with open(metadata_path, "r") as f:
+            metadata = json.load(f)
+        assert len(metadata.keys()) == len(
+            config["target"]
+        )  # two target builds expected
+        for target_name, target_metadata in metadata.items():
+            assert target_name in config["target"]
+            assert (
+                "docker.io/library/{}".format(config["target"][target_name]["tags"][0])
+                in target_metadata["image.name"]
+            )
+
+
+@pytest.mark.usefixtures("with_docker_driver")
+@pytest.mark.usefixtures("change_cwd")
+@pytest.mark.parametrize("only_print", [True, False])
+def test_bake_metadata_file_option(only_print, monkeypatch, tmp_path):
+    recorded = {}
+
+    def fake_run(cmd, capture_stderr=True, env={}):
+        recorded["cmd"] = list(cmd)
+        return "{}"
+
+    monkeypatch.setattr(python_on_whales.components.buildx.cli_wrapper, "run", fake_run)
+
+    metadata_path = tmp_path / "metadata.json"
+
+    docker.buildx.bake(files=[bake_file], print=only_print, metadata_file=metadata_path)
+
+    cmd = recorded.get("cmd", [])
+    assert "--metadata-file" in cmd
+    assert metadata_path in cmd or str(metadata_path) in map(str, cmd)
+
+
+@pytest.mark.usefixtures("with_docker_driver")
+@pytest.mark.usefixtures("change_cwd")
+@pytest.mark.parametrize("only_print", [True, False])
+def test_bake_without_metadata_file_option(only_print, monkeypatch, tmp_path):
+    recorded = {}
+
+    def fake_run(cmd, capture_stderr=True, env={}):
+        recorded["cmd"] = list(cmd)
+        return "{}"
+
+    monkeypatch.setattr(python_on_whales.components.buildx.cli_wrapper, "run", fake_run)
+
+    docker.buildx.bake(files=[bake_file], print=only_print)
+
+    cmd = recorded.get("cmd", [])
+    assert "--metadata-file" not in cmd
+
+
+@pytest.mark.usefixtures("with_docker_driver")
+@pytest.mark.usefixtures("change_cwd")
+@pytest.mark.parametrize("only_print", [True, False])
+def test_bake_metadata_file_str_path_option(only_print, monkeypatch, tmp_path):
+    recorded = {}
+
+    def fake_run(cmd, capture_stderr=True, env={}):
+        recorded["cmd"] = list(cmd)
+        return "{}"
+
+    monkeypatch.setattr(python_on_whales.components.buildx.cli_wrapper, "run", fake_run)
+
+    metadata_path = tmp_path / "metadata.json"
+
+    docker.buildx.bake(
+        files=[bake_file], print=only_print, metadata_file=str(metadata_path)
+    )
+
+    cmd = recorded.get("cmd", [])
+    assert "--metadata-file" in cmd
+    assert metadata_path in cmd or str(metadata_path) in map(str, cmd)
+
+
 @pytest.mark.usefixtures("with_docker_driver")
 @pytest.mark.usefixtures("prune_all")
 def test_prune_all_empty():