20328535594

Committed 18 Dec 2025 06:46AM UTC coverage: 57.969% (-22.3%) from 80.295%

Build # 20328535594

Build Type

Pull #22954

github

Committed by

web-flow

Commit Message

Merge ccc9c5409 into 407284c67

Pull Request Pull Request #22954: free up disk space in runner image

Run Details

39083 of 67421 relevant lines covered (57.97%)

0.91 hits per line

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

0.0

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

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

from __future__ import annotations

from dataclasses import dataclass, replace
from typing import cast

from pants.backend.docker.goals.package_image import BuiltDockerImage, DockerPackageFieldSet
from pants.backend.docker.subsystems.docker_options import DockerOptions
from pants.backend.docker.target_types import (
    DockerImageRegistriesField,
    DockerImageRunExtraArgsField,
    DockerImageSourceField,
)
from pants.backend.docker.util_rules.docker_binary import DockerBinary
from pants.core.goals.package import PackageFieldSet, build_package
from pants.core.goals.run import RunFieldSet, RunInSandboxBehavior, RunRequest
from pants.core.util_rules.env_vars import environment_vars_subset
from pants.engine.env_vars import EnvironmentVarsRequest
from pants.engine.internals.graph import resolve_target
from pants.engine.rules import collect_rules, concurrently, implicitly, rule
from pants.engine.target import WrappedTargetRequest


@dataclass(frozen=True)
class DockerRunFieldSet(RunFieldSet):
    required_fields = (DockerImageSourceField,)
    run_in_sandbox_behavior = RunInSandboxBehavior.RUN_REQUEST_HERMETIC

    extra_run_args: DockerImageRunExtraArgsField

    def get_run_args(self, options: DockerOptions) -> tuple[str, ...]:
        return tuple(options.run_args + (self.extra_run_args.value or ()))


@rule
async def docker_image_run_request(
    field_set: DockerRunFieldSet,
    docker: DockerBinary,
    options: DockerOptions,
    options_env_aware: DockerOptions.EnvironmentAware,
) -> RunRequest:
    wrapped_target = await resolve_target(
        WrappedTargetRequest(field_set.address, description_of_origin="<infallible>"),
        **implicitly(),
    )
    build_request = DockerPackageFieldSet.create(wrapped_target.target)
    registries = options.registries()
    for registry in registries.get(*(build_request.registries.value or [])):
        if registry.use_local_alias:
            # We only need to tag a single image name for run requests if there is a registry with
            # `use_local_alias` as true.
            build_request = replace(
                build_request,
                registries=DockerImageRegistriesField((registry.alias,), field_set.address),
            )
            break
    env, image = await concurrently(
        environment_vars_subset(EnvironmentVarsRequest(options_env_aware.env_vars), **implicitly()),
        build_package(**implicitly({build_request: PackageFieldSet})),
    )

    tag = cast(BuiltDockerImage, image.artifacts[0]).tags[0]
    run = docker.run_image(
        tag,
        docker_run_args=field_set.get_run_args(options),
        env=env,
    )

    return RunRequest(
        digest=image.digest,
        args=run.argv,
        extra_env=run.env,
        immutable_input_digests=run.immutable_input_digests,
    )


def rules():
    return [
        *collect_rules(),
        *DockerRunFieldSet.rules(),
    ]

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	×
5
6	from dataclasses import dataclass, replace	×
7	from typing import cast	×
8
9	from pants.backend.docker.goals.package_image import BuiltDockerImage, DockerPackageFieldSet	×
10	from pants.backend.docker.subsystems.docker_options import DockerOptions	×
11	from pants.backend.docker.target_types import (	×
12	DockerImageRegistriesField,
13	DockerImageRunExtraArgsField,
14	DockerImageSourceField,
15	)
16	from pants.backend.docker.util_rules.docker_binary import DockerBinary	×
17	from pants.core.goals.package import PackageFieldSet, build_package	×
18	from pants.core.goals.run import RunFieldSet, RunInSandboxBehavior, RunRequest	×
19	from pants.core.util_rules.env_vars import environment_vars_subset	×
20	from pants.engine.env_vars import EnvironmentVarsRequest	×
21	from pants.engine.internals.graph import resolve_target	×
22	from pants.engine.rules import collect_rules, concurrently, implicitly, rule	×
23	from pants.engine.target import WrappedTargetRequest	×
24
25
26	@dataclass(frozen=True)	×
27	class DockerRunFieldSet(RunFieldSet):	×
28	required_fields = (DockerImageSourceField,)	×
29	run_in_sandbox_behavior = RunInSandboxBehavior.RUN_REQUEST_HERMETIC	×
30
31	extra_run_args: DockerImageRunExtraArgsField	×
32
33	def get_run_args(self, options: DockerOptions) -> tuple[str, ...]:	×
34	return tuple(options.run_args + (self.extra_run_args.value or ()))	×
35
36
37	@rule	×
38	async def docker_image_run_request(	×
39	field_set: DockerRunFieldSet,
40	docker: DockerBinary,
41	options: DockerOptions,
42	options_env_aware: DockerOptions.EnvironmentAware,
43	) -> RunRequest:
44	wrapped_target = await resolve_target(	×
45	WrappedTargetRequest(field_set.address, description_of_origin="<infallible>"),
46	**implicitly(),
47	)
48	build_request = DockerPackageFieldSet.create(wrapped_target.target)	×
49	registries = options.registries()	×
50	for registry in registries.get(*(build_request.registries.value or [])):	×
51	if registry.use_local_alias:	×
52	# We only need to tag a single image name for run requests if there is a registry with
53	# `use_local_alias` as true.
54	build_request = replace(	×
55	build_request,
56	registries=DockerImageRegistriesField((registry.alias,), field_set.address),
57	)
58	break	×
59	env, image = await concurrently(	×
60	environment_vars_subset(EnvironmentVarsRequest(options_env_aware.env_vars), **implicitly()),
61	build_package(**implicitly({build_request: PackageFieldSet})),
62	)
63
64	tag = cast(BuiltDockerImage, image.artifacts[0]).tags[0]	×
65	run = docker.run_image(	×
66	tag,
67	docker_run_args=field_set.get_run_args(options),
68	env=env,
69	)
70
71	return RunRequest(	×
72	digest=image.digest,
73	args=run.argv,
74	extra_env=run.env,
75	immutable_input_digests=run.immutable_input_digests,
76	)
77
78
79	def rules():	×
80	return [	×
81	*collect_rules(),
82	*DockerRunFieldSet.rules(),
83	]

pantsbuild / pants / 20328535594

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