cucumber-core 5.0.2 → 6.0.0

data/lib/cucumber/core/test/step.rb

@@ -8,10 +8,11 @@ module Cucumber
   module Core
     module Test
       class Step
-        attr_reader :text, :location, :multiline_arg
+        attr_reader :id, :text, :location, :multiline_arg
 
-        def initialize(text, location, multiline_arg = Test::EmptyMultilineArgument.new, action = Test::UndefinedAction.new(location))
+        def initialize(id, text, location, multiline_arg = Test::EmptyMultilineArgument.new, action = Test::UndefinedAction.new(location))
           raise ArgumentError if text.nil? || text.empty?
+          @id = id
           @text = text
           @location = location
           @multiline_arg = multiline_arg
@@ -35,7 +36,7 @@ module Cucumber
         end
 
         def with_action(action_location = nil, &block)
-          self.class.new(text, location, multiline_arg, Test::Action.new(action_location, &block))
+          self.class.new(id, text, location, multiline_arg, Test::Action.new(action_location, &block))
         end
 
         def backtrace_line
@@ -56,8 +57,8 @@ module Cucumber
       end
 
       class HookStep < Step
-        def initialize(text, location, action)
-          super(text, location, Test::EmptyMultilineArgument.new, action)
+        def initialize(id, text, location, action)
+          super(id, text, location, Test::EmptyMultilineArgument.new, action)
         end
 
         def hook?

data/lib/cucumber/core/version.rb

@@ -3,7 +3,7 @@ module Cucumber
   module Core
     class Version
       def self.to_s
-        "5.0.2"
+        "6.0.0"
       end
     end
   end

data/spec/cucumber/core/compiler_spec.rb

@@ -31,6 +31,60 @@ module Cucumber::Core
       end
     end
 
