Skip to content

Commit

Permalink
Allow ovewriting a parametrized fixture while reusing the parent fixt…
Browse files Browse the repository at this point in the history
…ure's value

Fix pytest-dev#1953
  • Loading branch information
nicoddemus committed Sep 11, 2020
1 parent 9c0e0c7 commit fa1e088
Show file tree
Hide file tree
Showing 3 changed files with 140 additions and 26 deletions.
20 changes: 20 additions & 0 deletions changelog/1953.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Fix error when overwriting a parametrized fixture, while also reusing the super fixture value.

.. code-block:: python
# conftest.py
import pytest
@pytest.fixture(params=[1, 2])
def foo(request):
return request.param
# test_foo.py
import pytest
@pytest.fixture
def foo(foo):
return foo * 2
54 changes: 28 additions & 26 deletions src/_pytest/fixtures.py
Original file line number Diff line number Diff line change
Expand Up @@ -1529,34 +1529,36 @@ def sort_by_scope(arg_name: str) -> int:
return initialnames, fixturenames_closure, arg2fixturedefs

def pytest_generate_tests(self, metafunc: "Metafunc") -> None:
"""Generate new tests based on parametrized fixtures used by the given metafunc"""
for argname in metafunc.fixturenames:
faclist = metafunc._arg2fixturedefs.get(argname)
if faclist:
fixturedef = faclist[-1]
# Get the FixtureDefs for the argname.
fixture_defs = metafunc._arg2fixturedefs.get(argname)
if not fixture_defs:
# Will raise FixtureLookupError at setup time if not parametrized somewhere
# else (e.g @pytest.mark.parametrize)
continue

# In the common case we only look at the fixture def with the
# closest scope (last in the list). But if the fixture overrides
# another fixture, while requesting the super fixture, keep going
# in case the super fixture is parametrized (#1953).
for fixturedef in reversed(fixture_defs):
# Fixture is parametrized, apply it and stop.
if fixturedef.params is not None:
markers = list(metafunc.definition.iter_markers("parametrize"))
for parametrize_mark in markers:
if "argnames" in parametrize_mark.kwargs:
argnames = parametrize_mark.kwargs["argnames"]
else:
argnames = parametrize_mark.args[0]

if not isinstance(argnames, (tuple, list)):
argnames = [
x.strip() for x in argnames.split(",") if x.strip()
]
if argname in argnames:
break
else:
metafunc.parametrize(
argname,
fixturedef.params,
indirect=True,
scope=fixturedef.scope,
ids=fixturedef.ids,
)
else:
continue # Will raise FixtureLookupError at setup time.
metafunc.parametrize(
argname,
fixturedef.params,
indirect=True,
scope=fixturedef.scope,
ids=fixturedef.ids,
)
break

# Not requesting the overridden super fixture, stop.
if argname not in fixturedef.argnames:
break

continue # try super fixture, if any.

def pytest_collection_modifyitems(self, items: "List[nodes.Item]") -> None:
# Separate parametrized setups.
Expand Down
92 changes: 92 additions & 0 deletions testing/python/fixtures.py
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,98 @@ def test_spam(spam):
result = testdir.runpytest(testfile)
result.stdout.fnmatch_lines(["*3 passed*"])

def test_override_fixture_reusing_super_fixture_parametrization(self, testdir):
"""Override a fixture at a lower level, reusing the higher-level fixture that
is parametrized (#1953).
"""
testdir.makeconftest(
"""
import pytest
@pytest.fixture(params=[1, 2])
def foo(request):
return request.param
"""
)
testdir.makepyfile(
"""
import pytest
@pytest.fixture
def foo(foo):
return foo * 2
def test_spam(foo):
assert foo in (2, 4)
"""
)
result = testdir.runpytest()
result.stdout.fnmatch_lines(["*2 passed*"])

def test_override_top_level_fixture_reusing_super_fixture_parametrization(
self, testdir
):
"""Same as the above test, but with another level of overwriting."""
testdir.makeconftest(
"""
import pytest
@pytest.fixture(params=['unused', 'unused'])
def foo(request):
return request.param
"""
)
testdir.makepyfile(
"""
import pytest
@pytest.fixture(params=[1, 2])
def foo(request):
return request.param
class Test:
@pytest.fixture
def foo(self, foo):
return foo * 2
def test_spam(self, foo):
assert foo in (2, 4)
"""
)
result = testdir.runpytest()
result.stdout.fnmatch_lines(["*2 passed*"])

def test_override_parametrized_fixture_with_new_parametrized_fixture(self, testdir):
"""Overriding a parametrized fixture, while also parametrizing the new fixture and
simultaneously requesting the overwritten fixture as parameter, yields the same value
as ``request.param``.
"""
testdir.makeconftest(
"""
import pytest
@pytest.fixture(params=['ignored', 'ignored'])
def foo(request):
return request.param
"""
)
testdir.makepyfile(
"""
import pytest
@pytest.fixture(params=[10, 20])
def foo(foo, request):
assert request.param == foo
return foo * 2
def test_spam(foo):
assert foo in (20, 40)
"""
)
result = testdir.runpytest()
result.stdout.fnmatch_lines(["*2 passed*"])

def test_autouse_fixture_plugin(self, testdir):
# A fixture from a plugin has no baseid set, which screwed up
# the autouse fixture handling.
Expand Down

0 comments on commit fa1e088

Please sign in to comment.