zk 1.4.2 → 1.5.0

data/lib/zk/version.rb

@@ -1,3 +1,3 @@
 module ZK
-  VERSION = "1.4.2"
+  VERSION = "1.5.0"
 end

data/spec/logging_progress_bar_formatter.rb

@@ -0,0 +1,12 @@
+require 'rspec/core/formatters/progress_formatter'
+
+# essentially a monkey-patch to the ProgressBarFormatter, outputs 
+# '== #{example_proxy.description} ==' in the logs before each test.  makes it
+# easier to match up tests with the SQL they produce
+class LoggingProgressBarFormatter < RSpec::Core::Formatters::ProgressFormatter
+  def example_started(example)
+    ::Logging.logger['spec'].write(yellow("\n=====<([ #{example.full_description} ])>=====\n"))
+    super
+  end
+end
+

data/spec/shared/client_contexts.rb

@@ -8,22 +8,34 @@ shared_context 'threaded client connection' do
   include_context 'connection opts'
 
   before do
+#     logger.debug { "threaded client connection - begin before hook" }
+
     @connection_string = "localhost:#{ZK.test_port}"
     @base_path = '/zktests'
     @zk = ZK::Client::Threaded.new(*connection_args).tap { |z| wait_until { z.connected? } }
     @threadpool_exception = nil
     @zk.on_exception { |e| @threadpool_exception = e }
     @zk.rm_rf(@base_path)
+
+#     logger.debug { "threaded client connection - end before hook" }
   end
 
   after do
 #     raise @threadpool_exception if @threadpool_exception
-    @zk.reopen if @zk.closed?
+#     logger.debug { "threaded client connection - after hook" }
+
+    if @zk.closed?
+      logger.debug { "zk was closed, calling reopen" }
+      @zk.reopen 
+    end
+
     wait_until(5) { @zk.connected? }
     
     @zk.rm_rf(@base_path)
     @zk.close!
     wait_until(5) { @zk.closed? }
+
+#     logger.debug { "threaded client connection - end after hook" }
   end
 end
 

data/spec/shared/client_examples.rb

@@ -257,7 +257,9 @@ shared_examples_for 'client' do
 
         wait_until(2) do 
           begin
-            @events << @queue.pop(true)
+            event = @queue.pop(true)
+            logger.debug { "got event: #{event}" }
+            @events << event
             true
           rescue ThreadError
             false

data/spec/spec_helper.rb

@@ -36,15 +36,20 @@ RSpec.configure do |config|
     config.filter_run_excluding :rbx => :broken
   end
 
-  if ZK.jruby? or not ZK.mri_193?
+  if ZK.mri_187?
+    config.filter_run_excluding :mri_187 => :broken
+  end
+
+  if ZK.jruby?
     config.filter_run_excluding :fork_required => true
+    config.filter_run_excluding :jruby => :broken
   end
 
   if ZK.spawn_zookeeper?
     require 'zk-server'
 
     config.before(:suite) do 
-      ZK.logger.debug { "Starting zookeeper service" }
+      ::Logging.logger['spec'].debug { "Starting zookeeper service" }
       ZK::Server.run do |c|
         c.client_port = ZK.test_port
         c.force_sync  = false
@@ -53,10 +58,30 @@ RSpec.configure do |config|
     end
 
     config.after(:suite) do
-      ZK.logger.debug { "stopping zookeeper service" }
+      ::Logging.logger['spec'].debug { "stopping zookeeper service" }
       ZK::Server.shutdown
     end
   end
+
+  # tester should return true if the object is a leak
+  def leak_check(klass, &tester)
+    count = 0
+    ObjectSpace.each_object(klass) { |o| count += 1 if tester.call(o) }
+    unless count.zero?
+      raise "There were #{count} leaked #{klass} objects after #{example.full_description.inspect}" 
+    end
+  end
+
+  # these make tests run slow
+  if ENV['ZK_LEAK_CHECK']
+    config.after do 
+      leak_check(ZK::Client::Threaded) { |o| !o.closed? }
+      leak_check(ZK::ThreadedCallback, &:alive?)
+      leak_check(ZK::Threadpool, &:alive?)
+      leak_check(Thread) { |th| Thread.current != th && th.alive? }
+      ZK::ForkHook.hooks.values.flatten.should be_empty
+    end
+  end
 end
 
 class ::Thread

data/spec/support/client_forker.rb

@@ -14,16 +14,34 @@ class ClientForker
     @pids_root = "#{@base_path}/pid"
   end
 
+  LBORDER = ('-' * 35) << '< '
+  RBORDER = ' >' << ('-' * 35) 
+
+  def mark(thing)
+    logger << "\n#{LBORDER}#{thing}#{RBORDER}\n\n"
+  end
+
+  def mark_around(thing)
+    mark "#{thing}: ENTER"
+    yield
+  ensure
+    mark "#{thing}: EXIT"
+  end
+
   def before
-    ZK.open(*cnx_args) do |z|
-      z.rm_rf(@base_path)
-      z.mkdir_p(@pids_root)
+    mark_around('BEFORE') do
+      ZK.open(*cnx_args) do |z|
+        z.rm_rf(@base_path)
+        z.mkdir_p(@pids_root)
+      end
     end
   end
 
   def tear_down
-    @zk.rm_rf(@base_path)
-    @zk.close! unless @zk.closed?
+    mark_around('TEAR_DOWN') do
+      @zk.close! if @zk and !@zk.closed?
+      ZK.open(*cnx_args) { |z| z.rm_rf(@base_path) }
+    end
   end
 
   def kill_child!
@@ -34,8 +52,20 @@ class ClientForker
   rescue Errno::ESRCH
   end
 
+  CLEAR      = "\e[0m".freeze
+  YELLOW     = "\e[33m".freeze    # Set the terminal's foreground ANSI color to yellow.
+
+  def yellow_log_formatter()
+    orig_formatter = ::Logger::Formatter.new
+
+    proc do |s,dt,pn,msg|
+      "#{CLEAR}#{YELLOW}#{orig_formatter.call(s,dt,pn,msg)}#{CLEAR}"
+    end
+  end
+
   def run
     before
+    mark 'BEGIN TEST'
 
     logger.debug { "Process.pid of parent: #{Process.pid}" }
 
@@ -51,7 +81,7 @@ class ClientForker
 
     @parent_pid = $$
     
-    @zk.create("#{@pids_root}/#{$$}", $$.to_s)
+    @zk.create("#{@pids_root}/#{$$}", $$.to_s, :ignore => :node_exists)
 
     event_catcher = EventCatcher.new
 
@@ -66,8 +96,14 @@ class ClientForker
     logger.debug { "parent watching for children on #{@pids_root}" }
     @zk.children(@pids_root, :watch => true)  # side-effect, register watch
 
+    ZK.install_fork_hook
+
+    mark 'FORK'
+
     @pid = fork do
-      @zk.reopen
+      Thread.abort_on_exception = true
+      ::Logging.reopen
+
       @zk.wait_until_connected
 
       child_pid_path = "#{@pids_root}/#{$$}"
@@ -91,7 +127,11 @@ class ClientForker
         create_sub.unregister
       else
         logger.debug { "awaiting the create_latch to release" }
-        create_latch.await
+        create_latch.await(2) 
+        unless @zk.exists?(child_pid_path)
+          logger.debug { require 'pp'; PP.pp(@zk.event_handler, '') }
+          raise "child pid path not created after 2 sec"
+        end
       end
 
       logger.debug { "now testing for delete event totally created in child" }
@@ -152,6 +192,7 @@ class ClientForker
 
 #     $stderr.puts "#{@pid} exited with status: #{stat.inspect}"
   ensure
+    mark "END TEST"
     kill_child!
     tear_down
   end

data/spec/support/latch.rb

@@ -1,23 +1,5 @@
 # the much fabled 'latch' that tenderlove and nahi were on about
 
