Docker: Add full_directory interpolation value for repository configuration. (#20530)

Add the BUILD file full path, as a variable to the docker backend
configuration.

---------

Co-authored-by: Andreas Stenius <[email protected]>
Co-authored-by: Ramon Buckland <[email protected]>

Author: 3 people

docs/docs/docker/tagging-docker-images.mdx

@@ -130,9 +130,10 @@ docker_image(
 
 The default placeholders are:
 
-- `{directory}`: The directory the docker_image's BUILD file is in.
-- `{parent_directory}`: The parent directory of `{directory}`.
-- `{name}`: The name of the docker_image target.
+- `{name}`: The name of the `docker_image` target.
+- `{directory}`: The folder name of the docker_image's BUILD file.
+- `{parent_directory}`: The parent folder name of `{directory}`.
+- `{full_directory}`: The full path to the BUILD file.
 - `{build_args.ARG_NAME}`: Each defined Docker build arg is available for interpolation under the `build_args.` prefix.
 - `{default_repository}`: The default repository from configuration.
 - `{target_repository}`: The repository on the `docker_image` if provided, otherwise the default repository.

src/python/pants/backend/docker/goals/package_image.py

@@ -94,8 +94,9 @@ def format_repository(
     ) -> str:
         repository_context = InterpolationContext.from_dict(
             {
-                "directory": os.path.basename(self.address.spec_path),
                 "name": self.address.target_name,
+                "directory": os.path.basename(self.address.spec_path),
+                "full_directory": self.address.spec_path,
                 "parent_directory": os.path.basename(os.path.dirname(self.address.spec_path)),
                 "default_repository": default_repository,
                 "target_repository": self.repository.value or default_repository,

src/python/pants/backend/docker/goals/package_image_test.py

@@ -272,6 +272,11 @@ def test_build_docker_image(rule_runner: RuleRunner) -> None:
                   name="test5",
                   image_tags=["latest", "alpha-1.0", "alpha-1"],
                 )
+                docker_image(
+                  name="test6",
+                  image_tags=["1.2.3"],
+                  repository="xyz/{full_directory}/{name}",
+                )
                 docker_image(
                   name="err1",
                   repository="{bad_template}",
@@ -365,12 +370,17 @@ def test_build_docker_image(rule_runner: RuleRunner) -> None:
             )
         ],
     )
+    assert_build(
+        rule_runner,
+        Address("docker/test", target_name="test6"),
+        "Built docker image: xyz/docker/test/test6:1.2.3",
+    )
 
     err1 = (
         r"Invalid value for the `repository` field of the `docker_image` target at "
         r"docker/test:err1: '{bad_template}'\.\n\nThe placeholder 'bad_template' is unknown\. "
-        r"Try with one of: build_args, default_repository, directory, name, pants, "
-        r"parent_directory, tags, target_repository\."
+        r"Try with one of: build_args, default_repository, directory, full_directory, name, "
+        r"pants, parent_directory, tags, target_repository\."
     )
     with pytest.raises(DockerRepositoryNameError, match=err1):
         assert_build(

src/python/pants/backend/docker/subsystems/docker_options.py

@@ -108,13 +108,14 @@ def env_vars(self) -> tuple[str, ...]:
             The value is formatted and may reference these variables (in addition to the normal
             placeholders derived from the Dockerfile and build args etc):
 
-            {bullet_list(["name", "directory", "parent_directory", "target_repository"])}
+            {bullet_list(["name", "directory", "parent_directory", "full_directory", "target_repository"])}
 
             Example: `--default-repository="{{directory}}/{{name}}"`.
 
-            The `name` variable is the `docker_image`'s target name, `directory` and
-            `parent_directory` are the name of the directory in which the BUILD file is for the
-            target, and its parent directory respectively.
+            The `name` variable is the `docker_image`'s target name.
+
+            With the directory variables available, given a sample repository path of `baz/foo/bar/BUILD`,
+            then `directory` is `bar`, `parent_directory` is `foo` and `full_directory` will be `baz/foo/bar`.
 
             Use the `repository` field to set this value directly on a `docker_image` target.