sshkit-custom-dsl 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 867e0d7f0ec3e1e7cabaeb2a475cb0a8b4037ae5
-  data.tar.gz: 9aa920c2586eefb0679bfbe71081e482aaf660fc
+  metadata.gz: 2fd766977dc760e757d032aeb5afba4a8ecca796
+  data.tar.gz: 244879dd93b7ff53dea9070b59facd6726ef2ab8
 SHA512:
-  metadata.gz: 6506a298603b51b54aaf2ae51a1f0bab46f4b1ed0db0da2b36d3e2ffc2ed226e3d5bd8f45b66af9af620c9788f6f73c20e23bfdc6aee452ea09a16251ec1cd9b
-  data.tar.gz: 7995878880469aee3e526afd4238e898afee55b01026c300b88a2d587a63e244fa779f0cd0a9d844197bbd9251f7879f173512e46561596212d737ff586b7ef0
+  metadata.gz: ed3e7881c9e5aa5d64165dd2643135b9082701a66b9abbe09e32520b6141a1dcada72a954e658086843958053a9f2b0f02412b882bcb491c52920d88d1b00251
+  data.tar.gz: 0b2e4323dc19009e77c73bdf7693c67dbfc85e34506abffdd442308ea59404bdf556d853a379d6c0ddd3aed68453520405ae0ed3be8ee0a8371f2fecab5bb288

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 .idea
+.DS_Store

data/.rubocop_todo.yml

@@ -0,0 +1,11 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-10 13:48:11 +0200 using RuboCop version 0.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodName:
+  Enabled: false

data/README.md

