18791134616

Committed 24 Oct 2025 08:18PM UTC coverage: 75.519% (-4.8%) from 80.282%

Build # 18791134616

Build Type

Pull #22794

github

Committed by

web-flow

Commit Message

Merge 098c595a0 into 7971a20bf

Pull Request Pull Request #22794: Use self-hosted MacOS Intel runner

Run Details

65803 of 87134 relevant lines covered (75.52%)

3.07 hits per line

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

83.64

/src/python/pants/backend/python/subsystems/pytest.py

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

from __future__ import annotations

import os.path
from collections.abc import Iterable
from dataclasses import dataclass

from pants.backend.python.subsystems.python_tool_base import PythonToolBase
from pants.backend.python.target_types import (
    ConsoleScript,
    InterpreterConstraintsField,
    PythonResolveField,
    PythonTestsBatchCompatibilityTagField,
    PythonTestsExtraEnvVarsField,
    PythonTestSourceField,
    PythonTestsTimeoutField,
    PythonTestsXdistConcurrencyField,
    SkipPythonTestsField,
)
from pants.core.environments.target_types import EnvironmentField
from pants.core.goals.resolves import ExportableTool
from pants.core.goals.test import RuntimePackageDependenciesField, TestFieldSet
from pants.core.util_rules.config_files import ConfigFilesRequest
from pants.engine.rules import collect_rules
from pants.engine.target import Target
from pants.engine.unions import UnionRule
from pants.option.option_types import ArgsListOption, BoolOption, FileOption, SkipOption, StrOption
from pants.util.strutil import softwrap


@dataclass(frozen=True)
class PythonTestFieldSet(TestFieldSet):
    required_fields = (PythonTestSourceField,)

    source: PythonTestSourceField
    interpreter_constraints: InterpreterConstraintsField
    timeout: PythonTestsTimeoutField
    runtime_package_dependencies: RuntimePackageDependenciesField
    extra_env_vars: PythonTestsExtraEnvVarsField
    xdist_concurrency: PythonTestsXdistConcurrencyField
    batch_compatibility_tag: PythonTestsBatchCompatibilityTagField
    resolve: PythonResolveField
    environment: EnvironmentField

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


class PyTest(PythonToolBase):
    options_scope = "pytest"
    name = "Pytest"
    help_short = "The pytest Python test framework (https://docs.pytest.org/)."

    default_requirements = [
        "pytest>=7,<9,!=7.1.0,!=7.1.1",
        "pytest-cov>=5,<7",
        "pytest-xdist>=3.6.1,<4",
    ]

    default_main = ConsoleScript("pytest")

    default_lockfile_resource = ("pants.backend.python.subsystems", "pytest.lock")

    args = ArgsListOption(example="-k test_foo --quiet", passthrough=True)
    junit_family = StrOption(
        default="xunit2",
        advanced=True,
        help=softwrap(
            """
            The format of generated junit XML files. See
            https://docs.pytest.org/en/latest/reference.html#confval-junit_family.
            """
        ),
    )
    execution_slot_var = StrOption(
        default=None,
        advanced=True,
        help=softwrap(
            """
            If a non-empty string, the process execution slot id (an integer) will be exposed
            to tests under this environment variable name.
            """
        ),
    )
    config = FileOption(
        default=None,
        advanced=True,
        help=lambda cls: softwrap(
            f"""
            Path to a config file understood by Pytest
            (https://docs.pytest.org/en/latest/reference/customize.html#configuration-file-formats).
            Setting this option will disable `[{cls.options_scope}].config_discovery`. Use
            this option if the config is located in a non-standard location.
            """
        ),
    )
    config_discovery = BoolOption(
        default=True,
        advanced=True,
        help=lambda cls: softwrap(
            f"""
            If true, Pants will include all relevant Pytest config files (e.g. `pytest.ini`)
            during runs. See
            https://docs.pytest.org/en/stable/customize.html#finding-the-rootdir for where
            config files should be located for Pytest to discover them.

            Use `[{cls.options_scope}].config` instead if your config is in a
            non-standard location.
            """
        ),
    )
    xdist_enabled = BoolOption(
        default=False,
        advanced=False,
        help=softwrap(
            """
            If true, Pants will use `pytest-xdist` (https://pytest-xdist.readthedocs.io/en/latest/)
            to parallelize tests within each `python_test` target.

            NOTE: Enabling `pytest-xdist` can cause high-level scoped fixtures (for example `session`)
            to execute more than once. See the `pytest-xdist` docs for more info:
            https://pypi.org/project/pytest-xdist/#making-session-scoped-fixtures-execute-only-once
            """
        ),
    )

    skip = SkipOption("test")

    def config_request(self, dirs: Iterable[str]) -> ConfigFilesRequest:
        # Refer to https://docs.pytest.org/en/stable/customize.html#finding-the-rootdir for how
        # config files are discovered.
        check_existence = []
        check_content = {}
        for d in ("", *dirs):
            check_existence.append(os.path.join(d, "pytest.ini"))
            check_content[os.path.join(d, "pyproject.toml")] = b"[tool.pytest.ini_options]"
            check_content[os.path.join(d, "tox.ini")] = b"[pytest]"
            check_content[os.path.join(d, "setup.cfg")] = b"[tool:pytest]"

        return ConfigFilesRequest(
            specified=self.config,
            specified_option_name=f"[{self.options_scope}].config",
            discovery=self.config_discovery,
            check_existence=check_existence,
            check_content=check_content,
        )


