require 'fileutils' require 'abstract_unit' require 'active_record_unit' CACHE_DIR = 'test_cache' # Don't change '/../temp/' cavalierly or you might hose something you don't want hosed FILE_STORE_PATH = File.join(File.dirname(__FILE__), '/../temp/', CACHE_DIR) ActionController::Base.page_cache_directory = FILE_STORE_PATH class CachingController < ActionController::Base abstract! self.cache_store = :file_store, FILE_STORE_PATH end class PageCachingTestController < CachingController self.page_cache_compression = :best_compression caches_page :ok, :no_content, :if => Proc.new { |c| !c.request.format.json? } caches_page :found, :not_found caches_page :about_me caches_page :default_gzip caches_page :no_gzip, :gzip => false caches_page :gzip_level, :gzip => :best_speed def ok head :ok end def no_content head :no_content end def found redirect_to :action => 'ok' end def not_found head :not_found end def custom_path render :text => "Super soaker" cache_page("Super soaker", "/index.html") end def default_gzip render :text => "Text" end def no_gzip render :text => "PNG" end def gzip_level render :text => "Big text" end def expire_custom_path expire_page("/index.html") head :ok end def trailing_slash render :text => "Sneak attack" end def about_me respond_to do |format| format.html {render :text => 'I am html'} format.xml {render :text => 'I am xml'} end end end class PageCachingTest < ActionController::TestCase def setup super @request = ActionController::TestRequest.new @request.host = 'hostname.com' @request.env.delete('PATH_INFO') @controller = PageCachingTestController.new @controller.perform_caching = true @controller.cache_store = :file_store, FILE_STORE_PATH @response = ActionController::TestResponse.new @params = {:controller => 'posts', :action => 'index', :only_path => true} FileUtils.rm_rf(File.dirname(FILE_STORE_PATH)) FileUtils.mkdir_p(FILE_STORE_PATH) end def teardown FileUtils.rm_rf(File.dirname(FILE_STORE_PATH)) @controller.perform_caching = false end def test_page_caching_resources_saves_to_correct_path_with_extension_even_if_default_route with_routing do |set| set.draw do get 'posts.:format', :to => 'posts#index', :as => :formatted_posts get '/', :to => 'posts#index', :as => :main end @params[:format] = 'rss' assert_equal '/posts.rss', @routes.url_for(@params) @params[:format] = nil assert_equal '/', @routes.url_for(@params) end end def test_should_cache_get_with_ok_status get :ok assert_response :ok assert_page_cached :ok, "get with ok status should have been cached" end def test_should_cache_with_custom_path get :custom_path assert File.exist?("#{FILE_STORE_PATH}/index.html") end def test_should_expire_cache_with_custom_path get :custom_path assert File.exist?("#{FILE_STORE_PATH}/index.html") get :expire_custom_path assert !File.exist?("#{FILE_STORE_PATH}/index.html") end def test_should_gzip_cache get :custom_path assert File.exist?("#{FILE_STORE_PATH}/index.html.gz") get :expire_custom_path assert !File.exist?("#{FILE_STORE_PATH}/index.html.gz") end def test_should_allow_to_disable_gzip get :no_gzip assert File.exist?("#{FILE_STORE_PATH}/page_caching_test/no_gzip.html") assert !File.exist?("#{FILE_STORE_PATH}/page_caching_test/no_gzip.html.gz") end def test_should_use_config_gzip_by_default @controller.expects(:cache_page).with(nil, nil, Zlib::BEST_COMPRESSION) get :default_gzip end def test_should_set_gzip_level @controller.expects(:cache_page).with(nil, nil, Zlib::BEST_SPEED) get :gzip_level end def test_should_cache_without_trailing_slash_on_url @controller.class.cache_page 'cached content', '/page_caching_test/trailing_slash' assert File.exist?("#{FILE_STORE_PATH}/page_caching_test/trailing_slash.html") end def test_should_obey_http_accept_attribute @request.env['HTTP_ACCEPT'] = 'text/xml' get :about_me assert File.exist?("#{FILE_STORE_PATH}/page_caching_test/about_me.xml") assert_equal 'I am xml', @response.body end def test_cached_page_should_not_have_trailing_slash_even_if_url_has_trailing_slash @controller.class.cache_page 'cached content', '/page_caching_test/trailing_slash/' assert File.exist?("#{FILE_STORE_PATH}/page_caching_test/trailing_slash.html") end def test_should_cache_ok_at_custom_path @request.env['PATH_INFO'] = '/index.html' get :ok assert_response :ok assert File.exist?("#{FILE_STORE_PATH}/index.html") end [:ok, :no_content, :found, :not_found].each do |status| [:get, :post, :patch, :put, :delete].each do |method| unless method == :get && status == :ok define_method "test_shouldnt_cache_#{method}_with_#{status}_status" do send(method, status) assert_response status assert_page_not_cached status, "#{method} with #{status} status shouldn't have been cached" end end end end def test_page_caching_conditional_options get :ok, :format=>'json' assert_page_not_cached :ok end def test_page_caching_directory_set_as_pathname begin ActionController::Base.page_cache_directory = Pathname.new(FILE_STORE_PATH) get :ok assert_response :ok assert_page_cached :ok ensure ActionController::Base.page_cache_directory = FILE_STORE_PATH end end private def assert_page_cached(action, message = "#{action} should have been cached") assert page_cached?(action), message end def assert_page_not_cached(action, message = "#{action} shouldn't have been cached") assert !page_cached?(action), message end def page_cached?(action) File.exist? "#{FILE_STORE_PATH}/page_caching_test/#{action}.html" end end class ActionCachingTestController < CachingController rescue_from(Exception) { head 500 } rescue_from(ActionController::UnknownFormat) { head :not_acceptable } if defined? ActiveRecord rescue_from(ActiveRecord::RecordNotFound) { head :not_found } end # Eliminate uninitialized ivar warning before_filter { @title = nil } caches_action :index, :redirected, :forbidden, :if => Proc.new { |c| c.request.format && !c.request.format.json? }, :expires_in => 1.hour caches_action :show, :cache_path => 'http://test.host/custom/show' caches_action :edit, :cache_path => Proc.new { |c| c.params[:id] ? "http://test.host/#{c.params[:id]};edit" : "http://test.host/edit" } caches_action :with_layout caches_action :with_format_and_http_param, :cache_path => Proc.new { |c| { :key => 'value' } } caches_action :layout_false, :layout => false caches_action :with_layout_proc_param, :layout => Proc.new { |c| c.params[:layout] } caches_action :record_not_found, :four_oh_four, :simple_runtime_error caches_action :streaming caches_action :invalid layout 'talk_from_action' def index @cache_this = MockTime.now.to_f.to_s render :text => @cache_this end def redirected redirect_to :action => 'index' end def forbidden render :text => "Forbidden" response.status = "403 Forbidden" end def with_layout @cache_this = MockTime.now.to_f.to_s @title = nil render :text => @cache_this, :layout => true end def with_format_and_http_param @cache_this = MockTime.now.to_f.to_s render :text => @cache_this end def record_not_found raise ActiveRecord::RecordNotFound, "oops!" end def four_oh_four render :text => "404'd!", :status => 404 end def simple_runtime_error raise "oops!" end alias_method :show, :index alias_method :edit, :index alias_method :destroy, :index alias_method :layout_false, :with_layout alias_method :with_layout_proc_param, :with_layout def expire expire_action :controller => 'action_caching_test', :action => 'index' render :nothing => true end def expire_xml expire_action :controller => 'action_caching_test', :action => 'index', :format => 'xml' render :nothing => true end def expire_with_url_string expire_action url_for(:controller => 'action_caching_test', :action => 'index') render :nothing => true end def streaming render :text => "streaming", :stream => true end def invalid @cache_this = MockTime.now.to_f.to_s respond_to do |format| format.json{ render :json => @cache_this } end end end class MockTime < Time # Let Time spicy to assure that Time.now != Time.now def to_f super+rand end end class ActionCachingMockController attr_accessor :mock_url_for attr_accessor :mock_path def initialize yield self if block_given? end def url_for(*args) @mock_url_for end def params request.parameters end def request Object.new.instance_eval(<<-EVAL) def path; '#{@mock_path}' end def format; 'all' end def parameters; {:format => nil}; end self EVAL end end class ActionCacheTest < ActionController::TestCase tests ActionCachingTestController def setup super @request.host = 'hostname.com' FileUtils.mkdir_p(FILE_STORE_PATH) @path_class = ActionController::Caching::Actions::ActionCachePath @mock_controller = ActionCachingMockController.new end def teardown super FileUtils.rm_rf(File.dirname(FILE_STORE_PATH)) end def test_simple_action_cache get :index assert_response :success cached_time = content_to_cache assert_equal cached_time, @response.body assert fragment_exist?('hostname.com/action_caching_test') get :index assert_response :success assert_equal cached_time, @response.body end def test_simple_action_not_cached get :destroy assert_response :success cached_time = content_to_cache assert_equal cached_time, @response.body assert !fragment_exist?('hostname.com/action_caching_test/destroy') get :destroy assert_response :success assert_not_equal cached_time, @response.body end include RackTestUtils def test_action_cache_with_layout get :with_layout assert_response :success cached_time = content_to_cache assert_not_equal cached_time, @response.body assert fragment_exist?('hostname.com/action_caching_test/with_layout') get :with_layout assert_response :success assert_not_equal cached_time, @response.body body = body_to_string(read_fragment('hostname.com/action_caching_test/with_layout')) assert_equal @response.body, body end def test_action_cache_with_layout_and_layout_cache_false get :layout_false assert_response :success cached_time = content_to_cache assert_not_equal cached_time, @response.body assert fragment_exist?('hostname.com/action_caching_test/layout_false') get :layout_false assert_response :success assert_not_equal cached_time, @response.body body = body_to_string(read_fragment('hostname.com/action_caching_test/layout_false')) assert_equal cached_time, body end def test_action_cache_with_layout_and_layout_cache_false_via_proc get :with_layout_proc_param, :layout => false assert_response :success cached_time = content_to_cache assert_not_equal cached_time, @response.body assert fragment_exist?('hostname.com/action_caching_test/with_layout_proc_param') get :with_layout_proc_param, :layout => false assert_response :success assert_not_equal cached_time, @response.body body = body_to_string(read_fragment('hostname.com/action_caching_test/with_layout_proc_param')) assert_equal cached_time, body end def test_action_cache_with_layout_and_layout_cache_true_via_proc get :with_layout_proc_param, :layout => true assert_response :success cached_time = content_to_cache assert_not_equal cached_time, @response.body assert fragment_exist?('hostname.com/action_caching_test/with_layout_proc_param') get :with_layout_proc_param, :layout => true assert_response :success assert_not_equal cached_time, @response.body body = body_to_string(read_fragment('hostname.com/action_caching_test/with_layout_proc_param')) assert_equal @response.body, body end def test_action_cache_conditional_options @request.env['HTTP_ACCEPT'] = 'application/json' get :index assert_response :success assert !fragment_exist?('hostname.com/action_caching_test') end def test_action_cache_with_format_and_http_param get :with_format_and_http_param, :format => 'json' assert_response :success assert !fragment_exist?('hostname.com/action_caching_test/with_format_and_http_param.json?key=value.json') assert fragment_exist?('hostname.com/action_caching_test/with_format_and_http_param.json?key=value') end def test_action_cache_with_store_options MockTime.expects(:now).returns(12345).once @controller.expects(:read_fragment).with('hostname.com/action_caching_test', :expires_in => 1.hour).once @controller.expects(:write_fragment).with('hostname.com/action_caching_test', '12345.0', :expires_in => 1.hour).once get :index assert_response :success end def test_action_cache_with_custom_cache_path get :show assert_response :success cached_time = content_to_cache assert_equal cached_time, @response.body assert fragment_exist?('test.host/custom/show') get :show assert_response :success assert_equal cached_time, @response.body end def test_action_cache_with_custom_cache_path_in_block get :edit assert_response :success assert fragment_exist?('test.host/edit') get :edit, :id => 1 assert_response :success assert fragment_exist?('test.host/1;edit') end def test_cache_expiration get :index assert_response :success cached_time = content_to_cache get :index assert_response :success assert_equal cached_time, @response.body get :expire assert_response :success get :index assert_response :success new_cached_time = content_to_cache assert_not_equal cached_time, @response.body get :index assert_response :success assert_equal new_cached_time, @response.body end def test_cache_expiration_isnt_affected_by_request_format get :index cached_time = content_to_cache @request.request_uri = "/action_caching_test/expire.xml" get :expire, :format => :xml assert_response :success get :index assert_response :success assert_not_equal cached_time, @response.body end def test_cache_expiration_with_url_string get :index cached_time = content_to_cache @request.request_uri = "/action_caching_test/expire_with_url_string" get :expire_with_url_string assert_response :success get :index assert_response :success assert_not_equal cached_time, @response.body end def test_cache_is_scoped_by_subdomain @request.host = 'jamis.hostname.com' get :index assert_response :success jamis_cache = content_to_cache @request.host = 'david.hostname.com' get :index assert_response :success david_cache = content_to_cache assert_not_equal jamis_cache, @response.body @request.host = 'jamis.hostname.com' get :index assert_response :success assert_equal jamis_cache, @response.body @request.host = 'david.hostname.com' get :index assert_response :success assert_equal david_cache, @response.body end def test_redirect_is_not_cached get :redirected assert_response :redirect get :redirected assert_response :redirect end def test_forbidden_is_not_cached get :forbidden assert_response :forbidden get :forbidden assert_response :forbidden end def test_xml_version_of_resource_is_treated_as_different_cache with_routing do |set| set.draw do get ':controller(/:action(.:format))' end get :index, :format => 'xml' assert_response :success cached_time = content_to_cache assert_equal cached_time, @response.body assert fragment_exist?('hostname.com/action_caching_test/index.xml') get :index, :format => 'xml' assert_response :success assert_equal cached_time, @response.body assert_equal 'application/xml', @response.content_type get :expire_xml assert_response :success get :index, :format => 'xml' assert_response :success assert_not_equal cached_time, @response.body end end def test_correct_content_type_is_returned_for_cache_hit # run it twice to cache it the first time get :index, :id => 'content-type', :format => 'xml' get :index, :id => 'content-type', :format => 'xml' assert_response :success assert_equal 'application/xml', @response.content_type end def test_correct_content_type_is_returned_for_cache_hit_on_action_with_string_key # run it twice to cache it the first time get :show, :format => 'xml' get :show, :format => 'xml' assert_response :success assert_equal 'application/xml', @response.content_type end def test_correct_content_type_is_returned_for_cache_hit_on_action_with_string_key_from_proc # run it twice to cache it the first time get :edit, :id => 1, :format => 'xml' get :edit, :id => 1, :format => 'xml' assert_response :success assert_equal 'application/xml', @response.content_type end def test_empty_path_is_normalized @mock_controller.mock_url_for = 'http://example.org/' @mock_controller.mock_path = '/' assert_equal 'example.org/index', @path_class.new(@mock_controller, {}).path end def test_file_extensions get :index, :id => 'kitten.jpg' get :index, :id => 'kitten.jpg' assert_response :success end if defined? ActiveRecord def test_record_not_found_returns_404_for_multiple_requests get :record_not_found assert_response 404 get :record_not_found assert_response 404 end end def test_four_oh_four_returns_404_for_multiple_requests get :four_oh_four assert_response 404 get :four_oh_four assert_response 404 end def test_four_oh_four_renders_content get :four_oh_four assert_equal "404'd!", @response.body end def test_simple_runtime_error_returns_500_for_multiple_requests get :simple_runtime_error assert_response 500 get :simple_runtime_error assert_response 500 end def test_action_caching_plus_streaming get :streaming assert_response :success assert_match(/streaming/, @response.body) assert fragment_exist?('hostname.com/action_caching_test/streaming') end def test_invalid_format_returns_not_acceptable get :invalid, :format => "json" assert_response :success cached_time = content_to_cache assert_equal cached_time, @response.body assert fragment_exist?("hostname.com/action_caching_test/invalid.json") get :invalid, :format => "json" assert_response :success assert_equal cached_time, @response.body get :invalid, :format => "xml" assert_response :not_acceptable get :invalid, :format => "\xC3\x83" assert_response :not_acceptable end private def content_to_cache assigns(:cache_this) end def fragment_exist?(path) @controller.fragment_exist?(path) end def read_fragment(path) @controller.read_fragment(path) end end class FragmentCachingTestController < CachingController def some_action; end; end class FragmentCachingTest < ActionController::TestCase def setup super @store = ActiveSupport::Cache::MemoryStore.new @controller = FragmentCachingTestController.new @controller.perform_caching = true @controller.cache_store = @store @params = {:controller => 'posts', :action => 'index'} @request = ActionController::TestRequest.new @response = ActionController::TestResponse.new @controller.params = @params @controller.request = @request @controller.response = @response end def test_fragment_cache_key assert_equal 'views/what a key', @controller.fragment_cache_key('what a key') assert_equal "views/test.host/fragment_caching_test/some_action", @controller.fragment_cache_key(:controller => 'fragment_caching_test',:action => 'some_action') end def test_read_fragment_with_caching_enabled @store.write('views/name', 'value') assert_equal 'value', @controller.read_fragment('name') end def test_read_fragment_with_caching_disabled @controller.perform_caching = false @store.write('views/name', 'value') assert_nil @controller.read_fragment('name') end def test_fragment_exist_with_caching_enabled @store.write('views/name', 'value') assert @controller.fragment_exist?('name') assert !@controller.fragment_exist?('other_name') end def test_fragment_exist_with_caching_disabled @controller.perform_caching = false @store.write('views/name', 'value') assert !@controller.fragment_exist?('name') assert !@controller.fragment_exist?('other_name') end def test_write_fragment_with_caching_enabled assert_nil @store.read('views/name') assert_equal 'value', @controller.write_fragment('name', 'value') assert_equal 'value', @store.read('views/name') end def test_write_fragment_with_caching_disabled assert_nil @store.read('views/name') @controller.perform_caching = false assert_equal 'value', @controller.write_fragment('name', 'value') assert_nil @store.read('views/name') end def test_expire_fragment_with_simple_key @store.write('views/name', 'value') @controller.expire_fragment 'name' assert_nil @store.read('views/name') end def test_expire_fragment_with_regexp @store.write('views/name', 'value') @store.write('views/another_name', 'another_value') @store.write('views/primalgrasp', 'will not expire ;-)') @controller.expire_fragment(/name/) assert_nil @store.read('views/name') assert_nil @store.read('views/another_name') assert_equal 'will not expire ;-)', @store.read('views/primalgrasp') end def test_fragment_for @store.write('views/expensive', 'fragment content') fragment_computed = false view_context = @controller.view_context buffer = 'generated till now -> '.html_safe buffer << view_context.send(:fragment_for, 'expensive') { fragment_computed = true } assert !fragment_computed assert_equal 'generated till now -> fragment content', buffer end def test_html_safety assert_nil @store.read('views/name') content = 'value'.html_safe assert_equal content, @controller.write_fragment('name', content) cached = @store.read('views/name') assert_equal content, cached assert_equal String, cached.class html_safe = @controller.read_fragment('name') assert_equal content, html_safe assert html_safe.html_safe? end end class FunctionalCachingController < CachingController def fragment_cached end def html_fragment_cached_with_partial respond_to do |format| format.html end end def formatted_fragment_cached respond_to do |format| format.html format.xml end end end class FunctionalFragmentCachingTest < ActionController::TestCase def setup super @store = ActiveSupport::Cache::MemoryStore.new @controller = FunctionalCachingController.new @controller.perform_caching = true @controller.cache_store = @store @request = ActionController::TestRequest.new @response = ActionController::TestResponse.new end def test_fragment_caching get :fragment_cached assert_response :success expected_body = <<-CACHED Hello This bit's fragment cached Ciao CACHED assert_equal expected_body, @response.body assert_equal "This bit's fragment cached", @store.read("views/test.host/functional_caching/fragment_cached/#{template_digest("functional_caching/fragment_cached", "html")}") end def test_fragment_caching_in_partials get :html_fragment_cached_with_partial assert_response :success assert_match(/Old fragment caching in a partial/, @response.body) assert_match("Old fragment caching in a partial", @store.read("views/test.host/functional_caching/html_fragment_cached_with_partial/#{template_digest("functional_caching/_partial", "html")}")) end def test_render_inline_before_fragment_caching get :inline_fragment_cached assert_response :success assert_match(/Some inline content/, @response.body) assert_match(/Some cached content/, @response.body) assert_match("Some cached content", @store.read("views/test.host/functional_caching/inline_fragment_cached/#{template_digest("functional_caching/inline_fragment_cached", "html")}")) end def test_html_formatted_fragment_caching get :formatted_fragment_cached, :format => "html" assert_response :success expected_body = "\n

