zk-eventmachine 0.2.0.beta.3 → 0.9.0

data/lib/z_k/z_k_event_machine.rb

@@ -1,10 +1,10 @@
 require 'eventmachine'
-require 'em-synchrony'
 
 require 'zookeeper'
 require 'zookeeper/em_client'
 
 require 'zk'
+require 'deferred'
 
 module ZK
   module ZKEventMachine
@@ -14,11 +14,10 @@ end
 
 $LOAD_PATH.unshift(File.expand_path('../..', __FILE__)).uniq!
 
-require 'z_k/z_k_event_machine/deferred'
+require 'z_k/z_k_event_machine/iterator'
 require 'z_k/z_k_event_machine/callback'
 require 'z_k/z_k_event_machine/event_handler_e_m'
 require 'z_k/z_k_event_machine/unixisms'
 require 'z_k/z_k_event_machine/client'
-require 'z_k/z_k_event_machine/synchrony_client'
 
 

data/spec/spec_helper.rb

@@ -10,19 +10,21 @@ require 'evented-spec'
 # in spec/support/ and its subdirectories.
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
 
-$stderr.sync = true
-
 case `uname -s`.chomp
 when 'Linux'
-  $stderr.puts "WARN: setting EM.epoll = true for tests"
+#   $stderr.puts "WARN: setting EM.epoll = true for tests"
   EM.epoll = true
 when 'Darwin'
-  $stderr.puts "WARN: setting EM.kqueue = true for tests"
+#   $stderr.puts "WARN: setting EM.kqueue = true for tests"
   EM.kqueue = true
 end
 
 RSpec.configure do |config|
   config.mock_with :flexmock
+  config.extend   SpecGlobalLogger
+  config.include  SpecGlobalLogger
+  config.extend   WaitWatchers
+  config.include  WaitWatchers
 end
 
 

data/spec/support/logging.rb

@@ -1,15 +1,32 @@
 require 'logger'
 
-logger = Logger.new(File.expand_path('../../../test.log', __FILE__)).tap {|l| l.level = Logger::DEBUG}
+log_file = File.open(File.expand_path('../../../test.log', __FILE__), 'a').tap { |f| f.sync = true }
 
+Logger.new(log_file).tap do |log| 
+  log.level = Logger::DEBUG 
+  ZK.logger = log
+#   Zookeeper.logger = log
+end
+
+# for debugging along with C output uncomment the following
+#
+# $stderr.sync = true
 # logger = Logger.new($stderr).tap { |l| l.level = Logger::DEBUG }
 # Zookeeper.set_debug_level(4)
 
-ZK.logger = logger
-Zookeeper.logger = ZK.logger
+module SpecGlobalLogger
+  def logger
+    ZK.logger
+  end
 
-
-def logger
-  ZK.logger
+  # 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
+    orig_zk_level, Zookeeper.debug_level = Zookeeper.debug_level, ZookeeperConstants::ZOO_LOG_LEVEL_ERROR
+    yield
+  ensure
+    ZK.logger.level = orig_level
+  end
 end
 
+

data/spec/support/logging_progress_bar_formatter.rb

@@ -17,7 +17,7 @@ module RSpec
     module Formatters
       class ProgressFormatter
         def example_started(example)
-          ZK.logger.info(yellow("\n=====<([ #{example.full_description} ])>=====\n"))
+          ZK.logger << yellow("\n=====<([ #{example.full_description} ])>=====\n\n")
           super(example)
         end
       end

data/spec/support/wait_watchers.rb

@@ -0,0 +1,34 @@
+module WaitWatchers
+  class TimeoutError < StandardError; end
+
+  # method to wait until block passed returns true or timeout (default is 10 seconds) is reached 
+  # raises TiemoutError on timeout
+  def wait_until(timeout=2)
+    time_to_stop = Time.now + timeout
+    while true
+      rval = yield
+      return rval if rval
+      raise TimeoutError, "timeout of #{timeout}s exceeded" if Time.now > time_to_stop
+      Thread.pass
+    end
+  end
+
+  # inverse of wait_until
+  def wait_while(timeout=2)
+    time_to_stop = Time.now + timeout
+    while true
+      rval = yield
+      return rval unless rval
+      raise TimeoutError, "timeout of #{timeout}s exceeded" if Time.now > time_to_stop
+      Thread.pass
+    end
+  end
+
+  def report_realtime(what)
+    return yield
+    t = Benchmark.realtime { yield }
+    $stderr.puts "#{what}: %0.3f" % [t.to_f]
+  end
+end
+
+

