blender-zk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e2737454d88462d18113150662f39f2c6a51105
+  data.tar.gz: 0a5239083b3c5ff50dc6a0c238e531d25ec83f87
+SHA512:
+  metadata.gz: ca5b2ed888f5fcd1677e7a54a489a2d0352129e27eaaf20e31be41d9c4b1831b137a5db6f1ed752f7f7d17d6749206a72ea98e4266285479f216361b94da076c
+  data.tar.gz: 00880d15b3e1f2cc3b4053bf8d1544c8bb8710965c53f374a52bf85a28eb75f4c56ab2d2b85535baadd107501a7e273b0f479c7eadf8cbefe587f76cf65b8cd8

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+zookeeper*

data/.travis.yml

@@ -0,0 +1,11 @@
+before_install:
+  - ./build.sh
+  - bundle install --path .bundle
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - 2.1.2
+branches:
+  only:
+    - master
+script: "bundle exec rake spec"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blender-zk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright:: Copyright (c) 2014 PagerDuty, Inc.
+License:: Apache License, Version 2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Blender::Zk
+
+Zookeeper integration for blender. It allows [Blender](https://github.com/PagerDuty/blender)
+to use zookeeper for locking. Blender jobs running in different nodes can synchornize/coordinate using
+zookeeper.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blender-zk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blender-zk
+
+## Usage
+
+- Blender by default used file based locking (flock/fcntl) for locking. You have
+to explicitly tell blender to use zookeeper locking interface. This can be done
+using the `lock_options` DSL method. It take the locking driver name ('zk'
+ in our case).
+
+```ruby
+Blender.blend('test-1') do |sched|
+  sched.members(['localhost'])
+  sched.lock_options('zk')
+  sched.ruby_task('date') do
+    execute do
+      sleep 10
+      puts 'This will succeed'
+    end
+  end
+end
+
+## in another script
+Blender.blend('test-1') do |sched|
+  sched.members(['localhost'])
+  sched.lock_options('zk')
+  sched.ruby_task('date') do
+    execute do
+      puts 'This will fail, if both jobs are triggered at the same time '
+    end
+  end
+end
+```
+By default blender-zk will use the job name 'test-1' as key name. This, and
+other options (lock wait timeout, chroot etc) can be passed as option
+
+```ruby
+Blender.blend('test-1') do |sched|
+  sched.members(['localhost'])
+  sched.lock_options('zk', path: '/path/to/lock')
+  sched.ruby_task('date') do
+    execute do
+      sleep 3
+    end
+  end
+end
+### in another script
+Blender.blend('test-2') do |sched|
+  sched.members(['localhost'])
+  sched.lock_options('zk', path: '/path/to/lock', timeout: 5)
+  sched.ruby_task('date') do
+    execute do
+      puts 'This wont fail, since it will wait 5 second, by then the first job will finish'
+    end
+  end
+end
+```
+
+## License
+[Apache 2](http://www.apache.org/licenses/LICENSE-2.0)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/blender-zk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = %w{spec/**/*_spec.rb}
+end

data/blender-zk.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blender/zk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blender-zk'
+  spec.version       = Blender::Zk::VERSION
+  spec.authors       = ['Ranjib Dey']
+  spec.email         = ['ranjib@pagerduty.com']
+  spec.summary       = %q{Blender-Zookeeper integration}
+  spec.description   = %q{Allows zookeeper based locks in blender}
+  spec.homepage      = 'https://github.com/PagerDuty/blender-zk'
+  spec.license       = 'Apache 2'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'pd-blender'
+  spec.add_dependency 'zk'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/build.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+ls -l zookeeper-3.4.6.tar.gz || wget -c http://mirrors.gigenet.com/apache/zookeeper/zookeeper-3.4.6/zookeeper-3.4.6.tar.gz
+ls -l zookeeper-3.4.6/build.xml || tar -zxvf zookeeper-3.4.6.tar.gz
+ls -l zookeeper-3.4.6/conf/zoo.cfg || cp zookeeper-3.4.6/conf/zoo_sample.cfg zookeeper-3.4.6/conf/zoo.cfg
+./zookeeper-3.4.6/bin/zkServer.sh start

data/lib/blender/lock/zk.rb

@@ -0,0 +1,45 @@
+#
+# Author:: Ranjib Dey (<ranjib@pagerduty.com>)
+# Copyright:: Copyright (c) 2014 PagerDuty, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'zk'
+require 'zk/locker'
+require 'blender/exceptions'
+
+module Blender
+  module Lock
+    class Zk
+
+      def initialize(name, options = {})
+        @path = options[:path] || name
+        @hosts = options[:hosts] || 'localhost:2181'
+        @chroot = options[:chroot] || :do_nothing
+        @thread = options[:thread] || :single
+        @timeout = options[:timeout] || 0
+      end
+
+      def with_lock
+        ZK.open(@hosts) do |zk|
+          zk.with_lock(@path, wait: @timeout) do
+            yield if block_given?
+          end
+        end
+      rescue ZK::Exceptions::LockWaitTimeoutError => e
+        raise LockAcquisitionError, e.message
+      end
+    end
+  end
+end

data/lib/blender/zk.rb

@@ -0,0 +1,19 @@
+#
+# Author:: Ranjib Dey (<ranjib@pagerduty.com>)
+# Copyright:: Copyright (c) 2014 PagerDuty, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'blender/zk/version'
+require 'blender/lock/zk'

data/lib/blender/zk/version.rb

@@ -0,0 +1,22 @@
+#
+# Author:: Ranjib Dey (<ranjib@pagerduty.com>)
+# Copyright:: Copyright (c) 2014 PagerDuty, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Blender
+  module Zk
+    VERSION = "0.0.1"
+  end
+end

data/spec/blender/lock_zk_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'thread'
+
+Thread.abort_on_exception = true
+
+describe Blender::Lock::Zk do
+
+  context 'raw api' do
+    it 'without timeout' do
+      t = Thread.new do
+        l1 = Blender::Lock::Zk.new( '/a/b/c')
+        l1.with_lock do
+          sleep 2
+        end
+      end
+      sleep 1
+
+      l2 = Blender::Lock::Zk.new( '/a/b/c')
+      expect do
+        l2.with_lock do
+          puts 'Unreachable code'
+        end
+      end.to raise_error(Blender::LockAcquisitionError)
+      t.join
+    end
+
+    it 'with timeout' do
+      t = Thread.new do
+        l1 = Blender::Lock::Zk.new( '/a/b/c')
+        l1.with_lock do
+          sleep 2
+        end
+      end
+      sleep 1
+
+      l2 = Blender::Lock::Zk.new( '/a/b/c', timeout: 3)
+      expect do
+        l2.with_lock do
+          x = 1 # Solution to NP hard problems
+        end
+      end.not_to raise_error
+      t.join
+    end
+  end
+
+  context 'with blender dsl' do
+
+    it 'lock without timeout inside dsl' do
+      t = Thread.new do
+        Blender.blend('test-1') do |sched|
+          sched.members(['localhost'])
+          sched.lock_options('zk')
+          sched.ruby_task('date') do
+            execute do
+              sleep 2
+            end
+          end
+        end
+      end
+      sleep 1
+      expect do
+        Blender.blend('test-1') do |sched|
+          sched.members(['localhost'])
+          sched.lock_options('zk')
+          sched.ruby_task('date') do
+            execute do
+              puts 'Should fail'
+            end
+          end
+        end
+      end.to raise_error(Blender::LockAcquisitionError)
+      t.join
+    end
+
+    it 'lock with timeout' do
+      t = Thread.new do
+        Blender.blend('test-1') do |sched|
+          sched.members(['localhost'])
+          sched.lock_options('zk')
+          sched.ruby_task('date') do
+            execute do
+              sleep 2
+            end
+          end
+        end
+      end
+      sleep 1
+      expect do
+        Blender.blend('test-1') do |sched|
+          sched.members(['localhost'])
+          sched.lock_options('zk', timeout: 5)
+          sched.ruby_task('date') do
+            execute do
+              x = 2 # Another solution to NP hard problem
+            end
+          end
+        end
+      end.not_to raise_error
+      t.join
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+
+require 'rspec'
+require 'rspec/mocks'
+require 'rspec/expectations'
+require 'blender'
+require 'blender/zk'
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+  end
+  config.before(:each) do
+    doc = double(Blender::Handlers::Doc).as_null_object
+    allow(Blender::Handlers::Doc).to receive(:new).and_return(doc)
+  end
+  config.backtrace_exclusion_patterns = []
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: blender-zk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ranjib Dey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pd-blender
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows zookeeper based locks in blender
+email:
+- ranjib@pagerduty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blender-zk.gemspec
+- build.sh
+- lib/blender/lock/zk.rb
+- lib/blender/zk.rb
+- lib/blender/zk/version.rb
+- spec/blender/lock_zk_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PagerDuty/blender-zk
+licenses:
+- Apache 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Blender-Zookeeper integration
+test_files:
+- spec/blender/lock_zk_spec.rb
+- spec/spec_helper.rb