21552830208

Committed 31 Jan 2026 11:40PM UTC coverage: 80.277% (-0.05%) from 80.324%

Build # 21552830208

Build Type

Pull #23062

github

Committed by

web-flow

Commit Message

Merge 808a9786c into 2c4dcf9cf

Pull Request Pull Request #23062: Remove support for Get

Run Details

18 of 25 new or added lines in 4 files covered. (72.0%)

17119 existing lines in 541 files now uncovered.

78278 of 97510 relevant lines covered (80.28%)

3.36 hits per line

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

100.0

/src/python/pants/backend/tools/taplo/rules_integration_test.py

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

from typing import Any

import pytest

from pants.backend.tools.taplo.rules import TaploFmtRequest
from pants.backend.tools.taplo.rules import rules as taplo_rules
from pants.core.goals.fmt import FmtResult, Partitions
from pants.core.util_rules import config_files, external_tool
from pants.engine.fs import PathGlobs
from pants.engine.internals.native_engine import Snapshot
from pants.testutil.rule_runner import QueryRule, RuleRunner


@pytest.fixture
def rule_runner() -> RuleRunner:
    return RuleRunner(
        rules=[
            *taplo_rules(),
            *config_files.rules(),
            *external_tool.rules(),
            QueryRule(Partitions, [TaploFmtRequest.PartitionRequest]),
            QueryRule(FmtResult, [TaploFmtRequest.Batch]),
        ],
    )


GOOD_FILE = """[GLOBAL]\nbackend_packages = ["pants.backend.tools.taplo"]\n"""
BAD_FILE = """[GLOBAL]\nbackend_packages = [\n  "pants.backend.tools.taplo",\n]\n"""
NEEDS_CONFIG_FILE = """[GLOBAL]\npants_version = "2.17.0"\n"""
FIXED_NEEDS_CONFIG_FILE = """[GLOBAL]\npants_version="2.17.0"\n"""


def run_taplo(
    rule_runner: RuleRunner,
    *,
    extra_args: list[str] | None = None,
) -> FmtResult:
    rule_runner.set_options(
        ["--backend-packages=pants.backend.tools.taplo", *(extra_args or ())],
    )
    snapshot = rule_runner.request(Snapshot, [PathGlobs(["**", "!BUILDROOT"])])
    partition = rule_runner.request(
        Partitions[Any], [TaploFmtRequest.PartitionRequest(snapshot.files)]
    )[0]
    fmt_result = rule_runner.request(
        FmtResult,
        [
            TaploFmtRequest.Batch(
                "", partition.elements, partition_metadata=partition.metadata, snapshot=snapshot
            ),
        ],
    )
    return fmt_result


def test_no_changes_needed(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"f.toml": GOOD_FILE, "sub/g.toml": GOOD_FILE})
    fmt_result = run_taplo(rule_runner)
    assert not fmt_result.stdout
    assert "found files total=2" in fmt_result.stderr
    assert fmt_result.output == rule_runner.make_snapshot(
        {"f.toml": GOOD_FILE, "sub/g.toml": GOOD_FILE}
    )
    assert fmt_result.did_change is False


@pytest.mark.platform_specific_behavior
def test_changes_needed(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"f.toml": BAD_FILE, "sub/g.toml": BAD_FILE})
    fmt_result = run_taplo(rule_runner)
    assert not fmt_result.stdout
    assert "found files total=2" in fmt_result.stderr
    assert fmt_result.output == rule_runner.make_snapshot(
        {"f.toml": GOOD_FILE, "sub/g.toml": GOOD_FILE}
    )
    assert fmt_result.did_change is True


def test_globs(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"f.toml": BAD_FILE, "g.toml": BAD_FILE})
    fmt_result = run_taplo(rule_runner, extra_args=["--taplo-glob-pattern=['f.toml', '!g.toml']"])
    assert not fmt_result.stdout
    assert "found files total=1" in fmt_result.stderr
    assert fmt_result.output == rule_runner.make_snapshot({"f.toml": GOOD_FILE})


def test_config_files(rule_runner: RuleRunner) -> None:
    rule_runner.write_files(
        {
            "a/f.toml": NEEDS_CONFIG_FILE,
            ".taplo.toml": "[formatting]\ncompact_entries = true\n",
            "b/f.toml": NEEDS_CONFIG_FILE,
        }
    )
    fmt_result = run_taplo(rule_runner)
    assert not fmt_result.stdout
    assert "found files total=2" in fmt_result.stderr
    assert fmt_result.output == rule_runner.make_snapshot(
        {
            "a/f.toml": FIXED_NEEDS_CONFIG_FILE,
            "b/f.toml": FIXED_NEEDS_CONFIG_FILE,
        }
    )
    assert fmt_result.did_change


def test_passthrough_args(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"f.toml": NEEDS_CONFIG_FILE})
    fmt_result = run_taplo(rule_runner, extra_args=["--taplo-args='--option=compact_entries=true'"])
    assert not fmt_result.stdout
    assert "found files total=1" in fmt_result.stderr
    assert fmt_result.output == rule_runner.make_snapshot({"f.toml": FIXED_NEEDS_CONFIG_FILE})
    assert fmt_result.did_change

