20632486505

Committed 01 Jan 2026 04:21AM UTC coverage: 43.231% (-37.1%) from 80.281%

Build # 20632486505

Build Type

Pull #22962

github

Committed by

web-flow

Commit Message

Merge 08d5c63b0 into f52ab6675

Pull Request Pull Request #22962: Bump the gha-deps group across 1 directory with 6 updates

Run Details

26122 of 60424 relevant lines covered (43.23%)

0.86 hits per line

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

61.7

/src/python/pants/backend/shell/goals/package.py

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

from __future__ import annotations

import dataclasses
from dataclasses import dataclass

from pants.backend.shell.target_types import (
    ShellCommandCommandField,
    ShellCommandPackageDependenciesField,
    SkipShellCommandPackageField,
)
from pants.backend.shell.util_rules import shell_command
from pants.backend.shell.util_rules.shell_command import (
    ShellCommandProcessFromTargetRequest,
    prepare_process_request_from_target,
)
from pants.core.environments.target_types import EnvironmentField
from pants.core.goals.package import (
    BuiltPackage,
    BuiltPackageArtifact,
    OutputPathField,
    PackageFieldSet,
)
from pants.core.util_rules.adhoc_process_support import (
    AdhocProcessRequest,
    run_prepared_adhoc_process,
)
from pants.core.util_rules.adhoc_process_support import rules as adhoc_process_support_rules
from pants.engine.fs import EMPTY_DIGEST, AddPrefix, Digest
from pants.engine.internals.graph import resolve_target
from pants.engine.intrinsics import add_prefix, get_digest_entries
from pants.engine.process import ProcessCacheScope
from pants.engine.rules import collect_rules, implicitly, rule
from pants.engine.target import Target, WrappedTargetRequest
from pants.engine.unions import UnionRule
from pants.util.logging import LogLevel


@dataclass(frozen=True)
class PackageShellCommandFieldSet(PackageFieldSet):
    required_fields = (
        ShellCommandCommandField,
        ShellCommandPackageDependenciesField,
    )

    environment: EnvironmentField
    output_path: OutputPathField

    @classmethod
    def opt_out(cls, tgt: Target) -> bool:
        return tgt.get(SkipShellCommandPackageField).value


@rule(desc="Package with shell command", level=LogLevel.DEBUG)
async def package_shell_command(
    field_set: PackageShellCommandFieldSet,
) -> BuiltPackage:
    wrapped_tgt = await resolve_target(
        WrappedTargetRequest(field_set.address, description_of_origin="<infallible>"),
        **implicitly(),
    )
    target = wrapped_tgt.target

    shell_process = await prepare_process_request_from_target(
        ShellCommandProcessFromTargetRequest(target), **implicitly()
    )

    shell_process = dataclasses.replace(
        shell_process,
        cache_scope=shell_process.cache_scope or ProcessCacheScope.SUCCESSFUL,
    )

    result = await run_prepared_adhoc_process(**implicitly({shell_process: AdhocProcessRequest}))

    if result.process_result.exit_code != 0:
        raise ValueError(
            f"The `{target.alias}` at `{field_set.address}` failed with exit code {result.process_result.exit_code}.\n\n"
            f"stdout:\n\n{result.process_result.stdout.decode(errors='ignore')}\n\n"
            f"stderr:\n\n{result.process_result.stderr.decode(errors='ignore')}"
        )

    if result.adjusted_digest == EMPTY_DIGEST:
        raise ValueError(
            f"The `{target.alias}` at `{field_set.address}` did not produce or capture any output. "
            "The `package` goal is expected to produce output."
        )

    # Apply the output path for the artifacts.
    output_path = field_set.output_path.value_or_default(file_ending=None)
    output_digest: Digest
    if output_path:
        output_digest = await add_prefix(AddPrefix(result.adjusted_digest, output_path))
    else:
        output_digest = result.adjusted_digest

    output_digest_entries = await get_digest_entries(result.adjusted_digest)
    file_paths = sorted(e.path for e in output_digest_entries)
    artifacts = tuple(BuiltPackageArtifact(relpath=path) for path in file_paths)
    return BuiltPackage(output_digest, artifacts)


def rules():
    return (
        *collect_rules(),
        *shell_command.rules(),
        *adhoc_process_support_rules(),
        UnionRule(PackageFieldSet, PackageShellCommandFieldSet),
    )

