Merge branch 'master' into gherkin_reporter_parametrized_tests_fix

Author: sliwinski-milosz

.travis.yml

@@ -1,45 +1,20 @@
-sudo: false
+dist: xenial
 language: python
-python: "2.7"
+python:
+  - "2.7"
+  - "3.5"
+  - "3.6"
+  - "3.7"
+
+install: pip install tox tox-travis
 
-matrix:
-  include:
-    - env: TOXENV=py27-pytestlatest-linters
-    - env: TOXENV=py27-pytest29
-    - env: TOXENV=py27-pytest30
-    - env: TOXENV=py27-pytest31
-    - env: TOXENV=py27-pytest32
-    - env: TOXENV=py27-pytest33
-    - env: TOXENV=py27-pytest34
-    - env: TOXENV=py27-pytest35
-    - env: TOXENV=py27-pytest36
-    - env: TOXENV=py27-pytest37
-    - env: TOXENV=py27-pytest38
-    - env: TOXENV=py27-pytest39
-    - env: TOXENV=py27-pytest310
-    - env: TOXENV=py27-pytest40
-    - env: TOXENV=py27-pytestlatest
-    - env: TOXENV=py27-pytestlatest-xdist
-    - env: TOXENV=py34-pytestlatest
-      python: "3.4"
-    - env: TOXENV=py35-pytestlatest
-      python: "3.5"
-    - env: TOXENV=py36-pytestlatest
-      python: "3.6"
-    - env: TOXENV=py37-pytestlatest
-      python: "3.7"
-      # Currently, python 3.7 is a little bit tricky to install:
-      # https://github.com/travis-ci/travis-ci/issues/9069#issuecomment-425720905
-      sudo: required
-      dist: xenial
-    - env: TOXENV=py27-pytestlatest-coveralls
-install:
-  - pip install tox
 script: tox --recreate
+
 branches:
   except:
     - /^\d/
+
 notifications:
   email:
-  - [email protected]
-  - [email protected]
+    - [email protected]
+    - [email protected]

CHANGES.rst

@@ -1,6 +1,24 @@
 Changelog
 =========
 
+Unreleased
+----------
+
+3.1.1
+----------
+
+- Allow unicode string in ``@given()`` step names when using python2.
+  This makes the transition of projects from python 2 to 3 easier.
+
+3.1.0
+----------
+
+- Drop support for pytest < 3.3.2.
+- Step definitions generated by ``$ pytest-bdd generate`` will now raise ``NotImplementedError`` by default.
+- ``@given(...)`` no longer accepts regex objects. It was deprecated long ago.
+- Improve project testing by treating warnings as exceptions.
+- ``pytest_bdd_step_validation_error`` will now always receive ``step_func_args`` as defined in the signature.
+
 3.0.2
 ------
 

README.rst

@@ -35,7 +35,7 @@ Install pytest-bdd
     pip install pytest-bdd
 
 
-The minimum required version of pytest is 2.8.1.
+The minimum required version of pytest is 3.3.2
 
 
 Example
@@ -168,24 +168,24 @@ pass optional ``scope`` argument:
 
 .. code-block:: python
 
-    @given('I have an article', scope='session')
+    @given('there is an article', scope='session')
     def article(author):
         return create_test_article(author=author)
 
 .. code-block:: gherkin
 
     Scenario: I'm the author
         Given I'm an author
-        And I have an article
+        And there is an article
 
 
     Scenario: I'm the admin
         Given I'm the admin
         And there is an article
 
 
-For this example, step function for 'I have an article' given step will be executed once even though there are 2
-scenarios using it.
+In this example, the step function for the 'there is an article' given step will be executed once, even though there
+are 2 scenarios using it.
 Note that for other step types, it makes no sense to have scope larger than 'function' (the default) as they represent
 an action (when step), and assertion (then step).
 
@@ -379,7 +379,7 @@ Multiline steps
 ---------------
 
 As Gherkin, pytest-bdd supports multiline steps
-(aka `PyStrings <http://docs.behat.org/guides/1.gherkin.html#pystrings>`_).
+(aka `PyStrings <http://behat.org/en/v3.0/user_guide/writing_scenarios.html#pystrings>`_).
 But in much cleaner and powerful way:
 
 .. code-block:: gherkin
@@ -482,7 +482,7 @@ Scenario outlines
 
 Scenarios can be parametrized to cover few cases. In Gherkin the variable
 templates are written using corner braces as <somevalue>.
-`Gherkin scenario outlines <http://docs.behat.org/guides/1.gherkin.html#scenario-outlines>`_ are supported by pytest-bdd
+`Gherkin scenario outlines <http://behat.org/en/v3.0/user_guide/writing_scenarios.html#scenario-outlines>`_ are supported by pytest-bdd
 exactly as it's described in be behave_ docs.
 
 Example:
