fix scenario description

closes #647
cucumber · Sep 30, 2016 · 93705c5 · 93705c5
1 parent 5960f3e
commit 93705c5
Show file tree

Hide file tree

Showing 6 changed files with 113 additions and 2 deletions.
diff --git a/features/json_formatter.feature b/features/json_formatter.feature
@@ -1647,3 +1647,15 @@ Feature: JSON Formatter
         }
       ]
       """
+
+  Scenario: output JSON for a feature with one scenario with a description
+    Given a file named "features/a.feature" with:
+      """
+      Feature: some feature
+        Scenario: some scenario
+          Some description
+
+          Given an undefined step
+      """
+    When I run cucumber.js with `-f json`
+    Then the json output's first scenario has the description "Some description"
diff --git a/features/step_definitions/json_output_steps.js b/features/step_definitions/json_output_steps.js
@@ -185,6 +185,11 @@ var jsonOutputSteps = function jsonOutputSteps() {
     assert.equal(scenario.name, name);
   });
 
+  this.Then(/^the json output's first scenario has the description "([^"]*)"$/, function (description) {
+    var features = JSON.parse(this.lastRun.stdout);
+    assert.equal(features[0].elements[0].description.trim(), description);
+  });
+
 };
 
 module.exports = jsonOutputSteps;
diff --git a/lib/cucumber/ast/feature.js b/lib/cucumber/ast/feature.js
@@ -21,6 +21,15 @@ function Feature(data, scenarios) {
       }
     },
 
+    getScenarioDescriptionByLines: function getScenarioDescriptionByLines(lines) {
+      var element = _.find(data.children, function(node) {
+        return _.includes(lines, node.location.line);
+      });
+      if (element) {
+        return element.description;
+      }
+    },
+
     getScenarioKeyword: function() {
       return Gherkin.DIALECTS[self.getLanguage()].scenario;
     },

diff --git a/lib/cucumber/ast/scenario.js b/lib/cucumber/ast/scenario.js
@@ -13,7 +13,7 @@ function Scenario(data) {
     },
 
     getDescription: function getDescription() {
-      return data.description;
+      return self.getFeature().getScenarioDescriptionByLines(self.getLines());
     },
 
     getFeature: function getFeature() {

diff --git a/spec/cucumber/ast/feature_spec.js b/spec/cucumber/ast/feature_spec.js
@@ -88,6 +88,85 @@ describe("Cucumber.Ast.Feature", function () {
     });
   });
 
+  describe('getScenarioDescriptionByLines()', function() {
+    describe('from a scenario', function() {
+      describe('with a description', function() {
+        beforeEach(function() {
+          var source =
+            'Feature: Foo\n' +
+            '  Scenario: Bar\n' +
+            '    My scenario description\n' +
+            '\n' +
+            '    Then b\n';
+          var gherkinDocument = new Gherkin.Parser().parse(source);
+          feature = Cucumber.Ast.Feature(gherkinDocument.feature, []);
+        });
+
+        it('returns the keyword', function() {
+          var description = feature.getScenarioDescriptionByLines([2]);
+          expect(description.trim()).toEqual('My scenario description');
+        });
+      });
+
+      describe('without a description', function() {
+        beforeEach(function() {
+          var source =
+            'Feature: Foo\n' +
+            '  Scenario: Bar\n' +
+            '    Then b\n';
+          var gherkinDocument = new Gherkin.Parser().parse(source);
+          feature = Cucumber.Ast.Feature(gherkinDocument.feature, []);
+        });
+
+        it('returns the keyword', function() {
+          expect(feature.getScenarioDescriptionByLines([2])).toEqual(undefined);
+        });
+      });
+    });
+
+    describe('from an example in a scenario outline', function() {
+      describe('with a description', function() {
+        beforeEach(function() {
+          var source =
+            'Feature: Foo\n' +
+            '  Scenario Outline: Bar\n' +
+            '    My scenario outline description\n' +
+            '\n' +
+            '    When <what>\n' +
+            '\n' +
+            '  Examples:\n' +
+            '    | what |\n' +
+            '    | b    |';
+          var gherkinDocument = new Gherkin.Parser().parse(source);
+          feature = Cucumber.Ast.Feature(gherkinDocument.feature, []);
+        });
+
+        it('returns the keyword', function() {
+          var description = feature.getScenarioDescriptionByLines([2]);
+          expect(description.trim()).toEqual('My scenario outline description');
+        });
+      });
+
+      describe('without a description', function() {
+        beforeEach(function() {
+          var source =
+            'Feature: Foo\n' +
+            '  Scenario Outline: Bar\n' +
+            '    When <what>\n' +
+            '  Examples:\n' +
+            '    | what |\n' +
+            '    | b    |';
+          var gherkinDocument = new Gherkin.Parser().parse(source);
+          feature = Cucumber.Ast.Feature(gherkinDocument.feature, []);
+        });
+
+        it('returns the keyword', function() {
+          expect(feature.getScenarioDescriptionByLines([2])).toEqual(undefined);
+        });
+      });
+    });
+  });
+
   describe("getKeyword()", function () {
     it("returns the keyword of the feature", function () {
       expect(feature.getKeyword()).toEqual('keyword');

diff --git a/spec/cucumber/ast/scenario_spec.js b/spec/cucumber/ast/scenario_spec.js
@@ -6,7 +6,6 @@ describe("Cucumber.Ast.Scenario", function () {
 
   beforeEach(function () {
     var scenarioData = {
-      description: 'description',
       locations: [{path: 'path', line: 1}, {line: 2}],
       name: 'name',
       steps: [
@@ -67,6 +66,13 @@ describe("Cucumber.Ast.Scenario", function () {
   });
 
   describe("getDescription()", function () {
+    var feature;
+
+    beforeEach(function() {
+      feature = createSpyWithStubs('feature', {getScenarioDescriptionByLines: 'description'});
+      scenario.setFeature(feature);
+    });
+
     it("returns the description of the scenario", function () {
       expect(scenario.getDescription()).toEqual('description');
     });