cucumber-rest-bdd 0.3.4.pre.alpha.pre.86

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 354ca6b1520bfe6005fb8021e4a392b6c5e98f5c
+  data.tar.gz: 5d5e38d996f3d5766b641e1a9b1cb41db0c2edae
+SHA512:
+  metadata.gz: 7f3d861a146be7a1365d626948b92d922a55b64dc1bd767921446c06541f51fd71ea53844f1dba5f95515561bca5d2f82cfbcfadcdf254deab2a65362546e1b5
+  data.tar.gz: 7b0c99880dff53a71d2df02542f813cfd583ef31c08a2b91063283a650abcd03b1775d17d14fbd55e4be5a1e78ecb8313eedd65c69f6ea53bd989e9d2791024c

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,15 @@
+language: shell
+sudo: required
+services:
+- docker
+install:
+- make build
+script:
+- make test
+deploy:
+  provider: rubygems
+  api_key:
+    secure: obDis+hzVaV8Dk0i2V9bd3QiFhjdEpMZ6SxmTWDnbLcnYuhJyY7VPO3Jk9hINAWZPxH//uByVT+5p2r3YpmKUQxxoMtqJ7R8+aybfvlrDC9ZNoyE6lYF/Ysnj03pXMA5qwfqXt5ZVZuMvqAUj8J3sQBRSFwq7f/tlsAQdG1nowPL9lkxqOE++z+WvMvzkTs4x2RosrBg81eFNiCe0XKUXQGFbIneUA34Xjf/Mg+dls0UckyKBJO/3yoq3aCjYAaMGeA0UtfXwVqBdv7xhv8edzuJwbwrnstgQmwk6pR6XVIPff8wqHvRMHRXcFlPvRYv9WW4/CIxi6nvdpSlgeVXs9q1I22Z7f5sJy0As41wLoG95NVokqb2tFRz7ZwZU6tFNsJvK2tO8Bas0Gx6KTTThb2NTNdWQFczYBI/ERtYUB9qVRVlPDsK+iLRmFLi71H50aSbwnuXGEAfinXRmXvpLgPe1ZMYxMq+uz/ETBpCBfD26FQm3ieXIEb92GG7eswbIyv/LktCglEhNXR6FImqf1Ni2OOSXskJH+DTGnOkDHVFq5AhGQ8MtvJdsnJdm4p3PKzddzMPJ58cTwDOEd4uq7uNR/PGtE1w5FE3FNVIXr5ny1f9CpDwMpLL9xQ/AbgV9bJxBzqseBvXhn3HondJyZld1rfiUopvz/XGrydRvAo=
+  gem: cucumber-rest-bdd
+  on:
+    repo: graze/cucumber-rest-bdd

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby
+
+MAINTAINER "Harry Bragg <harry.bragg@graze.com>"
+LABEL version="0.3.4" \
+      license="MIT"
+
+RUN gem install cucumber-rest-bdd
+
+WORKDIR /opt/src
+
+ENV field_separator=_
+ENV field_camel=false
+ENV resource_single=false
+ENV cucumber_api_verbose=false
+ENV data_key=
+
+CMD ["cucumber"]

data/Dockerfile.dev

@@ -0,0 +1,22 @@
+FROM ruby
+
+MAINTAINER "Harry Bragg <harry.bragg@graze.com>"
+LABEL version="0.3.4" \
+      license="MIT"
+
+COPY . /usr/local/cucumber-rest-bdd
+WORKDIR /usr/local/cucumber-rest-bdd
+
+RUN gem build cucumber-rest-bdd.gemspec \
+    && gem install cucumber-rest-bdd-*.gem \
+    && rm -rf /usr/local/cucumber-rest-bdd
+
+WORKDIR /opt/src
+
+ENV field_separator=_
+ENV field_camel=false
+ENV resource_single=false
+ENV cucumber_api_verbose=false
+ENV data_key=
+
+CMD ["cucumber"]

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 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
+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/Makefile

