test: Cover behaviour when feature files contain extra blank lines

Author: acoulton

tests/Cucumber/CompatibilityTest.php

@@ -60,6 +60,7 @@ class CompatibilityTest extends TestCase
             'rule_without_name_and_description.feature' => 'Rule is wrongly parsed as Description',
             'incomplete_background_2.feature' => 'Background descriptions not supported',
             'examples_keyword_in_background_description.feature' => 'Background descriptions not supported',
+            'extra_blank_lines_everywhere.feature' => 'Background / Examples descriptions not supported',
         ],
         'gherkin-32' => [
             'complex_background.feature' => 'Rule keyword not supported',

tests/Cucumber/expected_variants/legacy/extra_blank_lines_everywhere.feature.expected.yaml

@@ -0,0 +1,91 @@
+Behat\Gherkin\Node\FeatureNode:
+    title: 'Some feature'
+    description: |4-
+
+          With a description that has
+
+          some blank lines before and after
+    tags:
+        - space-after-feature-tag
+    background:
+        Behat\Gherkin\Node\BackgroundNode:
+            title: |-
+                That is described
+
+                  With multiple paragraphs
+
+                  Of description
+            steps:
+                -
+                    Behat\Gherkin\Node\StepNode:
+                        keywordType: Given
+                        keyword: Given
+                        text: something
+                        arguments: []
+                        line: 19
+                -
+                    Behat\Gherkin\Node\StepNode:
+                        keywordType: Given
+                        keyword: And
+                        text: 'something else'
+                        arguments: []
+                        line: 21
+            keyword: Background
+            line: 13
+            description: ~
+    scenarios:
+        -
+            Behat\Gherkin\Node\OutlineNode:
+                tables:
+                    -
+                        Behat\Gherkin\Node\ExampleTableNode:
+                            keyword: Examples
+                            tags:
+                                - space-after-example-tag
+                            name: |-
+                                Here is a set of examples
+
+                                 That have blank lines in their descriptions
+
+                                 Once again
+                            description: ~
+                            maxLineLength:
+                                - 12
+                            table:
+                                43:
+                                    - precondition
+                                45:
+                                    - '?'
+                                47:
+                                    - 'really, ?'
+                examples: '**NOT INITIALIZED**'
+                title: |-
+                    We will profit
+
+                      With another very long
+
+                      Multiple line description
+                tags:
+                    - space-after-tag
+                steps:
+                    -
+                        Behat\Gherkin\Node\StepNode:
+                            keywordType: When
+                            keyword: When
+                            text: '<precondition>'
+                            arguments: []
+                            line: 31
+                    -
+                        Behat\Gherkin\Node\StepNode:
+                            keywordType: Then
+                            keyword: Then
+                            text: profit
+                            arguments: []
+                            line: 33
+                keyword: Scenario
+                line: 25
+                description: ~
+    keyword: Feature
+    language: en
+    file: {BASEDIR}/tests/Cucumber/extra_testdata/good/extra_blank_lines_everywhere.feature
+    line: 6

tests/Cucumber/extra_testdata/good/extra_blank_lines_everywhere.feature

@@ -0,0 +1,47 @@
+
+# language:en
+
+@space-after-feature-tag
+
+Feature: Some feature
+
+    With a description that has
+
+    some blank lines before and after
+
+
+    Background: That is described
+
+        With multiple paragraphs
+
+        Of description
+
+        Given something
+
+        And something else
+
+    @space-after-tag
+
+    Scenario: We will profit
+
+        With another very long
+
+        Multiple line description
+
+        When <precondition>
+
+        Then profit
+
+        @space-after-example-tag
+
+        Examples: Here is a set of examples
+
+           That have blank lines in their descriptions
+
+           Once again
+
+           | precondition |
+
+           | ?            |
+
+           | really, ?    |

tests/Cucumber/extra_testdata/good/extra_blank_lines_everywhere.feature.ast.ndjson

@@ -0,0 +1 @@
+{"gherkinDocument":{"comments":[],"feature":{"children":[{"background":{"description":"        With multiple paragraphs\n\n        Of description","id":"2","keyword":"Background","location":{"column":5,"line":13},"name":"That is described","steps":[{"id":"0","keyword":"Given ","keywordType":"Context","location":{"column":9,"line":19},"text":"something"},{"id":"1","keyword":"And ","keywordType":"Conjunction","location":{"column":9,"line":21},"text":"something else"}]}},{"scenario":{"description":"        With another very long\n\n        Multiple line description","examples":[{"description":"           That have blank lines in their descriptions\n\n           Once again","id":"9","keyword":"Examples","location":{"column":9,"line":37},"name":"Here is a set of examples","tableBody":[{"cells":[{"location":{"column":14,"line":45},"value":"?"}],"id":"6","location":{"column":12,"line":45}},{"cells":[{"location":{"column":14,"line":47},"value":"really, ?"}],"id":"7","location":{"column":12,"line":47}}],"tableHeader":{"cells":[{"location":{"column":14,"line":43},"value":"precondition"}],"id":"5","location":{"column":12,"line":43}},"tags":[{"id":"8","location":{"column":9,"line":35},"name":"@space-after-example-tag"}]}],"id":"11","keyword":"Scenario","location":{"column":5,"line":25},"name":"We will profit","steps":[{"id":"3","keyword":"When ","keywordType":"Action","location":{"column":9,"line":31},"text":"<precondition>"},{"id":"4","keyword":"Then ","keywordType":"Outcome","location":{"column":9,"line":33},"text":"profit"}],"tags":[{"id":"10","location":{"column":5,"line":23},"name":"@space-after-tag"}]}}],"description":"    With a description that has\n\n    some blank lines before and after","keyword":"Feature","language":"en","location":{"column":1,"line":6},"name":"Some feature","tags":[{"id":"12","location":{"column":1,"line":4},"name":"@space-after-feature-tag"}]},"uri":"../good/extra_blank_lines_everywhere.feature"}}

tests/Cucumber/extra_testdata/good/extra_blank_lines_everywhere.feature.pickles.ndjson

@@ -0,0 +1,2 @@
+{"pickle":{"astNodeIds":["11","6"],"id":"17","language":"en","name":"We will profit","steps":[{"astNodeIds":["0"],"id":"13","text":"something","type":"Context"},{"astNodeIds":["1"],"id":"14","text":"something else","type":"Context"},{"astNodeIds":["3","6"],"id":"15","text":"?","type":"Action"},{"astNodeIds":["4","6"],"id":"16","text":"profit","type":"Outcome"}],"tags":[{"astNodeId":"12","name":"@space-after-feature-tag"},{"astNodeId":"10","name":"@space-after-tag"},{"astNodeId":"8","name":"@space-after-example-tag"}],"uri":"../good/extra_blank_lines_everywhere.feature"}}
+{"pickle":{"astNodeIds":["11","7"],"id":"22","language":"en","name":"We will profit","steps":[{"astNodeIds":["0"],"id":"18","text":"something","type":"Context"},{"astNodeIds":["1"],"id":"19","text":"something else","type":"Context"},{"astNodeIds":["3","7"],"id":"20","text":"really, ?","type":"Action"},{"astNodeIds":["4","7"],"id":"21","text":"profit","type":"Outcome"}],"tags":[{"astNodeId":"12","name":"@space-after-feature-tag"},{"astNodeId":"10","name":"@space-after-tag"},{"astNodeId":"8","name":"@space-after-example-tag"}],"uri":"../good/extra_blank_lines_everywhere.feature"}}

tests/Cucumber/extra_testdata/good/extra_blank_lines_everywhere.feature.source.ndjson

@@ -0,0 +1 @@
+{"source":{"data":"\n# language:en\n\n@space-after-feature-tag\n\nFeature: Some feature\n\n    With a description that has\n\n    some blank lines before and after\n\n\n    Background: That is described\n\n        With multiple paragraphs\n\n        Of description\n\n        Given something\n\n        And something else\n\n    @space-after-tag\n\n    Scenario: We will profit\n\n        With another very long\n\n        Multiple line description\n\n        When <precondition>\n\n        Then profit\n\n        @space-after-example-tag\n\n        Examples: Here is a set of examples\n\n           That have blank lines in their descriptions\n\n           Once again\n\n           | precondition |\n\n           | ?            |\n\n           | really, ?    |\n","mediaType":"text/x.cucumber.gherkin+plain","uri":"../good/extra_blank_lines_everywhere.feature"}}

tests/Cucumber/extra_testdata/good/extra_blank_lines_everywhere.feature.tokens

@@ -0,0 +1,48 @@
+(1:1)Empty://
+(2:1)Language:/en/
+(3:1)Empty://
+(4:1)TagLine://1:@space-after-feature-tag
+(5:1)Empty://
+(6:1)FeatureLine:()Feature/Some feature/
+(7:1)Empty://
+(8:1)Other:/    With a description that has/
+(9:1)Other://
+(10:1)Other:/    some blank lines before and after/
+(11:1)Other://
+(12:1)Other://
+(13:5)BackgroundLine:()Background/That is described/
+(14:1)Empty://
+(15:1)Other:/        With multiple paragraphs/
+(16:1)Other://
+(17:1)Other:/        Of description/
+(18:1)Other://
+(19:9)StepLine:(Context)Given /something/
+(20:1)Empty://
+(21:9)StepLine:(Conjunction)And /something else/
+(22:1)Empty://
+(23:5)TagLine://5:@space-after-tag
+(24:1)Empty://
+(25:5)ScenarioLine:()Scenario/We will profit/
+(26:1)Empty://
+(27:1)Other:/        With another very long/
+(28:1)Other://
+(29:1)Other:/        Multiple line description/
+(30:1)Other://
+(31:9)StepLine:(Action)When /<precondition>/
+(32:1)Empty://
+(33:9)StepLine:(Outcome)Then /profit/
+(34:1)Empty://
+(35:9)TagLine://9:@space-after-example-tag
+(36:1)Empty://
+(37:9)ExamplesLine:()Examples/Here is a set of examples/
+(38:1)Empty://
+(39:1)Other:/           That have blank lines in their descriptions/
+(40:1)Other://
+(41:1)Other:/           Once again/
+(42:1)Other://
+(43:12)TableRow://14:precondition
+(44:1)Empty://
+(45:12)TableRow://14:?
+(46:1)Empty://
+(47:12)TableRow://14:really, ?
+EOF