@@ -859,7 +859,7 @@ Backgrounds
 
 It's often the case that to cover certain feature, you'll need multiple scenarios. And it's logical that the
 setup for those scenarios will have some common parts (if not equal). For this, there are `backgrounds`.
-pytest-bdd implements `Gherkin backgrounds <http://docs.behat.org/en/v2.5/guides/1.gherkin.html#backgrounds>`_ for
+pytest-bdd implements `Gherkin backgrounds <http://behat.org/en/v3.0/user_guide/writing_scenarios.html#backgrounds>`_ for
 features.
 
 .. code-block:: gherkin
@@ -974,13 +974,13 @@ Using unicode in the feature files
 ----------------------------------
 
 As mentioned above, by default, utf-8 encoding is used for parsing feature files.
-For steps definition, you can both use unicode- and bytestrings equally.
-However, for argumented steps, if you need to use unicode symbols in it's regular expression, use `u` sign with regex:
+For steps definition, you should use unicode strings, which is the default in python 3.
+If you are on python 2, make sure you use unicode strings by prefixing them with the `u` sign.
 
 
 .. code-block:: python
 
-    @given(re.compile(u"у мене є рядок який містить '{0}'".format('(?P<content>.+)')))
+    @given(parsers.re(u"у мене є рядок який містить '{0}'".format(u'(?P<content>.+)')))
     def there_is_a_string_with_content(content, string):
         """Create string with unicode content."""
         string['content'] = content

pytest.ini

@@ -0,0 +1,6 @@
+[pytest]
+pep8maxlinelength=120
+addopts=-vvl
+filterwarnings =
+    error
+    ignore::DeprecationWarning

pytest_bdd/__init__.py

@@ -3,6 +3,6 @@
 from pytest_bdd.steps import given, when, then
 from pytest_bdd.scenario import scenario, scenarios
 
-__version__ = '3.0.2'
+__version__ = '3.1.1'
 
 __all__ = [given.__name__, when.__name__, then.__name__, scenario.__name__, scenarios.__name__]

pytest_bdd/parsers.py

@@ -1,22 +1,17 @@
 """Step parsers."""
 
 from __future__ import absolute_import
+
 import re as base_re
-import warnings
 
 import parse as base_parse
-from parse_type import cfparse as base_cfparse
-
 import six
+from parse_type import cfparse as base_cfparse
 
 from .exceptions import InvalidStepParserError
 
 
-RE_TYPE = type(base_re.compile(''))
-
-
 class StepParser(object):
-
     """Parser of the individual step."""
 
     def __init__(self, name):
@@ -35,7 +30,6 @@ def is_matching(self, name):
 
 
 class re(StepParser):
-
     """Regex step parser."""
 
     def __init__(self, name, *args, **kwargs):
@@ -56,7 +50,6 @@ def is_matching(self, name):
 
 
 class parse(StepParser):
-
     """parse step parser."""
 
     def __init__(self, name, *args, **kwargs):
@@ -80,7 +73,6 @@ def is_matching(self, name):
 
 
 class cfparse(parse):
-
     """cfparse step parser."""
 
     def __init__(self, name, *args, **kwargs):
@@ -90,7 +82,6 @@ def __init__(self, name, *args, **kwargs):
 
 
 class string(StepParser):
-
     """Exact string step parser."""
 
     def parse_arguments(self, name):
@@ -113,16 +104,9 @@ def get_parser(step_name):
     :return: step parser object
     :rtype: StepArgumentParser
     """
-    if isinstance(step_name, RE_TYPE):
-        # backwards compartibility
-        warn = (
-            'pytest-bdd [{0}]: Direct usage of regex is deprecated. Please use pytest_bdd.parsers.re instead.'.format(
-                step_name.pattern)
-        )
-        warnings.warn(warn)
-        print(warn)
-        return re(step_name.pattern, flags=step_name.flags)
-    elif isinstance(step_name, six.string_types):
+    if isinstance(step_name, six.string_types):
+        if isinstance(step_name, six.binary_type):  # Python 2 compatibility
+            step_name = step_name.decode('utf-8')
         return string(step_name)
     elif not hasattr(step_name, 'is_matching') or not hasattr(step_name, 'parse_arguments'):
         raise InvalidStepParserError(step_name)

pytest_bdd/scenario.py

@@ -38,7 +38,7 @@
     recreate_function,
 )
 from .types import GIVEN
-from .utils import CONFIG_STACK, get_args, get_fixture_value
+from .utils import CONFIG_STACK, get_args
 
 if six.PY3:  # pragma: no cover
     import runpy
@@ -70,7 +70,7 @@ def find_argumented_step_fixture_name(name, type_, fixturemanager, request=None)
                 parser_name = get_step_fixture_name(parser.name, type_)
                 if request:
                     try:
-                        get_fixture_value(request, parser_name)
+                        request.getfixturevalue(parser_name)
                     except pytest_fixtures.FixtureLookupError:
                         continue
                 return parser_name
@@ -88,12 +88,12 @@ def _find_step_function(request, step, scenario, encoding):
     """
     name = step.name
     try:
