sshkit-custom-dsl 0.0.6 → 0.0.7

data/spec/unit/sshkit/custom/dsl/config_statements_spec.rb

@@ -0,0 +1,147 @@
+require 'unit_spec_helper'
+
+module SSHKit
+  module Custom
+    module DSL
+      describe ConfigStatements do
+        subject do
+          Class.new do
+            include ConfigStatements
+            include Helper
+
+            def _guard_sudo_user!(*)
+            end
+
+            def _guard_dir!(*)
+            end
+
+            def _guard_sudo_group!(*)
+            end
+          end.new
+        end
+
+        let(:mock_bck) do
+          SSHKit.config.backend.new(SSHKit::Host.new('localhost'))
+        end
+
+        let(:hosts) { ['localhost', '127.0.0.1'] }
+
+        before :each do
+          SSHKit::Custom::Runner::Abstract.active_backend = mock_bck
+        end
+
+        describe '.on' do
+          it 'sets the backends' do
+            subject.on hosts
+            expect(Config::Store.backends.count).to eq(2)
+          end
+
+          it 'creates a runner' do
+            subject.on hosts
+            expect(Config::Store.runner).to be_kind_of SSHKit::Custom::Runner::Parallel
+          end
+
+          it 'applies a block to the runner' do
+            block = ->(_host) {}
+            runner_double = double(:runner)
+
+            expect(subject).to receive(:_runner).and_return(runner_double)
+
+            expect(runner_double).to receive(:apply_block_to_bcks)
+
+            subject.on hosts, &block
+          end
+        end
+
+        describe '.within' do
+          it 'changes the directory' do
+            dir = '1234'
+            expect(subject._config_store).to receive(:add_pwd).with(dir)
+
+            subject.within(dir)
+          end
+
+          it 'ensures the directory is set back' do
+            dir = '1234'
+            expect(subject._config_store).to receive(:pop_pwd)
+
+            expect do
+              subject.within(dir) do
+                fail
+              end
+            end.to raise_error
+          end
+
+          it 'guards the block with a dir existing check' do
+            dir = '1234'
+            expect(subject).to receive(:_guard_dir!).with(dir)
+
+            subject.within(dir)
+          end
+        end
+
+        describe '.with' do
+          it 'changes the environment' do
+            env = { a: 2 }
+            expect(subject._config_store).to receive(:add_env).with(env)
+
+            subject.with(env)
+          end
+
+          it 'ensures the environment is set back' do
+            env = { a: 2 }
+            expect(subject._config_store).to receive(:pop_env)
+
+            expect do
+              subject.with(env) do
+                fail
+              end
+            end.to raise_error
+          end
+        end
+
+        describe '.as' do
+          it 'changes the user and group' do
+            user = 'u'
+            group = 'g'
+
+            expect(subject._config_store).to receive(:add_user_group).with(user, group)
+
+            subject.as(user: user, group: group)
+          end
+
+          it 'ensures the user and group is set back' do
+            user = 'u'
+            group = 'g'
+            expect(subject._config_store).to receive(:pop_user_group)
+
+            expect do
+              subject.as(user: user, group: group) do
+                fail
+              end
+            end.to raise_error
+          end
+
+          it 'guards the block execution with a user and group existing check' do
+            user = 'u'
+            group = 'g'
+
+            expect(subject).to receive(:_guard_sudo_user!).with(user)
+            expect(subject).to receive(:_guard_sudo_group!).with(user, group)
+
+            subject.as(user: user, group: group)
+          end
+
+          it 'uses the username when given' do
+            user = 'u'
+
+            expect(subject._config_store).to receive(:add_user_group).with(user, nil)
+
+            subject.as(user)
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/unit/sshkit/custom/dsl/exec_statements_spec.rb

