proxytest 0.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org" # http to fix 1.9.3
+
+gem "thin"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    proxytest (0.0.0)
+      thin
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    daemons (1.1.9)
+    diff-lcs (1.1.3)
+    eventmachine (1.0.0)
+    rack (1.5.0)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    thin (1.5.0)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  proxytest!
+  rake
+  rspec
+  thin

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2013 Richo Healey <richo@psych0tik.net>
+
+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,24 @@
+Test driven varnish ftw yo.
+
+## Usage
+
+```ruby
+
+# Sample Rakefile
+ProxyTest::config do |conf|
+  conf.backend_port = 2000
+  conf.proxy_port   = 6868
+
+  #conf.pattern = "proxytest/**/*_test.rb"
+
+  #conf.backend_host = "localhost"
+  #conf.proxy_host   = "localhost"
+end
+
+namespace :proxy do
+  desc "Run proxy tests"
+  task :test do
+    ProxyTest.run!
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+desc "Run basic tests"
+Rake::TestTask.new("test") { |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = true
+}
+
+desc "Start the singletonqueue server"
+task :serve do
+  require './test/helpers/backend'
+  q = SingletonQueue.new
+  loop do
+    q.enq("HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n")
+  end
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/examples/hello_world_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path("../../test_helper", __FILE__)
+class HelloWorldTest < ProxyTest::TestCase
+  def test_it_says_hello_world
+    # Returns the real objects from the transaction
+    res, req = expect :get, "/hello" do |response, request|
+      # Modify the request inline
+      request["X-Someotherheader"] = "thing"
+
+      # Modify the response inline
+      response.body = "body goes here"
+      response["X-Someheader"] = "value"
+    end
+
+    # Assertions about response go here
+    #
+    assert_equal res.body, "body goes here"
+    assert_equal res["X-SOMEHEADER"], "value"
+    assert_equal req.env["REQUEST_METHOD"], "GET"
+    assert_equal req.env["X-SOMEOTHERHEADER"], "thing"
+  end
+end

data/examples/teapot_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path("../../test_helper", __FILE__)
+class ImaTeapotTest < ProxyTest::TestCase
+  def test_it_is_a_teapot
+    res, req = expect :get, "/teapot" do |response, request|
+      response.status = 418
+      response.body = "I'm a teapot, yo"
+    end
+
+    assert_equal res.body, "I'm a teapot, yo"
+    assert_equal res.code.to_i, 418
+  end
+end
+

data/lib/proxytest.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require 'net/http'
+
+module ProxyTest
+end
+
+require File.expand_path("../proxytest/testcase", __FILE__)
+require File.expand_path("../proxytest/configurator", __FILE__)
+require File.expand_path("../proxytest/helpers/backend", __FILE__)
+require File.expand_path("../proxytest/helpers/response", __FILE__)

data/lib/proxytest/configurator.rb

@@ -0,0 +1,24 @@
+module ProxyTest; extend self
+  def config
+    ::ProxyTest::Config.seed_from_environment!
+    yield ::ProxyTest::Config
+  end
+end
+
+module ProxyTest
+  class Config; class << self
+    attr_accessor :backend_port, :backend_host
+    attr_accessor :proxy_port, :proxy_host
+    attr_accessor :pattern
+
+    def seed_from_environment!
+      # Doesn't touch any values that have already been set
+      @pattern ||= "proxytest/**/*_test.rb"
+
+      @backend_port ||= ENV["BACKEND_PORT"]
+      @backend_host ||= ENV["BACKEND_HOST"] || "localhost"
+      @proxy_port   ||= ENV["PROXY_PORT"]
+      @proxy_host   ||= ENV["PROXY_HOST"] || "localhost"
+    end
+  end; end
+end

data/lib/proxytest/helpers/backend.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+#
+#
+require 'thread'
+require 'socket'
+require File.expand_path("../thin_http_parser", __FILE__)
+
+module ProxyTest
+class SingletonQueue
+
+  def self.new(*args)
+    # Guarantees that only a single instance will exist
+    @@instance ||= super(*args)
+  end
+
+  def self.get
+    # Helper to make what's going on more obvious
+    @@instance
+  end
+
+######
+
+  def initialize(opts={})
+    @in_q  = Queue.new
+    @out_q = Queue.new
+    opts[:port] ||= ::ProxyTest::Config.backend_port
+    spawn_reader(opts[:port])
+  end
+  attr_reader :in_q, :out_q
+
+  def enq(data)
+    in_q.enq(data)
+  end
+
+  def deq
+    out_q.deq
+  end
+
+  def join!
+    @thread.join
+  end
+
+private
+
+  def spawn_reader(port)
+    @thread = Thread.new(in_q, out_q) do |en_q, de_q|
+      serv = TCPServer.new port
+      loop do
+        # Create a parser object
+        parser = ::ProxyTest::RequestParser.new
+
+        # Pop a connection off the stack
+        client = serv.accept
+
+        # retrieve the headers
+        lines = []
+        while (line = client.gets) != "\r\n"
+          # XXX Hack around missing CONTENT_LENGTH in parser.env
+          if parser.env['CONTENT_LENGTH'].nil? && line =~ /^Content-Length: (\d+)/
+            parser.env['CONTENT_LENGTH'] = $1.to_i
+          elsif line =~ /(\S+): (.*)/
+            parser.env[$1.upcase] = $2.chomp
+          end
+          lines << line
+        end
+
+
+        parser.parse(lines.join("\r\n"))
+
+        if parser.content_length > 0
+          parser.parse(client.gets(parser.content_length))
+        end
+
+        # Send the request object back to the caller
+        de_q.enq(parser)
+
+        # Fetch the response object from the caller
+        response = en_q.deq
+        client.write(response.to_s)
+
+        client.close
+      end
+    end
+  end
+
+end
+end

data/lib/proxytest/helpers/response.rb

@@ -0,0 +1,53 @@
+module ProxyTest
+  STATUSES = {
+    200 => "OK",
+    418 => "I'm a teapot"
+  }
+
+  class Response
+    attr_accessor :body
+    attr_reader :headers
+
+    def initialize
+      body = ""
+      # Default set of headers?
+      @headers = {}
+    end
+
+    def to_http
+      h1 =  <<-HTTP
+HTTP/1.0 #{status} #{STATUSES[status]}
+Content-Type: text/html
+Content-Length: #{body.length}
+HTTP
+      headers.each do |k, v|
+        h1 += "#{k}: #{v}\r\n"
+      end
+
+      h1 += <<-HTTP
+
+#{body}
+HTTP
+      return h1
+    end
+
+    # Hack to make it look like a Net::HTTP entity
+    def [](v)
+      headers[v]
+    end
+
+    def []=(k, v)
+      headers[k] = v
+    end
+
+    # Status wrapper
+    def status
+      @status ||= 200
+    end
+
+    def status=(st)
+      @status = st
+    end
+
+  end
+end

data/lib/proxytest/helpers/thin_http_parser.rb

@@ -0,0 +1,93 @@
+# FILE: thin_http_parser.rb
+# http://www.franzens.org/2011/10/writing-minimalistic-web-server-using.html
+# Copyright 2011 Nils Franzén
+
+module ProxyTest
+# Uncomment this line if 'thin_parser' is not found
+require 'thin'
+require 'thin_parser'
+require 'stringio'
+
+# Freeze some HTTP header names & values
+HTTP_VERSION      = 'HTTP_VERSION'.freeze
+HTTP_1_0          = 'HTTP/1.0'.freeze
+CONTENT_LENGTH    = 'CONTENT_LENGTH'.freeze
+CONNECTION        = 'HTTP_CONNECTION'.freeze
+KEEP_ALIVE_REGEXP = /\bkeep-alive\b/i.freeze
+CLOSE_REGEXP      = /\bclose\b/i.freeze
+
+# Freeze some Rack header names
+RACK_INPUT        = 'rack.input'.freeze
+
+# A request sent by the client to the server.
+class RequestParser
+  INITIAL_BODY      = ''
+
+  # Force external_encoding of request's body to ASCII_8BIT
+  INITIAL_BODY.encode!(Encoding::ASCII_8BIT) if INITIAL_BODY.respond_to?(:encode!)
+
+  # CGI-like request environment variables
+  attr_reader :env
+
+  # Unparsed data of the request
+  attr_reader :data
+
+  # Request body
+  attr_reader :body
+
+  def initialize
+    @parser   = Thin::HttpParser.new
+    @data     = ''
+    @nparsed  = 0
+    @body     = StringIO.new(INITIAL_BODY.dup)
+    @env      = {
+      RACK_INPUT        => @body,
+    }
+  end
+
+  # Parse a chunk of data into the request environment
+  # Returns +true+ if the parsing is complete.
+  def parse(data)
+    if @parser.finished?  # Header finished, can only be some more body
+      body << data
+    else                  # Parse more header using the super parser
+      @data << data
+      @nparsed = @parser.execute(@env, @data, @nparsed)
+    end
+
+    if finished?   # Check if header and body are complete
+      @data = nil
+      @body.rewind
+      true         # Request is fully parsed
+    else
+      false        # Not finished, need more data
+    end
+  end
+
+  # +true+ if headers and body are finished parsing
+  def finished?
+    @parser.finished? && @body.size >= content_length
+  end
+
+  # Expected size of the body
+  def content_length
+    @env[CONTENT_LENGTH].to_i
+  end
+
+  # Returns +true+ if the client expect the connection to be persistent.
+  def persistent?
+    # Clients and servers SHOULD NOT assume that a persistent connection
+    # is maintained for HTTP versions less than 1.1 unless it is explicitly
+    # signaled. (http://www.w3.org/Protocols/rfc2616/rfc2616-sec8.html)
+    if @env[HTTP_VERSION] == HTTP_1_0
+      @env[CONNECTION] =~ KEEP_ALIVE_REGEXP
+
+    # HTTP/1.1 client intends to maintain a persistent connection unless
+    # a Connection header including the connection-token "close" was sent
+    # in the request
+    else
+      @env[CONNECTION].nil? || @env[CONNECTION] !~ CLOSE_REGEXP
+    end
+  end
+end
+end

data/lib/proxytest/testcase.rb

@@ -0,0 +1,52 @@
+
+class ProxyTest::TestCase < Test::Unit::TestCase
+  def q
+    ::ProxyTest::SingletonQueue.get
+  end
+
+  def expect(method, path, &block)
+    # Create stub objects for the response and the request
+    url = URI.parse("http://#{::ProxyTest::Config.proxy_host}:#{::ProxyTest::Config.proxy_port}")
+    mock_req = requester(method).new(path)
+    mock_res = ::ProxyTest::Response.new
+
+    yield(mock_res, mock_req)
+
+    # Pass the response into the http server
+    q.enq(mock_res.to_http)
+
+    # TODO Configurable port
+    real_res = Net::HTTP.start(url.host,url.port) do |http|
+      http.request(mock_req)
+    end
+
+    real_req = q.deq
+
+    [real_res, real_req]
+  end
+
+  def requester(sym)
+    case sym
+    when :get
+      Net::HTTP::Get
+    when :post
+      Net::HTTP::Post
+    when :put
+      Net::HTTP::Put
+    when :head
+      Net::HTTP::Head
+    else
+      raise "Unsupported HTTP verb"
+    end
+  end
+
+
+  def get(path, hdr, &block)
+    @paths << [path, hdr, block]
+  end
+
+  def paths
+    @paths ||= Array.new
+  end
+
+end

data/proxytest.gemspec

@@ -0,0 +1,24 @@
+# vim: ft=ruby
+
+Gem::Specification.new do |s|
+  s.name        = "proxytest"
+  s.version     = "0.0.0"
+  s.authors     = ["Rich Healey"]
+  s.email       = ["richo@99designs.com"]
+  s.homepage    = "http://github.com/richo/proxytest"
+  s.summary     = "A test framework for testing proxy logic"
+  s.description = s.summary
+
+  s.add_dependency "thin"
+
+  s.add_development_dependency "rake"
+  #s.add_development_dependency "mocha"
+  s.add_development_dependency "rspec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+
+

data/script/cibuild

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+bundle install
+bundle exec rake spec

data/spec/proxytest/config_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ProxyTest::Config do
+
+  it "Should not have any values until initialized" do
+    ::ProxyTest::Config.backend_port.should be_nil
+    ::ProxyTest::Config.backend_host.should be_nil
+    ::ProxyTest::Config.proxy_port.should be_nil
+    ::ProxyTest::Config.proxy_host.should be_nil
+
+    ::ProxyTest::Config.pattern.should be_nil
+  end
+
+  it "Should inherit sane defaults for host config" do
+    ::ProxyTest::config do |conf|
+    end
+
+    ::ProxyTest::Config.backend_host.should == "localhost"
+    ::ProxyTest::Config.proxy_host.should == "localhost"
+  end
+
+  it "Should inherit sane default for pattern" do
+    ::ProxyTest::config do |conf|
+    end
+
+    ::ProxyTest::Config.pattern.should == "proxytest/**/*_test.rb"
+  end
+
+  it "Should store hostnames given" do
+    ::ProxyTest::config do |conf|
+      conf.backend_host = "richo-mbp"
+      conf.proxy_host = "richo-mbp"
+    end
+
+    ::ProxyTest::Config.backend_host.should == "richo-mbp"
+    ::ProxyTest::Config.proxy_host.should == "richo-mbp"
+  end
+
+  it "Should store ports given" do
+    ::ProxyTest::config do |conf|
+      conf.backend_port = 2257
+      conf.proxy_port = 2256
+    end
+
+    ::ProxyTest::Config.backend_port.should == 2257
+    ::ProxyTest::Config.proxy_port.should == 2256
+  end
+
+  it "Should not clobber config on subsequent passes" do
+    ::ProxyTest::config do |conf|
+      conf.backend_port = 2257
+      conf.proxy_port = 2256
+    end
+    ::ProxyTest::config do |conf|
+      conf.backend_host = "richo-mbp"
+      conf.proxy_host = "richo-mbp"
+    end
+
+    ::ProxyTest::Config.backend_host.should == "richo-mbp"
+    ::ProxyTest::Config.proxy_host.should == "richo-mbp"
+    ::ProxyTest::Config.backend_port.should == 2257
+    ::ProxyTest::Config.proxy_port.should == 2256
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'proxytest'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: proxytest
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Rich Healey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A test framework for testing proxy logic
+email:
+- richo@99designs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- examples/hello_world_test.rb
+- examples/teapot_test.rb
+- lib/proxytest.rb
+- lib/proxytest/configurator.rb
+- lib/proxytest/helpers/backend.rb
+- lib/proxytest/helpers/response.rb
+- lib/proxytest/helpers/thin_http_parser.rb
+- lib/proxytest/testcase.rb
+- proxytest.gemspec
+- script/cibuild
+- spec/proxytest/config_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/richo/proxytest
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A test framework for testing proxy logic
+test_files:
+- spec/proxytest/config_spec.rb
+- spec/spec_helper.rb