Merge pull request #193 from The-Compiler/pytest30

[WIP] Initial attempt at pytest 3.0 compatibility

Author: olegpidsadnyi

pytest_bdd/scenario.py

@@ -39,7 +39,7 @@
     recreate_function,
 )
 from .types import GIVEN
-from .utils import get_args
+from .utils import get_args, get_fixture_value
 
 if six.PY3:  # pragma: no cover
     import runpy
@@ -71,7 +71,7 @@ def find_argumented_step_fixture_name(name, type_, fixturemanager, request=None)
                 parser_name = get_step_fixture_name(parser.name, type_)
                 if request:
                     try:
-                        request.getfuncargvalue(parser_name)
+                        get_fixture_value(request, parser_name)
                     except pytest_fixtures.FixtureLookupError:
                         continue
                 return parser_name
@@ -89,12 +89,12 @@ def _find_step_function(request, step, scenario, encoding):
     """
     name = step.name
     try:
-        return request.getfuncargvalue(get_step_fixture_name(name, step.type, encoding))
+        return get_fixture_value(request, get_step_fixture_name(name, step.type, encoding))
     except pytest_fixtures.FixtureLookupError:
         try:
             name = find_argumented_step_fixture_name(name, step.type, request._fixturemanager, request)
             if name:
-                return request.getfuncargvalue(name)
+                return get_fixture_value(request, name)
             raise
         except pytest_fixtures.FixtureLookupError:
             raise exceptions.StepDefinitionNotFoundError(
@@ -129,7 +129,7 @@ def _execute_step_function(request, scenario, step, step_func):
     kw["step_func_args"] = {}
     try:
         # Get the step argument values.
-        kwargs = dict((arg, request.getfuncargvalue(arg)) for arg in get_args(step_func))
+        kwargs = dict((arg, get_fixture_value(request, arg)) for arg in get_args(step_func))
         kw["step_func_args"] = kwargs
 
         request.config.hook.pytest_bdd_before_step_call(**kw)

pytest_bdd/steps.py

@@ -49,7 +49,8 @@ def article(author):
     StepError,
 )
 from .parsers import get_parser
-from .utils import get_args
+from .utils import get_args, get_fixture_value, get_fixture_value_raw, set_fixture_value, get_request_fixture_defs, \
+    get_request_fixture_names
 
 
 def get_step_fixture_name(name, type_, encoding=None):
@@ -81,7 +82,7 @@ def given(name, fixture=None, converters=None, scope='function', target_fixture=
         module = get_caller_module()
 
         def step_func(request):
-            return request.getfuncargvalue(fixture)
+            return get_fixture_value(request, fixture)
 
         step_func.step_type = GIVEN
         step_func.converters = converters
@@ -161,7 +162,7 @@ def decorator(func):
                 func = pytest.fixture(scope=scope)(func)
 
             def step_func(request):
-                result = request.getfuncargvalue(func.__name__)
+                result = get_fixture_value(request, func.__name__)
                 if target_fixture:
                     inject_fixture(request, target_fixture, result)
                 return result
@@ -302,23 +303,23 @@ def inject_fixture(request, arg, value):
     fd = pytest_fixtures.FixtureDef(**fd_kwargs)
     fd.cached_result = (value, 0, None)
 
-    old_fd = getattr(request, "_fixturedefs", {}).get(arg)
-    old_value = request._funcargs.get(arg)
+    old_fd = get_request_fixture_defs(request).get(arg)
+    old_value = get_fixture_value_raw(request, arg)
     add_fixturename = arg not in request.fixturenames
 
     def fin():
         request._fixturemanager._arg2fixturedefs[arg].remove(fd)
-        getattr(request, "_fixturedefs", {})[arg] = old_fd
-        request._funcargs[arg] = old_value
+        get_request_fixture_defs(request)[arg] = old_fd
+        set_fixture_value(request, arg, old_value)
         if add_fixturename:
-            request.fixturenames.remove(arg)
+            get_request_fixture_names(request).remove(arg)
 
     request.addfinalizer(fin)
 
     # inject fixture definition
     request._fixturemanager._arg2fixturedefs.setdefault(arg, []).insert(0, fd)
     # inject fixture value in request cache
-    getattr(request, "_fixturedefs", {})[arg] = fd
-    request._funcargs[arg] = value
+    get_request_fixture_defs(request)[arg] = fd
+    set_fixture_value(request, arg, value)
     if add_fixturename:
-        request.fixturenames.append(arg)
+        get_request_fixture_names(request).append(arg)

pytest_bdd/utils.py

@@ -21,3 +21,54 @@ def get_args(func):
                 if param.kind == param.POSITIONAL_OR_KEYWORD]
     else:
         return inspect.getargspec(func).args
+
+
+def get_fixture_value(request, name):
+    """Get the given fixture from the pytest request object.
+
+    getfuncargvalue() is deprecated in pytest 3.0, so we need to use
+    getfixturevalue() there.
+    """
+    try:
+        getfixturevalue = request.getfixturevalue
+    except AttributeError:
+        getfixturevalue = request.getfuncargvalue
+    return getfixturevalue(name)
+
+
+def get_fixture_value_raw(request, name):
+    """Set the given raw fixture value from the pytest request object."""
+    try:
+        return request._fixture_values.get(name)
+    except AttributeError:
+        return request._funcargs.get(name)
+
+
+def set_fixture_value(request, name, value):
+    """Set the given fixture value on the pytest request object."""
+    try:
+        request._fixture_values[name] = value
+    except AttributeError:
+        request._funcargs[name] = value
+
+
+def get_request_fixture_defs(request):
+    """Get the internal list of FixtureDefs cached into the given request object.
+
+    Compatibility with pytest 3.0.
+    """
+    try:
+        return request._fixture_defs
+    except AttributeError:
+        return getattr(request, "_fixturedefs", {})
+
+
+def get_request_fixture_names(request):
+    """Get list of fixture names for the given FixtureRequest.
+
+    Get the internal and mutable list of fixture names in the enclosing scope of
+    the given request object.
+
+    Compatibility with pytest 3.0.
+    """
+    return request._pyfuncitem._fixtureinfo.names_closure

tests/feature/test_cucumber_json.py

@@ -158,7 +158,7 @@ def test_failing():
                     "type": "scenario"
                 }
             ],
-            "id": "test_step_trace0/test.feature",
+            "id": os.path.join("test_step_trace0", "test.feature"),
             "keyword": "Feature",
             "line": 2,
             "name": "One passing scenario, one failing scenario",

tests/feature/test_multiline.py

@@ -10,6 +10,7 @@
     scenario,
     then,
 )
+from pytest_bdd.utils import get_fixture_value
 
 
 @pytest.mark.parametrize(["feature_text", "expected_text"], [
@@ -72,7 +73,7 @@ def test_multiline(request, tmpdir, feature_text, expected_text):
 
     @scenario(file_name.strpath, 'Multiline step using sub indentation')
     def test_multiline(request):
-        assert request.getfuncargvalue('i_have_text') == expected_text
+        assert get_fixture_value(request, 'i_have_text') == expected_text
     test_multiline(request)
 
 

tests/library/child/test_local_override.py

@@ -5,6 +5,7 @@
 
 from pytest_bdd import given
 from pytest_bdd.steps import get_step_fixture_name, GIVEN
+from pytest_bdd.utils import get_fixture_value
 
 
 @given('I have locally overriden fixture')
@@ -21,10 +22,12 @@ def test_override(request, overridable):
     """Test locally overriden fixture."""
 
     # Test the fixture is also collected by the text name
-    assert request.getfuncargvalue(get_step_fixture_name('I have locally overriden fixture', GIVEN))(request) == 'local'
+    fixture = get_fixture_value(request, get_step_fixture_name('I have locally overriden fixture', GIVEN))
+    assert fixture(request) == 'local'
 
     # 'I have the overriden fixture' stands for overridable and is overriden locally
-    assert request.getfuncargvalue(get_step_fixture_name('I have the overriden fixture', GIVEN))(request) == 'local'
+    fixture = get_fixture_value(request, get_step_fixture_name('I have the overriden fixture', GIVEN))
+    assert fixture(request) == 'local'
 
     assert overridable == 'local'
 

tests/library/test_parent.py

@@ -3,6 +3,7 @@
 Check the parent givens are collected and overriden in the local conftest.
 """
 from pytest_bdd.steps import get_step_fixture_name, WHEN
+from pytest_bdd.utils import get_fixture_value
 
 
 def test_parent(parent, overridable):
@@ -16,4 +17,4 @@ def test_parent(parent, overridable):
 
 def test_global_when_step(request):
     """Test when step defined in the parent conftest."""
-    request.getfuncargvalue(get_step_fixture_name('I use a when step from the parent conftest', WHEN))
+    get_fixture_value(request, get_step_fixture_name('I use a when step from the parent conftest', WHEN))

tests/steps/test_steps.py

@@ -3,6 +3,7 @@
 import pytest
 from pytest_bdd import given, when, then
 from pytest_bdd.steps import get_step_fixture_name, WHEN, THEN
+from pytest_bdd.utils import get_fixture_value
 
 
 @when('I do stuff')
@@ -21,10 +22,10 @@ def test_when_then(request):
     This test checks that when and then are not evaluated
     during fixture collection that might break the scenario.
     """
-    do_stuff_ = request.getfuncargvalue(get_step_fixture_name('I do stuff', WHEN))
+    do_stuff_ = get_fixture_value(request, get_step_fixture_name('I do stuff', WHEN))
     assert callable(do_stuff_)
 
-    check_stuff_ = request.getfuncargvalue(get_step_fixture_name('I check stuff', THEN))
+    check_stuff_ = get_fixture_value(request, get_step_fixture_name('I check stuff', THEN))
     assert callable(check_stuff_)