lacquer 0.4.0 → 0.6.6

data/spec/lacquer/cache_control_spec.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+require 'lacquer/cache_control'
+
+describe Lacquer::CacheControl do
+  describe "#register" do
+    it "persists cache settings for url" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/class_sections/%s.*$", :args => "[0-9]+"
+      cache_control.store.first[:group].should  == :class_section
+      cache_control.store.first[:url].should    == "^/sv/class_sections/%s.*$"
+      cache_control.store.first[:args].should   == ["[0-9]+"]
+    end
+  end
+
+  describe "#urls_for" do
+    it "returns urls to expire for object" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/class_sections/%s.*$", :args => "[0-9]+"
+      cache_control.urls_for(:class_section, double("ClassSection", :to_param => 1)).should == ["^/sv/class_sections/1.*$"]
+    end
+  end
+
+  context "vcl" do
+    it "returns all urls as vcl conditions" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/class_sections/%s.*$", :args => "[0-9]+"
+      cache_control.register :class_section, :url => "^/sv/info_screens/%s.*$", :args => "[0-9]+"
+
+      conditions = cache_control.to_vcl_conditions
+      conditions.should include("req.url ~ \"^/sv/class_sections/[0-9]+.*$\"")
+      conditions.should include("||")
+      conditions.should include("req.url ~ \"^/sv/info_screens/[0-9]+.*$\"")
+    end
+
+    it "returns vcl for pass urls" do
+      cache_control = described_class.new
+      cache_control.register :pass, :url => "^/admin"
+      pass_urls = cache_control.to_vcl_pass_urls
+      pass_urls.should include('if(req.url ~ "^/admin")')
+      pass_urls.should include('return(pass)')
+    end
+
+    it "returns vcl for pipe urls" do
+      cache_control = described_class.new
+      cache_control.register :pipe, :url => "*.mp4$"
+      pass_urls = cache_control.to_vcl_pipe_urls
+      pass_urls.should include('if(req.url ~ "*.mp4$")')
+      pass_urls.should include('return(pipe)')
+    end
+
+    it "returns vcl for override ttl on beresp" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/competitions$", :expires_in => "7d"
+      override_ttl = cache_control.to_vcl_override_ttl_urls
+      override_ttl.should include('if(req.url ~ "^/sv/competitions$")')
+      override_ttl.should include('unset beresp.http.Set-Cookie')
+      override_ttl.should include('return(deliver)')
+    end
+
+    it "group by expires in" do
+      cache_control = described_class.new
+      cache_control.register :class_section, :url => "^/sv/competitions$", :expires_in => "1d"
+      cache_control.register :class_section, :url => "^/sv/competitions/%s$", :args => "[0-9]+", :expires_in => "2d"
+      cache_control.register :class_section, :url => "^/sv/competitions/%s/info_screen$", :args => "[0-9]+"
+
+      override_ttl = cache_control.to_vcl_override_ttl_urls
+      override_ttl.should include('if(req.url ~ "^/sv/competitions$")')
+      override_ttl.should include('set beresp.ttl = 1d')
+      override_ttl.should include('if(req.url ~ "^/sv/competitions/[0-9]+$")')
+      override_ttl.should include('set beresp.ttl = 2d')
+      override_ttl.should_not include('info_screen')
+    end
+  end
+end

data/spec/lacquer/cache_utils_spec.rb

@@ -1,4 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+require 'lacquer/delayed_job_job'
+require 'lacquer/resque_job'
+require 'lacquer/sidekiq_worker'
 
 describe "Lacquer" do
   before(:each) do
@@ -7,8 +10,8 @@ describe "Lacquer" do
 
   describe "talking to varnish" do
     before(:each) do
-      @varnish_stub = mock('varnish')
-      Lacquer::Varnish.stub!(:new).and_return(@varnish_stub)
+      @varnish_stub = double('varnish')
+      Lacquer::Varnish.stub(:new).and_return(@varnish_stub)
     end
 
     describe "when backend is :none" do
@@ -17,7 +20,7 @@ describe "Lacquer" do
       end
 
       it "sends commands to varnish instantly" do
-        @varnish_stub.should_receive(:purge).twice
+        @varnish_stub.should_receive(:purge).with('/', '/blog/posts').once
         @controller.clear_cache_for('/', '/blog/posts')
       end
 
@@ -30,8 +33,8 @@ describe "Lacquer" do
     describe "when backend is :delayed_job" do
       it "sends commands to a delayed_job queue" do
         Lacquer.configuration.job_backend = :delayed_job
