zookeeper 0.9.4 → 1.0.0.beta.1

data/.dotfiles/rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3@zookeeper --create

data/.gitignore

@@ -8,3 +8,6 @@ pkg
 zookeeper.gemspec
 Gemfile.*
 tmp/
+.rvmrc
+.zkserver
+coverage

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "releaseops"]
+	path = releaseops
+	url = git://github.com/slyphon/releaseops.git

data/.travis.yml

@@ -0,0 +1,22 @@
+---
+notifications:
+  email:
+    - slyphon@gmail.com
+
+# pull in releaseops submodule
+before_install:
+  - git submodule update --init --recursive
+
+env:
+  - SPAWN_ZOOKEEPER='true'
+
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree
+  - jruby-18mode
+  - jruby-19mode
+
+bundler_args: --without development docs coverage
+

data/CHANGELOG

@@ -1,9 +1,42 @@
-v0.9.4 Fix shutdown timing bug
+v1.0.0 Single Zookeeper namespace
 
-  * Because we now release the GIL, ruby may call close while there's still
-    a pending synchronous call (since we give up the interpreter during that
-    time). Protect calls with a mutex so that close can only be called when
-    there isn't an in-flight call.
+  * The top level Zookeeper class is now a module, the former Zookeeper
+    class is now Zookeeper::Client
+
+  * Consolidate the 6 top-level namespaces into one, Zookeeper module
+
+    ZookeeperCommon -> Zookeeper::Common
+    ZookeeperCallbacks -> Zookeeper::Callbacks
+    ZookeeperConstants -> Zookeeper::Constants
+    ZookeeperExceptions -> Zookeeper::Exceptions
+    ZookeeperACLs -> Zookeeper::ACLs
+    CZookeeper -> Zookeeper::CZookeeper
+
+  * Added a 'zookeeper/compatibility' file that will define the old names
+    and look up the new constants for users, and print a warning telling them
+    the change has occurred and that they should update their code
+
+  * Added scripts/upgrade-1.0-sed-alike.rb which will basically do a
+    find-and-replace, changing the old names to the new names (worked on
+    both the Zookeeper and ZK codebases).
+
+  * Java and C now use different names for the base class, to avoid the
+    possibility of error. Java is now JavaBase, C remains ZookeeperBase.
+    
+  * All client methods are defined in the ClientMethods module and mixed
+    into the constructed Client class.
+
+  * Fix all requires, no longer monkey with $LOAD_PATH, use require_relative
+
+  * Bugfix for C client. 
+  
+    Because we release the GIL, there's the possibilty that in the middle of a
+    synchronous C call, ruby will have switched thread contexts and one of
+    those threads will call close. It seems that during normal operation, this
+    is not a problem, but during shutdown, this causes CPU to spike to 100% and
+    a deadlock. This fix essentially wraps every call to the C layer in a
+    mutex. There may be a slightly less heavyweight optimization in the future,
+    but this is the safest option at the moment.
 
 v0.9.3 Event thread shutdown fix, Windows compatibility fix
 

data/Gemfile

@@ -4,11 +4,28 @@ gemspec
 
 gem 'rake', '~> 0.9.0'
 
+platform :mri_19 do
+  gem 'simplecov', :group => :coverage, :require => false
+end
+
 group :test do
   gem "rspec", "~> 2.8.0"
-  gem 'flexmock', '~> 0.8.11'
   gem 'eventmachine', '1.0.0.beta.4'
   gem 'evented-spec', '~> 0.9.0'
+
+  gem 'zk-server', '~> 1.0.0'
+end
+
+platform :mri_19 do
+  gem 'simplecov', :group => :coverage, :require => false
+end
+
+group :docs do
+  gem 'yard', '~> 0.8.0'
+
+  platform :mri_19 do
+    gem 'redcarpet'
+  end
 end
 
 group :development do

data/README.markdown

@@ -1,5 +1,7 @@
 # zookeeper #
 
