rest-assured 0.2.0.rc8 → 0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rest-assured (0.2.0.rc7)
+    rest-assured (0.2.0)
       activerecord (~> 3.1.0)
       activeresource (~> 3.1.0)
       haml (>= 3.1.3)
@@ -113,7 +113,7 @@ GEM
     term-ansicolor (1.0.7)
     thor (0.14.6)
     tilt (1.3.3)
-    tzinfo (0.3.30)
+    tzinfo (0.3.31)
     xpath (0.1.4)
       nokogiri (~> 1.3)
 

data/LICENSE

@@ -1,22 +1,7 @@
-Copyright (c) 2011, Artem Avetisyan, British Broadcasting Corporation
+Copyright 2010 British Broadcasting Corporation
 
-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:
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+http://www.apache.org/licenses/LICENSE-2.0
 
-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.
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/README.markdown

@@ -2,82 +2,169 @@
 
 ## Overview
 
-A tool for stubbing/mocking external http based services that app under test is talking to. This is useful for blackbox testing or in cases where it is not possible to access application objects directly from test code.
+A tool for stubbing/mocking external http based services that your app under test interacts with. This is useful for blackbox/integration testing.
 There are three main use cases:
 
-* stubbing out external data sources with predefined data, so that test code has known data to assert against
-* setting expectations on messages to external services (currently not yet implemented)
-* mimic different responses from external services during development. For that purpose there is web UI
+* stubbing out external data sources with predefined data
+* verify requests to external services
+* quickly emulate different behavior of external services during development (using web UI)
 
 ## Usage
 
-You are going to need ruby >= 1.8.7. Install gem and run:
+You are going to need ruby >= 1.8.7.
 
-    bash$ sudo gem install rest-assured # omit sudo if using rvm
-    bash$ rest-assured &
+First make sure there is database adapter:
+
+    bash$ gem install mysql # or sqlite
+
+If using mysql, rest-assured expects database 'rest\_assured' to be accessible by user 'root' with no password. Those are defaults and are changeable with command line options.
+
+Then install gem and run:
+
+    bash$ gem install rest-assured
+    bash$ rest-assured -a mysql &
 
 Or clone from github and run:
 
     bash$ git clone git@github.com:BBC/rest-assured.git
-    bash$ cd rest-assured && bundle install # `gem install bundler` if command not found
-    bash$ ./bin/rest-assured &
+    bash$ cd rest-assured && bundle install
+    bash$ ./bin/rest-assured -a mysql &
+
+This starts an instance of rest-assured on port 4578 (changable with --port option). You can now access it via REST or web interfaces on 'http://localhost:4578'
 
-This starts an instance of rest-assured on port 4578 (changable with --port option) and creates rest-assured.db (changable with --database option) in the current directory. You can now access it via REST or web interfaces on http://localhost:4578
+Various options (such as ssl, port, db credentials, etc.) are available through command line options. Check out `rest-assured -h` to see what they are.
+
+NOTE that although sqlite is an option, I found it locking under any non-trivial load. Mysql feels much more reliable. But may be that is me sqliting it wrong.
+
+## REST API
 
 ### Doubles
 
-Double is a stub/mock of a particular external call. There is the following rest API for setting up doubles:
+Double is a stub/mock of a particular external call.
+
+#### Ruby Client API
+
+Rest-assured provides client library which partially implements ActiveResource (create and get). To make it available put the following in your test setup code (e.g. env.rb)
+
+```ruby
+require 'rest-assured/client'
+
+RestAssured::Client.config.server_address = 'http://localhost:4578' # or wherever your rest-assured is
+```
+
+You can then create doubles in your tests
+
+```ruby
+RestAssured::Double.create(fullpath: '/products', content: 'this is content')
+```
+
+Or, in case you need verifications, create double in a Given part
+
+```ruby
+@double = RestAssured::Double.create(fullpath: '/products', verb: 'POST')
+```
+
+And verify requests happened on that double in a Then part
+
+```ruby
+@double.wait_for_requests(1, :timeout => 10) # default timeout 5 seconds
+
+req = @double.requests.first
 
-* `POST '/doubles', { fullpath: path, content: content, verb: verb }`
-  Creates double with the following parameters:
+req.body.should == expected_payload
+JSON.parse(req.params).should == expected_params_hash
+JSON.parse(req.rack_env)['ACCEPT'].should == 'Application/json'
+```
 
