cucumber-query 16.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53f2051f5e16ea98bdcb7e987df75df6672d11627748c12523e496e9404958e3
+  data.tar.gz: 39616c91c5bc55f69791912a476aa2bf0ab81cf553f005152a1d5d57a18c5b34
+SHA512:
+  metadata.gz: 6a18310da1223cdad7eda324e37ea3470cadcf2f5a78d972765967d5dc72e7c1d8a5e6dd7d38b004ae84e3f913a977eab29cd90f33a9e145b26e60f71fd9b9d6
+  data.tar.gz: 4c9a12d900b97bc4b4d0aad867ca4551a9243b185bd522a60ed4d9226f9519eea67978a4580b955c2a189f8eb76f191ff0a762939c13ef6a4d9e67e05be21861

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Cucumber Ltd and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/VERSION

@@ -0,0 +1 @@
+16.1.0

data/lib/cucumber/query.rb

@@ -0,0 +1,345 @@
+# frozen_string_literal: true
+
+require 'cucumber/messages'
+
+require_relative 'repository'
+
+# Given one Cucumber Message, find another.
+#
+# Queries can be made while the test run is incomplete - and this will naturally return incomplete results
+# see {Cucumber Messages - Message Overview}[https://github.com/cucumber/messages?tab=readme-ov-file#message-overview]
+#
+module Cucumber
+  # Provides lookup methods for related Cucumber messages stored in the `Repository` class.
+  class Query
+    attr_reader :repository
+    private :repository
+
+    include Cucumber::Messages::Helpers::TimeConversion
+    include Cucumber::Messages::Helpers::TestStepResultComparator
+
+    def initialize(repository)
+      @repository = repository
+    end
+
+    # @return [Integer]
+    def count_test_cases_started
+      find_all_test_case_started.length
+    end
+
+    # @return [Array<Pickle>]
+    def find_all_pickles
+      repository.pickle_by_id.values
+    end
+
+    # @return [Array<PickleStep>]
+    def find_all_pickle_steps
+      repository.pickle_step_by_id.values
+    end
+
+    # @return [Array<StepDefinition>]
+    def find_all_step_definitions
+      repository.step_definition_by_id.values
+    end
+
+    # @return [Array<TestCaseStarted>]
+    # This finds all test cases from the following conditions (UNION)
+    #   -> Test cases that have started, but not yet finished
+    #   -> Test cases that have started, finished, but that will NOT be retried
+    def find_all_test_case_started
+      repository.test_case_started_by_id.values.select do |test_case_started|
+        test_case_finished = find_test_case_finished_by(test_case_started)
+        test_case_finished.nil? || !test_case_finished.will_be_retried
+      end
+    end
+
+    # @return [Array<TestCaseFinished>]
+    # This finds all test cases that have finished AND will not be retried
+    def find_all_test_case_finished
+      repository.test_case_finished_by_test_case_started_id.values.reject(&:will_be_retried)
+    end
+
+    # @return [Array<TestCase>]
+    def find_all_test_cases
+      repository.test_case_by_id.values
+    end
+
+    # @return [Array<TestRunHookStarted>]
+    def find_all_test_run_hook_started
+      repository.test_run_hook_started_by_id.values
+    end
+
+    # @return [Array<TestRunHookFinished>]
+    def find_all_test_run_hook_finished
+      repository.test_run_hook_finished_by_test_run_hook_started_id.values
+    end
+
+    # @return [Array<TestStepStarted>]
+    def find_all_test_step_started
+      repository.test_steps_started_by_test_case_started_id.values.flatten
+    end
+
+    # @return [Array<TestStepFinished>]
+    def find_all_test_step_finished
+      repository.test_steps_finished_by_test_case_started_id.values.flatten
+    end
+
+    # @return [Array<TestStep>]
+    def find_all_test_steps
+      repository.test_step_by_id.values
+    end
+
+    # @return [Array<UndefinedParameterType>]
+    def find_all_undefined_parameter_types
+      repository.undefined_parameter_types
+    end
+
+    # @param message [TestStep, TestRunHookStarted, TestRunHookFinished]
+    # @return [Array<Hook>, nil]
+    def find_hook_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestStep, Cucumber::Messages::TestRunHookStarted, Cucumber::Messages::TestRunHookFinished],
+        '#find_hook_by'
+      )
+
+      if message.is_a?(Cucumber::Messages::TestRunHookFinished)
+        test_run_hook_started_message = find_test_run_hook_started_by(message)
+        test_run_hook_started_message && find_hook_by(test_run_hook_started_message)
+      else
+        repository.hook_by_id[message.hook_id]
+      end
+    end
+
+    # @return [Meta]
+    def find_meta
+      repository.meta
+    end
+
+    # @param message [TestCaseStarted, TestCaseFinished]
+    # @return [TestStepResult, nil]
+    def find_most_severe_test_step_result_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestCaseStarted, Cucumber::Messages::TestCaseFinished],
+        '#find_most_severe_test_step_result_by'
+      )
+
+      if message.is_a?(Cucumber::Messages::TestCaseStarted)
+        find_test_steps_finished_by(message)
+          .map(&:test_step_result)
+          .max_by { |test_step_result| test_step_result_rankings[test_step_result.status] }
+      else
+        test_case_started_message = find_test_case_started_by(message)
+        test_case_started_message && find_most_severe_test_step_result_by(test_case_started_message)
+      end
+    end
+
+    # @param message [TestCase, TestCaseStarted, TestCaseFinished, TestStepStarted, TestStepFinished]
+    # @return [Pickle]
+    def find_pickle_by(message)
+      ensure_only_message_types!(
+        message,
+        [
+          Cucumber::Messages::TestCase,
+          Cucumber::Messages::TestCaseStarted,
+          Cucumber::Messages::TestCaseFinished,
+          Cucumber::Messages::TestStepStarted,
+          Cucumber::Messages::TestStepFinished
+        ],
+        '#find_pickle_by'
+      )
+
+      test_case_message = message.is_a?(Cucumber::Messages::TestCase) ? message : find_test_case_by(message)
+      repository.pickle_by_id[test_case_message.pickle_id]
+    end
+
+    # @param message [TestStep]
+    # @return [PickleStep]
+    def find_pickle_step_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestStep],
+        '#find_pickle_step_by'
+      )
+
+      repository.pickle_step_by_id[message.pickle_step_id]
+    end
+
+    # @param message [PickleStep]
+    # @return [Step]
+    def find_step_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::PickleStep],
+        '#find_step_by'
+      )
+
+      repository.step_by_id[message.ast_node_ids.first]
+    end
+
+    # @param message [TestStep]
+    # @return [Array<StepDefinition>]
+    def find_step_definitions_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestStep],
+        '#find_step_definitions_by'
+      )
+
+      ids = message.step_definition_ids.nil? ? [] : message.step_definition_ids
+      ids.filter_map { |id| repository.step_definition_by_id[id] }
+    end
+
+    # @param message [Pickle, PickleStep]
+    # @return [Array<Suggestion>]
+    def find_suggestions_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::Pickle, Cucumber::Messages::PickleStep],
+        '#find_suggestions_by'
+      )
+
+      if message.is_a?(Cucumber::Messages::PickleStep)
+        repository.suggestions_by_pickle_step_id[message.id]
+      else
+        message.steps.flat_map { |pickle_step| find_suggestions_by(pickle_step) }
+      end
+    end
+
+    # @param message [TestCaseStarted, TestCaseFinished, TestStepStarted, TestStepFinished]
+    # @return [TestCase]
+    def find_test_case_by(message)
+      ensure_only_message_types!(
+        message,
+        [
+          Cucumber::Messages::TestCaseStarted,
+          Cucumber::Messages::TestCaseFinished,
+          Cucumber::Messages::TestStepStarted,
+          Cucumber::Messages::TestStepFinished
+        ],
+        '#find_test_case_by'
+      )
+
+      test_case_started_message = message.is_a?(Cucumber::Messages::TestCaseStarted) ? message : find_test_case_started_by(message)
+      repository.test_case_by_id[test_case_started_message.test_case_id]
+    end
+
+    # @param message [TestCaseFinished, TestStepStarted, TestStepFinished]
+    # @return [TestCaseStarted]
+    def find_test_case_started_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestCaseFinished, Cucumber::Messages::TestStepStarted, Cucumber::Messages::TestStepFinished],
+        '#find_test_case_started_by'
+      )
+
+      repository.test_case_started_by_id[message.test_case_started_id]
+    end
+
+    # @param message [TestCaseStarted]
+    # @return [TestCaseFinished]
+    def find_test_case_finished_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestCaseStarted],
+        '#find_test_case_finished_by'
+      )
+
+      repository.test_case_finished_by_test_case_started_id[message.id]
+    end
+
+    # @return [Hash<String, Integer>, nil]
+    def find_test_run_duration
+      if repository.test_run_started.nil? || repository.test_run_finished.nil?
+        nil
+      else
+        float_time = timestamp_to_time(repository.test_run_finished.timestamp) - timestamp_to_time(repository.test_run_started.timestamp)
+        seconds_to_duration(float_time)
+      end
+    end
+
+    # @param message [TestRunHookFinished]
+    # @return [TestRunHookStarted]
+    def find_test_run_hook_started_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestRunHookFinished],
+        '#find_test_run_hook_started_by'
+      )
+
+      repository.test_run_hook_started_by_id[message.test_run_hook_started_id]
+    end
+
+    # @param message [TestRunHookStarted]
+    # @return [TestRunHookFinished]
+    def find_test_run_hook_finished_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestRunHookStarted],
+        '#find_test_run_hook_finished_by'
+      )
+
+      repository.test_run_hook_finished_by_test_run_hook_started_id[message.id]
+    end
+
+    # @return [TestRunStarted]
+    def find_test_run_started
+      repository.test_run_started
+    end
+
+    # @return [TestRunFinished]
+    def find_test_run_finished
+      repository.test_run_finished
+    end
+
+    # @param message [TestStepStarted, TestStepFinished]
+    # @return [TestStep]
+    def find_test_step_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestStepStarted, Cucumber::Messages::TestStepFinished],
+        '#find_test_step_by'
+      )
+
+      repository.test_step_by_id[message.test_step_id]
+    end
+
+    # @param message [TestCaseStarted, TestCaseFinished]
+    # @return [Array<TestStep>]
+    def find_test_steps_started_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestCaseStarted, Cucumber::Messages::TestCaseFinished],
+        '#find_test_steps_started_by'
+      )
+
+      key = message.is_a?(Cucumber::Messages::TestCaseStarted) ? message.id : message.test_case_started_id
+      repository.test_steps_started_by_test_case_started_id.fetch(key, [])
+    end
+
+    # @param message [TestCaseStarted, TestCaseFinished]
+    # @return [Array<TestStep>]
+    def find_test_steps_finished_by(message)
+      ensure_only_message_types!(
+        message,
+        [Cucumber::Messages::TestCaseStarted, Cucumber::Messages::TestCaseFinished],
+        '#find_test_steps_finished_by'
+      )
+
+      if message.is_a?(Cucumber::Messages::TestCaseStarted)
+        repository.test_steps_finished_by_test_case_started_id.fetch(message.id, [])
+      else
+        test_case_started_message = find_test_case_started_by(message)
+        test_case_started_message.nil? ? [] : find_test_steps_finished_by(test_case_started_message)
+      end
+    end
+
+    private
+
+    def ensure_only_message_types!(supplied_message, permissible_message_types, method_name)
+      raise ArgumentError, "Supplied argument is not a Cucumber Message. Argument: #{supplied_message.class}" unless supplied_message.is_a?(Cucumber::Messages::Message)
+      raise ArgumentError, "Supplied message type '#{supplied_message.class}' is not permitted to be used when calling #{method_name}" unless permissible_message_types.include?(supplied_message.class)
+    end
+  end
+end

