18252174847

Committed 05 Oct 2025 01:36AM UTC coverage: 43.382% (-36.9%) from 80.261%

Build # 18252174847

Build Type

push

github

Committed by

web-flow

Commit Message

run tests on mac arm (#22717)

Just doing the minimal to pull forward the x86_64 pattern.

ref #20993

Run Details

25776 of 59416 relevant lines covered (43.38%)

1.3 hits per line

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

68.25

/src/python/pants/backend/python/lint/yapf/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

import pytest

from pants.backend.python import target_types_rules
from pants.backend.python.lint.yapf.rules import YapfFieldSet, YapfRequest
from pants.backend.python.lint.yapf.rules import rules as yapf_rules
from pants.backend.python.lint.yapf.subsystem import Yapf
from pants.backend.python.lint.yapf.subsystem import rules as yapf_subsystem_rules
from pants.backend.python.target_types import PythonSourcesGeneratorTarget
from pants.core.goals.fmt import FmtResult
from pants.core.util_rules import config_files, source_files
from pants.core.util_rules.source_files import SourceFiles, SourceFilesRequest
from pants.engine.addresses import Address
from pants.engine.target import Target
from pants.testutil.python_interpreter_selection import all_major_minor_python_versions
from pants.testutil.rule_runner import QueryRule, RuleRunner


@pytest.fixture
def rule_runner() -> RuleRunner:
    return RuleRunner(
        rules=[
            *yapf_rules(),
            *yapf_subsystem_rules(),
            *source_files.rules(),
            *config_files.rules(),
            *target_types_rules.rules(),
            QueryRule(FmtResult, (YapfRequest.Batch,)),
            QueryRule(SourceFiles, (SourceFilesRequest,)),
        ],
        target_types=[PythonSourcesGeneratorTarget],
    )


GOOD_FILE = "data = []\n"
BAD_FILE = "data = {  'a':11,'b':22    }\n"
FIXED_BAD_FILE = "data = {'a': 11, 'b': 22}\n"

# Note the indentation is 6 spaces; after formatting it should
# become 2 or 4 spaces depending on the configuration
NEEDS_CONFIG_FILE = "def func():\n      return 42\n"
FIXED_NEEDS_CONFIG_FILE_INDENT2 = "def func():\n  return 42\n"
FIXED_NEEDS_CONFIG_FILE_INDENT4 = "def func():\n    return 42\n"


def run_yapf(
    rule_runner: RuleRunner,
    targets: list[Target],
    *,
    extra_args: list[str] | None = None,
) -> FmtResult:
    rule_runner.set_options(
        ["--backend-packages=pants.backend.python.lint.yapf", *(extra_args or ())],
        env_inherit={"PATH", "PYENV_ROOT", "HOME"},
    )
    field_sets = [YapfFieldSet.create(tgt) for tgt in targets]
    input_sources = rule_runner.request(
        SourceFiles,
        [
            SourceFilesRequest(field_set.source for field_set in field_sets),
        ],
    )
    fmt_result = rule_runner.request(
        FmtResult,
        [
            YapfRequest.Batch(
                "",
                input_sources.snapshot.files,
                partition_metadata=None,
                snapshot=input_sources.snapshot,
            ),
        ],
    )
    return fmt_result


@pytest.mark.platform_specific_behavior
@pytest.mark.parametrize(
    "major_minor_interpreter",
    all_major_minor_python_versions(Yapf.default_interpreter_constraints),
)
def test_passing(rule_runner: RuleRunner, major_minor_interpreter: str) -> None:
    rule_runner.write_files({"f.py": GOOD_FILE, "BUILD": "python_sources(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))
    fmt_result = run_yapf(
        rule_runner,
        [tgt],
        extra_args=[f"--yapf-interpreter-constraints=['=={major_minor_interpreter}.*']"],
    )
    assert fmt_result.output == rule_runner.make_snapshot({"f.py": GOOD_FILE})
    assert fmt_result.did_change is False


def test_failing(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"f.py": BAD_FILE, "BUILD": "python_sources(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))
    fmt_result = run_yapf(rule_runner, [tgt])
    assert fmt_result.output == rule_runner.make_snapshot({"f.py": FIXED_BAD_FILE})
    assert fmt_result.did_change is True


def test_multiple_targets(rule_runner: RuleRunner) -> None:
    rule_runner.write_files(
        {"good.py": GOOD_FILE, "bad.py": BAD_FILE, "BUILD": "python_sources(name='t')"}
    )
    tgts = [
        rule_runner.get_target(Address("", target_name="t", relative_file_path="good.py")),
        rule_runner.get_target(Address("", target_name="t", relative_file_path="bad.py")),
    ]
    fmt_result = run_yapf(rule_runner, tgts)
    assert fmt_result.output == rule_runner.make_snapshot(
        {"good.py": GOOD_FILE, "bad.py": FIXED_BAD_FILE}
    )
    assert fmt_result.did_change is True


@pytest.mark.parametrize(
    "path,section,extra_args",
    (
        (".style.yapf", "style", []),
        ("custom.style", "style", ["--yapf-config=custom.style"]),
    ),
)
def test_config_file(
    rule_runner: RuleRunner, path: str, section: str, extra_args: list[str]
) -> None:
    rule_runner.write_files(
        {
            "f.py": NEEDS_CONFIG_FILE,
            "BUILD": "python_sources(name='t', interpreter_constraints=['==3.9.*'])",
            path: f"[{section}]\nindent_width = 2\n",
        }
    )
    tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))
    fmt_result = run_yapf(rule_runner, [tgt], extra_args=extra_args)
    assert fmt_result.output == rule_runner.make_snapshot({"f.py": FIXED_NEEDS_CONFIG_FILE_INDENT2})
    assert fmt_result.did_change is True


def test_passthrough_args(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"f.py": NEEDS_CONFIG_FILE, "BUILD": "python_sources(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))
    fmt_result = run_yapf(
        rule_runner, [tgt], extra_args=["--yapf-args=--style='{indent_width: 4}'"]
    )
    assert fmt_result.output == rule_runner.make_snapshot({"f.py": FIXED_NEEDS_CONFIG_FILE_INDENT4})
    assert fmt_result.did_change is True

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	3✔
5
6	import pytest	3✔
7
8	from pants.backend.python import target_types_rules	3✔
9	from pants.backend.python.lint.yapf.rules import YapfFieldSet, YapfRequest	3✔
10	from pants.backend.python.lint.yapf.rules import rules as yapf_rules	3✔
11	from pants.backend.python.lint.yapf.subsystem import Yapf	3✔
12	from pants.backend.python.lint.yapf.subsystem import rules as yapf_subsystem_rules	3✔
13	from pants.backend.python.target_types import PythonSourcesGeneratorTarget	3✔
14	from pants.core.goals.fmt import FmtResult	3✔
15	from pants.core.util_rules import config_files, source_files	3✔
16	from pants.core.util_rules.source_files import SourceFiles, SourceFilesRequest	3✔
17	from pants.engine.addresses import Address	3✔
18	from pants.engine.target import Target	3✔
19	from pants.testutil.python_interpreter_selection import all_major_minor_python_versions	3✔
20	from pants.testutil.rule_runner import QueryRule, RuleRunner	3✔
21
22
23	@pytest.fixture	3✔
24	def rule_runner() -> RuleRunner:	3✔
25	return RuleRunner(	3✔
26	rules=[
27	*yapf_rules(),
28	*yapf_subsystem_rules(),
29	*source_files.rules(),
30	*config_files.rules(),
31	*target_types_rules.rules(),
32	QueryRule(FmtResult, (YapfRequest.Batch,)),
33	QueryRule(SourceFiles, (SourceFilesRequest,)),
34	],
35	target_types=[PythonSourcesGeneratorTarget],
36	)
37
38
39	GOOD_FILE = "data = []\n"	3✔
40	BAD_FILE = "data = { 'a':11,'b':22 }\n"	3✔
41	FIXED_BAD_FILE = "data = {'a': 11, 'b': 22}\n"	3✔
42
43	# Note the indentation is 6 spaces; after formatting it should
44	# become 2 or 4 spaces depending on the configuration
45	NEEDS_CONFIG_FILE = "def func():\n return 42\n"	3✔
46	FIXED_NEEDS_CONFIG_FILE_INDENT2 = "def func():\n return 42\n"	3✔
47	FIXED_NEEDS_CONFIG_FILE_INDENT4 = "def func():\n return 42\n"	3✔
48
49
50	def run_yapf(	3✔
51	rule_runner: RuleRunner,
52	targets: list[Target],
53	*,
54	extra_args: list[str] \| None = None,
55	) -> FmtResult:
56	rule_runner.set_options(	3✔
57	["--backend-packages=pants.backend.python.lint.yapf", *(extra_args or ())],
58	env_inherit={"PATH", "PYENV_ROOT", "HOME"},
59	)
60	field_sets = [YapfFieldSet.create(tgt) for tgt in targets]	3✔
61	input_sources = rule_runner.request(	3✔
62	SourceFiles,
63	[
64	SourceFilesRequest(field_set.source for field_set in field_sets),
65	],
66	)
67	fmt_result = rule_runner.request(	3✔
68	FmtResult,
69	[
70	YapfRequest.Batch(
71	"",
72	input_sources.snapshot.files,
73	partition_metadata=None,
74	snapshot=input_sources.snapshot,
75	),
76	],
77	)
78	return fmt_result	3✔
79
80
81	@pytest.mark.platform_specific_behavior	3✔
82	@pytest.mark.parametrize(	3✔
83	"major_minor_interpreter",
84	all_major_minor_python_versions(Yapf.default_interpreter_constraints),
85	)
86	def test_passing(rule_runner: RuleRunner, major_minor_interpreter: str) -> None:	3✔
87	rule_runner.write_files({"f.py": GOOD_FILE, "BUILD": "python_sources(name='t')"})	3✔
88	tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))	3✔
89	fmt_result = run_yapf(	3✔
90	rule_runner,
91	[tgt],
92	extra_args=[f"--yapf-interpreter-constraints=['=={major_minor_interpreter}.*']"],
93	)
94	assert fmt_result.output == rule_runner.make_snapshot({"f.py": GOOD_FILE})	3✔
95	assert fmt_result.did_change is False	3✔
96
97
98	def test_failing(rule_runner: RuleRunner) -> None:	3✔
99	rule_runner.write_files({"f.py": BAD_FILE, "BUILD": "python_sources(name='t')"})	×
100	tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))	×
101	fmt_result = run_yapf(rule_runner, [tgt])	×
102	assert fmt_result.output == rule_runner.make_snapshot({"f.py": FIXED_BAD_FILE})	×
103	assert fmt_result.did_change is True	×
104
105
106	def test_multiple_targets(rule_runner: RuleRunner) -> None:	3✔
107	rule_runner.write_files(	×
108	{"good.py": GOOD_FILE, "bad.py": BAD_FILE, "BUILD": "python_sources(name='t')"}
109	)
110	tgts = [	×
111	rule_runner.get_target(Address("", target_name="t", relative_file_path="good.py")),
112	rule_runner.get_target(Address("", target_name="t", relative_file_path="bad.py")),
113	]
114	fmt_result = run_yapf(rule_runner, tgts)	×
115	assert fmt_result.output == rule_runner.make_snapshot(	×
116	{"good.py": GOOD_FILE, "bad.py": FIXED_BAD_FILE}
117	)
118	assert fmt_result.did_change is True	×
119
120
121	@pytest.mark.parametrize(	3✔
122	"path,section,extra_args",
123	(
124	(".style.yapf", "style", []),
125	("custom.style", "style", ["--yapf-config=custom.style"]),
126	),
127	)
128	def test_config_file(	3✔
129	rule_runner: RuleRunner, path: str, section: str, extra_args: list[str]
130	) -> None:
131	rule_runner.write_files(	×
132	{
133	"f.py": NEEDS_CONFIG_FILE,
134	"BUILD": "python_sources(name='t', interpreter_constraints=['==3.9.*'])",
135	path: f"[{section}]\nindent_width = 2\n",
136	}
137	)
138	tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))	×
139	fmt_result = run_yapf(rule_runner, [tgt], extra_args=extra_args)	×
140	assert fmt_result.output == rule_runner.make_snapshot({"f.py": FIXED_NEEDS_CONFIG_FILE_INDENT2})	×
141	assert fmt_result.did_change is True	×
142
143
144	def test_passthrough_args(rule_runner: RuleRunner) -> None:	3✔
145	rule_runner.write_files({"f.py": NEEDS_CONFIG_FILE, "BUILD": "python_sources(name='t')"})	×
146	tgt = rule_runner.get_target(Address("", target_name="t", relative_file_path="f.py"))	×
147	fmt_result = run_yapf(	×
148	rule_runner, [tgt], extra_args=["--yapf-args=--style='{indent_width: 4}'"]
149	)
150	assert fmt_result.output == rule_runner.make_snapshot({"f.py": FIXED_NEEDS_CONFIG_FILE_INDENT4})	×
151	assert fmt_result.did_change is True	×

pantsbuild / pants / 18252174847

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