bosh_common 0.4.0

data/README

@@ -0,0 +1 @@
+BOSH common / shared classes

data/Rakefile

@@ -0,0 +1,51 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+$:.unshift(File.expand_path("../../rake", __FILE__))
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+require "rake"
+begin
+  require "rspec/core/rake_task"
+rescue LoadError
+end
+
+require "bundler_task"
+require "ci_task"
+
+gem_helper = Bundler::GemHelper.new(Dir.pwd)
+
+desc "Build Blobstore Client gem into the pkg directory"
+task "build" do
+  gem_helper.build_gem
+end
+
+desc "Build and install Blobstore Client into system gems"
+task "install" do
+  sh("bundle install --local --without test development")
+  gem_helper.install_gem
+end
+
+BundlerTask.new
+
+if defined?(RSpec)
+  namespace :spec do
+    desc "Run Unit Tests"
+    rspec_task = RSpec::Core::RakeTask.new(:unit) do |t|
+      t.gemfile = "Gemfile"
+      t.pattern = "spec/unit/**/*_spec.rb"
+      t.rspec_opts = %w(--format progress --colour)
+    end
+
+    CiTask.new do |task|
+      task.rspec_task = rspec_task
+    end
+  end
+
+  desc "Install dependencies and run tests"
+  task :spec => %w(bundler:install:test spec:unit)
+end

data/lib/common/thread_formatter.rb

@@ -0,0 +1,51 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+class ThreadFormatter
+  FORMAT = "%s, [%s#%d] [%s] %5s -- %s: %s\n"
+
+  attr_accessor :datetime_format
+
+  def initialize
+    @datetime_format = nil
+  end
+
+  def call(severity, time, progname, msg)
+    thread_name = Thread.current[:name] || "0x#{Thread.current.object_id.to_s(16)}"
+    FORMAT % [severity[0..0], format_datetime(time), $$, thread_name, severity, progname,
+              msg2str(msg)]
+  end
+
+  private
+
+  def format_datetime(time)
+    if @datetime_format.nil?
+      time.strftime("%Y-%m-%dT%H:%M:%S.") << "%06d " % time.usec
+    else
+      time.strftime(@datetime_format)
+    end
+  end
+
+  def msg2str(msg)
+    case msg
+      when ::String
+        msg
+      when ::Exception
+        "#{ msg.message } (#{ msg.class })\n" <<
+            (msg.backtrace || []).join("\n")
+      else
+        msg.inspect
+    end
+  end
+end
+
+module Kernel
+
+  def with_thread_name(name)
+    old_name = Thread.current[:name]
+    Thread.current[:name] = name
+    yield
+  ensure
+    Thread.current[:name] = old_name
+  end
+
+end

data/lib/common/thread_pool.rb

@@ -0,0 +1,130 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+require "logger"
+
+module Bosh
+
+  class ThreadPool
+
+    def initialize(options = {})
+      @actions = []
+      @lock = Mutex.new
+      @cv = ConditionVariable.new
+      @max_threads = options[:max_threads] || 1
+      @available_threads = @max_threads
+      @logger = options[:logger]
+      @boom = nil
+      @original_thread = Thread.current
+      @threads = []
+      @state = :open
+    end
+
+    def wrap
+      begin
+        yield self
+        wait
+      ensure
+        shutdown
+      end
+    end
+
+    def pause
+      @lock.synchronize do
+        @state = :paused
+      end
+    end
+
+    def resume
+      @lock.synchronize do
+        @state = :open
+        [@available_threads, @actions.size].min.times do
+          @available_threads -= 1
+          create_thread
+        end
+      end
+    end
+
+    def process(&block)
+      @lock.synchronize do
+        @actions << block
+        if @state == :open
+          if @available_threads > 0
+            @logger.debug("Creating new thread")
+            @available_threads -= 1
+            create_thread
+          else
+            @logger.debug("All threads are currently busy, queuing action")
+          end
+        elsif @state == :paused
+          @logger.debug("Pool is paused, queueing action.")
+        end
+      end
+    end
+
+    def create_thread
+      thread = Thread.new do
+        begin
+          loop do
+            action = nil
+            @lock.synchronize do
+              action = @actions.shift unless @boom
+              if action
+                @logger.debug("Found an action that needs to be processed")
+              else
+                @logger.debug("Thread is no longer needed, cleaning up")
+                @available_threads += 1
+                @threads.delete(thread) if @state == :open
+              end
+            end
+
+            break unless action
+
+            begin
+              action.call
+            rescue Exception => e
+              raise_worker_exception(e)
+            end
+          end
+        end
+        @lock.synchronize { @cv.signal unless working? }
+      end
+      @threads << thread
+    end
+
+    def raise_worker_exception(exception)
+      if exception.respond_to?(:backtrace)
+        @logger.debug("Worker thread raised exception: #{exception} - #{exception.backtrace.join("\n")}")
+      else
+        @logger.debug("Worker thread raised exception: #{exception}")
+      end
+      @lock.synchronize do
+        @boom = exception if @boom.nil?
+      end
+    end
+
+    def working?
+      @boom.nil? && (@available_threads != @max_threads || !@actions.empty?)
+    end
+
+    def wait
+      @logger.debug("Waiting for tasks to complete")
+      @lock.synchronize do
+        @cv.wait(@lock) while working?
+        raise @boom if @boom
+      end
+    end
+
+    def shutdown
+      return if @state == :closed
+      @logger.debug("Shutting down pool")
+      @lock.synchronize do
+        return if @state == :closed
+        @state = :closed
+        @actions.clear
+      end
+      @threads.each { |t| t.join }
+    end
+
+  end
+
+end

data/lib/common/version.rb

@@ -0,0 +1,7 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+module Bosh
+  module Common
+    VERSION = "0.4.0"
+  end
+end