@@ -1,8 +1,13 @@
-# Sshkit::Custom::Dsl
+[![Build Status](https://travis-ci.org/faber-lotto/sshkit-custom-dsl.svg)](https://travis-ci.org/faber-lotto/sshkit-custom-dsl)
+[![Coverage Status](https://coveralls.io/repos/faber-lotto/sshkit-custom-dsl/badge.png)](https://coveralls.io/r/faber-lotto/sshkit-custom-dsl)
+[![Code Climate](https://codeclimate.com/github/faber-lotto/sshkit-custom-dsl.png)](https://codeclimate.com/github/faber-lotto/sshkit-custom-dsl)
+[![Gem Version](https://badge.fury.io/rb/capistrano-template.svg)](http://badge.fury.io/rb/capistrano-template)
+
+# SSHKit::Custom::DSL
 
 Exchanges original sshkit dsl against a custom dsl. This DSL does not change the scope of the blocks.
 Furthor more it uses `Rake::Threadpool`, to handle parallel requests. Keep in mind `Runner::Parallel` 
- and Runner::Group are execute all blocks in *parallel threads*, so do it thread save.
+ and `Runner::Group` execute all blocks in *parallel threads*, so do it thread save.
 
 ## Installation
 
@@ -25,6 +30,8 @@ Or install it yourself as:
 require 'sshkit/custom/dsl'
 
 extend SSHKit::Custom::DSL
+require 'delegate'
+# require 'sshkit/dsl' <= switch to see the different
 
 SSHKit.configure do |sshkit|
   sshkit.format = :pretty
@@ -38,10 +45,32 @@ SSHKit.configure do |sshkit|
   end
 end
 
+class TestScope < SimpleDelegator
+  def data
+    {msg: "12345"}
+  end
+
+  def call_it
+
+    on %w{localhost 127.0.0.1}, in: :sequence, wait: 0 do
+      within "/tmp" do
+        with rails_env: :production do
+          execute "echo", data.fetch(:msg)
+        end
+      end
+    end
+    
+  end
+end
+
+data = {msg: "ABCD"}
+
+TestScope.new(self).call_it
+
 on %w{localhost 127.0.0.1}, in: :sequence, wait: 0 do
   within "/tmp" do
     with rails_env: :production do
-      execute "echo", "12345"
+      execute "echo", data.fetch(:msg)
     end
   end
 end
@@ -71,7 +100,7 @@ It should work like the original one, I hope.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/sshkit-custom-dsl/fork )
+1. Fork it ( https://github.com/faber-lotto/sshkit-custom-dsl/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,12 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task :default => :spec
-
+task default: :spec
 
 desc 'Run RSpec with code coverage'
 task :coverage do

data/lib/core_ext/sshkit/backend/abstract.rb

@@ -11,18 +11,11 @@ module SSHKit
         @env ||= {}
       end
 
-      def host
-        @host
-      end
-
-      def user
-        @user
-      end
+      attr_reader :host
 
-      def group
-        @group
-      end
+      attr_reader :user
 
+      attr_reader :group
     end
   end
-end
+end

data/lib/core_ext/sshkit.rb

@@ -1,2 +1,2 @@
 require 'sshkit'
-require 'core_ext/sshkit/backend/abstract'
+require 'core_ext/sshkit/backend/abstract'

data/lib/sshkit/custom/config/store.rb

@@ -2,7 +2,6 @@ module SSHKit
   module Custom
     module Config
       module Store
-
         module_function
 
         def scope_storage
@@ -15,10 +14,10 @@ module SSHKit
 
         def create_runner(opts)
           @runner = Runner::Abstract.create_runner opts
-        end        
+        end
 
         def runner
-          @runner.tap{|r| r.backends = backends}
+          @runner.tap { |r| r.backends = backends }
         end
 
         def backends=(hosts)
@@ -30,11 +29,13 @@ module SSHKit
         end
 
         def add_pwd(directory)
-          active_backend.pwd ||= [];  active_backend.pwd << directory
+          active_backend.pwd ||= []
+          active_backend.pwd << directory
         end
 
         def pop_pwd
-          active_backend.pwd ||= [];  active_backend.pwd.pop
+          active_backend.pwd ||= []
+          active_backend.pwd.pop
         end
 
         def _envs
@@ -42,7 +43,7 @@ module SSHKit
         end
 
         def add_env(env)
-          old_env =  backends.first.env.clone
+          old_env =  active_backend.env.clone
           _envs << old_env
           env = old_env.merge(env)
           active_backend.env = env
@@ -50,7 +51,7 @@ module SSHKit
 
         def pop_env
           old_env = _envs.pop || {}
-          backends.each {|backend| backend.env = old_env}
+          active_backend.env = old_env
         end
 
         def _user_groups
@@ -58,7 +59,7 @@ module SSHKit
         end
 
         def add_user_group(user, group)
-          _user_groups << {user: active_backend.user, group:  active_backend.group }
+          _user_groups << { user: active_backend.user, group:  active_backend.group }
           active_backend.user = user
           active_backend.group = group
         end
@@ -70,9 +71,9 @@ module SSHKit
         end
 
         def active_backend
-          SSHKit::Custom::Config::Runner::Abstract.active_backend
+          SSHKit::Custom::Runner::Abstract.active_backend
         end
       end
     end
   end
-end
+end

data/lib/sshkit/custom/dsl/config_statements.rb

@@ -2,14 +2,12 @@ module SSHKit
   module Custom
     module DSL
       module ConfigStatements
-
-        def on(hosts, options={}, &block)
+        def on(hosts, options = {}, &block)
           hosts = Array(hosts).map { |rh| Host(rh) }.uniq
 
-          _config_store.backends = hosts
-          _config_store.create_runner options
+          _setup_runner(hosts, options)
 
-          _config_store.runner.apply_block_to_bcks(&block) if block_given?
+          _runner.apply_block_to_bcks(&block) if block_given?
         end
 
         def within(directory)
@@ -30,10 +28,9 @@ module SSHKit
         end
 
         def as(who)
-
           if who.respond_to? :fetch
-            user = who.fetch(:user,  who.fetch("user"))
-            group = who.fetch(:group, who.fetch("group", nil))
+            user = who.fetch(:user) { who.fetch('user') }
+            group = who.fetch(:group) { who.fetch('group', nil) }
           else
             user = who
             group = nil
@@ -49,7 +46,15 @@ module SSHKit
           _config_store.pop_user_group
         end
 
+        def _setup_runner(hosts, options)
+          _config_store.backends = hosts
+          _config_store.create_runner options
+        end
+
+        def _runner
+          _config_store.runner
+        end
       end
     end
   end
-end
+end

data/lib/sshkit/custom/dsl/exec_statements.rb

@@ -2,9 +2,9 @@ module SSHKit
   module Custom
     module DSL
       module ExecStatements
+        EXEC_STATEMENTS = [:execute, :make, :rake, :test, :capture, :upload!, :download!].freeze
 
-
-        [:execute, :make, :rake, :test, :capture, :upload!, :download!].each do |method|
+        EXEC_STATEMENTS.each do |method|
           define_method method do |*args, &block|
             _config_store.runner.send_cmd method, *args, &block
           end
@@ -36,7 +36,6 @@ module SSHKit
            fi
           EOTEST
         end
-
       end
     end
   end

data/lib/sshkit/custom/dsl/helper.rb

@@ -2,6 +2,7 @@ module SSHKit
   module Custom
     module DSL
       module Helper
+        LOGGING_METHODS = [:log, :debug, :fatal, :error, :warn, :info, :debug].freeze
 
         def active_backend
           SSHKit::Custom::Config::Store.active_backend
@@ -11,7 +12,7 @@ module SSHKit
           active_backend.host
         end
 
-        [:log, :debug, :fatal, :error, :warn, :info, :debug].each do |method|
+        LOGGING_METHODS.each do |method|
           define_method method do |*args|
             active_backend.send method, *args
           end
@@ -28,8 +29,7 @@ module SSHKit
         def _config_store
           @_config_store ||= SSHKit::Custom::Config::Store
         end
-
       end
     end
   end
-end
+end

data/lib/sshkit/custom/dsl/version.rb

@@ -1,7 +1,7 @@
 module SSHKit
   module Custom
     module DSL
-      VERSION = "0.0.6"
+      VERSION = '0.0.7'
     end
   end
 end

data/lib/sshkit/custom/dsl.rb

@@ -3,10 +3,10 @@ require 'core_ext/sshkit'
 require 'scoped_storage'
 
 require 'sshkit/custom/config/store'
-require 'sshkit/custom/config/runner/abstract'
-require 'sshkit/custom/config/runner/sequential'
-require 'sshkit/custom/config/runner/parallel'
-require 'sshkit/custom/config/runner/group'
+require 'sshkit/custom/runner/abstract'
+require 'sshkit/custom/runner/sequential'
+require 'sshkit/custom/runner/parallel'
+require 'sshkit/custom/runner/group'
 
 require 'sshkit/custom/dsl/config_statements'
 require 'sshkit/custom/dsl/exec_statements'

data/lib/sshkit/custom/runner/abstract.rb

@@ -0,0 +1,88 @@
+module SSHKit
+  module Custom
+    module Runner
+      ExecuteError = SSHKit::Runner::ExecuteError
+
+      class Abstract
+        attr_accessor :backends
+        attr_reader :options
+        attr_writer :wait_interval
+
+        def self.create_runner(opts)
+          opts_with_defaults = { in: :parallel }.merge(opts)
+
+          case opts_with_defaults[:in]
+          when :parallel
+            Parallel
+          when :sequence
+            Sequential
+          when :groups
+            Group
+          else
+            fail "Don't know how to handle run style #{opts_with_defaults[:in].inspect}"
+          end.new(opts_with_defaults)
+        end
+
+        def self.scope_storage
+          ScopedStorage::ThreadLocalStorage
+        end
+
+        def self.scope
+          @scope ||= ScopedStorage::Scope.new('sshkit_runner', scope_storage)
+        end
+
+        def self.active_backend
+          scope[:active_backend] || fail(ArgumentError, 'Backend not set')
+        end
+
+        def self.active_backend=(new_backend)
+          scope[:active_backend] = new_backend
+        end
+
+        def initialize(options = nil)
+          @options = options || {}
+        end
+
+        def active_backend
+          self.class.active_backend
+        end
+
+        def active_backend=(new_backend)
+          self.class.active_backend = new_backend
+        end
+
+        def send_cmd(cmd, *args, &block)
+          args = Array(block.call(active_backend.host)) if block
+          active_backend.send(cmd, *args)
+        rescue => e
+          e2 = ExecuteError.new e
+          raise e2, "Exception while executing on host #{active_backend.host}: #{e.message}"
+        end
+
+        def apply_block_to_bcks(&_block)
+          fail SSHKit::Backend::MethodUnavailableError
+        end
+
+        def apply_to_bck(backend, &block)
+          self.active_backend = backend
+          block.call(backend.host)
+         rescue => e
+          e2 = ExecuteError.new e
+          raise e2, "Exception while executing on host #{backend.host}: #{e.message}"
+        ensure
+          self.active_backend = nil
+        end
+
+        def do_wait
+          sleep wait_interval
+        end
+
+        protected
+
+        def wait_interval
+          @wait_interval || options[:wait] || 2
+        end
+      end
+    end
+  end
+end

data/lib/sshkit/custom/runner/group.rb

@@ -0,0 +1,34 @@
+module SSHKit
+  module Custom
+    module Runner
+      class Group < Abstract
+        attr_writer :group_size
+
+        def apply_block_to_bcks(&block)
+          backends.each_slice(group_size).map do |group_backends|
+
+            exec_parallel(group_backends, &block)
+
+            do_wait
+
+          end.flatten
+        end
+
+        def group_size
+          @group_size ||= options[:limit] || 2
+        end
+
+        def exec_parallel(group, &block)
+          use_runner.call(options).tap do |runner|
+            runner.backends = group
+            runner.apply_block_to_bcks(&block)
+          end
+        end
+
+        def use_runner
+          ->(options) { Parallel.new(options) }
+        end
+      end
+    end
+  end
+end

data/lib/sshkit/custom/runner/parallel.rb

@@ -0,0 +1,30 @@
+module SSHKit
+  module Custom
+    module Runner
+      require 'rake'
+
+      class Parallel < Abstract
+        def thread_pool
+          @thread_pool ||= Rake::ThreadPool.new(thread_count)
+        end
+
+        def apply_block_to_bcks(&block)
+          futures = to_futures(&block)
+          futures.each { |f| f.value }
+        end
+
+        def thread_count
+          @thread_count ||= options[:thread_count] || Rake.suggested_thread_count - 1
+        end
+
+        def to_futures(&block)
+          backends.map do |b|
+            thread_pool.future(b) do |fb|
+              apply_to_bck fb, &block
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sshkit/custom/runner/sequential.rb

@@ -0,0 +1,14 @@
+module SSHKit
+  module Custom
+    module Runner
+      class Sequential < Abstract
+        def apply_block_to_bcks(&block)
+          backends.each do |backend|
+            apply_to_bck backend, &block
+            do_wait
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -44,5 +44,3 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 end
-
-

data/spec/unit/sshkit/custom/config/store_spec.rb

@@ -0,0 +1,116 @@
+require 'unit_spec_helper'
+
+module SSHKit
+  module Custom
+    module Config
+      describe Store do
+
+        let(:mock_bck) do
+          SSHKit.config.backend.new(SSHKit::Host.new('localhost'))
+        end
+
+        let(:new_env) { { ab: :cd } }
+        let(:old_env) { { ab: 123, i: 5 } }
+
+        before :each do
+          SSHKit::Custom::Runner::Abstract.active_backend = mock_bck
+        end
+
+        describe '.create_runner' do
+          it 'creates the wanted runner' do
+            opts = { in: :parallel }
+            expect(Runner::Abstract).to receive(:create_runner).with(opts)
+            Store.create_runner opts
+          end
+        end
+
+        describe '.runner' do
+          it 'returns the actual runner' do
+            opts = { in: :parallel }
+            Store.create_runner opts
+
+            expect(Store.runner).not_to be_nil
+          end
+        end
+
+        describe '.backends=' do
+          it 'stores a list of backends' do
+            Store.backends = ['127.0.0.1', 'localhost'].map { |h| SSHKit::Host.new(h) }
+            expect(Store.backends.last.host.hostname).to eq('localhost')
+          end
+        end
+
+        describe '.add_pwd' do
+          it 'adds a directory to the stack' do
+            expect { Store.add_pwd('ddd') }.to change { mock_bck.pwd.count }.by(1)
+          end
+        end
+
+        describe '.pop_pwd' do
+          it 'removes a directory from the stack' do
+            Store.add_pwd('ddd')
+            Store.add_pwd('bbb')
+            Store.add_pwd('ccc')
+            expect { Store.pop_pwd }.to change { mock_bck.pwd.count }.by(-1)
+          end
+        end
+
+        describe '.add_env' do
+
+          it 'adds an env to the stack' do
+            expect(mock_bck.env).to eq({})
+            Store.add_env(new_env)
+            expect(mock_bck.env).to eq(new_env)
+          end
+
+          it 'merges the old env with the new one' do
+            Store.add_env(old_env)
+            Store.add_env(new_env)
+
+            expect(mock_bck.env).to eq(old_env.merge(new_env))
+          end
+        end
+
+        describe '.pop_env' do
+          it 'removes an env from the stack' do
+            Store.add_env(new_env)
+            Store.pop_env
+            expect(mock_bck.env).to eq({})
+          end
+
+          it 'restores pre existing envs' do
+            Store.add_env(old_env)
+            Store.add_env(new_env)
+
+            Store.pop_env
+
+            expect(mock_bck.env).to eq(old_env)
+          end
+        end
+
+        describe '.add_user_group' do
+          it 'stores an user and group' do
+            Store.add_user_group('u', 'g')
+            expect(mock_bck.user).to eq 'u'
+            expect(mock_bck.group).to eq 'g'
+          end
+        end
+
+        describe '.pop_user_group' do
+          it 'restores previous an user and group' do
+            Store.add_user_group('u', 'g')
+            Store.add_user_group('u1', 'g1')
+
+            expect(mock_bck.user).to eq 'u1'
+            expect(mock_bck.group).to eq 'g1'
+
+            Store.pop_user_group
+
+            expect(mock_bck.user).to eq 'u'
+            expect(mock_bck.group).to eq 'g'
+          end
+        end
+      end
+    end
+  end
+end