sshkit-chunky-runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49bf7cbfd1a2feb7a1420695a8b3be966ccf4287
+  data.tar.gz: a294221cde76f2c38de2c280fea367afb646b79c
+SHA512:
+  metadata.gz: 39cd8b01bdb72cf2906e8bf48c2b5aac05f5821ae2233b3d5b2c3816af829bb3324e52ac65ae606c352da288da6c7c3f01e0281ab23353d50438428ce5432e44
+  data.tar.gz: 0d7e8cbc5f933d9a201465c858275adfdea0d075c50b5e0c2aec3425307b59f85240fbed5c6606948174e344803734bfb94c00001b919ac131abe0da93748e46

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+script: "bundle exec rspec"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tomas Brazys
+
+MIT License
+
+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,64 @@
+# SSHKit::Chunky::Runner
+
+[![Build Status](https://travis-ci.org/deees/sshkit-chunky-runner.svg)](https://travis-ci.org/deees/sshkit-chunky-runner)
+[![Code Climate](https://codeclimate.com/github/deees/sshkit-chunky-runner/badges/gpa.svg)](https://codeclimate.com/github/deees/sshkit-chunky-runner)
+
+Runs ssh commands in few chunks. It divides hosts into static number of chunks,
+you just need to specify how many chunks you need.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sshkit-chunky-runner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sshkit-chunky-runner
+
+## Usage
+
+```ruby
+hosts = %w(
+  1.example.com
+  2.example.com
+  3.example.com
+  4.example.com
+  5.example.com
+  6.example.com
+  7.example.com
+  8.example.com
+)
+on hosts, in: :chunks, count: 3, wait: 5 do
+  within '/opt/sites/example.com' do
+    as :deploy  do
+      with rails_env: :production do
+        rake 'assets:precompile'
+      end
+    end
+  end
+end
+```
+
+This will divide all hosts into 3 groups.
+
+First group will have `1.example.com`, `2.example.com`, `3.example.com`, second
+group - `4.example.com`, `5.example.com`, `6.example.com`, and the last one -
+`7.example.com`, `8.example.com`.
+
+If you add more hosts, each group then will have more hosts. Number of groups
+remain the same.
+
+## Contributing
+
+1. Fork it ( https://github.com/deees/sshkit-chunky-runner/fork )
+2. Create your feature branch (`git checkout -b features/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin features/my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/sshkit/chunky/runner.rb

@@ -0,0 +1,10 @@
+require 'sshkit/chunky/runner/version'
+require 'sshkit/chunky/runner/coordinator'
+require 'sshkit/chunky/runner/chunks'
+
+module SSHKit
+  module Chunky
+    module Runner
+    end
+  end
+end

data/lib/sshkit/chunky/runner/chunks.rb

@@ -0,0 +1,19 @@
+module SSHKit
+  module Chunky
+    module Runner
+      class Chunks < SSHKit::Runner::Group
+        attr_writer :chunks_count
+
+        private
+
+        def group_size
+          (hosts.size.to_f / chunks_count).ceil
+        end
+
+        def chunks_count
+          @chunks_count || options[:count] || 2
+        end
+      end
+    end
+  end
+end

data/lib/sshkit/chunky/runner/coordinator.rb

@@ -0,0 +1,22 @@
+require 'sshkit/coordinator'
+
+module SSHKit
+  class Coordinator
+    # overrides original method to include chunks runner
+    def each(options={}, &block)
+      if hosts
+        options = default_options.merge(options)
+        case options[:in]
+        when :parallel then Runner::Parallel
+        when :sequence then Runner::Sequential
+        when :groups   then Runner::Group
+        when :chunks   then SSHKit::Chunky::Runner::Chunks # <- added
+        else
+          raise RuntimeError, "Don't know how to handle run style #{options[:in].inspect}"
+        end.new(hosts, options, &block).execute
+      else
+        Runner::Null.new(hosts, options, &block).execute
+      end
+    end
+  end
+end

data/lib/sshkit/chunky/runner/version.rb

@@ -0,0 +1,7 @@
+module SSHKit
+  module Chunky
+    module Runner
+      VERSION = '0.1.0'
+    end
+  end
+end

data/spec/lib/sshkit/chunky/runner/chunks_spec.rb

@@ -0,0 +1,37 @@
+require 'sshkit/chunky/runner/chunks'
+
+describe SSHKit::Chunky::Runner::Chunks do
+  describe '#group_size' do
+    let(:options) { { count: 3 } }
+    let(:block_to_run) { ->(host) { execute "echo #{Time.now.to_i}" } }
+    let(:runner) do
+      SSHKit::Chunky::Runner::Chunks.new(hosts, options, &block_to_run)
+    end
+
+    subject(:group_size) { runner.send(:group_size) }
+
+    context 'with one host' do
+      let(:hosts) { ['example.com'] }
+
+      it 'returns one' do
+        expect(group_size).to eq 1
+      end
+    end
+
+    context 'with 6 hosts' do
+      let(:hosts) { ['example.com'] * 6 }
+
+      it 'returns 2' do
+        expect(group_size).to eq 2
+      end
+    end
+
+    context 'with 7 hosts' do
+      let(:hosts) { ['example.com'] * 7 }
+
+      it 'returns 3' do
+        expect(group_size).to eq 3
+      end
+    end
+  end
+end

data/spec/lib/sshkit/chunky/runner/coordinator_spec.rb

@@ -0,0 +1,44 @@
+require 'sshkit/chunky/runner/coordinator'
+
+describe SSHKit::Coordinator do
+  describe '#each' do
+    let(:output) { '' }
+    let(:block_to_run) { ->(host) { execute "echo #{Time.now.to_i}" } }
+
+    subject(:results) do
+      output.lines.map { |value| value.split(' ').last.to_i }
+    end
+
+    before do
+      SSHKit.config.backend = SSHKit::Backend::Printer
+    end
+
+    context 'with default options' do
+      before do
+        SSHKit.capture_output output do
+          SSHKit::Coordinator.new(%w{1.example.com 2.example.com})
+            .each(&block_to_run)
+        end
+      end
+
+      it 'returns parallel results' do
+        expect(results.size).to eq 2
+        expect(results.first).to eq results.last
+      end
+    end
+
+    context 'with chunks options' do
+      before do
+        SSHKit.capture_output output do
+          SSHKit::Coordinator.new(%w{1.example.com 2.example.com})
+            .each(in: :chunks, count: 2, &block_to_run)
+        end
+      end
+
+      it 'returns sequential results' do
+        expect(results.size).to eq 2
+        expect(results.first).to be < results.last
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'sshkit'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/sshkit-chunky-runner.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sshkit/chunky/runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sshkit-chunky-runner'
+  spec.version       = SSHKit::Chunky::Runner::VERSION
+  spec.authors       = ['Tomas Brazys']
+  spec.email         = ['tomas.brazys@gmail.com']
+  spec.summary       = 'Run ssh commands in chunks'
+  spec.description   = 'Runs ssh commands in few chunks. It divides hosts into \
+                        static number of chunks, you just need to specify how \
+                        many chunks you need.'
+  spec.homepage      = 'https://github.com/deees/sshkit-chunky-runner'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+
+  spec.add_runtime_dependency 'sshkit', '~> 1.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: sshkit-chunky-runner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Brazys
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |-
+  Runs ssh commands in few chunks. It divides hosts into \
+                          static number of chunks, you just need to specify how \
+                          many chunks you need.
+email:
+- tomas.brazys@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sshkit/chunky/runner.rb
+- lib/sshkit/chunky/runner/chunks.rb
+- lib/sshkit/chunky/runner/coordinator.rb
+- lib/sshkit/chunky/runner/version.rb
+- spec/lib/sshkit/chunky/runner/chunks_spec.rb
+- spec/lib/sshkit/chunky/runner/coordinator_spec.rb
+- spec/spec_helper.rb
+- sshkit-chunky-runner.gemspec
+homepage: https://github.com/deees/sshkit-chunky-runner
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Run ssh commands in chunks
+test_files:
+- spec/lib/sshkit/chunky/runner/chunks_spec.rb
+- spec/lib/sshkit/chunky/runner/coordinator_spec.rb
+- spec/spec_helper.rb