@@ -0,0 +1,74 @@
+require 'unit_spec_helper'
+
+module SSHKit
+  module Custom
+    module DSL
+      describe ExecStatements do
+        subject do
+          Class.new do
+            include ExecStatements
+            include ConfigStatements
+            include Helper
+
+            def _config_store
+              self
+            end
+
+            attr_accessor :runner
+
+          end.new
+        end
+
+        let(:mock_bck) do
+          SSHKit.config.backend.new(SSHKit::Host.new('localhost'))
+        end
+
+        let(:hosts) { ['localhost', '127.0.0.1'] }
+
+        before :each do
+          SSHKit::Custom::Runner::Abstract.active_backend = mock_bck
+        end
+
+        describe '#EXEC_STATEMENTS' do
+          it 'creates a method for each exec statement' do
+            EXEC_STATEMENTS.each do |meth|
+              expect(subject).to respond_to meth
+            end
+          end
+
+          it 'delegates all calls to the runner' do
+            subject.runner = double(:runner)
+            args = [1, 2, 3, 4]
+
+            EXEC_STATEMENTS.each do |meth|
+              expect(subject.runner).to receive(:send_cmd).with(meth, *args)
+              subject.send(meth, *args)
+            end
+          end
+        end
+
+        describe '._guard_sudo_user!' do
+          it 'checks if a user can sudo with a specific user' do
+            expect(subject).to receive(:execute).with(/if.*sudo.*-u.*deploy/m, verbosity: 0)
+            subject._guard_sudo_user!('deploy')
+          end
+        end
+
+        describe '._guard_sudo_group!' do
+          it 'checks if a user can sudo with a specific group' do
+            expect(subject).to receive(:execute).with(/if.*sudo.*-u.*deploy.*-g.*dgroup/m, verbosity: 0)
+            subject._guard_sudo_group!('deploy', 'dgroup')
+          end
+        end
+
+        describe '._guard_dir!' do
+          it 'checks if a user can access a specific dir' do
+            expect(subject).to receive(:execute).with(/if.*-d.*\/tmp/m, verbosity: 0)
+            subject._guard_dir!('/tmp')
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/unit/sshkit/custom/dsl/helper_spec.rb

@@ -0,0 +1,57 @@
+require 'unit_spec_helper'
+
+module SSHKit
+  module Custom
+    module DSL
+      describe Helper do
+        subject do
+          Class.new do
+            include Helper
+          end.new
+        end
+
+        let(:mock_bck) do
+          SSHKit.config.backend.new(SSHKit::Host.new('localhost'))
+        end
+
+        before :each do
+          SSHKit::Custom::Runner::Abstract.active_backend = mock_bck
+        end
+
+        describe '#LOGGING_METHODS' do
+          it 'delegates all logging methods to active backend' do
+            LOGGING_METHODS.each do |meth|
+              expect(mock_bck).to receive(meth)
+              subject.send(meth, 'hello world')
+            end
+          end
+        end
+
+        describe '.active_backend' do
+          it 'returns the actual active backend' do
+            expect(subject.active_backend).to eq(mock_bck)
+          end
+        end
+
+        describe '.host' do
+          it 'return the actual host' do
+            expect(subject.host).to eq(mock_bck.host)
+          end
+        end
+
+        describe '.Host' do
+          it 'converts to a host object' do
+            expect(subject.Host('localhost')).to be_kind_of SSHKit::Host
+          end
+
+          it 'does nothing with a host object' do
+            lch = SSHKit::Host.new('localhost')
+            expect(subject.Host(lch)).to eq(lch)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/spec/unit/sshkit/custom/runner/abstract_spec.rb

@@ -0,0 +1,123 @@
+require 'unit_spec_helper'
+
+module SSHKit
+  module Custom
+    module Runner
+      describe Abstract do
+
+        subject do
+          Abstract.new(wait: 1)
+        end
+
+        describe '#create_runner' do
+          it 'creates a group runner' do
+            expect(Abstract.create_runner(in: :groups)).to be_kind_of Group
+          end
+
+          it 'creates a parallel runner' do
+            expect(Abstract.create_runner(in: :parallel)).to be_kind_of Parallel
+          end
+
+          it 'creates a parallel runner as deafult' do
+            expect(Abstract.create_runner({})).to be_kind_of Parallel
+          end
+
+          it 'creates a sequential runner' do
+            expect(Abstract.create_runner(in: :sequence)).to be_kind_of Sequential
+          end
+
+          it 'raises an error for unknown runners' do
+            expect { Abstract.create_runner(in: :abc) }.to raise_error
+          end
+
+          describe '.active_backend' do
+            it 'sets the active backend' do
+              subject.active_backend = :some_thing
+              expect(subject.active_backend).to eq :some_thing
+            end
+
+            it 'delegates to the class method' do
+              subject.active_backend = :some_thing
+              expect(subject.class.active_backend).to eq :some_thing
+            end
+          end
+
+          describe '.snd_cmd' do
+            let(:mock_bck) do
+              SSHKit.config.backend.new(SSHKit::Host.new('localhost'))
+            end
+
+            before :each do
+              SSHKit::Custom::Runner::Abstract.active_backend = mock_bck
+            end
+
+            it 'sends the cmd to the active backend' do
+              args = [1, 2, 3]
+              expect(mock_bck).to receive(:execute).with(*args)
+              subject.send_cmd(:execute, *args)
+            end
+
+            it 'executes a block to get the args' do
+              args = [1, 2, 3]
+              expect(mock_bck).to receive(:execute).with(*args)
+
+              subject.send_cmd(:execute) do
+                args
+              end
+
+            end
+
+            it 'reraises an exception' do
+              expect do
+                subject.send_cmd(:execute) do
+                  fail
+                end
+              end.to raise_error
+            end
+
+          end
+
+          describe '.apply_to_bck' do
+            let(:mock_bck) do
+              SSHKit.config.backend.new(SSHKit::Host.new('localhost'))
+            end
+
+            it 'executes the block and yields the host' do
+              block = ->(_host) {}
+              expect(block).to receive(:call)
+              subject.apply_to_bck(mock_bck, &block)
+            end
+
+            it 'reraises an exception' do
+              block = ->(_host) { fail }
+
+              expect { subject.apply_to_bck(mock_bck, &block) }.to raise_error
+            end
+
+          end
+
+          describe '.do_wait' do
+            it 'sleeps [wait] seconds' do
+
+              expect do
+                subject.send(:do_wait)
+              end.to change { Time.now.utc }.by_at_least(1)
+            end
+
+          end
+
+          describe '.apply_block_to_bcks' do
+            it 'should be implemented by sub classes' do
+              expect do
+                subject.apply_block_to_bcks do
+
+                end
+              end.to raise_error
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/unit/sshkit/custom/runner/group_spec.rb