1	# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3	from __future__ import annotations	3✔
4
5	from typing import Any	3✔
6
7	import pytest	3✔
8
9	from pants.backend.tools.taplo.rules import TaploFmtRequest	3✔
10	from pants.backend.tools.taplo.rules import rules as taplo_rules	3✔
11	from pants.core.goals.fmt import FmtResult, Partitions	3✔
12	from pants.core.util_rules import config_files, external_tool	3✔
13	from pants.engine.fs import PathGlobs	3✔
14	from pants.engine.internals.native_engine import Snapshot	3✔
15	from pants.testutil.rule_runner import QueryRule, RuleRunner	3✔
16
17
18	@pytest.fixture	3✔
19	def rule_runner() -> RuleRunner:	3✔
20	return RuleRunner(	3✔
21	rules=[
22	*taplo_rules(),
23	*config_files.rules(),
24	*external_tool.rules(),
25	QueryRule(Partitions, [TaploFmtRequest.PartitionRequest]),
26	QueryRule(FmtResult, [TaploFmtRequest.Batch]),
27	],
28	)
29
30
31	GOOD_FILE = """[GLOBAL]\nbackend_packages = ["pants.backend.tools.taplo"]\n"""	3✔
32	BAD_FILE = """[GLOBAL]\nbackend_packages = [\n "pants.backend.tools.taplo",\n]\n"""	3✔
33	NEEDS_CONFIG_FILE = """[GLOBAL]\npants_version = "2.17.0"\n"""	3✔
34	FIXED_NEEDS_CONFIG_FILE = """[GLOBAL]\npants_version="2.17.0"\n"""	3✔
35
36
37	def run_taplo(	3✔
38	rule_runner: RuleRunner,
39	*,
40	extra_args: list[str] \| None = None,
41	) -> FmtResult:
42	rule_runner.set_options(	3✔
43	["--backend-packages=pants.backend.tools.taplo", *(extra_args or ())],
44	)
45	snapshot = rule_runner.request(Snapshot, [PathGlobs(["**", "!BUILDROOT"])])	3✔
46	partition = rule_runner.request(	3✔
47	Partitions[Any], [TaploFmtRequest.PartitionRequest(snapshot.files)]
48	)[0]
49	fmt_result = rule_runner.request(	3✔
50	FmtResult,
51	[
52	TaploFmtRequest.Batch(
53	"", partition.elements, partition_metadata=partition.metadata, snapshot=snapshot
54	),
55	],
56	)
57	return fmt_result	3✔
58
59
60	def test_no_changes_needed(rule_runner: RuleRunner) -> None:	3✔
UNCOV 61	rule_runner.write_files({"f.toml": GOOD_FILE, "sub/g.toml": GOOD_FILE})	1✔
UNCOV 62	fmt_result = run_taplo(rule_runner)	1✔
UNCOV 63	assert not fmt_result.stdout	1✔
UNCOV 64	assert "found files total=2" in fmt_result.stderr	1✔
UNCOV 65	assert fmt_result.output == rule_runner.make_snapshot(	1✔
66	{"f.toml": GOOD_FILE, "sub/g.toml": GOOD_FILE}
67	)
UNCOV 68	assert fmt_result.did_change is False	1✔
69
70
71	@pytest.mark.platform_specific_behavior	3✔
72	def test_changes_needed(rule_runner: RuleRunner) -> None:	3✔
73	rule_runner.write_files({"f.toml": BAD_FILE, "sub/g.toml": BAD_FILE})	3✔
74	fmt_result = run_taplo(rule_runner)	3✔
75	assert not fmt_result.stdout	3✔
76	assert "found files total=2" in fmt_result.stderr	3✔
77	assert fmt_result.output == rule_runner.make_snapshot(	3✔
78	{"f.toml": GOOD_FILE, "sub/g.toml": GOOD_FILE}
79	)
80	assert fmt_result.did_change is True	3✔
81
82
83	def test_globs(rule_runner: RuleRunner) -> None:	3✔
UNCOV 84	rule_runner.write_files({"f.toml": BAD_FILE, "g.toml": BAD_FILE})	1✔
UNCOV 85	fmt_result = run_taplo(rule_runner, extra_args=["--taplo-glob-pattern=['f.toml', '!g.toml']"])	1✔
UNCOV 86	assert not fmt_result.stdout	1✔
UNCOV 87	assert "found files total=1" in fmt_result.stderr	1✔
UNCOV 88	assert fmt_result.output == rule_runner.make_snapshot({"f.toml": GOOD_FILE})	1✔
89
90
91	def test_config_files(rule_runner: RuleRunner) -> None:	3✔
UNCOV 92	rule_runner.write_files(	1✔
93	{
94	"a/f.toml": NEEDS_CONFIG_FILE,
95	".taplo.toml": "[formatting]\ncompact_entries = true\n",
96	"b/f.toml": NEEDS_CONFIG_FILE,
97	}
98	)
UNCOV 99	fmt_result = run_taplo(rule_runner)	1✔
UNCOV 100	assert not fmt_result.stdout	1✔
UNCOV 101	assert "found files total=2" in fmt_result.stderr	1✔
UNCOV 102	assert fmt_result.output == rule_runner.make_snapshot(	1✔
103	{
104	"a/f.toml": FIXED_NEEDS_CONFIG_FILE,
105	"b/f.toml": FIXED_NEEDS_CONFIG_FILE,
106	}
107	)
UNCOV 108	assert fmt_result.did_change	1✔
109
110
111	def test_passthrough_args(rule_runner: RuleRunner) -> None:	3✔
UNCOV 112	rule_runner.write_files({"f.toml": NEEDS_CONFIG_FILE})	1✔
UNCOV 113	fmt_result = run_taplo(rule_runner, extra_args=["--taplo-args='--option=compact_entries=true'"])	1✔
UNCOV 114	assert not fmt_result.stdout	1✔
UNCOV 115	assert "found files total=1" in fmt_result.stderr	1✔
UNCOV 116	assert fmt_result.output == rule_runner.make_snapshot({"f.toml": FIXED_NEEDS_CONFIG_FILE})	1✔
UNCOV 117	assert fmt_result.did_change	1✔

pantsbuild / pants / 21552830208

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