ERB

\n\n" assert_equal expected_body, @response.body assert_equal "

ERB

", @store.read("views/test.host/functional_caching/formatted_fragment_cached/#{template_digest("functional_caching/formatted_fragment_cached", "html")}") end def test_xml_formatted_fragment_caching get :formatted_fragment_cached, :format => "xml" assert_response :success expected_body = "\n

Builder

\n\n" assert_equal expected_body, @response.body assert_equal "

Builder

\n", @store.read("views/test.host/functional_caching/formatted_fragment_cached/#{template_digest("functional_caching/formatted_fragment_cached", "xml")}") end private def template_digest(name, format) ActionView::Digestor.digest(name, format, @controller.lookup_context) end end class CacheHelperOutputBufferTest < ActionController::TestCase class MockController def read_fragment(name, options) return false end def write_fragment(name, fragment, options) fragment end end def setup super end def test_output_buffer output_buffer = ActionView::OutputBuffer.new controller = MockController.new cache_helper = Object.new cache_helper.extend(ActionView::Helpers::CacheHelper) cache_helper.expects(:controller).returns(controller).at_least(0) cache_helper.expects(:output_buffer).returns(output_buffer).at_least(0) # if the output_buffer is changed, the new one should be html_safe and of the same type cache_helper.expects(:output_buffer=).with(responds_with(:html_safe?, true)).with(instance_of(output_buffer.class)).at_least(0) assert_nothing_raised do cache_helper.send :fragment_for, 'Test fragment name', 'Test fragment', &Proc.new{ nil } end end def test_safe_buffer output_buffer = ActiveSupport::SafeBuffer.new controller = MockController.new cache_helper = Object.new cache_helper.extend(ActionView::Helpers::CacheHelper) cache_helper.expects(:controller).returns(controller).at_least(0) cache_helper.expects(:output_buffer).returns(output_buffer).at_least(0) # if the output_buffer is changed, the new one should be html_safe and of the same type cache_helper.expects(:output_buffer=).with(responds_with(:html_safe?, true)).with(instance_of(output_buffer.class)).at_least(0) assert_nothing_raised do cache_helper.send :fragment_for, 'Test fragment name', 'Test fragment', &Proc.new{ nil } end end end