cap-ext-parallelize 0.1.2

data/README.md

@@ -0,0 +1,66 @@
+cap-ext-parallelize - A Capistrano extension for parallel task execution
+=============
+
+Imagine you want to restart several processes, either on one or on different
+servers, but that flingin flangin Capistrano just doesn't want to run all the
+restart tasks in parallel.
+
+I know what you're saying, Capistrano already has a command called `parallel`.
+That should do right? Not exactly, we wanted to be able to run complete tasks,
+no arbitrary blocks in parallel. The command `parallel` is only able to run
+specific shell commands, and it looks weird when you want to run several of
+them on only one host.
+
+We were inspired by the syntax though, so when you want to run arbitrary blocks
+in your Capistrano tasks, you can do it like this:
+
+    parallelize do |session|
+      session.run {deploy.restart} 
+      session.run {queue.restart}
+      session.run {daemon.restart}
+    end
+
+Every task will be run in its own thread, opening a new connection to the server.
+Because of this you should be aware of potential resource exhaustion. You can
+limit the number of threads in two ways, either set a variable (it defaults
+to 10):
+
+    set :parallelize_thread_count, 10
+
+Or specify it with a parameter:
+
+    parallelize(5) do
+      ...
+    end
+
+If one of your tasks ran in a transaction block and issued a rollback, 
+parallelize will rollback all other threads, if they have rollback statements
+defined.
+
+Known Issues
+============
+
+Due to the threading you have to be sure to already have authenticated your SSH
+key (you're using SSH keys, right?) using an SSH agent before you run the
+parallelized code. Otherwise it'll blow up, let's just leave it at that. That'll
+change in the future.
+
+Installation
+============
+
+1. Install the gem
+
+    gem install -s http://gems.github.com mattmatt-cap-ext-parallelize
+
+2. Add the following line to your Capfile
+
+    require 'cap\_ext\_parallelize'
+
+3. There is no step 3
+
+License
+=======
+
+(c) 2009 Mathias Meyer, Jonathan Weiss
+
+MIT-License

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = 'cap-ext-parallelize'
+    s.summary = 'A drop-in replacement for Capistrano to fire off Webistrano deployments transparently without losing the joy of using the cap command.'
+    s.email = 'meyer@paperplanes.de'
+    s.homepage = 'http://github.com/mattmatt/cap-ext-parallelize'
+    s.authors = ["Mathias Meyer"]
+    s.files = FileList["[A-Z]*", "{lib,test}/**/*"]
+    s.add_dependency 'capistrano'
+  end
+rescue LoadError 
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com" 
+end
+
+desc "Default Task"
+task :default => ["test"]
+
+desc "Runs the unit tests"
+task :test => "test:unit"
+
+namespace :test do
+  desc "Unit tests"
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << 'test/unit'
+    t.pattern = "test/*_shoulda.rb"
+    t.verbose = true
+  end
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 2
+:major: 0

data/lib/cap_ext_parallelize.rb

@@ -0,0 +1,9 @@
+require "#{File.dirname(__FILE__)}/capistrano/configuration/extensions/actions/invocation"
+require "#{File.dirname(__FILE__)}/capistrano/configuration/extensions/connections"
+require "#{File.dirname(__FILE__)}/capistrano/configuration/extensions/execution"
+
+class Capistrano::Configuration
+  include Capistrano::Configuration::Extensions::Actions::Invocation
+  include Capistrano::Configuration::Extensions::Connections
+  include Capistrano::Configuration::Extensions::Execution
+end

data/lib/capistrano/configuration/extensions/actions/invocation.rb

@@ -0,0 +1,84 @@
+module Capistrano
+  class Configuration
+    module Extensions
+      module Actions
+        module Invocation
+
+          class BlockProxy
+            attr_accessor :blocks
+        
+            def initialize
+              @blocks = []
+            end
+        
+            def run(&block)
+              blocks << block
+            end
+          end
+      
+          def parallelize(thread_count = nil)
+            set :parallelize_thread_count, 10 unless respond_to?(:parallelize_thread_count)
+        
+            proxy = BlockProxy.new
+            yield proxy
+        
+            logger.info "Running #{proxy.blocks.size} threads in chunks of #{thread_count || parallelize_thread_count}"
+            run_parallelize_loop(proxy, thread_count || parallelize_thread_count)
+          end
+
+          def run_parallelize_loop(proxy, thread_count)
+            batch = 1
+            all_threads = []
+            proxy.blocks.each_slice(thread_count) do |chunk|
+              logger.info "Running batch number #{batch}"
+              threads = run_in_threads(chunk)
+              all_threads << threads
+              wait_for(threads)
+              rollback_all_threads(all_threads.flatten) and return if threads.any? {|t| t[:rolled_back] || t[:exception_raised]}
+              batch += 1
+            end
+            all_threads
+          end
+      
+          def run_in_threads(blocks)
+            blocks.collect do |blk|
+              thread = Thread.new do
+                logger.info "Running block in background thread"
+                blk.call
+              end
+              begin
+                thread.run
+              rescue ThreadError
+                thread[:exception_raised] = $!
+              end
+              thread
+            end
+          end
+      
+          def wait_for(threads)
+            threads.each do |thread|
+              begin
+                thread.join
+              rescue
+                logger.important "Subthread failed: #{$!.message}"
+                thread[:exception_raised] = $!
+              end
+            end
+          end
+ 
+          def rollback_all_threads(threads)
+            Thread.new do
+              threads.select {|t| !t[:rolled_back]}.each do |thread|
+                Thread.current[:rollback_requests] = thread[:rollback_requests]
+                rollback!
+              end
+            end.join
+            rollback! # Rolling back main thread too
+            true
+          end
+      
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/extensions/connections.rb

@@ -0,0 +1,57 @@
+module Capistrano
+  class Configuration
+    module Extensions
+      
+      # Thread-safe(r) version of the Capistrano default
+      # connection handling.
+      module Connections
+        def initialize_with_connections(*args) #:nodoc:
+          initialize_without_connections(*args)
+          Thread.current[:sessions] = {}
+          Thread.current[:failed_sessions] = []
+        end
+
+        # Indicate that the given server could not be connected to.
+        def failed!(server)
+          Thread.current[:failed_sessions] << server
+        end
+    
+        # A hash of the SSH sessions that are currently open and available.
+        # Because sessions are constructed lazily, this will only contain
+        # connections to those servers that have been the targets of one or more
+        # executed tasks.
+        def sessions
+          Thread.current[:sessions] ||= {}
+        end
+    
+        # Query whether previous connection attempts to the given server have
+        # failed.
+        def has_failed?(server)
+          Thread.current[:failed_sessions].include?(server)
+        end
+    
+        def teardown_connections_to(servers)
+          servers.each do |server|
+            sessions[server].close
+            sessions.delete(server)
+          end
+        end
+    
+        private
+        def establish_connection_to(server, failures=nil)
+          current_thread = Thread.current
+          Thread.new { safely_establish_connection_to(server, current_thread, failures) }
+        end
+
+        def safely_establish_connection_to(server, thread, failures=nil)
+          thread[:sessions] ||= {}
+          thread[:sessions][server] ||= connection_factory.connect_to(server)
+        rescue Exception => err
+          raise unless failures
+          failures << { :server => server, :error => err }
+        end
+        
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/extensions/execution.rb

@@ -0,0 +1,49 @@
+module Capistrano
+  class Configuration
+    module Extensions
+      module Execution
+        
+        def task_call_frames
+          Thread.current[:task_call_frames] ||= []
+        end
+  
+        def rollback_requests=(rollback_requests)
+          Thread.current[:rollback_requests] = rollback_requests
+        end
+  
+        def rollback_requests
+          Thread.current[:rollback_requests]
+        end
+
+        def current_task
+          all_task_call_frames = Thread.main[:task_call_frames] + task_call_frames
+          return nil if all_task_call_frames.empty?
+          all_task_call_frames.last.task
+        end
+  
+        def transaction?
+          !(rollback_requests.nil? && Thread.main[:rollback_requests].nil?)
+        end
+  
+        def transaction(&blk)
+          super do
+            self.rollback_requests = [] unless transaction?
+            blk.call
+          end
+        end
+
+        def on_rollback(&block)
+          self.rollback_requests ||= [] if transaction?
+          super
+        end
+
+        def rollback!
+          return if rollback_requests.nil?
+          super
+          Thread.current[:rolled_back] = true
+        end
+        
+      end
+    end
+  end
+end

data/test/parallel_invocation_test.rb

@@ -0,0 +1,277 @@
+require "utils"
+require "capistrano/task_definition"
+require "capistrano/configuration"
+require "#{File.join(File.dirname(__FILE__), '..', 'lib')}/cap_ext_parallelize"
+
+class ConfigurationActionsParallelInvocationTest < Test::Unit::TestCase
+  class MockConfig
+    attr_reader :roles
+    attr_reader :options
+    attr_accessor :debug
+    attr_accessor :dry_run
+    attr_reader :tasks, :namespaces, :fully_qualified_name, :parent
+    attr_reader :state, :original_initialize_called
+    attr_accessor :logger, :default_task
+    attr_accessor :parallelize_thread_count
+    
+    def initialize(options)
+      @original_initialize_called = true
+      @tasks = {}
+      @namespaces = {}
+      @state = {}
+      @fully_qualified_name = options[:fqn]
+      @parent = options[:parent]
+      @logger = options.delete(:logger)
+      @options = {}
+      @parallelize_thread_count = 10
+      @roles = {}
+    end
+
+    def [](*args)
+      @options[*args]
+    end
+
+    def set(name, value)
+      @options[name] = value
+    end
+
+    def fetch(*args)
+      @options.fetch(*args)
+    end
+
+    include Capistrano::Configuration::Execution
+    include Capistrano::Configuration::Actions::Invocation
+    include Capistrano::Configuration::Extensions::Execution
+    include Capistrano::Configuration::Extensions::Actions::Invocation
+    include Capistrano::Configuration::Servers
+    include Capistrano::Configuration::Connections
+  end
+
+  def setup
+    @config = MockConfig.new(:logger => stub(:debug => nil, :info => nil, :important => nil, :trace => nil))
+    @original_io_proc = MockConfig.default_io_proc
+  end
+  
+  def test_parallelize_should_run_all_collected_tasks
+    aaa = new_task(@config, :aaa) do
+      parallelize do |session|
+        session.run {(state[:has_been_run] ||= []) << :first}
+        session.run {(state[:has_been_run] ||= []) << :second}
+      end
+    end
+    @config.execute_task(aaa)
+    assert @config.state[:has_been_run].include?(:first)
+    assert @config.state[:has_been_run].include?(:second)
+  end
+  
+  def test_parallelize_should_rollback_all_threads_when_one_thread_raises_error
+    ccc = new_task(@config, :ccc) do
+      on_rollback {(state[:rollback] ||= []) << :first}
+      raise "boom"
+    end
+
+    eee = new_task(@config, :eee) do
+      on_rollback {(state[:rollback] ||= []) << :second}
+    end
+    
+    ddd = new_task(@config, :ddd) do
+      transaction {execute_task(eee)}
+    end
+
+    bbb = new_task(@config, :bbb) {transaction {execute_task(ccc)}}
+    
+    aaa = new_task(@config, :aaa) do
+      on_rollback {puts 'rolled back'}
+      parallelize do |session|
+        session.run {execute_task(bbb)}
+        session.run {execute_task(ddd)}
+      end
+    end
+    
+    @config.execute_task(aaa)
+    assert @config.state[:rollback].include?(:first)
+    assert @config.state[:rollback].include?(:second)
+  end
+  
+  def test_parallelize_should_rollback_only_run_threads_when_one_thread_raises_error
+    ccc = new_task(@config, :ccc) do
+      on_rollback {(state[:rollback] ||= []) << :first}
+      raise "boom"
+    end
+
+    eee = new_task(@config, :eee) do
+      on_rollback {(state[:rollback] ||= []) << :second}
+    end
+    
+    ddd = new_task(@config, :ddd) do
+      transaction {execute_task(eee)}
+    end
+
+    bbb = new_task(@config, :bbb) {transaction {execute_task(ccc)}}
+    
+    aaa = new_task(@config, :aaa) do
+      on_rollback {puts 'rolled back'}
+      parallelize do |session|
+        session.run {execute_task(bbb)}
+        session.run {execute_task(ddd)}
+      end
+    end
+    @config.parallelize_thread_count = 1
+    @config.execute_task(aaa)
+    assert @config.state[:rollback].include?(:first)
+    assert !@config.state[:rollback].include?(:second)
+  end
+  
+  def test_parallelize_should_rollback_all_threads_when_one_thread_raises_error
+    ccc = new_task(@config, :ccc) do
+      on_rollback {(state[:rollback] ||= []) << :first}
+      sleep 0.1
+      raise "boom"
+    end
+
+    eee = new_task(@config, :eee) do
+      on_rollback {(state[:rollback] ||= []) << :second}
+    end
+    
+    ddd = new_task(@config, :ddd) do
+      transaction {execute_task(eee)}
+    end
+
+    bbb = new_task(@config, :bbb) {transaction {execute_task(ccc)}}
+    
+    aaa = new_task(@config, :aaa) do
+      on_rollback {puts 'rolled back'}
+      parallelize do |session|
+        session.run {execute_task(bbb)}
+        session.run {execute_task(ddd)}
+      end
+    end
+    
+    @config.execute_task(aaa)
+    assert @config.state[:rollback].include?(:first)
+    assert @config.state[:rollback].include?(:second)
+  end
+  
+  def test_should_not_rollback_threads_twice
+    ccc = new_task(@config, :ccc) do
+      on_rollback {(state[:rollback] ||= []) << :first}
+      raise "boom"
+    end
+
+    eee = new_task(@config, :eee) do
+      on_rollback {(state[:rollback] ||= []) << :second}
+    end
+    
+    ddd = new_task(@config, :ddd) do
+      transaction {execute_task(eee)}
+    end
+
+    bbb = new_task(@config, :bbb) {transaction {execute_task(ccc)}}
+    
+    aaa = new_task(@config, :aaa) do
+      on_rollback {puts 'rolled back'}
+      parallelize do |session|
+        session.run {execute_task(bbb)}
+        session.run {execute_task(ddd)}
+      end
+    end
+    
+    @config.execute_task(aaa)
+    assert_equal 2, @config.state[:rollback].size
+    assert @config.state[:rollback].include?(:first)
+    assert @config.state[:rollback].include?(:second)
+  end
+
+  def test_should_rollback_main_thread_too
+
+    eee = new_task(@config, :eee) do
+      on_rollback {(state[:rollback] ||= []) << :second}
+    end
+    
+    ddd = new_task(@config, :ddd) do
+      transaction {execute_task(eee)}
+    end
+
+    aaa = new_task(@config, :aaa) do
+      on_rollback {(state[:rollback] ||= []) << :main}
+      parallelize do |session|
+        session.run {execute_task(bbb)}
+        session.run {execute_task(ddd)}
+      end
+    end
+    
+    bbb = new_task(@config, :bbb) do
+      transaction do
+        execute_task(aaa)
+      end
+    end
+    
+    @config.execute_task(bbb)
+    assert_equal 2, @config.state[:rollback].size
+    assert @config.state[:rollback].include?(:main)
+    assert @config.state[:rollback].include?(:second)
+  end
+  
+  def test_should_run_each_run_block_in_separate_thread
+    bbb = new_task(@config, :bbb) do
+      # noop
+    end
+    
+    ccc = new_task(@config, :ccc) do
+      # noop
+    end
+    
+    @threads = []
+    aaa = new_task(@config, :aaa) do
+      return parallelize do |session|
+        session.run {execute_task(bbb)}
+        session.run {execute_task(ccc)}
+      end
+    end
+    @config.execute_task(aaa)
+    assert_equal 2, @threads.size
+    assert @threads.first.is_a?(Thread)
+    assert @threads.second.is_a?(Thread)
+  end
+  
+  def test_should_respect_roles_configured_in_the_calling_task
+    web_server = role(@config, :web, "my.host")
+    bgrnd_server = role(@config, :daemons, "my.other.host")
+
+    main = new_task(@config, :aaa, :roles => :web) do
+      parallelize do |session|
+        session.run {run 'echo hello'}
+      end
+    end
+    
+    @config.stubs(:connection_factory)
+    @config.expects(:establish_connection_to).with(web_server.first, []).returns(Thread.new {})
+    @config.execute_task(main)
+  end
+  
+  def test_should_rollback_when_main_thread_has_transaction_and_subthread_has_error
+    bbb = new_task(@config, :bbb) do
+      on_rollback {(state[:rollback] ||= []) << :second}
+      raise
+    end
+
+    aaa = new_task(@config, :aaa) do
+      transaction do
+        parallelize do |session|
+          session.run {execute_task(bbb)}
+        end
+      end
+    end
+    
+    @config.execute_task(aaa)
+    assert_equal 1, @config.state[:rollback].size
+    assert @config.state[:rollback].include?(:second)
+  end
+  
+  private
+  def new_task(namespace, name, options={}, &block)
+    block ||= stack_inspector
+    namespace.tasks[name] = Capistrano::TaskDefinition.new(name, namespace, options, &block)
+  end
+  
+end

data/test/utils.rb

@@ -0,0 +1,38 @@
+begin
+  require 'rubygems'
+  gem     'mocha'
+rescue LoadError
+end
+
+require 'test/unit'
+require 'mocha'
+require 'capistrano/server_definition'
+
+module TestExtensions
+  def server(host, options={})
+    Capistrano::ServerDefinition.new(host, options)
+  end
+
+  def namespace(fqn=nil)
+    space = stub(:roles => {}, :fully_qualified_name => fqn, :default_task => nil)
+    yield(space) if block_given?
+    space
+  end
+
+  def role(space, name, *args)
+    opts = args.last.is_a?(Hash) ? args.pop : {}
+    space.roles[name] ||= []
+    space.roles[name].concat(args.map { |h| Capistrano::ServerDefinition.new(h, opts) })
+  end
+
+  def new_task(name, namespace=@namespace, options={}, &block)
+    block ||= Proc.new {}
+    task = Capistrano::TaskDefinition.new(name, namespace, options, &block)
+    assert_equal block, task.body
+    return task
+  end
+end
+
+class Test::Unit::TestCase
+  include TestExtensions
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: cap-ext-parallelize
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Mathias Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-19 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: meyer@paperplanes.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.md
+- VERSION.yml
+- lib/cap_ext_parallelize.rb
+- lib/capistrano/configuration/extensions/actions/invocation.rb
+- lib/capistrano/configuration/extensions/connections.rb
+- lib/capistrano/configuration/extensions/execution.rb
+- test/parallel_invocation_test.rb
+- test/utils.rb
+has_rdoc: true
+homepage: http://github.com/mattmatt/cap-ext-parallelize
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: A drop-in replacement for Capistrano to fire off Webistrano deployments transparently without losing the joy of using the cap command.
+test_files: []
+