feature: Implement Cucumber::Query in-line with Java/JS implementations

lib/cucumber/formatter/message_builder.rb

@@ -9,6 +9,8 @@
 require 'cucumber/formatter/query/test_case_started_by_test_case'
 require 'cucumber/formatter/query/test_run_started'
 
+require 'cucumber/query'
+
 module Cucumber
   module Formatter
     class MessageBuilder
@@ -39,6 +41,8 @@ def initialize(config)
         @current_test_run_started_id = nil
         @current_test_case_started_id = nil
         @current_test_step_id = nil
+
+        @query = Cucumber::Query.new
       end
 
       def output_message

lib/cucumber/formatter/new_rerun.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'cucumber/formatter/io'
+require 'cucumber/query'
+require 'cucumber/formatter/message_builder'
+
+module Cucumber
+  module Formatter
+    class NewRerun
+      include Formatter::Io
+
+      def initialize(config)
+        @io = ensure_io(config.out_stream, config.error_stream)
+        @config = config
+        @failures = {}
+        config.on_event :test_case_finished, &method(:on_test_case_finished)
+        config.on_event :test_run_finished, &method(:on_test_run_finished)
+      end
+
+      def on_test_case_finished(event)
+        test_case, result = *event.attributes
+        if @config.strict.strict?(:flaky)
+          next if result.ok?(strict: @config.strict)
+
+          add_to_failures(test_case)
+        else
+          unless @latest_failed_test_case.nil?
+            if @latest_failed_test_case != test_case
+              add_to_failures(@latest_failed_test_case)
+              @latest_failed_test_case = nil
+            elsif result.ok?(strict: @config.strict)
+              @latest_failed_test_case = nil
+            end
+          end
+          @latest_failed_test_case = test_case unless result.ok?(strict: @config.strict)
+        end
+      end
+
+      def on_test_run_finished(_event)
+        add_to_failures(@latest_failed_test_case) unless @latest_failed_test_case.nil?
+        next if @failures.empty?
+
+        @io.print file_failures.join("\n")
+      end
+
+      private
+
+      def file_failures
+        @failures.map { |file, lines| [file, lines].join(':') }
+      end
+
+      def add_to_failures(test_case)
+        location = test_case.location
+        @failures[location.file] ||= []
+        @failures[location.file] << location.lines.max unless @failures[location.file].include?(location.lines.max)
+      end
+    end
+  end
+end

lib/cucumber/query.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'cucumber/repository'
+
+module Cucumber
+  class Query
+    attr_reader :repository
+    private :repository
+
+    def initialize(repository)
+      @repository = repository
+    end
+
+    # TODO: count methods (0/2) Complete
+    #   Missing: countMostSevereTestStepResultStatus / countTestCasesStarted
+    #   Completed: N/A
+
+    # TODO: findAll methods (4/12) Complete
+    #   Missing: findAllPickleSteps / findAllTestCaseStarted / findAllStepDefinitions / findAllTestCaseFinished
+    #   Missing: findAllTestStepFinished / findAllTestRunHookStarted / findAllTestRunHookFinished
+    #   Missing: findAllUndefinedParameterTypes
+    #   Completed: findAllPickles / findAllTestCases / findAllTestSteps / findAllTestStepStarted
+
+    def find_all_pickles
+      repository.pickle_by_id.values
+    end
+
+    def find_all_test_cases
+      repository.test_case_by_id.values
+    end
+
+    def find_all_test_step_started
+      # Java impl
+      #    repository.testStepsStartedByTestCaseStartedId.values().stream().flatMap(Collection::stream).collect(toList());
+      repository.test_steps_started_by_test_case_started_id.values
+    end
+
+    def find_all_test_steps
+      repository.test_step_by_id.values
+    end
+
+    # This method will be called with 1 of these 3 messages
+    # TestCaseStarted | TestCaseFinished | TestStepStarted
+    def find_pickle_by(element)
+      test_case = find_test_case_by(element)
+      raise 'Expected to find TestCase from TestCaseStarted' unless test_case
+
+      repository.pickle_by_id[test_case.pickle_id]
+    end
+
+    # This method will be called with 1 of these 4 messages
+    # TestCaseStarted | TestCaseFinished | TestStepStarted | TestStepFinished
+    def find_test_case_by(element)
+      test_case_started = element.respond_to?(:test_case_started_id) ? find_test_case_started_by(element) : element
+      raise 'Expected to find TestCaseStarted by TestStepStarted' unless test_case_started
+
+      repository.test_case_by_id[test_case_started.test_case_id]
+    end
+
+    # This method will be called with 1 of these 3 messages
+    # TestCaseFinished | TestStepStarted | TestStepFinished
+    def find_test_case_started_by(element)
+      repository.test_case_started_by_id[element.test_case_started_id]
+    end
+  end
+end

