Centralize rest yaml test parsing helper methods

Author: estolfo

api-spec-testing/test_file/test.rb

@@ -26,6 +26,47 @@ class TestFile
       # @since 6.2.0
       class Test
 
+        class << self
+
+          # Given a list of keys, find the value in a recursively nested document.
+          #
+          # @param [ Array<String> ] chain The list of nested document keys.
+          # @param [ Hash ] document The document to find the value in.
+          #
+          # @return [ Object ] The value at the nested key.
+          #
+          # @since 6.2.0
+          def find_value_in_document(chain, document)
+            return document[chain[0]] unless chain.size > 1
+            # a number can be a string key in a Hash or indicate an element in a list
+            if document.is_a?(Hash)
+              find_value_in_document(chain[1..-1], document[chain[0].to_s]) if document[chain[0].to_s]
+            elsif document[chain[0]]
+              find_value_in_document(chain[1..-1], document[chain[0]]) if document[chain[0]]
+            end
+          end
+
+          # Given a string representing a nested document key using dot notation,
+          #   split it, keeping escaped dots as part of a key name and replacing
+          #   numerics with a Ruby Integer.
+          #
+          # For example:
+          #   "joe.metadata.2.key2" => ['joe', 'metadata', 2, 'key2']
+          #   "jobs.0.node.attributes.ml\\.enabled" => ["jobs", 0, "node", "attributes", "ml\\.enabled"]
+          #
+          # @param [ String ] chain The list of nested document keys.
+          # @param [ Hash ] document The document to find the value in.
+          #
+          # @return [ Array<Object> ] A list of the nested keys.
+          #
+          # @since 6.2.0
+          def split_and_parse_key(key)
+            key.split(/(?<!\\)\./).map do |key|
+              (key =~ /\A[-+]?[0-9]+\z/) ? key.to_i: key.gsub('\\', '')
+            end.reject { |k| k == '$body' }
+          end
+        end
+
         attr_reader :description
         attr_reader :test_file
         attr_reader :cached_values
@@ -192,6 +233,23 @@ def skip_test?(client, features_to_skip = test_file.features_to_skip)
           end
         end
 
+        # Replace the `$master` substring in a key with the cached master node's id.
+        #
+        # @param [ String ] expected_key The expected key, containing the substring `$master` that needs to be replaced.
+        #
+        # See test xpack/10_basic.yml
+        
+        # @return [ String ] The altered key.
+        #
+        # @since 7.2.0
+        def inject_master_node_id(expected_key)
+          if cached_values['master']
+            expected_key.gsub(/\$master/, cached_values['master'])
+          else
+            expected_key
+          end
+        end
+
         private
 
         def contains_features_to_skip?(features_to_skip, skip_defintion)

elasticsearch-api/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -27,8 +27,8 @@
       # ssl test returns results at '$body' key. See ssl/10_basic.yml
       expected_pairs = expected_pairs['$body'] if expected_pairs['$body']
 