data/spec/z_k/z_k_event_machine/client_spec.rb

@@ -1,23 +1,31 @@
 require 'spec_helper'
 
 module ZK::ZKEventMachine
-  describe 'Client' do
+  shared_examples_for 'Client' do
     include EventedSpec::SpecHelper
     default_timeout 2.0
 
+    let(:base_path) { '/zk-em-testing' }
+
     before do
-      @zk = ::ZK.new
-      @base_path = '/zk-em-testing'
-      @zk.rm_rf(@base_path)
-      @zk.mkdir_p(@base_path)
-      @zkem = ZK::ZKEventMachine::Client.new('localhost:2181')
+      @zk.rm_rf(base_path)
+      @zk.mkdir_p(base_path)
     end
 
     after do
-      @zk.rm_rf(@base_path)
+      @zk.rm_rf(base_path)
       @zk.close!
     end
 
+    def event_mock(name=:event)
+      flexmock(name).tap do |ev|
+        ev.should_receive(:node_event?).and_return(false)
+        ev.should_receive(:state_event?).and_return(true)
+        ev.should_receive(:zk=).with_any_args
+        yield ev if block_given?
+      end
+    end
+
     describe 'connect' do
       it %[should return a deferred that fires when connected and then close] do
         em do
@@ -45,48 +53,10 @@ module ZK::ZKEventMachine
       end
     end
 
-    describe 'on_connection_loss' do
-      before do
-        @path = [@base_path, 'foo'].join('/')
-        @data = 'this is data'
-        @zk.create(@path, @data)
-      end
-
-      it %[should be called back if the connection is lost] do
-        em do
-          @zkem.on_connection_lost do |exc|
-            logger.debug { "WIN!" }
-            exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
-            @zkem.close! { done }
-          end
-
-          @zkem.connect do
-            flexmock(@zkem.cnx) do |m|
-              m.should_receive(:get).with(Hash).and_return do |hash|
-                logger.debug { "client received :get wtih #{hash.inspect}" }
-                @user_cb = hash[:callback]
-
-                EM.next_tick do
-                  logger.debug { "calling back user cb with connection loss" }
-                  @user_cb.call(:rc => ZK::Exceptions::CONNECTIONLOSS)
-                end
-
-                { :rc => Zookeeper::ZOK }
-              end
-            end
-
-            @zkem.get(@path) do |exc,data|
-              exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
-            end
-          end
-        end
-      end
-    end
-
     describe 'get' do
       describe 'success' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @data = 'this is data'
           @zk.create(@path, @data)
         end
@@ -129,7 +99,7 @@ module ZK::ZKEventMachine
 
       describe 'failure' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @zk.delete(@path) rescue ZK::Exceptions::NoNode
         end
 
@@ -167,7 +137,7 @@ module ZK::ZKEventMachine
     describe 'create' do
       describe 'success' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @zk.delete(@path) rescue ZK::Exceptions::NoNode
 
           @data = 'this is data'
@@ -233,7 +203,7 @@ module ZK::ZKEventMachine
 
       describe 'failure' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @zk.create(@path, '')
         end
 
@@ -267,11 +237,10 @@ module ZK::ZKEventMachine
       end # failure
     end # create
 
-
     describe 'set' do
       describe 'success' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @data = 'this is data'
           @new_data = 'this is better data'
           @zk.create(@path, @data)
@@ -321,7 +290,7 @@ module ZK::ZKEventMachine
 
       describe 'failure' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @zk.delete(@path) rescue ZK::Exceptions::NoNode
         end
 
@@ -357,7 +326,7 @@ module ZK::ZKEventMachine
 
     describe 'exists?' do
       before do
-        @path = [@base_path, 'foo'].join('/')
+        @path = [base_path, 'foo'].join('/')
         @data = 'this is data'
       end
 
