21729560526

Committed 05 Feb 2026 09:41PM UTC coverage: 80.349% (+0.07%) from 80.284%

Build # 21729560526

Build Type

Pull #23074

github

Committed by

web-flow

Commit Message

Merge adbbdcb01 into 8fa758091

Pull Request Pull Request #23074: Skip Preemptive Docker

Run Details

349 of 350 new or added lines in 5 files covered. (99.71%)

1 existing line in 1 file now uncovered.

78742 of 98000 relevant lines covered (80.35%)

3.36 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.74

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

# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from __future__ import annotations

import logging
from collections import defaultdict
from dataclasses import dataclass
from itertools import chain
from typing import DefaultDict, cast

from pants.backend.docker.goals.package_image import (
    DockerPackageFieldSet,
    GetImageRefsRequest,
    get_docker_image_build_process,
    get_image_refs,
)
from pants.backend.docker.package_types import BuiltDockerImage
from pants.backend.docker.registries import DockerRegistryOptions
from pants.backend.docker.subsystems.docker_options import DockerOptions
from pants.backend.docker.target_types import DockerImageRegistriesField, DockerImageSkipPushField
from pants.backend.docker.util_rules.docker_binary import DockerBinary
from pants.core.goals.package import PackageFieldSet
from pants.core.goals.publish import (
    CheckSkipRequest,
    CheckSkipResult,
    PublishFieldSet,
    PublishOutputData,
    PublishPackages,
    PublishProcesses,
    PublishRequest,
)
from pants.core.util_rules.env_vars import environment_vars_subset
from pants.engine.env_vars import EnvironmentVarsRequest
from pants.engine.process import InteractiveProcess, Process
from pants.engine.rules import collect_rules, implicitly, rule
from pants.engine.unions import UnionRule

logger = logging.getLogger(__name__)


class PublishDockerImageRequest(PublishRequest):
    pass


@dataclass(frozen=True)
class PublishDockerImageFieldSet(PublishFieldSet, DockerPackageFieldSet):
    publish_request_type = PublishDockerImageRequest
    required_fields = (  # type: ignore[assignment]
        *DockerPackageFieldSet.required_fields,
        DockerImageRegistriesField,
    )

    skip_push: DockerImageSkipPushField

    def make_skip_request(
        self, package_fs: PackageFieldSet
    ) -> PublishDockerImageSkipRequest | None:
        return (
            PublishDockerImageSkipRequest(publish_fs=self, package_fs=package_fs)
            if isinstance(package_fs, DockerPackageFieldSet)
            else None
        )

    def get_output_data(self) -> PublishOutputData:
        return PublishOutputData(
            {
                "publisher": "docker",
                "registries": self.registries.value or (),
                **super().get_output_data(),
            }
        )


class PublishDockerImageSkipRequest(CheckSkipRequest[PublishDockerImageFieldSet]):
    package_fs: DockerPackageFieldSet


@rule
async def check_if_skip_push(
    request: PublishDockerImageSkipRequest, options: DockerOptions
) -> CheckSkipResult:
    skip_registries = {
        registry for registry in options.registries().registries.values() if registry.skip_push
    }
    if skip_registries or request.publish_fs.skip_push.value:
        image_refs = await get_image_refs(
            GetImageRefsRequest(field_set=request.package_fs, build_upstream_images=False),
            **implicitly(),
        )
        if request.publish_fs.skip_push.value:
            return CheckSkipResult.skip(
                names=[tag.full_name for registry in image_refs for tag in registry.tags],
                description=f"(by `{request.publish_fs.skip_push.alias}` on {request.address})",
                data=request.publish_fs.get_output_data(),
            )
        if all(image_ref.registry in skip_registries for image_ref in image_refs):
            output_data = request.publish_fs.get_output_data()
            return CheckSkipResult(
                PublishPackages(
                    names=tuple(tag.full_name for tag in image_ref.tags),
                    description=f"(by skip_push on @{cast(DockerRegistryOptions, image_ref.registry).alias})",
                    data=output_data,
                )
                for image_ref in image_refs
            )
    return (
        CheckSkipResult.skip(skip_packaging_only=True)
        if request.package_fs.pushes_on_package()
        else CheckSkipResult.no_skip()
    )


