lookout-rack-test 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTEwMDdiNzc5NjU3NDJhYTU0NzUyNzhhNzkyNTBmNzM0OGRlYWRiOA==
+  data.tar.gz: !binary |-
+    ZmQxM2NlM2NhYmYwMDUyMzFlMzg0Yjk5MWIwY2E3NTE3N2I5YzUyOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTUxNzg0MWU5M2Q4ODFkNDg1OWIwZjBmMTdjMjU1NzczMmM5YjNlZjQzMTZi
+    MzBjNzRlNDIwYzc3YmNkMTFkNzhmN2YxZjRlMjk2MjZlNGE5MDZiNjE3MmY0
+    YzZhMjE3MjRmZDZmM2Y2NjYxMTBmNmIxYWMwMTlhODdkMmM2Y2M=
+  data.tar.gz: !binary |-
+    MTFjZjc2ZjVmNDFjMTVhM2UxYWU3YWZhZjkyYzI3YmUzY2VmYTliYTg4MjBk
+    YzkwNDNlYzBlNmFkZDY4YzQ4NWVjY2Q1OTJkN2EwZjU2YTViZTNhY2JiNDMx
+    NTA2MmU3N2NjMWI4YjM0ZThlOGNhODBmMTQyNzgwMjJmMzljMTg=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lookout-rack-test.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lookout, Inc
+
+MIT License
+
+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/README.md

@@ -0,0 +1,70 @@
+# Lookout::Rack::Test
+
+RSpec and Cucumber test helpers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lookout-rack-test'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lookout-rack-test
+
+## Usage
+
+`Lookout::Rack::Test` is intended to be consumed in pieces; it falls into three
+modules, `RSpec`, `Cucumber`, and `Rake`.
+
+### RSpec
+See examples in `spec/`.  `Lookout::Rack::Test::RSpec::FakeRequest` may also be
+helpful, if you want to test helper modules that are intended to be mixed into a
+route environment.
+
+```ruby
+  module Lookout::Rack::Test::RSpec
+    class FakeRequest
+      # Reopen the class to add a helper
+      include My::Helper
+    end
+  end
+
+  describe My::Helper do
+    let(:helper) { Lookout::Rack::Test::RSpec::FakeRequest.new }
+
+    # ... etc
+  end
+```
+
+### Cucumber
+See examples in `features/`.
+
+### Rake tasks
+  `require 'lookout/rack/test/rake' in your Rakefile to pick up the RSpec and
+Cucumber test tasks, namespaced under `:spec` and `:cucumber` respectively.
+
+Note that the `:cucumber` tasks require a `cucumber.yml`, e.g.: 
+
+```yml
+<%
+standard = "--expand -r features --format pretty --format junit --out features/reports"
+browser_opts = "--tags @selenium"
+%>
+
+default: <%= standard %> <%= browser_opts %> --tags ~@wip --tags ~@api
+wip: <%= standard %> --tags @wip
+api: <%= standard %> --tags @api --tags ~@wip
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'lookout/rack/test/rake'
+
+task :default => ['cucumber', 'spec']

data/cucumber.yml

@@ -0,0 +1,5 @@
+<%
+  standard = "--expand -r features --format pretty"
+%>
+
+default: <%= standard %>

data/examples/test_app.rb

@@ -0,0 +1,62 @@
+require 'sinatra'
+require 'json'
+
+class TestApp < Sinatra::Application
+  get '/' do
+    status 200
+  end
+
+  post '/' do
+    response = { 'some_param' => params['some_param'],
+                 'im_a_number' => params['im_a_number'] }
+    status 201
+
+    return response.to_json
+  end
+
+  put '/' do
+    response = { 'some_param' => params['some_param'],
+                 'im_a_number' => params['im_a_number'] }
+    status 202
+
+    return response.to_json
+  end
+
+  get '/json' do
+    return { 'key' => 1 }.to_json
+  end
+
+  post '/json' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+
+    status 201
+    return body.to_json
+  end
+
+  delete '/json' do
+    request.body.rewind
+    body = JSON.parse(request.body.read)
+
+    if body['some_key'] == 'some_value'
+      status 203
+    else
+      halt 400
+    end
+  end
+
+  get '/redirect' do
+    redirect to '/'
+  end
+
+  # For testing Timefreeze in Cukes
+  get '/time' do
+    time = Time.now.to_i
+
+    return { 'time' => time }.to_json
+  end
+
+  get '/route/:uri_var' do |uri_var|
+    return { 'variable' => uri_var }.to_json
+  end
+end

data/examples/test_models.rb

@@ -0,0 +1,15 @@
+module TestModels
+  @@setup = false
+
+  def self.setup
+    @@setup = true
+  end
+
+  def self.was_setup?
+    @@setup
+  end
+
+  def self.unsetup
+    @@setup = false
+  end
+end

data/features/general_steps/requests.feature

@@ -0,0 +1,13 @@
+Feature: Requests with no body or params
+
+  Scenario: I should be able to GET a route, and check the response status
+    When I GET "/"
+    Then the response should be 200
+
+  Scenario: I should be able to POST to a route, and check the response status
+    When I POST to "/"
+    Then the response should be 201
+
+  Scenario: I should be able to PUT to a route, and check the response status
+    When I PUT to "/"
+    Then the response should be 202

data/features/general_steps/requests_with_json_body.feature

@@ -0,0 +1,15 @@
+Feature: Requests with JSON body
+
+  Scenario: POST with JSON body
+    When I POST to "/json" with the JSON:
+    """
+      { "some_key" : "some_value" }
+    """
+    Then the response should be 201
+
+  Scenario: DELETE with JSON body
+    When I DELETE to "/json" with the JSON:
+    """
+      { "some_key" : "some_value" }
+    """
+    Then the response should be 203

data/features/general_steps/requests_with_params.feature

@@ -0,0 +1,27 @@
+Feature: Requests with params, JSON response
+
+  Scenario: POST with params
+    When I POST to "/" with:
+      | Name        | Value      |
+      | some_param  | some_value |
+      | im_a_number | 1          |
+    Then the response should be 201
+    And I should receive the JSON:
+    """
+      { "some_param" : "some_value",
+        "im_a_number" : "1"
+      }
+    """
+
+  Scenario: PUT with params
+    When I PUT to "/" with:
+      | Name        | Value      |
+      | some_param  | some_value |
+      | im_a_number | 1          |
+    Then the response should be 202
+    And I should receive the JSON:
+    """
+      { "some_param" : "some_value",
+        "im_a_number" : "1"
+      }
+    """

data/features/general_steps/response.feature

@@ -0,0 +1,21 @@
+Feature: Responses
+
+  Scenario: Normal response
+    When I GET "/"
+    Then the response should be 200
+
+  Scenario: Response with JSON body
+    When I GET "/json"
+    Then the response should be 200
+    And I should receive the JSON:
+    """
+      { "key" : 1 }
+    """
+
+  Scenario: Not found response
+    When I GET "/no_such_route"
+    Then the response should be 404
+
+  Scenario: Redirect
+    When I GET "/redirect"
+    Then I should be redirected to "/"

data/features/liquid_templates.feature

@@ -0,0 +1,44 @@
+Feature: Liquid templates
+"""
+Note that these also show variable interpolation happening in the response body
+"""
+
+  Scenario: Variable interpolation in URI
+    When I have set some template variable "foo"
+    And I GET "/route/{{foo}}"
+    Then the response should be 200
+    And I should receive the JSON:
+    """
+      { "variable" : "{{foo}}" }
+    """
+
+  Scenario: Variable interpolation in params
+    When I have set some template variable "foo"
+    And I POST to "/" with:
+      | Name        | Value   |
+      | some_param  | {{foo}} |
+      | im_a_number | 1       |
+    Then the response should be 201
+    And I should receive the JSON:
+    """
+      {
+        "some_param" : "{{foo}}",
+        "im_a_number" : "1"
+      }
+    """
+
+  Scenario: Variable interpolation in JSON body
+    When I have set some template variable "foo"
+    And I POST to "/json" with the JSON:
+    """
+      {
+        "some_var" : "{{foo}}"
+      }
+    """
+    Then the response should be 201
+    And I should receive the JSON:
+    """
+      {
+        "some_var" : "{{foo}}"
+      }
+    """

data/features/not_timefreeze.feature

@@ -0,0 +1,14 @@
+Feature: Timefreeze and liquid templates
+"""
+  This test does not happen in frozen time because it is not tagged @timefreeze - it is here to serve as a contrast to timefreeze.feature
+"""
+
+  Scenario: Timecop.freeze
+    Given I know the time the test started
+    When I GET "/time"
+    Then I should not receive the JSON:
+    """
+      {
+        "time" : "{{time}}"
+      }
+    """

data/features/number_transform.feature

@@ -0,0 +1,5 @@
+Feature: Transform of numbers
+
+  Scenario: A test containing a number
+    When I run a test that expects a number like 123
+    Then it should know that it is a number, not a string

data/features/step_definitions/liquid_templates_steps.rb

@@ -0,0 +1,3 @@
+When /^I have set some template variable "(.*?)"$/ do |var_name|
+  template_vars[var_name] = rand(1000).to_s
+end

data/features/step_definitions/number_transform_steps.rb

@@ -0,0 +1,7 @@
+Given /^I run a test that expects a number like (-?\d+*)$/ do |the_number|
+  @the_number = the_number
+end
+
+Then /^it should know that it is a number, not a string$/ do
+  expect(@the_number).to be_a Integer
+end

data/features/step_definitions/timefreeze_steps.rb

@@ -0,0 +1,15 @@
+Given /^I know the time the test started$/ do
+  template_vars['time'] = Time.now.to_i
+end
+
+Then /^I should not receive the JSON:$/ do |json|
+  target = JSON.parse(render_string(json))
+
+  begin
+    received = JSON.parse(last_response.body)
+  rescue JSON::ParserError => e
+    raise "Unexpected response: #{last_response.body}\n#{e}"
+  end
+
+  expect(received).not_to eql(target)
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../')
+
+require 'lookout/rack/test/cucumber'
+
+# Set up TestApp server
+require 'examples/test_app'
+$application_class = TestApp
+require 'lookout/rack/test/cucumber/server'
+
+require 'lookout/rack/test/cucumber/transforms'

data/features/timefreeze.feature

@@ -0,0 +1,15 @@
+@timefreeze
+Feature: Timefreeze and liquid templates
+"""
+  This test happens in frozen time because it is tagged @timefreeze
+"""
+
+  Scenario: Timecop.freeze
+    Given I know the time the test started
+    When I GET "/time"
+    Then I should receive the JSON:
+    """
+      {
+        "time" : {{time}}
+      }
+    """