cucumber-messages 20.0.0 → 21.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3990dc466da3ed1fcfd89df413422c86fda8183a766ae660e0c8f25e72a4795
-  data.tar.gz: 24308f5d7fc28df143bc0ab232ed8a9658220a4f844cde337c556b26375d61f6
+  metadata.gz: 8d775ee31d595dd6b7c67a8d6c98a84d18d6815c433b96aff25594c3cdcdd9f3
+  data.tar.gz: 79b5a45328fd019745e0d1fa5ce87c6df334956d5b9e8eb24a93e2ef7c0661a2
 SHA512:
-  metadata.gz: 0f8686679d4ab24f6c5c4c868d4e9d59dcdcde0743855b0332a2bdcd5374a447a85bdffec1630eb1eca37c18c10b624e6aa4243047810fe2dc26dcc6bd7625c2
-  data.tar.gz: 3a67338f63c2fa966258f8265cad066502b663bd88b0b845e1232e04894f299b4022a449c848d6419b2a939b628fc990d82a2faa586955fb53b2adc00d9c9f55
+  metadata.gz: d1ec82690ee4b3ada7e575f5ff2dd0fb2923e95647fdb3c1960666daaac919252d4fb796a01814f1fee8250a1654d057e5ab220b9483b4d2cc398723cc648b80
+  data.tar.gz: 2843fa5bf6ecb13b8ec138076e563ee34bb619c2bf8fd02704357ecf37346ed38c4deb8b8fe78748d739a6dacb10dc1772356fe78a691020ac2733177cbea0d1

data/VERSION

@@ -1 +1 @@
-20.0.0
+21.0.1

data/lib/cucumber/messages.deserializers.rb

@@ -88,6 +88,26 @@ module Cucumber
       end
     end
 
+    class Exception
+
+      ##
+      # Returns a new Exception from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Exception.from_h(some_hash) # => #<Cucumber::Messages::Exception:0x... ...>
+      #
+
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        self.new(
+          type: hash[:type],
+          message: hash[:message],
+        )
+      end
+    end
+
     class GherkinDocument
 
       ##
@@ -1054,6 +1074,7 @@ module Cucumber
           message: hash[:message],
           success: hash[:success],
           timestamp: Timestamp.from_h(hash[:timestamp]),
+          exception: Exception.from_h(hash[:exception]),
         )
       end
     end
@@ -1116,6 +1137,7 @@ module Cucumber
           duration: Duration.from_h(hash[:duration]),
           message: hash[:message],
           status: hash[:status],
+          exception: Exception.from_h(hash[:exception]),
         )
       end
     end

data/lib/cucumber/messages.dtos.rb

@@ -41,9 +41,9 @@ module Cucumber
       #  Content encoding is *not* determined by the media type, but rather by the type
       #  of the object being attached:
       # 
-      #  - string => IDENTITY
-      #  - byte array => BASE64
-      #  - stream => BASE64
+      #  - string: IDENTITY
+      #  - byte array: BASE64
+      #  - stream: BASE64
 
       attr_reader :content_encoding
 
@@ -223,6 +223,34 @@ module Cucumber
     end
 
 
+    ##
+    # Represents the Exception message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    #
+    # A simplified representation of an exception
+    #
+
+    class Exception < ::Cucumber::Messages::Message
+
+      ##
+      # The type of the exception that caused this result. E.g. "Error" or "org.opentest4j.AssertionFailedError"
+
+      attr_reader :type
+
+      ##
+      # The message of exception that caused this result. E.g. expected: "a" but was: "b"
+
+      attr_reader :message
+
+      def initialize(
+        type: '',
+        message: nil
+      )
+        @type = type
+        @message = message
+      end
+    end
+
+
     ##
     # Represents the GherkinDocument message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     #
@@ -1726,16 +1754,12 @@ module Cucumber
     class TestRunFinished < ::Cucumber::Messages::Message
 
       ##
-      # Error message. Can be a stack trace from a failed `BeforeAll` or `AfterAll`.
-      #  If there are undefined parameter types, the message is simply
-      #  "The following parameter type(s() are not defined: xxx, yyy".
-      #  The independent `UndefinedParameterType` messages can be used to generate
-      #  snippets for those parameter types.
+      # An informative message about the test run. Typically additional information about failure, but not necessarily.
 
       attr_reader :message
 
       ##
-      # success = StrictModeEnabled ? (failed_count == 0 && ambiguous_count == 0 && undefined_count == 0 && pending_count == 0) : (failed_count == 0 && ambiguous_count == 0)
+      # A test run is successful if all steps are either passed or skipped, all before/after hooks passed and no other exceptions where thrown.
 
       attr_reader :success
 
@@ -1744,14 +1768,21 @@ module Cucumber
 
       attr_reader :timestamp
 
+      ##
+      # Any exception thrown during the test run, if any. Does not include exceptions thrown while executing steps.
+
+      attr_reader :exception
+
       def initialize(
         message: nil,
         success: false,
-        timestamp: Timestamp.new
+        timestamp: Timestamp.new,
+        exception: nil
       )
         @message = message
         @success = success
         @timestamp = timestamp
+        @exception = exception
       end
     end
 
@@ -1814,18 +1845,28 @@ module Cucumber
 
       attr_reader :duration
 
+      ##
+      # An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
+
       attr_reader :message
 
       attr_reader :status
 
+      ##
+      # Exception thrown while executing this step, if any.
+
+      attr_reader :exception
+
       def initialize(
         duration: Duration.new,
         message: nil,
-        status: TestStepResultStatus::UNKNOWN
+        status: TestStepResultStatus::UNKNOWN,
+        exception: nil
       )
         @duration = duration
         @message = message
         @status = status
+        @exception = exception
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-messages
 version: !ruby/object:Gem::Version
-  version: 20.0.0
+  version: 21.0.1
 platform: ruby
 authors:
 - Aslak Hellesøy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2022-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-compatibility-kit
@@ -127,7 +127,7 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
-summary: cucumber-messages-20.0.0
+summary: cucumber-messages-21.0.1
 test_files:
 - spec/capture_warnings.rb
 - spec/cucumber/messages/acceptance_spec.rb