data/spec/Rakefile

@@ -0,0 +1,87 @@
+require "tempfile"
+require "rake"
+
+APP_DIR = File.expand_path(File.join("..", ".."), __FILE__)
+ENV["BUNDLE_GEMFILE"] ||= File.join(APP_DIR, "Gemfile")
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+require "rspec/core/rake_task"
+require "ci/reporter/rake/rspec"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern    = "**/*_spec.rb"
+  t.rspec_opts = %w[--color]
+end
+
+task :default => [:spec]
+
+coverage_dir   = File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_coverage"))
+reports_dir    = File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_reports"))
+dump_file      = File.join(Dir.tmpdir, "bosh-common.rcov")
+
+ENV["CI_REPORTS"] = reports_dir
+
+namespace "spec" do
+  gemfile   = "../Gemfile"
+  spec_opts = ["--format", "documentation", "--colour"]
+
+  if RUBY_VERSION < "1.9"
+    desc "Run specs for ci"
+    task "ci" => [ "ci:setup:rspec", "spec:rcov", "convert_rcov_to_clover" ]
+
+    desc "Run spec with coverage"
+    RSpec::Core::RakeTask.new("rcov") do |t|
+      FileUtils.rm_rf(dump_file)
+      t.gemfile    = gemfile
+      t.pattern    = "**/*_spec.rb"
+      t.rspec_opts = ["--format", "progress", "--colour"]
+      t.rcov       = true
+      t.rcov_opts  = %W{--aggregate #{dump_file} --exclude osx\/objc,gems\/,spec\/,unit\/,features\/ -o "#{coverage_dir}"}
+    end
+
+    task "convert_rcov_to_clover" do |t|
+      ignore_pattern = "spec,[.]bundle,[/]gems[/]"
+      clover_output  = File.join(coverage_dir, "clover.xml")
+
+      sh("bundle exec rcov_analyzer #{dump_file} #{ignore_pattern} > #{clover_output}")
+      FileUtils.rm_rf(dump_file)
+    end
+
+  else
+    desc "Run specs for ci"
+    task "ci" => [ "ci:setup:rspec", "spec:rcov" ]
+
+    desc "Run spec with coverage"
+    task :rcov => :cleanup_coverage do
+      require "simplecov"
+      require "simplecov-rcov"
+      require "simplecov-clover"
+
+      class SimpleCov::Formatter::CombinedFormatter
+        def format(result)
+          SimpleCov::Formatter::CloverFormatter.new.format(result)
+          SimpleCov::Formatter::RcovFormatter.new.format(result)
+        end
+      end
+
+      SimpleCov.formatter = SimpleCov::Formatter::CombinedFormatter
+      SimpleCov.root('..')
+      SimpleCov.coverage_dir('cov')
+      SimpleCov.start do
+        require "rspec/core"
+        add_filter "/spec/"
+        spec_dir = File.expand_path("..", __FILE__)
+        RSpec::Core::Runner.disable_autorun!
+        RSpec::Core::Runner.run([spec_dir], STDERR, STDOUT)
+      end
+    end
+  end
+
+  task "cleanup_coverage" do
+    rm_rf "cov"
+  end
+
+end

data/spec/lib/cloud/spec.rb

@@ -0,0 +1,8 @@
+module Bosh
+  module Clouds
+    class Spec
+      def initialize(options)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec/core'
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+RSpec.configure do |c|
+  c.color_enabled = true
+end

data/spec/unit/thread_pool_spec.rb

@@ -0,0 +1,69 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+require File.expand_path("../../spec_helper", __FILE__)
+
+require "common/thread_pool"
+
+describe Bosh::ThreadPool do
+
+  before(:all) do
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::INFO
+  end
+
+  it "should respect max threads" do
+    max = 0
+    current = 0
+    lock = Mutex.new
+
+    Bosh::ThreadPool.new(:max_threads => 2, :logger => @logger).wrap do |pool|
+      4.times do
+        pool.process do
+          lock.synchronize do
+            current += 1
+            max = current if current > max
+          end
+          sleep(0.050)
+          lock.synchronize do
+            max = current if current > max
+            current -= 1
+          end
+        end
+      end
+    end
+    max.should be <= 2
+  end
+
+  it "should raise exceptions" do
+    lambda {
+      Bosh::ThreadPool.new(:max_threads => 2, :logger => @logger).wrap do |pool|
+        5.times do |index|
+          pool.process do
+            sleep(0.050)
+            raise "bad" if index == 4
+          end
+        end
+      end
+    }.should raise_exception("bad")
+  end
+
+  it "should stop processing new work when there was an exception" do
+    max = 0
+    lock = Mutex.new
+
+    lambda {
+      Bosh::ThreadPool.new(:max_threads => 1, :logger => @logger).wrap do |pool|
+        10.times do |index|
+          pool.process do
+            lock.synchronize { max = index if index > max }
+            sleep(0.050)
+            raise "bad" if index == 4
+          end
+        end
+      end
+    }.should raise_exception("bad")
+
+    max.should be == 4
+  end
+
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: bosh_common
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- VMware
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156296060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156296060
+description: Bosh common
+email: support@vmware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- Rakefile
+- lib/common/thread_formatter.rb
+- lib/common/thread_pool.rb
+- lib/common/version.rb
+- spec/Rakefile
+- spec/lib/cloud/spec.rb
+- spec/spec_helper.rb
+- spec/unit/thread_pool_spec.rb
+homepage: http://www.vmware.com
+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'
+      segments:
+      - 0
+      hash: -472840810854006979
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -472840810854006979
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Bosh common
+test_files:
+- spec/Rakefile
+- spec/lib/cloud/spec.rb
+- spec/spec_helper.rb
+- spec/unit/thread_pool_spec.rb