cucumber-messages 22.0.0 → 27.2.0

data/lib/cucumber/messages/step_match_argument.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the StepMatchArgument message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # *
+    #  Represents a single argument extracted from a step match and passed to a step definition.
+    #  This is used for the following purposes:
+    #  - Construct an argument to pass to a step definition (possibly through a parameter type transform)
+    #  - Highlight the matched parameter in rich formatters such as the HTML formatter
+    #
+    #  This message closely matches the `Argument` class in the `cucumber-expressions` library.
+    ##
+    class StepMatchArgument < Message
+      ##
+      # *
+      #  Represents the outermost capture group of an argument. This message closely matches the
+      #  `Group` class in the `cucumber-expressions` library.
+      ##
+      attr_reader :group
+
+      attr_reader :parameter_type_name
+
+      def initialize(
+        group: Group.new,
+        parameter_type_name: nil
+      )
+        @group = group
+        @parameter_type_name = parameter_type_name
+        super()
+      end
+
+      ##
+      # Returns a new StepMatchArgument from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::StepMatchArgument.from_h(some_hash) # => #<Cucumber::Messages::StepMatchArgument:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          group: Group.from_h(hash[:group]),
+          parameter_type_name: hash[:parameterTypeName]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/step_match_arguments_list.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the StepMatchArgumentsList message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class StepMatchArgumentsList < Message
+      attr_reader :step_match_arguments
+
+      def initialize(
+        step_match_arguments: []
+      )
+        @step_match_arguments = step_match_arguments
+        super()
+      end
+
+      ##
+      # Returns a new StepMatchArgumentsList from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::StepMatchArgumentsList.from_h(some_hash) # => #<Cucumber::Messages::StepMatchArgumentsList:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          step_match_arguments: hash[:stepMatchArguments]&.map { |item| StepMatchArgument.from_h(item) }
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/table_cell.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TableCell message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # A cell in a `TableRow`
+    ##
+    class TableCell < Message
+      ##
+      # The location of the cell
+      ##
+      attr_reader :location
+
+      ##
+      # The value of the cell
+      ##
+      attr_reader :value
+
+      def initialize(
+        location: Location.new,
+        value: ''
+      )
+        @location = location
+        @value = value
+        super()
+      end
+
+      ##
+      # Returns a new TableCell from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TableCell.from_h(some_hash) # => #<Cucumber::Messages::TableCell:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          location: Location.from_h(hash[:location]),
+          value: hash[:value]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/table_row.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TableRow message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # A row in a table
+    ##
+    class TableRow < Message
+      ##
+      # The location of the first cell in the row
+      ##
+      attr_reader :location
+
+      ##
+      # Cells in the row
+      ##
+      attr_reader :cells
+
+      attr_reader :id
+
+      def initialize(
+        location: Location.new,
+        cells: [],
+        id: ''
+      )
+        @location = location
+        @cells = cells
+        @id = id
+        super()
+      end
+
+      ##
+      # Returns a new TableRow from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TableRow.from_h(some_hash) # => #<Cucumber::Messages::TableRow:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          location: Location.from_h(hash[:location]),
+          cells: hash[:cells]&.map { |item| TableCell.from_h(item) },
+          id: hash[:id]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/tag.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the Tag message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # *
+    #  A tag
+    ##
+    class Tag < Message
+      ##
+      # Location of the tag
+      ##
+      attr_reader :location
+
+      ##
+      # The name of the tag (including the leading `@`)
+      ##
+      attr_reader :name
+
+      ##
+      # Unique ID to be able to reference the Tag from PickleTag
+      ##
+      attr_reader :id
+
+      def initialize(
+        location: Location.new,
+        name: '',
+        id: ''
+      )
+        @location = location
+        @name = name
+        @id = id
+        super()
+      end
+
+      ##
+      # Returns a new Tag from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Tag.from_h(some_hash) # => #<Cucumber::Messages::Tag:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          location: Location.from_h(hash[:location]),
+          name: hash[:name],
+          id: hash[:id]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/test_case.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TestCase message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # //// TestCases
+    #
+    # *
+    #  A `TestCase` contains a sequence of `TestStep`s.
+    ##
+    class TestCase < Message
+      attr_reader :id
+
+      ##
+      # The ID of the `Pickle` this `TestCase` is derived from.
+      ##
+      attr_reader :pickle_id
+
+      attr_reader :test_steps
+
+      ##
+      # Identifier for the test run that this test case belongs to
+      ##
+      attr_reader :test_run_started_id
+
+      def initialize(
+        id: '',
+        pickle_id: '',
+        test_steps: [],
+        test_run_started_id: nil
+      )
+        @id = id
+        @pickle_id = pickle_id
+        @test_steps = test_steps
+        @test_run_started_id = test_run_started_id
+        super()
+      end
+
+      ##
+      # Returns a new TestCase from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TestCase.from_h(some_hash) # => #<Cucumber::Messages::TestCase:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          id: hash[:id],
+          pickle_id: hash[:pickleId],
+          test_steps: hash[:testSteps]&.map { |item| TestStep.from_h(item) },
+          test_run_started_id: hash[:testRunStartedId]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/test_case_finished.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TestCaseFinished message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class TestCaseFinished < Message
+      attr_reader :test_case_started_id
+
+      attr_reader :timestamp
+
+      attr_reader :will_be_retried
+
+      def initialize(
+        test_case_started_id: '',
+        timestamp: Timestamp.new,
+        will_be_retried: false
+      )
+        @test_case_started_id = test_case_started_id
+        @timestamp = timestamp
+        @will_be_retried = will_be_retried
+        super()
+      end
+
+      ##
+      # Returns a new TestCaseFinished from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TestCaseFinished.from_h(some_hash) # => #<Cucumber::Messages::TestCaseFinished:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          test_case_started_id: hash[:testCaseStartedId],
+          timestamp: Timestamp.from_h(hash[:timestamp]),
+          will_be_retried: hash[:willBeRetried]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/test_case_started.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TestCaseStarted message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class TestCaseStarted < Message
+      ##
+      # *
+      #  The first attempt should have value 0, and for each retry the value
+      #  should increase by 1.
+      ##
+      attr_reader :attempt
+
+      ##
+      # *
+      #  Because a `TestCase` can be run multiple times (in case of a retry),
+      #  we use this field to group messages relating to the same attempt.
+      ##
+      attr_reader :id
+
+      attr_reader :test_case_id
+
+      ##
+      # An identifier for the worker process running this test case, if test cases are being run in parallel. The identifier will be unique per worker, but no particular format is defined - it could be an index, uuid, machine name etc - and as such should be assumed that it's not human readable.
+      ##
+      attr_reader :worker_id
+
+      attr_reader :timestamp
+
+      def initialize(
+        attempt: 0,
+        id: '',
+        test_case_id: '',
+        worker_id: nil,
+        timestamp: Timestamp.new
+      )
+        @attempt = attempt
+        @id = id
+        @test_case_id = test_case_id
+        @worker_id = worker_id
+        @timestamp = timestamp
+        super()
+      end
+
+      ##
+      # Returns a new TestCaseStarted from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TestCaseStarted.from_h(some_hash) # => #<Cucumber::Messages::TestCaseStarted:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          attempt: hash[:attempt],
+          id: hash[:id],
+          test_case_id: hash[:testCaseId],
+          worker_id: hash[:workerId],
+          timestamp: Timestamp.from_h(hash[:timestamp])
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/test_run_finished.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TestRunFinished message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class TestRunFinished < Message
+      ##
+      # An informative message about the test run. Typically additional information about failure, but not necessarily.
+      ##
+      attr_reader :message
+
+      ##
+      # 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
+
+      ##
+      # Timestamp when the TestRun is finished
+      ##
+      attr_reader :timestamp
+
+      ##
+      # Any exception thrown during the test run, if any. Does not include exceptions thrown while executing steps.
+      ##
+      attr_reader :exception
+
+      attr_reader :test_run_started_id
+
+      def initialize(
+        message: nil,
+        success: false,
+        timestamp: Timestamp.new,
+        exception: nil,
+        test_run_started_id: nil
+      )
+        @message = message
+        @success = success
+        @timestamp = timestamp
+        @exception = exception
+        @test_run_started_id = test_run_started_id
+        super()
+      end
+
+      ##
+      # Returns a new TestRunFinished from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TestRunFinished.from_h(some_hash) # => #<Cucumber::Messages::TestRunFinished:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          message: hash[:message],
+          success: hash[:success],
+          timestamp: Timestamp.from_h(hash[:timestamp]),
+          exception: Exception.from_h(hash[:exception]),
+          test_run_started_id: hash[:testRunStartedId]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/test_run_hook_finished.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TestRunHookFinished message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class TestRunHookFinished < Message
+      ##
+      # Identifier for the hook execution that has finished
+      ##
+      attr_reader :test_run_hook_started_id
+
+      attr_reader :result
+
+      attr_reader :timestamp
+
+      def initialize(
+        test_run_hook_started_id: '',
+        result: TestStepResult.new,
+        timestamp: Timestamp.new
+      )
+        @test_run_hook_started_id = test_run_hook_started_id
+        @result = result
+        @timestamp = timestamp
+        super()
+      end
+
+      ##
+      # Returns a new TestRunHookFinished from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TestRunHookFinished.from_h(some_hash) # => #<Cucumber::Messages::TestRunHookFinished:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          test_run_hook_started_id: hash[:testRunHookStartedId],
+          result: TestStepResult.from_h(hash[:result]),
+          timestamp: Timestamp.from_h(hash[:timestamp])
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/test_run_hook_started.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TestRunHookStarted message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class TestRunHookStarted < Message
+      ##
+      # Unique identifier for this hook execution
+      ##
+      attr_reader :id
+
+      ##
+      # Identifier for the test run that this hook execution belongs to
+      ##
+      attr_reader :test_run_started_id
+
+      ##
+      # Identifier for the hook that will be executed
+      ##
+      attr_reader :hook_id
+
+      attr_reader :timestamp
+
+      def initialize(
+        id: '',
+        test_run_started_id: '',
+        hook_id: '',
+        timestamp: Timestamp.new
+      )
+        @id = id
+        @test_run_started_id = test_run_started_id
+        @hook_id = hook_id
+        @timestamp = timestamp
+        super()
+      end
+
+      ##
+      # Returns a new TestRunHookStarted from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TestRunHookStarted.from_h(some_hash) # => #<Cucumber::Messages::TestRunHookStarted:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          id: hash[:id],
+          test_run_started_id: hash[:testRunStartedId],
+          hook_id: hash[:hookId],
+          timestamp: Timestamp.from_h(hash[:timestamp])
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/test_run_started.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the TestRunStarted message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class TestRunStarted < Message
+      attr_reader :timestamp
+
+      attr_reader :id
+
+      def initialize(
+        timestamp: Timestamp.new,
+        id: nil
+      )
+        @timestamp = timestamp
+        @id = id
+        super()
+      end
+
+      ##
+      # Returns a new TestRunStarted from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::TestRunStarted.from_h(some_hash) # => #<Cucumber::Messages::TestRunStarted:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          timestamp: Timestamp.from_h(hash[:timestamp]),
+          id: hash[:id]
+        )
+      end
+    end
+  end
+end