@rule
async def push_docker_images(
    request: PublishDockerImageRequest,
    docker: DockerBinary,
    options: DockerOptions,
    options_env_aware: DockerOptions.EnvironmentAware,
) -> PublishProcesses:
    if cast(DockerPackageFieldSet, request.field_set).pushes_on_package():
        build_process = await get_docker_image_build_process(request.field_set, **implicitly())
        return PublishProcesses(
            [
                PublishPackages(
                    names=build_process.tags,
                    process=build_process.process
                    if options.publish_noninteractively
                    else InteractiveProcess.from_process(build_process.process),
                )
            ]
        )

    tags = tuple(
        chain.from_iterable(
            cast(BuiltDockerImage, image).tags
            for pkg in request.packages
            for image in pkg.artifacts
        )
    )

    env = await environment_vars_subset(
        EnvironmentVarsRequest(options_env_aware.env_vars), **implicitly()
    )
    skip_push_reasons: DefaultDict[str, DefaultDict[str, set[str]]] = defaultdict(
        lambda: defaultdict(set)
    )
    jobs: list[PublishPackages] = []
    refs: list[str] = []
    processes: list[Process | InteractiveProcess] = []

    for tag in tags:
        for registry in options.registries().registries.values():
            if registry.skip_push and tag.startswith(f"{registry.address}/"):
                skip_push_reasons["skip_push"][registry.alias].add(tag)
                break
            if registry.use_local_alias and tag.startswith(f"{registry.alias}/"):
                skip_push_reasons["use_local_alias"][registry.alias].add(tag)
                break
        else:
            refs.append(tag)
            push_process = docker.push_image(tag, env)
            if options.publish_noninteractively:
                processes.append(push_process)
            else:
                processes.append(InteractiveProcess.from_process(push_process))

    for ref, process in zip(refs, processes):
        jobs.append(
            PublishPackages(
                names=(ref,),
                process=process,
            )
        )

    for reason, skip_push in skip_push_reasons.items():
        for name, skip_tags in skip_push.items():
            jobs.append(
                PublishPackages(
                    names=tuple(skip_tags),
                    description=f"(by `{reason}` on registry @{name})",
                ),
            )

    return PublishProcesses(jobs)


def rules():
    return (
        *collect_rules(),
        *PublishDockerImageFieldSet.rules(),
        UnionRule(CheckSkipRequest, PublishDockerImageSkipRequest),
    )