def rules():
    return (
        *collect_rules(),
        UnionRule(ExportableTool, PyTest),
    )

1	# Copyright 2016 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	8✔
5
6	import os.path	8✔
7	from collections.abc import Iterable	8✔
8	from dataclasses import dataclass	8✔
9
10	from pants.backend.python.subsystems.python_tool_base import PythonToolBase	8✔
11	from pants.backend.python.target_types import (	8✔
12	ConsoleScript,
13	InterpreterConstraintsField,
14	PythonResolveField,
15	PythonTestsBatchCompatibilityTagField,
16	PythonTestsExtraEnvVarsField,
17	PythonTestSourceField,
18	PythonTestsTimeoutField,
19	PythonTestsXdistConcurrencyField,
20	SkipPythonTestsField,
21	)
22	from pants.core.environments.target_types import EnvironmentField	8✔
23	from pants.core.goals.resolves import ExportableTool	8✔
24	from pants.core.goals.test import RuntimePackageDependenciesField, TestFieldSet	8✔
25	from pants.core.util_rules.config_files import ConfigFilesRequest	8✔
26	from pants.engine.rules import collect_rules	8✔
27	from pants.engine.target import Target	8✔
28	from pants.engine.unions import UnionRule	8✔
29	from pants.option.option_types import ArgsListOption, BoolOption, FileOption, SkipOption, StrOption	8✔
30	from pants.util.strutil import softwrap	8✔
31
32
33	@dataclass(frozen=True)	8✔
34	class PythonTestFieldSet(TestFieldSet):	8✔
35	required_fields = (PythonTestSourceField,)	8✔
36
37	source: PythonTestSourceField	8✔
38	interpreter_constraints: InterpreterConstraintsField	8✔
39	timeout: PythonTestsTimeoutField	8✔
40	runtime_package_dependencies: RuntimePackageDependenciesField	8✔
41	extra_env_vars: PythonTestsExtraEnvVarsField	8✔
42	xdist_concurrency: PythonTestsXdistConcurrencyField	8✔
43	batch_compatibility_tag: PythonTestsBatchCompatibilityTagField	8✔
44	resolve: PythonResolveField	8✔
45	environment: EnvironmentField	8✔
46
47	@classmethod	8✔
48	def opt_out(cls, tgt: Target) -> bool:	8✔
49	return tgt.get(SkipPythonTestsField).value	×
50
51
52	class PyTest(PythonToolBase):	8✔
53	options_scope = "pytest"	8✔
54	name = "Pytest"	8✔
55	help_short = "The pytest Python test framework (https://docs.pytest.org/)."	8✔
56
57	default_requirements = [	8✔
58	"pytest>=7,<9,!=7.1.0,!=7.1.1",
59	"pytest-cov>=5,<7",
60	"pytest-xdist>=3.6.1,<4",
61	]
62
63	default_main = ConsoleScript("pytest")	8✔
64
65	default_lockfile_resource = ("pants.backend.python.subsystems", "pytest.lock")	8✔
66
67	args = ArgsListOption(example="-k test_foo --quiet", passthrough=True)	8✔
68	junit_family = StrOption(	8✔
69	default="xunit2",
70	advanced=True,
71	help=softwrap(
72	"""
73	The format of generated junit XML files. See
74	https://docs.pytest.org/en/latest/reference.html#confval-junit_family.
75	"""
76	),
77	)
78	execution_slot_var = StrOption(	8✔
79	default=None,
80	advanced=True,
81	help=softwrap(
82	"""
83	If a non-empty string, the process execution slot id (an integer) will be exposed
84	to tests under this environment variable name.
85	"""
86	),
87	)
88	config = FileOption(	8✔
89	default=None,
90	advanced=True,
91	help=lambda cls: softwrap(
92	f"""
93	Path to a config file understood by Pytest
94	(https://docs.pytest.org/en/latest/reference/customize.html#configuration-file-formats).
95	Setting this option will disable `[{cls.options_scope}].config_discovery`. Use
96	this option if the config is located in a non-standard location.
97	"""
98	),
99	)
100	config_discovery = BoolOption(	8✔
101	default=True,
102	advanced=True,
103	help=lambda cls: softwrap(
104	f"""
105	If true, Pants will include all relevant Pytest config files (e.g. `pytest.ini`)
106	during runs. See
107	https://docs.pytest.org/en/stable/customize.html#finding-the-rootdir for where
108	config files should be located for Pytest to discover them.
109
110	Use `[{cls.options_scope}].config` instead if your config is in a
111	non-standard location.
112	"""
113	),
114	)
115	xdist_enabled = BoolOption(	8✔
116	default=False,
117	advanced=False,
118	help=softwrap(
119	"""
120	If true, Pants will use `pytest-xdist` (https://pytest-xdist.readthedocs.io/en/latest/)
121	to parallelize tests within each `python_test` target.
122
123	NOTE: Enabling `pytest-xdist` can cause high-level scoped fixtures (for example `session`)
124	to execute more than once. See the `pytest-xdist` docs for more info:
125	https://pypi.org/project/pytest-xdist/#making-session-scoped-fixtures-execute-only-once
126	"""
127	),
128	)
129
130	skip = SkipOption("test")	8✔
131
132	def config_request(self, dirs: Iterable[str]) -> ConfigFilesRequest:	8✔
133	# Refer to https://docs.pytest.org/en/stable/customize.html#finding-the-rootdir for how
134	# config files are discovered.
135	check_existence = []	×
136	check_content = {}	×
137	for d in ("", *dirs):	×
138	check_existence.append(os.path.join(d, "pytest.ini"))	×
139	check_content[os.path.join(d, "pyproject.toml")] = b"[tool.pytest.ini_options]"	×
140	check_content[os.path.join(d, "tox.ini")] = b"[pytest]"	×
141	check_content[os.path.join(d, "setup.cfg")] = b"[tool:pytest]"	×
142
143	return ConfigFilesRequest(	×
144	specified=self.config,
145	specified_option_name=f"[{self.options_scope}].config",
146	discovery=self.config_discovery,
147	check_existence=check_existence,
148	check_content=check_content,
149	)
150
151
152	def rules():	8✔
153	return (	6✔
154	*collect_rules(),
155	UnionRule(ExportableTool, PyTest),
156	)

pantsbuild / pants / 18791134616

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