+    context "when the event_bus is provided" do
+      let(:event_bus) { double }
+
+      before do
+        allow( event_bus ).to receive(:envelope)
+        allow( event_bus ).to receive(:gherkin_source_parsed).and_return(nil)
+        allow( event_bus ).to receive(:test_case_created).and_return(nil)
+        allow( event_bus ).to receive(:test_step_created).and_return(nil)
+      end
+
+      it "emits a TestCaseCreated event with the created Test::Case and Pickle" do
+        gherkin_documents = [
+          gherkin do
+            feature do
+              scenario do
+                step 'passing'
+              end
+            end
+          end
+        ]
+
+        compile(gherkin_documents, event_bus) do | visitor |
+          allow( visitor ).to receive(:test_case)
+          allow( visitor ).to receive(:test_step)
+          allow( visitor ).to receive(:done)
+          allow( event_bus ).to receive(:envelope)
+
+          expect( event_bus ).to receive(:test_case_created).once
+        end
+      end
+
+      it "emits a TestStepCreated event with the created Test::Step and PickleStep" do
+        gherkin_documents = [
+          gherkin do
+            feature do
+              scenario do
+                step 'passing'
+                step 'passing'
+              end
+            end
+          end
+        ]
+
+        compile(gherkin_documents, event_bus) do |visitor|
+          allow( visitor ).to receive(:test_case)
+          allow( visitor ).to receive(:test_step)
+          allow( visitor ).to receive(:done)
+          allow( event_bus ).to receive(:envelope)
+
+          expect( event_bus ).to receive(:test_step_created).twice
+        end
+      end
+    end
+
     it "compiles a feature with a background" do
       gherkin_documents = [
         gherkin do
@@ -166,13 +220,22 @@ module Cucumber::Core
       end
     end
 
-    def compile(gherkin_documents)
+    def compile(gherkin_documents, event_bus = nil)
       visitor = double
       allow( visitor ).to receive(:test_suite).and_yield(visitor)
       allow( visitor ).to receive(:test_case).and_yield(visitor)
+
+      if event_bus.nil?
+        event_bus = double
+        allow( event_bus ).to receive(:envelope).and_return(nil)
+        allow( event_bus ).to receive(:gherkin_source_parsed).and_return(nil)
+        allow( event_bus ).to receive(:test_case_created).and_return(nil)
+        allow( event_bus ).to receive(:test_step_created).and_return(nil)
+        allow( event_bus ).to receive(:envelope).and_return(nil)
+      end
+
       yield visitor
-      super(gherkin_documents, visitor)
+      super(gherkin_documents, visitor, [], event_bus)
     end
-
   end
 end

data/spec/cucumber/core/gherkin/parser_spec.rb

@@ -9,11 +9,14 @@ module Cucumber
       describe Parser do
         let(:receiver)  { double }
         let(:event_bus) { double }
-        let(:parser)    { Parser.new(receiver, event_bus) }
+        let(:gherkin_query) { double }
+        let(:parser)    { Parser.new(receiver, event_bus, gherkin_query) }
         let(:visitor)   { double }
 
         before do
           allow( event_bus ).to receive(:gherkin_source_parsed)
+          allow( event_bus).to receive(:envelope)
+          allow( gherkin_query ).to receive(:update)
         end
 
         def parse
@@ -40,6 +43,12 @@ module Cucumber
             expect( event_bus ).to receive(:gherkin_source_parsed)
             parse
           end
+
+          it "emits an 'envelope' event for every message produced by Gherkin" do
+            # Only one message emited, there's no pickles generated
+            expect( event_bus ).to receive(:envelope).once
+            parse
+          end
         end
 
         context "for empty files" do
@@ -87,6 +96,13 @@ module Cucumber
             expect( receiver ).to receive(:pickle)
             parse
           end
+
+          it "emits an 'envelope' event containing the pickle" do
+            allow( receiver ).to receive(:pickle)
+            # Once for the gherkin document, once with the pickle
+            expect( event_bus ).to receive(:envelope).twice
+            parse
+          end
         end
 
         context "when scenario is inside a rule" do

data/spec/cucumber/core/test/case_spec.rb

@@ -13,11 +13,12 @@ module Cucumber
         include Core
         include Core::Gherkin::Writer
 
+        let(:id) { double }
         let(:name) { double }
         let(:location) { double }
         let(:tags) { double }
         let(:language) { double }
-        let(:test_case) { Test::Case.new(name, test_steps, location, tags, language) }
+        let(:test_case) { Test::Case.new(id, name, test_steps, location, tags, language) }
         let(:test_steps) { [double, double] }
 
         context 'describing itself' do
@@ -45,7 +46,7 @@ module Cucumber
             expect( first_hook ).to receive(:describe_to).ordered.and_yield
             expect( second_hook ).to receive(:describe_to).ordered.and_yield
             around_hooks = [first_hook, second_hook]
-            Test::Case.new(name, [], location, tags, language, around_hooks).describe_to(visitor, double)
+            Test::Case.new(id, name, [], location, tags, language, around_hooks).describe_to(visitor, double)
           end
 
         end

data/spec/cucumber/core/test/data_table_spec.rb

@@ -6,31 +6,29 @@ module Cucumber
   module Core
     module Test
       describe DataTable do
-        let(:location) { Test::Location.new('foo.feature', 9..12) }
-
         before do
           @table = DataTable.new([
             %w{one four seven},
             %w{4444 55555 666666}
-          ], location)
+          ])
         end
 
         describe "equality" do
           it "is equal to another table with the same data" do
-            expect( DataTable.new([[1,2],[3,4]], location) ).to eq DataTable.new([[1,2],[3,4]], location)
+            expect( DataTable.new([[1,2],[3,4]]) ).to eq DataTable.new([[1,2],[3,4]])
           end
 
           it "is not equal to another table with different data" do
-            expect( DataTable.new([[1,2],[3,4]], location) ).not_to eq DataTable.new([[1,2]], location)
+            expect( DataTable.new([[1,2],[3,4]]) ).not_to eq DataTable.new([[1,2]])
           end
 
           it "is not equal to a non table" do
-            expect( DataTable.new([[1,2],[3,4]], location) ).not_to eq Object.new
+            expect( DataTable.new([[1,2],[3,4]]) ).not_to eq Object.new
           end
         end
 
         describe "#data_table?" do
-          let(:table) { DataTable.new([[1,2],[3,4]], location) }
+          let(:table) { DataTable.new([[1,2],[3,4]]) }
 
           it "returns true" do
             expect(table).to be_data_table
@@ -38,7 +36,7 @@ module Cucumber
         end
 
         describe "#doc_string" do
-          let(:table) { DataTable.new([[1,2],[3,4]], location) }
+          let(:table) { DataTable.new([[1,2],[3,4]]) }
 
           it "returns false" do
             expect(table).not_to be_doc_string
