zk-server 0.0.1

data/.dotfiles/rspec-logging

@@ -0,0 +1,4 @@
+--color
+--require ./spec/support/logging_progress_bar_formatter.rb
+--format Motionbox::LoggingProgressBarFormatter
+

data/.dotfiles/rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@zk-server --create

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+zookeeper/

data/.yardopts

@@ -0,0 +1,9 @@
+--protected
+--no-private
+--tag hidden_example:Hidden
+--hide-tag hidden_example
+--markup markdown
+-
+MIT_LICENSE
+README.md
+

data/Gemfile

@@ -0,0 +1,21 @@
+source :rubygems
+
+gem 'zk', :path => '~/zk'
+
+
+
+group :development do
+  gem 'pry'
+end
+
+group :docs do
+  gem 'yard', '~> 0.7.5'
+
+  platform :mri_19 do
+    gem 'redcarpet'
+  end
+end
+
+
+# Specify your gem's dependencies in zk-server.gemspec
+gemspec

data/MIT_LICENSE

@@ -0,0 +1,22 @@
+Copyright (C) 2012 by Hewlett Packard Development Company, L.P.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# ZK::Server
+
+Sets up and runs a ZooKeeper standalone server process. Intended for use during testing of zookeeper-related code. The following are the design goals:
+
+* Easy to configure and run
+* Never ever leaks a process (barring impossible circumstances)
+
+
+## Usage
+
+Example usage:
+
+```
+server = ZK::Server.new do |config|
+  config.client_port = 21811
+  config.enable_jmx = true
+  config.force_sync = false
+end
+
+server.run
+
+# do a bunch of stuff (like run your specs)
+
+server.shutdown
+```
+
+For full options, see [ZK::Server::Config](http://rubydoc.info/github/slyphon/zk-server/master/ZK/Server/Config)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+namespace :yard do
+  task :clean do
+    rm_rf '.yardoc'
+  end
+
+  task :server => :clean do
+    sh "yard server --reload"
+  end
+end
+
+task :clean => 'yard:clean'
+
+

data/lib/zk-server/config.rb

@@ -0,0 +1,138 @@
+module ZK
+  module Server
+    class Config
+      DEFAULT_JVM_FLAGS = %w[
+        -server 
+        -Xmx256m
+        -Dzookeeper.serverCnxnFactory=org.apache.zookeeper.server.NettyServerCnxnFactory 
+      ].freeze
+
+      # the com.sun.managemnt.jmxremote.port arg will be filled in dynamically
+      # based on the {#jmx_port} value
+      #
+      DEFAULT_JMX_ARGS = %w[
+        -Dcom.sun.management.jmxremote=true
+        -Dcom.sun.management.jmxremote.local.only=false
+        -Dcom.sun.management.jmxremote.authenticate=false
+        -Dcom.sun.management.jmxremote.ssl=false
+      ].freeze
+
+      ZOO_MAIN = 'org.apache.zookeeper.server.quorum.QuorumPeerMain'.freeze
+
+      # The top level directory we will store all of our data under. used as the
+      # basis for all other path generation. Defaults to `File.join(Dir.getwd, 'zookeeper')`
+      attr_accessor :base_dir
+
+      # a hash that will be used to provide extra values for the zoo.cfg file.
+      # keys are written as-is to the file, so they should be camel-cased. 
+      #
+      # dataDir will be set relative to {#base_dir} and clientPort will either use
+      # the default of 2181, or can be adjusted by {#client_port=}
+      # 
+      attr_accessor :zoo_cfg_hash
+
+      # what port should the server listen on for connections? (default 2181)
+      attr_accessor :client_port
+      alias port client_port
+      alias port= client_port=
+
+      # maximum number of client connections (defaults to 100)
+      attr_accessor :max_client_cnxns
+
+      # defaults to 2000
+      attr_accessor :tick_time
+
+      # from the [admin guide](http://zookeeper.apache.org/doc/r3.3.5/zookeeperAdmin.html)
+      #
+      # > ZooKeeper logs transactions to a transaction log. After snapCount
+      # > transactions are written to a log file a snapshot is started and a new
+      # > transaction log file is created. The default snapCount is 100,000.
+      #
+      # For testing, to speed up disk IO, I generally set this to 1_000_000 and
+      # force_sync to false. YMMV, understand what this does before messing with it
+      # if you care about your data. 
+      #
+      # default: unset
+      attr_accessor :snap_count
+
+      # This value can make testing go faster, as zookeeper doesn't have to issue
+      # an fsync() call for each snapshot write. It is however DANGEROUS if you
+      # care about the data. (I set it to false for running tests)
+      #
+      # default: no value set
+      attr_accessor :force_sync
+
+      # if truthy, will enable jmx (defaults to false)
+      # note that our defualt jmx config has all security and auth turned off
+      # if you want to customize this, then use jvm_flags and set this to false
+      attr_accessor :enable_jmx
+
+      # default jmx port is 22222
+      attr_accessor :jmx_port
+
+      # array to which additional JVM flags should be added
+      #
+      # default is {DEEFAULT_JVM_FLAGS}
+      attr_accessor :jvm_flags
+
+      def initialize(opts={})
+        @base_dir = File.join(Dir.getwd, 'zookeeper')
+        @zoo_cfg_hash = {}
+        @tick_time    = 2000
+        @client_port  = 2181
+        @snap_count   = nil
+        @force_sync   = nil
+        @jmx_port     = 22222
+        @enable_jmx   = false
+        @jvm_flags    = DEFAULT_JVM_FLAGS.dup
+
+        @max_client_cnxns = 100
+
+        opts.each { |k,v| __send__(:"#{k}=", v) }
+      end
+
+      # @private
+      def zoo_cfg_path
+        File.join(base_dir, 'zoo.cfg')
+      end
+
+      # @private
+      def log4j_props_path
+        File.join(base_dir, 'log4j.properties')
+      end
+
+      # @private
+      def log_dir
+        File.join(base_dir, 'log')
+      end
+
+      # @private
+      def stdio_redirect_path
+        File.join(log_dir, 'zookeeper.out')
+      end
+
+      # @private
+      def data_dir
+        File.join(base_dir, 'data')
+      end
+
+      # @private
+      def classpath
+        @classpath ||= [Server.zk_jar_path, Server.log4j_jar_path, base_dir]
+      end
+
+      # @private
+      def command_args
+        cmd = [Server.java_binary_path]
+        cmd += %W[-Dzookeeper.log.dir=#{log_dir} -Dzookeeper.root.logger=INFO,CONSOLE]
+        if enable_jmx
+          cmd += DEFAULT_JMX_ARGS
+          cmd << "-Dcom.sun.management.jmxremote.port=#{jmx_port}"
+        end
+        cmd += jvm_flags
+        cmd += %W[-cp #{classpath.join(':')} #{ZOO_MAIN} #{zoo_cfg_path}]
+      end
+    end
+  end
+end
+

data/lib/zk-server/log4j.properties

@@ -0,0 +1,17 @@
+# DEFAULT: console appender only
+log4j.rootLogger=INFO, ROLLINGFILE
+
+# Add ROLLINGFILE to rootLogger to get log file output
+#    Log DEBUG level and above messages to a log file
+log4j.appender.ROLLINGFILE=org.apache.log4j.RollingFileAppender
+log4j.appender.ROLLINGFILE.Threshold=DEBUG
+log4j.appender.ROLLINGFILE.File=${zookeeper.log.dir}/zookeeper.log
+
+# Max log file size of 10MB
+log4j.appender.ROLLINGFILE.MaxFileSize=10MB
+# uncomment the next line to limit number of backup files
+#log4j.appender.ROLLINGFILE.MaxBackupIndex=10
+
+log4j.appender.ROLLINGFILE.layout=org.apache.log4j.PatternLayout
+log4j.appender.ROLLINGFILE.layout.ConversionPattern=%d{ISO8601} - %-5p [%t:%C{1}@%L] - %m%n
+

data/lib/zk-server/process.rb

@@ -0,0 +1,198 @@
+module ZK
+  module Server
+    # This encapsulates the logic of running the zookeeper server, as a sub-process.
+    # It is intended that it will be stopped and started with the process that starts it.
+    # We are not going to do daemonized process management. 
+    #
+    # By default, we will create a directory in the current working directory called 'zk-server'
+    # to store our data under (configurable). 
+    #
+    class Process
+      include ZK::Logging
+      extend Forwardable
+      include FileUtils::Verbose
+
+      def_delegators :config,
+        :base_dir, :data_dir, :log4j_props_path, :log_dir, :command_args,
+        :tick_time, :snap_count, :force_sync, :zoo_cfg_hash, :client_port,
+        :max_client_cnxns, :stdio_redirect_path, :zoo_cfg_path
+
+      # the {Config} object that will be used to configure this Process
+      attr_accessor :config
+
+      attr_reader :exit_status
+
+      # how long should we wait for the child to start responding to 'ruok'?
+      attr_accessor :child_startup_timeout
+
+      def initialize(opts={})
+        @child_startup_timeout = opts.delete(:child_startup_timeout, 5)
+        @run_called = false
+        @config = Config.new(opts)
+        @exit_watching_thread = nil
+
+        @pid = nil
+        @exit_status = nil
+
+        @mutex      = Monitor.new
+        @exit_cond  = @mutex.new_cond
+      end
+
+      # removes all files related to this instance
+      # runs {#shutdown} first
+      def clobber!
+        shutdown
+        FileUtils.rm_rf(base_dir)
+      end
+
+      # true if the process was started and is still running
+      def running?
+        spawned? and !@exit_status and !!::Process.kill(0, @pid)
+      rescue Errno::ESRCH
+        false
+      end
+
+      # have we started the child process?
+      def spawned?
+        !!@pid
+      end
+
+      # shutdown the child, wait for it to exit, ensure it is dead
+      def shutdown
+        if @pid
+          return if @exit_status
+
+          @mutex.synchronize do
+            %w[HUP TERM KILL].each do |signal|
+              logger.debug { "sending #{signal} to #{@pid}" }
+
+              begin
+                ::Process.kill(signal, @pid)
+              rescue Errno::ESRCH
+                break
+              end
+
+              if @exit_status or @exit_cond.wait(5)
+                logger.debug { "process exited" }
+                break
+              end
+            end
+          end
+
+          logger.debug { "@exit_status: #{@exit_status}" }
+        end
+        true
+      end
+
+      # can we connect to the server, issue an 'ruok', and receive an 'imok'?
+      def ping?
+        TCPSocket.open('localhost', client_port) do |sock|
+          sock.puts('ruok')
+          sock.read == 'imok'
+        end
+      rescue
+        false
+      end
+
+      # the pid of our child process
+      def pid
+        @pid
+      end
+
+      # start the child, using the {#config}. we create the files necessary,
+      # fork the child, and wait 5s for the child to start responding to pings
+      #
+      #
+      # @return [false,true] false if run has already been called on this instance
+      #   true if we hav
+      def run
+        return false if @run_called
+        @run_called = true
+
+        create_files!
+        fork_and_exec!
+        spawn_exit_watching_thread
+
+        unless wait_until_ping
+          raise "Oh noes! something went wrong!" unless running?
+        end
+
+        at_exit { self.shutdown }
+
+        true
+      end
+
+      protected
+        def wait_until_ping(timeout=5)
+          times_up = timeout ? Time.now + timeout : 0
+          while Time.now < times_up
+            return true if ping?
+          end
+          false
+        end
+
+        def spawn_exit_watching_thread
+          @exit_watching_thread ||= Thread.new do
+            _, @exit_status = ::Process.wait2(@pid)
+            @mutex.synchronize do
+              @exit_cond.broadcast
+            end
+          end
+        end
+
+        # wait for up to timeout seconds to pass, polling for completion
+        # returns nil if the process didn't exit
+        def wait_for_pid(timeout=2)
+          times_up = timeout ? Time.now + timeout : 0
+
+          while Time.now < times_up
+            pid, stat = ::Process.wait2(@pid, ::Process::WNOHANG)
+            return stat if stat
+            sleep(0.01)
+          end
+
+          nil
+        end
+
+        def fork_and_exec!
+          @pid ||= (
+            args = command_args()
+            args << {:err => [:child, :out], :out => [stdio_redirect_path, File::APPEND|File::CREAT|File::WRONLY]}
+            spawn({}, *command_args)
+          )
+        end
+
+        def create_files!
+          mkdir_p base_dir
+          mkdir_p data_dir
+          write_zoo_cfg!
+          write_log4j_properties!
+        end
+
+        def write_log4j_properties!
+          unless File.exists?(log4j_props_path)
+            cp Server.default_log4j_props_path, log4j_props_path
+          end
+        end
+
+        def write_zoo_cfg!
+          File.open(zoo_cfg_path, 'w') do |fp|
+            fp.puts <<-EOS
+tickTime=#{tick_time}
+dataDir=#{data_dir}
+clientPort=#{client_port}
+maxClientCnxns=#{max_client_cnxns}
+            EOS
+
+            fp.puts("forceSync=#{force_sync}") if force_sync
+            fp.puts("snapCount=#{snap_count}") if snap_count
+            zoo_cfg_hash.each do |k,v|
+              fp.puts("#{k}=#{v}")
+            end
+
+            fp.fsync
+          end
+        end
+    end
+  end
+end

data/lib/zk-server/version.rb

@@ -0,0 +1,5 @@
+module ZK
+  module Server
+    VERSION = "0.0.1"
+  end
+end

data/lib/zk-server.rb

@@ -0,0 +1,81 @@
+# Yes, i know, this is arguably bad form, but i'm actually going to use bundler
+# as an API
+require 'rubygems'
+require 'bundler/setup'
+require 'fileutils'
+require 'forwardable'
+require 'logger'
+require 'socket'
+
+Bundler.require
+
+require 'zk'
+
+#ZK.logger = Logger.new($stderr).tap { |l| l.level = Logger::DEBUG }
+
+module ZK
+  module Server
+    ZK_JAR_GEM  = 'slyphon-zookeeper_jar'
+    LOG4J_GEM   = 'slyphon-log4j'
+
+    # Create a new {ZK::Server::Process} instance. if a block is given
+    # then yield the {Config} object to the block
+    #
+    # @yield [Config] server config instance if block given
+    def self.new(opts={})
+      Server::Process.new(opts).tap do |server|
+        yield server.config if block_given?
+      end
+    end
+
+    def self.zk_jar_path
+      # in future revisions of the zookeeper jar, we'll make it easier to get
+      # at this information without needing rubygems and bundler to get at it,
+      # but for now this is the best way
+
+      @zk_jar_path ||= get_jar_paths_from_gem(ZK_JAR_GEM).first
+    end
+
+    def self.log4j_jar_path
+      @log4j_jar_path ||= get_jar_paths_from_gem(LOG4J_GEM).first
+    end
+
+    def self.get_jar_paths_from_gem(gem_name)
+      glob = "#{get_spec_for(gem_name).lib_dirs_glob}/**/*.jar"
+
+      Dir[glob].tap do |ary|
+        raise "gem #{gem_name} did not contain any jars (using glob: #{glob.inspect})" if ary.empty?
+      end
+    end
+
+    def self.get_spec_for(gem_name)
+      not_found = proc do
+        raise "could not locate the #{gem_name} Gem::Specification! wtf?!"
+      end
+
+      Bundler.load.specs.find(not_found) { |s| s.name == gem_name }
+    end
+
+    def self.java_binary_path=(path)
+      @java_binary_path = path
+    end
+
+    def self.java_binary_path
+      @java_binary_path ||= which('java')
+    end
+
+    def self.which(bin_name)
+      if_none = proc { "Could not find #{bin_name} in PATH: #{ENV['PATH'].inspect}" }
+      ENV['PATH'].split(':').map{|n| File.join(n, bin_name) }.find(if_none) {|x| File.executable?(x) }
+    end
+
+    def self.default_log4j_props_path
+      File.expand_path('../zk-server/log4j.properties', __FILE__)
+    end
+  end
+end
+
+require 'zk-server/version'
+require 'zk-server/config'
+require 'zk-server/process'
+

data/zk-server.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/zk-server/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = ["Jonathan D. Simms"]
+  s.email         = ["slyphon@gmail.com"]
+  s.description   = %q{runs a standalone zookeeper server}
+  s.summary       = s.description + "\n"
+  s.homepage      = ""
+
+  s.add_runtime_dependency 'bundler', '~> 1.1.3'
+  s.add_runtime_dependency 'zk', '>= 1.0.0'
+  s.add_runtime_dependency 'slyphon-log4j', '= 1.2.15'
+  s.add_runtime_dependency 'slyphon-zookeeper_jar', '~> 3.3.5'
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.name          = "zk-server"
+  s.require_paths = ["lib"]
+  s.version       = ZK::Server::VERSION
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: zk-server
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jonathan D. Simms
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-02 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 1
+        - 3
+        version: 1.1.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: zk
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: slyphon-log4j
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 2
+        - 15
+        version: 1.2.15
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: slyphon-zookeeper_jar
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 3
+        - 5
+        version: 3.3.5
+  type: :runtime
+  version_requirements: *id004
+description: runs a standalone zookeeper server
+email: 
+- slyphon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .dotfiles/rspec-logging
+- .dotfiles/rvmrc
+- .gitignore
+- .yardopts
+- Gemfile
+- MIT_LICENSE
+- README.md
+- Rakefile
+- lib/zk-server.rb
+- lib/zk-server/config.rb
+- lib/zk-server/log4j.properties
+- lib/zk-server/process.rb
+- lib/zk-server/version.rb
+- zk-server.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: runs a standalone zookeeper server
+test_files: []
+