cucumber-core 19.0.0 → 20.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25b931cc726aa46d40c838941a4a033fd70a34ef4899884750e86e9ad2a0f1b3
-  data.tar.gz: d4f808dfc9dc0106e96b1fb6754df766f18a1248914323e89fe32c9a5eee6202
+  metadata.gz: 3f9931a15c76e003ac7bb598bf814bbd5d908ba256eb852847cb7aefc84dfda3
+  data.tar.gz: d3ed87cbc37e6c7c432747abb6caef55d10363bd4d75b440a27c7b856022dd6e
 SHA512:
-  metadata.gz: 8a0428cdbc69794d04b068fc6b72a83026cb8b08959c91153fc4c3b71b44062e442e5842dcef7b3dc8af424daa6c7dbebcce9fe13258ee4cc51a1aa6b9b798b6
-  data.tar.gz: ae12323897fe7bb9b0f1bad297dadf5a2be335f5eb187a1093317350e5bd6211dac5cb93c1bafcca50610a5366571e9b85cb512363567471973ddbbf55bbcdd0
+  metadata.gz: 55ec2c7b9356c1d61b44e7bc71ad82718bca4841da8a59e56aedca11d1709831aeffa28e38de81465e9730887bcd9fb7e94ace5625db8af771eca1812f99d5ce
+  data.tar.gz: 2cda929bc001a8ea4e0b49a39d4f0ce61faf5b7dd2fcbd29826ff95d7e6f2e40adbc229159b28293d10d0779fee2d3e7f9dd519986baa2856c817bcce5f2658c

data/CHANGELOG.md

@@ -10,6 +10,24 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ## [Unreleased]
 