@@ -46,7 +44,7 @@ module Cucumber
         end
 
         describe "#map" do
-          let(:table) { DataTable.new([ %w{foo bar}, %w{1 2} ], location) }
+          let(:table) { DataTable.new([ %w{foo bar}, %w{1 2} ]) }
 
           it 'yields the contents of each cell to the block' do
 
@@ -54,7 +52,7 @@ module Cucumber
           end
 
           it 'returns a new table with the cells modified by the block' do
-            expect( table.map { |cell| "*#{cell}*" } ).to eq  DataTable.new([%w{*foo* *bar*}, %w{*1* *2*}], location)
+            expect( table.map { |cell| "*#{cell}*" } ).to eq  DataTable.new([%w{*foo* *bar*}, %w{*1* *2*}])
           end
         end
 
@@ -63,14 +61,14 @@ module Cucumber
             @table = DataTable.new([
               %w{one 1111},
               %w{two 22222}
-            ], location)
+            ])
           end
 
           it "should transpose the table" do
             transposed = DataTable.new([
               %w{one two},
               %w{1111 22222}
-            ], location)
+            ])
             expect( @table.transpose ).to eq( transposed )
           end
         end

data/spec/cucumber/core/test/doc_string_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'cucumber/core/test/location'
 require 'cucumber/core/test/doc_string'
 require 'unindent'
 
@@ -7,11 +6,10 @@ module Cucumber
   module Core
     module Test
       describe DocString do
-        let(:location) { double }
-        let(:doc_string) { DocString.new(content, content_type, location) }
+        let(:doc_string) { DocString.new(content, content_type) }
 
         describe "#data_table?" do
-          let(:doc_string) { DocString.new("test", "text/plain" , location) }
+          let(:doc_string) { DocString.new("test", "text/plain" ) }
 
           it "returns false" do
             expect(doc_string).not_to be_data_table
@@ -19,7 +17,7 @@ module Cucumber
         end
 
         describe "#doc_string" do
-          let(:doc_string) { DocString.new("test", "text/plain" , location) }
+          let(:doc_string) { DocString.new("test", "text/plain" ) }
 
           it "returns true" do
             expect(doc_string).to be_doc_string
@@ -48,15 +46,15 @@ module Cucumber
           let(:content_type) { 'text/plain' }
 
           it 'is equal to another DocString with the same content and content_type' do
-            expect( doc_string ).to eq DocString.new(content, content_type, location)
+            expect( doc_string ).to eq DocString.new(content, content_type)
           end
 
           it 'is not equal to another DocString with different content' do
-            expect( doc_string ).not_to eq DocString.new('bar', content_type, location)
+            expect( doc_string ).not_to eq DocString.new('bar', content_type)
           end
 
           it 'is not equal to another DocString with different content_type' do
-            expect( doc_string ).not_to eq DocString.new(content, 'text/html', location)
+            expect( doc_string ).not_to eq DocString.new(content, 'text/html')
           end
 
           it 'is equal to a string with the same content' do
@@ -96,13 +94,12 @@ module Cucumber
       end
 
       context "inspect" do
-        let(:location) { Test::Location.new("features/feature.feature", 8) }
         let(:content_type) { 'text/plain' }
 
         it "provides a useful inspect method" do
-          doc_string = DocString.new("some text", content_type, location)
+          doc_string = DocString.new("some text", content_type)
           expect(doc_string.inspect).to eq <<-END.chomp.unindent
-          #<Cucumber::Core::Test::DocString (features/feature.feature:8)
+          #<Cucumber::Core::Test::DocString
             """text/plain
             some text
             """>

data/spec/cucumber/core/test/result_spec.rb

@@ -23,6 +23,11 @@ module Cucumber::Core::Test
         expect( result.to_s ).to eq "✓"
       end
 
+      it "converts to a Cucumber::Message::TestResult" do
+        message = result.to_message
+        expect(message.status).to eq(Cucumber::Messages::TestStepResult::Status::PASSED)
+      end
+
       it "has a duration" do
         expect( result.duration ).to eq duration
       end
@@ -68,6 +73,11 @@ module Cucumber::Core::Test
         expect( result.duration ).to eq duration
       end
 
