sinatra-unit 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2013-01-14
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/sinatra/unit.rb

data/README.txt

@@ -0,0 +1,84 @@
+# sinatra-unit
+
+* http://github.com/snarfmason/sinatra-unit
+
+Testing harness for Sinatra to make proper unit tests/specs for actions.
+
+Description
+-----------
+
+The idea is to instantiate your Sintra class and then execute the web request blocks on the instance
+that you have created. It uses the `test_request` method (and shortcuts like `test_get`, `test_put`, etc)
+to look up the block using the same route matching logic that Sinatra would use when receiving a request
+from Rack.
+
+Usage
+-----
+
+Basic usage:
+
+    @app = WebApp.new
+    response_body = @app.test_request(:get, '/')
+
+of course you can do, params:
+
+    response_body = @app.test_request(:get, '/hi', :qsname => 'jon')
+
+you can set the environment or session (if enabled) with a hash, before a request
+
+    @app.env = { :test => 'hello' }
+    @app.session = { :test => 'hello' }
+    response_body = @app.test_get '/showsession'
+
+Currently the text of the response is returned from the `test_request` method. If you need access to headers or HTTP status you use the `response` object.
+
+    @app.response.status
+    @app.response.header['Content-Type']
+
+
+Writing Tests
+-------------
+
+basic good route:
+
+    response_body = @app.test_request(:get, '/')
+    assert_equal "hello world", response_body
+    assert_equal 200, @app.response.status
+    assert_equal 'text/html', @app.response.header['Content-Type']
+
+basic bad route:
+
+    assert_raise Sinatra::Unit::UnknownRouteError do
+      @app.test_get '/wrongroute'
+    end
+
+basic redirect:
+
+    @app.test_get '/redirect'
+    assert @app.redirect?
+    assert_equal 302, @app.response.status
+
+you can retrieve instance variables set in request blocks
+
+    # app
+    get '/showobject' do
+      @object = OpenStruct.new :foo => 1, :bar => 2, :baz => 3
+      "foo=#{@object.foo}&bar=#{@object.bar}&baz=#{@object.baz}"
+    end
+
+    # test
+    response_body = @app.test_get '/showobject'
+    assert_equal 'foo=1&bar=2&baz=3', response_body
+    assert_equal 1, @app.variables("object").foo
+
+you can assert against session values
+
+    # app
+    post '/setsession' do
+      session[:test] = params[:test]
+    end
+    
+    # test
+    assert_nil @app.session[:test]
+    @app.test_post '/setsession', :test => 'goodbye'
+    assert_equal 'goodbye', @app.session[:test]

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :isolate
+# Hoe.plugin :rubyforge
+
+Hoe.spec "sinatra-unit" do
+  dependency 'sinatra', '~> 1.3.3'
+
+  developer "Jonathan Mason", "jonathan.e.mason@gmail.com"
+
+  license "MIT"
+end
+
+# vim: syntax=ruby

data/lib/sinatra/unit.rb

