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,139 @@
+# frozen_string_literal: true
+
+require 'cucumber/repository'
+
+# Given one Cucumber Message, find another.
+#
+# Queries can be made while the test run is incomplete - and this will naturally return incomplete results
+# see <a href="https://github.com/cucumber/messages?tab=readme-ov-file#message-overview">Cucumber Messages - Message Overview</a>
+#
+module Cucumber
+  class Query
+    attr_reader :repository
+    private :repository
+
+    def initialize(repository)
+      @repository = repository
+    end
+
+    # TODO: count methods (1/2) Complete
+    #   Missing: countMostSevereTestStepResultStatus
+
+    # TODO: findAll methods (11/12) Complete
+    #   Missing: findAllUndefinedParameterTypes
+
+    # TODO: find****By methods (3/25) Complete
+    #   Missing: findAttachmentsBy (2 variants)
+    #   Missing: findHookBy (3 variants)
+    #   Missing: findMeta (1 variant) - This strictly speaking isn't a findBy but is located within them
+    #   Missing: findMostSevereTestStepResultBy (2 variants)
+    #   Missing: findLocationOf (1 variant) - This strictly speaking isn't a findBy but is located within them
+    #   Partially Complete (3/5): findPickleBy (5 variants)
+    #   Missing: findPickleStepBy (1 variant)
+    #   Missing: findSuggestionsBy (2 variants)
+    #   Missing: findStepBy (1 variant)
+    #   Missing: findStepDefinitionsBy (1 variant)
+    #   Missing: findUnambiguousStepDefinitionBy (1 variant)
+    #   Fully Complete (4/4): findTestCaseBy (4 variants)
+    #   Missing: findTestCaseDurationBy (2 variant)
+    #   Fully Complete (3/3): findTestCaseStartedBy (3 variants)
+    #   Fully Complete (1/1): findTestCaseFinishedBy (1 variant)
+    #   Missing: findTestRunHookFinishedBy (1 variant)
+    #   Missing: findTestRunHookStartedBy (1 variant)
+    #   Missing: findTestRunDuration (1 variant) - This strictly speaking isn't a findBy but is located within them
+    #   Missing: findTestRunFinished (1 variant) - This strictly speaking isn't a findBy but is located within them
+    #   Missing: findTestRunStarted (1 variant) - This strictly speaking isn't a findBy but is located within them
+    #   Missing: findTestStepBy (2 variants)
+    #   Missing: findTestStepsStartedBy (2 variants)
+    #   Missing: findTestStepsFinishedBy (2 variants)
+    #   Missing: findTestStepFinishedAndTestStepBy (1 variant)
+    #   Missing: findLineageBy (9 variants!)
+
+    def count_test_cases_started
+      find_all_test_case_started.length
+    end
+
+    def find_all_pickles
+      repository.pickle_by_id.values
+    end
+
+    def find_all_pickle_steps
+      repository.pickle_step_by_id.values
+    end
+
+    def find_all_step_definitions
+      repository.step_definition_by_id.values
+    end
+
+    # This finds all test cases that have started, but not yet finished
+    # AS WELL AS (AND)
+    # This finds all test cases that have started AND have finished, but that will NOT be retried
+    def find_all_test_case_started
+      repository.test_case_started_by_id.values.select do |test_case_started|
+        test_case_finished = find_test_case_finished_by(test_case_started)
+        test_case_finished.nil? || !test_case_finished.will_be_retried
+      end
+    end
+
+    # This finds all test cases that have finished AND will not be retried
+    def find_all_test_case_finished
+      repository.test_case_finished_by_test_case_started_id.values.reject do |test_case_finished|
+        test_case_finished.will_be_retried
+      end
+    end
+
+    def find_all_test_cases
+      repository.test_case_by_id.values
+    end
+
+    def find_all_test_run_hook_started
+      repository.test_run_hook_started_by_id.values
+    end
+
+    def find_all_test_run_hook_finished
+      repository.test_run_hook_finished_by_test_run_hook_started_id.values
+    end
+
+    def find_all_test_step_started
+      repository.test_steps_started_by_test_case_started_id.values.flatten
+    end
+
+    def find_all_test_step_finished
+      repository.test_steps_finished_by_test_case_started_id.values.flatten
+    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
+
+    # This method will be called with only 1 message
+    #   [TestCaseStarted]
+    def find_test_case_finished_by(test_case_started)
+      repository.test_case_finished_by_test_case_started_id[test_case_started.id]
+    end
+  end
+end

