cucumber 8.0.0.rc.1 → 9.0.0

data/README.md

@@ -4,6 +4,7 @@
 
 # Cucumber
 
+[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
 [![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
 [![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
 [![pull requests](https://oselvar.com/api/badge?label=pull%20requests&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-ruby%2FpullRequests.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
@@ -50,13 +51,13 @@ Later in this document, bundler is considered being used so all commands are usi
 
 ### Supported platforms
 
+- Ruby 3.2
 - Ruby 3.1
 - Ruby 3.0
 - Ruby 2.7
-- Ruby 2.6
+- TruffleRuby 22.0.0+
 - JRuby (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
-  - 9.3 >= 9.3.1 (there is a known issue with JRuby 9.3.0. More info can
-    be found in the [PR#1571](https://github.com/cucumber/cucumber-ruby/pull/1571).)
+  - 9.4
 
 ### Ruby on Rails
 

data/lib/cucumber/cli/options.rb

@@ -56,11 +56,12 @@ module Cucumber
       NO_PROFILE_LONG_FLAG = '--no-profile'.freeze
       FAIL_FAST_FLAG = '--fail-fast'.freeze
       RETRY_FLAG = '--retry'.freeze
+      RETRY_TOTAL_FLAG = '--retry-total'.freeze
       OPTIONS_WITH_ARGS = [
         '-r', '--require', '--i18n-keywords', '-f', '--format', '-o',
         '--out', '-t', '--tags', '-n', '--name', '-e', '--exclude',
-        PROFILE_SHORT_FLAG, PROFILE_LONG_FLAG, RETRY_FLAG, '-l',
-        '--lines', '--port', '-I', '--snippet-type'
+        PROFILE_SHORT_FLAG, PROFILE_LONG_FLAG, RETRY_FLAG, RETRY_TOTAL_FLAG,
+        '-l', '--lines', '--port', '-I', '--snippet-type'
       ].freeze
       ORDER_TYPES = %w[defined random].freeze
       TAG_LIMIT_MATCHER = /(?<tag_name>@\w+):(?<limit>\d+)/x
@@ -108,6 +109,7 @@ module Cucumber
           opts.on('-j DIR', '--jars DIR', 'Load all the jars under DIR') { |jars| load_jars(jars) } if Cucumber::JRUBY
 
           opts.on("#{RETRY_FLAG} ATTEMPTS", *retry_msg) { |v| set_option :retry, v.to_i }
+          opts.on("#{RETRY_TOTAL_FLAG} TESTS", *retry_total_msg) { |v| set_option :retry_total, v.to_i }
           opts.on('--i18n-languages', *i18n_languages_msg) { list_languages_and_exit }
           opts.on('--i18n-keywords LANG', *i18n_keywords_msg) { |lang| language lang }
           opts.on(FAIL_FAST_FLAG, 'Exit immediately following the first failing scenario') { set_option :fail_fast }
@@ -271,6 +273,13 @@ Specify SEED to reproduce the shuffling from a previous run.
         ['Specify the number of times to retry failing tests (default: 0)']
       end
 
+      def retry_total_msg
+        [
+          'The total number of failing test after which retrying of tests is suspended.',
+          'Example: --retry-total 10 -> Will stop retrying tests after 10 failing tests.'
+        ]
+      end
+
       def name_msg
         [
           'Only execute the feature elements which match part of the given name.',
@@ -543,6 +552,7 @@ Specify SEED to reproduce the shuffling from a previous run.
         end
 
         @options[:retry] = other_options[:retry] if @options[:retry].zero?
+        @options[:retry_total] = other_options[:retry_total] if @options[:retry_total].infinite?
 
         self
       end
@@ -616,7 +626,8 @@ Specify SEED to reproduce the shuffling from a previous run.
           snippets: true,
           source: true,
           duration: true,
-          retry: 0
+          retry: 0,
+          retry_total: Float::INFINITY
         }
       end
     end

data/lib/cucumber/configuration.rb

@@ -78,6 +78,10 @@ module Cucumber
       @options[:retry]
     end
 
+    def retry_total_tests
+      @options[:retry_total]
+    end
+
     def guess?
       @options[:guess]
     end
@@ -273,7 +277,8 @@ module Cucumber
         snippets: true,
         source: true,
         duration: true,
-        event_bus: Cucumber::Events.make_event_bus
+        event_bus: Cucumber::Events.make_event_bus,
+        retry_total: Float::INFINITY
       }
     end
 

data/lib/cucumber/filters/retry.rb

@@ -7,6 +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)
@@ -21,7 +26,21 @@ module Cucumber
       private
 
       def retry_required?(test_case, event)
-        event.test_case == test_case && event.result.failed? && test_case_counts[test_case] < configuration.retry_attempts
+        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
+          true
+        else
+          # test failed after max. attempts
+          @total_permanently_failed += 1
+          false
+        end
       end
 
       def test_case_counts

data/lib/cucumber/formatter/ansicolor.rb

@@ -86,7 +86,7 @@ module Cucumber
       # example:
       #
       #   apply_custom_colors('passed=white')
-      def apply_custom_colors(colors)
+      def self.apply_custom_colors(colors)
         colors.split(':').each do |pair|
           a = pair.split('=')
           ALIASES[a[0]] = a[1]

data/lib/cucumber/formatter/backtrace_filter.rb

@@ -22,6 +22,7 @@ module Cucumber
     @backtrace_filters << RbConfig::CONFIG['rubylibdir'] if RbConfig::CONFIG['rubylibdir']
 
     @backtrace_filters << 'org/jruby/' if ::Cucumber::JRUBY
+    @backtrace_filters << '<internal:' if RUBY_ENGINE == 'truffleruby'
 
     BACKTRACE_FILTER_PATTERNS = Regexp.new(@backtrace_filters.join('|'))
 

data/lib/cucumber/formatter/io.rb

@@ -61,7 +61,7 @@ module Cucumber
       end
 
       def ensure_file(path, name)
-        raise "You *must* specify --out FILE for the #{name} formatter" unless String == path.class
+        raise "You *must* specify --out FILE for the #{name} formatter" unless path.instance_of? String
         raise "I can't write #{name} to a directory - it has to be a file" if File.directory?(path)
         raise "I can't write #{name} to a file in the non-existing directory #{File.dirname(path)}" unless File.directory?(File.dirname(path))
 
@@ -69,7 +69,7 @@ module Cucumber
       end
 
       def ensure_dir(path, name)
-        raise "You *must* specify --out DIR for the #{name} formatter" unless String == path.class
+        raise "You *must* specify --out DIR for the #{name} formatter" unless path.instance_of? String
         raise "I can't write #{name} reports to a file - it has to be a directory" if File.file?(path)
 
         FileUtils.mkdir_p(path) unless File.directory?(path)

data/lib/cucumber/glue/dsl.rb

@@ -19,8 +19,8 @@ module Cucumber
           @rb_language.build_rb_world_factory(world_modules, namespaced_world_modules, proc)
         end
 
-        def register_rb_hook(phase, tag_names, proc)
-          @rb_language.register_rb_hook(phase, tag_names, proc)
+        def register_rb_hook(phase, tag_names, proc, name: nil)
+          @rb_language.register_rb_hook(phase, tag_names, proc, name: name)
         end
 
         def define_parameter_type(parameter_type)
@@ -62,14 +62,14 @@ module Cucumber
 
       # Registers a proc that will run before each Scenario. You can register as many
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def Before(*tag_expressions, &proc)
-        Dsl.register_rb_hook('before', tag_expressions, proc)
+      def Before(*tag_expressions, name: nil, &proc)
+        Dsl.register_rb_hook('before', tag_expressions, proc, name: name)
       end
 
       # Registers a proc that will run after each Scenario. You can register as many
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def After(*tag_expressions, &proc)
-        Dsl.register_rb_hook('after', tag_expressions, proc)
+      def After(*tag_expressions, name: nil, &proc)
+        Dsl.register_rb_hook('after', tag_expressions, proc, name: name)
       end
 
       # Registers a proc that will be wrapped around each scenario. The proc
@@ -77,14 +77,14 @@ module Cucumber
       # argument (but passed as a regular argument, since blocks cannot accept
       # blocks in 1.8), on which it should call the .call method. You can register
       # as many  as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def Around(*tag_expressions, &proc)
-        Dsl.register_rb_hook('around', tag_expressions, proc)
+      def Around(*tag_expressions, name: nil, &proc)
+        Dsl.register_rb_hook('around', tag_expressions, proc, name: name)
       end
 
       # Registers a proc that will run after each Step. You can register as
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def AfterStep(*tag_expressions, &proc)
-        Dsl.register_rb_hook('after_step', tag_expressions, proc)
+      def AfterStep(*tag_expressions, name: nil, &proc)
+        Dsl.register_rb_hook('after_step', tag_expressions, proc, name: name)
       end
 
       def ParameterType(options)
@@ -108,20 +108,20 @@ module Cucumber
       end
 
       # Registers a proc that will run after Cucumber is configured in order to install an external plugin.
-      def InstallPlugin(&proc)
-        Dsl.register_rb_hook('install_plugin', [], proc)
+      def InstallPlugin(name: nil, &proc)
+        Dsl.register_rb_hook('install_plugin', [], proc, name: name)
       end
 
       # Registers a proc that will run before the execution of the scenarios.
       # Use it for your final set-ups
-      def BeforeAll(&proc)
-        Dsl.register_rb_hook('before_all', [], proc)
+      def BeforeAll(name: nil, &proc)
+        Dsl.register_rb_hook('before_all', [], proc, name: name)
       end
 
       # Registers a proc that will run after the execution of the scenarios.
       # Use it for your final clean-ups
-      def AfterAll(&proc)
-        Dsl.register_rb_hook('after_all', [], proc)
+      def AfterAll(name: nil, &proc)
+        Dsl.register_rb_hook('after_all', [], proc, name: name)
       end
 
       # Registers a new Ruby StepDefinition. This method is aliased

data/lib/cucumber/glue/hook.rb

@@ -6,11 +6,12 @@ module Cucumber
   module Glue
     # TODO: Kill pointless wrapper for Before, After and AfterStep hooks with fire
     class Hook
-      attr_reader :id, :tag_expressions, :location
+      attr_reader :id, :tag_expressions, :location, :name
 
-      def initialize(id, registry, tag_expressions, proc)
+      def initialize(id, registry, tag_expressions, proc, name: nil)
         @id = id
         @registry = registry
+        @name = name
         @tag_expressions = sanitize_tag_expressions(tag_expressions)
         @proc = proc
         @location = Cucumber::Core::Test::Location.from_source_location(*@proc.source_location)
@@ -32,6 +33,7 @@ module Cucumber
         Cucumber::Messages::Envelope.new(
           hook: Cucumber::Messages::Hook.new(
             id: id,
+            name: name,
             tag_expression: tag_expressions.empty? ? nil : tag_expressions.join(' '),
             source_reference: Cucumber::Messages::SourceReference.new(
               uri: location.file,

data/lib/cucumber/glue/proto_world.rb

@@ -3,7 +3,7 @@
 require 'cucumber/gherkin/formatter/ansi_escapes'
 require 'cucumber/core/test/data_table'
 require 'cucumber/deprecate'
-require 'mime/types'
+require 'mini_mime'
 
 module Cucumber
   module Glue
@@ -92,7 +92,7 @@ module Cucumber
         return super unless File.file?(file)
 
         content = File.read(file, mode: 'rb')
-        media_type = MIME::Types.type_for(file).first if media_type.nil?
+        media_type = MiniMime.lookup_by_filename(file)&.content_type if media_type.nil?
 
         super(content, media_type.to_s)
       rescue StandardError

data/lib/cucumber/glue/registry_and_more.rb

@@ -72,8 +72,8 @@ module Cucumber
         end
       end
 
-      def register_rb_hook(phase, tag_expressions, proc)
-        hook = add_hook(phase, Hook.new(@configuration.id_generator.new_id, self, tag_expressions, proc))
+      def register_rb_hook(phase, tag_expressions, proc, name: nil)
+        hook = add_hook(phase, Hook.new(@configuration.id_generator.new_id, self, tag_expressions, proc, name: name))
         @configuration.notify :envelope, hook.to_envelope
         hook
       end

data/lib/cucumber/platform.rb

@@ -7,7 +7,7 @@ require 'cucumber/core/platform'
 
 module Cucumber
   unless defined?(Cucumber::VERSION)
-    VERSION       = File.read(File.expand_path('version', __dir__)).strip
+    VERSION       = File.read(File.expand_path('../../VERSION', __dir__)).strip
     BINARY        = File.expand_path("#{File.dirname(__FILE__)}/../../bin/cucumber")
     LIBDIR        = File.expand_path("#{File.dirname(__FILE__)}/../../lib")
     RAILS         = defined?(Rails)

data/lib/cucumber/rake/task.rb

@@ -36,7 +36,7 @@ module Cucumber
         attr_reader :args
 
         def initialize(libs, cucumber_opts, feature_files)
-          raise 'libs must be an Array when running in-process' unless Array == libs.class
+          raise 'libs must be an Array when running in-process' unless libs.instance_of? Array
 
           libs.reverse_each { |lib| $LOAD_PATH.unshift(lib) }
           @args = (
@@ -113,7 +113,15 @@ module Cucumber
       attr_reader :cucumber_opts
 
       def cucumber_opts=(opts) # :nodoc:
-        @cucumber_opts = String == opts.class ? opts.split(' ') : opts
+        unless opts.instance_of? String
+          @cucumber_opts = opts
+          return
+        end
+
+        @cucumber_opts = opts.split(' ')
+        return if @cucumber_opts.length <= 1
+
+        $stderr.puts 'WARNING: consider using an array rather than a space-delimited string with cucumber_opts to avoid undesired behavior.'
       end
 
       # Whether or not to fork a new ruby interpreter. Defaults to true. You may gain
@@ -155,7 +163,7 @@ module Cucumber
       end
 
       def runner(_task_args = nil) # :nodoc:
-        cucumber_opts = [(ENV['CUCUMBER_OPTS'] ? ENV['CUCUMBER_OPTS'].split(/\s+/) : nil) || cucumber_opts_with_profile]
+        cucumber_opts = [ENV['CUCUMBER_OPTS']&.split(/\s+/) || cucumber_opts_with_profile]
         return ForkedCucumberRunner.new(libs, binary, cucumber_opts, bundler, feature_files) if fork
 
         InProcessCucumberRunner.new(libs, cucumber_opts, feature_files)