alinta-cucumber-rest-bdd 0.5.22 → 0.5.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e78ccb9ec136ed4347daaa0afafc066e44beaabd5a19cafbffd54a4e2039507c
-  data.tar.gz: 6f73934f0c2df4bb620d2e09412b1c4cb5e1273aac70d771df1e65e6ac7ca854
+  metadata.gz: c5dec7f07c1f119eb37358b529c13278f00aac9d9a7b7266f012bf3b43edf4a8
+  data.tar.gz: 18cef53fd72a2717fb392c2ac23e2d853779038ae5fc779238a351dc649d252d
 SHA512:
-  metadata.gz: 4fa555baada878b6e8480d319a2a26155b802fd38d2a410fe27a271c0a37283c9f5c7bfc51c70f74da909ae2e7cc2fa594467b62ce0818ce28fdccd0bbe6ee32
-  data.tar.gz: 6995a6ebaf778b666dbbd17e4a3a18e16f8fbbbe4d99abf03f1ef0c4e2aba0c76c2f6709de56e8857791efab69f76ae4fe98b1d61d97ba32a3c689d7ebd1306a
+  metadata.gz: 266a787b8396ffd88d33d603c66b4245d79e7a66490f8bdcb0991d11ec9f7658813fad1b094d7ab33a9e3e66c4e5624f350b230c5684bac09fcb4b0ab90e8fdb
+  data.tar.gz: 278fc49764b69122daed202e8201d8171ea3519398410b633e4a4356e4091bc475f0d2800ce3a2a789678e7554a512791ff967d48f478c19bbd4ee1e8c306197

data/lib/cucumber-rest-bdd/data.rb

@@ -43,10 +43,10 @@ def get_child_data(level, data)
     else
         levelKey = case level[:type]
             when 'single' then get_field(level[:key])
-            when 'multiple' then get_field(level[:key])
-            when 'list' then get_resource(level[:key])
+            when 'multiple' then get_list_field(level[:key])
+            when 'list' then get_list_field(level[:key])
         end
-        raise %/Key not found: #{level[:key]} as #{levelKey} in #{data}/ if !data[levelKey]
+        raise %/Key not found: #{level[:key]} as #{levelKey} in #{data}/ if data.is_a?(Array) || !data[levelKey]
         return data[levelKey]
     end
 end

data/lib/cucumber-rest-bdd/steps/response.rb

@@ -7,8 +7,18 @@ Then("print the response") do
     puts %/The response:\n#{@response.to_json_s}/
 end
 
-# response interrogation
+# SIMPLE VALUE RESPONSE
 
+# response is a string with the specified value
+Then("the response #{HAVE_ALTERNATION} (the )(following )value {string}") do |value|
+    expected = value
+    data = @response.get get_root_data_key()
+    raise %/Response did not match: #{expected}\n#{data}/ if data.empty? || !data.include?(expected)
+end
+
+# OBJECT RESPONSE
+
+# response is an object with a field that is validated by a pre-defined regex
 Then("the response #{HAVE_ALTERNATION} {field_name} of type {word}") do |field, type|
     regex = case type
         when 'datetime' then /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,3})?(?:[+|-]\d{2}:\d{2})?$/i
@@ -21,92 +31,108 @@ Then("the response #{HAVE_ALTERNATION} {field_name} of type {word}") do |field,
     field.validate_value(@response, value.to_s, Regexp.new(regex))
 end
 
+# response is an object with a field that is validated by a custom regex
 Then("the response #{HAVE_ALTERNATION} {field_name} of type {word} that matches {string}") do |field, type, regex|
     value = field.get_value(@response, type)
     field.validate_value(@response, value.to_s, Regexp.new(regex))
 end
 
-Then("the response is a list of/containing {list_has_count} {field_name}") do |list_comparison, item|
-    list = @response.get_as_type get_root_data_key(), 'array'
-    raise %/Expected #{list_comparison.to_string()} items in array for path '#{get_root_data_key()}', found: #{list.count}\n#{@response.to_json_s}/ if !list_comparison.compare(list.count)
-end
-
-# Responses without nesting
-
+# response is an object with specific attributes having defined values
 Then("the response #{HAVE_ALTERNATION} (the )(following )attributes:") do |attributes|
     expected = get_attributes(attributes.hashes)
     data = @response.get get_root_data_key()
     raise %/Response did not match:\n#{expected.inspect}\n#{data}/ if data.empty? || !data.deep_include?(expected)
 end
 
