cucumber 11.1.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41a92bddb6a0e5cdf8a69b28abfc455f4d77516e3f4abd8283cd6a222d1f5bd9
-  data.tar.gz: 743067172c8d6e732e86a2417dfa43b809ecff66ad772477460af2b1e217c234
+  metadata.gz: 1afa805afc19084236a0c669140643f73d58830be94b68ce95101093ee1ac094
+  data.tar.gz: e0000b36b86fc3a28dd727b11fb3b449996d0219d4bcc17bacfad8a4d5fcdc56
 SHA512:
-  metadata.gz: b26e638126d5f0d7846390ed1ddbf2b38c76d92c19e43aa859ba8432b04a017e509a018e55abb590ad523e31f295daeec9e210506b862a310e996b138cb113ab
-  data.tar.gz: 5360ce612562f89839f87cf568f8a0adc3d732e224f99900653e8c58a0b4c51892932c9568b10e58365f2652fe867023d7bd32f05df7a95860583167b52cfd55
+  metadata.gz: 40f7f93918b8de9376adca4c9a0d8b78f365f629d7244116a5247b795b64b3b9c592515f4dc93eab7f6a700610facc0b745ad06360833a36b4bb99fcc7080727
+  data.tar.gz: bdfe41db58fc69daea12ccc35f5b52e8623ca590db609e85228eb6c34f772516de59a51e11cd5ac8d6426de3dbabd3df05966a3df58cd9f46fbc4342b59a26e5

data/VERSION

@@ -1 +1 @@
-11.1.0
+12.0.0

data/lib/cucumber/cli/configuration.rb

@@ -27,8 +27,6 @@ module Cucumber
         @args = args
         @options.parse!(args)
         arrange_formats
-        raise("You can't use both --strict and --wip") if strict.strict? && wip?
-
         set_environment_variables
       end
 
@@ -44,10 +42,6 @@ module Cucumber
         Integer(@options[:seed] || rand(0xFFFF))
       end
 
-      def strict
-        @options[:strict]
-      end
-
       def wip?
         @options[:wip]
       end

data/lib/cucumber/cli/options.rb

@@ -132,10 +132,6 @@ module Cucumber
           opts.on('-q', '--quiet', 'Alias for --no-snippets --no-source --no-duration --publish-quiet.') { shut_up }
           opts.on('--no-duration', "Don't print the duration at the end of the summary") { set_option :duration, false }
           opts.on('-b', '--backtrace', 'Show full backtrace for all errors.') { Cucumber.use_full_backtrace = true }
-          opts.on('-S', '--[no-]strict', *strict_msg) { |setting| set_strict(setting) }
-          opts.on('--[no-]strict-undefined', 'Fail if there are any undefined results.') { |setting| set_strict(setting, :undefined) }
-          opts.on('--[no-]strict-pending', 'Fail if there are any pending results.') { |setting| set_strict(setting, :pending) }
-          opts.on('--[no-]strict-flaky', 'Fail if there are any flaky results.') { |setting| set_strict(setting, :flaky) }
           opts.on('-w', '--wip', 'Fail if there are any passing scenarios.') { set_option :wip }
           opts.on('-v', '--verbose', 'Show the files and features loaded.') { set_option :verbose }
           opts.on('-g', '--guess', 'Guess best match for Ambiguous steps.') { set_option :guess }
@@ -289,13 +285,6 @@ module Cucumber
         ]
       end
 
-      def strict_msg
-        [
-          'Fail if there are any strict affected results ',
-          '(that is undefined, pending or flaky results).'
-        ]
-      end
-
       def parse_formats(value)
         formatter, *formatter_options = value.split(',')
         options_hash = Hash[formatter_options.map { |string| string.split('=') }]
@@ -467,10 +456,6 @@ module Cucumber
         @options[:duration] = false
       end
 
-      def set_strict(setting, type = nil)
-        @options[:strict].set_strict(setting, type)
-      end
-
       def stdout_formats
         @options[:formats].select { |_, _, output| output == @out_stream }
       end
@@ -528,7 +513,6 @@ module Cucumber
         @options[:source] &= other_options[:source]
         @options[:snippets] &= other_options[:snippets]
         @options[:duration] &= other_options[:duration]
