Implement parsing escaped pipe characters in outline parameters (#337)

* Implement parsing escaped pipe characters in outline parameters

* Use unicode_literals to fix test_outline error in Python 2

Author: Mark90

pytest_bdd/feature.py

@@ -59,6 +59,7 @@
 
 STEP_PARAM_RE = re.compile(r"\<(.+?)\>")
 COMMENT_RE = re.compile(r"(^|(?<=\s))#")
+SPLIT_LINE_RE = re.compile(r"(?<!\\)\|")
 
 
 def get_step_type(line):
@@ -141,6 +142,16 @@ def get_tags(line):
     return set((tag.lstrip("@") for tag in line.strip().split(" @") if len(tag) > 1))
 
 
+def split_line(line):
+    """Split the given Examples line.
+
+    :param str|unicode line: Feature file Examples line.
+
+    :return: List of strings.
+    """
+    return [cell.replace("\\|", "|").strip() for cell in SPLIT_LINE_RE.split(line[1:-1])]
+
+
 def get_features(paths, **kwargs):
     """Get features for given paths.
 
@@ -361,14 +372,12 @@ def __init__(self, basedir, filename, encoding="utf-8", strict_gherkin=True):
                     mode = types.EXAMPLE_LINE_VERTICAL
                     (scenario or self).examples.line_number = line_number
                 elif mode == types.EXAMPLES_HEADERS:
-                    (scenario or self).examples.set_param_names(
-                        [l.strip() for l in parsed_line.split("|")[1:-1] if l.strip()]
-                    )
+                    (scenario or self).examples.set_param_names([l for l in split_line(parsed_line) if l])
                     mode = types.EXAMPLE_LINE
                 elif mode == types.EXAMPLE_LINE:
-                    (scenario or self).examples.add_example([l.strip() for l in stripped_line.split("|")[1:-1]])
+                    (scenario or self).examples.add_example([l for l in split_line(stripped_line)])
                 elif mode == types.EXAMPLE_LINE_VERTICAL:
-                    param_line_parts = [l.strip() for l in stripped_line.split("|")[1:-1]]
+                    param_line_parts = [l for l in split_line(stripped_line)]
                     try:
                         (scenario or self).examples.add_example_row(param_line_parts[0], param_line_parts[1:])
                     except exceptions.ExamplesNotValidError as exc:

tests/feature/test_outline.py

@@ -1,4 +1,5 @@
 """Scenario Outline tests."""
+from __future__ import unicode_literals
 import re
 import textwrap
 
@@ -11,7 +12,7 @@
 
 @scenario("outline.feature", "Outlined given, when, thens", example_converters=dict(start=int, eat=float, left=str))
 def test_outlined(request):
-    assert get_parametrize_markers_args(request.node) == ([u"start", u"eat", u"left"], [[12, 5.0, "7"], [5, 4.0, "1"]])
+    assert get_parametrize_markers_args(request.node) == (["start", "eat", "left"], [[12, 5.0, "7"], [5, 4.0, "1"]])
 
 
 @given("there are <start> cucumbers")
@@ -56,7 +57,7 @@ def test_wrong_vertical_examples_scenario(testdir):
     feature = features.join("test.feature")
     feature.write_text(
         textwrap.dedent(
-            u"""
+            """
     Scenario Outline: Outlined with wrong vertical example table
         Given there are <start> cucumbers
         When I eat <eat> cucumbers
@@ -89,7 +90,7 @@ def test_wrong_vertical_examples_feature(testdir):
     feature = features.join("test.feature")
     feature.write_text(
         textwrap.dedent(
-            u"""
+            """
     Feature: Outlines
 
         Examples: Vertical
@@ -133,7 +134,7 @@ def test_outlined_with_other_fixtures(other_fixture):
 )
 def test_vertical_example(request):
     """Test outlined scenario with vertical examples table."""
-    assert get_parametrize_markers_args(request.node) == ([u"start", u"eat", u"left"], [[12, 5.0, "7"], [2, 1.0, "1"]])
+    assert get_parametrize_markers_args(request.node) == (["start", "eat", "left"], [[12, 5.0, "7"], [2, 1.0, "1"]])
 
 
 @given("there are <start> <fruits>")
@@ -164,5 +165,62 @@ def test_outlined_feature(request):
         ["start", "eat", "left"],
         [[12, 5.0, "7"], [5, 4.0, "1"]],
         ["fruits"],
-        [[u"oranges"], [u"apples"]],
+        [["oranges"], ["apples"]],
     )
+
+
+def test_outline_with_escaped_pipes(testdir):
+    """Test parametrized feature example table with escaped pipe characters in input."""
+    features = testdir.mkdir("features")
+    feature = features.join("test.feature")
+    feature.write_text(
+        textwrap.dedent(
+            r"""
+    Feature: Outline With Special characters
+    
+        Scenario Outline: Outline with escaped pipe character
+            Given We have strings <string1> and <string2>
+            Then <string2> should be the base64 encoding of <string1>
+
+            Examples:
+            | string1      | string2          |
+            | bork         | Ym9yaw==         |
+            | \|bork       | fGJvcms=         |
+            | bork \|      | Ym9yayB8         |
+            | bork\|\|bork | Ym9ya3x8Ym9yaw== |
+            | \|           | fA==             |
+            | bork      \\ | Ym9yayAgICAgIFxc |
+            | bork    \\\| | Ym9yayAgICBcXHw= |
+            """
+        ),
+        "utf-8",
+        ensure=True,
+    )
+
+    testdir.makepyfile(
+        textwrap.dedent(
+            """
+    import base64
+
+    from pytest_bdd import scenario, given, when, then
+    from pytest_bdd.utils import get_parametrize_markers_args
+
+
+    @scenario("features/test.feature", "Outline with escaped pipe character")
+    def test_outline_with_escaped_pipe_character(request):
+        pass
+
+
+    @given("We have strings <string1> and <string2>")
+    def we_have_strings_string1_and_string2(string1, string2):
+        pass
+
+
+    @then("<string2> should be the base64 encoding of <string1>")
+    def string2_should_be_base64_encoding_of_string1(string2, string1):
+        assert string1.encode() == base64.b64decode(string2.encode())
+    """
+        )
+    )
+    result = testdir.runpytest()
+    result.stdout.fnmatch_lines(["* 7 passed *"])