+      it "converts to a Cucumber::Message::TestResult" do
+        message = result.to_message
+        expect(message.status).to eq(Cucumber::Messages::TestStepResult::Status::FAILED)
+      end
+
       it "requires both constructor arguments" do
         expect { Result::Failed.new }.to raise_error(ArgumentError)
         expect { Result::Failed.new(duration) }.to raise_error(ArgumentError)
@@ -131,6 +141,11 @@ module Cucumber::Core::Test
       specify { expect( result ).to     be_unknown   }
       specify { expect( result ).not_to be_skipped   }
       specify { expect( result ).not_to be_flaky     }
+
+      it "converts to a Cucumber::Message::TestResult" do
+        message = result.to_message
+        expect(message.status).to eq(Cucumber::Messages::TestStepResult::Status::UNKNOWN)
+      end
     end
 
     describe Result::Raisable do
@@ -190,6 +205,11 @@ module Cucumber::Core::Test
         result.describe_to(visitor, args)
       end
 
+      it "converts to a Cucumber::Message::TestResult" do
+        message = result.to_message
+        expect(message.status).to eq(Cucumber::Messages::TestStepResult::Status::UNDEFINED)
+      end
+
       specify { expect( result.to_sym ).to eq :undefined }
 
       specify { expect( result ).not_to be_passed    }
@@ -214,6 +234,11 @@ module Cucumber::Core::Test
         result.describe_to(visitor, args)
       end
 
+      it "converts to a Cucumber::Message::TestResult" do
+        message = result.to_message
+        expect(message.status).to eq(Cucumber::Messages::TestStepResult::Status::SKIPPED)
+      end
+
       specify { expect( result.to_sym ).to eq :skipped }
 
       specify { expect( result ).not_to be_passed    }
@@ -236,6 +261,11 @@ module Cucumber::Core::Test
         result.describe_to(visitor, args)
       end
 
+      it "converts to a Cucumber::Message::TestResult" do
+        message = result.to_message
+        expect(message.status).to eq(Cucumber::Messages::TestStepResult::Status::PENDING)
+      end
+
       specify { expect( result.to_sym ).to eq :pending }
 
       specify { expect( result ).not_to be_passed    }
@@ -259,7 +289,7 @@ module Cucumber::Core::Test
 
     describe Result::StrictConfiguration do
       subject(:strict_configuration) { Result::StrictConfiguration.new}
-      
+
       describe '#set_strict' do
         context 'no type argument' do
           it 'sets all result types to the setting argument' do

data/spec/cucumber/core/test/runner_spec.rb

@@ -7,19 +7,21 @@ require 'cucumber/core/test/duration_matcher'
 module Cucumber::Core::Test
   describe Runner do
 
+    let(:step_id)   { double }
+    let(:test_id)   { double }
     let(:name)      { double }
     let(:location)  { double }
     let(:tags)      { double }
     let(:language)  { double }
-    let(:test_case) { Case.new(name, test_steps, location, tags, language) }
+    let(:test_case) { Case.new(test_id, name, test_steps, location, tags, language) }
     let(:text)      { double }
     let(:runner)    { Runner.new(event_bus) }
     let(:event_bus) { double.as_null_object }
-    let(:passing)   { Step.new(text, location, location).with_action {} }
-    let(:failing)   { Step.new(text, location, location).with_action { raise exception } }
-    let(:pending)   { Step.new(text, location, location).with_action { raise Result::Pending.new("TODO") } }
-    let(:skipping)  { Step.new(text, location, location).with_action { raise Result::Skipped.new } }
-    let(:undefined) { Step.new(text, location, location) }
+    let(:passing)   { Step.new(step_id, text, location, location).with_action {} }
+    let(:failing)   { Step.new(step_id, text, location, location).with_action { raise exception } }
+    let(:pending)   { Step.new(step_id, text, location, location).with_action { raise Result::Pending.new("TODO") } }
+    let(:skipping)  { Step.new(step_id, text, location, location).with_action { raise Result::Skipped.new } }
+    let(:undefined) { Step.new(step_id, text, location, location) }
     let(:exception) { StandardError.new('test error') }
 
     before do
@@ -223,8 +225,8 @@ module Cucumber::Core::Test
 
     context 'with multiple test cases' do
       context 'when the first test case fails' do
-        let(:first_test_case) { Case.new(name, [failing], location, tags, language) }
-        let(:last_test_case)  { Case.new(name, [passing], location, tags, language) }
+        let(:first_test_case) { Case.new(test_id, name, [failing], location, tags, language) }
+        let(:last_test_case)  { Case.new(test_id, name, [passing], location, tags, language) }
         let(:test_cases)      { [first_test_case, last_test_case] }
 
         it 'reports the results correctly for the following test case' do