1	# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	6✔
5
6	import logging	6✔
7	from collections import defaultdict	6✔
8	from dataclasses import dataclass	6✔
9	from itertools import chain	6✔
10	from typing import DefaultDict, cast	6✔
11
12	from pants.backend.docker.goals.package_image import (	6✔
13	DockerPackageFieldSet,
14	GetImageRefsRequest,
15	get_docker_image_build_process,
16	get_image_refs,
17	)
18	from pants.backend.docker.package_types import BuiltDockerImage	6✔
19	from pants.backend.docker.registries import DockerRegistryOptions	6✔
20	from pants.backend.docker.subsystems.docker_options import DockerOptions	6✔
21	from pants.backend.docker.target_types import DockerImageRegistriesField, DockerImageSkipPushField	6✔
22	from pants.backend.docker.util_rules.docker_binary import DockerBinary	6✔
23	from pants.core.goals.package import PackageFieldSet	6✔
24	from pants.core.goals.publish import (	6✔
25	CheckSkipRequest,
26	CheckSkipResult,
27	PublishFieldSet,
28	PublishOutputData,
29	PublishPackages,
30	PublishProcesses,
31	PublishRequest,
32	)
33	from pants.core.util_rules.env_vars import environment_vars_subset	6✔
34	from pants.engine.env_vars import EnvironmentVarsRequest	6✔
35	from pants.engine.process import InteractiveProcess, Process	6✔
36	from pants.engine.rules import collect_rules, implicitly, rule	6✔
37	from pants.engine.unions import UnionRule	6✔
38
39	logger = logging.getLogger(__name__)	6✔
40
41
42	class PublishDockerImageRequest(PublishRequest):	6✔
43	pass	6✔
44
45
46	@dataclass(frozen=True)	6✔
47	class PublishDockerImageFieldSet(PublishFieldSet, DockerPackageFieldSet):	6✔
48	publish_request_type = PublishDockerImageRequest	6✔
49	required_fields = ( # type: ignore[assignment]	6✔
50	*DockerPackageFieldSet.required_fields,
51	DockerImageRegistriesField,
52	)
53
54	skip_push: DockerImageSkipPushField	6✔
55
56	def make_skip_request(	6✔
57	self, package_fs: PackageFieldSet
58	) -> PublishDockerImageSkipRequest \| None:
NEW 59	return (	×
60	PublishDockerImageSkipRequest(publish_fs=self, package_fs=package_fs)
61	if isinstance(package_fs, DockerPackageFieldSet)
62	else None
63	)
64
65	def get_output_data(self) -> PublishOutputData:	6✔
66	return PublishOutputData(	1✔
67	{
68	"publisher": "docker",
69	"registries": self.registries.value or (),
70	**super().get_output_data(),
71	}
72	)
73
74
75	class PublishDockerImageSkipRequest(CheckSkipRequest[PublishDockerImageFieldSet]):	6✔
76	package_fs: DockerPackageFieldSet	6✔
77
78
79	@rule	6✔
80	async def check_if_skip_push(	6✔
81	request: PublishDockerImageSkipRequest, options: DockerOptions
82	) -> CheckSkipResult:
83	skip_registries = {	1✔
84	registry for registry in options.registries().registries.values() if registry.skip_push
85	}
86	if skip_registries or request.publish_fs.skip_push.value:	1✔
87	image_refs = await get_image_refs(	1✔
88	GetImageRefsRequest(field_set=request.package_fs, build_upstream_images=False),
89	**implicitly(),
90	)
91	if request.publish_fs.skip_push.value:	1✔
92	return CheckSkipResult.skip(	1✔
93	names=[tag.full_name for registry in image_refs for tag in registry.tags],
94	description=f"(by `{request.publish_fs.skip_push.alias}` on {request.address})",
95	data=request.publish_fs.get_output_data(),
96	)
97	if all(image_ref.registry in skip_registries for image_ref in image_refs):	1✔
98	output_data = request.publish_fs.get_output_data()	1✔
99	return CheckSkipResult(	1✔
100	PublishPackages(
101	names=tuple(tag.full_name for tag in image_ref.tags),
102	description=f"(by skip_push on @{cast(DockerRegistryOptions, image_ref.registry).alias})",
103	data=output_data,
104	)
105	for image_ref in image_refs
106	)
107	return (	1✔
108	CheckSkipResult.skip(skip_packaging_only=True)
109	if request.package_fs.pushes_on_package()
110	else CheckSkipResult.no_skip()
111	)
112
113
114	@rule	6✔
115	async def push_docker_images(	6✔
116	request: PublishDockerImageRequest,
117	docker: DockerBinary,
118	options: DockerOptions,
119	options_env_aware: DockerOptions.EnvironmentAware,
120	) -> PublishProcesses:
121	if cast(DockerPackageFieldSet, request.field_set).pushes_on_package():	1✔
122	build_process = await get_docker_image_build_process(request.field_set, **implicitly())	1✔
123	return PublishProcesses(	1✔
124	[
125	PublishPackages(
126	names=build_process.tags,
127	process=build_process.process
128	if options.publish_noninteractively
129	else InteractiveProcess.from_process(build_process.process),
130	)
131	]
132	)
133
134	tags = tuple(	1✔
135	chain.from_iterable(
136	cast(BuiltDockerImage, image).tags
137	for pkg in request.packages
138	for image in pkg.artifacts
139	)
140	)
141
142	env = await environment_vars_subset(	1✔
143	EnvironmentVarsRequest(options_env_aware.env_vars), **implicitly()
144	)
145	skip_push_reasons: DefaultDict[str, DefaultDict[str, set[str]]] = defaultdict(	1✔
146	lambda: defaultdict(set)
147	)
148	jobs: list[PublishPackages] = []	1✔
149	refs: list[str] = []	1✔
150	processes: list[Process \| InteractiveProcess] = []	1✔
151
152	for tag in tags:	1✔
153	for registry in options.registries().registries.values():	1✔
154	if registry.skip_push and tag.startswith(f"{registry.address}/"):	1✔
155	skip_push_reasons["skip_push"][registry.alias].add(tag)	1✔
156	break	1✔
157	if registry.use_local_alias and tag.startswith(f"{registry.alias}/"):	1✔
158	skip_push_reasons["use_local_alias"][registry.alias].add(tag)	×
159	break	×
160	else:
161	refs.append(tag)	1✔
162	push_process = docker.push_image(tag, env)	1✔
163	if options.publish_noninteractively:	1✔
164	processes.append(push_process)	×
165	else:
166	processes.append(InteractiveProcess.from_process(push_process))	1✔
167
168	for ref, process in zip(refs, processes):	1✔
169	jobs.append(	1✔
170	PublishPackages(
171	names=(ref,),
172	process=process,
173	)
174	)
175
176	for reason, skip_push in skip_push_reasons.items():	1✔
177	for name, skip_tags in skip_push.items():	1✔
178	jobs.append(	1✔
179	PublishPackages(
180	names=tuple(skip_tags),
181	description=f"(by `{reason}` on registry @{name})",
182	),
183	)
184
185	return PublishProcesses(jobs)	1✔
186
187
188	def rules():	6✔
189	return (	5✔
190	*collect_rules(),
191	*PublishDockerImageFieldSet.rules(),
192	UnionRule(CheckSkipRequest, PublishDockerImageSkipRequest),
193	)

pantsbuild / pants / 21729560526

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous