Fix making datatable and docstring available as kwargs

Author: jsa34

README.rst

@@ -615,7 +615,9 @@ Leading indentation are stripped.
 
 For example, the Gherkin docstring:
 
+
 .. code-block:: gherkin
+
     """
     This is a sample docstring.
     It spans multiple lines.
@@ -625,6 +627,7 @@ For example, the Gherkin docstring:
 Will be returned as:
 
 .. code-block:: python
+
     "This is a sample docstring.\nIt spans multiple lines."
 
 
@@ -645,7 +648,7 @@ Full example:
 
         And a step provides a docstring with lower indentation
         """
-    This is a when docstring
+    This is a docstring
         """
 
         And this step has no docstring
@@ -661,21 +664,22 @@ Full example:
 
         from pytest_bdd import given, then
 
+
         @given("some steps will have docstrings")
         def _():
             pass
 
         @then("a step has a docstring")
         def _(docstring):
-            assert docstring == "This is a given docstring\non two lines"
+            assert docstring == "This is a docstring\non two lines"
 
         @then("a step provides a docstring with lower indentation")
         def _(docstring):
-            assert docstring == "This is a when docstring"
+            assert docstring == "This is a docstring"
 
         @then("this step has a greater indentation")
         def _(docstring):
-            assert docstring == "This is a when docstring"
+            assert docstring == "This is a docstring"
 
         @then("this step has no docstring")
         def _():

src/pytest_bdd/scenario.py

@@ -14,6 +14,7 @@
 from __future__ import annotations
 
 import contextlib
+import inspect
 import logging
 import os
 import re
@@ -191,6 +192,7 @@ def _execute_step_function(
     converters = context.converters
     kwargs = {}
     args = get_args(context.step_func)
+    signature = inspect.signature(context.step_func)  # Get function signature
 
     try:
         parsed_args = context.parser.parse_arguments(step.name)
@@ -209,7 +211,13 @@ def _execute_step_function(
                 value = converters[arg](value)
             kwargs[arg] = value
 
-        kwargs = {arg: kwargs[arg] if arg in kwargs else request.getfixturevalue(arg) for arg in args}
+        step_func_explicit_args = {arg: kwargs[arg] if arg in kwargs else request.getfixturevalue(arg) for arg in args}
+
+        if any(param.kind == param.VAR_KEYWORD for param in signature.parameters.values()):
+            kwargs = {**kwargs, **step_func_explicit_args}
+        else:
+            kwargs = step_func_explicit_args
+
         kw["step_func_args"] = kwargs
 
         request.config.hook.pytest_bdd_before_step_call(**kw)

tests/datatable/test_datatable.py

@@ -154,3 +154,62 @@ def test_datatable():
     result = pytester.runpytest("-s")
     result.assert_outcomes(failed=1)
     result.stdout.fnmatch_lines(["*fixture 'datatable' not found*"])
+
+
+def test_steps_with_datatable_missing_argument_in_step(pytester):
+    pytester.makefile(
+        ".feature",
+        missing_datatable_arg=textwrap.dedent(
+            """\
+            Feature: Missing datatable
+
+              Scenario: Datatable arg is missing for a step definition
+                Given this step has a datatable
+                    | name  | email             | age |
+                    | John  | [email protected]  | 30  |
+
+                When this step has a datatable but no datatable argument
+                    | name  | email             | age |
+                    | John  | [email protected]  | 30  |
+
+                Then the test passes
+            """
+        ),
+    )
+    pytester.makeconftest(
+        textwrap.dedent(
+            """\
+        from pytest_bdd import given, when, then
+
+
+        @given("this step has a datatable")
+        def _(datatable):
+            print(datatable)
+
+
+        @when("this step has a datatable but no datatable argument")
+        def _():
+            pass
+
+
+        @then("the test passes")
+        def _():
+            pass
+
+    """
+        )
+    )
+
+    pytester.makepyfile(
+        textwrap.dedent(
+            """\
+        from pytest_bdd import scenario
+
+        @scenario("missing_datatable_arg.feature", "Datatable arg is missing for a step definition")
+        def test_datatable():
+            pass
+        """
+        )
+    )
+    result = pytester.runpytest("-s")
+    result.assert_outcomes(passed=1)

tests/steps/test_docstring.py

@@ -140,6 +140,51 @@ def test_docstring():
     result.stdout.fnmatch_lines(["*fixture 'docstring' not found*"])
 
 
+def test_steps_with_docstring_in_kwargs(pytester):
+    pytester.makefile(
+        ".feature",
+        docstring_kwarg=textwrap.dedent(
+            '''\
+            Feature: Docstring in kwargs
+
+              Scenario: Docstring is in step kwargs
+                Given this step has a docstring
+                """
+                This is a given docstring
+                """
+            '''
+        ),
+    )
+    pytester.makeconftest(
+        textwrap.dedent(
+            """\
+        from pytest_bdd import given
+
+
+        @given("this step has a docstring")
+        def _(**kwargs):
+            print(kwargs['docstring'])
+
+
+    """
+        )
+    )
+
+    pytester.makepyfile(
+        textwrap.dedent(
+            """\
+        from pytest_bdd import scenario
+
+        @scenario("docstring_kwarg.feature", "Docstring is in step kwargs")
+        def test_docstring():
+            pass
+        """
+        )
+    )
+    result = pytester.runpytest("-s")
+    result.assert_outcomes(passed=1)
+
+
 def test_steps_with_docstring_missing_argument_in_step_def(pytester):
     pytester.makefile(
         ".feature",