-class Latch
-  def initialize(count = 1)
-    @count = count
-    @mutex = Monitor.new
-    @cond = @mutex.new_cond
-  end
-
-  def release
-    @mutex.synchronize {
-      @count -= 1 if @count > 0
-      @cond.broadcast if @count.zero?
-    }
-  end
-
-  def await
-    @mutex.synchronize {
-      @cond.wait_while { @count > 0 }
-    }
-  end
+class Latch < Zookeeper::Latch
 end
 

data/spec/support/logging.rb

@@ -1,30 +1,46 @@
 module ZK
-#   LOG_FILE = File.open(File.join(ZK::ZK_ROOT, 'test.log'), 'a').tap { |f| f.sync = true }
-  LOG_FILE = File.join(ZK::ZK_ROOT, 'test.log')
-#   LOG_FILE = $stderr
+  TEST_LOG_PATH = File.join(ZK::ZK_ROOT, 'test.log')
 end
 
-# ZK.logger = ENV['TRAVIS'] ? Logger.new($stderr) : Logger.new(ZK::LOG_FILE)
+layout = Logging.layouts.pattern(
+  :pattern => '%.1l, [%d #%p] %30.30c{2}:  %m\n',
+  :date_pattern => '%Y-%m-%d %H:%M:%S.%6N' 
+)
 
-ZK.logger = Logger.new(ZK::LOG_FILE).tap { |l| l.level = Logger::DEBUG }
+appender = ENV['ZK_DEBUG'] ? Logging.appenders.stderr : Logging.appenders.file(ZK::TEST_LOG_PATH)
+appender.layout = layout
+
+%w[ZK ClientForker spec Zookeeper].each do |name|
+  ::Logging.logger[name].tap do |log|
+    log.appenders = [appender]
+    log.level = :debug
+  end
+end
+
+# this logger is kinda noisy
+Logging.logger['ZK::EventHandler'].level = :info
+
+Zookeeper.logger = Logging.logger['Zookeeper']
+Zookeeper.logger.level = :info
+
+# Zookeeper.logger = ZK.logger.clone_new_log(:progname => 'zoo')
 
 # Zookeeper.logger = ZK.logger
 # Zookeeper.set_debug_level(4)
 
-ZK.logger.debug { "LOG OPEN" }
-
 module SpecGlobalLogger
   def logger
-    ZK.logger
+    @spec_global_logger ||= ::Logging.logger['spec']
   end
 
   # sets the log level to FATAL for the duration of the block
   def mute_logger
-    orig_level, ZK.logger.level = ZK.logger.level, Logger::FATAL
+    zk_log = Logging.logger['ZK']
+    orig_level, zk_log.level = zk_log.level, :off
     orig_zk_level, Zookeeper.debug_level = Zookeeper.debug_level, Zookeeper::Constants::ZOO_LOG_LEVEL_ERROR
     yield
   ensure
-    ZK.logger.level = orig_level
+    zk_log.level = orig_zk_level
   end
 end
 

data/spec/support/wait_watchers.rb

@@ -19,7 +19,7 @@ module WaitWatchers
   #
   def wait_until(timeout=2)
     if ZK.travis? and timeout and timeout < 5
-      ZK.logger.debug { "TRAVIS: adjusting wait_until timeout from #{timeout} to 5 sec" }
+      logger.debug { "TRAVIS: adjusting wait_until timeout from #{timeout} to 5 sec" }
       timeout = 5
     end
 
@@ -35,7 +35,7 @@ module WaitWatchers
   # inverse of wait_until
   def wait_while(timeout=2)
     if ZK.travis? and timeout and timeout < 5
-      ZK.logger.debug { "TRAVIS: adjusting wait_while timeout from #{timeout} to 5 sec" }
+      logger.debug { "TRAVIS: adjusting wait_while timeout from #{timeout} to 5 sec" }
       timeout = 5
     end
 

data/spec/zk/00_forked_client_integration_spec.rb

