Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sources_fingerprint to peek on source-creating targets #18383

Merged
merged 4 commits into from
Mar 3, 2023
Merged

Add sources_fingerprint to peek on source-creating targets #18383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c71b31
Add "sources_fingerprint" to peek on a source-creating target
huonw Feb 25, 2023
717861f
Merge remote-tracking branch 'upstream/main' into feature/8445-source…
huonw Mar 1, 2023
21cc565
from __future__ import annotations for older pythons
huonw Mar 1, 2023
726ff14
mypy and tests actually passing after merge skew
huonw Mar 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/python/pants/backend/project_info/peek.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
from pants.engine.addresses import Addresses
from pants.engine.collection import Collection
from pants.engine.console import Console
from pants.engine.fs import Snapshot
from pants.engine.goal import Goal, GoalSubsystem, Outputting
from pants.engine.internals.build_files import _get_target_family_and_adaptor_for_dep_rules
from pants.engine.internals.dep_rules import DependencyRuleApplication, DependencyRuleSet
Expand Down Expand Up @@ -79,7 +80,7 @@ def _normalize_value(val: Any) -> Any:
class TargetData:
target: Target
# Sources may not be registered on the target, so we'll have nothing to expand.
expanded_sources: tuple[str, ...] | None
expanded_sources: Snapshot | None
expanded_dependencies: tuple[str, ...]

