vcap-concurrency 0.1.0

data/spec/proxy_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe VCAP::Concurrency::Proxy do
+  describe "#method_missing" do
+    it "should proxy method calls to the underlying object" do
+      proxied_object = ["hi"]
+      proxy = VCAP::Concurrency::Proxy.new(proxied_object)
+      proxy << "there"
+
+      proxied_object.should == ["hi", "there"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "thread"
+
+require "vcap/concurrency"

data/spec/thread_pool_spec.rb

@@ -0,0 +1,175 @@
+require "set"
+
+require "spec_helper"
+
+$stdout.sync = true
+
+describe VCAP::Concurrency::ThreadPool do
+  describe "#start" do
+    it "should raise an error if it has already been started or stopped" do
+      tp = VCAP::Concurrency::ThreadPool.new(1)
+      tp.start
+
+      # Started
+      expect do
+        tp.start
+      end.to raise_error(/invalid state/i)
+
+      # Stopped
+      tp.stop
+      expect do
+        tp.start
+      end.to raise_error(/invalid state/i)
+    end
+
+    it "should start the requested number of worker threads" do
+      waiting = VCAP::Concurrency::AtomicVar.new(0)
+      barrier = Mutex.new
+      num_threads = 5
+      promises = []
+      tp = VCAP::Concurrency::ThreadPool.new(num_threads)
+
+      # Each worker notifies the main thread that it is ready. When all workers
+      # have checked in, the main thread unblocks them all.
+      num_threads.times do |ii|
+        promises << tp.enqueue do
+          waiting.mutate { |v| v + 1 }
+
+          barrier.synchronize {}
+
+          Thread.current
+        end
+      end
+
+      barrier.lock
+
+      tp.start
+
+      # Wait until all threads have checked in
+      wait_threads_active(waiting, num_threads)
+
+      # Let all threads proceed
+      barrier.unlock
+
+      # Wait for the threads to finish and collect our result
+      results = Set.new(promises.map { |p| p.resolve })
+
+      tp.shutdown
+
+      results.length.should == num_threads
+    end
+  end
+
+  describe "#enqueue" do
+    it "should raise an error if the pool is stopped" do
+      tp = VCAP::Concurrency::ThreadPool.new(1)
+
+      tp.stop
+      expect do
+        tp.enqueue { true }
+      end.to raise_error(/invalid state/i)
+    end
+
+    it "should be responsible for executing the supplied bock in a worker" do
+      tp = VCAP::Concurrency::ThreadPool.new(1)
+      expected_result = fib(5)
+      promise = tp.enqueue { fib(5) }
+
+      tp.start
+
+      result = promise.resolve
+
+      tp.shutdown
+
+      result.should == expected_result
+    end
+
+    it "should propagate exceptions thrown in the block" do
+      tp = VCAP::Concurrency::ThreadPool.new(1)
+      e = RuntimeError.new("test")
+      promise = tp.enqueue { raise e }
+
+      tp.start
+
+      expect do
+        promise.resolve
+      end.to raise_error(e)
+
+      tp.shutdown
+    end
+  end
+
+  describe "#stop" do
+    it "should allow existing work to be processed" do
+      waiting = VCAP::Concurrency::AtomicVar.new(0)
+      barrier = Mutex.new
+      num_threads = 5
+      promises = []
+      tp = VCAP::Concurrency::ThreadPool.new(num_threads)
+
+      # Each worker notifies the main thread that it is ready. When all workers
+      # have checked in, the main thread unblocks them all.
+      num_threads.times do |ii|
+        promises << tp.enqueue do
+          waiting.mutate { |v| v + 1 }
+
+          barrier.synchronize {}
+
+          ii
+        end
+      end
+
+      barrier.lock
+
+      tp.start
+
+      # Wait until all threads have checked in
+      wait_threads_active(waiting, num_threads)
+
+      # All threads are active here, but cannot proceed until we unlock the
+      # barrier. Thus, any work added here must live in the queue.
+      num_threads.times do |ii|
+        promises << tp.enqueue { ii + num_threads }
+      end
+
+      tp.stop
+
+      # Let all threads proceed
+      barrier.unlock
+
+      # Wait for the threads to finish and collect our results
+      results = promises.map { |p| p.resolve }
+
+      tp.join
+
+      results.length.should == 2 * num_threads
+    end
+  end
+
+  describe "#join" do
+    it "should raise an error unless the pool has been started or stopped" do
+      tp = VCAP::Concurrency::ThreadPool.new(5)
+      expect do
+        tp.join
+      end.to raise_error(/invalid state/i)
+    end
+  end
+
+  def wait_threads_active(counter, expected)
+    cur = 0
+    done = false
+    while (cur = counter.wait_value_changed(cur)) != expected
+    end
+  end
+
+  def fib(ii)
+    case ii
+    when 1
+      1
+    when 0
+      1
+    else
+      fib(ii - 1) + fib(ii - 2)
+    end
+  end
+end

data/vcap-concurrency.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/vcap/concurrency/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["VMware"]
+  gem.email         = ["support@vmware.com"]
+  gem.description   = "Provides utility classes to support common patterns" \
+                      + " in concurrent programming."
+  gem.summary       = %q{Concurrency related utility classes}
+  gem.homepage      = "http://www.cloudfoundry.org"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "vcap-concurrency"
+  gem.require_paths = ["lib"]
+  gem.version       = VCAP::Concurrency::VERSION
+
+  gem.add_development_dependency("ci_reporter")
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec")
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: vcap-concurrency
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- VMware
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides utility classes to support common patterns in concurrent programming.
+email:
+- support@vmware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vcap/concurrency.rb
+- lib/vcap/concurrency/atomic_var.rb
+- lib/vcap/concurrency/errors.rb
+- lib/vcap/concurrency/promise.rb
+- lib/vcap/concurrency/proxy.rb
+- lib/vcap/concurrency/thread_pool.rb
+- lib/vcap/concurrency/version.rb
+- spec/atomic_var_spec.rb
+- spec/promise_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb
+- spec/thread_pool_spec.rb
+- vcap-concurrency.gemspec
+homepage: http://www.cloudfoundry.org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Concurrency related utility classes
+test_files:
+- spec/atomic_var_spec.rb
+- spec/promise_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb
+- spec/thread_pool_spec.rb