-
-        Delayed::Job.should_receive(:enqueue).twice
+        Lacquer::DelayedJobJob.should_receive(:new).with(['/', '/blog/posts'])
+        Delayed::Job.should_receive(:enqueue).once
         @controller.clear_cache_for('/', '/blog/posts')
       end
     end
@@ -40,7 +43,16 @@ describe "Lacquer" do
       it "sends commands to a resque queue" do
         Lacquer.configuration.job_backend = :resque
 
-        Resque.should_receive(:enqueue).twice
+        Resque.should_receive(:enqueue).once
+        @controller.clear_cache_for('/', '/blog/posts')
+      end
+    end
+
+    describe "when backend is :sidekiq" do
+      it "sends commands to a sidekiq queue" do
+        Lacquer.configuration.job_backend = :sidekiq
+
+        Lacquer::SidekiqWorker.should_receive(:perform_async).once
         @controller.clear_cache_for('/', '/blog/posts')
       end
     end
@@ -70,8 +82,8 @@ describe "Lacquer" do
   end
 
   it "should allow purge by non-controller sweepers" do
-    @varnish_stub = mock('varnish')
-    Lacquer::Varnish.stub!(:new).and_return(@varnish_stub)
+    @varnish_stub = double('varnish')
+    Lacquer::Varnish.stub(:new).and_return(@varnish_stub)
 
     @sweeper = SweeperClass.new
 

data/spec/lacquer/delayed_job_job_spec.rb

@@ -3,8 +3,10 @@ require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 describe "DelayedJobJob" do
   describe "perform" do
     it "should purge the parameter" do
-      @varnish_mock = mock('varnish')
-      Lacquer::Varnish.stub!(:new).and_return(@varnish_mock)
+      require File.expand_path('lib/lacquer/delayed_job_job')
+
+      @varnish_mock = double('varnish')
+      Lacquer::Varnish.stub(:new).and_return(@varnish_mock)
 
       @varnish_mock.should_receive(:purge).with('/').exactly(1).times
       Lacquer::DelayedJobJob.new('/').perform

data/spec/lacquer/resque_job_spec.rb

@@ -3,8 +3,10 @@ require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 describe "ResqueJob" do
   describe "perform" do
     it "should purge the parameter" do
-      @varnish_mock = mock('varnish')
-      Lacquer::Varnish.stub!(:new).and_return(@varnish_mock)
+      require File.expand_path('lib/lacquer/resque_job')
+
+      @varnish_mock = double('varnish')
+      Lacquer::Varnish.stub(:new).and_return(@varnish_mock)
 
       @varnish_mock.should_receive(:purge).with('/').exactly(1).times
       Lacquer::ResqueJob.perform('/')

data/spec/lacquer/sidekiq_worker_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "SidekiqWorker" do
+  describe "perform" do
+    it "should purge the parameter" do
+      require File.expand_path('lib/lacquer/sidekiq_worker')
+
+      @varnish_mock = double('varnish')
+      Lacquer::Varnish.stub(:new).and_return(@varnish_mock)
+
+      @varnish_mock.should_receive(:purge).with('/').exactly(1).times
+      Lacquer::SidekiqWorker.new.perform('/')
+    end
+  end
+end

data/spec/lacquer/varnish_spec.rb

@@ -2,30 +2,30 @@ require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 
 describe "Varnish" do
   before(:each) do
-    @telnet_mock = mock('Net::Telnet')
-    Net::Telnet.stub!(:new).and_return(@telnet_mock)
-    @telnet_mock.stub!(:close)
-    @telnet_mock.stub!(:cmd)    
-    @telnet_mock.stub!(:puts)
-    @telnet_mock.stub!(:waitfor)
+    @telnet_mock = double('Net::Telnet')
+    Net::Telnet.stub(:new).and_return(@telnet_mock)
+    @telnet_mock.stub(:close)
+    @telnet_mock.stub(:cmd)
+    @telnet_mock.stub(:puts)
+    @telnet_mock.stub(:waitfor)
     Lacquer.configuration.retries.should == 5
   end
 
   describe "with any command" do
     describe "when connection is unsuccessful" do
       it "should raise a Lacquer::VarnishError" do
-        @telnet_mock.stub!(:cmd).and_raise(Timeout::Error)
-        lambda {
+        @telnet_mock.stub(:cmd).and_raise(Timeout::Error)
+        expect {
           Lacquer::Varnish.new.purge('/')
-        }.should raise_error(Lacquer::VarnishError)
+        }.to raise_error(Lacquer::VarnishError)
       end
 
       it "should retry on failure before erroring" do
-        @telnet_mock.stub!(:cmd).and_raise(Timeout::Error)
+        @telnet_mock.stub(:cmd).and_raise(Timeout::Error)
         Net::Telnet.should_receive(:new).exactly(5).times