+## [20.1.0] - 2026-11-02
+### Added
+- Moved the version definition to `lib/cucumber/core/version.rb` and updated the gemspec to use `Cucumber::Core::VERSION`
+
+### Changed
+- Add additional parameters (`message` and `exception`), conditionally to the message generated by a pending or skipped
+test step (If it is defined in the invocating step definition) ([#348](https://github.com/cucumber/cucumber-ruby-core/pull/348))
+
+## [20.0.0] - 2026-10-09
+### Changed
+- **BREAKING CHANGE:** `Cucumber::Core::Test::Runner` now takes a retry policy instead of a maximum number of attempts, and
+asks it whether a finished test case will be retried. Its optional constructor arguments became keyword arguments. See upgrading notes for
+[20.0.0.md](upgrading_notes/20.0.0.md#upgrading-to-cucumber-core-2000), for full changes
+
+### Fixed
+- The `TestCaseFinished` envelope is now emitted before the `test_case_finished` event, so a test case retried from
+that event no longer has its envelope emitted out of order and with the started id of the retry
+
 ## [19.0.0] - 2026-08-19
 ### Added
 - Emit test_case_started/finished and test_step_started/test_step_finished envelopes from the Runner. ([#331](https://github.com/cucumber/cucumber-ruby-core/pull/331))
@@ -164,7 +182,9 @@ See upgrading notes for [13.0.0.md](upgrading_notes/13.0.0.md#upgrading-to-cucum
 ### Changed
 - Updated `cucumber-gherkin` and `cucumber-messages`
 
-[Unreleased]: https://github.com/cucumber/cucumber-ruby-core/compare/v19.0.0...HEAD
+[Unreleased]: https://github.com/cucumber/cucumber-ruby-core/compare/v20.1.0...HEAD
+[20.1.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v20.0.0...v20.1.0
+[20.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v19.0.0...v20.0.0
 [19.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v18.0.0...v19.0.0
 [18.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v17.0.0...v18.0.0
 [17.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v16.2.0...v17.0.0

data/README.md

@@ -5,8 +5,7 @@
 [![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)
-[![Test cucumber-core](https://github.com/cucumber/cucumber-ruby-core/actions/workflows/test.yml/badge.svg)](https://github.com/cucumber/cucumber-ruby-core/actions/workflows/test.yml)
-[![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby-core.svg)](https://codeclimate.com/github/cucumber/cucumber-ruby-core)
+[![Test cucumber-core](https://github.com/cucumber/cucumber-ruby-core/actions/workflows/test-ruby.yaml/badge.svg)](https://github.com/cucumber/cucumber-ruby-core/actions/workflows/test-ruby.yaml)
 
 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/lib/cucumber/core/test/no_retries.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Core
+    module Test
+      class NoRetries
+        def will_be_retried?(_test_case, _result) = false
+      end
+    end
+  end
+end

data/lib/cucumber/core/test/result/pending.rb

@@ -29,10 +29,19 @@ module Cucumber
           end
 
           def to_message
-            Cucumber::Messages::TestStepResult.new(
-              status: Cucumber::Messages::TestStepResultStatus::PENDING,
-              duration: duration.to_message_duration
-            )
+            if message
+              Cucumber::Messages::TestStepResult.new(
+                status: Cucumber::Messages::TestStepResultStatus::PENDING,
+                duration: duration.to_message_duration,
+                message: message,
+                exception: exception_sub_message
+              )
+            else
+              Cucumber::Messages::TestStepResult.new(
+                status: Cucumber::Messages::TestStepResultStatus::PENDING,
+                duration: duration.to_message_duration
+              )
+            end
           end
         end
       end

data/lib/cucumber/core/test/result/raisable.rb

@@ -11,7 +11,7 @@ module Cucumber
         class Raisable < StandardError
           attr_reader :message, :duration
 
-          def initialize(message = '', duration = UnknownDuration.new, backtrace = nil)
+          def initialize(message = nil, duration = UnknownDuration.new, backtrace = nil)
             @message = message
             @duration = duration
             super(message)
@@ -39,6 +39,16 @@ module Cucumber
 
             filter.new(dup).exception
           end
+
+          private
+
+          def exception_sub_message
+            Cucumber::Messages::Exception.new(
+              type: self.class,
+              message: message,
+              stack_trace: backtrace&.join("\n")
+            )
+          end
         end
       end
     end

data/lib/cucumber/core/test/result/skipped.rb

@@ -29,10 +29,19 @@ module Cucumber
           end
 
           def to_message
-            Cucumber::Messages::TestStepResult.new(
-              status: Cucumber::Messages::TestStepResultStatus::SKIPPED,
-              duration: duration.to_message_duration
-            )
+            if message
+              Cucumber::Messages::TestStepResult.new(
+                status: Cucumber::Messages::TestStepResultStatus::SKIPPED,
+                duration: duration.to_message_duration,
+                message: message,
+                exception: exception_sub_message
+              )
+            else
+              Cucumber::Messages::TestStepResult.new(
+                status: Cucumber::Messages::TestStepResultStatus::SKIPPED,
+                duration: duration.to_message_duration
+              )
+            end
           end
         end
       end

data/lib/cucumber/core/test/runner.rb

@@ -2,6 +2,7 @@
 
 require 'cucumber/messages/helpers/test_step_result_comparator'
 
+require_relative 'no_retries'
 require_relative 'timer'
 require 'cucumber/messages'
 
@@ -14,11 +15,13 @@ module Cucumber
         attr_reader :event_bus, :running_test_case, :running_test_step, :id_generator
         private :event_bus, :running_test_case, :running_test_step, :id_generator
 
-        def initialize(event_bus, id_generator = Cucumber::Messages::Helpers::IdGenerator::UUID.new, backtrace_filter = nil, max_attempts = 1)
+        # @param retry_policy [#will_be_retried?] asked, once a test case has finished, whether it is going to be
+        #   run again. It receives the test case and its result. By default, no test case is ever reported as retried.
+        def initialize(event_bus, id_generator: Cucumber::Messages::Helpers::IdGenerator::UUID.new, backtrace_filter: nil, retry_policy: NoRetries.new)
           @event_bus = event_bus
           @id_generator = id_generator
           @backtrace_filter = backtrace_filter
-          @max_attempts = max_attempts
+          @retry_policy = retry_policy
           @current_test_case = nil
         end
 
@@ -34,8 +37,8 @@ module Cucumber
           descend.call(self)
 
           result = calculate_test_case_result(test_case)
+          event_bus.envelope(to_test_case_finished_envelope(test_case, result))
           event_bus.test_case_finished(test_case, result)
-          event_bus.envelope(to_test_case_finished_envelope(result))
           self
         end
 
@@ -82,12 +85,12 @@ module Cucumber
           )
         end
 
-        def to_test_case_finished_envelope(result)
+        def to_test_case_finished_envelope(test_case, result)
           Cucumber::Messages::Envelope.new(
             test_case_finished: Cucumber::Messages::TestCaseFinished.new(
               test_case_started_id: @current_test_case_started_id,
               timestamp: time_to_timestamp(Time.now),
-              will_be_retried: result.failed? && (@attempt < @max_attempts)
+              will_be_retried: @retry_policy.will_be_retried?(test_case, result)
             )
           )
         end
@@ -111,7 +114,7 @@ module Cucumber
             result_message = Cucumber::Messages::TestStepResult.new(
               status: result_message.status,
               duration: result_message.duration,
-              message: to_error_message(message_element),
+              message: result_message.message,
               exception: to_exception_object(result, message_element)
             )
           end
@@ -125,13 +128,6 @@ module Cucumber
           )
         end
 
-        def to_error_message(message_element)
-          <<~ERROR_MESSAGE
-            #{message_element.message} (#{message_element.class})
-            #{message_element.backtrace}
-          ERROR_MESSAGE
-        end
-
         def to_exception_object(result, message_element)
           return unless result.failed?
 

data/lib/cucumber/core/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Core
+    VERSION = '20.1.0'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-core
 version: !ruby/object:Gem::Version
-  version: 19.0.0
+  version: 20.1.0
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -217,6 +217,7 @@ files:
 - lib/cucumber/core/test/filters/tag_filter.rb
 - lib/cucumber/core/test/hook_step.rb
 - lib/cucumber/core/test/location.rb
+- lib/cucumber/core/test/no_retries.rb
 - lib/cucumber/core/test/result.rb
 - lib/cucumber/core/test/result/ambiguous.rb
 - lib/cucumber/core/test/result/boolean_methods.rb
@@ -235,6 +236,7 @@ files:
 - lib/cucumber/core/test/step.rb
 - lib/cucumber/core/test/tag.rb
 - lib/cucumber/core/test/timer.rb
+- lib/cucumber/core/version.rb
 homepage: https://cucumber.io
 licenses:
 - MIT
@@ -262,5 +264,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.16
 specification_version: 4
-summary: cucumber-core-19.0.0
+summary: cucumber-core-20.1.0
 test_files: []