18791134616

Committed 24 Oct 2025 08:18PM UTC coverage: 75.519% (-4.8%) from 80.282%

Build # 18791134616

Build Type

Pull #22794

github

Committed by

web-flow

Commit Message

Merge 098c595a0 into 7971a20bf

Pull Request Pull Request #22794: Use self-hosted MacOS Intel runner

Run Details

65803 of 87134 relevant lines covered (75.52%)

3.07 hits per line

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

71.43

/src/python/pants/backend/docker/util_rules/docker_build_env.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.abc import Mapping
from dataclasses import dataclass

from pants.backend.docker.subsystems.docker_options import DockerOptions
from pants.backend.docker.util_rules.docker_build_args import (
    DockerBuildArgsRequest,
    docker_build_args,
)
from pants.backend.docker.utils import KeyValueSequenceUtil
from pants.core.util_rules.env_vars import environment_vars_subset
from pants.engine.env_vars import EnvironmentVars, EnvironmentVarsRequest
from pants.engine.rules import collect_rules, implicitly, rule
from pants.engine.target import Target

logger = logging.getLogger(__name__)


class DockerBuildEnvironmentError(ValueError):
    @classmethod
    def from_key_error(cls, e: KeyError) -> DockerBuildEnvironmentError:
        return cls(
            f"The Docker environment variable {e} is undefined. You may provide a value for "
            "this variable either in `[docker].env_vars` or in Pants's own environment."
        )


@dataclass(frozen=True)
class DockerBuildEnvironment:
    environment: EnvironmentVars

    @classmethod
    def create(
        cls,
        env: Mapping[str, str],
    ) -> DockerBuildEnvironment:
        return cls(EnvironmentVars(env))

    def __getitem__(self, key: str) -> str:
        try:
            return self.environment[key]
        except KeyError as e:
            raise DockerBuildEnvironmentError.from_key_error(e) from e

    def get(self, key: str, default: str | None = None) -> str:
        if default is None:
            return self[key]

        return self.environment.get(key, default)


@dataclass(frozen=True)
class DockerBuildEnvironmentRequest:
    target: Target


@rule
async def docker_build_environment_vars(
    request: DockerBuildEnvironmentRequest,
    docker_options: DockerOptions,
    docker_env_aware: DockerOptions.EnvironmentAware,
) -> DockerBuildEnvironment:
    build_args = await docker_build_args(DockerBuildArgsRequest(request.target), **implicitly())
    env_vars = KeyValueSequenceUtil.from_strings(
        *{build_arg for build_arg in build_args if "=" not in build_arg},
        *docker_env_aware.env_vars,
    )
    env = await environment_vars_subset(EnvironmentVarsRequest(tuple(env_vars)), **implicitly())
    return DockerBuildEnvironment.create(env)


def rules():
    return collect_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	7✔
5
6	import logging	7✔
7	from collections.abc import Mapping	7✔
8	from dataclasses import dataclass	7✔
9
10	from pants.backend.docker.subsystems.docker_options import DockerOptions	7✔
11	from pants.backend.docker.util_rules.docker_build_args import (	7✔
12	DockerBuildArgsRequest,
13	docker_build_args,
14	)
15	from pants.backend.docker.utils import KeyValueSequenceUtil	7✔
16	from pants.core.util_rules.env_vars import environment_vars_subset	7✔
17	from pants.engine.env_vars import EnvironmentVars, EnvironmentVarsRequest	7✔
18	from pants.engine.rules import collect_rules, implicitly, rule	7✔
19	from pants.engine.target import Target	7✔
20
21	logger = logging.getLogger(__name__)	7✔
22
23
24	class DockerBuildEnvironmentError(ValueError):	7✔
25	@classmethod	7✔
26	def from_key_error(cls, e: KeyError) -> DockerBuildEnvironmentError:	7✔
27	return cls(	×
28	f"The Docker environment variable {e} is undefined. You may provide a value for "
29	"this variable either in `[docker].env_vars` or in Pants's own environment."
30	)
31
32
33	@dataclass(frozen=True)	7✔
34	class DockerBuildEnvironment:	7✔
35	environment: EnvironmentVars	7✔
36
37	@classmethod	7✔
38	def create(	7✔
39	cls,
40	env: Mapping[str, str],
41	) -> DockerBuildEnvironment:
42	return cls(EnvironmentVars(env))	1✔
43
44	def __getitem__(self, key: str) -> str:	7✔
45	try:	×
46	return self.environment[key]	×
47	except KeyError as e:	×
48	raise DockerBuildEnvironmentError.from_key_error(e) from e	×
49
50	def get(self, key: str, default: str \| None = None) -> str:	7✔
51	if default is None:	×
52	return self[key]	×
53
54	return self.environment.get(key, default)	×
55
56
57	@dataclass(frozen=True)	7✔
58	class DockerBuildEnvironmentRequest:	7✔
59	target: Target	7✔
60
61
62	@rule	7✔
63	async def docker_build_environment_vars(	7✔
64	request: DockerBuildEnvironmentRequest,
65	docker_options: DockerOptions,
66	docker_env_aware: DockerOptions.EnvironmentAware,
67	) -> DockerBuildEnvironment:
68	build_args = await docker_build_args(DockerBuildArgsRequest(request.target), **implicitly())	×
69	env_vars = KeyValueSequenceUtil.from_strings(	×
70	*{build_arg for build_arg in build_args if "=" not in build_arg},
71	*docker_env_aware.env_vars,
72	)
73	env = await environment_vars_subset(EnvironmentVarsRequest(tuple(env_vars)), **implicitly())	×
74	return DockerBuildEnvironment.create(env)	×
75
76
77	def rules():	7✔
78	return collect_rules()	7✔

pantsbuild / pants / 18791134616

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