lib/cucumber/repository.rb

@@ -0,0 +1,127 @@
+# 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
+    attr_reader :pickle_by_id, :pickle_step_by_id,
+                :step_by_id, :step_definition_by_id,
+                :test_case_by_id, :test_case_started_by_id, :test_case_finished_by_test_case_started_id,
+                :test_run_hook_started_by_id, :test_run_hook_finished_by_test_run_hook_started_id,
+                :test_step_by_id, :test_steps_started_by_test_case_started_id, :test_steps_finished_by_test_case_started_id
+
+    def initialize
+      @pickle_by_id = {}
+      @pickle_step_by_id = {}
+      @step_by_id = {}
+      @step_definition_by_id = {}
+      @test_case_by_id = {}
+      @test_case_started_by_id = {}
+      @test_case_finished_by_test_case_started_id = {}
+      @test_run_hook_started_by_id = {}
+      @test_run_hook_finished_by_test_run_hook_started_id = {}
+      @test_step_by_id = {}
+      @test_steps_started_by_test_case_started_id = Hash.new { |hash, key| hash[key] = [] }
+      @test_steps_finished_by_test_case_started_id = Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    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
+      return update_gherkin_document(envelope.gherkin_document) if envelope.gherkin_document
+      return update_pickle(envelope.pickle) if envelope.pickle
+      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
+      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
+      return update_test_case(envelope.test_case) if envelope.test_case
+
+      nil
+    end
+
+    private
+
+    def update_feature(feature)
+      # Java impl:
+      #        feature.getChildren()
+      #                 .forEach(featureChild -> {
+      #                     featureChild.getBackground().ifPresent(background -> updateSteps(background.getSteps()));
+      #                     featureChild.getScenario().ifPresent(this::updateScenario);
+      #                     featureChild.getRule().ifPresent(rule -> rule.getChildren().forEach(ruleChild -> {
+      #                         ruleChild.getBackground().ifPresent(background -> updateSteps(background.getSteps()));
+      #                         ruleChild.getScenario().ifPresent(this::updateScenario);
+      #                     }));
+      #                 });
+
+      feature.children.each do |feature_child|
+        update_steps(feature_child.background.steps) if feature_child.background
+        update_scenario(feature_child.scenario) if feature_child.scenario
+        if feature_child.rule
+          feature_child.rule.children.each do |rule_child|
+            update_steps(rule_child.background.steps) if rule_child.background
+            update_scenario(rule_child.scenario) if rule_child.scenario
+          end
+        end
+      end
+    end
+
+    def update_gherkin_document(gherkin_document)
+      # Java impl:
+      #       private void updateGherkinDocument(GherkinDocument document) {
+      #         lineageById.putAll(Lineages.of(document));
+      #         document.getFeature().ifPresent(this::updateFeature);
+      #     }
+      # TODO: Update lineage??
+      update_feature(gherkin_document.feature) if gherkin_document.feature
+    end
+
+    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_scenario(scenario)
+      update_steps(scenario.steps)
+    end
+
+    def update_steps(steps)
+      steps.each { |step| step_by_id[step.id] = step }
+    end
+
+    def update_step_definition(step_definition)
+      step_definition_by_id[step_definition.id] = step_definition
+    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_started(test_case_started)
+      test_case_started_by_id[test_case_started.id] = test_case_started
+    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_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_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_step_started(test_step_started)
+      test_steps_started_by_test_case_started_id[test_step_started.test_case_started_id] << test_step_started
+    end
+
+    def update_test_step_finished(test_step_finished)
+      test_steps_finished_by_test_case_started_id[test_step_finished.test_case_started_id] << test_step_finished
+    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