copycopter_client 1.0.2 → 1.0.3

data/spec/copycopter_client/configuration_spec.rb

@@ -194,15 +194,19 @@ end
 
 share_examples_for "applied configuration" do
   let(:backend) { stub('i18n-backend') }
-  let(:sync)    { stub('sync', :start => nil) }
+  let(:cache)    { stub('cache') }
   let(:client)  { stub('client') }
+  let(:poller)  { stub('poller') }
+  let(:process_guard) { stub('process_guard', :start => nil) }
   let(:logger)  { FakeLogger.new }
   subject { CopycopterClient::Configuration.new }
 
   before do
     CopycopterClient::I18nBackend.stubs(:new => backend)
     CopycopterClient::Client.stubs(:new => client)
-    CopycopterClient::Sync.stubs(:new => sync)
+    CopycopterClient::Cache.stubs(:new => cache)
+    CopycopterClient::Poller.stubs(:new => poller)
+    CopycopterClient::ProcessGuard.stubs(:new => process_guard)
     subject.logger = logger
     apply
   end
@@ -211,11 +215,20 @@ share_examples_for "applied configuration" do
 
   it "builds and assigns an I18n backend" do
     CopycopterClient::Client.should have_received(:new).with(subject.to_hash)
-    CopycopterClient::Sync.should have_received(:new).with(client, subject.to_hash)
-    CopycopterClient::I18nBackend.should have_received(:new).with(sync)
+    CopycopterClient::Cache.should have_received(:new).with(client, subject.to_hash)
+    CopycopterClient::I18nBackend.should have_received(:new).with(cache)
     I18n.backend.should == backend
   end
 
+  it "builds and assigns a poller" do
+    CopycopterClient::Poller.should have_received(:new).with(cache, subject.to_hash)
+  end
+
+  it "builds a process guard" do
+    CopycopterClient::ProcessGuard.should have_received(:new).
+      with(cache, poller, subject.to_hash)
+  end
+
   it "logs that it's ready" do
     logger.should have_entry(:info, "Client #{CopycopterClient::VERSION} ready")
   end
@@ -228,15 +241,15 @@ share_examples_for "applied configuration" do
     CopycopterClient.client.should == client
   end
 
-  it "stores the sync" do
-    CopycopterClient.sync.should == sync
+  it "stores the cache" do
+    CopycopterClient.cache.should == cache
   end
 end
 
 describe CopycopterClient::Configuration, "applied when testing" do
   it_should_behave_like "applied configuration" do
-    it "doesn't start sync" do
-      sync.should have_received(:start).never
+    it "doesn't start the process guard" do
+      process_guard.should have_received(:start).never
     end
   end
 
@@ -248,8 +261,8 @@ end
 
 describe CopycopterClient::Configuration, "applied when not testing" do
   it_should_behave_like "applied configuration" do
-    it "starts sync" do
-      sync.should have_received(:start)
+    it "starts the process guard" do
+      process_guard.should have_received(:start)
     end
   end
 

data/spec/copycopter_client/i18n_backend_spec.rb

@@ -1,29 +1,29 @@
 require 'spec_helper'
 
 describe CopycopterClient::I18nBackend do
-  let(:sync) { {} }
+  let(:cache) { {} }
 
   def build_backend
-    backend = CopycopterClient::I18nBackend.new(sync)
+    backend = CopycopterClient::I18nBackend.new(cache)
     I18n.backend = backend
     backend
   end
 
   before do
     @default_backend = I18n.backend
-    sync.stubs(:wait_for_download)
+    cache.stubs(:wait_for_download)
   end
 
   after { I18n.backend = @default_backend }
 
   subject { build_backend }
 
-  it "reloads locale files and waits for the sync to complete" do
+  it "reloads locale files and waits for the download to complete" do
     I18n.stubs(:load_path => [])
     subject.reload!
     subject.translate('en', 'test.key', :default => 'something')
 
-    sync.should have_received(:wait_for_download)
+    cache.should have_received(:wait_for_download)
     I18n.should have_received(:load_path)
   end
 
@@ -31,21 +31,21 @@ describe CopycopterClient::I18nBackend do
     should be_kind_of(I18n::Backend::Base)
   end
 
-  it "looks up a key in sync" do
+  it "looks up a key in cache" do
     value = 'hello'
-    sync['en.prefix.test.key'] = value
+    cache['en.prefix.test.key'] = value
 
     backend = build_backend
 
     backend.translate('en', 'test.key', :scope => 'prefix').should == value
   end
 
-  it "finds available locales from locale files and sync" do
+  it "finds available locales from locale files and cache" do
     YAML.stubs(:load_file => { 'es' => { 'key' => 'value' } })
     I18n.stubs(:load_path => ["test.yml"])
 
-    sync['en.key'] = ''
-    sync['fr.key'] = ''
+    cache['en.key'] = ''
+    cache['fr.key'] = ''
 
     subject.available_locales.should =~ [:en, :es, :fr]
   end
