19529437518

Committed 20 Nov 2025 07:44AM UTC coverage: 78.884% (-1.4%) from 80.302%

Build # 19529437518

Build Type

push

github

Committed by

web-flow

Commit Message

nfpm.native_libs: Add RPM package depends from packaged pex_binaries (#22899)

## PR Series Overview

This is the second in a series of PRs that introduces a new backend:
`pants.backend.npm.native_libs`
Initially, the backend will be available as:
`pants.backend.experimental.nfpm.native_libs`

I proposed this new backend (originally named `bindeps`) in discussion
#22396.

This backend will inspect ELF bin/lib files (like `lib*.so`) in packaged
contents (for this PR series, only in `pex_binary` targets) to identify
package dependency metadata and inject that metadata on the relevant
`nfpm_deb_package` or `nfpm_rpm_package` targets. Effectively, it will
provide an approximation of these native packager features:
- `rpm`: `rpmdeps` + `elfdeps`
- `deb`: `dh_shlibdeps` + `dpkg-shlibdeps` (These substitute
`${shlibs:Depends}` in debian control files have)

### Goal: Host-agnostic package builds

This pants backend is designed to be host-agnostic, like
[nFPM](https://nfpm.goreleaser.com/).

Native packaging tools are often restricted to a single release of a
single distro. Unlike native package builders, this new pants backend
does not use any of those distro-specific or distro-release-specific
utilities or local package databases. This new backend should be able to
run (help with building deb and rpm packages) anywhere that pants can
run (MacOS, rpm linux distros, deb linux distros, other linux distros,
docker, ...).

### Previous PRs in series

- #22873

## PR Overview

This PR adds rules in `nfpm.native_libs` to add package dependency
metadata to `nfpm_rpm_package`. The 2 new rules are:

- `inject_native_libs_dependencies_in_package_fields`:

    - An implementation of the polymorphic rule `inject_nfpm_package_fields`.
      This rule is low priority (`priority = 2`) so that in-repo plugins can
      override/augment what it injects. (See #22864)

    - Rule logic overview:
        - find any pex_binaries that will be packaged in an `nfpm_rpm_package`
   ... (continued)

Run Details

96 of 118 new or added lines in 3 files covered. (81.36%)

910 existing lines in 53 files now uncovered.

73897 of 93678 relevant lines covered (78.88%)

3.21 hits per line

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

79.17

/src/python/pants/bsp/spec/resources.py

# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).
from __future__ import annotations

from dataclasses import dataclass
from typing import Any

from pants.bsp.spec.base import BuildTargetIdentifier, Uri

# -----------------------------------------------------------------------------------------------
# Resources Request
# See https://build-server-protocol.github.io/docs/specification.html#resources-request
# -----------------------------------------------------------------------------------------------


@dataclass(frozen=True)
class ResourcesParams:
    targets: tuple[BuildTargetIdentifier, ...]

    @classmethod
    def from_json_dict(cls, d: dict[str, Any]) -> Any:
        return cls(
            targets=tuple(BuildTargetIdentifier.from_json_dict(x) for x in d["targets"]),
        )

    def to_json_dict(self) -> dict[str, Any]:
        return {"targets": [tgt.to_json_dict() for tgt in self.targets]}


@dataclass(frozen=True)
class ResourcesItem:
    target: BuildTargetIdentifier
    # List of resource files.
    resources: tuple[Uri, ...]

    def to_json_dict(self):
        result = {
            "target": self.target.to_json_dict(),
            "resources": self.resources,
        }
        return result


@dataclass(frozen=True)
class ResourcesResult:
    items: tuple[ResourcesItem, ...]

    def to_json_dict(self) -> dict[str, Any]:
        return {
            "items": [ri.to_json_dict() for ri in self.items],
        }

1	# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3	from __future__ import annotations	1✔
4
5	from dataclasses import dataclass	1✔
6	from typing import Any	1✔
7
8	from pants.bsp.spec.base import BuildTargetIdentifier, Uri	1✔
9
10	# -----------------------------------------------------------------------------------------------
11	# Resources Request
12	# See https://build-server-protocol.github.io/docs/specification.html#resources-request
13	# -----------------------------------------------------------------------------------------------
14
15
16	@dataclass(frozen=True)	1✔
17	class ResourcesParams:	1✔
18	targets: tuple[BuildTargetIdentifier, ...]	1✔
19
20	@classmethod	1✔
21	def from_json_dict(cls, d: dict[str, Any]) -> Any:	1✔
UNCOV 22	return cls(	×
23	targets=tuple(BuildTargetIdentifier.from_json_dict(x) for x in d["targets"]),
24	)
25
26	def to_json_dict(self) -> dict[str, Any]:	1✔
UNCOV 27	return {"targets": [tgt.to_json_dict() for tgt in self.targets]}	×
28
29
30	@dataclass(frozen=True)	1✔
31	class ResourcesItem:	1✔
32	target: BuildTargetIdentifier	1✔
33	# List of resource files.
34	resources: tuple[Uri, ...]	1✔
35
36	def to_json_dict(self):	1✔
UNCOV 37	result = {	×
38	"target": self.target.to_json_dict(),
39	"resources": self.resources,
40	}
UNCOV 41	return result	×
42
43
44	@dataclass(frozen=True)	1✔
45	class ResourcesResult:	1✔
46	items: tuple[ResourcesItem, ...]	1✔
47
48	def to_json_dict(self) -> dict[str, Any]:	1✔
UNCOV 49	return {	×
50	"items": [ri.to_json_dict() for ri in self.items],
51	}

pantsbuild / pants / 19529437518

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