lib/cucumber/repository.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Cucumber
+  # In memory repository i.e. a thread based link to cucumber-query
+  class Repository
+    attr_accessor :meta, :test_run_started, :test_run_finished
+
+    def update(envelope)
+      return self.meta = envelope.meta if envelope.meta
+      return self.test_run_started = envelope.test_run_started if envelope.test_run_started
+      return self.test_run_finished = envelope.test_run_finished if envelope.test_run_finished
+
+      # TODO: These items are completed AS IS. Should be good to sign off
+      return update_test_run_hook_started(envelope.test_run_hook_started) if envelope.test_run_hook_started
+      return update_test_run_hook_finished(envelope.test_run_hook_finished) if envelope.test_run_hook_finished
+      return update_test_case_started(envelope.test_case_started) if envelope.test_case_started
+      return update_test_case_finished(envelope.test_case_finished) if envelope.test_case_finished
+
+      # TODO: Check these two items in terms of LinkedHashMap in Java
+      return update_test_step_started(envelope.test_step_started) if envelope.test_step_started
+      return update_test_step_finished(envelope.test_step_finished) if envelope.test_step_finished
+
+      # TODO: These items are completed AS IS. Should be good to sign off
+      return update_pickle(envelope.pickle) if envelope.pickle
+      return update_test_case(envelope.test_case) if envelope.test_case
+
+      nil
+    end
+
+    def pickle_by_id
+      @pickle_by_id ||= {}
+    end
+
+    def pickle_step_by_id
+      @pickle_step_by_id ||= {}
+    end
+
+    def test_case_by_id
+      @test_case_by_id ||= {}
+    end
+
+    def test_case_finished_by_test_case_started_id
+      @test_case_finished_by_test_case_started_id ||= {}
+    end
+
+    def test_case_started_by_id
+      @test_case_started_by_id ||= {}
+    end
+
+    def test_run_hook_started_by_id
+      @test_run_hook_started_by_id ||= {}
+    end
+
+    def test_run_hook_finished_by_test_run_hook_started_id
+      @test_run_hook_finished_by_test_run_hook_started_id ||= {}
+    end
+
+    def test_step_by_id
+      @test_step_by_id ||= {}
+    end
+
+    def test_steps_finished_by_test_case_started_id
+      @test_steps_finished_by_test_case_started_id ||= {}
+    end
+
+    def test_steps_started_by_test_case_started_id
+      @test_steps_started_by_test_case_started_id ||= {}
+    end
+
+    private
+
+    def update_pickle(pickle)
+      pickle_by_id[pickle.id] = pickle
+      pickle.steps.each { |pickle_step| pickle_step_by_id[pickle_step.id] = pickle_step }
+    end
+
+    def update_test_case(test_case)
+      test_case_by_id[test_case.id] = test_case
+      test_case.test_steps.each { |test_step| test_step_by_id[test_step.id] = test_step }
+    end
+
+    def update_test_case_finished(test_case_finished)
+      test_case_finished_by_test_case_started_id[test_case_finished.test_case_started_id] = test_case_finished
+    end
+
+    def update_test_case_started(test_case_started)
+      test_case_started_by_id[test_case_started.id] = test_case_started
+    end
+
+    def update_test_run_hook_finished(test_run_hook_finished)
+      test_run_hook_finished_by_test_run_hook_started_id[test_run_hook_finished.test_run_hook_started_id] = test_run_hook_finished
+    end
+
+    def update_test_run_hook_started(test_run_hook_started)
+      test_run_hook_started_by_id[test_run_hook_started.id] = test_run_hook_started
+    end
+
+    def update_test_step_finished(test_step_finished)
+      # Java impl:
+      #   this.testStepsFinishedByTestCaseStartedId.compute(event.getTestCaseStartedId(), updateList(event));
+      test_steps_finished_by_test_case_started_id[test_step_finished.test_case_started_id] = test_step_finished
+    end
+
+    def update_test_step_started(test_step_started)
+      # Java impl
+      #    this.testStepsStartedByTestCaseStartedId.compute(event.getTestCaseStartedId(), updateList(event));
+      test_steps_started_by_test_case_started_id[test_step_started.test_case_started_id] = test_step_started
+    end
+  end
+end

