sshkit 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6b3d2a602578d1cea808691cd6a94345862e87e
-  data.tar.gz: 1f7d65fb072bb2c9e6fd830d49bfa354cf756296
+  metadata.gz: fbc4c4d5b2ac3c6cfda56f6d7582b6c2e4b0814d
+  data.tar.gz: 6a260d8a28ed5df45fd14de2140aa0de0f6ef577
 SHA512:
-  metadata.gz: 4e0f22c3b4b0bf6e6af4bafc7d3d610c216fea810aebd29ab689819d3953da77f4aa3c5ea599453997f85b5f5bec5fae8fd629c370968a87580755bd23f6044b
-  data.tar.gz: c789d68ad2b9025a694dd41b58b55640d55443252729bdbbd7d8460419e5fbe9670fde840b437cf2416380a1e19c28613ddd92c1b55d5a27ae0f8fa1c47a5dc8
+  metadata.gz: e37e0ac83457d83c0c5d41676830097c5ccd6f24ae5cc636533d2c2bb54a2f7706f387ec9af97a458a332a198b90189fd4263ec3411fb07a75db56cd0db25107
+  data.tar.gz: 135cc559ee24611b6f1ccab198445ea7a8efe2df7339c12409e5547a5c3ea0a1ae22d61a640b2a6703b1bb9e7c36af15d1f05fc2103d43d222bcd8fe9a978450

data/.gitignore

@@ -1,4 +1,7 @@
 *.gem
+*.swp
+bin/rake
+.bundle
 .yardoc
 .vagrant*
 test/tmp

data/CHANGELOG.md

@@ -3,11 +3,26 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
-## (Unreleased)
+## `master` (Unreleased)
 
   * Add your entries here, remember to credit yourself however you want to be
     credited!
 
+## 1.7.0
+
+  * Update Vagrantfile to use multi-provider Hashicorp precise64 box - remove URLs. @townsen
+  * Merge host ssh_options and Netssh defaults @townsen
+    Previously if host-level ssh_options were defined the Netssh defaults
+    were ignored.
+  * Merge host ssh_options and Netssh defaults
+  * Fixed race condition where output of failed command would be empty. @townsen
+    Caused random failures of `test_execute_raises_on_non_zero_exit_status_and_captures_stdout_and_stderr`
+    Also fixes output handling in failed commands, and generally buggy output.
+  * Remove override of backtrace() and backtrace_locations() from ExecuteError. @townsen
+    This interferes with rake default behaviour and creates duplicate stacktraces.
+  * Allow running local commands using `on(:local)`
+  * Implement the upload! and download! methods for the local backend
+
 ## 1.6.0
 
   * Fix colorize to use the correct API (@fazibear)

data/EXAMPLES.md

@@ -344,3 +344,10 @@ Replace `on` with `run_locally`
       end
     end
 
+You can achieve the same thing with `on(:local)`
+
+    on(:local) do
+      within '/tmp' do
+        execute :whoami
+      end
+    end

data/README.md