@@ -55,14 +55,14 @@ describe CopycopterClient::I18nBackend do
 
     subject.translate('en', 'test.key', :default => default).should == default
 
-    sync['en.test.key'].should == default
+    cache['en.test.key'].should == default
   end
 
   it "queues missing keys without default" do
     expect { subject.translate('en', 'test.key') }.
       to raise_error(I18n::MissingTranslationData)
 
-    sync['en.test.key'].should == ""
+    cache['en.test.key'].should == ""
   end
 
   it "queues missing keys with scope" do
@@ -71,17 +71,17 @@ describe CopycopterClient::I18nBackend do
     subject.translate('en', 'key', :default => default, :scope => ['test']).
       should == default
 
-    sync['en.test.key'].should == default
+    cache['en.test.key'].should == default
   end
 
   it "marks strings as html safe" do
-    sync['en.test.key'] = FakeHtmlSafeString.new("Hello")
+    cache['en.test.key'] = FakeHtmlSafeString.new("Hello")
     backend = build_backend
     backend.translate('en', 'test.key').should be_html_safe
   end
 
   it "looks up an array of defaults" do
-    sync['en.key.one'] = "Expected"
+    cache['en.key.one'] = "Expected"
     backend = build_backend
     backend.translate('en', 'key.three', :default => [:"key.two", :"key.one"]).
       should == 'Expected'
@@ -94,14 +94,14 @@ describe CopycopterClient::I18nBackend do
       subject.store_translations('en', 'test' => { 'key' => 'Expected' })
       subject.translate('en', 'test.key', :default => 'Unexpected').
         should include('Expected')
-      sync['en.test.key'].should == 'Expected'
+      cache['en.test.key'].should == 'Expected'
     end
 
     it "preserves interpolation markers in the stored translation" do
       subject.store_translations('en', 'test' => { 'key' => '%{interpolate}' })
       subject.translate('en', 'test.key', :interpolate => 'interpolated').
         should include('interpolated')
-      sync['en.test.key'].should == '%{interpolate}'
+      cache['en.test.key'].should == '%{interpolate}'
     end
 
     it "uses the default if the stored translations don't have the key" do
@@ -109,9 +109,9 @@ describe CopycopterClient::I18nBackend do
         should include('Expected')
     end
 
-    it "uses the syncd key when present" do
+    it "uses the cached key when present" do
       subject.store_translations('en', 'test' => { 'key' => 'Unexpected' })
-      sync['en.test.key'] = 'Expected'
+      cache['en.test.key'] = 'Expected'
       subject.translate('en', 'test.key', :default => 'default').
         should include('Expected')
     end
@@ -120,14 +120,14 @@ describe CopycopterClient::I18nBackend do
       nested = { :nested => 'value' }
       subject.store_translations('en', 'key' => nested)
       subject.translate('en', 'key', :default => 'Unexpected').should == nested
-      sync['en.key.nested'].should == 'value'
+      cache['en.key.nested'].should == 'value'
     end
 
     it "returns an array directly without storing" do
       array = ['value']
       subject.store_translations('en', 'key' => array)
       subject.translate('en', 'key', :default => 'Unexpected').should == array
-      sync['en.key'].should be_nil
+      cache['en.key'].should be_nil
     end
 
     it "looks up an array of defaults" do
@@ -151,7 +151,7 @@ describe CopycopterClient::I18nBackend do
 
       subject.translate('en', 'test.key', :default => default).should == default
 
-      sync['en.test.key'].should == default
+      cache['en.test.key'].should == default
     end
   end
 end

