capistrano-fault-tolerant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4fd77f8ab1d2d67fa617a9bfc792bbdd9727eb1
+  data.tar.gz: bd8d1db0485e2719d62b9160fb86fefeda7fbd9d
+SHA512:
+  metadata.gz: 724eed828872091b45d2db66ac2dc90089ea7ec323ca0557dcf3c4e5b9e7e16a58912899f99ff657305532cc70b23d80334f73d1daf1d5fac7f274a025b03334
+  data.tar.gz: 587da335e2534d3a02a2741fb5443f36366023a7c119d48ec722132cca9a623e42e039671c6deed24a8ce265ab6b1e01a84b678f620469d89fa387de81b77130

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kir Shatrov
+
+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,79 @@
+# Fault Tolerant Capistrano
+
+Imagine you have hundreds of hosts in Capistrano, and you'd like to allow specific command to fail on `5%` of your hosts.
+The gem brings fault tolerant commands to Capistrano DSL:
+
+```ruby
+on roles(:web), failure_tolerance: 0.05 do
+  within release_path do
+    execute "./script-that-may-fail-sometimes"
+  end
+end
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# it's important to set `require: false`
+gem 'capistrano-fault-tolerant', require: false
+```
+
+You'll also need the edge version of SSHKit which includes [the commit](https://github.com/capistrano/sshkit/commit/8d1ca5202cfd4dfd73b67412c99aafc655640060):
+
+```
+gem 'sshkit', github: 'capistrano/sshkit'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Add to `Capfile`:
+```ruby
+require 'capistrano-fault-tolerant'
+```
+
+Now you can use `failure_tolerance` option with any command:
+
+```ruby
+on roles(:web), failure_tolerance: 0.05 do
+  within release_path do
+    execute "./script-that-may-fail-sometimes"
+  end
+end
+```
+
+**If > 5% of `web` hosts will fail, Capistrano will continue to deploy.**
+
+**When < 5% of `web` hosts will fail, Capistrano will stop with an exception as it usually does with failed commands.**
+
+The gem can also call a callback on new failed host:
+
+```
+# config/deploy.rb
+CapistranoFaultTolerant.on_failed_host = ->(host) {
+  # notify someone about failed host
+  puts "HOST FAILED: #{host}"
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-fault-tolerant.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-fault-tolerant.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-fault-tolerant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-fault-tolerant"
+  spec.version       = CapistranoFaultTolerant::VERSION
+  spec.authors       = ["Kir Shatrov"]
+  spec.email         = ["shatrov@me.com"]
+
+  spec.summary       = %q{Brings fault tolerant command to Capistrano}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/kirs/capistrano-fault-tolerant"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", "~> 3.4"
+  spec.add_dependency "sshkit", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/capistrano-fault-tolerant.rb

@@ -0,0 +1,73 @@
+require 'sshkit'
+require 'thread'
+
+module CapistranoFaultTolerant
+  class FailedHosts
+    TooManyHostsFailedError = Class.new(StandardError)
+
+    def initialize(total_hosts, tolerance)
+      @max_hosts_to_fail = (total_hosts * tolerance).floor
+      @hosts = Set.new
+    end
+
+    attr_reader :hosts
+
+    def push(host)
+      if @hosts.size >= @max_hosts_to_fail
+        raise TooManyHostsFailedError, "the limit of failed hosts is full. Failed hosts: #{@hosts.to_a.join("\n")}"
+      end
+
+      @hosts << host
+      if CapistranoFaultTolerant.on_failed_host
+        CapistranoFaultTolerant.on_failed_host.call(host)
+      end
+    end
+
+    def include?(host)
+      @hosts.include?(host)
+    end
+  end
+
+  def self.on_failed_host
+    @on_failed_host
+  end
+
+  def self.on_failed_host=(val)
+    @on_failed_host = val
+  end
+
+  class Runner < SSHKit::Runner::Abstract
+    def execute
+      threads = []
+      hosts.each do |host|
+        threads << Thread.new(host) do |h|
+          begin
+            backend(h, &block).run
+          rescue StandardError, Errno::ETIMEDOUT, Net::SSH::ConnectionTimeout => e
+            b = SSHKit.config.backend.new(h)
+            b.error "Exception while executing #{host.user ? "as #{host.user}@" : "on host "}#{host}: #{e.message}"
+
+            options[:failed_hosts].push(h)
+          end
+        end
+      end
+      threads.map(&:join)
+    end
+  end
+
+  module ExtendedDSL
+    def on(hosts, options={}, &block)
+      if options[:failure_tolerance]
+        options[:failed_hosts] = CapistranoFaultTolerant::FailedHosts.new(hosts.size, options.delete(:failure_tolerance))
+        options[:in] = CapistranoFaultTolerant::Runner
+      end
+      super(hosts, options, &block)
+    end
+  end
+end
+
+if defined?(Capistrano)
+  self.extend CapistranoFaultTolerant::ExtendedDSL
+else
+  raise "capistrano_fault_tolerant gem should be required only in Capfile"
+end

data/lib/capistrano-fault-tolerant/version.rb

@@ -0,0 +1,3 @@
+module CapistranoFaultTolerant
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-fault-tolerant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kir Shatrov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: 
+email:
+- shatrov@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- capistrano-fault-tolerant.gemspec
+- lib/capistrano-fault-tolerant.rb
+- lib/capistrano-fault-tolerant/version.rb
+homepage: https://github.com/kirs/capistrano-fault-tolerant
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Brings fault tolerant command to Capistrano
+test_files: []