@@ -0,0 +1,104 @@
+require 'ostruct'
+
+module Sinatra
+  class Unit
+    VERSION = '0.1.0'
+
+    class UnknownRouteError < StandardError
+      attr_accessor :method, :path, :params
+      def initialize(method, path, params)
+        self.method, self.path, self.params = method, path, params
+        message = "Could not resovle route #{method} #{path} with params #{params.inspect}"
+        super message
+      end
+    end
+
+    class SessionsDisabledError < StandardError ; end
+  end
+
+  class Base
+    def test_sessions_enabled?
+      return true if self.class.sessions?
+
+      used_middleware = self.class.instance_variable_get "@middleware"
+      used_middleware.each do |middleware|
+        return true if middleware.first == Rack::Session::Cookie
+      end
+
+      return false
+    end
+
+    # Normal sinatra session method just returns request.session which passes
+    # through to env['rack.session'] but I don't initialize the request object
+    # until just before the route lookkup, so I need to skip directly to env.
+    def session
+      raise Sinatra::Unit::SessionsDisabledError unless test_sessions_enabled?
+      env['rack.session'] ||= {}
+    end
+
+    # This doesn't exist in regular sinatra, but it's convenient for some tests
+    def session=(session)
+      raise Sinatra::Unit::SessionsDisabledError unless test_sessions_enabled?
+      env['rack.session'] = session
+    end
+
+    # test_request comes mostly from the guts of route! in Sinatra::Base
+    def test_request(method, path, params={})
+      @params = indifferent_params(params)
+
+      @request = Sinatra::Request.new(env)
+      @request.path_info = path # sinatra 1.3.3
+
+      @__protected_ivars = instance_variables + ["@__protected_ivars"]
+
+      # routes are stored by uppercase method, but I wanted the test interface
+      # to accept :get or 'get' as well as 'GET'
+      test_request_internal self.class, method.to_s.upcase
+    end
+
+    def variables(name)
+      name = "@#{name.to_s}"
+      instance_variable_get(name) unless @__protected_ivars.include?(name)
+    end
+
+    # expects @request and @params to be set
+    # Don't call this directly, but I don't believe in private methods
+    def test_request_internal(route_holder, method)
+      raise Sinatra::Unit::UnknownRouteError.new(method,@request.path_info,@params) unless route_holder.respond_to?(:routes)
+
+      if route_holder.routes.has_key? method
+        routes = route_holder.routes[method]
+        routes.each do |pattern, keys, conditions, block|
+          process_route(pattern, keys, conditions) do |*args|
+            return catch(:halt) { block[*args] }
+          end
+        end
+      end
+
+      test_request_internal(route_holder.superclass, method)
+    end
+
+    %w(get post put delete head).each do |method|
+      eval <<-CODE
+        def test_#{method}(path, params={})
+          test_request('#{method}', path, params)
+        end
+      CODE
+    end
+
+    # Sinatra makes new do a bunch of stuff with rack middleware wrappers
+    # that are useful if you're actually running the app, but provides
+    # new! for regular instantiation. I'm just re-standardizing names
+    class << self
+      alias new_with_rack_wrappers new
+    end
+
+    def self.new
+      app = new!
+      app.env ||= {}
+      app.response = Sinatra::Response.new
+      app
+    end
+
+  end
+end

data/test/unit/test_no_sessions_app.rb

@@ -0,0 +1,26 @@
+require 'no_sessions_app'
+require 'sinatra/unit'
+
+require 'test/unit'
+
+class TestNoSessionsApp < Test::Unit::TestCase
+  def setup
+    @app = NoSessionsApp.new
+  end
+
+  def test_session_show
+    assert_raises Sinatra::Unit::SessionsDisabledError do
+      @app.session = { :test => 'hello' }
+      response_body = @app.test_get '/showsession'
+      assert_equal 'session[test] hello', response_body
+    end
+  end
+
+  def test_session_set
+    assert_raises Sinatra::Unit::SessionsDisabledError do
+      assert_nil @app.session[:test]
+      @app.test_post '/setsession', :test => 'goodbye'
+      assert_equal 'goodbye', @app.session[:test]
+    end
+  end
+end

data/test/unit/test_rack_session_app.rb

@@ -0,0 +1,22 @@
+require 'rack_sessions_app'
+require 'sinatra/unit'
+
+require 'test/unit'
+
+class TestRackSessionsApp < Test::Unit::TestCase
+  def setup
+    @app = RackSessionsApp.new
+  end
+
+  def test_session_show
+    @app.session = { :test => 'hello' }
+    response_body = @app.test_get '/showsession'
+    assert_equal 'session[test] hello', response_body
+  end
+
+  def test_session_set
+    assert_nil @app.session[:test]
+    @app.test_post '/setsession', :test => 'goodbye'
+    assert_equal 'goodbye', @app.session[:test]
+  end
+end

data/test/unit/test_unknown_route_error.rb

@@ -0,0 +1,21 @@
+require 'web_app'
+require 'sinatra/unit'
+require 'test/unit'
+
+class TestUnknownRouteError < Test::Unit::TestCase
+  def test_unknown_route_exception_details
+    error = nil
+    begin
+      WebApp.new.test_get '/wrongroute', :wrong_param => 'foobar'
+    rescue => e
+      error = e
+    end
+
+    assert_not_nil error
+    assert_equal 'GET', error.method
+    assert_equal '/wrongroute', error.path
+    assert_equal 'foobar', error.params[:wrong_param]
+    assert_match %r{GET.*/wrongroute.*wrong_param.*foobar}, error.message
+  end
+end
+