@@ -403,7 +372,7 @@ module ZK::ZKEventMachine
     describe 'stat' do
       describe 'success' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @data = 'this is data'
           @zk.create(@path, @data)
           @orig_stat = @zk.stat(@path)
@@ -445,7 +414,7 @@ module ZK::ZKEventMachine
 
       describe 'non-existent node' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @zk.delete(@path) rescue ZK::Exceptions::NoNode
         end
 
@@ -474,7 +443,7 @@ module ZK::ZKEventMachine
     describe 'delete' do
       describe 'success' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @data = 'this is data'
           @zk.create(@path, @data)
         end
@@ -512,7 +481,7 @@ module ZK::ZKEventMachine
 
       describe 'failure' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @zk.delete(@path) rescue ZK::Exceptions::NoNode
         end
 
@@ -549,7 +518,7 @@ module ZK::ZKEventMachine
     describe 'children' do
       describe 'success' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @child_1_path = [@path, 'child_1'].join('/')
           @child_2_path = [@path, 'child_2'].join('/')
 
@@ -603,7 +572,7 @@ module ZK::ZKEventMachine
 
       describe 'failure' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @zk.delete(@path) rescue ZK::Exceptions::NoNode
         end
 
@@ -640,7 +609,7 @@ module ZK::ZKEventMachine
     describe 'get_acl' do
       describe 'success' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @data = 'this is data'
           @zk.create(@path, @data)
         end
@@ -684,7 +653,7 @@ module ZK::ZKEventMachine
 
       describe 'failure' do
         before do
-          @path = [@base_path, 'foo'].join('/')
+          @path = [base_path, 'foo'].join('/')
           @zk.delete(@path) rescue ZK::Exceptions::NoNode
         end
 
@@ -729,6 +698,157 @@ module ZK::ZKEventMachine
         it %[should have NoNode as the first argument to the block] 
       end # failure
     end # set_acl
+
+    describe 'session_id and session_passwd' do
+      it %[should return a Fixnum for session_id once connected] do
+        em do
+          @zkem.session_id.should be_nil
+
+          @zkem.connect do
+            @zkem.session_id.should be_kind_of(Fixnum)
+            @zkem.close! { done }
+          end
+        end
+      end
+
+      it %[should return a String for session_passwd once connected] do
+        em do
+          @zkem.session_passwd.should be_nil
+
+          @zkem.connect do
+            @zkem.session_passwd.should be_kind_of(String)
+            @zkem.close! { done }
+          end
+        end
+      end
+    end
+
+    describe 'on_connection_lost' do
+      before do
+        @path = [base_path, 'foo'].join('/')
+        @data = 'this is data'
+        @zk.create(@path, @data)
+      end
+
+      it %[should be called back if the connection is lost] do
+        em do
+          @zkem.on_connection_lost do |exc|
+            logger.debug { "WIN!" }
+            exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
+            @zkem.close! { done }
+          end
+
+          @zkem.connect do
+            flexmock(@zkem.__send__(:cnx)) do |m|  # ok, this is being a bit naughty with the __send__
+              m.should_receive(:get).with(Hash).and_return do |hash|
+                logger.debug { "client received :get wtih #{hash.inspect}" }
+                @user_cb = hash[:callback]
+
+                EM.next_tick do
+                  logger.debug { "calling back user cb with connection loss" }
+                  @user_cb.call(:rc => ZK::Exceptions::CONNECTIONLOSS)
+                end
+
+                { :rc => Zookeeper::ZOK }
+              end
+            end
+
+            @zkem.get(@path) do |exc,data|
+              exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
+            end
+          end
+        end
+      end
+
+      it %[should be called if we get a session expired event] do
+        @zkem.on_connection_lost do |exc|
+          logger.debug { "WIN!" }
+          exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
+          @zkem.close! { done }
+        end
+
+        em do
+          @zkem.connect do
+            event = event_mock(:connection_loss_event).tap do |ev|
+              ev.should_receive(:state).and_return(Zookeeper::ZOO_EXPIRED_SESSION_STATE)
+            end
+
+            EM.next_tick { @zkem.event_handler.process(event) }
+          end
+        end
+      end
+    end # on_connection_lost
+
+    describe 'on_connected' do
+      it %[should be called back when a ZOO_CONNECTED_STATE event is received] do
+        em do
+          @zkem.on_connected do |event|
+            logger.debug { "WIN!" }
+            @zkem.close! { done }
+          end
+
+          @zkem.connect do
+            logger.debug { "we connected" }
+          end
+        end
+      end
+    end # on_connected
+
+    describe 'on_connecting' do
+      it %[should be called back when a ZOO_CONNECTING_STATE event is received] do
+        @zkem.on_connecting do |event|
+          logger.debug { "WIN!" }
+          @zkem.close! { done }
+        end
+
+        em do
+          @zkem.connect do
+            event = event_mock(:connecting_event).tap do |ev|
+              ev.should_receive(:state).and_return(Zookeeper::ZOO_CONNECTING_STATE)
+            end
+
+            EM.next_tick { @zkem.event_handler.process(event) }
+          end
+        end
+      end
+    end # on_connecting
   end # Client