-Then("the response #{HAVE_ALTERNATION} (the )(following )value {string}") do |value|
-    expected = value
-    data = @response.get get_root_data_key()
-    raise %/Response did not match: #{expected}\n#{data}/ if data.empty? || !data.include?(expected)
+# ARRAY RESPONSE
+
+# response is an array of objects
+Then("the response is a list of/containing {list_has_count} {field_name}") do |list_comparison, item|
+    list = @response.get_as_type get_root_data_key(), 'array'
+    raise %/Expected #{list_comparison.to_string()} items in array for path '#{get_root_data_key()}', found: #{list.count}\n#{@response.to_json_s}/ if !list_comparison.compare(list.count)
 end
 
-Then("{list_has_count} {field_name} #{HAVE_ALTERNATION} (the )(following )(data )attributes:") do |list_comparison, field, attributes|
+# response is an array of objects where the specified number of entries match the defined data attributes
+Then("the response is a list with {list_has_count} entry/entries having/containing/with (the )(following )(data )attributes:") do |list_comparison, attributes|
     expected = get_attributes(attributes.hashes)
-    data = field.get_value(@response, 'array')
+    data = @response.get_as_type get_root_data_key(), 'array'
     matched = data.select { |item| !item.empty? && item.deep_include?(expected) }
     raise %/Expected #{list_comparison.to_string()} items in array that matched:\n#{expected.inspect}\n#{data}/ if !list_comparison.compare(matched.count)
 end
 
-Then("{list_has_count} {field_name} #{HAVE_ALTERNATION} (the )(following )value {string}") do |list_comparison, field, value|
-    expected = value
-    data = field.get_value(@response, 'array')
-    matched = data.select { |item| !item.empty? && item.include?(expected) }
-    raise %/Expected #{list_comparison.to_string()} items in array that matched:\n#{expected}\n#{data}/ if !list_comparison.compare(matched.count)
+# response is an array of objects where the specified number of entries match the defined data attributes
+Then("the response is a list with {list_has_count} entry/entries {list_nesting}") do |list_comparison, nesting|
+    nesting.push({
+        root: true,
+        type: 'multiple',
+        comparison: list_comparison
+    })
+    data = @response.get get_key(nesting.grouping)
+    raise %/Could not find a match for: #{nesting.match}\n#{@response.to_json_s}/ if data.empty? || !nest_match_attributes(data, nesting.grouping, {}, false)
 end
 
-# Responses with nesting
-
-Then("the response {list_nesting} #{HAVE_ALTERNATION} (the )(following )attributes:") do |nesting, attributes|
+# response is an array of objects where the specified number of entries match the defined data attributes
+Then("the response is a list with {list_has_count} entry/entries {list_nesting} #{HAVE_ALTERNATION} (the )(following )(data )attributes:") do |list_comparison, nesting, attributes|
     expected = get_attributes(attributes.hashes)
     nesting.push({
         root: true,
-        type: 'single'
+        type: 'multiple',
+        comparison: list_comparison
     })
     data = @response.get get_key(nesting.grouping)
     raise %/Could not find a match for: #{nesting.match}\n#{expected.inspect}\n#{@response.to_json_s}/ if data.empty? || !nest_match_attributes(data, nesting.grouping, expected, false)
 end
 
-Then("the response {list_nesting} #{HAVE_ALTERNATION} (the )(following )value {string}") do |nesting, value|
+# response is an array of objects where the specified number of entries match the defined string value
+Then("the response is a list with {list_has_count} entry/entries having/containing/with (the )(following )value {string}") do |list_comparison, value|
+    expected = value
+    data = @response.get_as_type get_root_data_key(), 'array'
+    matched = data.select { |item| !item.empty? && item.include?(expected) }
+    raise %/Expected #{list_comparison.to_string()} items in array that matched:\n#{expected}\n#{data}/ if !list_comparison.compare(matched.count)
+end
+
+# response is an array of objects where the specified number of entries match the defined string value
+Then("the response is a list with {list_has_count} entry/entries {list_nesting} #{HAVE_ALTERNATION} (the )(following )value {string}") do |list_comparison, nesting, value|
     expected = value
     nesting.push({
         root: true,
-        type: 'single'
+        type: 'multiple',
+        comparison: list_comparison
     })
     data = @response.get get_key(nesting.grouping)
     raise %/Could not find a match for: #{nesting.match}\n#{expected}\n#{@response.to_json_s}/ if data.empty? || !nest_match_attributes(data, nesting.grouping, expected, true)
 end
 