-  - __fullpath__ - e.g., `/some/api/object`, or with parameters in query string (useful for doubling GETs) - `/some/other/api/object?a=2&b=c`. Mandatory.
-  - __content__ - whatever you want this double to respond with. Mandatory.
+#### Plain REST API
+
+##### Create double 
+  HTTP POST to '/doubles.json' creates double and returns its json representation.
+  The following options can be passed as request parameters:
+
+  - __fullpath__ - e.g., '/some/api/object', or with parameters in query string (useful for doubling GETs) - '/some/other/api/object?a=2&b=c'. Mandatory.
+  - __content__ - whatever you want this double to respond with. Optional.
   - __verb__ - one of http the following http verbs: GET, POST, PUT, DELETE. Optional. GET is default.
+  - __status__ - status returned when double is requested. Optional. 200 is default.
 
   Example (using ruby RestClient):
   
-    RestClient.post 'http://localhost:4578/doubles', { fullpath: '/api/v2/products?type=fresh', verb: 'GET', content: 'this is list of products' }
+```ruby
+response = RestClient.post 'http://localhost:4578/doubles', { fullpath: '/api/v2/products?type=fresh', verb: 'GET', content: 'this is list of products', status: 200 }
+puts response.body
+```
+  Produces:
+
+    "{\"double\":{\"fullpath\":\"/api/v2/products?type=fresh\",\"verb\":\"GET\",\"id\":123,\"content\":\"this is list of products\",\"description\":null,\"status\":null,\"active\":true}}"
 
-  Now GETting http://localhost:4578/api/v2/products?type=fresh (in browser for instance) should return "this is list of products".
+  And then GETting 'http://localhost:4578/api/v2/products?type=fresh' (in browser for instance) should return "this is list of products".
 
-  If there is more than one double for the same request\_fullpath and verb, the last created one gets served. In UI you can manually control which double is 'active' (gets served).
+  If there is more than one double for the same fullpath and verb, the last created one gets served. In UI you can manually control which double is 'active' (gets served).
 
-* `DELETE '/doubles/all'`
-  Deletes all doubles.
+##### Get double state
+  HTTP GET to '/double/:id.json' returns json with double current state. Use id from create json as :id.
+
+  Example (using ruby RestClient):
+
+```ruby
+response = RestClient.get 'http://localhost:4578/doubles/123.json'
+puts response.body
+```
+
+  Assuming the above double has been requested once, this call would produce
+
+    "{\"double\":{\"fullpath\":\"/api/v2/products?type=fresh\",\"verb\":\"GET\",\"id\":123,\"requests\":[{\"rack_env\":\"LOOK FOR YOUR HEADERS HERE\",\"created_at\":\"2011-11-07T18:34:21+00:00\",\"body\":\"\",\"params\":\"{}\"}],\"content\":\"this is list of products\",\"description\":null,\"status\":null,\"active\":true}}"
+
+  The important bit here is 'requests' array. This is history of requests for that double (in chronological order). Each element contains the following data (keys):
+  
+  - __body__ - request payload
+  - __params__ - request parameters
+  - __created_at__ - request timestamp
+  - __rack_env__ - raw request dump (key value pairs). Including request headers
+
+##### Delete all doubles
+  HTTP DELETE to '/doubles/all' deletes all doubles. Useful for cleaning up between tests.
 
 ### Redirects
 
 It is sometimes desirable to only double certain calls while letting others through to the 'real' services. Meet Redirects. Kind of "rewrite rules" for requests that didn't match any double. Here is the rest API for managing redirects:
 
-* `POST '/redirects', { pattern: pattern, to: uri }` Creates redirect with the following parameters:
+#### Create redirect
+  HTTP POST to '/redirects' creates redirect.
+  The following options can be passed as request parameters:
 
   - __pattern__ - regex (perl5 style) tested against request fullpath. Mandatory
-  - __to__ - url base e.g., `https://myserver:8787/api`. Mandatory
+  - __to__ - url base e.g., 'https://myserver:8787/api'. Mandatory
 
   Example (using ruby RestClient):
 