1	# Copyright 2025 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 dataclasses	2✔
7	from dataclasses import dataclass	2✔
8
9	from pants.backend.shell.target_types import (	2✔
10	ShellCommandCommandField,
11	ShellCommandPackageDependenciesField,
12	SkipShellCommandPackageField,
13	)
14	from pants.backend.shell.util_rules import shell_command	2✔
15	from pants.backend.shell.util_rules.shell_command import (	2✔
16	ShellCommandProcessFromTargetRequest,
17	prepare_process_request_from_target,
18	)
19	from pants.core.environments.target_types import EnvironmentField	2✔
20	from pants.core.goals.package import (	2✔
21	BuiltPackage,
22	BuiltPackageArtifact,
23	OutputPathField,
24	PackageFieldSet,
25	)
26	from pants.core.util_rules.adhoc_process_support import (	2✔
27	AdhocProcessRequest,
28	run_prepared_adhoc_process,
29	)
30	from pants.core.util_rules.adhoc_process_support import rules as adhoc_process_support_rules	2✔
31	from pants.engine.fs import EMPTY_DIGEST, AddPrefix, Digest	2✔
32	from pants.engine.internals.graph import resolve_target	2✔
33	from pants.engine.intrinsics import add_prefix, get_digest_entries	2✔
34	from pants.engine.process import ProcessCacheScope	2✔
35	from pants.engine.rules import collect_rules, implicitly, rule	2✔
36	from pants.engine.target import Target, WrappedTargetRequest	2✔
37	from pants.engine.unions import UnionRule	2✔
38	from pants.util.logging import LogLevel	2✔
39
40
41	@dataclass(frozen=True)	2✔
42	class PackageShellCommandFieldSet(PackageFieldSet):	2✔
43	required_fields = (	2✔
44	ShellCommandCommandField,
45	ShellCommandPackageDependenciesField,
46	)
47
48	environment: EnvironmentField	2✔
49	output_path: OutputPathField	2✔
50
51	@classmethod	2✔
52	def opt_out(cls, tgt: Target) -> bool:	2✔
53	return tgt.get(SkipShellCommandPackageField).value	×
54
55
56	@rule(desc="Package with shell command", level=LogLevel.DEBUG)	2✔
57	async def package_shell_command(	2✔
58	field_set: PackageShellCommandFieldSet,
59	) -> BuiltPackage:
60	wrapped_tgt = await resolve_target(	×
61	WrappedTargetRequest(field_set.address, description_of_origin="<infallible>"),
62	**implicitly(),
63	)
64	target = wrapped_tgt.target	×
65
66	shell_process = await prepare_process_request_from_target(	×
67	ShellCommandProcessFromTargetRequest(target), **implicitly()
68	)
69
70	shell_process = dataclasses.replace(	×
71	shell_process,
72	cache_scope=shell_process.cache_scope or ProcessCacheScope.SUCCESSFUL,
73	)
74
75	result = await run_prepared_adhoc_process(**implicitly({shell_process: AdhocProcessRequest}))	×
76
77	if result.process_result.exit_code != 0:	×
78	raise ValueError(	×
79	f"The `{target.alias}` at `{field_set.address}` failed with exit code {result.process_result.exit_code}.\n\n"
80	f"stdout:\n\n{result.process_result.stdout.decode(errors='ignore')}\n\n"
81	f"stderr:\n\n{result.process_result.stderr.decode(errors='ignore')}"
82	)
83
84	if result.adjusted_digest == EMPTY_DIGEST:	×
85	raise ValueError(	×
86	f"The `{target.alias}` at `{field_set.address}` did not produce or capture any output. "
87	"The `package` goal is expected to produce output."
88	)
89
90	# Apply the output path for the artifacts.
91	output_path = field_set.output_path.value_or_default(file_ending=None)	×
92	output_digest: Digest
93	if output_path:	×
94	output_digest = await add_prefix(AddPrefix(result.adjusted_digest, output_path))	×
95	else:
96	output_digest = result.adjusted_digest	×
97
98	output_digest_entries = await get_digest_entries(result.adjusted_digest)	×
99	file_paths = sorted(e.path for e in output_digest_entries)	×
100	artifacts = tuple(BuiltPackageArtifact(relpath=path) for path in file_paths)	×
101	return BuiltPackage(output_digest, artifacts)	×
102
103
104	def rules():	2✔
105	return (	2✔
106	*collect_rules(),
107	*shell_command.rules(),
108	*adhoc_process_support_rules(),
109	UnionRule(PackageFieldSet, PackageShellCommandFieldSet),
110	)

pantsbuild / pants / 20632486505

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