@@ -8,7 +8,7 @@ describe 'forked client integration' do
       @base_path = '/zktests'
       @pids_root = "#{@base_path}/pid"
       
-      @cnx_args = ["#{ZK.default_host}:#{ZK.test_port}", { :thread => :single, :timeout => 5 }]
+      @cnx_args = ["#{ZK.default_host}:#{ZK.test_port}", { :thread => :per_callback, :timeout => 5 }]
 
       ZK.open(*@cnx_args) do |z|
         z.rm_rf(@base_path)

data/spec/zk/client_spec.rb

@@ -11,7 +11,7 @@ describe ZK::Client::Threaded do
       include_context 'connection opts'
 
       before do
-        @zk = ZK::Client::Threaded.new(*connection_args).tap { |z| wait_until { z.connected? } }
+        @zk = ZK::Client::Threaded.new(*connection_args)
       end
 
       after do
@@ -23,10 +23,19 @@ describe ZK::Client::Threaded do
 
         @zk.should be_kind_of(ZK::Client::Threaded) # yeah yeah, just be sure
 
+        shutdown_thread = nil
+
         @zk.defer do
-          @zk.close!
+          shutdown_thread = @zk.close!
         end
 
+        wait_while { shutdown_thread.nil? }
+
+        shutdown_thread.should_not be_nil
+        shutdown_thread.should be_kind_of(Thread)
+
+        shutdown_thread.join(5).should == shutdown_thread
+
         wait_until(5) { @zk.closed? }.should be_true 
       end
     end

data/spec/zk/election_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe ZK::Election do
+describe ZK::Election, :jruby => :broken do
   include_context 'connection opts'
 
   before do
     ZK.open(connection_host) do |cnx| 
-      ZK.logger.debug { "REMOVING /_zkelection" }
+      logger.debug { "REMOVING /_zkelection" }
       cnx.rm_rf('/_zkelection')
     end
 
@@ -29,10 +29,15 @@ describe ZK::Election do
       @palin = ZK::Election::Candidate.new(@zk2, @election_name, :data => @data2)
     end
 
+    after do
+      @palin.close
+      @obama.close
+    end
+
     describe 'vote!' do
       describe 'loser' do
         it %[should wait until the leader has acked before firing loser callbacks] do
-          queue = Queue.new
+          latch = Latch.new
           @do_ack = false
 
           @obama_won = nil
@@ -44,7 +49,7 @@ describe ZK::Election do
             @obama_waiting = true
 
             # wait for us to signal
-            queue.pop
+            latch.await
 
 #             $stderr.puts "obama on_winning_election entered"
             @obama_won = true
@@ -68,7 +73,7 @@ describe ZK::Election do
           # palin's callbacks haven't fired
           @palin_lost.should be_nil
 
-          queue << :ok
+          latch.release
 
           wait_until { @obama_won }
           @obama_won.should be_true
@@ -83,33 +88,42 @@ describe ZK::Election do
 
       describe do
         before do
+          Thread.abort_on_exception = true
           @obama_won = @obama_lost = @palin_won = @palin_lost = nil
+          win_latch, lose_latch = Latch.new, Latch.new
 
           @obama.on_winning_election do 
             logger.debug { "obama on_winning_election fired" }
             @obama_won = true
+            win_latch.release
           end
 
           @obama.on_losing_election do
             logger.debug { "obama on_losing_election fired" }
             @obama_lost = true
+            lose_latch.release
           end
 
           @palin.on_winning_election do
             logger.debug { "palin on_winning_election fired" }
             @palin_won = true
+            win_latch.release
           end
 
           @palin.on_losing_election do
             logger.debug { "palin on_losing_election fired" }
             @palin_lost = true
+            lose_latch.release
           end
           
           @obama.vote!
           @palin.vote!
 
-          wait_until { @obama_won }
-          wait_until { @palin_lost }
+          win_latch.await
+          @obama_won.should be_true
+
+          lose_latch.await
+          @palin_lost.should be_true
         end
 
         describe 'winner' do