@@ -0,0 +1,15 @@
+TAG := graze/cucumber-rest-bdd
+RUN := docker run --rm -it -v $(PWD):/opt/src -w /opt/src ${TAG}
+
+build:
+	docker-compose build runner
+
+test: start-test-server
+	docker-compose run --rm runner cucumber --order random
+	make stop-test-server > /dev/null 2>&1 &
+
+start-test-server: stop-test-server
+	docker-compose up -d test-server
+
+stop-test-server:
+	docker-compose stop test-server

data/README.md

@@ -0,0 +1,267 @@
+# Cucumber Rest BDD
+
+[![Build Status](https://travis-ci.org/graze/cucumber-rest-bdd.svg?branch=master)](https://travis-ci.org/graze/cucumber-rest-bdd)
+[![](https://images.microbadger.com/badges/image/graze/cucumber-rest-bdd.svg)](https://microbadger.com/images/graze/cucumber-rest-bdd "Get your own image badge on microbadger.com")
+[![](https://images.microbadger.com/badges/version/graze/cucumber-rest-bdd.svg)](https://microbadger.com/images/graze/cucumber-rest-bdd "Get your own version badge on microbadger.com")
+[![](https://images.microbadger.com/badges/license/graze/cucumber-rest-bdd.svg)](https://microbadger.com/images/graze/cucumber-rest-bdd "Get your own license badge on microbadger.com")
+
+A set of Behavioural tests that can be run against a REST API.
+
+![Giphy](https://media3.giphy.com/media/Tv7VPg6Os488g/giphy.gif)
+
+This is based from: http://gregbee.ch/blog/effective-api-testing-with-cucumber
+
+A list of [Steps](STEPS.md) shows the comparison between Behavioural and Functional tests provided by this package.
+
+## Configuration
+
+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)
+- `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`)
+
+## Examples
+
+- For a full list of steps see: [STEPS](STEPS.md)
+- These examples are taken from the test [features](features)
+
+### Retrieve items
+
+```gherkin
+Given I am a client
+When I request the post "1"
+Then the request was successful
+And the response has the following attributes:
+    | attribute | type    | value |
+    | User Id   | numeric | 1     |
+    | Id        | numeric | 1     |
+    | Title     | string  | sunt aut facere repellat provident occaecati excepturi optio reprehenderit |
+    | Body      | string  | quia et suscipit\\nsuscipit recusandae consequuntur expedita et cum\\nreprehenderit molestiae ut ut quas totam\\nnostrum rerum est autem sunt rem eveniet architecto |
+```
+
+```gherkin
+Given I am a client
+When I request a list of posts with:
+    | User Id | 2 |
+Then the request is successful
+And the response is a list of at least 2 posts
+And one response has the following attributes:
+    | attribute | type    | value |
+    | User Id   | numeric | 2     |
+    | Id        | numeric | 11    |
+    | Title     | string  | et ea vero quia laudantium autem |
+    | Body      | string  | delectus reiciendis molestiae occaecati non minima eveniet qui voluptatibus\\naccusamus in eum beatae sit\\nvel qui neque voluptates ut commodi qui incidunt\nut animi commodi |
+```
+
+You can inspect child objects by using `:` in between the names
+
+```gherkin
+Given I am a client
+When I request the comment "1" with:
+    | `_expand` | post |
+Then the response has the following attributes:
+    | attribute    | type   | value |
+    | name         | string | id labore ex et quam laborum |
+    | email        | string | Eliseo@gardner.biz |
+    | body         | string | laudantium enim quasi est quidem magnam voluptate ipsam eos\\ntempora quo necessitatibus\\ndolor quam autem quasi\\nreiciendis et nam sapiente accusantium |
+    | post : title | string | sunt aut facere repellat provident occaecati excepturi optio reprehenderit |
+    | post : body  | string | quia et suscipit\\nsuscipit recusandae consequuntur expedita et cum\\nreprehenderit molestiae ut ut quas totam\\nnostrum rerum est autem sunt rem eveniet architecto |
+```
+
+Alternatively you can inspect child arrays and objects by describing the path of the object with attributes
+
+```gherkin
+Given I am a client
+When I set JSON request body to:
+    """
+    {"title":"test","body":"multiple",
+    "comments":[
+        {"common":1,"id":1,"title":"fish","body":"cake","image":{"href":"some_url"}},
+        {"common":1,"id":2,"title":"foo","body":"bar","image":{"href":"some_url"}}
+    ]}
+    """
+And I send a POST request to "http://test-server/posts"
+Then the response has the attributes:
+    | attribute | type   | value    |
+    | title     | string | test     |
+    | body      | string | multiple |
+And the response has a list of comments
+And the response has a list of 2 comments
+And the response has two comments with attributes:
+    | attribute | type    | value |
+    | common    | integer | 1     |
+And the response has two comments with an image with attributes:
+    | attribute | type    | value    |
+    | href      | string  | some_url |
+And the response has one comment with attributes:
+    | attribute | type    | value |
+    | Id        | integer | 1     |
+    | Title     | string  | fish  |
+    | Body      | string  | cake  |
+And the response has one comment with attributes:
+    | attribute | type    | value |
+    | Id        | integer | 2     |
+    | Title     | string  | foo   |
+    | Body      | string  | bar   |
+```
+
+Each numeric request can be prefixed with a modifier to modify the number specified
+
+```gherkin
+Given I am a client
+When I request a list of posts with:
+    | `_embed` | comments |
+Then the response is a list of posts
+Then the response is a list of more than 5 posts
+Then the response is a list of at least 10 posts
+Then more than three posts have the attributes:
+    | attribute | type    | value |
+    | User Id   | integer | 5     |
+Then less than 200 posts have more than four comments
+Then more than 50 posts have less than six comments
+Then more than 80 posts have a list of comments
+Then at least 90 posts have a list of five comments
+Then more than 10 posts have five comments
+Then less than 200 posts have five comments
+```
+
+### Creation
+
+```gherkin
+Given I am a client
+When I request to create a post with:
+    | attribute | type    | value |
+    | Title     | string  | foo   |
+    | Body      | string  | bar   |
+    | User Id   | numeric | 1     |
+Then the request is successful and a post was created
+And the response has the following attributes:
+    | attribute | type    | value |
+    | User Id   | numeric | 1     |
+    | Title     | string  | foo   |
+    | Body      | string  | bar   |
+```
+
+### Removal
+
+```gherkin
+Given I am a client
+When I request to remove the post "20"
+Then the request is successful
+```
+
+### Modification
+
+```gherkin
+Given I am a client
+When I request to modify the post "21" with:
+    | attribute | type    | value |
+    | Title     | string  | foo   |
+Then the request is successful
+And the response has the following attributes:
+    | attribute | type    | value |
+    | User Id   | numeric | 3     |
+    | Title     | string  | foo   |
+    | Body      | string  | repellat aliquid praesentium dolorem quo\\nsed totam minus non itaque\\nnihil labore molestiae sunt dolor eveniet hic recusandae veniam\\ntempora et tenetur expedita sunt |
+```
+
+### Multiple Requests
+
+```gherkin
+Given I am a client
+When I request to create a post with:
+    | attribute | type    | value |
+    | Title     | string  | foo   |
+    | Body      | string  | bar   |
+    | User Id   | integer | 12    |
+Then the request is successful
+When I save "id"
+And I request the post "{id}"
+Then the request is successful
+And the response has the following attributes:
+    | attribute | type    | value |
+    | Title     | string  | foo   |
+    | Body      | string  | bar   |
+    | User Id   | numeric | 12    |
+    | Id        | numeric | {id}  |
+```
+
+## Resources
+
+A resource "name" is attempted to be retrieved from the given name of the item to be retrieved. This pluralises, ensures everything is lower case, removes any unparameterisable characters and uses a `-` separator.
+
+```
+Token -> tokens
+User -> users
+Big Life -> big-lifes
+octopus -> octopi
+```
+
+If the environment variable: `resource_single` is set to `true` then it will not attempt to pluralise the resources.
+
+```
+Token -> token
+User -> user
+```
+
+You can directly pass what you want using:
+```
+`field`
+```
+this will not modify the field.
+
+## Attributes
+
+### Types
+
+Attribute types:
+The following types are supported:
+
+| type    | other names           | example   |
+|---------|-----------------------|-----------|
+| integer | numeric, number, long | 12        |
+| float   | double, decimal       | 4.8       |
+| string  | text                  | "text"    |
+| array   | array                 | ["a"]     |
+| object  | object                | {"a":"b"} |
+| null    | nil                   |           |
+| bool    | boolean               | true      |
+
+### Name conversion
+
+attributes are converted into singular parametrised versions of the provided name:
+
+The conversion is based on the provided environment variables `field_camel` and `field_separator`
+
+**Default**
+```
+field_camel=false
+field_separator=_
+
+Someid -> someid
+Product Id -> product_id
+Bodies -> body
+```
+
+**CamelCase**
+```
+field_camel=true
+field_separator=_
+
+Someid -> someid
+Product Id -> productId
+Bodies -> body
+```
+
+**Other separator**
+```
+field_camel=false
+field_separator=-
+
+Someid -> someid
+Product Id -> product-id
+Bodies -> body
+```

data/STEPS.md

@@ -0,0 +1,199 @@
+# Gherkin Steps
+
+This test suite introduces behavioural test steps on top of functional REST API steps from [cucumber-api](https://github.com/hidroh/cucumber-api)
+
+The following is a list of steps, and their equivalent functional step
+
+## Setup
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+Given I am a client                                 Given I send and accept JSON
+```
+
+## Retrieval
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+When I request an item "2"                          When I send a GET request to "http://url/items/2"
+
+When I request a list of items                      When I send a GET request to "http://url/items"
+
+When I request a list of items with:                When I send a GET request to "http://url/items" with:
+   | User Id | 12 |                                     | userId |
+                                                        | 12     |
+```
+
+## Creation
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+When I request to create an item                    When I send a POST request to "http://url/items"
+
+When I request to create an item with:              When I set JSON request body to:
+    | attribute | type    | value |                     """
+    | User Id   | integer | 12    |                     {"userId":12,"title":"foo"}
+    | Title     | string  | foo   |                     """
+                                                    And I send a POST request to "http://url/items"
+
+When I request to create an item with id "4"        When I send a PUT request to "http://url/items/4"
+
+When I request to replace the item "4" with:        When I set JSON request body to:
+    | attribute | type    | value |                     """
+    | User Id   | integer | 7     |                     {"userId":7,"title":"foo"}
+    | Title     | string  | foo   |                     """
+                                                    And I send a PUT request to "http://url/items/4"
+```
+
+## Modification
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+When I request to modify the item "4" with:         When I set JSON request body to:
+    | attribute | type    | value |                     """
+    | Body      | string  | bar   |                     {"body":"bar"}
+                                                        """
+                                                    And I send a PATCH request to "http://url/items/4"
+```
+
+## Status Inspection
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+Then the request is successful                      Then the response status should be "200"
+
+Then the request was redirected                     <N/A> (response status between "300" and "400")
+
+Then the request failed                             <N/A> (response status between "400" and "600")
+
+Then the request was successful and an item was     Then the response status should be "201"
+  created
+
+Then the request was successfully accepted          Then the response status should be "202"
+
+Then the request was successful and no response     Then the response status should be "204"
+  body is returned
+
+Then the request failed because it was invalid      Then the response status should be "400"
+
+Then the request failed because I am unauthorised   Then the response status should be "401"
+
+Then the request failed because it was forbidden    Then the response status should be "403"
+
+Then the request failed because the item was not    Then the response status should be "404"
+  found  
+
+Then the request failed because it was not allowed  Then the response status should be "405"
+
+Then the request failed because there was a         Then the response status should be "409"
+  conflict    
+
+Then the request failed because the item has gone   Then the response status should be "410"
+
+Then the request failed because it was not          Then the response status should be "501"
+  implemented
+```
+
+## Response Inspection
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+Then the response has the following attributes:     Then the JSON response should have "userId" of type numeric
+    | attribute | type    | value |                   with value "12"
+    | User Id   | integer | 12    |                 Then the JSON response should have "title" of type numeric
+    | Title     | string  | foo   |                   with value "foo"
+    | Body      | string  | bar   |                 Then the JSON response should have "body" of type numeric with
+                                                      value "bar"
+
+Then the response is a list of 12 items             Then the JSON response should have "$." of type array with 12
+                                                      entries
+
+Then the response is a list of at least 12 items    Then the JSON response should have "$." of type array with at
+                                                      least 12 entries
+Then the response is a list of at most 12 items     <N/A>
+Then the response is a list of fewer than 12 items  <N/A>
+Then the response is a list of more than 12 items   <N/A>
+
+Then two items have have the following attributes:  <N/A>
+    | attribute | type    | value |
+    | User Id   | integer | 12    |
+    | Title     | string  | foo   |
+    | Body      | string  | bar   |
+
+Then more than two items have have the following    <N/A>
+    attributes:
+    | attribute | type    | value |
+    | User Id   | integer | 12    |
+    | Title     | string  | foo   |
+    | Body      | string  | bar   |
+
+<N/A>                                               Then the JSON response should follow "schema.json"
+
+<N/A>                                               Then the response has the header "Content Type" with value
+                                                      "application/json"
+```
+
+### Attribute saving and re-use
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+When I save "User Id" as "user"                     When I grab "$.userId" as "user"
+And I request the user "{user}"                     And I send a GET request to "http://url/users/{user}"
+```
+
+### Nested responses
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+Then the response has the following attributes:     Then the JSON response should have "userId" of type numeric
+    | attribute    | type    | value |                with value "12"
+    | User Id      | integer | 12    |              Then the JSON response should have "title" of type numeric
+    | Title        | string  | foo   |                with value "foo"
+    | Body         | string  | bar   |              Then the JSON response should have "body" of type numeric with
+    | Post : Title | string  | baz   |                value "bar"
+    | Post : Body  | string  | boo   |              Then the JSON response should have "post.title" of type string
+                                                      with value "baz"
+                                                    Then the JSON response should have "post.body" of type string
+                                                      with value "boo"
+
+Then the response has a list of comments            Then the JSON response should have "comments" of type array
+
+Then the response has a list of 2 comments          Then the JSON response should have "comments" of type array with
+                                                      2 entries
+Then the response has a list of at least            Then the JSON response should have "comments" of type array with
+  2 comments                                          at least 2 entries
+
+Then the response has a post with two comments      <N/A>
+  with attributes:
+    | attribute | type   | value |
+    | Title     | string | foo   |
+    | Body      | string | bar   |
+
+Then two items contains two posts with three        <N/A>
+  comments with an image with attributes:
+    | attribute | type   | value    |
+    | Href      | string | some_url |
+
+Then more than two items contains fewer than two    <N/A>
+  posts with at least three comments with an
+  image with attributes:
+    | attribute | type   | value    |
+    | Href      | string | some_url |
+
+Then the response has a post with a list of         Then the JSON response should have "post.comments" of type array
+  comments
+
+Then the response has a post with a list of more    Then the JSON response should have "post.comments" of type array
+  than 3 comments                                     with at least 4 comments
+
+Then more than three posts have less than two       <N/A>
+  comments
+```

data/cucumber-rest-bdd.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name          = 'cucumber-rest-bdd'
+  s.version       = '0.3.4'
+  s.version       = "#{s.version}-alpha-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS'] && ENV['TRAVIS_TAG'] == ''
+  s.platform      = Gem::Platform::RUBY
+  s.date          = '2017-01-10'
+  s.summary       = 'BDD Rest API specifics for cucumber'
+  s.description   = 'Series of BDD cucumber rules for testing API endpoints'
+  s.authors       = ["Harry Bragg"]
+  s.email         = ["harry.bragg@graze.com"]
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.homepage      = 'http://github.com/graze/cucumber-rest-bdd'
+  s.license       = 'MIT'
+
+  s.add_dependency('cucumber-api', '~> 0.4')
+  s.add_dependency('activesupport', '~> 5.0')
+  s.add_dependency('easy_diff', '~> 1.0')
+end

data/docker-compose.yml

@@ -0,0 +1,22 @@
+version: '2'
+services:
+    test-server:
+        image: clue/json-server
+        volumes:
+            - ./server/db.json:/data/db.json:ro
+
+    runner:
+        image: graze/cucumber-rest-bdd
+        build:
+            context: .
+            dockerfile: Dockerfile.dev
+        volumes:
+            - .:/opt/src
+        working_dir: /opt/src
+        environment:
+            - endpoint=http://test-server/
+            - cucumber_api_verbose=false
+            - field_separator=_
+            - field_camel=true
+            - resource_single=false
+            - data_key=