@@ -0,0 +1,48 @@
+require 'unit_spec_helper'
+
+module SSHKit
+  module Custom
+    module Runner
+      describe Group do
+        subject do
+          Group.new(wait: 0, limit: 1)
+        end
+
+        describe '.apply_block_to_bcks' do
+
+          let(:block) { ->(_) {} }
+          let(:bck1) { SSHKit.config.backend.new(SSHKit::Host.new('localhost')) }
+          let(:bck2) { SSHKit.config.backend.new(SSHKit::Host.new('127.0.0.1')) }
+
+          before :each do
+            allow(subject).to receive(:use_runner).and_return(->(options) {Sequential.new(options) })
+          end
+
+          it 'calls apply_to_bck for every backend' do
+            subject.backends = [bck1, bck2]
+
+            expect(block).to receive(:call).with(bck1.host)
+            expect(block).to receive(:call).with(bck2.host)
+
+            subject.apply_block_to_bcks(&block)
+          end
+
+          it 'groups the backends into batches' do
+            subject.backends = [bck1, bck2]
+
+            expect(subject).to receive(:exec_parallel).with([bck1])
+            expect(subject).to receive(:exec_parallel).with([bck2])
+
+            subject.apply_block_to_bcks(&block)
+          end
+        end
+
+        describe '.use_runner' do
+          it 'creates a parallel runner' do
+            expect(subject.use_runner.call({})).to be_kind_of Parallel
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/sshkit/custom/runner/parallel_spec.rb

@@ -0,0 +1,55 @@
+require 'unit_spec_helper'
+
+module SSHKit
+  module Custom
+    module Runner
+      class DummyFuture
+        def initialize(host, &block)
+          @host = host
+          @block = block
+        end
+
+        def value
+          @block.call @host
+        end
+      end
+
+      describe Parallel do
+        let(:thread_pool)do
+          double(:thread_pool).tap do |t|
+            allow(t).to receive(:future) do |host, &block|
+              DummyFuture.new(host, &block)
+            end
+          end
+        end
+
+        subject do
+          Parallel.new(wait: 0)
+        end
+
+        describe '.apply_block_to_bcks' do
+          it 'calls apply_to_bck for every backend' do
+            allow(subject).to receive(:thread_pool).and_return(thread_pool)
+
+            block = ->(_) {}
+
+            bck1 =  SSHKit.config.backend.new(SSHKit::Host.new('localhost'))
+            bck2 =  SSHKit.config.backend.new(SSHKit::Host.new('127.0.0.1'))
+            subject.backends = [bck1, bck2]
+
+            expect(block).to receive(:call).with(bck1.host)
+            expect(block).to receive(:call).with(bck2.host)
+
+            subject.apply_block_to_bcks(&block)
+          end
+        end
+
+        describe '.thread_pool' do
+          it 'creates a rake thread pool' do
+            expect(subject.thread_pool).to be_kind_of Rake::ThreadPool
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/sshkit/custom/runner/sequential_spec.rb