data/test/unit/test_web_app.rb

@@ -0,0 +1,105 @@
+require 'web_app'
+require 'sinatra/unit'
+
+require 'test/unit'
+
+class TestWebApp < Test::Unit::TestCase
+  def setup
+    @app = WebApp.new
+  end
+
+  def test_returns_hello_world_on_index
+    response_body = @app.test_request(:get, '/')
+    assert_equal "hello world", response_body
+    assert_equal 200, @app.response.status
+    assert_equal 'text/html', @app.response.header['Content-Type']
+  end
+
+  def test_returns_goodbye_on_bye
+    response_body = @app.test_request(:get, '/bye')
+    assert_equal "goodbye", response_body
+  end
+
+  def test_has_hello_name
+    response_body = @app.test_request(:get, '/hello/jon')
+    assert_equal "hello jon", response_body
+  end
+
+  def test_returns_for_hi_with_param
+    response_body = @app.test_request(:get, '/hi', :qsname => 'jon')
+    assert_equal "hi jon", response_body
+  end
+
+  def test_work_with_get_wrapped_method
+    response_body = @app.test_get '/'
+    assert_equal "hello world", response_body
+  end
+
+  def test_raises_an_exception_for_unknown_route
+    assert_raise Sinatra::Unit::UnknownRouteError do
+      @app.test_get '/wrongroute'
+    end
+  end
+
+  def test_works_with_post_data
+    response_body = @app.test_post '/goodnight', :name => 'jon'
+    assert_equal 'post goodnight jon', response_body
+  end
+
+  def test_works_with_pu
+    response_body = @app.test_put '/goodnight', :name => 'jon'
+    assert_equal 'put goodnight jon', response_body
+  end
+
+  def test_works_with_env
+    @app.env = { :test => 'hello' }
+    response_body = @app.test_post '/showenv'
+    assert_equal 'env[test] hello', response_body
+  end
+
+  def test_session_show
+    @app.session = { :test => 'hello' }
+    response_body = @app.test_get '/showsession'
+    assert_equal 'session[test] hello', response_body
+  end
+
+  def test_session_set
+    assert_nil @app.session[:test]
+    @app.test_post '/setsession', :test => 'goodbye'
+    assert_equal 'goodbye', @app.session[:test]
+  end
+
+  def test_instance_variable_retrieval
+    response_body = @app.test_get '/showobject'
+    assert_equal 'foo=1&bar=2&baz=3', response_body
+    assert_equal 1, @app.variables("object").foo
+  end
+
+  def test_only_retrieve_instance_variables_set_in_the_block
+    response_body = @app.test_get '/showobject'
+    assert_nil @app.variables("template_cache")
+  end
+
+  def test_do_not_retrieve_protected_instance_variables
+    response_body = @app.test_get '/showobject'
+    assert_nil @app.variables("__protected_ivars")
+  end
+
+  def test_redirect_to_index
+    @app.test_get '/redirect'
+    assert @app.redirect?
+    assert_equal 302, @app.response.status
+  end
+
+  def test_two_requests
+    response_body = @app.test_request(:get, '/')
+    assert_equal "hello world", response_body
+    assert_equal 200, @app.response.status
+    assert_equal 'text/html', @app.response.header['Content-Type']
+
+    @app.test_get '/redirect'
+    assert @app.redirect?
+    assert_equal 302, @app.response.status
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-unit
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jonathan Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-04-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 3
+        - 5
+        version: "3.5"
+  type: :development
+  version_requirements: *id003
+description: ""
+email: 
+- jonathan.e.mason@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/sinatra/unit.rb
+- test/unit/test_no_sessions_app.rb
+- test/unit/test_rack_session_app.rb
+- test/unit/test_unknown_route_error.rb
+- test/unit/test_web_app.rb
+- .gemtest
+homepage: http://github.com/snarfmason/sinatra-unit
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sinatra-unit
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: 
+- test/unit/test_no_sessions_app.rb
+- test/unit/test_rack_session_app.rb
+- test/unit/test_unknown_route_error.rb
+- test/unit/test_web_app.rb