mongrel2 0.0.1

data/lib/mongrel2/xmlrequest.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby
+
+require 'nokogiri'
+
+require 'mongrel2/request' unless defined?( Mongrel2::Request )
+require 'mongrel2/mixins'
+
+
+# The Mongrel2 XML Request class. Instances of this class represent a request for an XML route from
+# a Mongrel2 server.
+class Mongrel2::XMLRequest < Mongrel2::Request
+	include Mongrel2::Loggable
+
+	register_request_type( self, :XML )
+
+
+	### Parse the body as JSON.
+	def initialize( sender_id, conn_id, path, headers, body, raw=nil )
+		super
+		self.log.debug "Parsing XML request body"
+		@data = Nokogiri::XML( body )
+	end
+
+
+	######
+	public
+	######
+
+	# The parsed request data (a Nokogiri::XML document)
+	attr_reader :data
+
+
+end # class Mongrel2::XMLRequest
+
+# vim: set nosta noet ts=4 sw=4:
+

data/spec/lib/constants.rb

@@ -0,0 +1,237 @@
+#!/usr/bin/env ruby
+
+require 'uri'
+require 'yajl'
+require 'tnetstring'
+
+require 'mongrel2' unless defined?( Mongrel2 )
+
+
+### A collection of constants used in testing
+module Mongrel2::TestConstants # :nodoc:all
+
+	include Mongrel2::Constants
+
+	unless defined?( TEST_HOST )
+
+		TEST_HOST = 'localhost'
+		TEST_PORT = 8118
+
+		# Rule 2: Every message to and from Mongrel2 has that Mongrel2 instances
+		#   UUID as the very first thing.
+		TEST_UUID = 'BD17D85C-4730-4BF2-999D-9D2B2E0FCCF9'
+
+		# 0mq socket specifications for Handlers
+		TEST_SEND_SPEC = 'tcp://127.0.0.1:9998'
+		TEST_RECV_SPEC = 'tcp://127.0.0.1:9997'
+
+		# Rule 3: Mongrel2 sends requests with one number right after the
+		#   servers UUID separated by a space. Handlers return a netstring with
+		#   a list of numbers separated by spaces. The numbers indicate the
+		#   connected browser the message is to/from.
+		TEST_ID = 8
+
+		#
+		# HTTP request constants
+		#
+
+		TEST_ROUTE = '/handler'
+		TEST_PATH  = TEST_ROUTE
+		TEST_QUERY = 'thing=foom'
+
+		TEST_HEADERS = {
+			"x-forwarded-for" => "127.0.0.1",
+			"accept-language" => "en-US,en;q=0.8",
+			"accept-encoding" => "gzip,deflate,sdch",
+			"connection"      => "keep-alive",
+			"accept-charset"  => "UTF-8,*;q=0.5",
+			"accept"          => "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+			"user-agent"      => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_1) " +
+			                     "AppleWebKit/535.1 (KHTML, like Gecko) Chrome/13.0.782.112 " +
+			                     "Safari/535.1",
+			"host"            => "localhost:3667",
+			"METHOD"          => "GET",
+			"VERSION"         => "HTTP/1.1",
+		}
+
+		TEST_BODY = ''
+
+		TEST_REQUEST_OPTS = {
+			:uuid    => TEST_UUID,
+			:id      => TEST_ID,
+			:path    => TEST_PATH,
+			:body    => TEST_BODY,
+		}
+
+
+		#
+		# JSON (JSSocket, etc.) request constants
+		#
+
+		TEST_JSON_PATH = '@directory'
+
+		TEST_JSON_HEADERS = {
+			'PATH'            => TEST_JSON_PATH,
+			'x-forwarded-for' => "127.0.0.1",
+			'METHOD'          => "JSON",
+			'PATTERN'         => TEST_JSON_PATH,
+		}
+		TEST_JSON_BODY = { 'type' => 'msg', 'msg' => 'connect' }
+
+		TEST_JSON_REQUEST_OPTS = {
+			:uuid    => TEST_UUID,
+			:id      => TEST_ID,
+			:path    => TEST_JSON_PATH,
+			:body    => TEST_JSON_BODY,
+		}
+
+
+		#
+		# XML message request constants
+		#
+
+		TEST_XML_PATH = '<directory'
+
+		TEST_XML_HEADERS = {
+			'PATH'            => TEST_XML_PATH,
+			'x-forwarded-for' => "127.0.0.1",
+			'METHOD'          => "XML",
+			'PATTERN'         => TEST_XML_PATH,
+		}
+		TEST_XML_BODY = '<directory><file name="foom.txt" /><file name="foom2.md" /></directory>'
+
+		TEST_XML_REQUEST_OPTS = {
+			:uuid    => TEST_UUID,
+			:id      => TEST_ID,
+			:path    => TEST_XML_PATH,
+			:body    => TEST_XML_BODY,
+		}
+
+
+		#
+		# HTTP constants
+		#
+
+		# Space
+		SP = '\\x20'
+
+		# Network EOL
+		CRLF = '\\r\\n'
+
+		# Pattern to match the contents of ETag and If-None-Match headers
+		ENTITY_TAG_PATTERN = %r{
+			(w/)?       # Weak flag
+			"           # Opaque-tag
+				([^"]+) # Quoted-string
+			"           # Closing quote
+		  }ix
+
+		# Separators    = "(" | ")" | "<" | ">" | "@"
+		#                  | "," | ";" | ":" | "\" | <">
+		#                  | "/" | "[" | "]" | "?" | "="
+		#                  | "{" | "}" | SP | HT
+		SEPARATORS = Regexp.quote("(\")<>@,;:\\/[]?={} \t")
+
+		# token         = 1*<any CHAR except CTLs or separators>
+		TOKEN = /[^#{SEPARATORS}[:cntrl:]]+/
+
+		# Borrow URI's pattern for matching absolute URIs
+		REQUEST_URI = URI::REL_URI_REF
+
+		# Canonical HTTP methods
+		REQUEST_METHOD = /OPTIONS|GET|HEAD|POST|PUT|DELETE|TRACE|CONNECT/
+
+		# Extension HTTP methods
+		# extension-method = token
+		EXTENSION_METHOD = TOKEN
+
+		# HTTP-Version   = "HTTP" "/" 1*DIGIT "." 1*DIGIT
+		HTTP_VERSION = %r{HTTP/(\d+\.\d+)}
+
+		# LWS            = [CRLF] 1*( SP | HT )
+		LWS = /#{CRLF}[ \t]+/
+
+		# TEX            = <any OCTET except CTLs, but including LWS>
+		TEXT = /[^[:cntrl:]]|#{LWS}/
+
+		# Reason-Phrase  = *<TEXT, excluding CR, LF>
+		REASON_PHRASE = %r{[^[:cntrl:]]+}
+
+		# Pattern to match HTTP response lines
+		#	Status-Line = HTTP-Version SP Status-Code SP Reason-Phrase CRLF
+		HTTP_RESPONSE_LINE = %r{
+			(?<http_version>#{HTTP_VERSION})
+			#{SP}
+			(?<status_code>\d{3})
+			#{SP}
+			(?<reason_phrase>#{REASON_PHRASE})
+			#{CRLF}
+		}x
+
+		# message-header = field-name ":" [ field-value ]
+		# field-name     = token
+		# field-value    = *( field-content | LWS )
+		# field-content  = <the OCTETs making up the field-value
+		#                  and consisting of either *TEXT or combinations
+		#                  of token, separators, and quoted-string>
+
+		# Pattern to match a single header tuple, possibly split over multiple lines
+		HEADER_LINE = %r{
+			^
+			#{TOKEN}
+			:
+			(?:#{LWS}|#{TEXT})*
+			#{CRLF}
+		}mx
+
+		# entity-body	 = *OCTET
+		MESSAGE_BODY = /.*/
+
+		# Pattern to match an entire HTTP response
+		#   Response      = Status-Line               ; Section 6.1
+		#                   *(( general-header        ; Section 4.5
+		#                    | response-header        ; Section 6.2
+		#                    | entity-header ) CRLF)  ; Section 7.1
+		#                   CRLF
+		#                   [ message-body ]          ; Section 7.2
+		HTTP_RESPONSE = %r{
+			^
+			(?<response_line>#{HTTP_RESPONSE_LINE})
+			(?<headers>#{HEADER_LINE}*)
+			#{CRLF}
+			(?<message_body>#{MESSAGE_BODY})
+		}x
+
+		# wkday        = "Mon" | "Tue" | "Wed"
+		#              | "Thu" | "Fri" | "Sat" | "Sun"
+		WKDAY =	 Regexp.union( %w[Mon Tue Wed Thu Fri Sat Sun] )
+
+		# month        = "Jan" | "Feb" | "Mar" | "Apr"
+		#              | "May" | "Jun" | "Jul" | "Aug"
+		#              | "Sep" | "Oct" | "Nov" | "Dec"
+		MONTH = Regexp.union( %w[Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec] ) 
+
+		# Match an RFC1123 "HTTP date"
+		# rfc1123-date = wkday "," SP date1 SP time SP "GMT"
+		# date1        = 2DIGIT SP month SP 4DIGIT
+		#                ; day month year (e.g., 02 Jun 1982)
+		# time         = 2DIGIT ":" 2DIGIT ":" 2DIGIT
+		#                ; 00:00:00 - 23:59:59
+		HTTP_DATE = %r{
+			#{WKDAY} , #{SP}
+			\d{2} #{SP}
+			#{MONTH} #{SP}
+			\d{4} #{SP}
+			\d{2} : \d{2} : \d{2} #{SP} GMT
+		}x
+
+
+		# Freeze all testing constants
+		constants.each do |cname|
+			const_get(cname).freeze
+		end
+	end
+
+end
+
+

data/spec/lib/helpers.rb

@@ -0,0 +1,246 @@
+#!/usr/bin/ruby
+# coding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
+	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
+}
+
+# SimpleCov test coverage reporting; enable this using the :coverage rake task
+if ENV['COVERAGE']
+	$stderr.puts "\n\n>>> Enabling coverage report.\n\n"
+	require 'simplecov'
+	SimpleCov.start do
+		add_filter 'spec'
+		add_group "Config Classes" do |file|
+			file.filename =~ %r{lib/mongrel2/config(\.rb|/.*)$}
+		end
+		add_group "Needing tests" do |file|
+			file.covered_percent < 90
+		end
+	end
+end
+
+begin
+	require 'configurability'
+rescue LoadError => err
+end
+
+require 'pathname'
+require 'tmpdir'
+
+require 'rspec'
+require 'mongrel2'
+require 'mongrel2/config'
+
+require 'sequel'
+require 'sequel/model'
+
+require 'spec/lib/constants'
+require 'spec/lib/matchers'
+
+
+### RSpec helper functions.
+module Mongrel2::SpecHelpers
+	include Mongrel2::TestConstants
+
+	class ArrayLogger
+		### Create a new ArrayLogger that will append content to +array+.
+		def initialize( array )
+			@array = array
+		end
+
+		### Write the specified +message+ to the array.
+		def write( message )
+			@array << message
+		end
+
+		### No-op -- this is here just so Logger doesn't complain
+		def close; end
+
+	end # class ArrayLogger
+
+
+	unless defined?( LEVEL )
+		LEVEL = {
+			:debug => Logger::DEBUG,
+			:info  => Logger::INFO,
+			:warn  => Logger::WARN,
+			:error => Logger::ERROR,
+			:fatal => Logger::FATAL,
+		  }
+	end
+
+	###############
+	module_function
+	###############
+
+	### Make an easily-comparable version vector out of +ver+ and return it.
+	def vvec( ver )
+		return ver.split('.').collect {|char| char.to_i }.pack('N*')
+	end
+
+
+	### Reset the logging subsystem to its default state.
+	def reset_logging
+		Mongrel2.reset_logger
+	end
+
+
+	### Alter the output of the default log formatter to be pretty in SpecMate output
+	def setup_logging( level=Logger::FATAL )
+
+		# Turn symbol-style level config into Logger's expected Fixnum level
+		if Mongrel2::Logging::LOG_LEVELS.key?( level.to_s )
+			level = Mongrel2::Logging::LOG_LEVELS[ level.to_s ]
+		end
+
+		logger = Logger.new( $stderr )
+		Mongrel2.logger = logger
+		Mongrel2.logger.level = level
+
+		# Only do this when executing from a spec in TextMate
+		if ENV['HTML_LOGGING'] || (ENV['TM_FILENAME'] && ENV['TM_FILENAME'] =~ /_spec\.rb/)
+			Thread.current['logger-output'] = []
+			logdevice = ArrayLogger.new( Thread.current['logger-output'] )
+			Mongrel2.logger = Logger.new( logdevice )
+			# Mongrel2.logger.level = level
+			Mongrel2.logger.formatter = Mongrel2::Logging::HtmlFormatter.new( logger )
+		end
+	end
+
+
+	### Set up a Mongrel2 configuration database in memory.
+	def setup_config_db( dbspec=':memory:' )
+		Mongrel2::Config.configure( :configdb => dbspec ) unless
+			Mongrel2::Config.db.uri[ %r{sqlite:/(.*)}, 1 ] == dbspec
+		Mongrel2::Config.init_database
+		Mongrel2::Config.db.tables.collect {|t| Mongrel2::Config.db[t] }.each( &:truncate )
+	end
+
+
+	### Normalize and fill in missing members for the given +opts+.
+	def normalize_headers( opts, defaults=TEST_HEADERS )
+		headers = defaults.merge( opts[:headers] || {} )
+
+		headers["PATH"]    = opts[:path]
+		headers["URI"]     = "#{opts[:path]}?#{opts[:query]}"
+		headers["QUERY"]   = opts[:query]
+		headers["PATTERN"] = opts[:pattern] || opts[:path]
+
+		return headers
+	end
+
+
+	### Make a raw Mongrel2 request from the specified +opts+ and return it as a String.
+	def make_request( opts={} )
+		opts = TEST_REQUEST_OPTS.merge( opts )
+		headers = normalize_headers( opts )
+
+		headerstring = TNetstring.dump( Yajl::Encoder.encode(headers) )
+		bodystring = TNetstring.dump( opts[:body] || '' )
+
+		# UUID ID PATH SIZE:HEADERS,SIZE:BODY,
+		return "%s %d %s %s%s" % [
+			opts[:uuid],
+			opts[:id],
+			opts[:path],
+			headerstring,
+			bodystring,
+		]
+	end
+
+
+	### Make a new-style (TNetstring headers) raw Mongrel2 request from the specified +opts+ 
+	### and return it as a String.
+	def make_tn_request( opts={} )
+		opts = TEST_REQUEST_OPTS.merge( opts )
+		headers = normalize_headers( opts )
+
+		headerstring = TNetstring.dump( headers )
+		bodystring = TNetstring.dump( opts[:body] || '' )
+
+		# UUID ID PATH SIZE:HEADERS,SIZE:BODY,
+		return "%s %d %s %s%s" % [
+			opts[:uuid],
+			opts[:id],
+			opts[:path],
+			headerstring,
+			bodystring,
+		]
+	end
+
+
+	### Make a Mongrel2 request for a JSON route.
+	def make_json_request( opts={} )
+		opts = TEST_JSON_REQUEST_OPTS.merge( opts )
+		headers = normalize_headers( opts, TEST_JSON_HEADERS )
+		headers.delete( 'URI' ) # JSON requests don't have one
+
+		Mongrel2.log.debug "JSON request, headers = %p, opts = %p" % [ headers, opts ]
+
+		headerstring = TNetstring.dump( Yajl::Encoder.encode(headers) )
+		bodystring = TNetstring.dump( Yajl::Encoder.encode(opts[:body] || []) )
+
+		# UUID ID PATH SIZE:HEADERS,SIZE:BODY,
+		return "%s %d %s %s%s" % [
+			opts[:uuid],
+			opts[:id],
+			opts[:path],
+			headerstring,
+			bodystring,
+		]
+	end
+
+
+	### Make a Mongrel2 request for an XML route.
+	def make_xml_request( opts={} )
+		opts = TEST_XML_REQUEST_OPTS.merge( opts )
+		headers = normalize_headers( opts, TEST_XML_HEADERS )
+		headers.delete( 'URI' ) # XML requests don't have one
+
+		Mongrel2.log.debug "XML request, headers = %p, opts = %p" % [ headers, opts ]
+
+		headerstring = TNetstring.dump( Yajl::Encoder.encode(headers) )
+		bodystring = TNetstring.dump( opts[:body] || "#{TEST_XML_PATH} />" )
+
+		# UUID ID PATH SIZE:HEADERS,SIZE:BODY,
+		return "%s %d %s %s%s" % [
+			opts[:uuid],
+			opts[:id],
+			opts[:path],
+			headerstring,
+			bodystring,
+		]
+	end
+
+end
+
+
+abort "You need a version of RSpec >= 2.6.0" unless defined?( RSpec )
+
+if defined?( ::Amalgalite )
+	$stderr.puts ">>> Using Amalgalite #{Amalgalite::VERSION} for DB access."
+else
+	$stderr.puts ">>> Using SQLite3 #{SQLite3::VERSION} for DB access."
+end
+
+### Mock with RSpec
+RSpec.configure do |c|
+	include Mongrel2::TestConstants
+
+	c.mock_with :rspec
+
+	c.extend( Mongrel2::TestConstants )
+	c.include( Mongrel2::TestConstants )
+	c.include( Mongrel2::SpecHelpers )
+	c.include( Mongrel2::Matchers )
+end
+
+# vim: set nosta noet ts=4 sw=4:
+