cucumber 11.0.0 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c26004e2b3e93b8a26180b4e6395f62dc4dcf8ab9cf410e6a179af00e98687ae
-  data.tar.gz: 7cc32417229dd46c4aa4816e6137cfae251ed1d1f2eb107693e3b03442d1c3d6
+  metadata.gz: 41a92bddb6a0e5cdf8a69b28abfc455f4d77516e3f4abd8283cd6a222d1f5bd9
+  data.tar.gz: 743067172c8d6e732e86a2417dfa43b809ecff66ad772477460af2b1e217c234
 SHA512:
-  metadata.gz: dfd1379832fc0fb2cede983c7d2fac1491fa83cc394d00e9fd00359632029f6adc44c6ef1140c824f8abb8e03a736075c99b94fcdab40ac457facadc5cc58b44
-  data.tar.gz: 3f26435c0610fdaaa7afc111010a3bac1683f7e1235a5c49eafe85e4f64f398d8dd78333cffa9edd1b951f3225fb0b85c08d8cfcf6962891a6bda596ce28d3d8
+  metadata.gz: b26e638126d5f0d7846390ed1ddbf2b38c76d92c19e43aa859ba8432b04a017e509a018e55abb590ad523e31f295daeec9e210506b862a310e996b138cb113ab
+  data.tar.gz: 5360ce612562f89839f87cf568f8a0adc3d732e224f99900653e8c58a0b4c51892932c9568b10e58365f2652fe867023d7bd32f05df7a95860583167b52cfd55

data/README.md

@@ -1,13 +1,22 @@
-<img src="docs/img/logo.svg" alt="" width="75" />
+<h1 align="center">
+  <img src="docs/img/logo.svg" alt="Cucumber logo" width="75">
+  <br>
+  Cucumber
+</h1>
 
-# Cucumber
+<div align="center">
 
