sshkit 0.0.34 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8a80737dc30278cecf0c75d8317073b49d1a9ef
-  data.tar.gz: 6cb80d26c524ec7482254a7f1e9ac6bf54cf69b5
+  metadata.gz: 729d775d8b75d0236bd1756c0c4d3bd1e0ace0b1
+  data.tar.gz: ed4c442b6db439862659f9d5588adf6d4a91e678
 SHA512:
-  metadata.gz: 8f169d46717d900f9af2ebccff96665b306613946cf68bc74902a7bbba2ffd961a43fe356294066ffeaaa7754782870710a2e32dc6b9dd93f43ccfcc7e038580
-  data.tar.gz: 48fa41ad79624b95467bcd8b1f7f0699f0cf80c5cf0d1e9c5dc738d6f136e4ad2b509dba9221e27c50185db1ac021703f75e225d332a90aa2c47f378ec7df85f
+  metadata.gz: 0edeec6c8678ad5307b1221614ab207f76c213034502474c96c438bf6fa68a01355522ea7be34c688a1007936fa2c84d565cd869fdce58ef1c4bb35b3a84f22c
+  data.tar.gz: 6e5aeb51f35d0269d0f4ac89308fa43d5d23c757e1bbe08b76d1cc6294f1e3c07e72cb364a9cecb530bbcd534683aefe3fd5c53208ad13f6ebf36b1ca0553328

data/EXAMPLES.md

@@ -352,3 +352,14 @@ Implemented since `v0.0.6`
 The `SSHKit::Host#properties` is an [`OpenStruct`](http://ruby-doc.org/stdlib-1.9.3/libdoc/ostruct/rdoc/OpenStruct.html)
 which is not verified or validated in any way, it is up to you, or your
 library to attach meanings or conventions to this mechanism.
+
+## Running local commands
+
+Replace `on` with `run_locally`
+
+    run_locally do
+      within '/tmp' do
+        execute :whoami
+      end
+    end
+

data/lib/sshkit/all.rb

@@ -1,7 +1,6 @@
 require_relative '../core_ext/array'
 require_relative '../core_ext/hash'
 
-require_relative 'dsl'
 require_relative 'host'
 
 require_relative 'command'
@@ -20,7 +19,10 @@ require_relative 'runners/abstract'
 require_relative 'runners/sequential'
 require_relative 'runners/parallel'
 require_relative 'runners/group'
+require_relative 'runners/null'
 
 require_relative 'backends/abstract'
 require_relative 'backends/printer'
 require_relative 'backends/netssh'
+require_relative 'backends/local'
+require_relative 'backends/skipper'

data/lib/sshkit/backends/abstract.rb

@@ -112,6 +112,16 @@ module SSHKit
         remove_instance_variable(:@group)
       end
 
+      class << self
+        def config
+          @config ||= OpenStruct.new
+        end
+
+        def configure
+          yield config
+        end
+      end
+
       private
 
       def command(*args)

data/lib/sshkit/backends/local.rb

@@ -0,0 +1,38 @@
+require 'open3'
+module SSHKit
+
+  module Backend
+
+    class Local < Printer
+
+      def initialize(&block)
+        @block = block
+      end
+
+      def run
+        instance_exec(&@block)
+      end
+
+      def execute(*args)
+        command(*args).tap do |cmd|
+          output << cmd
+
+          cmd.started = Time.now
+
+          stdout, stderr, exit_status = Open3.capture3(cmd.to_command)
+
+          cmd.stdout = stdout
+          cmd.full_stdout += stdout
+
+          cmd.stderr = stderr
+          cmd.full_stderr += stderr
+
+          cmd.exit_status = exit_status.to_i
+
+          output << cmd
+        end
+      end
+
+    end
+  end
+end

data/lib/sshkit/backends/printer.rb

@@ -10,12 +10,20 @@ module SSHKit
       end
 
       def execute(*args)
-        output << command(*args).to_command + "\n"
+        command(*args).tap do |cmd|
+          output << cmd
+        end
       end
+      alias :upload! :execute
+      alias :download! :execute
+      alias :test :execute
+      alias :invoke :execute
 
-      def capture(command, args=[])
-        raise MethodUnavailableError
+      def capture(*args)
+        String.new.tap { execute(*args) }
       end
+      alias :capture! :capture
+
 
       private
 

data/lib/sshkit/backends/skipper.rb

@@ -0,0 +1,31 @@
+module SSHKit
+  module Backend
+
+    class Skipper < Printer
+
+      def initialize(&block)
+        @block = block
+      end
+
+      def execute(*args)
+        command(*args).tap do |cmd|
+          warn "[SKIPPING] No Matching Host for #{cmd}"
+        end
+      end
+      alias :upload! :execute
+      alias :download! :execute
+      alias :test :execute
+      alias :invoke :execute
+
+      def info(messages)
+        # suppress all messages except `warn`
+      end
+      alias :log :info
+      alias :fatal :info
+      alias :error :info
+      alias :debug :info
+      alias :trace :info
+
+    end
+  end
+end

data/lib/sshkit/coordinator.rb

@@ -6,19 +6,22 @@ module SSHKit
 
     def initialize(raw_hosts)
       @raw_hosts = Array(raw_hosts)
-      raise "No matching hosts!" unless Array(raw_hosts).any?
-      resolve_hosts!
+      resolve_hosts! if Array(raw_hosts).any?
     end
 
     def each(options={}, &block)
-      options = default_options.merge(options)
-      case options[:in]
-      when :parallel then Runner::Parallel
-      when :sequence then Runner::Sequential
-      when :groups   then Runner::Group
+      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
+        else
+          raise RuntimeError, "Don't know how to handle run style #{options[:in].inspect}"
+        end.new(hosts, &block).execute
       else
-        raise RuntimeError, "Don't know how to handle run style #{options[:in].inspect}"
-      end.new(hosts, &block).execute
+        Runner::Null.new(hosts, &block).execute
+      end
     end
 
     private

data/lib/sshkit/dsl.rb

@@ -8,6 +8,10 @@ module SSHKit
       Coordinator.new(hosts).each(options, &block)
     end
 
+    def run_locally(&block)
+      Backend::Local.new(&block).run
+    end
+
   end
 
 end

data/lib/sshkit/runners/null.rb

@@ -0,0 +1,12 @@
+module SSHKit
+
+  module Runner
+
+    class Null < Abstract
+
+      def execute
+        SSHKit::Backend::Skipper.new(&block).run
+      end
+    end
+  end
+end

data/lib/sshkit/runners/parallel.rb

@@ -4,23 +4,6 @@ module SSHKit
 
   module Runner
 
-    class Abstract
-
-      attr_reader :hosts, :block
-
-      def initialize(hosts, &block)
-        @hosts       = Array(hosts)
-        @block       = block
-      end
-
-      private
-
-      def backend(host, &block)
-        SSHKit.config.backend.new(host, &block)
-      end
-
-    end
-
     class Parallel < Abstract
       def execute
         threads = []
@@ -33,34 +16,6 @@ module SSHKit
       end
     end
 
-    class Sequential < Abstract
-      attr_writer :wait_interval
-      def execute
-        hosts.each do |host|
-          backend(host, &block).run
-          sleep wait_interval
-        end
-      end
-      private
-      def wait_interval
-        @wait_interval ||= 2
-      end
-    end
-
-    class Group < Sequential
-      attr_writer :group_size
-      def execute
-        hosts.each_slice(group_size).collect do |group_hosts|
-          Parallel.new(group_hosts, &block).execute
-          sleep wait_interval
-        end.flatten
-      end
-      private
-      def group_size
-        @group_size ||= 2
-      end
-    end
-
   end
 
 end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "0.0.34"
+  VERSION = "1.0.0"
 end

data/test/functional/backends/test_local.rb

@@ -0,0 +1,22 @@
+require 'helper'
+module SSHKit
+
+  module Backend
+
+    class TestLocal < MiniTest::Unit::TestCase
+
+      def setup
+        SSHKit.config.output = SSHKit::Formatter::BlackHole.new($stdout)
+      end
+
+      def test_execute_raises_on_non_zero_exit_status_and_captures_stdout_and_stderr
+        err = assert_raises SSHKit::Command::Failed do
+          Local.new do
+            execute :echo, "'Test capturing stderr' 1>&2; false"
+          end.run
+        end
+        assert_equal "echo stdout: Nothing written\necho stderr: Test capturing stderr\n", err.message
+      end
+    end
+  end
+end

data/test/unit/backends/test_printer.rb

@@ -8,17 +8,7 @@ module SSHKit
 
       def block_to_run
         lambda do |host|
-          within '/opt/sites/example.com' do
-            execute 'date'
-            execute :ls, '-l', '/some/directory'
-            with rails_env: :production do
-              within :tmp do
-                as :root do
-                  execute :touch, 'restart.txt'
-                end
-              end
-            end
-          end
+          execute :ls, '-l', '/some/directory'
         end
       end
 
@@ -26,19 +16,17 @@ module SSHKit
         Printer.new(Host.new(:'example.com'), &block_to_run)
       end
 
+      def setup
+        SSHKit.config.output_verbosity = :debug
+      end
+
       def test_simple_printing
-        result = String.new
+        result = StringIO.new
         SSHKit.capture_output(result) do
           printer.run
         end
-        assert_equal <<-EOEXPECTED.unindent, result
-          if test ! -d /opt/sites/example.com; then echo "Directory does not exist '/opt/sites/example.com'" 1>&2; false; fi
-          cd /opt/sites/example.com && /usr/bin/env date
-          cd /opt/sites/example.com && /usr/bin/env ls -l /some/directory
-          if test ! -d /opt/sites/example.com/tmp; then echo "Directory does not exist '/opt/sites/example.com/tmp'" 1>&2; false; fi
-          if ! sudo su root -c whoami > /dev/null; then echo "You cannot switch to user 'root' using sudo, please check the sudoers file" 1>&2; false; fi
-          cd /opt/sites/example.com/tmp && ( RAILS_ENV=production sudo su root -c \"/usr/bin/env touch restart.txt\" )
-        EOEXPECTED
+        result.rewind
+        assert_equal '/usr/bin/env ls -l /some/directory', result.read
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 1.0.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-14 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -214,8 +214,10 @@ files:
 - lib/sshkit.rb
 - lib/sshkit/all.rb
 - lib/sshkit/backends/abstract.rb
+- lib/sshkit/backends/local.rb
 - lib/sshkit/backends/netssh.rb
 - lib/sshkit/backends/printer.rb
+- lib/sshkit/backends/skipper.rb
 - lib/sshkit/command.rb
 - lib/sshkit/configuration.rb
 - lib/sshkit/coordinator.rb
@@ -229,10 +231,12 @@ files:
 - lib/sshkit/logger.rb
 - lib/sshkit/runners/abstract.rb
 - lib/sshkit/runners/group.rb
+- lib/sshkit/runners/null.rb
 - lib/sshkit/runners/parallel.rb
 - lib/sshkit/runners/sequential.rb
 - lib/sshkit/version.rb
 - sshkit.gemspec
+- test/functional/backends/test_local.rb
 - test/functional/backends/test_netssh.rb
 - test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
@@ -270,6 +274,7 @@ signing_key:
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby
 test_files:
+- test/functional/backends/test_local.rb
 - test/functional/backends/test_netssh.rb
 - test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
@@ -283,4 +288,3 @@ test_files:
 - test/unit/test_coordinator.rb
 - test/unit/test_host.rb
 - test/unit/test_logger.rb
-has_rdoc: