cucumber-rest-bdd 0.4.4 → 0.5.1.pre.140

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdfd0c715aefc7a24bde96d6c3c6b99e3f740a25
-  data.tar.gz: b888b7f6187cff2d5d5c1bff03656a79b33905b7
+  metadata.gz: cb1d9233bd18d88c3a16492812de62b582ad2dae
+  data.tar.gz: e874e9bd715a41facadd47f02ed6be5f7f75d442
 SHA512:
-  metadata.gz: b7bdd8148100ed05bd005ddd5aafccf564fdcb24edd69e22e68abe6100e36d6d1530279f3703548a9054080c313452a6fc391b6568c42dd3393b1d128cfc80cd
-  data.tar.gz: 79ad4ad6c2116dcdc21b2172cb14993397d89b70b5d89ebaafb606c907cf2938759b89fd1469d2c1f85ca10094b4d2b44a489a24fc3001203ad0a73fcca81fbc
+  metadata.gz: 57f0046b7719f6f35c1f6de7f9fc8f825d9fa8ba913699abf47bbd4cadef25e1819e8e0d0929b2eb2e31b368ed733b68ce7b1810463bf57ad2ce8c21a57ca4aa
+  data.tar.gz: 9cfa198f99325aa0dc96d648eb9f7c44df37735b083c2e63b43d898d3983e55cb93a1e5f01f3e111d29d2048aad4868af0a8c8db65453bd2f5aaa6104f95db90

data/Dockerfile

@@ -1,7 +1,7 @@
 FROM ruby
 
 MAINTAINER "Harry Bragg <harry.bragg@graze.com>"
-LABEL version="0.4.4" \
+LABEL version="0.5.1" \
       license="MIT"
 
 COPY . /usr/local/cucumber-rest-bdd
@@ -18,6 +18,7 @@ ENV field_camel=false
 ENV resource_single=false
 ENV cucumber_api_verbose=false
 ENV data_key=
+ENV error_key=error
 ENV set_parent_id=false
 
 CMD ["cucumber"]

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 graze.com
+Copyright (c) 2017 graze.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -5,7 +5,7 @@ build:
 	docker-compose build runner
 
 test: start-test-server
-	docker-compose run --rm runner cucumber --order random
+	docker-compose run --rm runner cucumber --order random --format progress
 	make stop-test-server > /dev/null 2>&1 &
 
 start-test-server: stop-test-server

data/README.md

@@ -35,6 +35,7 @@ The following environment variables modify how this will operate:
 
 - `endpoint` - (string) the base url to call for each request
 - `data_key` - (string) the root data key (if applicable) (for example: `"data"` if all responses have a `{"data":{}}` field)
+- `error_key` - (string) this will ignore the `data_key` when checking for errors
 - `field_separator` - (string) the separator used between words by the api
 - `field_camel` - (bool [`true`|`false`]) does this endpoint use camelCase for fields (default: `false`)
 - `resource_single` - (bool [`true`|`false`]) if each resource should be singularized or not (default: `false`)
@@ -154,6 +155,31 @@ Then more than 10 posts have five comments
 Then less than 200 posts have five comments
 ```
 
+#### Errors
+
+If the `error_key` environment variable is set, if that key is used as the initial step it will ignore any `data_key`
+setting.
+
+Example: `error_key=error`, `data_key=data`
+
+```gherkin
+Then the response has a list of posts       | {"data":[{"id": 12}]}
+
+Then the response has one error             | {"errors":[{"message": "Error"}]}
+
+Then the response has an error              | {"error": {"message": "Error}}
+```
+
+Example: `error_key=`, `data_key=data`
+
+```gherkin
+Then the response has a list of posts       | {"data":[{"id": 12}]}
+
+Then the response has one error             | {"data": {"errors":[{"message": "Error"}]}}
+
+Then the response has an error              | {"data": {"error": {"message": "Error}}}
+```
+
 ### Creation
 
 ```gherkin

data/STEPS.md

@@ -139,6 +139,37 @@ Then more than two items have have the following    <N/A>
                                                       "application/json"
 ```
 
+### Error Handling
+
+Using the environment variable: `error_key` to represent the error resource
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+Then the response has one error:                    Then the JSON response should have "errors[0].code" of type
+    | attribute | type   | value   |                  string with value "ERR-BLA"
+    | code      | string | ERR-BLA |
+
+Then the response has one error with attributes:    Then the JSON response should have "errors[0].code" of type
+    | attribute | type   | value   |                  string with value "ERR-BLA"
+    | code      | string | ERR-BLA |
+
+Then the response has at least one error           Then the JSON response should have "errors" of type array
+                                                     with at least 1 entry
+
+Then the response has an error                      Then the JSON response should have required key "error" of
+Then the response contains an error                   type object
+
+Then the response has two errors with:
+    | attribute | type   | value       |
+    | message   | string | super error |
+
+Then the response has three errors with two links   <N/A>
+  with:
+    | attribute | type   | value       |
+    | href      | string | http://oops |
+```
+
 ### Attribute saving and re-use
 
 ```
@@ -155,7 +186,7 @@ Behavioural                                         Functional
 --------------------------------------------------- --------------------------------------------------------------
 When I request a list of comments for post "1"      When I send a GET request to "http://url/posts/1/comments"
 
-When I request the comment "2" for post "3"         When I send a GET request to "http://url/posts/2/comments/3"
+When I request the comment "2" for post "3"         When I send a GET request to "http://url/posts/3/comments/2"
 
 When I request the photo "3" in album "4" for user  When I send a GET request to
   "5"                                                 "http://url/users/5/albums/4/photos/3"

data/cucumber-rest-bdd.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'cucumber-rest-bdd'
-  s.version       = '0.4.4'
+  s.version       = '0.5.1'
   s.version       = "#{s.version}-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS'] && ENV['TRAVIS_TAG'] == ''
   s.platform      = Gem::Platform::RUBY
   s.date          = '2017-01-10'

data/docker-compose.yml

@@ -2,7 +2,7 @@ version: '2'
 services:
     test-server:
         image: clue/json-server
-        command: --routes /data/routes.json
+        command: --routes /data/routes.json --middlewares /data/error.js
         volumes:
             - ./server:/data:ro
 
@@ -19,4 +19,5 @@ services:
             - field_camel=true
             - resource_single=false
             - data_key=
+            - error_key=error
             - set_parent_id=true

data/features/errors.feature

@@ -0,0 +1,22 @@
+Feature: Handling error responses
+
+    Background:
+        Given I am a client
+
+    Scenario: Handle errors as a list
+        When I request the error "list"
+        Then the request fails because the post was not found
+        And the response contains at least one errors
+        And the response has one error
+        And the response has one error with the attributes:
+            | attribute   | type    | value     |
+            | Message     | string  | Not Found |
+
+    Scenario: Handle error as a single item
+        When I request the error "single"
+        Then the request fails because it was invalid
+        And the response contains an error
+        And the response has an error
+        And the response has an error with the attributes:
+            | attribute   | type    | value       |
+            | Message     | string  | Bad Request |

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

@@ -4,11 +4,11 @@ require 'cucumber-rest-bdd/types'
 # response interrogation
 
 Then(/^the response is a list (?:of|containing) (#{FEWER_MORE_THAN})?\s*(#{CAPTURE_INT}|\d+) .*?$/) do |count_mod, count|
-    list = @response.get_as_type get_root_json_path(), 'array'
-    raise %/Expected at least #{count} items in array for path '#{get_root_json_path()}', found: #{list.count}\n#{@response.to_json_s}/ if !num_compare(count_mod, list.count, count.to_i)
+    list = @response.get_as_type get_root_data_key(), 'array'
+    raise %/Expected at least #{count} items in array for path '#{get_root_data_key()}', found: #{list.count}\n#{@response.to_json_s}/ if !num_compare(count_mod, list.count, count.to_i)
 end
 
-Then(/^the response ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{CAPTURE_INT}|\d+)) (?:\w+) )*)#{HAVE_SYNONYM} (?:the )?(?:following )?(?:data )?attributes:$/) do |nesting, attributes|
+Then(/^the response ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{CAPTURE_INT}|\d+)) (?:\w+) )*)#{HAVE_SYNONYM} (?:the )?(?:following )?(?:data|error )?attributes:$/) do |nesting, attributes|
     expected = get_attributes(attributes.hashes)
     groups = nesting
     grouping = get_grouping(groups)
@@ -16,8 +16,8 @@ Then(/^the response ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{C
         root: true,
         type: 'single'
     })
-    data = @response.get get_root_json_path()
-    raise %/Could not find a match for: #{nesting}\n#{expected.inspect}\n#{@response.to_json_s}/ if !nest_match(data, grouping, expected)
+    data = @response.get get_key(grouping)
+    raise %/Could not find a match for: #{nesting}\n#{expected.inspect}\n#{@response.to_json_s}/ if data.empty? || !nest_match(data, grouping, expected)
 end
 
 Then(/^the response ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{CAPTURE_INT}|\d+)) (?:\w+)\s?)+)$/) do |nesting|
@@ -27,8 +27,8 @@ Then(/^the response ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{C
         root: true,
         type: 'single'
     })
-    data = @response.get get_root_json_path()
-    raise %/Could not find a match for: #{nesting}\n#{@response.to_json_s}/ if !nest_match(data, grouping, {})
+    data = @response.get get_key(grouping)
+    raise %/Could not find a match for: #{nesting}\n#{@response.to_json_s}/ if data.empty? || !nest_match(data, grouping, {})
 end
 
 Then(/^(#{FEWER_MORE_THAN})?\s*(#{CAPTURE_INT}|\d+) (?:.*?) ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{CAPTURE_INT}|\d+)) (?:\w+) )*)#{HAVE_SYNONYM} (?:the )?(?:following )?(?:data )?attributes:$/) do |count_mod, count, nesting, attributes|
@@ -41,7 +41,7 @@ Then(/^(#{FEWER_MORE_THAN})?\s*(#{CAPTURE_INT}|\d+) (?:.*?) ((?:#{HAVE_SYNONYM}
         count: count.to_i,
         count_mod: count_mod
     })
-    data = @response.get get_root_json_path()
+    data = @response.get get_key(grouping)
     raise %/Expected #{compare_to_string(count_mod)}#{count} items in array with attributes for: #{nesting}\n#{expected.inspect}\n#{@response.to_json_s}/ if !nest_match(data, grouping, expected)
 end
 
@@ -54,7 +54,7 @@ Then(/^(#{FEWER_MORE_THAN})?\s*(#{CAPTURE_INT}|\d+) (?:.*?) ((?:#{HAVE_SYNONYM}
         count: count.to_i,
         count_mod: count_mod
     })
-    data = @response.get get_root_json_path()
+    data = @response.get get_key(grouping)
     raise %/Expected #{compare_to_string(count_mod)}#{count} items in array with: #{nesting}\n#{@response.to_json_s}/ if !nest_match(data, grouping, {})
 end
 
@@ -74,7 +74,7 @@ Then(/^the response ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{C
         root: true,
         type: 'single'
     })
-    data = @response.get get_root_json_path()
+    data = @response.get get_key(grouping)
     raise %/Could not find a match for #{nesting}#{compare_to_string(num_mod)}#{num} #{item}\n#{@response.to_json_s}/ if !nest_match(data, grouping, {})
 end
 
@@ -96,10 +96,19 @@ Then(/^(#{FEWER_MORE_THAN})?\s*(#{CAPTURE_INT}|\d+) (?:.*?) ((?:#{HAVE_SYNONYM}
         count: count.to_i,
         count_mod: count_mod
     })
-    data = @response.get get_root_json_path()
+    data = @response.get get_key(grouping)
     raise %/Expected #{compare_to_string(count_mod)}#{count} items with #{nesting}#{compare_to_string(num_mod)}#{num}#{item}\n#{@response.to_json_s}/ if !nest_match(data, grouping, {})
 end
 
+# gets the relevant key for the response based on the first key element
+def get_key(grouping)
+    if ENV['error_key'] && !ENV['error_key'].empty? && grouping.count > 1 && grouping[-2][:key] == ENV['error_key'] then
+        get_root_error_key()
+    else
+        get_root_data_key()
+    end
+end
+
 # gets an array in the nesting format that nest_match understands to interrogate nested object and array data
 def get_grouping(nesting)
     grouping = []
@@ -131,6 +140,7 @@ end
 #
 # returns true if the expected data is contained within the data based on the nesting information
 def nest_match(data, nesting, expected)
+    return false if !data
     return data.deep_include?(expected) if nesting.size == 0
 
     local_nesting = nesting.dup

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

@@ -102,12 +102,16 @@ def get_resource(name)
     resource = (ENV.has_key?('resource_single') && ENV['resource_single'] == 'true') ? resource.singularize : resource.pluralize
 end
 
-def get_root_json_path()
+def get_root_data_key()
     return ENV.has_key?('data_key') && !ENV['data_key'].empty? ? "$.#{ENV['data_key']}." : "$."
 end
 
+def get_root_error_key()
+    return "$."
+end
+
 def get_json_path(names)
-    return "#{get_root_json_path()}#{get_parameters(names).join('.')}"
+    return "#{get_root_data_key()}#{get_parameters(names).join('.')}"
 end
 
 def get_parameters(names)
@@ -119,7 +123,7 @@ def get_parameter(name)
         name = name[1..-2]
     else
         separator = ENV.has_key?('field_separator') ? ENV['field_separator'] : '_'
-        name = name.parameterize(separator: separator)
+        name = name.singularize.parameterize(separator: separator)
         name = name.camelize(:lower) if (ENV.has_key?('field_camel') && ENV['field_camel'] == 'true')
     end
     name

data/server/error.js

@@ -0,0 +1,14 @@
+module.exports = (req, res, next) => {
+    if (req.path == '/errors/list') {
+        res.status(404)
+        res.locals.data = {
+            errors: [{ message: 'Not Found' }]
+        }
+    } else if (req.path == '/errors/single') {
+        res.status(400)
+        res.locals.data = {
+            error: { message: 'Bad Request' }
+        }
+    }
+    next()
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-rest-bdd
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.1.pre.140
 platform: ruby
 authors:
 - Harry Bragg
@@ -68,6 +68,7 @@ files:
 - STEPS.md
 - cucumber-rest-bdd.gemspec
 - docker-compose.yml
+- features/errors.feature
 - features/functional.feature
 - features/grabs.feature
 - features/headers.feature
@@ -88,6 +89,7 @@ files:
 - lib/cucumber-rest-bdd/types.rb
 - lib/cucumber-rest-bdd/url.rb
 - server/db.json
+- server/error.js
 - server/routes.json
 homepage: http://github.com/graze/cucumber-rest-bdd
 licenses:
@@ -104,12 +106,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: BDD Rest API specifics for cucumber