@@ -0,0 +1,27 @@
+require 'unit_spec_helper'
+
+module SSHKit
+  module Custom
+    module Runner
+      describe Sequential do
+        subject do
+          Sequential.new(wait: 0)
+        end
+
+        describe '.apply_block_to_bcks' do
+          it 'calls apply_to_bck for every backend' do
+            block = ->(_) {}
+            bck1 =  SSHKit.config.backend.new(SSHKit::Host.new('localhost'))
+            bck2 =  SSHKit.config.backend.new(SSHKit::Host.new('127.0.0.1'))
+            subject.backends = [bck1, bck2]
+
+            expect(block).to receive(:call).with(bck1.host)
+            expect(block).to receive(:call).with(bck2.host)
+
+            subject.apply_block_to_bcks(&block)
+          end
+        end
+      end
+    end
+  end
+end

data/sshkit-custom-dsl.gemspec

@@ -4,26 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sshkit/custom/dsl/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sshkit-custom-dsl"
+  spec.name          = 'sshkit-custom-dsl'
   spec.version       = SSHKit::Custom::DSL::VERSION
-  spec.authors       = ["Dieter Späth"]
-  spec.email         = ["d.spaeth@faber.de"]
-  spec.summary       = %q{Exchanges original sshkit dsl against a custom dsl}
-  spec.description   = %q{Exchanges original sshkit dsl against a custom dsl. This DSL does not change the scope of the blocks.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Dieter Späth']
+  spec.email         = ['d.spaeth@faber.de']
+  spec.summary       = %q(Exchanges original sshkit dsl against a custom dsl)
+  spec.description   = %q(Exchanges original sshkit dsl against a custom dsl. This DSL does not change the scope of the blocks.)
+  spec.homepage      = ''
+  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.require_paths = ['lib']
 
   spec.add_dependency 'sshkit', '~> 1.5.1'
   spec.add_dependency 'scoped_storage'
   spec.add_dependency 'rake'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
 
   spec.add_development_dependency 'rspec', '2.99.0.rc1'
   # show nicely how many specs have to be run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sshkit-custom-dsl
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Dieter Späth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sshkit
@@ -157,16 +157,16 @@ files:
 - Rakefile
 - lib/core_ext/sshkit.rb
 - lib/core_ext/sshkit/backend/abstract.rb
-- lib/sshkit/custom/config/runner/abstract.rb
-- lib/sshkit/custom/config/runner/group.rb
-- lib/sshkit/custom/config/runner/parallel.rb
-- lib/sshkit/custom/config/runner/sequential.rb
 - lib/sshkit/custom/config/store.rb
 - lib/sshkit/custom/dsl.rb
 - lib/sshkit/custom/dsl/config_statements.rb
 - lib/sshkit/custom/dsl/exec_statements.rb
 - lib/sshkit/custom/dsl/helper.rb
 - lib/sshkit/custom/dsl/version.rb
+- lib/sshkit/custom/runner/abstract.rb
+- lib/sshkit/custom/runner/group.rb
+- lib/sshkit/custom/runner/parallel.rb
+- lib/sshkit/custom/runner/sequential.rb
 - spec/acceptance/.gitkeep
 - spec/acceptance_spec_helper.rb
 - spec/integration/.gitkeep
@@ -174,6 +174,14 @@ files:
 - spec/spec_helper.rb
 - spec/support/.gitkeep
 - spec/unit/.gitkeep
+- spec/unit/sshkit/custom/config/store_spec.rb
+- spec/unit/sshkit/custom/dsl/config_statements_spec.rb
+- spec/unit/sshkit/custom/dsl/exec_statements_spec.rb
+- spec/unit/sshkit/custom/dsl/helper_spec.rb
+- spec/unit/sshkit/custom/runner/abstract_spec.rb
+- spec/unit/sshkit/custom/runner/group_spec.rb
+- spec/unit/sshkit/custom/runner/parallel_spec.rb
+- spec/unit/sshkit/custom/runner/sequential_spec.rb
 - spec/unit_spec_helper.rb
 - sshkit-custom-dsl.gemspec
 homepage: ''
@@ -208,4 +216,12 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/.gitkeep
 - spec/unit/.gitkeep
+- spec/unit/sshkit/custom/config/store_spec.rb
+- spec/unit/sshkit/custom/dsl/config_statements_spec.rb
+- spec/unit/sshkit/custom/dsl/exec_statements_spec.rb
+- spec/unit/sshkit/custom/dsl/helper_spec.rb
+- spec/unit/sshkit/custom/runner/abstract_spec.rb
+- spec/unit/sshkit/custom/runner/group_spec.rb
+- spec/unit/sshkit/custom/runner/parallel_spec.rb
+- spec/unit/sshkit/custom/runner/sequential_spec.rb
 - spec/unit_spec_helper.rb