-        return get_fixture_value(request, get_step_fixture_name(name, step.type, encoding))
+        return request.getfixturevalue(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 get_fixture_value(request, name)
+                return request.getfixturevalue(name)
             raise
         except pytest_fixtures.FixtureLookupError:
             raise exceptions.StepDefinitionNotFoundError(
@@ -128,7 +128,7 @@ def _execute_step_function(request, scenario, step, step_func):
     kw["step_func_args"] = {}
     try:
         # Get the step argument values.
-        kwargs = dict((arg, get_fixture_value(request, arg)) for arg in get_args(step_func))
+        kwargs = dict((arg, request.getfixturevalue(arg)) for arg in get_args(step_func))
         kw["step_func_args"] = kwargs
 
         request.config.hook.pytest_bdd_before_step_call(**kw)
@@ -188,6 +188,7 @@ def _execute_scenario(feature, scenario, request, encoding):
                     step=step,
                     step_func=step_func,
                     exception=exception,
+                    step_func_args=dict((arg, request.getfixturevalue(arg)) for arg in get_args(step_func)),
                 )
                 raise
 

pytest_bdd/steps.py

@@ -49,8 +49,7 @@ def article(author):
     StepError,
 )
 from .parsers import get_parser
-from .utils import get_args, get_fixture_value, get_fixture_value_raw, set_fixture_value, get_request_fixture_defs, \
-    get_request_fixture_names
+from .utils import get_args
 
 
 def get_step_fixture_name(name, type_, encoding=None):
@@ -82,11 +81,11 @@ def given(name, fixture=None, converters=None, scope='function', target_fixture=
         module = get_caller_module()
 
         def step_func(request):
-            return get_fixture_value(request, fixture)
+            return request.getfixturevalue(fixture)
 
         step_func.step_type = GIVEN
         step_func.converters = converters
-        step_func.__name__ = name
+        step_func.__name__ = force_encode(name, 'ascii')
         step_func.fixture = fixture
         func = pytest.fixture(scope=scope)(lambda: step_func)
         func.__doc__ = 'Alias for the "{0}" fixture.'.format(fixture)
@@ -162,7 +161,7 @@ def decorator(func):
                 func = pytest.fixture(scope=scope)(func)
 
             def step_func(request):
-                result = get_fixture_value(request, func.__name__)
+                result = request.getfixturevalue(func.__name__)
                 if target_fixture:
                     inject_fixture(request, target_fixture, result)
                 return result
@@ -305,26 +304,21 @@ def inject_fixture(request, arg, value):
     fd = pytest_fixtures.FixtureDef(**fd_kwargs)
     fd.cached_result = (value, 0, None)
 
-    old_fd = get_request_fixture_defs(request).get(arg)
+    old_fd = request._fixture_defs.get(arg)
     add_fixturename = arg not in request.fixturenames
 
-    old_value = get_fixture_value_raw(request, arg)  # Compatibility with pytest < 3.3.2
-
     def fin():
         request._fixturemanager._arg2fixturedefs[arg].remove(fd)
-        get_request_fixture_defs(request)[arg] = old_fd
+        request._fixture_defs[arg] = old_fd
 
         if add_fixturename:
-            get_request_fixture_names(request).remove(arg)
-
-        set_fixture_value(request, arg, old_value)  # Compatibility with pytest < 3.3.2
+            request._pyfuncitem._fixtureinfo.names_closure.remove(arg)
 
     request.addfinalizer(fin)
 
     # inject fixture definition
     request._fixturemanager._arg2fixturedefs.setdefault(arg, []).insert(0, fd)
     # inject fixture value in request cache
-    get_request_fixture_defs(request)[arg] = fd
-    set_fixture_value(request, arg, value)
+    request._fixture_defs[arg] = fd
     if add_fixturename:
-        get_request_fixture_names(request).append(arg)
+        request._pyfuncitem._fixtureinfo.names_closure.append(arg)

pytest_bdd/templates/test.py.mak

@@ -22,6 +22,7 @@ def test_${ make_python_name(scenario.name)}():
 @${step.type}('${step.name}')
 def ${ make_python_name(step.name)}():
     """${step.name}."""
+    raise NotImplementedError
 % if not loop.last: