mongrel_esi 0.4.0

data/test/integration/docs/test1.html

@@ -0,0 +1 @@
+<div>test1</div>

data/test/integration/docs/test3.html

@@ -0,0 +1,9 @@
+<div>test3</div>
+<esi:try>
+  <esi:attempt>
+    <esi:include src="/fragments/test1.html" max-age="600+600"/>
+  </esi:attempt>
+  <esi:except>
+    <esi:include src="/fragments/test1.html"/>
+  </esi:except>
+</esi:try>

data/test/integration/docs/test_failover.html

@@ -0,0 +1 @@
+<div>test failover</div>

data/test/integration/handler_test.rb

@@ -0,0 +1,270 @@
+require "#{File.dirname(__FILE__)}/help"
+
+class HandlerTest < Test::Unit::TestCase
+
+  def setup
+    ESI::Server.start
+  end
+
+  def test_more_web_server
+    results = hit([ "http://localhost:9997/esi_test_content.html", "http://localhost:9997/esi_mixed_content.html"])
+
+		results.each do |res|
+			assert_match $fragment_test1, res
+			assert_no_match /<esi:/, res # assert there are no esi tags in the result
+		end
+    check_status results, String
+	end
+  
+  def test_simple_esi
+    Net::HTTP.start("localhost", 9997) do |h|
+      req = h.get("/esi_test_content.html")
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+			assert_match $fragment_test1, req.body, "Fragment not found"
+			assert_match $fragment_test2, req.body, "Fragment not found"
+    end
+  end
+
+  def test_large_document
+    Net::HTTP.start("localhost", 9997) do |h|
+      req = h.get("/index.html")
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+			assert_match $fragment_test1, req.body, "Fragment not found"
+      # should have 37 fragments
+      count = 0
+      req.body.scan $fragment_test1 do|m|
+        count += 1
+      end
+      assert_equal 37, count, "There should be 37 fragments in the document"
+    end
+  end
+ 
+  def test_reverse_proxy
+    Net::HTTP.start("localhost", 9997) do |h|
+      req = h.get("/content/foo.html")
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+			assert_match $fragment_test2, req.body, "Fragment not found"
+    end
+  end
+ 
+  def test_post
+    Net::HTTP.start("localhost","9997") do |http|
+      post_str = "key=value"
+      assert_match post_str, http.post("/post_test",post_str).read_body, "HTTP POST failed"
+    end
+  end
+
+  def test_ajax_post
+    Net::HTTP.start("localhost","9997") do |http|
+      post_str = "key=value"
+      post_result = http.post("/post_test", post_str,{"X-Requested-With" => "XMLHttpRequest"}).read_body
+      assert_match post_str, post_result, "HTTP Ajax POST failed"
+    end
+  end
+ 
+  def test_post_redirect
+    Net::HTTP.start("localhost","9997") do |http|
+      post_str = "key=value"
+      res = http.post("/post_redirect_test", post_str)
+      assert_equal Net::HTTPFound, res.class
+      assert_equal "/esi_test_content.html", res["Location"]
+    end
+  end
+
+  def test_get_redirect
+    Net::HTTP.start("localhost","9997") do |http|
+      res = http.get("/post_redirect_test")
+      assert_equal Net::HTTPFound, res.class
+      assert_equal "/esi_test_content.html", res["Location"]
+    end
+  end
+  
+  # test that we're including http headers as part of the request fragment cache
+  def test_ajax_caching
+    # start by making the request using the X-Requested-With Header
+    Net::HTTP.start("localhost", 9997) do |h|
+      req = h.get("/content/ajax_test_page.html", {"X-Requested-With" => "XMLHttpRequest"})
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+			assert_match "XMLHttpRequest", req.body, "Did not get the expected response for Javascript, should see XMLHttpRequest in the response"
+    end
+    # now the content should be cached so make the request again without the javascript header to get the alternate version
+    Net::HTTP.start("localhost", 9997) do |h|
+      req = h.get("/content/ajax_test_page.html")
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+			assert_match "HTTP Request", req.body, "Did not get the expected response for noscript"
+    end
+    # make the ajax request one more time for good measure
+    Net::HTTP.start("localhost", 9997) do |h|
+      req = h.get("/content/ajax_test_page.html", {"X-Requested-With" => "XMLHttpRequest"})
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+			assert_match "XMLHttpRequest", req.body, "Did not get the expected response for Javascript"
+    end
+  end
+
+  # test that if a fragment has a <esi include in it, that response comes back with a rendered module
+  def test_fragment_in_fragment
+    Net::HTTP.start("localhost", 9997) do |h|
+      req = h.get("/content/include_in_include.html")
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+			assert_no_match /<esi:/, req.body, "Result still contains esi includes" # assert there are no esi tags in the result
+			assert_match /<div>test3<\/div>/, req.body, "assert fragment is included"
+			assert_match /<div>test1<\/div>/, req.body, "assert inner fragment is included"
+    end
+  end
+
+  # test whether the cache server alters the markup
+  def test_markup
+    Net::HTTP.start("localhost", 9997) do |h|
+      req = h.get("/content/malformed_transforms.html")
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+      assert_equal File.open("#{DOCROOT}/content/malformed_transforms.html-correct").read, req.body
+    end
+  end
+
+  def test_failing_fragments
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/content/500.html")
+      assert_not_nil res
+      assert_not_nil res.header
+      assert_not_nil res.body
+      assert_equal Net::HTTPOK, res.header.class, res.body
+    end
+  end
+
+  def test_failing_fragments_can_failover
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/content/500_with_failover.html")
+      assert_not_nil res
+      assert_not_nil res.header
+      assert_not_nil res.body
+      assert_equal Net::HTTPOK, res.header.class, res.body
+			assert_match /<div>test1<\/div>/, res.body, "The failover esi include should have been requested"
+    end
+  end
+
+  def test_failing_fragments_can_failover_to_alt_attribute
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/content/500_with_failover_to_alt.html")
+      assert_not_nil res
+      assert_not_nil res.header
+      assert_not_nil res.body
+      assert_equal Net::HTTPOK, res.header.class, res.body
+			assert_match /<div>test1<\/div>/, res.body, "The failover esi include should have been requested"
+    end
+  end
+
+  def test_static_failover
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/content/static-failover.html")
+      assert_not_nil res
+      assert_not_nil res.header
+      assert_not_nil res.body
+      #puts res.body
+      assert_equal Net::HTTPOK, res.header.class, res.body
+			assert_match /<div>test1<\/div>/, res.body, "Normal esi include tags failed"
+			assert_match /<div>test1<\/div>/, res.body, "Normal esi include tags failed"
+			assert_match /<a href="www.akamai.com">www.example.com <\/a>/, res.body, "Static Failover failed"
+    end
+  end
+
+  def test_cookies_proxied
+    Net::HTTP.start("localhost", 9997) do |h|
+      post_str = "key=value"
+      req = h.post("/post_test",post_str)
+      assert_not_nil req
+      assert_not_nil req.header
+      assert_not_nil req.body
+      assert_equal Net::HTTPOK, req.header.class
+      assert_match TEST_COOKIE1, req.header["Set-Cookie"]
+      assert_match TEST_COOKIE2, req.header["Set-Cookie"]
+      assert_match TEST_COOKIE3, req.header["Set-Cookie"]
+    end
+  end
+
+	def test_markup_in_attempt_passed_through
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/content/test3.html")
+      assert_not_nil res
+      assert_not_nil res.header
+      assert_not_nil res.body
+      assert_equal Net::HTTPOK, res.header.class
+			assert_match /<p>Some markup that should not be lost<\/p>/, res.body
+		end
+	end
+	
+	def test_markup_in_except_passed_through
+    # TODO
+	end
+
+  def test_surrogate_control_header
+    # first tell the esi handler to use the surrogate control header
+    $esi_dispatcher.config.config.send(:store,:enable_for_surrogate_only, true)
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/404")
+      assert_not_nil res
+      assert_not_nil res.header
+      assert_not_nil res.body
+      assert_equal Net::HTTPNotFound, res.header.class
+			assert_match /#{$fragment_test1}/, res.body
+		end
+    $esi_dispatcher.config.config.send(:store,:enable_for_surrogate_only, nil)
+ 
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/404-no-surrogate")
+      assert_not_nil res
+      assert_not_nil res.header
+      assert_not_nil res.body
+      assert_equal Net::HTTPNotFound, res.header.class
+			assert_no_match /#{$fragment_test1}/, res.body
+		end
+  end
+
+  def test_invalidation
+    Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/esi_test_content.html")
+      assert_not_nil res
+      assert_not_nil res.header
+      assert_not_nil res.body
+      assert_equal Net::HTTPOK, res.header.class
+			assert_match $fragment_test1, res.body, "Fragment not found"
+			assert_match $fragment_test2, res.body, "Fragment not found"
+    end
+
+    assert cached?( FRAGMENT_TEST1_URI ), "Error Fragment should be cached!"
+    assert cached?( FRAGMENT_TEST2_URI ), "Error Fragment should be cached!"
+ 
+		Net::HTTP.start("localhost", 9997) do |h|
+      res = h.get("/esi_invalidate.html")
+    end
+ 		
+    assert !cached?( FRAGMENT_TEST1_URI ), "Error Fragment 1 should not be cached!"
+    assert !cached?( FRAGMENT_TEST2_URI ), "Error Fragment 2 should not be cached!"
+  end
+
+
+end
+

data/test/integration/help.rb

@@ -0,0 +1,234 @@
+# modified version from mongrel
+#  This code is moving into integration test folder
+$:.unshift File.join(File.dirname(__FILE__), "..", "..", "lib")
+$:.unshift File.join(File.dirname(__FILE__), "..", "..", "ext")
+require 'esi/dispatcher'
+require 'test/unit'
+SERVER_ROOT = "#{File.dirname(__FILE__)}/../../"
+ENV["test"] = "true"
+DOCROOT = "#{File.dirname(__FILE__)}/docs/"
+
+# Either takes a string to do a get request against, or a tuple of [URI, HTTP] where
+# HTTP is some kind of Net::HTTP request object (POST, HEAD, etc.)
+def hit(uris)
+  results = []
+  uris.each do |u|
+    res = nil
+
+    assert_nothing_raised do
+      if u.kind_of? String
+        res = Net::HTTP.get(URI.parse(u))
+      else
+        url = URI.parse(u[0])
+        res = Net::HTTP.new(url.host, url.port).start {|h| h.request(u[1]) }
+      end
+    end
+
+    assert_not_nil res, "Didn't get a response: #{u}"
+    results << res
+  end
+
+  return results
+end
+
+def check_status(results, expecting)
+  results.each do |res|
+    assert(res.kind_of?(expecting), "Didn't get #{expecting}, got: #{res.class}")
+  end
+end
+
+
+class MockRequest
+  def initialize(params={})
+    @params = params
+  end
+  def params
+    @params
+  end
+end
+
+def cached?( uri )
+  $esi_dispatcher.config.cache.get( uri, {} )
+end
+
+require 'singleton'
+
+TEST_COOKIE1 = "s_cc=true; s_sq=%5B%5BB%5D%5D; _session_id=367df8904d23ee48ddac56012b9d509f;".freeze
+TEST_COOKIE2 = "rhg_gsid=83d7e46425b431c6651e2beb3e4fd9e41175970072%3A; cookies_enabled=true;".freeze
+TEST_COOKIE3 = "RTOKEN=dG9kZGZAc2ltb2hlYWx0aC5jb20%3D; rhg_sa=xbSssuHwmP5rohZ0Pcu%2BmaU3bSFU%2Br1eBq4iZgTd%2BbQ%3D; edn=Z%25A16W%25E9F%25D4f%25A5%2522j%255D%25DA%2528%2585%2586; ems=%25F2%25A9%25FBlZ%2594.a%253D%250A%251F%2506%25BD%251B%25BA%25EC; av=13; s_se_sig=dG9kZGZAc2ltb2hlYWx0aC5jb20%253D; rhg_css_to_warn=1175974191515".freeze
+FRAGMENT_TEST1_URI = "http://127.0.0.1:9998/fragments/test1.html".freeze
+FRAGMENT_TEST2_URI = "http://127.0.0.1:9999/content/test2.html".freeze
+
+class PostHandler < Mongrel::HttpHandler
+  include Mongrel::HttpHandlerPlugin
+  def process(request, response)
+    response.start(200,true) do |head,out|
+      head["Set-Cookie"] = TEST_COOKIE1
+      head["Set-Cookie"] = TEST_COOKIE2
+      head["Set-Cookie"] = TEST_COOKIE3
+      out << request.body.read
+    end
+  end
+end
+
+class PostRedirectHandler < Mongrel::HttpHandler
+  include Mongrel::HttpHandlerPlugin
+  def process(request, response)
+    response.start(302,true) do |head,out|
+      head["Location"] = "/esi_test_content.html"
+      out << %Q(<html><body>You are being <a href="/test1.html">redirected</a>.</body></html>)
+    end
+  end
+end
+
+class Basic404Handler < Mongrel::HttpHandler
+  include Mongrel::HttpHandlerPlugin
+  def process(request, response)
+    response.start(404,true) do |head,out|
+      head["Surrogate-Control"] = %q(max-age=0, content="ESI/1.0 ESI-INV/1.0")
+      out << %q(<html><body><esi:include src='/test1.html'/></body></html>)
+    end
+  end
+end
+
+class Basic404HandlerWithoutHeader < Mongrel::HttpHandler
+  include Mongrel::HttpHandlerPlugin
+  def process(request, response)
+    response.start(404,true) do |head,out|
+      #head["Surrogate-Control"] = %q(max-age=0, content="ESI/1.0 ESI-INV/1.0")
+      out << %q(<html><body><esi:include src='/test1.html'/></body></html>)
+    end
+  end
+end
+
+class AjaxCacheHandler < Mongrel::HttpHandler
+  include Mongrel::HttpHandlerPlugin
+  def process(request, response)
+    response.start(200,true) do |head,out|
+      # return hello if requested with 
+      if request.params["HTTP_X_REQUESTED_WITH"] == "XMLHttpRequest"
+        out << "XMLHttpRequest Request"
+      else
+        out << "HTTP Request"
+      end
+    end
+  end
+end
+
+class InvalidateHandler < Mongrel::HttpHandler
+  include Mongrel::HttpHandlerPlugin
+  def process(request, response)
+    response.start(200,true) do |head,out|
+      head["Surrogate-Control"] = %q(max-age=0, content="ESI/1.0 ESI-INV/1.0")
+
+      out << %Q(<html><body>
+      <esi:invalidate output="no">
+           <?xml version="1.0"?>
+           <!DOCTYPE INVALIDATION SYSTEM "internal:///WCSinvalidation.dtd">
+           <INVALIDATION VERSION="WCS-1.1">
+             <OBJECT>
+               <BASICSELECTOR URI="#{FRAGMENT_TEST1_URI}"/>
+               <ACTION REMOVALTTL="0"/>
+               <INFO VALUE="invalidating fragment test 1"/>
+             </OBJECT>
+           </INVALIDATION>
+      </esi:invalidate>
+      <esi:invalidate output="no">
+        <?xml version="1.0"?>
+        <!DOCTYPE INVALIDATION SYSTEM "internal:///WCSinvalidation.dtd">
+        <INVALIDATION VERSION="WCS-1.1">
+          <OBJECT>
+            <BASICSELECTOR URI="#{FRAGMENT_TEST2_URI}"/>
+            <ACTION REMOVALTTL="0"/>
+            <INFO VALUE="invalidating fragment test 2"/>
+          </OBJECT>
+        </INVALIDATION>
+      </esi:invalidate>
+</body></html>)
+    end
+  end
+end
+
+$fragment_test1 = File.open("#{DOCROOT}/test1.html").read
+$fragment_test2 = File.open("#{DOCROOT}/content/test2.html").read
+
+
+
+$esi_dispatcher = ESI::Dispatcher.new(
+  :host => '127.0.0.1',
+  :port => 9997,
+  :cwd => SERVER_ROOT,
+  :log_file => 'log/test.log',
+  :pid_file => 'log/test.pid',
+  :daemon => false,
+  :debug => true,
+  :includes => ["mongrel-esi"],
+  :user => nil,
+  :group => nil,
+  :prefix => '/',
+  :config_file => nil, 
+  :routing => [{:host => '127.0.0.1', :port => '9999', :match_url => '^\/(content|samples|extra|get_test).*'},
+               {:host => '127.0.0.1', :port => '9998', :match_url => 'default'}],
+  :cache => 'ruby',
+  :cache_options => {:servers => ['localhost:11211'], :debug => false, :namespace => 'mesi', :readyonly => false},
+  :allowed_content_types => ['text/plain', 'text/html'],
+  :enable_for_surrogate_only => false,
+  :invalidator => false
+)
+
+# allow access to the internal parser
+class ESI::Handler
+  attr_reader :parser
+end
+
+module ESI
+  class Server
+    include Singleton
+
+    CONFIG = [
+      { :host_port => { :host => '127.0.0.1', :port => 9999 },
+        :handlers => [
+          { :uri => '/', :handler => Mongrel::DirHandler.new(DOCROOT) },
+          { :uri => '/get_test', :handler => AjaxCacheHandler.new(DOCROOT) }
+        ]
+      },
+      { :host_port => { :host => '127.0.0.1', :port => 9998 },
+        :handlers => [
+          { :uri => "/", :handler => Mongrel::DirHandler.new(DOCROOT) },
+          { :uri => "/fragments/", :handler => Mongrel::DirHandler.new(DOCROOT) },
+          { :uri => '/post_test', :handler => PostHandler.new },
+          { :uri => '/post_redirect_test', :handler => PostRedirectHandler.new },
+          { :uri => '/404', :handler => Basic404Handler.new },
+          { :uri => '/404-no-surrogate', :handler => Basic404HandlerWithoutHeader.new },
+          { :uri => '/invalidate', :handler => InvalidateHandler.new }
+        ]
+      },
+      { :host_port => { :host => '127.0.0.1', :port => 9997 },
+        :handlers => [
+          { :uri => "/", :handler => $esi_dispatcher }
+        ]
+      }
+    ]
+
+    def self.start
+      ESI::Server.instance
+    end
+
+    def initialize
+      @servers = CONFIG.collect do|conf|
+        Mongrel::Configurator.new conf[:host_port] do
+          listener do
+            conf[:handlers].each do|handler|
+              uri handler[:uri], :handler => handler[:handler]
+            end
+          end
+        end
+      end
+
+      @servers.each { |server| server.run }
+      at_exit do 
+        @servers.each { |server| server.stop }
+      end
+    end
+  end
+end