data/spec/copycopter_client/poller_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe CopycopterClient::Poller do
+  POLLING_DELAY = 0.5
+
+  let(:client) { FakeClient.new }
+  let(:cache) { CopycopterClient::Cache.new(client, :logger => FakeLogger.new) }
+
+  def build_poller(config = {})
+    config[:logger] ||= FakeLogger.new
+    config[:polling_delay] = POLLING_DELAY
+    default_config = CopycopterClient::Configuration.new.to_hash
+    poller = CopycopterClient::Poller.new(cache, default_config.update(config))
+    @pollers << poller
+    poller
+  end
+
+  def wait_for_next_sync
+    sleep(POLLING_DELAY * 3)
+  end
+
+  before do
+    @pollers = []
+  end
+
+  after do
+    @pollers.each { |poller| poller.stop }
+  end
+
+  it "it polls after being started" do
+    poller = build_poller
+    poller.start
+
+    client['test.key'] = 'value'
+    wait_for_next_sync
+
+    cache['test.key'].should == 'value'
+  end
+
+  it "it doesn't poll before being started" do
+    poller = build_poller
+    client['test.key'] = 'value'
+
+    wait_for_next_sync
+
+    cache['test.key'].should be_nil
+  end
+
+  it "stops polling when stopped" do
+    poller = build_poller
+
+    poller.start
+    poller.stop
+
+    client['test.key'] = 'value'
+    wait_for_next_sync
+
+    cache['test.key'].should be_nil
+  end
+
+  it "stops polling with an invalid api key" do
+    failure = "server is napping"
+    logger = FakeLogger.new
+    cache.stubs(:download).raises(CopycopterClient::InvalidApiKey.new(failure))
+    poller = build_poller(:logger => logger)
+
+    cache['upload.key'] = 'upload'
+    poller.start
+    wait_for_next_sync
+
+    logger.should have_entry(:error, failure)
+
+    client['test.key'] = 'test value'
+    wait_for_next_sync
+
+    cache['test.key'].should be_nil
+  end
+
+  it "logs an error if the background thread can't start" do
+    Thread.stubs(:new => nil)
+    logger = FakeLogger.new
+
+    build_poller(:logger => logger).start
+
+    logger.should have_entry(:error, "Couldn't start poller thread")
+  end
+
+  it "flushes the log when polling" do
+    logger = FakeLogger.new
+    logger.stubs(:flush)
+
+    build_poller(:logger => logger).start
+
+    wait_for_next_sync
+
+    logger.should have_received(:flush).at_least_once
+  end
+
+  it "starts from the top-level constant" do
+    poller = build_poller
+    CopycopterClient.poller = poller
+    poller.stubs(:start)
+
+    CopycopterClient.start_poller
+
+    poller.should have_received(:start)
+  end
+end
+
+

data/spec/copycopter_client/process_guard_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe CopycopterClient::ProcessGuard do
+  include DefinesConstants
+
+  before do
+    @original_process_name = $0
+  end
+
+  after do
+    $0 = @original_process_name
+  end
+
+  let(:cache) { stub('cache', :flush => nil) }
+  let(:poller) { stub('poller', :start => nil) }
+
+  def build_process_guard(options = {})
+    options[:logger] ||= FakeLogger.new
+    options[:cache] ||= cache
+    CopycopterClient::ProcessGuard.new(options[:cache], poller, options)
+  end
+
+  it "starts polling from a worker process" do
+    process_guard = build_process_guard
+
+    process_guard.start
+
+    poller.should have_received(:start)
+  end
+
+  it "registers passenger hooks from the passenger master" do
+    logger = FakeLogger.new
+    passenger = define_constant('PhusionPassenger', FakePassenger.new)
+    passenger.become_master
+
+    process_guard = build_process_guard(:logger => logger)
+    process_guard.start
+
+    logger.should have_entry(:info, "Registered Phusion Passenger fork hook")
+    poller.should have_received(:start).never
+  end
+
+  it "starts polling from a passenger worker" do
+    logger = FakeLogger.new
+    passenger = define_constant('PhusionPassenger', FakePassenger.new)
+    passenger.become_master
+    process_guard = build_process_guard(:logger => logger)
+
+    process_guard.start
+    passenger.spawn
+
+    poller.should have_received(:start)
+  end
+
+  it "registers unicorn hooks from the unicorn master" do
+    logger = FakeLogger.new
+    define_constant('Unicorn', Module.new)
+    http_server = Class.new(FakeUnicornServer)
+    unicorn = define_constant('Unicorn::HttpServer', http_server).new
+    unicorn.become_master
+
+    process_guard = build_process_guard(:logger => logger)
+    process_guard.start
+
+    logger.should have_entry(:info, "Registered Unicorn fork hook")
+    poller.should have_received(:start).never
+  end
+
+  it "starts polling from a unicorn worker" do
+    logger = FakeLogger.new
+    define_constant('Unicorn', Module.new)
+    http_server = Class.new(FakeUnicornServer)
+    unicorn = define_constant('Unicorn::HttpServer', http_server).new
+    unicorn.become_master
+    process_guard = build_process_guard(:logger => logger)
+
+    process_guard.start
+    unicorn.spawn
+
+    poller.should have_received(:start)
+  end
+
+  it "flushes when the process terminates" do
+    cache = WritingCache.new
+    pid = fork do
+      process_guard = build_process_guard(:cache => cache)
+      process_guard.start
+      exit
+    end
+    Process.wait
+
+    cache.should be_written
+  end
+
+  it "flushes after running a resque job" do
+    logger = FakeLogger.new
+    cache = WritingCache.new
+    define_constant('Resque', Module.new)
+    job_class = define_constant('Resque::Job', FakeResqueJob)
+    job = job_class.new
+    process_guard = build_process_guard(:cache => cache, :logger => logger)
+
+    process_guard.start
+    job.fork_and_perform
+
+    cache.should be_written
+    logger.should have_entry(:info, "Registered Resque after_perform hook")
+  end
+
+  it "doesn't fail if only Resque is defined and not Resque::Job" do
+    logger = FakeLogger.new
+    cache = WritingCache.new
+    define_constant('Resque', Module.new)
+    process_guard = build_process_guard(:cache => cache, :logger => logger)
+
+    process_guard.start
+  end
+end