-Then("the response {list_nesting}") do |nesting|
+# HIERARCHICAL RESPONSE
+
+# response has the specified hierarchy of objects / lists where the specified number of leaf items match the defined data attributes
+Then("the response {list_nesting} #{HAVE_ALTERNATION} (the )(following )attributes:") do |nesting, attributes|
+    expected = get_attributes(attributes.hashes)
     nesting.push({
         root: true,
         type: 'single'
     })
     data = @response.get get_key(nesting.grouping)
-    raise %/Could not find a match for: #{nesting.match}\n#{@response.to_json_s}/ if data.empty? || !nest_match_attributes(data, nesting.grouping, {}, false)
+    raise %/Could not find a match for: #{nesting.match}\n#{expected.inspect}\n#{@response.to_json_s}/ if data.empty? || !nest_match_attributes(data, nesting.grouping, expected, false)
 end
 
-Then("{list_has_count} {field_name} {list_nesting} #{HAVE_ALTERNATION} (the )(following )(data )attributes:") do |list_comparison, count_item, nesting, attributes|
-    expected = get_attributes(attributes.hashes)
+# response has the specified hierarchy of objects / lists where the specified number of leaf items match the defined string value
+Then("the response {list_nesting} #{HAVE_ALTERNATION} (the )(following )value {string}") do |nesting, value|
+    expected = value
     nesting.push({
         root: true,
-        type: 'multiple',
-        comparison: list_comparison
+        type: 'single'
     })
     data = @response.get get_key(nesting.grouping)
-    raise %/Expected #{list_comparison.to_string()} items in array with attributes for: #{nesting.match}\n#{expected.inspect}\n#{@response.to_json_s}/ if !nest_match_attributes(data, nesting.grouping, expected, false)
+    raise %/Could not find a match for: #{nesting.match}\n#{expected}\n#{@response.to_json_s}/ if data.empty? || !nest_match_attributes(data, nesting.grouping, expected, true)
 end
 
-Then("{list_has_count} {field_name} {list_nesting}") do |list_comparison, item, nesting|
+# response has the specified hierarchy of objects / lists where the specified number of leaf items is as expected only (no data checked)
+Then("the response {list_nesting}") do |nesting|
     nesting.push({
         root: true,
-        type: 'multiple',
-        comparison: list_comparison
+        type: 'single'
     })
     data = @response.get get_key(nesting.grouping)
-    raise %/Expected #{list_comparison.to_string()} items in array with: #{nesting.match}\n#{@response.to_json_s}/ if !nest_match_attributes(data, nesting.grouping, {}, false)
+    raise %/Could not find a match for: #{nesting.match}\n#{@response.to_json_s}/ if data.empty? || !nest_match_attributes(data, nesting.grouping, {}, false)
 end

data/lib/cucumber-rest-bdd/types.rb

@@ -123,6 +123,18 @@ def get_field(name)
     return name
 end
 
+def get_list_field(name)
+    if name[0] == '`' && name[-1] == '`'
+        name = name[1..-2]
+    elsif name[0] != '[' || name[-1] != ']'
+        separator = ENV.has_key?('field_separator') ? ENV['field_separator'] : '_'
+        name = name.parameterize(separator: separator)
+        name = name.pluralize
+        name = name.camelize(:lower) if (ENV.has_key?('field_camel') && ENV['field_camel'] == 'true')
+    end
+    return name
+end
+
 def get_attributes(hashes)
     attributes = hashes.each_with_object({}) do |row, hash|
       name, value, type = row["attribute"], row["value"], row["type"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alinta-cucumber-rest-bdd
 version: !ruby/object:Gem::Version
-  version: 0.5.22
+  version: 0.5.23
 platform: ruby
 authors:
 - Harry Bragg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-api