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.

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

Fix compatibility issues with pytest 8.1 (fixture registration) #680

Merged
merged 5 commits into from
Mar 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:

- name: Install poetry
run: |
python -m pip install poetry==1.6.1
python -m pip install poetry==1.8.2
- name: Configure poetry
run: |
Expand Down
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Changelog

Unreleased
----------
- Address another compatibility issue with pytest 8.1 (fixture registration). `#680 <https://github.com/pytest-dev/pytest-bdd/pull/680>`_

7.1.1
----------
Expand Down
424 changes: 213 additions & 211 deletions poetry.lock

Large diffs are not rendered by default.

57 changes: 56 additions & 1 deletion src/pytest_bdd/compat.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,75 @@

from collections.abc import Sequence
from importlib.metadata import version
from typing import Any

from _pytest.fixtures import FixtureDef, FixtureManager
from _pytest.fixtures import FixtureDef, FixtureManager, FixtureRequest
from _pytest.nodes import Node
from packaging.version import parse as parse_version

pytest_version = parse_version(version("pytest"))

__all__ = ["getfixturedefs", "inject_fixture"]

if pytest_version.release >= (8, 1):

def getfixturedefs(fixturemanager: FixtureManager, fixturename: str, node: Node) -> Sequence[FixtureDef] | None:
return fixturemanager.getfixturedefs(fixturename, node)

def inject_fixture(request: FixtureRequest, arg: str, value: Any) -> None:
"""Inject fixture into pytest fixture request.
:param request: pytest fixture request
:param arg: argument name
:param value: argument value
"""

request._fixturemanager._register_fixture(
name=arg,
func=lambda: value,
nodeid=request.node.nodeid,
)
Comment on lines +20 to +32
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (edge_case_not_handled): The implementation of inject_fixture for pytest versions >= 8.1 seems to lack error handling or validation for the inputs. Consider adding checks to ensure that the request, arg, and value parameters meet expected conditions or constraints.


else:

def getfixturedefs(fixturemanager: FixtureManager, fixturename: str, node: Node) -> Sequence[FixtureDef] | None:
return fixturemanager.getfixturedefs(fixturename, node.nodeid)

def inject_fixture(request: FixtureRequest, arg: str, value: Any) -> None:
"""Inject fixture into pytest fixture request.
:param request: pytest fixture request
:param arg: argument name
:param value: argument value
"""
fd = FixtureDef(
fixturemanager=request._fixturemanager,
baseid=None,
argname=arg,
func=lambda: value,
scope="function",
params=None,
)
fd.cached_result = (value, 0, None)

old_fd = request._fixture_defs.get(arg)
add_fixturename = arg not in request.fixturenames

def fin() -> None:
request._fixturemanager._arg2fixturedefs[arg].remove(fd)

if old_fd is not None:
request._fixture_defs[arg] = old_fd

if add_fixturename:
request._pyfuncitem._fixtureinfo.names_closure.remove(arg)

request.addfinalizer(fin)

# inject fixture definition
request._fixturemanager._arg2fixturedefs.setdefault(arg, []).append(fd)

# inject fixture value in request cache
request._fixture_defs[arg] = fd
if add_fixturename:
request._pyfuncitem._fixtureinfo.names_closure.append(arg)
4 changes: 2 additions & 2 deletions src/pytest_bdd/scenario.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
from typing_extensions import ParamSpec

from . import exceptions
from .compat import getfixturedefs
from .compat import getfixturedefs, inject_fixture
from .feature import get_feature, get_features
from .steps import StepFunctionContext, get_step_fixture_name, inject_fixture
from .steps import StepFunctionContext, get_step_fixture_name
from .utils import CONFIG_STACK, get_args, get_caller_module_locals, get_caller_module_path

if TYPE_CHECKING:
Expand Down
44 changes: 2 additions & 42 deletions src/pytest_bdd/steps.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ def _(article):
from typing import Any, Callable, Iterable, Literal, TypeVar

import pytest
from _pytest.fixtures import FixtureDef, FixtureRequest
from _pytest.fixtures import FixtureRequest
from typing_extensions import ParamSpec

from . import compat
from .parser import Step
from .parsers import StepParser, get_parser
from .types import GIVEN, THEN, WHEN
Expand Down Expand Up @@ -200,44 +201,3 @@ def find_unique_name(name: str, seen: Iterable[str]) -> str:
new_name = f"{name}_{i}"
if new_name not in seen:
return new_name


def inject_fixture(request: FixtureRequest, arg: str, value: Any) -> None:
"""Inject fixture into pytest fixture request.
:param request: pytest fixture request
:param arg: argument name
:param value: argument value
"""

fd = FixtureDef(
fixturemanager=request._fixturemanager,
baseid=None,
argname=arg,
func=lambda: value,
scope="function",
params=None,
)
fd.cached_result = (value, 0, None)

old_fd = request._fixture_defs.get(arg)
add_fixturename = arg not in request.fixturenames

def fin() -> None:
request._fixturemanager._arg2fixturedefs[arg].remove(fd)

if old_fd is not None:
request._fixture_defs[arg] = old_fd

if add_fixturename:
request._pyfuncitem._fixtureinfo.names_closure.remove(arg)

request.addfinalizer(fin)

# inject fixture definition
request._fixturemanager._arg2fixturedefs.setdefault(arg, []).append(fd)

# inject fixture value in request cache
request._fixture_defs[arg] = fd
if add_fixturename:
request._pyfuncitem._fixtureinfo.names_closure.append(arg)
6 changes: 4 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tox]
distshare = {homedir}/.tox/distshare
envlist = py{3.8,3.9,3.10,3.11}-pytest{6.2,7.0,7.1,7.2,7.3,7.4,latest}-coverage
py{3.12,3.13}-pytest{7.3,7.4,latest}-coverage
envlist = py{3.8,3.9,3.10,3.11}-pytest{6.2,7.0,7.1,7.2,7.3,7.4,8.0,8.1,latest}-coverage
py{3.12,3.13}-pytest{7.3,7.4,8.0,8.1,latest}-coverage
py3.12-pytestlatest-xdist-coverage
mypy

Expand All @@ -12,6 +12,8 @@ setenv =
xdist: _PYTEST_MORE_ARGS=-n3 -rfsxX
deps =
pytestlatest: pytest
pytest8.1: pytest~=8.1.0
pytest8.0: pytest~=8.0.0
pytest7.4: pytest~=7.4.0
pytest7.3: pytest~=7.3.0
pytest7.2: pytest~=7.2.0
Expand Down
Loading