+
+  describe 'regular' do
+
+    before do
+      @zkem = ZK::ZKEventMachine::Client.new('localhost:2181')
+      @zk = ZK.new.tap { |z| wait_until { z.connected? } }
+      @zk.should be_connected
+    end
+
+    it_should_behave_like 'Client'
+  end
+
+  describe 'chrooted' do
+    let(:chroot_path) { '/_zkem_chroot_' }
+    let(:zk_connect_host) { "localhost:2181#{chroot_path}" }
+
+    before :all do
+      ZK.open('localhost:2181') do |z|
+        z.rm_rf(chroot_path)
+        z.mkdir_p(chroot_path)
+      end
+    end
+
+    after :all do
+      ZK.open('localhost:2181') do |z|
+        z.rm_rf(chroot_path)
+      end
+    end
+
+    before do
+      @zkem = ZK::ZKEventMachine::Client.new(zk_connect_host)
+      @zk = ZK.new(zk_connect_host).tap { |z| wait_until { z.connected? } }
+      @zk.should be_connected
+    end
+
+    it_should_behave_like 'Client'
+  end
 end # ZK::ZKEventMachine
 

data/spec/z_k/z_k_event_machine/event_handler_e_m_spec.rb

@@ -14,11 +14,12 @@ module ZK::ZKEventMachine
     end
 
     after do
-      @zk.rm_rf(@base_path)
-      @zk.close!
+      mute_logger do
+        @zk.rm_rf(@base_path)
+        @zk.close!
+      end
     end
 
-
     # this is a test of event delivery in general, not just of the
     # EventHandlerEM implementation
 
@@ -71,8 +72,8 @@ module ZK::ZKEventMachine
               ary.should be_empty
               stat.should be_kind_of(ZookeeperStat::Stat)
 
-              @zkem.create(@child_path, '') { |p|
-                p.should == @path
+              @zkem.create(@child_path, '').callback { |p|
+                p.should == @child_path
 
               }.errback(&eb_raise)
             }.errback(&eb_raise)

data/zk-eventmachine.gemspec

@@ -12,18 +12,12 @@ Gem::Specification.new do |s|
   s.summary     = %q{ZK client for EventMachine-based (async) applications}
   s.description = s.description
 
-  s.add_dependency('zk', '~> 0.8.5')
+  s.add_dependency 'zk', '~> 0.9.0'
 
   # zk depends on slyphon-zookeeper, but we need at least this version
-  s.add_dependency('slyphon-zookeeper', '~> 0.2.4')
-  s.add_dependency('eventmachine', '~> 1.0.0.beta.3')
-  s.add_dependency('em-synchrony', '~> 1.0.0')
-
-  s.add_development_dependency('rspec', '~> 2.5.0')
-  s.add_development_dependency('yard', '~> 0.7.0')
-  s.add_development_dependency('autotest', '>= 4.4.0')
-  s.add_development_dependency('flexmock', '~> 0.8.10')
-  s.add_development_dependency('evented-spec', '~> 0.4.1')
+  s.add_dependency 'slyphon-zookeeper', '~> 0.8.1'
+  s.add_dependency 'eventmachine',      '~> 1.0.0.beta.4'
+  s.add_dependency 'deferred',          '~> 0.5.3'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")