cucumber 11.1.1 → 12.0.0

data/lib/cucumber/formatter/message_builder.rb

@@ -3,9 +3,9 @@
 require 'base64'
 require 'json'
 
-require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/query'
 
+require_relative 'backtrace_filter'
 require_relative 'message_handlers'
 
 module Cucumber
@@ -23,8 +23,7 @@ module Cucumber
 
         @test_run_started_id = config.test_run_started_id
 
-        # Fake Query objects
-        @test_case_by_step_id = {}
+        # Fake Query objects - used to build specific parts of the messages defined inside handlers
         @pickle_id_by_test_case_id = {}
         @pickle_id_step_by_test_step_id = {}
         @hook_id_by_test_step_id = {}
@@ -33,22 +32,17 @@ module Cucumber
 
         # Ensure all handlers for events occur after all ivars are instantiated
 
-        config.on_event :gherkin_source_parsed, &method(:on_gherkin_source_parsed)
-
         config.on_event :hook_test_step_created, &method(:on_hook_test_step_created)
 
         config.on_event :step_activated, &method(:on_step_activated)
 
         config.on_event :test_case_created, &method(:on_test_case_created)
         config.on_event :test_case_ready, &method(:on_test_case_ready)
-        config.on_event :test_case_started, &method(:on_test_case_started)
-        config.on_event :test_case_finished, &method(:on_test_case_finished)
 
         config.on_event :test_run_started, &method(:on_test_run_started)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
 
         config.on_event :test_step_created, &method(:on_test_step_created)
-        config.on_event :test_step_started, &method(:on_test_step_started)
         config.on_event :test_step_finished, &method(:on_test_step_finished)
 
         config.on_event :attach_called, &method(:on_attach_called)
@@ -56,7 +50,13 @@ module Cucumber
       end
 
       def on_envelope(event)
+        @repository.update(event.envelope)
         store_current_test_run_hook_started_id(event)
+        @current_test_step_id = event.envelope.test_step_started.test_step_id if event.envelope.test_step_started
+        return unless event.envelope.test_case_started
+
+        @current_test_case_started_id = event.envelope.test_case_started.id
+        @current_test_run_hook_started_id = nil
       end
 
       def on_attach_called(event)
@@ -94,28 +94,31 @@ module Cucumber
 
       private
 
-      def on_gherkin_source_parsed(_event)
-        # TODO: Handle GherkinSourceParsed
-      end
-
       def on_hook_test_step_created(event)
+        # Set iVar value for `hook_id`
         @hook_id_by_test_step_id[event.test_step.id] = event.hook.id
       end
 
       def on_step_activated(event)
+        # Add/Update iVar value for `step_definition_ids...`
         @step_definition_ids_by_test_step_id[event.test_step.id] << event.step_match.step_definition.id
+        # Add/Update iVar value for `step_match_arguments...`
         @step_match_arguments_by_test_step_id[event.test_step.id] = event.step_match.step_arguments
       end
 
       def on_test_case_created(event)
+        # Set iVar value for `pickle_id`
         @pickle_id_by_test_case_id[event.test_case.id] = event.pickle.id
       end
 
       def on_test_case_ready(event)