data/lib/cucumber/repository.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Cucumber
+  # In memory repository i.e. a thread based link to cucumber-query
+  class Repository
+    attr_accessor :meta, :test_run_started, :test_run_finished
+    attr_reader :attachments_by_test_case_started_id, :attachments_by_test_run_hook_started_id,
+                :hook_by_id,
+                :pickle_by_id, :pickle_step_by_id,
+                :suggestions_by_pickle_step_id,
+                :step_by_id, :step_definition_by_id,
+                :test_case_by_id, :test_case_started_by_id, :test_case_finished_by_test_case_started_id,
+                :test_run_hook_started_by_id, :test_run_hook_finished_by_test_run_hook_started_id,
+                :test_step_by_id, :test_steps_started_by_test_case_started_id, :test_steps_finished_by_test_case_started_id,
+                :undefined_parameter_types
+
+    def initialize
+      @attachments_by_test_case_started_id = _hash_with_array_default
+      @attachments_by_test_run_hook_started_id = _hash_with_array_default
+      @hook_by_id = {}
+      @pickle_by_id = {}
+      @pickle_step_by_id = {}
+      @step_by_id = {}
+      @step_definition_by_id = {}
+      @suggestions_by_pickle_step_id = _hash_with_array_default
+      @test_case_by_id = {}
+      @test_case_started_by_id = {}
+      @test_case_finished_by_test_case_started_id = {}
+      @test_run_hook_started_by_id = {}
+      @test_run_hook_finished_by_test_run_hook_started_id = {}
+      @test_step_by_id = {}
+      @test_steps_started_by_test_case_started_id = _hash_with_array_default
+      @test_steps_finished_by_test_case_started_id = _hash_with_array_default
+      @undefined_parameter_types = []
+    end
+
+    def update(envelope)
+      message_category = envelope.type[:contained_message]
+      message_value = envelope.public_send(message_category)
+      send("update_#{message_category}", message_value)
+    end
+
+    private
+
+    def method_missing(method_name, *args, &)
+      if method_name.to_s.start_with?('update_')
+        Kernel.warn("Attempting to update the repository with #{method_name}. Please raise this as a missing message handler")
+        Kernel.warn('Create an issue here: https://github.com/cucumber/query/issues')
+        nil
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.start_with?('update_') || super
+    end
+
+    def update_attachment(attachment)
+      attachments_by_test_case_started_id[attachment.test_case_started_id] << attachment if attachment.test_case_started_id
+      attachments_by_test_run_hook_started_id[attachment.test_run_hook_started_id] << attachment if attachment.test_run_hook_started_id
+    end
+
+    def update_feature(feature)
+      feature.children.each do |feature_child|
+        update_steps(feature_child.background.steps) if feature_child.background
+        update_scenario(feature_child.scenario) if feature_child.scenario
+        feature_child.rule&.children&.each { |rule_child| _update_feature_rule(rule_child) }
+      end
+    end
+
+    def update_gherkin_document(gherkin_document)
+      update_feature(gherkin_document.feature) if gherkin_document.feature
+    end
+
+    def update_hook(hook)
+      hook_by_id[hook.id] = hook
+    end
+
+    def update_meta(meta)
+      self.meta = meta
+    end
+
+    def update_pickle(pickle)
+      pickle_by_id[pickle.id] = pickle
+      pickle.steps.each { |pickle_step| pickle_step_by_id[pickle_step.id] = pickle_step }
+    end
+
+    def update_scenario(scenario)
+      update_steps(scenario.steps)
+    end
+
+    def update_source(_source)
+      # This deliberately doesn't perform any handling. `Source` as a message is not stored or required
+      #   - See `GherkinDocument` for a more "parsed" form of an AST representation
+      :no_op
+    end
+
+    def update_steps(steps)
+      steps.each { |step| step_by_id[step.id] = step }
+    end
+
+    def update_step_definition(step_definition)
+      step_definition_by_id[step_definition.id] = step_definition
+    end
+
+    def update_suggestion(suggestion)
+      suggestions_by_pickle_step_id[suggestion.pickle_step_id] << suggestion
+    end
+
+    def update_test_case(test_case)
+      test_case_by_id[test_case.id] = test_case
+      test_case.test_steps.each { |test_step| test_step_by_id[test_step.id] = test_step }
+    end
+
+    def update_test_case_started(test_case_started)
+      test_case_started_by_id[test_case_started.id] = test_case_started
+    end
+
+    def update_test_case_finished(test_case_finished)
+      test_case_finished_by_test_case_started_id[test_case_finished.test_case_started_id] = test_case_finished
+    end
+
+    def update_test_run_started(test_run_started)
+      self.test_run_started = test_run_started
+    end
+
+    def update_test_run_finished(test_run_finished)
+      self.test_run_finished = test_run_finished
+    end
+
+    def update_test_run_hook_started(test_run_hook_started)
+      test_run_hook_started_by_id[test_run_hook_started.id] = test_run_hook_started
+    end
+
+    def update_test_run_hook_finished(test_run_hook_finished)
+      test_run_hook_finished_by_test_run_hook_started_id[test_run_hook_finished.test_run_hook_started_id] = test_run_hook_finished
+    end
+
+    def update_test_step_started(test_step_started)
+      test_steps_started_by_test_case_started_id[test_step_started.test_case_started_id] << test_step_started
+    end
+
+    def update_test_step_finished(test_step_finished)
+      test_steps_finished_by_test_case_started_id[test_step_finished.test_case_started_id] << test_step_finished
+    end
+
+    def update_undefined_parameter_type(undefined_parameter_type)
+      undefined_parameter_types << undefined_parameter_type
+    end
+
+    def _update_feature_rule(rule_child)
+      update_steps(rule_child.background.steps) if rule_child.background
+      update_scenario(rule_child.scenario) if rule_child.scenario
+    end
+
+    def _hash_with_array_default
+      Hash.new { |hash, key| hash[key] = [] }
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-query
+version: !ruby/object:Gem::Version
+  version: 16.1.0
+platform: ruby
+authors:
+- Luke Hill
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber-messages
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '34.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '36'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '34.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '36'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.88.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.88.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.2
+description: Cucumber Query - query messages
+email: cukebot@cucumber.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- VERSION
+- lib/cucumber/query.rb
+- lib/cucumber/repository.rb
+homepage: https://github.com/cucumber/query
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/cucumber/query/issues
+  changelog_uri: https://github.com/cucumber/query/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/cucumber/query/blob/main/README.md
+  mailing_list_uri: https://groups.google.com/forum/#!forum/cukes
+  source_code_uri: https://github.com/cucumber/query/blob/main/ruby
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.8
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: cucumber-query-16.1.0
+test_files: []