26080722777

Committed 19 May 2026 06:37AM UTC coverage: 52.106% (-11.5%) from 63.597%

Build # 26080722777

Build Type

Pull #23250

github

Committed by

web-flow

Commit Message

Merge 63ec06323 into 2693df832

Pull Request Pull Request #23250: Feature: Add generic option to docker image

Coverage Stats

12 of 50 new or added lines in 3 files covered. (24.0%)

5382 existing lines in 201 files now uncovered.

32053 of 61515 relevant lines covered (52.11%)

1.04 hits per line

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

45.95

/src/python/pants/backend/go/util_rules/embedcfg.py

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

from __future__ import annotations

import json
from collections.abc import Iterable, Mapping
from dataclasses import dataclass
from typing import Any

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


@dataclass(frozen=True)
class EmbedConfig:
    patterns: FrozenDict[str, tuple[str, ...]]
    files: FrozenDict[str, str]

    def __init__(self, patterns: Mapping[str, Iterable[str]], files: Mapping[str, str]) -> None:
        """Configuration passed to the Go compiler to configure file embedding.

        The compiler relies entirely on the caller to map embed patterns to actual filesystem
        paths. All embed patterns
        contained in the package must be mapped. Consult
        `FirstPartyPkgAnalysis.embed_patterns` for the embed patterns obtained from analysis.

        :param patterns: Maps each pattern provided via a //go:embed directive to a list of file
          paths relative to the package directory for files to embed for that pattern. When the
          embedded variable is an `embed.FS`, those relative file paths define the virtual
          directory hierarchy exposed by the embed.FS filesystem abstraction. The relative file
          paths are resolved to actual filesystem paths for their content by consulting the
          `files` dictionary.
        :param files: Maps each virtual, relative file path used as a value in the `patterns`
          dictionary to the actual filesystem path with that file's content.
        """
        object.__setattr__(self, "patterns", FrozenDict({k: tuple(v) for k, v in patterns.items()}))
        object.__setattr__(self, "files", FrozenDict(files))

    @classmethod
    def from_json_dict(
        cls, d: dict[str, Any], prefix_to_strip: str | None = None
    ) -> EmbedConfig | None:
        patterns = d.get("Patterns", {})
        files = d.get("Files", {})
        if prefix_to_strip:
            files = {key: strip_prefix(value, prefix_to_strip) for key, value in files.items()}
        result = cls(
            patterns=FrozenDict({key: tuple(value) for key, value in patterns.items()}),
            files=FrozenDict(files),
        )
        return result if result else None

    def to_embedcfg(self) -> bytes:
        data = {
            "Patterns": dict(self.patterns),
            "Files": dict(self.files),
        }
        return json.dumps(data).encode("utf-8")

    def __bool__(self) -> bool:
        return bool(self.patterns) or bool(self.files)

    def merge(self, other: EmbedConfig) -> EmbedConfig:
        """Merge two EmbedConfig's into one.

        Overlapping keys must have the same values.
        """
        overlapping_patterns_keys = set(self.patterns.keys()) & set(other.patterns.keys())
        for key in overlapping_patterns_keys:
            if self.patterns[key] != other.patterns[key]:
                raise AssertionError(
                    "Unable to merge conflicting golang file embed configurations. This should not have occurred. "
                    "Please open an issue at https://github.com/pantsbuild/pants/issues/new/choose "
                    "with the following information: "
                    f"Patterns Key: {key}; Left: {self.patterns[key]}; Right: {other.patterns[key]} "
                )

        overlapping_files_keys = set(self.files.keys()) & set(other.files.keys())
        for key in overlapping_files_keys:
            if self.files[key] != other.files[key]:
                raise AssertionError(
                    "Unable to merge conflicting golang file embed configurations. This should not have occurred. "
                    "Please open an issue at https://github.com/pantsbuild/pants/issues/new/choose "
                    "with the following information: "
                    f"Files Key: {key}; Left: {self.patterns[key]}; Right: {other.patterns[key]} "
                )

        return EmbedConfig(
            patterns={**self.patterns, **other.patterns},
            files={**self.files, **other.files},
        )

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	2✔
5
6	import json	2✔
7	from collections.abc import Iterable, Mapping	2✔
8	from dataclasses import dataclass	2✔
9	from typing import Any	2✔
10
11	from pants.util.frozendict import FrozenDict	2✔
12	from pants.util.strutil import strip_prefix	2✔
13
14
15	@dataclass(frozen=True)	2✔
16	class EmbedConfig:	2✔
17	patterns: FrozenDict[str, tuple[str, ...]]	2✔
18	files: FrozenDict[str, str]	2✔
19
20	def __init__(self, patterns: Mapping[str, Iterable[str]], files: Mapping[str, str]) -> None:	2✔
21	"""Configuration passed to the Go compiler to configure file embedding.
22
23	The compiler relies entirely on the caller to map embed patterns to actual filesystem
24	paths. All embed patterns
25	contained in the package must be mapped. Consult
26	`FirstPartyPkgAnalysis.embed_patterns` for the embed patterns obtained from analysis.
27
28	:param patterns: Maps each pattern provided via a //go:embed directive to a list of file
29	paths relative to the package directory for files to embed for that pattern. When the
30	embedded variable is an `embed.FS`, those relative file paths define the virtual
31	directory hierarchy exposed by the embed.FS filesystem abstraction. The relative file
32	paths are resolved to actual filesystem paths for their content by consulting the
33	`files` dictionary.
34	:param files: Maps each virtual, relative file path used as a value in the `patterns`
35	dictionary to the actual filesystem path with that file's content.
36	"""
UNCOV 37	object.__setattr__(self, "patterns", FrozenDict({k: tuple(v) for k, v in patterns.items()}))	×
UNCOV 38	object.__setattr__(self, "files", FrozenDict(files))	×
39
40	@classmethod	2✔
41	def from_json_dict(	2✔
42	cls, d: dict[str, Any], prefix_to_strip: str \| None = None
43	) -> EmbedConfig \| None:
UNCOV 44	patterns = d.get("Patterns", {})	×
UNCOV 45	files = d.get("Files", {})	×
UNCOV 46	if prefix_to_strip:	×
UNCOV 47	files = {key: strip_prefix(value, prefix_to_strip) for key, value in files.items()}	×
UNCOV 48	result = cls(	×
49	patterns=FrozenDict({key: tuple(value) for key, value in patterns.items()}),
50	files=FrozenDict(files),
51	)
UNCOV 52	return result if result else None	×
53
54	def to_embedcfg(self) -> bytes:	2✔
55	data = {	×
56	"Patterns": dict(self.patterns),
57	"Files": dict(self.files),
58	}
59	return json.dumps(data).encode("utf-8")	×
60
61	def __bool__(self) -> bool:	2✔
UNCOV 62	return bool(self.patterns) or bool(self.files)	×
63
64	def merge(self, other: EmbedConfig) -> EmbedConfig:	2✔
65	"""Merge two EmbedConfig's into one.
66
67	Overlapping keys must have the same values.
68	"""
69	overlapping_patterns_keys = set(self.patterns.keys()) & set(other.patterns.keys())	×
70	for key in overlapping_patterns_keys:	×
71	if self.patterns[key] != other.patterns[key]:	×
72	raise AssertionError(	×
73	"Unable to merge conflicting golang file embed configurations. This should not have occurred. "
74	"Please open an issue at https://github.com/pantsbuild/pants/issues/new/choose "
75	"with the following information: "
76	f"Patterns Key: {key}; Left: {self.patterns[key]}; Right: {other.patterns[key]} "
77	)
78
79	overlapping_files_keys = set(self.files.keys()) & set(other.files.keys())	×
80	for key in overlapping_files_keys:	×
81	if self.files[key] != other.files[key]:	×
82	raise AssertionError(	×
83	"Unable to merge conflicting golang file embed configurations. This should not have occurred. "
84	"Please open an issue at https://github.com/pantsbuild/pants/issues/new/choose "
85	"with the following information: "
86	f"Files Key: {key}; Left: {self.patterns[key]}; Right: {other.patterns[key]} "
87	)
88
89	return EmbedConfig(	×
90	patterns={self.patterns, other.patterns},
91	files={self.files, other.files},
92	)

pantsbuild / pants / 26080722777

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