+        # Use iVar value for `pickle_id`
+        pickle_id = @pickle_id_by_test_case_id.fetch(event.test_case.id)
+
         message = Cucumber::Messages::Envelope.new(
           test_case: Cucumber::Messages::TestCase.new(
             id: event.test_case.id,
-            pickle_id: fake_query_pickle_id(event.test_case),
+            pickle_id: pickle_id,
             test_steps: event.test_case.test_steps.map { |step| test_step_to_message(step) },
             test_run_started_id: @test_run_started_id
           )
@@ -127,55 +130,6 @@ module Cucumber
         @config.event_bus.envelope(message)
       end
 
-      def on_test_case_started(event)
-        # For any new test_case_started events, we must ALWAYS generate a new id for a new run
-        @current_test_case_started_id = @config.id_generator.new_id
-        @current_test_run_hook_started_id = nil
-
-        find_all_test_case_started_by_test_case_id =
-          @repository.test_case_started_by_id
-                     .values
-                     .select { |test_case_started| test_case_started.test_case_id == event.test_case.id }
-
-        # If no TestCaseStarted messages exist. We must be on attempt 1 (Hence the .to_i casting for a `nil` value)
-        attempts_previously_made = find_all_test_case_started_by_test_case_id.map(&:attempt).max.to_i
-
-        message = Cucumber::Messages::Envelope.new(
-          test_case_started: Cucumber::Messages::TestCaseStarted.new(
-            id: @current_test_case_started_id,
-            test_case_id: event.test_case.id,
-            timestamp: time_to_timestamp(Time.now),
-            attempt: attempts_previously_made + 1
-          )
-        )
-
-        @config.event_bus.envelope(message)
-        @repository.update(message)
-      end
-
-      def on_test_case_finished(event)
-        test_case_started_id =
-          @repository.test_case_started_by_id
-                     .values
-                     .detect { |test_case_started_message| test_case_started_message.test_case_id == event.test_case.id }
-                     .id
-
-        test_case_started_message = @repository.test_case_started_by_id[test_case_started_id]
-        max_attempts = @config.retry_attempts
-        retries_attempted = test_case_started_message.attempt - 1
-        will_be_retried = event.result.failed? && (retries_attempted < max_attempts)
-
-        message = Cucumber::Messages::Envelope.new(
-          test_case_finished: Cucumber::Messages::TestCaseFinished.new(
-            test_case_started_id: test_case_started_id,
-            timestamp: time_to_timestamp(Time.now),
-            will_be_retried: will_be_retried
-          )
-        )
-
-        @config.event_bus.envelope(message)
-      end
-
       def on_test_run_started(*)
         message = Cucumber::Messages::Envelope.new(
           test_run_started: Cucumber::Messages::TestRunStarted.new(
@@ -200,71 +154,14 @@ module Cucumber
       end
 
       def on_test_step_created(event)
+        # Set iVar value for `pickle_id_step_...`
         @pickle_id_step_by_test_step_id[event.test_step.id] = event.pickle_step.id
+        # Set iVar value for `step_definition_ids...`
         @step_definition_ids_by_test_step_id[event.test_step.id] = []
       end
 
-      def on_test_step_started(event)
-        @current_test_step_id = event.test_step.id
-        find_test_case_by_step_id =
-          @repository.test_case_by_id
-                     .values
-                     .detect { |test_case_message| test_case_message.test_steps.any? { |step_message| step_message.id == event.test_step.id } }
-
-        find_test_case_started_by_test_case =
-          @repository.test_case_started_by_id
-                     .values
-                     .select { |test_case_started_message| test_case_started_message.test_case_id == find_test_case_by_step_id.id }
-                     .max_by(&:attempt)
-
-        message = Cucumber::Messages::Envelope.new(
-          test_step_started: Cucumber::Messages::TestStepStarted.new(
-            test_step_id: event.test_step.id,
-            test_case_started_id: find_test_case_started_by_test_case.id,
-            timestamp: time_to_timestamp(Time.now)
-          )
-        )
-
-        @config.event_bus.envelope(message)
-      end
-
       def on_test_step_finished(event)
-        find_test_case_by_step_id =
-          @repository.test_case_by_id
-                     .values
-                     .detect { |test_case_message| test_case_message.test_steps.any? { |step_message| step_message.id == event.test_step.id } }
-
-        find_test_case_started_by_test_case =
-          @repository.test_case_started_by_id
-                     .values
-                     .select { |test_case_started_message| test_case_started_message.test_case_id == find_test_case_by_step_id.id }
-                     .max_by(&:attempt)
-
-        result = event.result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
-        result_message = result.to_message
-        if result.failed? || result.pending?
-          message_element = result.failed? ? result.exception : result
-
-          result_message = Cucumber::Messages::TestStepResult.new(
-            status: result_message.status,
-            duration: result_message.duration,
-            message: create_error_message(message_element),
-            exception: create_exception_object(result, message_element)
-          )
-        end
-
         output_snippet_envelope(event)
-
-        message = Cucumber::Messages::Envelope.new(
-          test_step_finished: Cucumber::Messages::TestStepFinished.new(
-            test_step_id: event.test_step.id,
-            test_case_started_id: find_test_case_started_by_test_case.id,
-            test_step_result: result_message,
-            timestamp: time_to_timestamp(Time.now)
-          )
-        )
-
-        @config.event_bus.envelope(message)
       end
 
       def output_snippet_envelope(event)
@@ -311,8 +208,10 @@ module Cucumber
 
         Cucumber::Messages::TestStep.new(
           id: step.id,
+          # Use iVar value for `pickle_id_step_...`
           pickle_step_id: @pickle_id_step_by_test_step_id[step.id],
-          step_definition_ids: fake_query_step_definition_ids(step),
+          # Use iVar value for `step_definition_ids...`
+          step_definition_ids: @step_definition_ids_by_test_step_id.fetch(step.id),
           step_match_arguments_lists: step_match_arguments_lists(step)
         )
       end
@@ -320,6 +219,7 @@ module Cucumber
       def hook_step_to_message(step)
         Cucumber::Messages::TestStep.new(
           id: step.id,
+          # Use iVar value for `hook_id`
           hook_id: @hook_id_by_test_step_id[step.id]
         )
       end
@@ -334,7 +234,9 @@ module Cucumber
       end
 
       def step_match_arguments(step)
-        fake_query_step_match_arguments(step)&.map do |argument|
+        # Use iVar value for `step_match_arguments...`
+        step_matches = @step_match_arguments_by_test_step_id[step.id]
+        step_matches&.map do |argument|
           Cucumber::Messages::StepMatchArgument.new(
             group: argument_group_to_message(argument.group),
             parameter_type_name: parameter_type_name(argument)
@@ -370,22 +272,6 @@ module Cucumber
           stack_trace: message_element.backtrace.join("\n")
         )
       end
-
-      def fake_query_hook_id(test_step)
-        @hook_id_by_test_step_id.fetch(test_step.id)
-      end
-
-      def fake_query_pickle_id(test_case)
-        @pickle_id_by_test_case_id.fetch(test_case.id)
-      end
-
-      def fake_query_step_definition_ids(test_step)
-        @step_definition_ids_by_test_step_id.fetch(test_step.id)
-      end
-
-      def fake_query_step_match_arguments(test_step)
-        @step_match_arguments_by_test_step_id.fetch(test_step.id, nil)
-      end
     end
   end
 end

data/lib/cucumber/formatter/pretty.rb

@@ -151,7 +151,7 @@ module Cucumber
       private
 
       def find_exception_to_be_printed(result)
-        return nil if result.ok?(strict: options[:strict])
+        return nil if result.ok?
 
         result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
         exception = result.failed? ? result.exception : result

data/lib/cucumber/formatter/rerun.rb

@@ -28,42 +28,20 @@ module Cucumber
       def finish_report
         @query.find_all_test_case_started.each do |test_case|
           status = @query.find_most_severe_test_step_result_by(test_case).status
-          # RULE: Don't log test cases without a pickle (Unsure what these could be?)
+
+          # RULE: Don't log test cases without a pickle (We cannot query their location data to log them)
           pickle = @query.find_pickle_by(test_case)
           next if pickle.nil?
 
-          # RULE: (Configuration specific)
-          #   -> If the test case has already been logged (And so we're retrying), we remove prior references of failures
-          if passing?(test_case) && !rerun_flaky_tests?
+          # RULE: Test cases with the worst result as Passing is not considered a failure (Don't log these)
+          if status == Cucumber::Messages::TestStepResultStatus::PASSED
+            # If the test case in question had already been logged as a failure (And we're retrying), remove the prior reference of failure
             uri_and_location_hash[pickle.uri].delete(pickle.location.line)
             next
           end
 
-          # RULE: (Configuration specific - to be amended once CCK conformance is finalised)
-          #   -> If the strict configuration permits the result - handle it accordingly
-          if status == 'UNDEFINED' && !@config.strict.strict?(:undefined)
-            Cucumber.deprecate(
-              'The strict configuration in cucumber is going away and moving towards a standardised set of behaviours',
-              '--strict=undefined',
-              '12.0.0'
-            )
-            next
-          end
-
-          if status == 'PENDING' && !@config.strict.strict?(:pending)
-            Cucumber.deprecate(
-              'The strict configuration in cucumber is going away and moving towards a standardised set of behaviours',
-              '--strict=pending',
-              '12.0.0'
-            )
-            next
-          end
-
-          # RULE: Passing test cases are not considered failures (Don't log these)
-          next if passing?(test_case)
-
-          # RULE: Skipped test cases are not considered failures (on their own, don't log these)
-          next if skipped?(test_case)
+          # RULE: Test cases with the worst result as Skipped/Pending/Undefined are not considered failures (don't log these)
+          next if non_rerunnable_status?(status)
 
           # RULE: Before logging a failure, ensure we are not on a retried test case (Don't log a retry multiple times)
           next if test_case.attempt > 1
@@ -86,18 +64,12 @@ module Cucumber
         @uri_and_location_hash ||= Hash.new { |hash, key| hash[key] = Set.new }
       end
 
-      def rerun_flaky_tests?
-        @config.strict.strict?(:flaky)
-      end
-
-      def passing?(test_case_started)
-        most_severe_test_step_result = @query.find_most_severe_test_step_result_by(test_case_started)
-        most_severe_test_step_result.status == Cucumber::Messages::TestStepResultStatus::PASSED
-      end
-
-      def skipped?(test_case_started)
-        most_severe_test_step_result = @query.find_most_severe_test_step_result_by(test_case_started)
-        most_severe_test_step_result.status == Cucumber::Messages::TestStepResultStatus::SKIPPED
+      def non_rerunnable_status?(status)
+        [
+          Cucumber::Messages::TestStepResultStatus::SKIPPED,
+          Cucumber::Messages::TestStepResultStatus::PENDING,
+          Cucumber::Messages::TestStepResultStatus::UNDEFINED
+        ].include?(status)
       end
     end
   end

data/lib/cucumber/glue/hook.rb

@@ -4,7 +4,6 @@ require 'cucumber/glue/invoke_in_world'
 
 module Cucumber
   module Glue
-    # TODO: Kill pointless wrapper for Before, After and AfterStep hooks with fire
     class Hook
       attr_reader :id, :tag_expressions, :location, :name
 

data/lib/cucumber/glue/multiple_world.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Glue
+    # Raised if there are 2 or more World blocks.
+    class MultipleWorld < StandardError
+      def initialize(first_proc, second_proc)
+        super(error_message(first_proc, second_proc))
+      end
+
+      def error_message(first_proc, second_proc)
+        <<~MESSAGE
+      You can only pass a proc to #World once, but it's happening
+      in 2 places:
+      #{Glue.backtrace_line(first_proc, 'World')}
+      #{Glue.backtrace_line(second_proc, 'World')}
+      Use Ruby modules instead to extend your worlds. See the Cucumber::Glue::Dsl#World RDoc
+      or http://wiki.github.com/cucumber/cucumber/a-whole-new-world.
+
+
+        MESSAGE
+      end
+    end
+
+  end
+end

data/lib/cucumber/glue/nil_world.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Glue
+    # Raised if a World block returns Nil.
+    class NilWorld < StandardError
+      def initialize
+        super('World procs should never return nil')
+      end
+    end
+  end
+end

data/lib/cucumber/glue/registry_and_more.rb

@@ -6,17 +6,22 @@ require 'cucumber/cucumber_expressions/regular_expression'
 require 'cucumber/cucumber_expressions/cucumber_expression_generator'
 require 'cucumber/messages/helpers/time_conversion'
 
-require 'cucumber/glue/dsl'
-require 'cucumber/glue/snippet'
-require 'cucumber/glue/hook'
-require 'cucumber/glue/proto_world'
-require 'cucumber/glue/step_definition'
-require 'cucumber/glue/world_factory'
-require 'cucumber/gherkin/i18n'
+require_relative 'dsl'
+require_relative 'snippet'
+require_relative 'hook'
+require_relative 'proto_world'
+require_relative 'step_definition'
+require_relative 'world_factory'
+require_relative '../step_match'
+require_relative '../gherkin/i18n'
+
 require 'multi_test'
-require 'cucumber/step_match'
-require 'cucumber/events/base'
-require 'cucumber/events/step_definition_registered'
+require 'cucumber/core/event/base'
+
+require_relative '../events/step_definition_registered'
+
+require_relative 'multiple_world'
+require_relative 'nil_world'
 
 module Cucumber
   module Glue
@@ -25,28 +30,6 @@ module Cucumber
       "#{location}:in `#{name}'"
     end
 
-    # Raised if a World block returns Nil.
-    class NilWorld < StandardError
-      def initialize
-        super('World procs should never return nil')
-      end
-    end
-
-    # Raised if there are 2 or more World blocks.
-    class MultipleWorld < StandardError
-      def initialize(first_proc, second_proc)
-        # TODO: [LH] - Just use a heredoc here to fix this up
-        message = String.new
-        message << "You can only pass a proc to #World once, but it's happening\n"
-        message << "in 2 places:\n\n"
-        message << Glue.backtrace_line(first_proc, 'World') << "\n"
-        message << Glue.backtrace_line(second_proc, 'World') << "\n\n"
-        message << "Use Ruby modules instead to extend your worlds. See the Cucumber::Glue::Dsl#World RDoc\n"
-        message << "or http://wiki.github.com/cucumber/cucumber/a-whole-new-world.\n\n"
-        super(message)
-      end
-    end
-
     # TODO: This class has too many responsibilities, split off
     class RegistryAndMore
       attr_reader :current_world, :step_definitions

data/lib/cucumber/multiline_argument/data_table.rb

@@ -77,7 +77,7 @@ module Cucumber
 
       # This is a Hash being initialized with a default value of a Hash
       # DO NOT REFORMAT TO REMOVE {} - Ruby 3.4+ will interpret these as keywords and cucumber will not work
-      NULL_CONVERSIONS = Hash.new({ strict: false, proc: ->(cell_value) { cell_value } }).freeze
+      NULL_CONVERSIONS = Hash.new({ proc: ->(cell_value) { cell_value } }).freeze
 
       # @param data [Core::Test::DataTable] the data for the table
       # @param conversion_procs [Hash] see map_column
@@ -265,9 +265,7 @@ module Cucumber
       # Returns a new Table with an additional column mapping.
       #
       # Change how #hashes converts column values. The +column_name+ argument identifies the column
-      # and +conversion_proc+ performs the conversion for each cell in that column. If +strict+ is
-      # true, an error will be raised if the column named +column_name+ is not found. If +strict+
-      # is false, no error will be raised. Example:
+      # and +conversion_proc+ performs the conversion for each cell in that column.
       #
       #   Given /^an expense report for (.*) with the following posts:$/ do |table|
       #     posts_table = posts_table.map_column('amount') { |a| a.to_i }
@@ -276,9 +274,9 @@ module Cucumber
       #     end
       #   end
       #
-      def map_column(column_name, strict: true, &conversion_proc)
+      def map_column(column_name, &conversion_proc)
         conversion_procs = @conversion_procs.dup
-        conversion_procs[column_name.to_s] = { strict: strict, proc: conversion_proc }
+        conversion_procs[column_name.to_s] = { proc: conversion_proc }
         self.class.new(Core::Test::DataTable.new(raw), conversion_procs, @header_mappings.dup, @header_conversion_proc)
       end
 
@@ -467,7 +465,7 @@ module Cucumber
 
       def convert_columns!
         @conversion_procs.each do |column_name, conversion_proc|
-          verify_column(column_name) if conversion_proc[:strict]
+          verify_column(column_name)
         end
 
         cell_matrix.transpose.each do |col|

data/lib/cucumber/retry_policy.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Cucumber
+  # Decides whether a failed test case is run again, honouring both the `--retry` and the `--retry-total` options.
+  #
+  # The retry filter asks it and then records what it did, the test runner asks it when it reports the outcome of a
+  # test case. Both have to get the same answer, so #will_be_retried? never changes the state of the policy.
+  class RetryPolicy
+    def initialize(max_retries, max_permanent_failures)
+      @max_retries = max_retries
+      @max_permanent_failures = max_permanent_failures
+      @retries = Hash.new(0)
+      @permanent_failures = 0
+    end
+
+    def will_be_retried?(test_case, result)
+      return false unless result.failed?
+      return false if @permanent_failures >= @max_permanent_failures
+
+      @retries[test_case] < @max_retries
+    end
+
+    def record_retry(test_case) = @retries[test_case] += 1
+
+    def record_permanent_failure = @permanent_failures += 1
+  end
+end

data/lib/cucumber/rspec/doubles.rb

@@ -5,15 +5,9 @@ require 'rspec/mocks'
 World(RSpec::Mocks::ExampleMethods)
 
 Before do
-  if RSpec::Mocks::Version::STRING >= '2.9.9'
-    RSpec::Mocks.setup
-  else
-    RSpec::Mocks.setup(self)
-  end
+  RSpec::Mocks.setup(self)
 end
 
 After do
-  RSpec::Mocks.verify
-ensure
   RSpec::Mocks.teardown
 end

data/lib/cucumber/runtime/meta_message_builder.rb

@@ -70,7 +70,7 @@ module Cucumber
         def os
           Cucumber::Messages::Product.new(
             name: RbConfig::CONFIG['target_os'],
-            version: Sys::Uname.uname.version
+            version: Sys::Uname.version
           )
         end
 

data/lib/cucumber/runtime/user_interface.rb

@@ -22,6 +22,7 @@ module Cucumber
       # that makes a sound before invoking #ask.
       #
       def ask(question, timeout_seconds)
+        Cucumber.deprecate(ask_deprecation_message, 'Cucumber::Runtime#ask (From UserInterface Module)', 'v12')
         $stdout.puts(question)
         $stdout.flush
         puts(question)
@@ -49,6 +50,18 @@ module Cucumber
 
       private
 
+      def ask_deprecation_message
+        <<~MESSAGE
+          The `#ask` method has been present in cucumber for a while, but its purpose outside of cucumber is
+          questionable. It is being deprecated and will be removed in a future version (Targeting v12).
+
+          If you are using it in your own code, you should remove the dependency on it and implement your own version
+          of it. If you are using it in a step definition, you should consider whether that is really necessary and
+          use either a conditional waiter or use a tag so that the scenario doesn't automatically run in a CI
+          environment where there is no operator to answer the question.
+        MESSAGE
+      end
+
       def mri_gets(timeout_seconds)
         Timeout.timeout(timeout_seconds) do
           $stdin.gets