@@ -244,9 +246,9 @@ module Cucumber::Core::Test
         hook_mapping = UnskippableAction.new do |last_result|
           result_spy = last_result
         end
-        after_hook = HookStep.new(text, location, hook_mapping)
-        failing_step = Step.new(text, location).with_action { fail }
-        test_case = Case.new(name, [failing_step, after_hook], location, tags, language)
+        after_hook = HookStep.new(step_id, text, location, hook_mapping)
+        failing_step = Step.new(step_id, text, location).with_action { fail }
+        test_case = Case.new(test_id, name, [failing_step, after_hook], location, tags, language)
         test_case.describe_to runner
         expect(result_spy).to be_failed
       end
@@ -256,8 +258,8 @@ module Cucumber::Core::Test
     context "with around hooks" do
       it "passes normally when around hooks don't fail" do
         around_hook = AroundHook.new { |block| block.call }
-        passing_step = Step.new(text, location, location).with_action {}
-        test_case = Case.new(name, [passing_step], location, tags, language, [around_hook])
+        passing_step = Step.new(step_id, text, location, location).with_action {}
+        test_case = Case.new(test_id, name, [passing_step], location, tags, language, [around_hook])
         expect(event_bus).to receive(:test_case_finished).with(test_case, anything) do |reported_test_case, result|
           expect(result).to be_passed
         end
@@ -266,8 +268,8 @@ module Cucumber::Core::Test
 
       it "gets a failed result if the Around hook fails before the test case is run" do
         around_hook = AroundHook.new { |block| raise exception }
-        passing_step = Step.new(text, location, location).with_action {}
-        test_case = Case.new(name, [passing_step], location, tags, language, [around_hook])
+        passing_step = Step.new(step_id, text, location, location).with_action {}
+        test_case = Case.new(test_id, name, [passing_step], location, tags, language, [around_hook])
         expect(event_bus).to receive(:test_case_finished).with(test_case, anything) do |reported_test_case, result|
           expect(result).to be_failed
           expect(result.exception).to eq exception
@@ -277,8 +279,8 @@ module Cucumber::Core::Test
 
       it "gets a failed result if the Around hook fails after the test case is run" do
         around_hook = AroundHook.new { |block| block.call; raise exception }
-        passing_step = Step.new(text, location, location).with_action {}
-        test_case = Case.new(name, [passing_step], location, tags, language, [around_hook])
+        passing_step = Step.new(step_id, text, location, location).with_action {}
+        test_case = Case.new(test_id, name, [passing_step], location, tags, language, [around_hook])
         expect(event_bus).to receive(:test_case_finished).with(test_case, anything) do |reported_test_case, result|
           expect(result).to be_failed
           expect(result.exception).to eq exception
@@ -288,8 +290,8 @@ module Cucumber::Core::Test
 
       it "fails when a step fails if the around hook works" do
         around_hook = AroundHook.new { |block| block.call }
-        failing_step = Step.new(text, location, location).with_action { raise exception }
-        test_case = Case.new(name, [failing_step], location, tags, language, [around_hook])
+        failing_step = Step.new(step_id, text, location, location).with_action { raise exception }
+        test_case = Case.new(test_id, name, [failing_step], location, tags, language, [around_hook])
         expect(event_bus).to receive(:test_case_finished).with(test_case, anything) do |reported_test_case, result|
           expect(result).to be_failed
           expect(result.exception).to eq exception
@@ -299,8 +301,8 @@ module Cucumber::Core::Test
 
       it "sends after_test_step for a step interrupted by (a timeout in) the around hook" do
         around_hook = AroundHook.new { |block| block.call; raise exception }
-        passing_step = Step.new(text, location, location).with_action {}
-        test_case = Case.new(name, [], location, tags, language, [around_hook])
+        passing_step = Step.new(step_id, text, location, location).with_action {}
+        test_case = Case.new(test_id, name, [], location, tags, language, [around_hook])
         allow(runner).to receive(:running_test_step).and_return(passing_step)
         expect(event_bus).to receive(:test_step_finished).with(passing_step, anything) do |reported_test_case, result|
           expect(result).to be_failed