-    RestClient.post 'http://localhost:4578/redirects', { pattern: '^/auth', to: 'https://myserver.com/api' }
+```ruby
+RestClient.post 'http://localhost:4578/redirects', { pattern: '^/auth', to: 'https://myserver.com/api' }
+```
 
-  Now request (any verb) to http://localhost:4578/auth/services/1 will get redirected to https://myserver.com/api/auth/services/1. Provided of course there is no double matched for that fullpath and verb.
+  Now request (any verb) to 'http://localhost:4578/auth/services/1' will get redirected to 'https://myserver.com/api/auth/services/1.' Provided of course there is no double matched for that fullpath and verb.
   Much like rewrite rules, redirects are evaluated in order (of creation). In UI you can manually rearrange the order.
 
-### Storage
-
-By default when you start rest-assured it creates (unless already exists) sqlite database and stores it into file in the current directory. This is good for using it for development - when you want doubles/redirects to persist across restarts - but may not be so desirable for using with tests, where you want each test run to start from blank slate. For that reason, you can specify `--database :memory:` so that database is kept in memory.
-
-### Logging
-
-It is sometimes useful to see what requests rest-assured is being hit. Either to explore what requests your app is making or to check that test setup is right and doubles indeed get returned. By default, when started, rest-assured creates log file in the current directory. This is configurable with `--logfile` option.
+#### Delete all redirects
+  HTTP DELETE to '/redirects/all' deletes all redirects. Useful for cleaning up between tests.
 
 ## TODO
 