-        @options[:strict] = other_options[:strict].merge!(@options[:strict])
         @options[:dry_run] |= other_options[:dry_run]
 
         @profiles += other_options.profiles

data/lib/cucumber/configuration.rb

@@ -6,6 +6,7 @@ require 'cucumber/events'
 require 'cucumber/messages'
 require 'cucumber/core/event_bus'
 require 'cucumber/core/test/result'
+require 'cucumber/retry_policy'
 require 'forwardable'
 require 'cucumber'
 
@@ -23,7 +24,6 @@ module Cucumber
       {
         autoload_code_paths: %w[features/support features/step_definitions],
         filters: [],
-        strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
         require: [],
         dry_run: false,
         fail_fast: false,
@@ -114,10 +114,6 @@ module Cucumber
       @options[:guess]
     end
 
-    def strict
-      @options[:strict]
-    end
-
     def wip?
       @options[:wip]
     end
@@ -285,6 +281,10 @@ module Cucumber
       @id_generator ||= Cucumber::Messages::Helpers::IdGenerator::UUID.new
     end
 
+    def retry_policy
+      @retry_policy ||= RetryPolicy.new(retry_attempts, retry_total_tests)
+    end
+
     def test_run_started_id
       @test_run_started_id ||= id_generator.new_id
     end

data/lib/cucumber/errors.rb

@@ -3,6 +3,49 @@
 require 'cucumber/core/test/result'
 
 module Cucumber
+  # Raised when a step matches 2 or more StepDefinitions
+  class Ambiguous < StandardError
+    def initialize(step_name, step_definitions, used_guess)
+      # TODO: [LH] - Just use a heredoc here to fix this up
+      message = String.new
+      message << "Ambiguous match of \"#{step_name}\":\n\n"
+      message << step_definitions.map(&:backtrace_line).join("\n")
+      message << "\n\n"
+      message << "You can run again with --guess to make Cucumber be more smart about it\n" unless used_guess
+      super(message)
+    end
+  end
+
+  class FeatureFolderNotFoundException < RuntimeError
+    def initialize(path)
+      @path = path
+      super
+    end
+
+    def message
+      "No such file or directory - #{@path}"
+    end
+  end
+
+  class FileNotFoundException < RuntimeError
+    attr_reader :path
+
+    def initialize(original_exception, path)
+      @path = path
+      super(original_exception)
+    end
+  end
+
+  # Raised when a StepDefinition's block invokes World#pending
+  class Pending < Core::Test::Result::Pending
+  end
+
+  class TagExcess < StandardError
+    def initialize(messages)
+      super(messages.join("\n"))
+    end
+  end
+
   # Raised when there is no matching StepDefinition for a step.
   class Undefined < Core::Test::Result::Undefined
     def self.from(result, step_name)
@@ -27,27 +70,4 @@ module Cucumber
       super %(Undefined dynamic step: "#{step_name}")
     end
   end
-
-  # Raised when a StepDefinition's block invokes World#pending
-  class Pending < Core::Test::Result::Pending
-  end
-
-  # Raised when a step matches 2 or more StepDefinitions
-  class Ambiguous < StandardError
-    def initialize(step_name, step_definitions, used_guess)
-      # TODO: [LH] - Just use a heredoc here to fix this up
-      message = String.new
-      message << "Ambiguous match of \"#{step_name}\":\n\n"
-      message << step_definitions.map(&:backtrace_line).join("\n")
-      message << "\n\n"
-      message << "You can run again with --guess to make Cucumber be more smart about it\n" unless used_guess
-      super(message)
-    end
-  end
-
-  class TagExcess < StandardError
-    def initialize(messages)
-      super(messages.join("\n"))
-    end
-  end
 end

data/lib/cucumber/events/attach_called.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Events
+    # Fired when attach is called in a step definition
+    class AttachCalled < Core::Event::Base
+      # The attachment body
+      attr_reader :src
+
+      # The content media type
+      attr_reader :media_type
+
+      # An optional filename
+      attr_reader :filename
+
+      def self.event_id
+        :attach_called
+      end
+
+      def initialize(src, media_type, filename)
+        @src = src
+        @media_type = media_type
+        @filename = filename
+        super()
+      end
+    end
+  end
+end

data/lib/cucumber/events/envelope.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require 'cucumber/core/event/base'
 
 module Cucumber
   module Events
-    class Envelope < Base
+    class Envelope < Core::Event::Base
       attr_reader :envelope
 
       def self.event_id

data/lib/cucumber/events/gherkin_source_parsed.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Cucumber
   module Events
     # Fired after we've parsed the contents of a feature file
-    class GherkinSourceParsed < Base
+    class GherkinSourceParsed < Core::Event::Base
       # # The Gherkin Ast
       attr_reader :gherkin_document
 

data/lib/cucumber/events/gherkin_source_read.rb

@@ -3,7 +3,7 @@
 module Cucumber
   module Events
     # Fired after we've read in the contents of a feature file
-    class GherkinSourceRead < Base
+    class GherkinSourceRead < Core::Event::Base
       # The path to the file
       attr_reader :path
 

data/lib/cucumber/events/hook_test_step_created.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Cucumber
   module Events
     # Event fired when a step is created from a hook
-    class HookTestStepCreated < Base
+    class HookTestStepCreated < Core::Event::Base
       attr_reader :test_step, :hook
 
       def self.event_id

data/lib/cucumber/events/step_activated.rb

@@ -3,7 +3,7 @@
 module Cucumber
   module Events
     # Event fired when a step is activated
-    class StepActivated < Base
+    class StepActivated < Core::Event::Base
       # The test step that was matched.
       #   @return [Cucumber::Core::Test::Step]
       attr_reader :test_step

data/lib/cucumber/events/step_definition_registered.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Cucumber
   module Events
     # Event fired after each step definition has been registered
-    class StepDefinitionRegistered < Base
+    class StepDefinitionRegistered < Core::Event::Base
       # The step definition that was just registered.
       #   @return [RbSupport::RbStepDefinition]
       attr_reader :step_definition

data/lib/cucumber/events/test_case_created.rb

@@ -3,7 +3,7 @@
 module Cucumber
   module Events
     # Event fired when a Test::Case is created from a Pickle
-    class TestCaseCreated < Base
+    class TestCaseCreated < Core::Event::Base
       attr_reader :test_case, :pickle
 
       def self.event_id

data/lib/cucumber/events/test_case_finished.rb

@@ -3,7 +3,7 @@
 module Cucumber
   module Events
     # Event fired when a Test::Case is created from a Pickle
-    class TestCaseFinished < Base
+    class TestCaseFinished < Core::Event::Base
       # @return [Cucumber::Core::Test::Case] that was executed
       attr_reader :test_case
 

data/lib/cucumber/events/test_case_ready.rb

@@ -2,7 +2,7 @@
 
 module Cucumber
   module Events
-    class TestCaseReady < Base
+    class TestCaseReady < Core::Event::Base
       attr_reader :test_case
 
       def self.event_id

data/lib/cucumber/events/test_case_started.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Cucumber
   module Events
     # Signals that a {Cucumber::Core::Test::Case} is about to be executed
-    class TestCaseStarted < Base
+    class TestCaseStarted < Core::Event::Base
       # @return [Cucumber::Core::Test::Case] the test case to be executed
       attr_reader :test_case
 

data/lib/cucumber/events/test_run_finished.rb

@@ -3,7 +3,7 @@
 module Cucumber
   module Events
     # Event fired after all test cases have finished executing
-    class TestRunFinished < Base
+    class TestRunFinished < Core::Event::Base
       attr_reader :success
 
       def self.event_id

data/lib/cucumber/events/test_run_hook_finished.rb

@@ -2,7 +2,7 @@
 
 module Cucumber
   module Events
-    class TestRunHookFinished < Base
+    class TestRunHookFinished < Core::Event::Base
       attr_reader :hook, :test_result
 
       def self.event_id

data/lib/cucumber/events/test_run_hook_started.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
-    class TestRunHookStarted < Base
+    class TestRunHookStarted < Core::Event::Base
       attr_reader :hook
 
       def self.event_id

data/lib/cucumber/events/test_run_started.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Cucumber
   module Events
     # Event fired once all test cases have been filtered before
     # the first one is executed.
-    class TestRunStarted < Base
+    class TestRunStarted < Core::Event::Base
       # @return [Array<Cucumber::Core::Test::Case>] the test cases to be executed
       attr_reader :test_cases
 

data/lib/cucumber/events/test_step_created.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Cucumber
   module Events
     # Event fired when a TestStep is created from a PickleStep
-    class TestStepCreated < Base
+    class TestStepCreated < Core::Event::Base
       attr_reader :test_step, :pickle_step
 
       def self.event_id

data/lib/cucumber/events/test_step_finished.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Cucumber
   module Events
     # Signals that a {Cucumber::Core::Test::Step} has finished executing
-    class TestStepFinished < Base
+    class TestStepFinished < Core::Event::Base
       # @return [Cucumber::Core::Test::Step] the test step that was executed
       attr_reader :test_step
 

data/lib/cucumber/events/test_step_started.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Cucumber
   module Events
     # Signals that a {Cucumber::Core::Test::Step} is about to be executed
-    class TestStepStarted < Base
+    class TestStepStarted < Core::Event::Base
       # @return [Cucumber::Core::Test::Step] the test step to be executed
       attr_reader :test_step
 

data/lib/cucumber/events/undefined_parameter_type.rb

@@ -2,7 +2,7 @@
 
 module Cucumber
   module Events
-    class UndefinedParameterType < Base
+    class UndefinedParameterType < Core::Event::Base
       attr_reader :type_name, :expression
 
       def self.event_id

data/lib/cucumber/events.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
-Dir["#{File.dirname(__FILE__)}/events/*.rb"].map(&method(:require))
+require 'cucumber/core/event/base'
+
+Dir[File.join(__dir__, 'events', '*.rb')].each do |file|
+  require_relative File.join('events', File.basename(file))
+end
 
 module Cucumber
   # Events tell you what's happening while Cucumber runs your features.
@@ -23,7 +27,8 @@ module Cucumber
     end
 
     def self.registry
-      Core::Events.build_registry(
+      Core::EventBus.build_registry(
+        AttachCalled,
         GherkinSourceParsed,
         GherkinSourceRead,
         HookTestStepCreated,

data/lib/cucumber/filters/retry.rb

@@ -7,16 +7,11 @@ require 'cucumber/events'
 module Cucumber
   module Filters
     class Retry < Core::Filter.new(:configuration)
-      def initialize(*_args)
-        super
-        @total_permanently_failed = 0
-      end
-
       def test_case(test_case)
         configuration.on_event(:test_case_finished) do |event|
-          next unless retry_required?(test_case, event)
+          next unless event.test_case == test_case
+          next unless retry?(test_case, event.result)
 
-          test_case_counts[test_case] += 1
           test_case.describe_to(receiver)
         end
 
@@ -25,27 +20,17 @@ module Cucumber
 
       private
 
-      def retry_required?(test_case, event)
-        return false unless event.test_case == test_case
-
-        return false unless event.result.failed?
-
-        return false if @total_permanently_failed >= configuration.retry_total_tests
-
-        retry_required = test_case_counts[test_case] < configuration.retry_attempts
-        if retry_required
-          # retry test
+      def retry?(test_case, result)
+        if retry_policy.will_be_retried?(test_case, result)
+          retry_policy.record_retry(test_case)
           true
         else
-          # test failed after max. attempts
-          @total_permanently_failed += 1
+          retry_policy.record_permanent_failure if result.failed?
           false
         end
       end
 
-      def test_case_counts
-        @test_case_counts ||= Hash.new { |h, k| h[k] = 0 }
-      end
+      def retry_policy = configuration.retry_policy
     end
   end
 end

data/lib/cucumber/formatter/console.rb

@@ -169,15 +169,15 @@ module Cucumber
         end
       end
 
-      def attach(src, media_type, filename, _streamed_file)
-        return unless media_type == 'text/x.cucumber.log+plain'
+      def on_attach_called(event)
+        return unless event.media_type == 'text/x.cucumber.log+plain'
         return unless @io
 
         @io.puts
-        if filename
-          @io.puts("#{filename}: #{format_string(src, :tag)}")
+        if event.filename
+          @io.puts("#{event.filename}: #{format_string(event.src, :tag)}")
         else
-          @io.puts(format_string(src, :tag))
+          @io.puts(format_string(event.src, :tag))
         end
 
         @io.flush

data/lib/cucumber/formatter/console_counts.rb

@@ -31,9 +31,11 @@ module Cucumber
       end
 
       def status_counts(summary)
-        counts = Core::Test::Result::TYPES.map { |status| [status, summary.total(status)] }
-        counts = counts.select { |_status, count| count.positive? }
-        counts = counts.map { |status, count| format_string("#{count} #{status}", status) }
+        counts =
+          Cucumber::Core::Test::Result::BooleanMethods::TYPES
+            .map { |status| [status, summary.total(status)] }
+            .select { |_status, count| count.positive? }
+            .map { |status, count| format_string("#{count} #{status}", status) }
         "(#{counts.join(', ')})" if counts.any?
       end
     end

data/lib/cucumber/formatter/console_issues.rb

@@ -15,9 +15,9 @@ module Cucumber
         @config.on_event(:test_case_finished) do |event|
           if event.test_case != @previous_test_case
             @previous_test_case = event.test_case
-            @issues[event.result.to_sym] << event.test_case unless event.result.ok?(strict: @config.strict)
+            @issues[event.result.to_sym] << event.test_case unless event.result.ok?
           elsif event.result.passed?
-            @issues[:flaky] << event.test_case unless Core::Test::Result::Flaky.ok?(strict: @config.strict.strict?(:flaky))
+            @issues[:flaky] << event.test_case unless Core::Test::Result::Flaky.ok?
             @issues[:failed].delete(event.test_case)
           end
         end
@@ -25,7 +25,7 @@ module Cucumber
       end
 
       def to_s
-        test_case_result = @issues.empty? ? [] : Core::Test::Result::TYPES.map { |type| scenario_listing(type, @issues[type]) }
+        test_case_result = @issues.empty? ? [] : Cucumber::Core::Test::Result::BooleanMethods::TYPES.map { |type| scenario_listing(type, @issues[type]) }
         global_hooks_result = @global_hooks_summary.ok? ? [] : @global_hooks_summary.exception_listing
         [test_case_result + global_hooks_result].flatten.join("\n")
       end

data/lib/cucumber/formatter/duration_extractor.rb

@@ -27,8 +27,6 @@ module Cucumber
       def duration(duration, *)
         duration.tap { |dur| @result_duration = dur.nanoseconds / 10**9.0 }
       end
-
-      def attach(*) end
     end
   end
 end

data/lib/cucumber/formatter/fail_fast.rb

@@ -8,10 +8,10 @@ module Cucumber
     class FailFast
       def initialize(configuration)
         @previous_test_case = nil
-        configuration.on_event :test_case_finished do |event|
+        configuration.on_event(:test_case_finished) do |event|
           if event.test_case != @previous_test_case
             @previous_test_case = event.test_case
-            Cucumber.wants_to_quit = true unless event.result.ok?(strict: configuration.strict)
+            Cucumber.wants_to_quit = true unless event.result.ok?
           elsif event.result.passed?
             Cucumber.wants_to_quit = false
           end

data/lib/cucumber/formatter/html.rb

@@ -1,22 +1,26 @@
 # frozen_string_literal: true
 
-require 'cucumber/formatter/io'
 require 'cucumber/html_formatter'
-require 'cucumber/formatter/message_builder'
+
+require_relative 'io'
 
 module Cucumber
   module Formatter
-    class HTML < MessageBuilder
+    class HTML
+      include Io
+
       def initialize(config)
+        @config = config
         @io = ensure_io(config.out_stream, config.error_stream)
         @html_formatter = Cucumber::HTMLFormatter::Formatter.new(@io)
         @html_formatter.write_pre_message
-        super(config)
+        config.on_event :envelope, &method(:on_envelope)
       end
 
-      def output_envelope(envelope)
-        @repository.update(envelope)
+      def on_envelope(event)
+        envelope = event.envelope
         @html_formatter.write_message(envelope)
+        # TODO: Move this conditional logic into the HTML formatter proper
         @html_formatter.write_post_message if envelope.test_run_finished
       end
     end