spec/cucumber/formatter/rerun_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cucumber/formatter/rerun'
+require 'cucumber/formatter/new_rerun'
 require 'cucumber/core'
 require 'cucumber/core/gherkin/writer'
 require 'support/standard_step_actions'
@@ -9,7 +9,7 @@
 
 module Cucumber
   module Formatter
-    describe Rerun do
+    describe NewRerun do
       include Cucumber::Core::Gherkin::Writer
       include Cucumber::Core
 
@@ -34,6 +34,7 @@ module Formatter
               end
             end
           end
+
           described_class.new(config)
           execute [gherkin], [StandardStepActions.new], config.event_bus
           config.event_bus.test_run_finished

spec/cucumber/query_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+def source_names
+  %w[attachments empty hooks minimal rules]
+end
+
+def sources
+  source_names.map { |name| "#{Dir.pwd}/spec/support/#{name}.ndjson" }
+end
+
+def queries
+  {
+    'findAllPickles' => ->(query) { query.find_all_pickles.length },
+    'findAllTestCases' => ->(query) { query.find_all_test_cases.length },
+    'findAllTestSteps' => ->(query) { query.find_all_test_steps.length }
+  }
+end
+
+def list_of_tests
+  sources.flat_map do |source|
+    queries.map do |query_name, query_proc|
+      { cck_spec: source, query_name:, query_proc: }
+    end
+  end
+end
+
+require 'cucumber/query'
+require 'cucumber/messages'
+require_relative '../../compatibility/support/cck/helpers'
+
+describe Cucumber::Query do
+  include CCK::Helpers
+
+  subject(:query) { described_class.new(repository) }
+
+  let(:repository) { Cucumber::Repository.new }
+
+  list_of_tests.each do |test|
+    describe "executes the query '#{test[:query_name]}' against the CCK definition '#{test[:cck_spec]}'" do
+      let(:cck_messages) { parse_ndjson_file(test[:cck_spec]).map.itself }
+      let(:filename_to_check) { test[:cck_spec].sub('.ndjson', ".#{test[:query_name]}.results.json") }
+
+      before { cck_messages.each { |message| repository.update(message) } }
+
+      it 'returns the expected query result' do
+        evaluated_query = test[:query_proc].call(query)
+        expected_query_result = JSON.parse(File.read(filename_to_check))
+
+        expect(evaluated_query).to eq(expected_query_result)
+      end
+    end
+  end
+end

spec/support/attachments.findAllPickles.results.json

@@ -0,0 +1 @@
+7

spec/support/attachments.findAllTestCases.results.json

@@ -0,0 +1 @@
+7

spec/support/attachments.findAllTestSteps.results.json

@@ -0,0 +1 @@
+7