-      expected_key = inject_master_node_id(expected_key, test)
-      split_key = split_and_parse_key(expected_key)
+      expected_key = test.inject_master_node_id(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -49,8 +49,8 @@
   match do |response|
     # Handle is_true: ''
     return !!response if field == ''
-    split_key = split_and_parse_key(field).collect { |k| test.get_cached_value(k) }
-    !!find_value_in_document(split_key, response)
+    split_key = Test.split_and_parse_key(field).collect { |k| test.get_cached_value(k) }
+    !!Test.find_value_in_document(split_key, response)
   end
 end
 
@@ -60,8 +60,8 @@
   match do |response|
     # Handle is_false: ''
     return !response if field == ''
-    split_key = split_and_parse_key(field).collect { |k| test.get_cached_value(k) }
-    value_in_doc = find_value_in_document(split_key, response)
+    split_key = Test.split_and_parse_key(field).collect { |k| test.get_cached_value(k) }
+    value_in_doc = Test.find_value_in_document(split_key, response)
     value_in_doc == 0 || !value_in_doc
   end
 end
@@ -72,8 +72,8 @@
   match do |response|
     expected_pairs.all? do |expected_key, expected_value|
 
-      expected_key = inject_master_node_id(expected_key, test)
-      split_key = split_and_parse_key(expected_key)
+      expected_key = test.inject_master_node_id(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
 
@@ -95,8 +95,8 @@
   match do |response|
     expected_pairs.all? do |expected_key, expected_value|
 
-      expected_key = inject_master_node_id(expected_key, test)
-      split_key = split_and_parse_key(expected_key)
+      expected_key = test.inject_master_node_id(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -117,8 +117,8 @@
   match do |response|
     expected_pairs.all? do |expected_key, expected_value|
 
-      expected_key = inject_master_node_id(expected_key, test)
-      split_key = split_and_parse_key(expected_key)
+      expected_key = test.inject_master_node_id(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -139,8 +139,8 @@
   match do |response|
     expected_pairs.all? do |expected_key, expected_value|
 
-      expected_key = inject_master_node_id(expected_key, test)
-      split_key = split_and_parse_key(expected_key)
+      expected_key = test.inject_master_node_id(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -172,10 +172,10 @@
 
       # See test xpack/10_basic.yml
       # The master node id must be injected in the keys of match clauses
-      expected_key = inject_master_node_id(expected_key, test)
+      expected_key = test.inject_master_node_id(expected_key)
 
-      split_key = split_and_parse_key(expected_key)
-      actual_value = find_value_in_document(split_key, response)
+      split_key = Test.split_and_parse_key(expected_key)
+      actual_value = Test.find_value_in_document(split_key, response)
 
       # Sometimes the expected value is a cached value from a previous request.
       # See test api_key/10_basic.yml

elasticsearch-api/spec/rest_yaml_tests_helper.rb

@@ -90,59 +90,3 @@
 
 # The features to skip
 REST_API_YAML_SKIP_FEATURES = ['warnings'].freeze
-
-# Given a list of keys, find the value in a recursively nested document.
-#
-# @param [ Array<String> ] chain The list of nested document keys.
-# @param [ Hash ] document The document to find the value in.
-#
-# @return [ Object ] The value at the nested key.
-#
-# @since 6.2.0
-def find_value_in_document(chain, document)
-  return document[chain[0]] unless chain.size > 1
-  # a number can be a string key in a Hash or indicate an element in a list
-  if document.is_a?(Hash)
-    find_value_in_document(chain[1..-1], document[chain[0].to_s]) if document[chain[0].to_s]
-  elsif document[chain[0]]
-    find_value_in_document(chain[1..-1], document[chain[0]]) if document[chain[0]]
-  end
-end
-
-# Given a string representing a nested document key using dot notation,
-#   split it, keeping escaped dots as part of a key name and replacing
-#   numerics with a Ruby Integer.
-#
-# For example:
-#   "joe.metadata.2.key2" => ['joe', 'metadata', 2, 'key2']
-#   "jobs.0.node.attributes.ml\\.enabled" => ["jobs", 0, "node", "attributes", "ml\\.enabled"]
-#
-# @param [ String ] chain The list of nested document keys.
-# @param [ Hash ] document The document to find the value in.
-#
-# @return [ Array<Object> ] A list of the nested keys.
-#
-# @since 6.2.0
-def split_and_parse_key(key)
-  key.split(/(?<!\\)\./).map do |key|
-    (key =~ /\A[-+]?[0-9]+\z/) ? key.to_i: key.gsub('\\', '')
-  end.reject { |k| k == '$body' }
-end
-
-# Replace the `$master` substring in a key with the cached master node's id.
-#
-# @param [ String ] expected_key The expected key, containing the substring `$master` that needs to be replaced.
-# @param [ Elasticsearch::RestAPIYAMLTests::TestFile::Test ] test The test.
-#
-# See test xpack/10_basic.yml
-#
-# @return [ String ] The altered key.
-#
-# @since 7.1.1
-def inject_master_node_id(expected_key, test)
-  if test.cached_values['master']
-    expected_key.gsub(/\$master/, test.cached_values['master'])
-  else
-    expected_key
-  end
-end

elasticsearch-xpack/spec/rest_yaml_tests_helper.rb

@@ -144,37 +144,3 @@
 
 # The features to skip
 REST_API_YAML_SKIP_FEATURES = ['warnings'].freeze
-
-
-# Given a list of keys, find the value in a recursively nested document.
-#
-# @param [ Array<String> ] chain The list of nested document keys.
-# @param [ Hash ] document The document to find the value in.
-#
-# @return [ Object ] The value at the nested key.
-#
-# @since 6.2.0
-def find_value_in_document(chain, document)
-  return document[chain[0]] unless chain.size > 1
-  find_value_in_document(chain[1..-1], document[chain[0]]) if document[chain[0]]
-end
-
-# Given a string representing a nested document key using dot notation,
-#   split it, keeping escaped dots as part of a key name and replacing
-#   numerics with a Ruby Integer.
-#
-# For example:
-#   "joe.metadata.2.key2" => ['joe', 'metadata', 2, 'key2']
-#   "jobs.0.node.attributes.ml\\.enabled" => ["jobs", 0, "node", "attributes", "ml\\.enabled"]
-#
-# @param [ String ] chain The list of nested document keys.
-# @param [ Hash ] document The document to find the value in.
-#
-# @return [ Array<Object> ] A list of the nested keys.
-#
-# @since 6.2.0
-def split_and_parse_key(key)
-  key.split(/(?<!\\)\./).map do |key|
-    (key =~ /\A[-+]?[0-9]+\z/) ? key.to_i: key.gsub('\\', '')
-  end.reject { |k| k == '$body' }
-end

elasticsearch-xpack/spec/xpack/rest_api_yaml_spec.rb

@@ -26,7 +26,7 @@
       # ssl test returns results at '$body' key. See ssl/10_basic.yml
       expected_pairs = expected_pairs['$body'] if expected_pairs['$body']
 
-      split_key = split_and_parse_key(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -46,7 +46,7 @@
   match do |response|
     # Handle is_true: ''
     return response == true if field == ''
-    !!find_value_in_document(split_and_parse_key(field), response)
+    !!Test.find_value_in_document(split_and_parse_key(field), response)
   end
 end
 
@@ -55,15 +55,15 @@
   match do |response|
     # Handle is_false: ''
     return response == false if field == ''
-    !find_value_in_document(split_and_parse_key(field), response)
+    !Test.find_value_in_document(split_and_parse_key(field), response)
   end
 end
 
 RSpec::Matchers.define :match_gte_field do |expected_pairs|
 
   match do |response|
     expected_pairs.all? do |expected_key, expected_value|
-      split_key = split_and_parse_key(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -82,7 +82,7 @@
 
   match do |response|
     expected_pairs.all? do |expected_key, expected_value|
-      split_key = split_and_parse_key(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -101,7 +101,7 @@
 
   match do |response|
     expected_pairs.all? do |expected_key, expected_value|
-      split_key = split_and_parse_key(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -120,7 +120,7 @@
 
   match do |response|
     expected_pairs.all? do |expected_key, expected_value|
-      split_key = split_and_parse_key(expected_key)
+      split_key = Test.split_and_parse_key(expected_key)
 
       actual_value = split_key.inject(response) do |_response, key|
         # If the key is an index, indicating element of a list
@@ -151,10 +151,10 @@
 
       # See test xpack/10_basic.yml
       # The master node id must be injected in the keys of match clauses
-      expected_key = inject_master_node_id(expected_key, test)
+      expected_key = test.inject_master_node_id(expected_key)
 
-      split_key = split_and_parse_key(expected_key)
-      actual_value = find_value_in_document(split_key, response)
+      split_key = Test.split_and_parse_key(expected_key)
+      actual_value = Test.find_value_in_document(split_key, response)
 
       # Sometimes the expected value is a cached value from a previous request.
       # See test api_key/10_basic.yml