dependencies_rules: tuple[str, ...] | None = None
Expand All @@ -98,7 +99,8 @@ def to_dict(self, exclude_defaults: bool = False, include_dep_rules: bool = Fals

fields["dependencies"] = self.expanded_dependencies
if self.expanded_sources is not None:
fields["sources"] = self.expanded_sources
fields["sources"] = self.expanded_sources.files
fields["sources_fingerprint"] = self.expanded_sources.digest.fingerprint

if include_dep_rules:
fields["_dependencies_rules"] = self.dependencies_rules
Expand Down Expand Up @@ -189,7 +191,7 @@ async def get_target_data(
for tgt, deps in zip(sorted_targets, dependencies_per_target)
]
expanded_sources_map = {
tgt.address: hs.snapshot.files
tgt.address: hs.snapshot
for tgt, hs in zip(targets_with_sources, hydrated_sources_per_target)
}

Expand Down
62 changes: 49 additions & 13 deletions src/python/pants/backend/project_info/peek_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from __future__ import annotations

import dataclasses
from textwrap import dedent
from typing import Sequence

import pytest

Expand All @@ -11,11 +15,16 @@
from pants.base.specs import RawSpecs, RecursiveGlobSpec
from pants.core.target_types import ArchiveTarget, FilesGeneratorTarget, FileTarget, GenericTarget
from pants.engine.addresses import Address
from pants.engine.fs import Digest, Snapshot
from pants.engine.internals.dep_rules import DependencyRuleAction, DependencyRuleApplication
from pants.engine.rules import QueryRule
from pants.testutil.rule_runner import RuleRunner


def _snapshot(fingerprint: str, files: tuple[str, ...]) -> Snapshot:
return Snapshot._unsafe_create(Digest(fingerprint.ljust(64, "0"), 1), files, ())


@pytest.mark.parametrize(
"expanded_target_infos, exclude_defaults, include_dep_rules, expected_output",
[
Expand All @@ -38,7 +47,10 @@
},
Address("example", target_name="files_target"),
),
("foo.txt", "bar.txt"),
_snapshot(
"2",
("foo.txt", "bar.txt"),
),
tuple(),
)
],
Expand All @@ -59,9 +71,10 @@
}
},
"sources": [
"foo.txt",
"bar.txt"
"bar.txt",
"foo.txt"
],
"sources_fingerprint": "2000000000000000000000000000000000000000000000000000000000000000",
"sources_raw": [
"*.txt"
]
Expand All @@ -77,7 +90,10 @@
FilesGeneratorTarget(
{"sources": ["foo.txt"]}, Address("example", target_name="files_target")
),
("foo.txt",),
_snapshot(
"1",
("foo.txt",),
),
tuple(),
)
],
Expand All @@ -95,6 +111,7 @@
"sources": [
"foo.txt"
],
"sources_fingerprint": "1000000000000000000000000000000000000000000000000000000000000000",
"sources_raw": [
"foo.txt"
],
Expand All @@ -112,7 +129,10 @@
{"sources": ["*.txt"], "tags": ["zippable"]},
Address("example", target_name="files_target"),
),
tuple(),
_snapshot(
"0",
(),
),
tuple(),
),
TargetData(
Expand All @@ -138,6 +158,7 @@
"target_type": "files",
"dependencies": [],
"sources": [],
"sources_fingerprint": "0000000000000000000000000000000000000000000000000000000000000000",
"sources_raw": [
"*.txt"
],
Expand Down Expand Up @@ -167,7 +188,7 @@
[
TargetData(
FilesGeneratorTarget({"sources": ["*.txt"]}, Address("foo", target_name="baz")),
("foo/a.txt",),
_snapshot("", ("foo/a.txt",)),
("foo/a.txt:baz",),
dependencies_rules=("does", "apply", "*"),
dependents_rules=("fall-through", "*"),
Expand Down Expand Up @@ -218,6 +239,7 @@
"sources": [
"foo/a.txt"
],
"sources_fingerprint": "0000000000000000000000000000000000000000000000000000000000000000",
"sources_raw": [
"*.txt"
]
Expand Down Expand Up @@ -254,6 +276,19 @@ def test_non_matching_build_target(rule_runner: RuleRunner) -> None:
assert result.stdout == "[]\n"


def _normalize_fingerprints(tds: Sequence[TargetData]) -> list[TargetData]:
"""We're not here to test the computation of fingerprints."""
return [
dataclasses.replace(
td,
expanded_sources=None
if td.expanded_sources is None
else _snapshot("", td.expanded_sources.files),
)
for td in tds
]


def test_get_target_data(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
Expand All @@ -272,29 +307,30 @@ def test_get_target_data(rule_runner: RuleRunner) -> None:
TargetDatas,
[RawSpecs(recursive_globs=(RecursiveGlobSpec("foo"),), description_of_origin="tests")],
)
assert list(tds) == [

assert _normalize_fingerprints(tds) == [
TargetData(
GenericTarget({"dependencies": [":baz"]}, Address("foo", target_name="bar")),
None,
("foo/a.txt:baz", "foo/b.txt:baz"),
),
TargetData(
FilesGeneratorTarget({"sources": ["*.txt"]}, Address("foo", target_name="baz")),
("foo/a.txt", "foo/b.txt"),
_snapshot("", ("foo/a.txt", "foo/b.txt")),
("foo/a.txt:baz", "foo/b.txt:baz"),
),
TargetData(
FileTarget(
{"source": "a.txt"}, Address("foo", relative_file_path="a.txt", target_name="baz")
),
("foo/a.txt",),
_snapshot("", ("foo/a.txt",)),
(),
),
TargetData(
FileTarget(
{"source": "b.txt"}, Address("foo", relative_file_path="b.txt", target_name="baz")
),
("foo/b.txt",),
_snapshot("", ("foo/b.txt",)),
(),
),
]
Expand Down Expand Up @@ -325,10 +361,10 @@ def test_get_target_data_with_dep_rules(rule_runner: RuleRunner) -> None:
TargetDatas,
[RawSpecs(recursive_globs=(RecursiveGlobSpec("foo"),), description_of_origin="tests")],
)
assert list(tds) == [
assert _normalize_fingerprints(tds) == [
TargetData(
FilesGeneratorTarget({"sources": ["*.txt"]}, Address("foo", target_name="baz")),
("foo/a.txt",),
_snapshot("", ("foo/a.txt",)),
("foo/a.txt:baz",),
dependencies_rules=("does", "apply", "*"),
dependents_rules=("fall-through", "*"),
Expand All @@ -349,7 +385,7 @@ def test_get_target_data_with_dep_rules(rule_runner: RuleRunner) -> None:
FileTarget(
{"source": "a.txt"}, Address("foo", relative_file_path="a.txt", target_name="baz")
),
("foo/a.txt",),
_snapshot("", ("foo/a.txt",)),
(),
dependencies_rules=("does", "apply", "*"),
dependents_rules=("fall-through", "*"),
Expand Down