-        lambda {
+        expect {
           Lacquer::Varnish.new.purge('/')
-        }.should raise_error(Lacquer::VarnishError)
+        }.to raise_error(Lacquer::VarnishError)
       end
 
       it "should close the connection afterwards" do
@@ -34,23 +34,67 @@ describe "Varnish" do
       end
     end
 
+    describe "when using authentication" do
+      after(:each) do
+        Lacquer.configuration.varnish_servers.first[:secret] = nil
+      end
+      describe "with correct secret" do
+        before(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = "the real secret"
+        end
+
+        it "should return successfully when using correct secret" do
+          @telnet_mock.stub(:waitfor).with("Match" => /^107/).and_yield("107 59      \nhaalpffwlcvblmdrinpnjwigwsbiiigq\n\nAuthentication required.\n\n")
+          @telnet_mock.stub(:cmd).with("String" => "auth a4aefcde4b0ee27268af1c9ed613e3220601276b48f9ae5914f801db6c8ef612", "Match" => /\d{3}/).and_yield('200')
+          @telnet_mock.stub(:cmd).with("String" => "url.purge /", "Match" => /\n\n/).and_yield('200')
+
+          expect {
+            Lacquer::Varnish.new.purge('/')
+          }.not_to raise_error
+        end
+
+        after(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = nil
+        end
+      end
+
+      describe "with wrong secret" do
+        before(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = "the wrong secret"
+        end
+        it "should raise Lacquer::AuthenticationError when using wrong secret" do
+          @telnet_mock.stub(:waitfor).with("Match" => /^107/).and_yield("107 59      \nhaalpffwlcvblmdrinpnjwigwsbiiigq\n\nAuthentication required.\n\n")
+          @telnet_mock.stub(:cmd).with("String" => "auth 767dc6ec9eca6e4155d20c8479d3a1a10cf88d92c3846388a830d7fd966d58f9", "Match" => /\d{3}/).and_yield('107')
+          @telnet_mock.stub(:cmd).with("url.purge /").and_yield('200')
+
+          expect {
+            Lacquer::Varnish.new.purge('/')
+          }.to raise_error(Lacquer::AuthenticationError)
+        end
+        after(:each) do
+          Lacquer.configuration.varnish_servers.first[:secret] = nil
+        end
+      end
+    end
+
     describe "when connection is unsuccessful and an error handler is set" do
       before(:each) do
-        Lacquer.configuration.command_error_handler = mock("command_error_handler")
+        Lacquer.configuration.command_error_handler = double("command_error_handler")
       end
       it "should call handler on error" do
-        @telnet_mock.stub!(:cmd).and_raise(Timeout::Error)
+        @telnet_mock.stub(:cmd).and_raise(Timeout::Error)
         Lacquer.configuration.command_error_handler.should_receive(:call).exactly(1).times
-        lambda {
+        expect {
           Lacquer::Varnish.new.purge('/')
-        }.should_not raise_error(Lacquer::VarnishError)
+        }.not_to raise_error
       end
     end
+
   end
 
   describe "when sending a stats command" do
     it "should return an array of stats" do
-      @telnet_mock.stub!(:cmd).and_yield(%Q[
+      @telnet_mock.stub(:cmd).and_yield(%Q[
 200 2023
      6263596  Client connections accepted
      6260911  Client requests received
@@ -125,7 +169,7 @@ Closing CLI connection
 
   describe "when sending a purge command" do 
     it "should return successfully" do
-      @telnet_mock.stub!(:cmd).and_yield('200')
+      @telnet_mock.stub(:cmd).with("String" => "url.purge /", "Match" => /\n\n/).and_yield('200')
       Lacquer::Varnish.new.purge('/').should be(true)
     end
   end

data/spec/lacquer/varnishd_spec.rb

@@ -0,0 +1,122 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "Varnishd" do
+  before do
+    spec_root = Pathname.new(__FILE__).dirname.join('..').expand_path    
+    Lacquer::Varnishd.stub(:started_check_delay).and_return(0)
+    Lacquer::Varnishd.stub(:env).and_return('test')
+    Lacquer::Varnishd.stub(:root_path).and_return(spec_root)
+  end
+
+  def executes_with(regexp)
+    new_method = Lacquer::Varnishd.method(:new)
+    Lacquer::Varnishd.stub(:new).and_return do |*args|
+      varnishd = new_method.call(*args)
+      varnishd.should_receive(:execute).with(regexp)
+      varnishd.stub(:log)
+      varnishd
+    end
+  end
+
+  it "passes settings in the initailizer" do
+    Lacquer::Varnishd.new("listen" => ":80").listen.should == ":80"
+  end
+
+  it "loads settings from varnish_config" do
+    Lacquer::Varnishd.config.should have_key("listen")
+    Lacquer::Varnishd.config.should have_key("telnet")
+    Lacquer::Varnishd.config.should have_key("sbin_path")
+    Lacquer::Varnishd.config.should have_key("bin_path")
+    Lacquer::Varnishd.config.should have_key("storage")
+    Lacquer::Varnishd.config.should have_key("use_sudo")
+    Lacquer::Varnishd.config["params"].should have_key('overflow_max')
+  end
+
+  it "returns full path to varnishd" do
+    executes_with(%r[/opt/varnishd/sbin/varnishd])
+    Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin").start
+  end
+
+  it "returns full path to varnishd using sudo" do
+    executes_with(%r[sudo /opt/varnishd/sbin/varnishd])
+    Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin", "use_sudo" => true).start
+  end
+
+  it "returns pid file" do
+    executes_with(/log\/varnishd.test.pid/)
+    Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin").start
+  end
+
+  it "returns pid file with custom path" do
+    executes_with(/pid\/varnishd.test.pid/)
+    Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin", "pid_path" => "pid/").start
+  end
+
+  it "returns params as string" do
+    Lacquer::Varnishd.new("params" => { "max" => 2000, "add" => 2 }).params_args.should == "-p max=2000 -p add=2"    
+  end
+
+  it "returns listen arg as string" do
+    Lacquer::Varnishd.new("listen" => ":80").args.should include("-a :80")
+  end
+
+  it "starts varnishd with args and params" do
+    executes_with(%r[/opt/varnishd/sbin.*-P.*log/varnishd.test.pid])
+    Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin", "params" => { "overflow_max" => 2000 }).start
+  end
+
+  it "raises error if vcl_script_file is not present" do
+    Lacquer::Varnishd.stub(:vcl_script_filename).and_return("config/file_not_found.vcl")
+    expect {
+      Lacquer::Varnishd.new.vcl_script_path
+    }.to raise_error
+  end
+
+  it "renders vcl file when erb is present" do
+    Lacquer::Varnishd.stub(:vcl_script_filename).and_return("config/generate.vcl")
+    result = Lacquer::Varnishd.new.render_vcl
+    result.should include('.host = "0.0.0.0"')
+    result.should include('.port = "3000"')
+  end
+
+  describe '#reload' do
+    def expect_reload_cmd(attributes)
+      Time.stub(:now).and_return Time.parse('October 6th, 1984')
+      varnishadm_cmd = "#{attributes['bin_path']}/varnishadm -T #{attributes['telnet']}"
+      reload_id = "reload#{Time.now.usec}"
+      load_cmd = "#{varnishadm_cmd} vcl.load #{reload_id} config/generate.vcl"
+      use_cmd = "#{varnishadm_cmd} vcl.use #{reload_id}"
+
+      executes_with "#{load_cmd} && #{use_cmd}"
+    end
+
+    context 'given varnishd is running' do
+      before do
+        attributes = { "sbin_path" => "/opt/varnishd/sbin", "bin_path" => "/opt/bin", "telnet" => "localhost:6082" }
+        expect_reload_cmd attributes
+        @varnishd = Lacquer::Varnishd.new attributes
+        @varnishd.stub(:vcl_script_filename).and_return("config/generate.vcl")
+        @varnishd.stub(:running?).and_return true
+      end
+
+      it 'executes the varnishadm reload commands' do
+        @varnishd.should_receive :generate_vcl
+      end
+
+      after do
+        @varnishd.reload
+      end
+    end
+
+    context 'given varnishd is not running' do
+      before do
+        executes_with(%r[/opt/varnishd/sbin/varnishd])
+        @varnishd = Lacquer::Varnishd.new("sbin_path" => "/opt/varnishd/sbin")
+      end
+
+      it 'starts varnishd' do
+        @varnishd.reload
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -21,6 +21,18 @@ end
 
 module Resque; end
 
+module Sidekiq
+  module Worker
+    module ClassMethods
+      def sidekiq_options(options); end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end
+
 Lacquer.configure do |config|
   config.enable_cache = true
   config.default_ttl = 1.week
@@ -28,6 +40,6 @@ Lacquer.configure do |config|
   config.varnish_servers << { :host => "0.0.0.0", :port => 6082 }
 end
 
-Rspec.configure do |c|
+RSpec.configure do |c|
   c.mock_with :rspec
 end

data/tasks/lacquer.rake

@@ -0,0 +1 @@
+load File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'lacquer', 'tasks.rb'))