-[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
+[![Gem Version](https://badge.fury.io/rb/cucumber.svg)](https://badge.fury.io/rb/cucumber)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/cucumber/cucumber-ruby/badge)](https://scorecard.dev/viewer/?uri=github.com/cucumber/cucumber-ruby)
 [![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
 [![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
-[![Test cucumber](https://github.com/cucumber/cucumber-ruby/actions/workflows/test.yaml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions/workflows/test.yaml)
-[![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby.svg)](https://codeclimate.com/github/cucumber/cucumber-ruby)
-[![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=main)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=main)
+[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
+
+[![Build Status](https://github.com/cucumber/cucumber-ruby/actions/workflows/test-ruby.yaml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions)
+[![Build Status](https://github.com/cucumber/cucumber-ruby/actions/workflows/release-ruby.yaml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions)
+
+</div>
+
 
 Cucumber is a tool for running automated tests written in plain language. Because they're
 written in plain language, they can be read by anyone on your team. Because they can be

data/VERSION

@@ -1 +1 @@
-11.0.0
+11.1.0

data/lib/cucumber/cli/main.rb

@@ -23,6 +23,7 @@ module Cucumber
 
       def execute!(existing_runtime = nil)
         trap_interrupt
+        trap_thread_dump_signal
 
         runtime = runtime(existing_runtime)
 
@@ -90,6 +91,27 @@ module Cucumber
         end
       end
 
+      def trap_thread_dump_signal
+        signal = %w[INFO PWR].find { |s| Signal.list.key?(s) }
+
+        return if signal.nil?
+
+        trap(signal) do
+          Thread.list.each do |thread|
+            prefix = "Thread TID-#{(thread.object_id ^ Process.pid).to_s(36)} #{thread.name || '<no name>'}"
+            backtrace = thread.backtrace
+
+            if backtrace&.any?
+              backtrace.each do |line|
+                @err.puts("#{prefix} #{line}")
+              end
+            else
+              @err.puts("#{prefix} <no backtrace available>")
+            end
+          end
+        end
+      end
+
       def runtime(existing_runtime)
         return Runtime.new(configuration) unless existing_runtime
 

data/lib/cucumber/configuration.rb

@@ -285,6 +285,10 @@ module Cucumber
       @id_generator ||= Cucumber::Messages::Helpers::IdGenerator::UUID.new
     end
 
+    def test_run_started_id
+      @test_run_started_id ||= id_generator.new_id
+    end
+
     private
 
     def default_features_paths

data/lib/cucumber/events/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# TODO: Remove this class and use Cucumber::Core::Event::Base once v17 of core is minimum
+module Cucumber
+  module Events
+    # An archetype of what each Cucumber Event defined in cucumber-ruby must adhere to
+    class Base
+      # The "key" name of the class to be used as the key in the event registry (Underscored name symbolized)
+      #   @return [Symbol]
+      def self.event_id
+        raise 'Must be implemented in subclass'
+      end
+
+      # The properties of each event. Stored in iVar named format - where the key is the name of the iVar
+      #   @return [Hash<Symbol>]
+      def to_h
+        instance_variables.to_h { |variable_name| [variable_name[1..].to_sym, instance_variable_get(variable_name)] }
+      end
+
+      def event_id
+        self.class.event_id
+      end
+    end
+  end
+end

data/lib/cucumber/events/envelope.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
-    class Envelope < Core::Event.new(:envelope)
+    class Envelope < Base
       attr_reader :envelope
 
+      def self.event_id
+        :envelope
+      end
+
+      def initialize(envelope)
+        @envelope = envelope
+        super()
+      end
+
       def inspect
         "Envelope Event -> Message Type: #{type}}"
       end

data/lib/cucumber/events/gherkin_source_parsed.rb

@@ -1,13 +1,22 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Fired after we've parsed the contents of a feature file
-    class GherkinSourceParsed < Core::Event.new(:gherkin_document)
-      # The Gherkin Ast
+    class GherkinSourceParsed < Base
+      # # The Gherkin Ast
       attr_reader :gherkin_document
+
+      def self.event_id
+        :gherkin_source_parsed
+      end
+
+      def initialize(gherkin_document)
+        @gherkin_document = gherkin_document
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/gherkin_source_read.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
     # Fired after we've read in the contents of a feature file
-    class GherkinSourceRead < Core::Event.new(:path, :body)
+    class GherkinSourceRead < Base
       # The path to the file
       attr_reader :path
 
       # The raw Gherkin source
       attr_reader :body
+
+      def self.event_id
+        :gherkin_source_read
+      end
+
+      def initialize(path, body)
+        @path = path
+        @body = body
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/hook_test_step_created.rb

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Event fired when a step is created from a hook
-    class HookTestStepCreated < Core::Event.new(:test_step, :hook)
+    class HookTestStepCreated < Base
       attr_reader :test_step, :hook
+
+      def self.event_id
+        :hook_test_step_created
+      end
+
+      def initialize(test_step, hook)
+        @test_step = test_step
+        @hook = hook
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/step_activated.rb

@@ -1,20 +1,26 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
     # Event fired when a step is activated
-    class StepActivated < Core::Event.new(:test_step, :step_match)
+    class StepActivated < Base
       # The test step that was matched.
-      #
-      # @return [Cucumber::Core::Test::Step]
+      #   @return [Cucumber::Core::Test::Step]
       attr_reader :test_step
 
       # Information about the matching definition.
-      #
-      # @return [Cucumber::StepMatch]
+      #   @return [Cucumber::StepMatch]
       attr_reader :step_match
+
+      def self.event_id
+        :step_activated
+      end
+
+      def initialize(test_step, step_match)
+        @test_step = test_step
+        @step_match = step_match
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/step_definition_registered.rb

@@ -1,15 +1,23 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Event fired after each step definition has been registered
-    class StepDefinitionRegistered < Core::Event.new(:step_definition)
+    class StepDefinitionRegistered < Base
       # The step definition that was just registered.
-      #
-      # @return [RbSupport::RbStepDefinition]
+      #   @return [RbSupport::RbStepDefinition]
       attr_reader :step_definition
+
+      def self.event_id
+        :step_definition_registered
+      end
+
+      def initialize(step_definition)
+        @step_definition = step_definition
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_case_created.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
     # Event fired when a Test::Case is created from a Pickle
-    class TestCaseCreated < Core::Event.new(:test_case, :pickle)
+    class TestCaseCreated < Base
       attr_reader :test_case, :pickle
+
+      def self.event_id
+        :test_case_created
+      end
+
+      def initialize(test_case, pickle)
+        @test_case = test_case
+        @pickle = pickle
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_case_finished.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
-    # Signals that a {Cucumber::Core::Test::Case} has finished executing
-    class TestCaseFinished < Core::Events::TestCaseFinished
+    # Event fired when a Test::Case is created from a Pickle
+    class TestCaseFinished < Base
       # @return [Cucumber::Core::Test::Case] that was executed
       attr_reader :test_case
 
       # @return [Cucumber::Core::Test::Result] the result of running the {Cucumber::Core::Test::Case}
       attr_reader :result
+
+      def self.event_id
+        :test_case_finished
+      end
+
+      def initialize(test_case, result)
+        @test_case = test_case
+        @result = result
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_case_ready.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
-    # Event fired when a Test::Case is ready to be ran (matching has been done, hooks added etc)
-    class TestCaseReady < Core::Event.new(:test_case)
+    class TestCaseReady < Base
       attr_reader :test_case
+
+      def self.event_id
+        :test_case_ready
+      end
+
+      def initialize(test_case)
+        @test_case = test_case
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_case_started.rb

@@ -1,13 +1,22 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Signals that a {Cucumber::Core::Test::Case} is about to be executed
-    class TestCaseStarted < Core::Events::TestCaseStarted
+    class TestCaseStarted < Base
       # @return [Cucumber::Core::Test::Case] the test case to be executed
       attr_reader :test_case
+
+      def self.event_id
+        :test_case_started
+      end
+
+      def initialize(test_case)
+        @test_case = test_case
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_run_finished.rb

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
     # Event fired after all test cases have finished executing
-    class TestRunFinished < Core::Event.new(:success)
+    class TestRunFinished < Base
       attr_reader :success
+
+      def self.event_id
+        :test_run_finished
+      end
+
+      def initialize(success = nil)
+        @success = success
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_run_hook_finished.rb

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
-    class TestRunHookFinished < Core::Event.new(:hook, :test_result)
+    class TestRunHookFinished < Base
       attr_reader :hook, :test_result
+
+      def self.event_id
+        :test_run_hook_finished
+      end
+
+      def initialize(hook, test_result)
+        @hook = hook
+        @test_result = test_result
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_run_hook_started.rb

@@ -4,8 +4,17 @@ require 'cucumber/core/events'
 
 module Cucumber
   module Events
-    class TestRunHookStarted < Core::Event.new(:hook)
+    class TestRunHookStarted < Base
       attr_reader :hook
+
+      def self.event_id
+        :test_run_hook_started
+      end
+
+      def initialize(hook)
+        @hook = hook
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_run_started.rb

@@ -1,14 +1,23 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Event fired once all test cases have been filtered before
     # the first one is executed.
-    class TestRunStarted < Core::Event.new(:test_cases)
+    class TestRunStarted < Base
       # @return [Array<Cucumber::Core::Test::Case>] the test cases to be executed
       attr_reader :test_cases
+
+      def self.event_id
+        :test_run_started
+      end
+
+      def initialize(test_cases)
+        @test_cases = test_cases
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_step_created.rb

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Event fired when a TestStep is created from a PickleStep
-    class TestStepCreated < Core::Event.new(:test_step, :pickle_step)
+    class TestStepCreated < Base
       attr_reader :test_step, :pickle_step
+
+      def self.event_id
+        :test_step_created
+      end
+
+      def initialize(test_step, pickle_step)
+        @test_step = test_step
+        @pickle_step = pickle_step
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_step_finished.rb

@@ -1,16 +1,26 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Signals that a {Cucumber::Core::Test::Step} has finished executing
-    class TestStepFinished < Core::Events::TestStepFinished
+    class TestStepFinished < Base
       # @return [Cucumber::Core::Test::Step] the test step that was executed
       attr_reader :test_step
 
       # @return [Cucumber::Core::Test::Result] the result of running the {Cucumber::Core::Test::Step}
       attr_reader :result
+
+      def self.event_id
+        :test_step_finished
+      end
+
+      def initialize(test_step, result)
+        @test_step = test_step
+        @result = result
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_step_started.rb

@@ -1,13 +1,22 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Signals that a {Cucumber::Core::Test::Step} is about to be executed
-    class TestStepStarted < Core::Events::TestStepStarted
+    class TestStepStarted < Base
       # @return [Cucumber::Core::Test::Step] the test step to be executed
       attr_reader :test_step
+
+      def self.event_id
+        :test_step_started
+      end
+
+      def initialize(test_step)
+        @test_step = test_step
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/undefined_parameter_type.rb

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
-    class UndefinedParameterType < Core::Event.new(:type_name, :expression)
+    class UndefinedParameterType < Base
       attr_reader :type_name, :expression
+
+      def self.event_id
+        :undefined_parameter_type
+      end
+
+      def initialize(type_name, expression)
+        @type_name = type_name
+        @expression = expression
+        super()
+      end
     end
   end
 end

data/lib/cucumber/filters/fire_before_all_hooks.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Filters
+    # Executes all BeforeAll hooks and ONLY if they were all
+    # successful pass on all the `TestCase` objects down the filter chain
+    class FireBeforeAllHooks < Core::Filter.new(:config)
+      def initialize(support_code, receiver = nil)
+        super
+        @support_code = support_code
+        @test_cases = []
+      end
+
+      def test_case(test_case)
+        @test_cases << test_case
+        self
+      end
+
+      def done
+        if fire_before_all_hook
+          @test_cases.map do |test_case|
+            test_case.describe_to(@receiver)
+          end
+        end
+        receiver.done
+        self
+      end
+
+      private
+
+      def fire_before_all_hook
+        @support_code.fire_hook(:before_all)
+      end
+    end
+  end
+end