+[![Build Status](https://secure.travis-ci.org/slyphon/zookeeper.png?branch=master)](http://travis-ci.org/slyphon/zookeeper)
+
 An interface to the Zookeeper cluster coordination server.
 
 For a higher-level interface with a more convenient API and features such as locks, have a look at [ZK](https://github.com/slyphon/zk) (also available is [ZK-EventMachine](https://github.com/slyphon/zk-eventmachine) for those who prefer async).

data/Rakefile

@@ -1,114 +1,70 @@
-# def gemset_name
-#   ENV.fetch('GEM_HOME').split('@').last
-# end
-
-GEM_FILES = FileList['*zookeeper-*.gem']
-
-# need to releaase under both names until ZK is updated to use just 'zookeeper'
-GEM_NAMES = %w[zookeeper slyphon-zookeeper]
-
-namespace :mb do
-  namespace :gems do
-    task :build do
-      GEM_NAMES.each do |gem_name|
-        ENV['JAVA_GEM'] = nil
-        sh "rvm 1.8.7 do env ZOOKEEPER_GEM_NAME='#{gem_name}' gem build zookeeper.gemspec"
-        sh "rvm 1.8.7 do env JAVA_GEM=1 ZOOKEEPER_GEM_NAME='#{gem_name}' gem build zookeeper.gemspec"
-      end
-    end
+release_ops_path = File.expand_path('../releaseops/lib', __FILE__)
 
-    task :push => :build do
-      raise "No gemfiles to push!" if GEM_FILES.empty?
+# if the special submodule is availabe, use it
+# we use a submodule because it doesn't depend on anything else (*cough* bundler)
+# and can be shared across projects
+#
+if File.exists?(release_ops_path)
+  require File.join(release_ops_path, 'releaseops')
 
-      GEM_FILES.each do |gem|
-        sh "gem push #{gem}"
-      end
-    end
+  # sets up the multi-ruby zk:test_all rake tasks
+  ReleaseOps::TestTasks.define_for(*%w[1.8.7 1.9.2 jruby rbx ree 1.9.3])
 
-    task :clean do
-      rm_rf GEM_FILES
-    end
+  # sets up the task :default => 'spec:run' and defines a simple
+  # "run the specs with the current rvm profile" task
+  ReleaseOps::TestTasks.define_simple_default_for_travis
 
-    task :all => [:build, :push, :clean]
-  end
-end
+  # Define a task to run code coverage tests
+  ReleaseOps::TestTasks.define_simplecov_tasks
 
-gemset_name = 'zookeeper'
+  # set up yard:server, yard:gems, and yard:clean tasks 
+  # for doing documentation stuff
+  ReleaseOps::YardTasks.define
 
-# this nonsense w/ tmp and the Gemfile is a bundler optimization
+  task :clean => 'yard:clean'
 
-%w[1.8.7 1.9.2 jruby rbx 1.9.3].each do |ns_name|
-  rvm_ruby = (ns_name == 'rbx') ? "rbx-2.0.testing" : ns_name
+  namespace :zk do
+    namespace :gems do
+      task :build do
+        require 'tmpdir'
 
-  ruby_with_gemset = "#{rvm_ruby}@#{gemset_name}"
+        raise "You must specify a TAG" unless ENV['TAG']
 
-  create_gemset_name  = "mb:#{ns_name}:create_gemset"
-  clobber_task_name   = "mb:#{ns_name}:clobber"
-  clean_task_name     = "mb:#{ns_name}:clean"
-  build_task_name     = "mb:#{ns_name}:build"
-  bundle_task_name    = "mb:#{ns_name}:bundle_install"
-  rspec_task_name     = "mb:#{ns_name}:run_rspec"
+        ReleaseOps.with_tmpdir(:prefix => 'zookeeper') do |tmpdir|
+          tag = ENV['TAG']
 
-  phony_gemfile_link_name = "Gemfile.#{ns_name}"
-  phony_gemfile_lock_name = "#{phony_gemfile_link_name}.lock"
+          sh "git clone . #{tmpdir}"
 
-  file phony_gemfile_link_name do
-    # apparently, rake doesn't deal with symlinks intelligently :P
-    ln_s('Gemfile', phony_gemfile_link_name) unless File.symlink?(phony_gemfile_link_name)
-  end
+          orig_dir = Dir.getwd
 
-  task :clean do
-    rm_rf [phony_gemfile_lock_name, phony_gemfile_lock_name]
-  end
+          cd tmpdir do
+            sh "git co #{tag} && git reset --hard && git clean -fdx"
 
-  task create_gemset_name do
-    sh "rvm #{rvm_ruby} do rvm gemset create #{gemset_name}"
-  end
+            ENV['JAVA_GEM'] = nil
+            sh "rvm 1.8.7 do gem build zookeeper.gemspec"
+            sh "rvm 1.8.7 do env JAVA_GEM=1 gem build zookeeper.gemspec"
 
-  task clobber_task_name do
-    unless rvm_ruby == 'jruby'
-      cd 'ext' do
-        sh "rvm #{ruby_with_gemset} do bundle exec rake clobber"
+            mv FileList['*.gem'], orig_dir
+          end
+        end
       end
-    end
-  end
 
-  task clean_task_name do
-    unless rvm_ruby == 'jruby'
-      cd 'ext' do
-        sh "rvm #{ruby_with_gemset} do bundle exec rake clean"
-      end
-    end
-  end
+      task :push => :build do
+        gems = FileList['*.gem']
+        raise "No gemfiles to push!" if gems.empty?
 
-  task build_task_name => [create_gemset_name, clean_task_name] do
-    unless rvm_ruby == 'jruby'
-      cd 'ext' do
-        sh "rvm #{ruby_with_gemset} do bundle exec rake build"
+        gems.each do |gem|
+          sh "gem push #{gem}"
+        end
       end
-    end
-  end
 
-  task bundle_task_name => [phony_gemfile_link_name, build_task_name] do
-    sh "rvm #{ruby_with_gemset} do bundle install --gemfile #{phony_gemfile_link_name}"
-  end
-
-  task rspec_task_name => bundle_task_name do
-    sh "rvm #{ruby_with_gemset} do env BUNDLE_GEMFILE=#{phony_gemfile_link_name} bundle exec rspec spec --fail-fast"
-  end
-
-  task "mb:#{ns_name}" => rspec_task_name
-
-  task "mb:test_all_rubies" => rspec_task_name
-end
+      task :clean do
+        rm_rf FileList['*.gem']
+      end
 
-task "mb:test_all" do
-  require 'benchmark'
-  t = Benchmark.realtime do
-    Rake::Task['mb:test_all_rubies'].invoke
+      task :all => [:build, :push, :clean]
+    end
   end
-
-  $stderr.puts "Test run took: #{t} s"
 end
 
 task :clobber do
@@ -142,23 +98,5 @@ task :build do
   end
 end
 
-namespace :spec do
-  task :define do
-    require 'rubygems'
-    require 'bundler/setup'
-    require 'rspec/core/rake_task'
-
-    RSpec::Core::RakeTask.new('spec:runner') do |t|
-      t.rspec_opts = '-f d' if ENV['TRAVIS']
-    end
-
-    task 'spec:runner' => :build
-  end
-
-  task :run => :define do
-    Rake::Task['spec:runner'].invoke
-  end
-end
-
-task :default => 'spec:run'
+task 'spec:run' => 'build:clean' unless defined?(::JRUBY_VERSION)
 

data/ext/c_zookeeper.rb

@@ -1,12 +1,16 @@
-require 'zookeeper/constants'
-require File.expand_path('../zookeeper_c', __FILE__)
+require_relative '../lib/zookeeper/common'
+require_relative '../lib/zookeeper/constants'
+require_relative 'zookeeper_c'
+
+# require File.expand_path('../zookeeper_c', __FILE__)
 
 # TODO: see if we can get the destructor to handle thread/event queue teardown
 #       when we're garbage collected
+module Zookeeper
 class CZookeeper
-  include ZookeeperCommon
-  include ZookeeperConstants
-  include ZookeeperExceptions
+  include Zookeeper::Common
+  include Zookeeper::Constants
+  include Zookeeper::Exceptions
 
   DEFAULT_SESSION_TIMEOUT_MSEC = 10000
 
@@ -209,4 +213,4 @@ class CZookeeper
       end
     end
 end
-
+end

data/ext/zookeeper_base.rb

@@ -1,16 +1,18 @@
-require File.expand_path('../c_zookeeper', __FILE__)
+# require File.expand_path('../c_zookeeper', __FILE__)
+
+require_relative 'c_zookeeper'
 require 'forwardable'
 
 # The low-level wrapper-specific methods for the C lib
 # subclassed by the top-level Zookeeper class
+module Zookeeper
 class ZookeeperBase
   extend Forwardable
-  include ZookeeperCommon
-  include ZookeeperCallbacks
-  include ZookeeperConstants
-  include ZookeeperExceptions
-  include ZookeeperACLs
-  include ZookeeperStat
+  include Zookeeper::Common       # XXX: clean this up, no need to include *everything*
+  include Zookeeper::Callbacks
+  include Zookeeper::Constants
+  include Zookeeper::Exceptions
+  include Zookeeper::ACLs
 
   # @private
   class ClientShutdownException < StandardError; end
@@ -73,6 +75,10 @@ class ZookeeperBase
     end
     
     @mutex.synchronize do
+      # keep track of what process we were in to protect
+      # against reuse after fork()
+      @pid = Process.pid
+
       # flushes all outstanding watcher reqs.
       @watcher_reqs.clear
       set_default_global_watcher
@@ -115,8 +121,14 @@ class ZookeeperBase
   # if either of these happen, the user will need to renegotiate a connection via reopen
   def assert_open
     @mutex.synchronize do
-      raise ZookeeperException::SessionExpired if state == ZOO_EXPIRED_SESSION_STATE
-      raise ZookeeperException::NotConnected   unless connected?
+      raise Exceptions::SessionExpired if state == ZOO_EXPIRED_SESSION_STATE
+      raise Exceptions::NotConnected   unless connected?
+      unless Process.pid == @pid
+        raise InheritedConnectionError, <<-EOS.gsub(/(?:^|\n)\s*/, ' ').strip
+          You tried to use a connection inherited from another process [#{@pid}]
+          You need to call reopen() after forking
+        EOS
+      end
     end
   end
 
@@ -195,7 +207,7 @@ protected
       end
     end
 
-    # pass this along to the ZookeeperCommon implementation
+    # pass this along to the Zookeeper::Common implementation
     super(req_id, meth_name, call_opts)
   end
 
@@ -229,4 +241,4 @@ protected
     @chroot_path
   end
 end
-
+end

data/ext/zookeeper_c.c

@@ -26,7 +26,9 @@
 #include "zkrb_wrapper.h"
 #include "dbg.h"
 
-static VALUE Zookeeper = Qnil;
+
+static VALUE mZookeeper = Qnil;         // the Zookeeper module
+static VALUE CZookeeper = Qnil;         // the Zookeeper::CZookeeper class
 static VALUE ZookeeperClientId = Qnil;
 
 // slyphon: possibly add a lock to this for synchronizing during get_next_event
@@ -160,7 +162,7 @@ static VALUE method_zkrb_init(int argc, VALUE* argv, VALUE self) {
 
   VALUE data;
   struct zkrb_instance_data *zk_local_ctx;
-  data = Data_Make_Struct(Zookeeper, struct zkrb_instance_data, 0, free_zkrb_instance_data, zk_local_ctx);
+  data = Data_Make_Struct(CZookeeper, struct zkrb_instance_data, 0, free_zkrb_instance_data, zk_local_ctx);
   zk_local_ctx->queue = zkrb_queue_alloc();
 
   if (zk_local_ctx->queue == NULL)
@@ -654,9 +656,9 @@ static VALUE method_zerror(VALUE self, VALUE errc) {
 
 static void zkrb_define_methods(void) {
 #define DEFINE_METHOD(method, args) { \
-    rb_define_method(Zookeeper, #method, method_ ## method, args); }
+    rb_define_method(CZookeeper, #method, method_ ## method, args); }
 #define DEFINE_CLASS_METHOD(method, args) { \
-    rb_define_singleton_method(Zookeeper, #method, method_ ## method, args); }
+    rb_define_singleton_method(CZookeeper, #method, method_ ## method, args); }
 
   // the number after the method name should be actual arity of C function - 1
   DEFINE_METHOD(zkrb_init, -1);
@@ -686,10 +688,10 @@ static void zkrb_define_methods(void) {
   // Make these class methods?
   DEFINE_METHOD(zerror, 1);
 
-  rb_define_singleton_method(Zookeeper, "set_zkrb_debug_level", klass_method_zkrb_set_debug_level, 1);
+  rb_define_singleton_method(CZookeeper, "set_zkrb_debug_level", klass_method_zkrb_set_debug_level, 1);
 
-  rb_attr(Zookeeper, rb_intern("selectable_io"), 1, 0, Qtrue);
-  rb_define_method(Zookeeper, "wake_event_loop!", method_wake_event_loop_bang, 0);
+  rb_attr(CZookeeper, rb_intern("selectable_io"), 1, 0, Qtrue);
+  rb_define_method(CZookeeper, "wake_event_loop!", method_wake_event_loop_bang, 0);
 
 }
 
@@ -712,11 +714,13 @@ static VALUE zkrb_client_id_method_initialize(VALUE self) {
 void Init_zookeeper_c() {
   ZKRBDebugging = 0;
 
-  /* initialize Zookeeper class */
-  Zookeeper = rb_define_class("CZookeeper", rb_cObject);
+  mZookeeper = rb_define_module("Zookeeper");
+
+  /* initialize CZookeeper class */
+  CZookeeper = rb_define_class_under(mZookeeper, "CZookeeper", rb_cObject);
   zkrb_define_methods();
 
-  ZookeeperClientId = rb_define_class_under(Zookeeper, "ClientId", rb_cObject);
+  ZookeeperClientId = rb_define_class_under(CZookeeper, "ClientId", rb_cObject);
   rb_define_method(ZookeeperClientId, "initialize", zkrb_client_id_method_initialize, 0);
   rb_define_attr(ZookeeperClientId, "session_id", 1, 1);
   rb_define_attr(ZookeeperClientId, "passwd", 1, 1);