Fix #1621: Json formatter fails with tagged examples (#1651)

* Add a reproduction scenario for #1621 * Add a unit test * Fix the json-formatter to make tests pass * [skip ci]Update changelog
cucumber · Apr 26, 2021 · 238947f · 238947f
1 parent 21c0349
commit 238947f
Show file tree

Hide file tree

Showing 5 changed files with 145 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,10 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 
 ### Fixed
 
+* Json formatter now works with tagged examples
+  ([#1621](https://github.com/cucumber/cucumber-js/issues/1621)
+   [#1651](https://github.com/cucumber/cucumber-js/pull/1651))
+
 ## [7.2.1] (2021-04-21)
 
 ### Fixed

diff --git a/features/scenario_outlines.feature b/features/scenario_outlines.feature
@@ -93,3 +93,55 @@ Feature: Scenario Outlines and Examples
     When I run cucumber-js
     Then it fails
     And it runs 4 scenarios
+
+  Scenario: scenario outlines with tagged examples
+    Given a file named "features/scenario_outline.feature" with:
+      """
+      Feature: a feature
+        Scenario Outline: a scenario
+          Given a step <id>
+
+        @examples @tag
+        Examples:
+          | id |
+          | 1  |
+          | 2  |
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      const {Given} = require('@cucumber/cucumber')
+
+      Given('a step {int}', function(int) {})
+      """
+    When I run cucumber-js with `-f json`
+    Then it passes
+    And it runs 2 scenarios
+
+  Scenario: scenario outlines with multiple example tables
+    Given a file named "features/scenario_outline.feature" with:
+      """
+      Feature: a feature
+        Scenario Outline: a scenario
+          Given a step <id>
+
+        @example @id-1-2
+        Examples:
+          | id |
+          | 1  |
+          | 2  |
+
+        @example @id-3-4
+        Examples:
+          | id |
+          | 3  |
+          | 4  |
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      const {Given} = require('@cucumber/cucumber')
+
+      Given('a step {int}', function(int) {})
+      """
+    When I run cucumber-js with `-f json`
+    Then it passes
+    And it runs 4 scenarios
diff --git a/src/formatter/json_formatter.ts b/src/formatter/json_formatter.ts
@@ -16,6 +16,7 @@ import ITag = messages.GherkinDocument.Feature.ITag
 import IFeature = messages.GherkinDocument.IFeature
 import IPickle = messages.IPickle
 import IScenario = messages.GherkinDocument.Feature.IScenario
+import IPickleTag = messages.Pickle.IPickleTag
 import IEnvelope = messages.IEnvelope
 import IRule = messages.GherkinDocument.Feature.FeatureChild.IRule
 
@@ -314,20 +315,33 @@ export default class JsonFormatter extends Formatter {
     pickle: IPickle
     gherkinScenarioMap: { [id: string]: IScenario }
   }): IJsonTag[] {
-    return _.map(pickle.tags, (tagData) => {
-      const featureSource = feature.tags.find(
-        (t: ITag) => t.id === tagData.astNodeId
-      )
-      const scenarioSource = gherkinScenarioMap[pickle.astNodeIds[0]].tags.find(
-        (t: ITag) => t.id === tagData.astNodeId
-      )
-      const line = doesHaveValue(featureSource)
-        ? featureSource.location.line
-        : scenarioSource.location.line
-      return {
-        name: tagData.name,
-        line,
-      }
-    })
+    const scenario = gherkinScenarioMap[pickle.astNodeIds[0]]
+
+    return pickle.tags.map(
+      (tagData: IPickleTag): IJsonTag =>
+        this.getScenarioTag(tagData, feature, scenario)
+    )
+  }
+
+  private getScenarioTag(
+    tagData: IPickleTag,
+    feature: IFeature,
+    scenario: IScenario
+  ): IJsonTag {
+    const byAstNodeId = (tag: ITag): Boolean => tag.id === tagData.astNodeId
+    const flatten = (acc: ITag[], val: ITag[]): ITag[] => acc.concat(val)
+
+    const tag =
+      feature.tags.find(byAstNodeId) ||
+      scenario.tags.find(byAstNodeId) ||
+      scenario.examples
+        .map((e) => e.tags)
+        .reduce(flatten, [])
+        .find(byAstNodeId)
+
+    return {
+      name: tagData.name,
+      line: tag?.location?.line,
+    }
   }
 }
diff --git a/src/formatter/json_formatter_spec.ts b/src/formatter/json_formatter_spec.ts
@@ -7,6 +7,7 @@ import {
 } from '../../test/fixtures/json_formatter_steps'
 import FakeTimers, { InstalledClock } from '@sinonjs/fake-timers'
 import timeMethods from '../time'
+import { IJsonFeature, IJsonScenario } from '../../lib/formatter/json_formatter'
 
 describe('JsonFormatter', () => {
   let clock: InstalledClock
@@ -357,6 +358,63 @@ describe('JsonFormatter', () => {
         ])
       })
     })
+
+    describe(' with tagged examples', () => {
+      it('outputs the examples', async () => {
+        // Arrange
+        const sources = [
+          {
+            data: [
+              'Feature: my feature',
+              '  Scenario: my scenario',
+              '    Given a step <id>',
+              '',
+              '    @tag-1-2',
+              '    Examples:',
+              '      |id|',
+              '      | 1|',
+              '      | 2|',
+              '',
+              '    @tag @tag-3-4',
+              '    Examples:',
+              '      |id|',
+              '      | 3|',
+              '      | 4|',
+            ].join('\n'),
+            uri: 'a.feature',
+          },
+        ]
+
+        const supportCodeLibrary = getJsonFormatterSupportCodeLibrary(clock)
+
+        // Act
+        const output = await testFormatter({
+          sources,
+          supportCodeLibrary,
+          type: 'json',
+        })
+
+        // Assert
+        const jsonFeature: IJsonFeature = JSON.parse(output)[0]
+        const jsonScenarios = jsonFeature.elements
+        const jsonScenarioTags = jsonScenarios.map((s: IJsonScenario) => s.tags)
+
+        const expectedTags = [
+          [{ line: 5, name: '@tag-1-2' }],
+          [{ line: 5, name: '@tag-1-2' }],
+          [
+            { line: 11, name: '@tag' },
+            { line: 11, name: '@tag-3-4' },
+          ],
+          [
+            { line: 11, name: '@tag' },
+            { line: 11, name: '@tag-3-4' },
+          ],
+        ]
+
+        expect(jsonScenarioTags).to.eql(expectedTags)
+      })
+    })
   })
 
   describe('one rule with several examples (scenarios)', () => {

diff --git a/test/fixtures/json_formatter_steps.ts b/test/fixtures/json_formatter_steps.ts
@@ -29,6 +29,8 @@ export function getJsonFormatterSupportCodeLibrary(
     Given('a step that attaches', async function (this: World) {
       await this.attach(Buffer.from([137, 80, 78, 71]), 'image/png')
     })
+
+    Given('a step {int}', function (_int: Number) {})
   })
 }