-* Implement expectations
-* Support headers (extends previous point)
-* Ruby client library
-* Support verbs in UI (at the moment it is always GET)
-* Don't allow to double internal routes. Just in case
+* Hide wiring rest-assured into ruby project behind client api
+* Bring UI upto date with rest-api (add verbs, statuses, request history)
+* Add custom response headers
 
 ## Author
 
 [Artem Avetisyan](https://github.com/artemave)
+
+## Changelog
+
+0.2
+  - adds verifications
+  - adds ruby client
+  - adds custom return statuses
+  - adds ssl
+  - adds mysql support
+0.1 initial public release
+

data/bin/console

@@ -1,11 +1,10 @@
 #!/usr/bin/env ruby
 require "irb"
-require 'bundler/setup'
 
 $:.push File.expand_path('../../lib', __FILE__)
 
 require 'rest-assured/config'
-AppConfig[:database] = ENV['FRS_DB'] || File.expand_path('../../db/development.db', __FILE__)
+RestAssured::Config.build :database => ( ENV['FRS_DB'] || File.expand_path('../../db/development.db', __FILE__) )
 
 require 'rest-assured'
 

data/bin/rest-assured

@@ -51,6 +51,18 @@ OptionParser.new do |opts|
     user_opts[:logfile] = logfile
   end
 
+  opts.on('--ssl', "Whether or not to run on https. Defaults to false (http)") do |use_ssl|
+    user_opts[:use_ssl] = true
+  end
+
+  opts.on('-c', '--ssl_cert FILENAME', "Path to ssl_cert. Defaults to self signed certificate shipped with rest-assured") do |ssl_cert|
+    user_opts[:ssl_cert] = ssl_cert
+  end
+
+  opts.on('-k', '--ssl_key FILENAME', "Path to ssl_key. Defaults to key shipped with rest-assured") do |ssl_key|
+    user_opts[:ssl_key] = ssl_key
+  end
+
   opts.on_tail("--help", "Show this message") do
     puts opts
     exit

data/features/command_line_options.feature

@@ -33,7 +33,6 @@ Feature: command line options
       | -d /tmp/ratest.db        | /tmp/ratest.db    |
       | --database /tmp/resta.db | /tmp/resta.db     |
 
-  @now
   Scenario Outline: mysql options
     When I start rest-assured with -a mysql <options>
     Then database options should be:
@@ -53,3 +52,23 @@ Feature: command line options
       | --dbencoding utf16le       | rest_assured | root   |        |        |        | utf16le    |                 |
       | --dbsocket /tmp/mysql.sock | rest_assured | root   |        |        |        |            | /tmp/mysql.sock |
 
+  Scenario Outline: use ssl option
+    When I start rest-assured with <option>
+    Then rest-assured should "<use_ssl>"
+
+    Examples:
+      | option | use_ssl |
+      |        | false   |
+      | --ssl  | true    |
+
+  Scenario Outline: specifying ssl options 
+    When I start rest-assured with <option>
+    Then ssl certificate used should be "<ssl_cert>" and ssl key should be "<ssl_key>"
+
+    Examples:
+      | option                  | ssl_cert        | ssl_key        |
+      | -c /tmp/mycert.crt      | /tmp/mycert.crt | DEFAULT_KEY    |
+      | --ssl_cert ./mycert.crt | ./mycert.crt    | DEFAULT_KEY    |
+      |                         | DEFAULT_CERT    | DEFAULT_KEY    |
+      | -k /tmp/mykey.key       | DEFAULT_CERT    | /tmp/mykey.key |
+      | --ssl_key ./mykey.key   | DEFAULT_CERT    | ./mykey.key    |

data/features/{redirect_rules_via_api.feature → rest_api/redirects.feature}

@@ -3,27 +3,30 @@ Feature: manage redirect rules
   As a developer
   I want to redirect to real api if there are no doubles for requested fullpath
 
-  Background:
-    Given there are no redirect rules
-    And there are no doubles
-
   Scenario: no redirect rules
+    Given blank slate
     When I request "/api/something"
     Then I should get 404
 
   Scenario: add redirect rule
+    Given blank slate
     When I register redirect with pattern "^/api" and uri "http://real.api.co.uk"
     And I request "/api/something"
     Then it should redirect to "http://real.api.co.uk/api/something"
 
   Scenario: add second redirect that match the same request
-    When I register redirect with pattern "/api/something" and uri "http://real.api.co.uk"
-    And I register redirect with pattern "/api/some.*" and uri "http://real.com"
+    Given there is redirect with pattern "/api/something" and uri "http://real.api.co.uk"
+    When I register redirect with pattern "/api/some.*" and uri "http://real.com"
     And I request "/api/something"
     Then it should redirect to "http://real.api.co.uk/api/something"
 
   Scenario: add second redirect that does not match the same request
-    When I register redirect with pattern "/api/something" and uri "http://real.api.co.uk"
-    And I register redirect with pattern "/api/some" and uri "http://real.com"
+    Given there is redirect with pattern "/api/something" and uri "http://real.api.co.uk"
+    When I register redirect with pattern "/api/some" and uri "http://real.com"
     And I request "/api/someth"
     Then it should redirect to "http://real.com/api/someth"
+
+  Scenario: clear redirects
+    Given there are some redirects
+    When I delete all redirects
+    Then there should be no redirects

data/features/ruby_api/wait_for_requests.feature

@@ -0,0 +1,39 @@
+Feature: wait for requests on double to happen
+  In order to know when it is a good time to verify requests on a double
+  As test developer
+  I want to be able to wait until specified number of requests happen
+
+  Background:
+    Given I created a double:
+    """
+    @double = RestAssured::Double.create(:fullpath => '/some/api')
+    """
+
+  Scenario: succesfully wait for requests
+    When I wait for 3 requests:
+    """
+    @double.wait_for_requests(3)
+    """
+    And that double gets requested 3 times
+    Then it should let me through
+
+  Scenario: wait for requests that never come
+    When I wait for 3 requests:
+    """
+    @double.wait_for_requests(3)
+    """
+    And that double gets requested 2 times
+    Then it should wait for 5 seconds (default timeout)
+    And it should raise MoreRequestsExpected error after with the following message:
+    """
+    Expected 3 requests. Got 2.
+    """
+
+  @now
+  Scenario: custom timeout
+    When I wait for 3 requests:
+    """
+    @double.wait_for_requests(3, :timeout => 3)
+    """
+    And that double gets requested 2 times
+    Then it should wait for 3 seconds

data/features/step_definitions/command_line_options_steps.rb

@@ -33,3 +33,15 @@ Then /^database options should be:$/ do |table|
   @app_config[:db_config][:encoding].should == empty_to_nil[res['dbencoding']]
   @app_config[:db_config][:socket].should == empty_to_nil[res['dbsocket']]
 end
+
+Then /^ssl certificate used should be "([^"]*)" and ssl key should be "([^"]*)"$/ do |ssl_cert, ssl_key|
+  ssl_cert = File.expand_path('../../../ssl/localhost.crt', __FILE__) if ssl_cert == 'DEFAULT_CERT'
+  ssl_key = File.expand_path('../../../ssl/localhost.key', __FILE__) if ssl_key == 'DEFAULT_KEY'
+
+  @app_config[:ssl_cert].should == ssl_cert
+  @app_config[:ssl_key].should == ssl_key
+end
+
+Then /^rest\-assured should "([^"]*)"$/ do |use|
+  @app_config[:use_ssl].to_s.should == use
+end

