Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate the Docker context tags version from <stage>.tag to tags.<stage>. #14376

Merged
merged 3 commits into from
Feb 8, 2022
Merged

Migrate the Docker context tags version from <stage>.tag to tags.<stage>. #14376

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
40b1d87
Migrate the Docker context tags version from `<stage>.tag` to `tags.<…
kaos Feb 5, 2022
380e632
propagate source of deprecated use.
kaos Feb 8, 2022
5eb8f65
Merge branch 'main' into docker_version_tags_interpolation_context
kaos Feb 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/python/pants/backend/docker/goals/package_image_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ def test_build_docker_image(rule_runner: RuleRunner) -> None:
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, directory, name, pants, parent_directory\."
r"Try with one of: build_args, directory, name, pants, parent_directory, tags\."
)
with pytest.raises(DockerRepositoryNameError, match=err1):
assert_build(
Expand Down
24 changes: 22 additions & 2 deletions src/python/pants/backend/docker/util_rules/docker_build_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
)
from pants.backend.docker.utils import get_hash, suggest_renames
from pants.backend.docker.value_interpolation import (
DeprecatedDockerInterpolationValue,
DockerBuildArgsInterpolationValue,
DockerInterpolationContext,
DockerInterpolationValue,
Expand Down Expand Up @@ -50,6 +51,14 @@
logger = logging.getLogger(__name__)


class DockerfileImageTagsDeprecation(DeprecatedDockerInterpolationValue):
_removal_version = "2.11.0.dev0"
_hint = (
"The `<stage>.tag` version values are deprecated in favour of `tags.<stage>`.\n\n"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to Save A Click and give an example:

For example, rather than using {baseimage.tag} in your Docker template, use {tags.baseimage}.

But then still link to this PR like you do if people still aren't understanding.

"See https://github.com/pantsbuild/pants/issues/14023 for more details."
)


class DockerBuildContextError(Exception):
pass

Expand Down Expand Up @@ -118,11 +127,19 @@ def create(
# Go over all FROM tags and names for all stages.
stage_names: set[str] = set()
stage_tags = (tag.split(maxsplit=1) for tag in dockerfile_info.version_tags)
tags_values: dict[str, str] = {}
for idx, (stage, tag) in enumerate(stage_tags):
if stage != f"stage{idx}":
stage_names.add(stage)
value = {"tag": tag}
if not interpolation_context:
if idx == 0:
# Expose the first (stage0) FROM directive as the "baseimage".
tags_values["baseimage"] = tag
tags_values[stage] = tag

# The remaining part of this for loop is deprecated.
# TODO: remove in 2.11.0.dev0
value = DockerfileImageTagsDeprecation({"tag": tag})
if idx == 0:
# Expose the first (stage0) FROM directive as the "baseimage".
interpolation_context["baseimage"] = value
interpolation_context[stage] = value
Expand Down Expand Up @@ -172,6 +189,9 @@ def create(
"hash": get_hash((build_args, build_env, snapshot.digest)).hexdigest(),
}

# Base image tags values for all stages (as parsed from the Dockerfile instructions).
interpolation_context["tags"] = tags_values

return cls(
build_args=build_args,
digest=snapshot.digest,
Expand Down
59 changes: 43 additions & 16 deletions src/python/pants/backend/docker/util_rules/docker_build_context_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
from pants.backend.docker.util_rules.docker_build_context import (
DockerBuildContext,
DockerBuildContextRequest,
DockerfileImageTagsDeprecation,
)
from pants.backend.docker.util_rules.docker_build_env import DockerBuildEnvironment
from pants.backend.docker.value_interpolation import (
Expand Down Expand Up @@ -140,8 +141,12 @@ def test_pants_hash(rule_runner: RuleRunner) -> None:
Address("test"),
expected_files=["test/Dockerfile"],
expected_interpolation_context={
"baseimage": {"tag": "latest"},
"stage0": {"tag": "latest"},
"tags": {
"baseimage": "latest",
"stage0": "latest",
},
"baseimage": DockerfileImageTagsDeprecation({"tag": "latest"}),
"stage0": DockerfileImageTagsDeprecation({"tag": "latest"}),
"build_args": {},
"pants": {"hash": "fd19488a9b08a0184432762cab85f1370904d09bafd9df1a2f8a94614b2b7eb6"},
},
Expand Down Expand Up @@ -238,8 +243,12 @@ def test_from_image_build_arg_dependency(rule_runner: RuleRunner) -> None:
expected_files=["src/downstream/Dockerfile"],
build_upstream_images=True,
expected_interpolation_context={
"baseimage": {"tag": "latest"},
"stage0": {"tag": "latest"},
"tags": {
"baseimage": "latest",
"stage0": "latest",
},
"baseimage": DockerfileImageTagsDeprecation({"tag": "latest"}),
"stage0": DockerfileImageTagsDeprecation({"tag": "latest"}),
"build_args": {
"BASE_IMAGE": "upstream/image:latest",
},
Expand Down Expand Up @@ -319,11 +328,18 @@ def test_interpolation_context_from_dockerfile(rule_runner: RuleRunner) -> None:
Address("src/docker"),
expected_files=["src/docker/Dockerfile"],
expected_interpolation_context={
"baseimage": {"tag": "3.8"},
"stage0": {"tag": "3.8"},
"interim": {"tag": "latest"},
"stage2": {"tag": "latest"},
"output": {"tag": "1-1"},
"tags": {
"baseimage": "3.8",
"stage0": "3.8",
"interim": "latest",
"stage2": "latest",
"output": "1-1",
},
"baseimage": DockerfileImageTagsDeprecation({"tag": "3.8"}),
"stage0": DockerfileImageTagsDeprecation({"tag": "3.8"}),
"interim": DockerfileImageTagsDeprecation({"tag": "latest"}),
"stage2": DockerfileImageTagsDeprecation({"tag": "latest"}),
"output": DockerfileImageTagsDeprecation({"tag": "1-1"}),
"build_args": {},
},
)
Expand Down Expand Up @@ -352,11 +368,18 @@ def test_synthetic_dockerfile(rule_runner: RuleRunner) -> None:
Address("src/docker"),
expected_files=["src/docker/Dockerfile.docker"],
expected_interpolation_context={
"baseimage": {"tag": "3.8"},
"stage0": {"tag": "3.8"},
"interim": {"tag": "latest"},
"stage2": {"tag": "latest"},
"output": {"tag": "1-1"},
"tags": {
"baseimage": "3.8",
"stage0": "3.8",
"interim": "latest",
"stage2": "latest",
"output": "1-1",
},
"baseimage": DockerfileImageTagsDeprecation({"tag": "3.8"}),
"stage0": DockerfileImageTagsDeprecation({"tag": "3.8"}),
"interim": DockerfileImageTagsDeprecation({"tag": "latest"}),
"stage2": DockerfileImageTagsDeprecation({"tag": "latest"}),
"output": DockerfileImageTagsDeprecation({"tag": "1-1"}),
"build_args": {},
},
)
Expand Down Expand Up @@ -428,8 +451,12 @@ def test_build_arg_defaults_from_dockerfile(rule_runner: RuleRunner) -> None:
},
expected_files=["src/docker/Dockerfile"],
expected_interpolation_context={
"baseimage": {"tag": "${base_version}"},
"stage0": {"tag": "${base_version}"},
"tags": {
"baseimage": "${base_version}",
"stage0": "${base_version}",
},
"baseimage": DockerfileImageTagsDeprecation({"tag": "${base_version}"}),
"stage0": DockerfileImageTagsDeprecation({"tag": "${base_version}"}),
"build_args": {
# `base_name` is not listed here, as it was not an explicitly defined build arg.
"base_version": "3.9",
Expand Down
14 changes: 14 additions & 0 deletions src/python/pants/backend/docker/value_interpolation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from dataclasses import dataclass
from typing import ClassVar, Mapping, TypeVar, Union

from pants.base.deprecated import warn_or_error
from pants.engine.addresses import Address
from pants.util.frozendict import FrozenDict

Expand Down Expand Up @@ -36,6 +37,19 @@ def __getattr__(self, attribute: str) -> str:
return self[attribute]


class DeprecatedDockerInterpolationValue(DockerInterpolationValue):
_removal_version: ClassVar[str]
_hint: ClassVar[str | None]

def __getattr__(self, attribute: str) -> str:
warn_or_error(
self._removal_version,
f"Docker interpolation context type {type(self).__name__!r}",
self._hint,
)
return super().__getattr__(attribute)


class DockerBuildArgInterpolationError(DockerInterpolationError):
@classmethod
def attribute_error(
Expand Down