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

98.15

/src/python/pants/backend/docker/registries.py

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

from __future__ import annotations

from collections.abc import Iterator
from dataclasses import dataclass
from typing import Any

from pants.util.frozendict import FrozenDict
from pants.util.strutil import softwrap

ALL_DEFAULT_REGISTRIES = "<all default registries>"


class DockerRegistryError(ValueError):
    pass


class DockerRegistryOptionsNotFoundError(DockerRegistryError):
    def __init__(self, message):
        super().__init__(
            f"{message}\n\n"
            "Use the [docker].registries configuration option to define custom registries."
        )


class DockerRegistryAddressCollisionError(DockerRegistryError):
    def __init__(self, first, second):
        message = softwrap(
            f"""
            Duplicated docker registry address for aliases: {first.alias}, {second.alias}.
            Each registry `address` in `[docker].registries` must be unique.
            """
        )

        super().__init__(message)


@dataclass(frozen=True)
class DockerRegistryOptions:
    address: str
    alias: str = ""
    default: bool = False
    skip_push: bool = False
    extra_image_tags: tuple[str, ...] = ()
    repository: str | None = None
    use_local_alias: bool = False

    @classmethod
    def from_dict(cls, alias: str, d: dict[str, Any]) -> DockerRegistryOptions:
        return cls(
            alias=alias,
            address=d["address"],
            default=d.get("default", alias == "default"),
            skip_push=d.get("skip_push", DockerRegistryOptions.skip_push),
            extra_image_tags=tuple(
                d.get("extra_image_tags", DockerRegistryOptions.extra_image_tags)
            ),
            repository=d.get("repository"),
            use_local_alias=d.get("use_local_alias", False),
        )

    def register(self, registries: dict[str, DockerRegistryOptions]) -> None:
        if self.address in registries:
            collision = registries[self.address]
            raise DockerRegistryAddressCollisionError(collision, self)
        registries[self.address] = self
        if self.alias:
            registries[f"@{self.alias}"] = self


@dataclass(frozen=True)
class DockerRegistries:
    default: tuple[DockerRegistryOptions, ...]
    registries: FrozenDict[str, DockerRegistryOptions]

    @classmethod
    def from_dict(cls, d: dict[str, Any]) -> DockerRegistries:
        registries: dict[str, DockerRegistryOptions] = {}
        for alias, options in d.items():
            DockerRegistryOptions.from_dict(alias, options).register(registries)
        return cls(
            default=tuple(
                sorted({r for r in registries.values() if r.default}, key=lambda r: r.address)
            ),
            registries=FrozenDict(registries),
        )

    def get(self, *aliases_or_addresses: str) -> Iterator[DockerRegistryOptions]:
        for alias_or_address in aliases_or_addresses:
            if alias_or_address in self.registries:
                # Get configured registry by "@alias" or "address".
                yield self.registries[alias_or_address]
            elif alias_or_address.startswith("@"):
                raise DockerRegistryOptionsNotFoundError(
                    f"There is no Docker registry configured with alias: {alias_or_address[1:]}."
                )
            elif alias_or_address == ALL_DEFAULT_REGISTRIES:
                yield from self.default
            else:
                # Assume an explicit address from the BUILD file.
                yield DockerRegistryOptions(address=alias_or_address)

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	9✔
5
6	from collections.abc import Iterator	9✔
7	from dataclasses import dataclass	9✔
8	from typing import Any	9✔
9
10	from pants.util.frozendict import FrozenDict	9✔
11	from pants.util.strutil import softwrap	9✔
12
13	ALL_DEFAULT_REGISTRIES = "<all default registries>"	9✔
14
15
16	class DockerRegistryError(ValueError):	9✔
17	pass	9✔
18
19
20	class DockerRegistryOptionsNotFoundError(DockerRegistryError):	9✔
21	def __init__(self, message):	9✔
22	super().__init__(	1✔
23	f"{message}\n\n"
24	"Use the [docker].registries configuration option to define custom registries."
25	)
26
27
28	class DockerRegistryAddressCollisionError(DockerRegistryError):	9✔
29	def __init__(self, first, second):	9✔
30	message = softwrap(	1✔
31	f"""
32	Duplicated docker registry address for aliases: {first.alias}, {second.alias}.
33	Each registry `address` in `[docker].registries` must be unique.
34	"""
35	)
36
37	super().__init__(message)	1✔
38
39
40	@dataclass(frozen=True)	9✔
41	class DockerRegistryOptions:	9✔
42	address: str	9✔
43	alias: str = ""	9✔
44	default: bool = False	9✔
45	skip_push: bool = False	9✔
46	extra_image_tags: tuple[str, ...] = ()	9✔
47	repository: str \| None = None	9✔
48	use_local_alias: bool = False	9✔
49
50	@classmethod	9✔
51	def from_dict(cls, alias: str, d: dict[str, Any]) -> DockerRegistryOptions:	9✔
52	return cls(	1✔
53	alias=alias,
54	address=d["address"],
55	default=d.get("default", alias == "default"),
56	skip_push=d.get("skip_push", DockerRegistryOptions.skip_push),
57	extra_image_tags=tuple(
58	d.get("extra_image_tags", DockerRegistryOptions.extra_image_tags)
59	),
60	repository=d.get("repository"),
61	use_local_alias=d.get("use_local_alias", False),
62	)
63
64	def register(self, registries: dict[str, DockerRegistryOptions]) -> None:	9✔
65	if self.address in registries:	1✔
66	collision = registries[self.address]	1✔
67	raise DockerRegistryAddressCollisionError(collision, self)	1✔
68	registries[self.address] = self	1✔
69	if self.alias:	1✔
70	registries[f"@{self.alias}"] = self	1✔
71
72
73	@dataclass(frozen=True)	9✔
74	class DockerRegistries:	9✔
75	default: tuple[DockerRegistryOptions, ...]	9✔
76	registries: FrozenDict[str, DockerRegistryOptions]	9✔
77
78	@classmethod	9✔
79	def from_dict(cls, d: dict[str, Any]) -> DockerRegistries:	9✔
80	registries: dict[str, DockerRegistryOptions] = {}	1✔
81	for alias, options in d.items():	1✔
82	DockerRegistryOptions.from_dict(alias, options).register(registries)	1✔
83	return cls(	1✔
84	default=tuple(
85	sorted({r for r in registries.values() if r.default}, key=lambda r: r.address)
86	),
87	registries=FrozenDict(registries),
88	)
89
90	def get(self, *aliases_or_addresses: str) -> Iterator[DockerRegistryOptions]:	9✔
91	for alias_or_address in aliases_or_addresses:	1✔
92	if alias_or_address in self.registries:	1✔
93	# Get configured registry by "@alias" or "address".
94	yield self.registries[alias_or_address]	1✔
95	elif alias_or_address.startswith("@"):	1✔
96	raise DockerRegistryOptionsNotFoundError(	1✔
97	f"There is no Docker registry configured with alias: {alias_or_address[1:]}."
98	)
99	elif alias_or_address == ALL_DEFAULT_REGISTRIES:	1✔
100	yield from self.default	×
101	else:
102	# Assume an explicit address from the BUILD file.
103	yield DockerRegistryOptions(address=alias_or_address)	1✔

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