data/features/step_definitions/doubles_steps.rb

@@ -1,7 +1,7 @@
 # REST api steps
 
 Given /^there are no doubles$/ do
-  Double.destroy_all
+  RestAssured::Models::Double.destroy_all
 end
 
 When /^I create a double with "([^"]*)" as fullpath and "([^"]*)" as response content$/ do |fullpath, content|
@@ -19,19 +19,19 @@ Then /^I should get (#{CAPTURE_A_NUMBER}) in response status$/ do |status|
 end
 
 Then /^there should be (#{CAPTURE_A_NUMBER}) double with "([^"]*)" as fullpath and "([^"]*)" as response content$/ do |n, fullpath, content|
-  Double.where(:fullpath => fullpath, :content => content).count.should == n
+  RestAssured::Models::Double.where(:fullpath => fullpath, :content => content).count.should == n
 end
 
 Then /^there should be (#{CAPTURE_A_NUMBER}) double with "([^""]*)" as fullpath, "([^""]*)" as response content, "([^""]*)" as request verb and status as "(#{CAPTURE_A_NUMBER})"$/ do |n, fullpath, content, verb, status|
-  Double.where(:fullpath => fullpath, :content => content, :verb => verb, :status => status).count.should == n
+  RestAssured::Models::Double.where(:fullpath => fullpath, :content => content, :verb => verb, :status => status).count.should == n
 end
 
 Given /^there is double with "([^"]*)" as fullpath and "([^"]*)" as response content$/ do |fullpath, content|
-  Double.create(:fullpath => fullpath, :content => content)
+  RestAssured::Models::Double.create(:fullpath => fullpath, :content => content)
 end
 
 Given /^there is double with "([^"]*)" as fullpath, "([^"]*)" as response content, "([^"]*)" as request verb and "([^"]*)" as status$/ do |fullpath, content, verb, status|
-  Double.create(:fullpath => fullpath, :content => content, :verb => verb, :status => status)
+  RestAssured::Models::Double.create(:fullpath => fullpath, :content => content, :verb => verb, :status => status)
 end
 
 Given /^I register "([^"]*)" as fullpath and "([^"]*)" as response content$/ do |fullpath, content|
@@ -54,7 +54,7 @@ end
 
 Given /^there are some doubles$/ do
   [['fullpath1', 'content1'], ['fullpath2', 'content2'], ['fullpath3', 'content3']].each do |double|
-    Double.create(:fullpath => double[0], :content => double[1])
+    RestAssured::Models::Double.create(:fullpath => double[0], :content => double[1])
   end
 end
 
@@ -64,14 +64,14 @@ When /^I delete all doubles$/ do
 end
 
 Then /^there should be no doubles$/ do
-  Double.count.should == 0
+  RestAssured::Models::Double.count.should == 0
 end
 
 # UI steps
 
 Given /^the following doubles exist:$/ do |doubles|
   doubles.hashes.each do |row|
-    Double.create(:fullpath => row['fullpath'], :description => row['description'], :content => row['content'])
+    RestAssured::Models::Double.create(:fullpath => row['fullpath'], :description => row['description'], :content => row['content'])
   end
 end
 
@@ -115,8 +115,8 @@ Then /^I should (not)? ?see "([^"]*)"$/ do |see, text|
 end
 
 Given /^there are two doubles for the same fullpath$/ do
-  @first = Double.create :fullpath => '/api/something', :content => 'some content'
-  @second = Double.create :fullpath => '/api/something', :content => 'other content'
+  @first = RestAssured::Models::Double.create :fullpath => '/api/something', :content => 'some content'
+  @second = RestAssured::Models::Double.create :fullpath => '/api/something', :content => 'other content'
 end
 
 When /^I make (first|second) double active$/ do |ord|