@@ -1,4 +1,4 @@
-![SSHKit Logo](https://raw.github.com/leehambley/sshkit/master/assets/images/logo.png)
+![SSHKit Logo](https://raw.github.com/leehambley/sshkit/master/examples/images/logo.png)
 
 **SSHKit** is a toolkit for running commands in a structured way on one or
 more servers.
@@ -199,7 +199,7 @@ first argument before attempting to find it in the *command map*.
 
 ## Output Handling
 
-![Example Output](https://raw.github.com/leehambley/sshkit/master/assets/images/example_output.png)
+![Example Output](https://raw.github.com/leehambley/sshkit/master/examples/images/example_output.png)
 
 By default, the output format is set to `:pretty`:
 

data/Vagrantfile

@@ -1,13 +1,7 @@
 VAGRANTFILE_API_VERSION = "2"
 
 Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  config.vm.box = 'precise64'
-  config.vm.provider "vmware_fusion" do |vmf|
-    vmf.box_url = "http://files.vagrantup.com/precise64_vmware.box"
-  end
-  config.vm.provider "virtualbox" do |vb|
-    config.vm.box_url = "http://cloud-images.ubuntu.com/vagrant/precise/current/precise-server-cloudimg-amd64-vagrant-disk1.box"
-  end
+  config.vm.box = 'hashicorp/precise64'
 
   json_config_path = File.join("test", "boxes.json")
   list = File.open(json_config_path).read
@@ -15,7 +9,6 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
 
   list.each do |vm|
     config.vm.define vm["name"] do |web|
-      web.vm.box = "precise64"
       web.vm.network "forwarded_port", guest: 22, host: vm["port"]
     end
   end

data/lib/sshkit/backends/local.rb

@@ -1,17 +1,18 @@
 require 'open3'
+require 'fileutils'
 module SSHKit
 
   module Backend
 
     class Local < Printer
 
-      def initialize(&block)
-        @host = Host.new(hostname: 'localhost') # just for logging
+      def initialize(_ = nil, &block)
+        @host = Host.new(:local) # just for logging
         @block = block
       end
 
       def run
-        instance_exec(&@block)
+        instance_exec(@host, &@block)
       end
 
       def test(*args)
@@ -31,6 +32,26 @@ module SSHKit
         _execute(*[*args, options]).full_stdout
       end
 
+      def upload!(local, remote, options = {})
+        if local.is_a?(String)
+          FileUtils.cp(local, remote)
+        else
+          File.open(remote, "wb") do |f|
+            IO.copy_stream(local, f)
+          end
+        end
+      end
+
+      def download!(remote, local=nil, options = {})
+        if local.nil?
+          FileUtils.cp(remote, File.basename(remote))
+        else
+          File.open(remote, "rb") do |f|
+            IO.copy_stream(f, local)
+          end
+        end
+      end
+
       private
 
       def _execute(*args)
@@ -39,23 +60,34 @@ module SSHKit
 
           cmd.started = Time.now
 
-          stdout, stderr, exit_status =
-            if RUBY_ENGINE == 'jruby'
-              _, o, e, t = Open3.popen3('/usr/bin/env', 'sh', '-c', cmd.to_command)
-              [o.read, e.read, t.value]
-            else
-              Open3.capture3(cmd.to_command)
+          Open3.popen3(cmd.to_command) do |stdin, stdout, stderr, wait_thr|
+            stdout_thread = Thread.new do
+              while line = stdout.gets do
+                cmd.stdout = line
+                cmd.full_stdout += line
+
+                output << cmd
+              end
             end
 
-          cmd.stdout = stdout
-          cmd.full_stdout += stdout
+            stderr_thread = Thread.new do
+              while line = stderr.gets do
+                cmd.stderr = line
+                cmd.full_stderr += line
 
-          cmd.stderr = stderr
-          cmd.full_stderr += stderr
+                output << cmd
+              end
+            end
 
-          cmd.exit_status = exit_status.to_i
+            stdout_thread.join
+            stderr_thread.join
 
-          output << cmd
+            cmd.exit_status = wait_thr.value.to_i
+            cmd.stdout = ''
+            cmd.stderr = ''
+
+            output << cmd
+          end
         end
       end
 

data/lib/sshkit/backends/netssh.rb

@@ -133,6 +133,7 @@ module SSHKit
         command(*args).tap do |cmd|
           output << cmd
           cmd.started = true
+          exit_status = nil
           with_ssh do |ssh|
             ssh.open_channel do |chan|
               chan.request_pty if Netssh.config.pty
@@ -148,9 +149,7 @@ module SSHKit
                   output << cmd
                 end
                 chan.on_request("exit-status") do |ch, data|
-                  cmd.stdout = ''
-                  cmd.stderr = ''
-                  cmd.exit_status = data.read_long
+                  exit_status = data.read_long
                   output << cmd
                 end
                 #chan.on_request("exit-signal") do |ch, data|
@@ -176,11 +175,12 @@ module SSHKit
             end
             ssh.loop
           end
+          cmd.exit_status = exit_status if exit_status
         end
       end
 
       def with_ssh
-        host.ssh_options ||= Netssh.config.ssh_options
+        host.ssh_options = Netssh.config.ssh_options.merge(host.ssh_options || {})
         conn = self.class.pool.checkout(
           String(host.hostname),
           host.username,

data/lib/sshkit/command.rb

@@ -90,10 +90,8 @@ module SSHKit
       if options[:raise_on_non_zero_exit] && exit_status > 0
         message = ""
         message += "#{command} exit status: " + exit_status.to_s + "\n"
-        message += "#{command} stdout: " + (stdout.strip.empty? ? "Nothing written" : stdout.strip) + "\n"
-
-        stderr_message = [stderr.strip, full_stderr.strip].delete_if(&:empty?).first
-        message += "#{command} stderr: " + (stderr_message || 'Nothing written') + "\n"
+        message += "#{command} stdout: " + (full_stdout.strip.empty? ? "Nothing written" : full_stdout.strip) + "\n"
+        message += "#{command} stderr: " + (full_stderr.strip.empty? ? 'Nothing written' : full_stderr.strip) + "\n"
         raise Failed, message
       end
     end

data/lib/sshkit/exception.rb

@@ -8,14 +8,6 @@ module SSHKit
           def initialize cause
             @cause = cause
           end
-
-          def backtrace
-            @cause.backtrace
-          end
- 
-          def backtrace_locations
-            @cause.backtrace_locations
-          end
         end
     end
 end

data/lib/sshkit/formatters/pretty.rb

@@ -34,6 +34,7 @@ module SSHKit
                                              uuid(command) + c.green("\t" + line)]
               original_output << "\n" unless line[-1] == "\n"
             end
+            command.stdout = ''
           end
 
           unless command.stderr.empty?
@@ -42,6 +43,7 @@ module SSHKit
                                              uuid(command) + c.red("\t" + line)]
               original_output << "\n" unless line[-1] == "\n"
             end
+            command.stderr = ''
           end
         end
 

data/lib/sshkit/host.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'etc'
 
 module SSHKit
 
@@ -22,7 +23,11 @@ module SSHKit
 
     def initialize(host_string_or_options_hash)
 
-      unless host_string_or_options_hash.is_a?(Hash)
+      if host_string_or_options_hash == :local
+        @local = true
+        @hostname = "localhost"
+        @user = Etc.getpwuid.name
+      elsif !host_string_or_options_hash.is_a?(Hash)
         suitable_parsers = [
           SimpleHostParser,
           HostWithPortParser,
@@ -51,6 +56,10 @@ module SSHKit
       end
     end
 
+    def local?
+      @local
+    end
+
     def hash
       user.hash ^ hostname.hash ^ port.hash
     end

data/lib/sshkit/runners/abstract.rb

@@ -15,7 +15,11 @@ module SSHKit
       private
 
       def backend(host, &block)
-        SSHKit.config.backend.new(host, &block)
+        if host.local?
+          SSHKit::Backend::Local.new(&block)
+        else
+          SSHKit.config.backend.new(host, &block)
+        end
       end
 
     end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.6.1"
+  VERSION = "1.7.0"
 end

data/test/functional/backends/test_netssh.rb

@@ -65,6 +65,17 @@ module SSHKit
         end
       end
 
+      def test_ssh_option_merge
+        a_host.ssh_options = { paranoid: true }
+        host_ssh_options = {}
+        SSHKit::Backend::Netssh.config.ssh_options = { forward_agent: false }
+        Netssh.new(a_host) do |host|
+          capture(:uname)
+          host_ssh_options = host.ssh_options
+        end.run
+        assert_equal({ forward_agent: false, paranoid: true }, host_ssh_options)
+      end
+
       def test_execute_raises_on_non_zero_exit_status_and_captures_stdout_and_stderr
         err = assert_raises SSHKit::Command::Failed do
           Netssh.new(a_host) do |host|

data/test/unit/test_host.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'etc'
 
 module SSHKit
 
@@ -41,6 +42,14 @@ module SSHKit
       assert_equal 'example.com', h.hostname
     end
 
+    def test_host_local
+      h = Host.new :local
+      assert       h.local?
+      assert_nil   h.port
+      assert_equal Etc.getpwuid.name, h.username
+      assert_equal 'localhost',       h.hostname
+    end
+
     def test_does_not_confuse_ipv6_hosts_with_port_specification
       h = Host.new '[1fff:0:a88:85a3::ac1f]:8001'
       assert_equal 8001,                    h.port

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2015-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -151,8 +151,8 @@ files:
 - RELEASING.md
 - Rakefile
 - Vagrantfile
-- assets/images/example_output.png
-- assets/images/logo.png
+- examples/images/example_output.png
+- examples/images/logo.png
 - lib/core_ext/array.rb
 - lib/core_ext/hash.rb
 - lib/sshkit.rb
@@ -227,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby